EOUtils::OggFile Class Reference

#include <OggFile.h>

Inheritance diagram for EOUtils::OggFile:

Collaboration diagram for EOUtils::OggFile:

Public Member Functions
	OggFile (const std::string &pFilename)
	OggFile (const std::string &pFilename, const OggFileInfo &pFileInfo)
	OggFile (const std::string &pFilename, AudioFileModes pFileMode)
	OggFile (const std::string &pFilename, OggWriteQuality pQuality)
	OggFile (const std::string &pFilename, OggWriteApproxBitrateKbps pApproxBitrate)
	OggFile (const OggFile &pOther)
	OggFile (OggFile &&pOther) noexcept
	~OggFile () override
AudioFileResultType	open (AudioFileModes pOpenMode) override
void	setAudioFileInfo (const AudioFileInfo &pAudioFileInfo) override
const OggFileInfo &	getFileInfo () const
void	setOggWriteQualityBestOneWorstZero (double pQuality)
void	setOggWriteApproxNominalBitrateKbps (std::uint32_t pKbps)
void	clearOggWriteEncodingOverrides ()
Public Member Functions inherited from EOUtils::SndFileBackedMetadataAudioFile
void	setAudioFileInfo (const AudioFileInfo &pAudioFileInfo) override
AudioFileResultType	open (AudioFileModes pOpenMode) override
void	close () override
	Closes the audio file.
bool	isOpen () const override
	Returns whether or not the audio file is open.
AudioFileResultType	getNextSample_int64 (std::int64_t &pAudioSample) override
AudioFileResultType	writeSample_int64 (std::int64_t pAudioSample) override
AudioFileResultType	getHighestSampleValue_int64 (std::int64_t &pHighestAudioSample) override
AudioFileResultType	goToAudioDataPos () override
	Goes to the audio data position in the audio file.
std::size_t	numSamples () const override
	Returns the number of audio samples in the audio file.
std::int64_t	maxValueForSampleSize () const override
	Returns the maximum possible positive value of the audio file's sample size.
void	seekOutputToSampleNum (std::size_t pSampleNum) override
AudioFileInfo	getAudioFileInfo () const override
	Returns an AudioFile object with information about the audio file.
AudioFileResultType	setTitle (const std::string &pTitle) override
	Sets the title metadata tag.
AudioFileResultType	setArtist (const std::string &pArtist) override
	Sets the artist metadata tag.
AudioFileResultType	setAlbum (const std::string &pAlbum) override
	Sets the album metadata tag.
AudioFileResultType	setGenre (const std::string &pGenre) override
	Sets the genre metadata tag.
AudioFileResultType	setTrackNumber (std::uint32_t pTrackNumber, std::uint32_t pTotalTracks=0) override
AudioFileResultType	setYear (const std::string &pYear) override
	Sets the year/date metadata tag.
AudioFileResultType	setComment (const std::string &pComment) override
	Sets the comment metadata tag.
AudioFileResultType	getTitle (std::string &pTitle) const override
	Gets the title metadata tag.
AudioFileResultType	getArtist (std::string &pArtist) const override
	Gets the artist metadata tag.
AudioFileResultType	getAlbum (std::string &pAlbum) const override
	Gets the album metadata tag.
AudioFileResultType	getGenre (std::string &pGenre) const override
	Gets the genre metadata tag.
AudioFileResultType	getTrackNumber (std::uint32_t &pTrackNumber, std::uint32_t &pTotalTracks) const override
AudioFileResultType	getYear (std::string &pYear) const override
	Gets the year/date metadata tag.
AudioFileResultType	getComment (std::string &pComment) const override
	Gets the comment metadata tag.
	~SndFileBackedMetadataAudioFile () override
Public Member Functions inherited from EOUtils::MetadataAudioFile
	MetadataAudioFile (const std::string &pFilename)
	MetadataAudioFile (const std::string &pFilename, AudioFileModes pFileMode)
	MetadataAudioFile (const MetadataAudioFile &pOther)
virtual	~MetadataAudioFile ()
virtual AudioFileResultType	setTrackNumber (uint32_t pTrackNumber, uint32_t pTotalTracks=0)=0
	Sets the track number metadata tag.
virtual AudioFileResultType	getTrackNumber (uint32_t &pTrackNumber, uint32_t &pTotalTracks) const =0
	Gets the track number metadata tag.
Public Member Functions inherited from EOUtils::AudioFile
	AudioFile (const std::string &pFilename)
	Constructor.
	AudioFile (const std::string &pFilename, AudioFileModes pFileMode)
	AudioFile (const AudioFile &pAudioFile)
virtual	~AudioFile ()
virtual bool	BitrateIsAdjustable () const =0
	Returns whether or not the audio file bitrate is adjustable.
virtual bool	hasReadMode () const
	Returns whether or not read mode is enabled for the file.
virtual bool	hasWriteMode () const
	Returns whether or not write mode is enabled for the file.
virtual AudioFileResultType	getNextSample_int64 (int64_t &pAudioSample)=0
	Gets the next sample from the file, cast to a 64-bit integer.
virtual AudioFileResultType	writeSample_int64 (int64_t pAudioSample)=0
	Writes an audio sample to the file. The parameter is a 64-bit integer but will be cast to the bitness of the audio samples in the file.
virtual AudioFileResultType	getHighestSampleValue_int64 (int64_t &pHighestAudioSample)=0
	Gets the highest audio sample value from the file, cast to a 64-bit integer.
const std::string &	Filename () const
	Gets the filename of the audio file.
void	Filename (const std::string &pFilename)
	Setter for the filename of the audio file.
void	setMetadata (const std::string &pName, const std::string &pValue)
	Adds a piece of metadata for the audio file.
