EOUtils::FLACFileInfo Class Reference

Holds metadata for FLAC audio files. More...

#include <FLACFileInfo.h>

Inheritance diagram for EOUtils::FLACFileInfo:

Collaboration diagram for EOUtils::FLACFileInfo:

Public Member Functions
	FLACFileInfo (int16_t pNumChannels=0, int32_t pSampleRateHz=0, int32_t pBytesPerSecond=0, int16_t pByteRate=0, int16_t pBitsPerSample=0)
	Constructor.
	FLACFileInfo (const AudioFileInfo &pAudioFileInfo)
	Constructor for copying an AudioFileInfo object.
	FLACFileInfo (const FLACFileInfo &pAudioFileInfo)
	Constructor for copying a FLACFileInfo object.
AudioFileResultType	read (std::fstream &pInFStream) override
	Reads the FLAC stream info from a file.
AudioFileResultType	write (std::fstream &pOutFStream) override
	Not used for FLAC - metadata is written by the encoder.
AudioFileResultType	read (const char *pFilename)
	Reads FLAC stream info from a file by filename.
uint32_t	CompressionLevel () const
	Returns the current compression level.
void	CompressionLevel (uint32_t pCompressionLevel)
	Sets the compression level to use when writing FLAC files (0-8, where 0 is fastest and 8 is maximum compression)
Public Member Functions inherited from EOUtils::AudioFileInfo
	AudioFileInfo (int16_t pNumChannels=0, int32_t pSampleRateHz=0, int32_t pBytesPerSecond=0, int16_t pByteRate=0, int16_t pBitsPerSample=0)
	Constructor.
virtual void	copyAudioFileInfo (const AudioFileInfo &pAudioFileInfo)
	Copies the values from another AudioFileInfo object.
virtual int32_t	FileSize () const
void	FileSize (int32_t pFileSize)
virtual int16_t	NumChannels () const
virtual void	NumChannels (int16_t pNumChannels)
virtual int32_t	SampleRateHz () const
virtual void	SampleRateHz (int32_t pSampleRateHz)
virtual int32_t	BytesPerSecond () const
virtual void	BytesPerSecond (int32_t pBytesPerSecond)
virtual int16_t	ByteRate () const
virtual void	ByteRate (int16_t pByteRate)
virtual int16_t	BitsPerSample () const
virtual void	BitsPerSample (int16_t pBitsPerSample)
virtual size_t	BytesPerSample () const

Static Public Member Functions
static bool	isFLACFile (const char *pFilename)
	Check if the given file is a FLAC file (has "fLaC" signature)

Additional Inherited Members
Protected Attributes inherited from EOUtils::AudioFileInfo
int32_t	mFileSize
int16_t	mNumChannels
int32_t	mSampleRateHz
int32_t	mBytesPerSecond
int16_t	mByteRate
int16_t	mBitsPerSample

Detailed Description

Holds metadata for FLAC audio files.

Constructor & Destructor Documentation

FLACFileInfo() [1/3]

EOUtils::FLACFileInfo::FLACFileInfo	(	int16_t	pNumChannels = 0,
		int32_t	pSampleRateHz = 0,
		int32_t	pBytesPerSecond = 0,
		int16_t	pByteRate = 0,
		int16_t	pBitsPerSample = 0
	)

Constructor.

FLACFileInfo() [2/3]

EOUtils::FLACFileInfo::FLACFileInfo

(

const AudioFileInfo &

pAudioFileInfo

)

Constructor for copying an AudioFileInfo object.

FLACFileInfo() [3/3]

EOUtils::FLACFileInfo::FLACFileInfo

(

const FLACFileInfo &

pAudioFileInfo

)

Constructor for copying a FLACFileInfo object.

Member Function Documentation

CompressionLevel() [1/2]

uint32_t EOUtils::FLACFileInfo::CompressionLevel

(

)

const

Returns the current compression level.

Referenced by EOUtils::FLACFile::CompressionLevel(), EOUtils::FLACFile::CompressionLevel(), and EOUtils::FLACFile::open().

CompressionLevel() [2/2]

void EOUtils::FLACFileInfo::CompressionLevel

(

uint32_t

pCompressionLevel

)

Sets the compression level to use when writing FLAC files (0-8, where 0 is fastest and 8 is maximum compression)

isFLACFile()

bool EOUtils::FLACFileInfo::isFLACFile ( const char *  pFilename )

static

Check if the given file is a FLAC file (has "fLaC" signature)

read() [1/2]

AudioFileResultType EOUtils::FLACFileInfo::read ( const char *  pFilename )

virtual

Reads FLAC stream info from a file by filename.

Reimplemented from EOUtils::AudioFileInfo.

References read(), and result.

read() [2/2]

AudioFileResultType EOUtils::FLACFileInfo::read ( std::fstream &  pInFStream )

overridevirtual

Reads the FLAC stream info from a file.

Reimplemented from EOUtils::AudioFileInfo.

References EOUtils::AudioFileResultType::addError(), BITS_PER_BYTE, EOUtils::AudioFileInfo::mBitsPerSample, EOUtils::AudioFileInfo::mByteRate, EOUtils::AudioFileInfo::mBytesPerSecond, EOUtils::AudioFileInfo::mFileSize, EOUtils::AudioFileInfo::mNumChannels, EOUtils::AudioFileInfo::mSampleRateHz, result, and streamInfo.

Referenced by read().

write()

AudioFileResultType EOUtils::FLACFileInfo::write ( std::fstream &  pOutFStream )

overridevirtual

Not used for FLAC - metadata is written by the encoder.

Reimplemented from EOUtils::AudioFileInfo.

References EOUtils::AudioFileResultType::addError(), and result.

---

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

• /home/erico/projects/audio_mixer_cpp/code/common/FLACFileInfo.h
• /home/erico/projects/audio_mixer_cpp/code/common/FLACFileInfo.cpp