#include <AudioFileInfo.h>

Inheritance diagram for EOUtils::AudioFileInfo:

Collaboration diagram for EOUtils::AudioFileInfo:

Public Member Functions
	AudioFileInfo (int16_t pNumChannels=0, int32_t pSampleRateHz=0, int32_t pBytesPerSecond=0, int16_t pByteRate=0, int16_t pBitsPerSample=0)
	Constructor.
virtual	~AudioFileInfo ()=default
virtual void	copyAudioFileInfo (const AudioFileInfo &pAudioFileInfo)
	Copies the values from another AudioFileInfo object.
virtual AudioFileResultType	read (const char *pFilename)
	Reads the info from a WAV file.
virtual AudioFileResultType	read (std::fstream &pInFStream)
	Reads the info from a file stream.
virtual AudioFileResultType	write (std::fstream &pOutFStream)
	Writes the info to a file stream.
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

Protected Attributes
int32_t	mFileSize
int16_t	mNumChannels
int32_t	mSampleRateHz
int32_t	mBytesPerSecond
int16_t	mByteRate
int16_t	mBitsPerSample

Constructor & Destructor Documentation

◆ AudioFileInfo()

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

Constructor.

Parameters

[in]	pNumChannels	The number of channels
[in]	pSampleRateHz	The sample rate (in Hz)
[in]	pBytesPerSecond	The number of bytes per second
[in]	pByteRate	The byte rate (number of bytes per sample * number of channels)
[in]	pBitsPerSample	The number of bits per sample

References mBitsPerSample, mByteRate, mBytesPerSecond, mFileSize, mNumChannels, and mSampleRateHz.

Referenced by EOUtils::AiffFileInfo::AiffFileInfo(), EOUtils::AiffFileInfo::AiffFileInfo(), copyAudioFileInfo(), EOUtils::FLACFileInfo::FLACFileInfo(), EOUtils::FLACFileInfo::FLACFileInfo(), EOUtils::FLACFileInfo::FLACFileInfo(), EOUtils::MP3FileInfo::MP3FileInfo(), EOUtils::MP3FileInfo::MP3FileInfo(), EOUtils::OggFileInfo::OggFileInfo(), EOUtils::OggFileInfo::OggFileInfo(), EOUtils::WAVFileInfo::WAVFileInfo(), EOUtils::WAVFileInfo::WAVFileInfo(), and ~AudioFileInfo().

◆ ~AudioFileInfo()

virtual EOUtils::AudioFileInfo::~AudioFileInfo ( )

virtualdefault

References AudioFileInfo().

Member Function Documentation

◆ BitsPerSample() [1/2]

int16_t EOUtils::AudioFileInfo::BitsPerSample ( ) const

virtual

Reimplemented in EOUtils::WAVFileInfo.

References mBitsPerSample.

Referenced by EOUtils::WAVFileInfo::BitsPerSample(), EOUtils::WAVFileInfo::BitsPerSample(), EOUtils::mixAudioFiles(), and EOUtils::sndfile_detail::sfInfoToAudioFileInfo().

◆ BitsPerSample() [2/2]

void EOUtils::AudioFileInfo::BitsPerSample ( int16_t pBitsPerSample )

virtual

Reimplemented in EOUtils::WAVFileInfo.

References mBitsPerSample.

◆ ByteRate() [1/2]

int16_t EOUtils::AudioFileInfo::ByteRate ( ) const

virtual

References mByteRate.

Referenced by EOUtils::sndfile_detail::sfInfoToAudioFileInfo().

◆ ByteRate() [2/2]

void EOUtils::AudioFileInfo::ByteRate ( int16_t pByteRate )

virtual

References mByteRate.

◆ BytesPerSample()

size_t EOUtils::AudioFileInfo::BytesPerSample ( ) const

virtual

References BITS_PER_BYTE, and mBitsPerSample.

◆ BytesPerSecond() [1/2]

int32_t EOUtils::AudioFileInfo::BytesPerSecond ( ) const

virtual

References mBytesPerSecond.

Referenced by EOUtils::sndfile_detail::sfInfoToAudioFileInfo().

◆ BytesPerSecond() [2/2]

void EOUtils::AudioFileInfo::BytesPerSecond ( int32_t pBytesPerSecond )

virtual

References mBytesPerSecond.

◆ copyAudioFileInfo()

void EOUtils::AudioFileInfo::copyAudioFileInfo ( const AudioFileInfo & pAudioFileInfo )

virtual

Copies the values from another AudioFileInfo object.

Parameters

[in] pAudioFileInfo An AudioFileInfo object to copy the values from

References AudioFileInfo(), mBitsPerSample, mByteRate, mBytesPerSecond, mFileSize, mNumChannels, and mSampleRateHz.

Referenced by EOUtils::getAudioFileInfo().

◆ FileSize() [1/2]

int32_t EOUtils::AudioFileInfo::FileSize ( ) const

virtual

References mFileSize.

Referenced by EOUtils::sndfile_detail::sfInfoToAudioFileInfo(), and EOUtils::WAVFileInfo::updateFileSizeSizeInFile().

◆ FileSize() [2/2]

