Eric Oulashin's C++ Audio Mixer 1.0
Public Member Functions | Protected Attributes | List of all members
EOUtils::AudioFileInfo Class Reference

#include <AudioFileInfo.h>

Inheritance diagram for EOUtils::AudioFileInfo:
Inheritance graph
Collaboration diagram for EOUtils::AudioFileInfo:
Collaboration graph

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 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]pNumChannelsThe number of channels
[in]pSampleRateHzThe sample rate (in Hz)
[in]pBytesPerSecondThe number of bytes per second
[in]pByteRateThe byte rate (number of bytes per sample * number of channels)
[in]pBitsPerSampleThe number of bits per sample

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::FLACFile::getNextSample_int64(), EOUtils::FLACFile::maxValueForSampleSize(), EOUtils::mixAudioFiles(), EOUtils::FLACFile::open(), and EOUtils::FLACFile::writeSample_int64().

◆ 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.

◆ 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.

Referenced by EOUtils::WAVFile::getNextSample(), EOUtils::FLACFile::numSamples(), EOUtils::WAVFile::numSamples(), EOUtils::WAVFile::seekOutputToSampleNum(), and EOUtils::WAVFile::writeSample().

◆ BytesPerSecond() [1/2]

int32_t EOUtils::AudioFileInfo::BytesPerSecond ( ) const
virtual

References mBytesPerSecond.

◆ 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]pAudioFileInfoAn AudioFileInfo object to copy the values from

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

Referenced by EOUtils::getAudioFileInfo(), EOUtils::FLACFile::setAudioFileInfo(), and EOUtils::WAVFile::setAudioFileInfo().

◆ FileSize() [1/2]

int32_t EOUtils::AudioFileInfo::FileSize ( ) const
virtual

References mFileSize.

Referenced by 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::FLACFile::close(), EOUtils::mixAudioFiles(), EOUtils::FLACFile::numSamples(), EOUtils::FLACFile::open(), EOUtils::FLACFile::seekOutputToSampleNum(), and EOUtils::FLACFile::writeSample_int64().

◆ 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]pFilenameThe 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::FLACFileInfo.

References read(), and result.

Referenced by read().

◆ read() [2/2]

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

Reads the info from a file stream.

Parameters
[in]pInFStreamA 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::FLACFileInfo, and EOUtils::WAVFileInfo.

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

◆ SampleRateHz() [1/2]

int32_t EOUtils::AudioFileInfo::SampleRateHz ( ) const
virtual

References mSampleRateHz.

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

◆ 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]pOutFStreamA 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::FLACFileInfo, and EOUtils::WAVFileInfo.

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

Member Data Documentation

◆ mBitsPerSample

int16_t EOUtils::AudioFileInfo::mBitsPerSample
protected

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

◆ mByteRate

int16_t EOUtils::AudioFileInfo::mByteRate
protected

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

◆ mBytesPerSecond

int32_t EOUtils::AudioFileInfo::mBytesPerSecond
protected

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

◆ mFileSize

int32_t EOUtils::AudioFileInfo::mFileSize
protected

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

◆ mNumChannels

int16_t EOUtils::AudioFileInfo::mNumChannels
protected

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

◆ mSampleRateHz

int32_t EOUtils::AudioFileInfo::mSampleRateHz
protected

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

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8