AudioDecoder Class Reference

Audio decoder base class. More...

#include <tdme/audio/decoder/AudioDecoder.h>

Inheritance diagram for AudioDecoder:

Collaboration diagram for AudioDecoder:

Public Member Functions
virtual void	openFile (const string &pathName, const string &fileName)=0
	Open a local file. More...
virtual void	reset ()=0
	Resets this audio decoder, if a stream was open it will be rewinded. More...
int32_t	getChannels ()
int32_t	getSampleRate ()
int32_t	getBitsPerSample ()
int32_t	getSamples ()
virtual int32_t	readFromStream (ByteBuffer *data)=0
	Read raw PCM data from stream. More...
virtual void	close ()=0
	Closes the audio file. More...
	AudioDecoder ()
	Constructor. More...
virtual	~AudioDecoder ()
	Destructor. More...

Static Public Attributes
static constexpr int32_t	CHANNELS_NONE { -1 }
static constexpr int32_t	SAMPLERATE_NONE { -1 }
static constexpr int32_t	BITSPERSAMPLES_NONE { -1 }
static constexpr int32_t	SAMPLES_NONE { -1 }

Protected Attributes
int32_t	channels
int32_t	sampleRate
int32_t	bitsPerSample
int32_t	samples

Detailed Description

Audio decoder base class.

Author

Andreas Drewke

Version

$Id$

Definition at line 23 of file AudioDecoder.h.

Constructor & Destructor Documentation

AudioDecoder()

AudioDecoder

(

)

Constructor.

Definition at line 12 of file AudioDecoder.cpp.

~AudioDecoder()

~AudioDecoder ( )

virtual

Destructor.

Definition at line 20 of file AudioDecoder.cpp.

Member Function Documentation

close()

virtual void close ( )

pure virtual

Closes the audio file.

Exceptions

tdme::os::filesystem::FileSystemException
tdme::audio::decoder::AudioDecoderException

Implemented in VorbisDecoder.

getBitsPerSample()

int32_t getBitsPerSample ( )

inline

Returns

bits per sample or BITSPERSAMPLES_NONE

Definition at line 72 of file AudioDecoder.h.

getChannels()

int32_t getChannels ( )

inline

Returns

number of channels or CHANNELS_NONE

Definition at line 58 of file AudioDecoder.h.

getSampleRate()

int32_t getSampleRate ( )

inline

Returns

sample rate in hz or SAMPLERATE_NONE

Definition at line 65 of file AudioDecoder.h.

getSamples()

int32_t getSamples ( )

inline

Returns

samples or SAMPLES_NONE

Definition at line 79 of file AudioDecoder.h.

openFile()

virtual void openFile ( const string &  pathName, const string &  fileName  )

pure virtual

Open a local file.

Parameters

pathName	path name
fileName	file name

Exceptions

tdme::os::filesystem::FileSystemException
tdme::audio::decoder::AudioDecoderException

Implemented in VorbisDecoder.

readFromStream()

virtual int32_t readFromStream ( ByteBuffer *  data )

pure virtual

Read raw PCM data from stream.

Parameters

data	byte buffer

Exceptions

tdme::os::filesystem::FileSystemException
tdme::audio::decoder::AudioDecoderException

Returns

number of bytes read

Implemented in VorbisDecoder.

reset()

virtual void reset ( )

pure virtual

Resets this audio decoder, if a stream was open it will be rewinded.

Exceptions

tdme::os::filesystem::FileSystemException
tdme::audio::decoder::AudioDecoderException

Implemented in VorbisDecoder.

Member Data Documentation

bitsPerSample

int32_t bitsPerSample

protected

Definition at line 34 of file AudioDecoder.h.

BITSPERSAMPLES_NONE

constexpr int32_t BITSPERSAMPLES_NONE { -1 }

staticconstexpr

Definition at line 28 of file AudioDecoder.h.

channels

int32_t channels

protected

Definition at line 32 of file AudioDecoder.h.

CHANNELS_NONE

constexpr int32_t CHANNELS_NONE { -1 }

staticconstexpr

Definition at line 26 of file AudioDecoder.h.

sampleRate

int32_t sampleRate

protected

Definition at line 33 of file AudioDecoder.h.

SAMPLERATE_NONE

constexpr int32_t SAMPLERATE_NONE { -1 }

staticconstexpr

Definition at line 27 of file AudioDecoder.h.

samples

int32_t samples

protected

Definition at line 35 of file AudioDecoder.h.

SAMPLES_NONE

constexpr int32_t SAMPLES_NONE { -1 }

staticconstexpr

Definition at line 29 of file AudioDecoder.h.

---

The documentation for this class was generated from the following files:

• /home/andreas/Development/drewke.net/tdme2/src/tdme/audio/decoder/AudioDecoder.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/audio/decoder/AudioDecoder.cpp