void EOUtils::AudioFileInfo::FileSize ( int32_t pFileSize )

References mFileSize.

◆ NumChannels() [1/2]

int16_t EOUtils::AudioFileInfo::NumChannels ( ) const

virtual

References mNumChannels.

Referenced by EOUtils::mixAudioFiles(), and EOUtils::sndfile_detail::sfInfoToAudioFileInfo().

◆ NumChannels() [2/2]

void EOUtils::AudioFileInfo::NumChannels ( int16_t pNumChannels )

virtual

References mNumChannels.

◆ read() [1/2]

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

virtual

Reads the info from a WAV file.

Parameters

[in] pFilename The name of a WAV file to read from

Returns: An AudioFileResultType object containing error messages on failure, or no errors on success

Reimplemented in EOUtils::AiffFileInfo, EOUtils::FLACFileInfo, EOUtils::MP3FileInfo, and EOUtils::OggFileInfo.

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

Referenced by read().

◆ read() [2/2]

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

virtual

Reads the info from a file stream.

Parameters

[in] pInFStream A file stream object to read the information from. This must be already opened in read and binary mode.

Returns: An AudioFileResultType object containing error messages on failure, or no errors on success

Reimplemented in EOUtils::AiffFileInfo, EOUtils::FLACFileInfo, EOUtils::MP3FileInfo, EOUtils::OggFileInfo, and EOUtils::WAVFileInfo.

References EOUtils::AudioFileResultType::addError().

◆ SampleRateHz() [1/2]

int32_t EOUtils::AudioFileInfo::SampleRateHz ( ) const

virtual

References mSampleRateHz.

Referenced by EOUtils::mixAudioFiles(), and EOUtils::sndfile_detail::sfInfoToAudioFileInfo().

◆ SampleRateHz() [2/2]

void EOUtils::AudioFileInfo::SampleRateHz ( int32_t pSampleRateHz )

virtual

References mSampleRateHz.

◆ write()

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

virtual

Writes the info to a file stream.

Parameters

[in] pOutFStream A file stream object to write the information to. This must be already opened in write and binary mode.

Returns: An AudioFileResultType object containing error messages on failure, or no errors on success

Reimplemented in EOUtils::AiffFileInfo, EOUtils::FLACFileInfo, EOUtils::MP3FileInfo, EOUtils::OggFileInfo, and EOUtils::WAVFileInfo.

References EOUtils::AudioFileResultType::addError().

Member Data Documentation

◆ mBitsPerSample

int16_t EOUtils::AudioFileInfo::mBitsPerSample

protected

Referenced by AudioFileInfo(), BitsPerSample(), BitsPerSample(), BytesPerSample(), copyAudioFileInfo(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), and EOUtils::WAVFileInfo::write().

◆ mByteRate

int16_t EOUtils::AudioFileInfo::mByteRate

protected

Referenced by AudioFileInfo(), ByteRate(), ByteRate(), copyAudioFileInfo(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), and EOUtils::WAVFileInfo::write().

◆ mBytesPerSecond

int32_t EOUtils::AudioFileInfo::mBytesPerSecond

protected

Referenced by AudioFileInfo(), BytesPerSecond(), BytesPerSecond(), copyAudioFileInfo(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), and EOUtils::WAVFileInfo::write().

◆ mFileSize

int32_t EOUtils::AudioFileInfo::mFileSize

protected

Referenced by AudioFileInfo(), copyAudioFileInfo(), FileSize(), FileSize(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), and EOUtils::WAVFileInfo::write().

◆ mNumChannels

int16_t EOUtils::AudioFileInfo::mNumChannels

protected

Referenced by AudioFileInfo(), copyAudioFileInfo(), NumChannels(), NumChannels(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), and EOUtils::WAVFileInfo::write().

◆ mSampleRateHz

int32_t EOUtils::AudioFileInfo::mSampleRateHz

protected

Referenced by AudioFileInfo(), copyAudioFileInfo(), EOUtils::FLACFileInfo::read(), EOUtils::WAVFileInfo::read(), SampleRateHz(), SampleRateHz(), and EOUtils::WAVFileInfo::write().

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

/home/erico/projects/audio_mixer_cpp/code/common/AudioFileInfo.h
/home/erico/projects/audio_mixer_cpp/code/common/AudioFileInfo.cpp

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ AudioFileInfo()

◆ ~AudioFileInfo()

Member Function Documentation

◆ BitsPerSample() [1/2]

◆ BitsPerSample() [2/2]

◆ ByteRate() [1/2]

◆ ByteRate() [2/2]

◆ BytesPerSample()

◆ BytesPerSecond() [1/2]

◆ BytesPerSecond() [2/2]

◆ copyAudioFileInfo()

◆ FileSize() [1/2]

◆ FileSize() [2/2]

◆ NumChannels() [1/2]

◆ NumChannels() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ SampleRateHz() [1/2]

◆ SampleRateHz() [2/2]

◆ write()

Member Data Documentation

◆ mBitsPerSample

◆ mByteRate

◆ mBytesPerSecond

◆ mFileSize

◆ mNumChannels

◆ mSampleRateHz