VorbisDecoder Class Reference

OGG/Vorbis audio decoder. More...

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

Inheritance diagram for VorbisDecoder:

Collaboration diagram for VorbisDecoder:

Classes
struct	OGGFileData

Public Member Functions
virtual void	openFile (const string &pathName, const string &fileName)
	Open a local file. More...
virtual void	reset ()
	Resets this audio decoder, if a stream was open it will be rewinded. More...
virtual int32_t	readFromStream (ByteBuffer *data)
	Read raw PCM data from stream. More...
virtual void	close ()
	Closes the audio file. More...
	VorbisDecoder ()
	Constructor. More...
	~VorbisDecoder ()
	Destructor. More...
Public Member Functions inherited from AudioDecoder
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 Private Member Functions
static size_t	oggfiledata_read (void *buffer, size_t size, size_t count, VorbisDecoder::OGGFileData *oggFileData)
	Read from OGG file data. More...
static int	oggfiledata_seek (VorbisDecoder::OGGFileData *oggFileData, ogg_int64_t offset, int whence)
	Seek in OGG file data. More...
static int	oggfiledata_close (VorbisDecoder::OGGFileData *oggFileData)
	Close OGG file data. More...
static long	oggfiledata_tell (VorbisDecoder::OGGFileData *oggFileData)
	Tell position of OGG file data. More...

Private Attributes
OGGFileData *	oggFileData { nullptr }
string	pathName
string	fileName
OggVorbis_File	vf
int	section

Additional Inherited Members
Static Public Attributes inherited from AudioDecoder
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 inherited from AudioDecoder
int32_t	channels
int32_t	sampleRate
int32_t	bitsPerSample
int32_t	samples

Detailed Description

OGG/Vorbis audio decoder.

Author

Andreas Drewke

Definition at line 28 of file VorbisDecoder.h.

Constructor & Destructor Documentation

VorbisDecoder()

VorbisDecoder

(

)

Constructor.

Definition at line 75 of file VorbisDecoder.cpp.

~VorbisDecoder()

~VorbisDecoder

(

)

Destructor.

Definition at line 80 of file VorbisDecoder.cpp.

Member Function Documentation

close()

void close ( )

virtual

Closes the audio file.

Exceptions

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

Implements AudioDecoder.

Definition at line 161 of file VorbisDecoder.cpp.

oggfiledata_close()

int oggfiledata_close ( VorbisDecoder::OGGFileData *  oggFileData )

staticprivate

Close OGG file data.

Parameters

oggFileData

pointer to OGG file data

Definition at line 67 of file VorbisDecoder.cpp.

oggfiledata_read()

size_t oggfiledata_read ( void *  buffer, size_t  size, size_t  count, VorbisDecoder::OGGFileData *  oggFileData  )

staticprivate

Read from OGG file data.

Parameters

buffer	buffer to read into
size	chunk bytes to read
count	chunk count to read
oggFileData	pointer to OGG file data

Definition at line 40 of file VorbisDecoder.cpp.

oggfiledata_seek()

int oggfiledata_seek ( VorbisDecoder::OGGFileData *  oggFileData, ogg_int64_t  offset, int  whence  )

staticprivate

Seek in OGG file data.

Parameters

oggFileData	OGG file data pointer
offset	offset (can be relative to position)
whence	whence see (SEEK_*)

Definition at line 51 of file VorbisDecoder.cpp.

oggfiledata_tell()

long oggfiledata_tell ( VorbisDecoder::OGGFileData *  oggFileData )

staticprivate

Tell position of OGG file data.

Parameters

oggFileData

pointer to OGG file data

Returns

current read position

Definition at line 71 of file VorbisDecoder.cpp.

openFile()

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

virtual

Open a local file.

Parameters

pathName	path name
fileName	file name

Exceptions

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

Implements AudioDecoder.

Definition at line 85 of file VorbisDecoder.cpp.

readFromStream()

int32_t readFromStream ( ByteBuffer *  data )

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

Implements AudioDecoder.

Definition at line 137 of file VorbisDecoder.cpp.

reset()

void reset ( )

virtual

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

Exceptions

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

Implements AudioDecoder.

Definition at line 132 of file VorbisDecoder.cpp.

Member Data Documentation

fileName

string fileName

private

Definition at line 113 of file VorbisDecoder.h.

oggFileData

OGGFileData* oggFileData { nullptr }

private

Definition at line 111 of file VorbisDecoder.h.

pathName

string pathName

private

Definition at line 112 of file VorbisDecoder.h.

section

int section

private

Definition at line 115 of file VorbisDecoder.h.

vf

OggVorbis_File vf

private

Definition at line 114 of file VorbisDecoder.h.

---

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

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