template<typename T>
void	setMetadataFromVal (const std::string &pName, const T &pValue)
	Adds a piece of metadata for the audio file. Templatized for any value type. The value will be converted to a string to store in the metadata.
AudioFileResultType	getMetadata (const std::string &pName, std::string &pValue) const
	Gets a metadata value as a string.
template<typename T>
AudioFileResultType	getMetadataAs (const std::string &pName, T &pValue) const
	Gets a metadata value. Templatized to capture the value as any type.
std::string	getMetadata (const std::string &pName) const
	Gets a metadata value.
template<typename T>
T	getMetadataAs (const std::string &pName) const
template<typename T>
T	getMetadataAs (const std::string &pName, const T &pDefaultVal) const
	Gets a metadata value. Templatized to return it as any type.
bool	hasMetadata (const std::string &pName) const
	Returns whether or not a metadata item exists.
virtual void	seekOutputToSampleNum (size_t pSampleNum)=0

Protected Member Functions
bool	readFormatMatches (int pSfFullFormat) const override
int	newFileSfFormatMask () const override
const char *	formatLabel () const override
void	configureSndfileEncoderForWrite (SNDFILE *pSnd) override
Protected Member Functions inherited from EOUtils::SndFileBackedMetadataAudioFile
	SndFileBackedMetadataAudioFile (const std::string &pFilename)
	SndFileBackedMetadataAudioFile (const std::string &pFilename, AudioFileModes pFileMode)
	SndFileBackedMetadataAudioFile (const SndFileBackedMetadataAudioFile &pOther)
	SndFileBackedMetadataAudioFile (SndFileBackedMetadataAudioFile &&pOther) noexcept
	SndFileBackedMetadataAudioFile (const std::string &pFilename, const AudioFileInfo &pLayoutHint)
Protected Member Functions inherited from EOUtils::AudioFile
virtual std::streampos	fileSizeAccordingToStream ()
virtual void	setFileMode (AudioFileModes pFileMode)

Additional Inherited Members
Protected Attributes inherited from EOUtils::SndFileBackedMetadataAudioFile
AudioFileInfo	mFileLayout
Protected Attributes inherited from EOUtils::AudioFile
std::string	mFilename
std::fstream	mFileStream
std::ios_base::openmode	mFileOpenMode
size_t	mDataSizeBytes
std::map< std::string, std::string >	mMetadata

Constructor & Destructor Documentation

OggFile() [1/7]

EOUtils::OggFile::OggFile ( const std::string & pFilename )

explicit

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout, and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

Referenced by OggFile(), and OggFile().

OggFile() [2/7]

EOUtils::OggFile::OggFile ( const std::string & pFilename, const OggFileInfo & pFileInfo )

explicit

References EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

OggFile() [3/7]

EOUtils::OggFile::OggFile ( const std::string & pFilename, AudioFileModes pFileMode )

explicit

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout, and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

OggFile() [4/7]

EOUtils::OggFile::OggFile ( const std::string & pFilename, OggWriteQuality pQuality )

explicit

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout, and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

OggFile() [5/7]

EOUtils::OggFile::OggFile ( const std::string & pFilename, OggWriteApproxBitrateKbps pApproxBitrate )

explicit

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout, and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

OggFile() [6/7]

EOUtils::OggFile::OggFile

(

const OggFile &

pOther

)

References OggFile(), and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

OggFile() [7/7]

EOUtils::OggFile::OggFile ( OggFile && pOther )

noexcept

References OggFile(), and EOUtils::SndFileBackedMetadataAudioFile::SndFileBackedMetadataAudioFile().

~OggFile()

EOUtils::OggFile::~OggFile ( )

overridedefault

Member Function Documentation

clearOggWriteEncodingOverrides()

void EOUtils::OggFile::clearOggWriteEncodingOverrides

(

)

configureSndfileEncoderForWrite()

void EOUtils::OggFile::configureSndfileEncoderForWrite ( SNDFILE * )

overrideprotectedvirtual

After a successful SFM_WRITE open, codecs may tweak the encoder via sf_command. Default: no-op.

Reimplemented from EOUtils::SndFileBackedMetadataAudioFile.

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout.

formatLabel()

const char * EOUtils::OggFile::formatLabel ( ) const

overrideprotectedvirtual

Implements EOUtils::SndFileBackedMetadataAudioFile.

getFileInfo()

const OggFileInfo & EOUtils::OggFile::getFileInfo

(

)

const

newFileSfFormatMask()

int EOUtils::OggFile::newFileSfFormatMask ( ) const

overrideprotectedvirtual

Implements EOUtils::SndFileBackedMetadataAudioFile.

open()

AudioFileResultType EOUtils::OggFile::open ( AudioFileModes pOpenMode )

overridevirtual

Reimplemented from EOUtils::AudioFile.

References EOUtils::SndFileBackedMetadataAudioFile::mFileLayout, and EOUtils::SndFileBackedMetadataAudioFile::open().

readFormatMatches()

bool EOUtils::OggFile::readFormatMatches ( int pSfFullFormat ) const

overrideprotectedvirtual

Implements EOUtils::SndFileBackedMetadataAudioFile.

References EOUtils::sndfile_detail::formatHasMajorMinor().

setAudioFileInfo()

void EOUtils::OggFile::setAudioFileInfo ( const AudioFileInfo & pAudioFileInfo )

overridevirtual

Implements EOUtils::AudioFile.

References EOUtils::SndFileBackedMetadataAudioFile::setAudioFileInfo().

setOggWriteApproxNominalBitrateKbps()

void EOUtils::OggFile::setOggWriteApproxNominalBitrateKbps

(

std::uint32_t

pKbps

)

setOggWriteQualityBestOneWorstZero()

void EOUtils::OggFile::setOggWriteQualityBestOneWorstZero

(

double

pQuality

)

---

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

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