Kicking it Olde Sküül! Burgerlib on Github Follow Olde Sküül on Twitter Burgerbecky on LinkedIn Burgerbecky on LinkedIn
Loading...
Searching...
No Matches
Burger::Decompress32BitBEAudio Class Reference

Process 32 bit audio data in Big Endian format. More...

Inheritance diagram for Burger::Decompress32BitBEAudio:
Collaboration diagram for Burger::Decompress32BitBEAudio:

Public Member Functions

const Burger::StaticRTTIget_StaticRTTI (void) const noexcept override
 Get the description to the class.
 
 Decompress32BitBEAudio ()
 Default constructor.
 
eError Reset (void) override
 Resets the decompresser to defaults.
 
eError Process (void *pOutput, uintptr_t uOutputChunkSize, const void *pInput, uintptr_t uInputChunkLength) override
 Decompress audio data using big endian 32 bit words.
 
- Public Member Functions inherited from Burger::DecompressAudio
const Burger::StaticRTTIget_StaticRTTI (void) const noexcept override
 Get the description to the class.
 
SoundManager::eDataType GetDataType (void) const
 Returns the uncompressed data type this codec will output.
 
void SetMono (void)
 Alert the decompression codec to create a single audio channel.
 
void SetStereo (void)
 Alert the decompression codec to create stereo channels.
 
uint_t IsStereo (void) const
 Obtain the stereo/mono state of the decompresser.
 
- Public Member Functions inherited from Burger::Decompress
 Decompress (void)
 Default constructor.
 
uintptr_t GetTotalInputSize (void) const noexcept
 Get the total processed input data in bytes.
 
uintptr_t GetTotalOutputSize (void) const noexcept
 Get the total processed output data in bytes.
 
uintptr_t GetProcessedInputSize (void) const noexcept
 Get the total processed output data in bytes from the last process pass.
 
uintptr_t GetProcessedOutputSize (void) const noexcept
 Get the total processed output data in bytes from the last process pass.
 
uint32_t GetSignature (void) const noexcept
 Return the signature for this decompressor.
 
- Public Member Functions inherited from Burger::Base
const char * get_class_name (void) const noexcept
 Get the name of the class.
 
virtual ~Base () noexcept=default
 Destructor.
 

Static Public Member Functions

static Decompress32BitBEAudioNew (void)
 Allocate and initialize a Decompress32BitBEAudio.
 

Static Public Attributes

static const Burger::StaticRTTI g_StaticRTTI
 
static const uint32_t Signature = 0x42453332
 'BE32'
 
- Static Public Attributes inherited from Burger::DecompressAudio
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 
- Static Public Attributes inherited from Burger::Decompress
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 
- Static Public Attributes inherited from Burger::Base
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 

Additional Inherited Members

- Protected Member Functions inherited from Burger::DecompressAudio
 DecompressAudio (SoundManager::eDataType uDataType)
 Constructor.
 
- Protected Attributes inherited from Burger::DecompressAudio
SoundManager::eDataType m_eDataType
 Data type the decompresser will create.
 
uint_t m_bStereo
 TRUE if data is stereo
 
- Protected Attributes inherited from Burger::Decompress
uintptr_t m_uTotalInput
 Total number of bytes processed for input.
 
uintptr_t m_uTotalOutput
 Total number of bytes processed for output.
 
uintptr_t m_uInputLength
 Number of input bytes processed from the last call to Process()
 
uintptr_t m_uOutputLength
 Number of output bytes processed from the last call to Process()
 
uint32_t m_uSignature
 4 character code to identify this decompresser
 

Detailed Description

Process 32 bit audio data in Big Endian format.


Convert 32 bit big endian audio data to native format

See also
Decompress and DecompressAudio

Constructor & Destructor Documentation

◆ Decompress32BitBEAudio()

Burger::Decompress32BitBEAudio::Decompress32BitBEAudio ( )

Default constructor.


Initializes the defaults

Member Function Documentation

◆ get_StaticRTTI()

const Burger::StaticRTTI * Burger::Decompress32BitBEAudio::get_StaticRTTI ( void ) const
overridevirtualnoexcept

Get the description to the class.


This virtual function will pull the pointer to the StaticRTTI instance that has the name of the class. Due to it being virtual, it will be the name of the most derived class.

Returns
Pointer to a global, read only instance of StaticRTTI for the true class

Reimplemented from Burger::Decompress.

◆ New()

Burger::Decompress32BitBEAudio *BURGER_API Burger::Decompress32BitBEAudio::New ( void )
static

Allocate and initialize a Decompress32BitBEAudio.


Returns
A pointer to a default Decompress32BitBEAudio class or NULL if out of memory
See also
Delete(const T *)

◆ Process()

Burger::eError Burger::Decompress32BitBEAudio::Process ( void * pOutput,
uintptr_t uOutputChunkLength,
const void * pInput,
uintptr_t uInputChunkLength )
overridevirtual

Decompress audio data using big endian 32 bit words.


Input data is assumed to be big endian 32 bit words. There is no decompression being performed.

Parameters
pOutputPointer to the buffer to accept the decompressed data
uOutputChunkLengthNumber of bytes in the output buffer
pInputPointer to data to decompress
uInputChunkLengthNumber of bytes in the data to decompress
Returns
Decompress::eError code with zero if no failure, non-zero is an error code

Implements Burger::Decompress.

◆ Reset()

Burger::eError Burger::Decompress32BitBEAudio::Reset ( void )
overridevirtual

Resets the decompresser to defaults.


Returns
kErrorNone if successful

Implements Burger::Decompress.

Member Data Documentation

◆ g_StaticRTTI

const Burger::StaticRTTI Burger::Decompress32BitBEAudio::g_StaticRTTI
static

◆ Signature

const uint32_t Burger::Decompress32BitBEAudio::Signature = 0x42453332
static

'BE32'