CLAM-Development: CLAM::AudioFile Class Reference

CLAM-Development 1.4.0

#include <AudioFile.hxx>

List of all members.

Public Member Functions
	AudioFile ()
	AudioFile (const AudioFile &)
const AudioFile &	operator= (const AudioFile &)
virtual	~AudioFile ()
const Filename &	GetLocation () const
const AudioFileHeader &	GetHeader () const
const AudioTextDescriptors &	GetTextDescriptors () const
AudioTextDescriptors &	GetTextDescriptors ()
void	SetTextDescriptors (const AudioTextDescriptors &descriptors)
EAudioFileCodec	GetCodec () const
bool	IsValid () const
bool	IsReadable () const
bool	IsWritable () const
AudioCodecs::Stream *	GetStream ()

Protected Member Functions
bool	SetHeader (const AudioFileHeader &)
	Usually the header is set into the file using CreateNew or OpenExistig (public) methods.
void	ResolveCodec ()
void	ActivateCodec ()
void	ResetHeaderData ()

Protected Attributes
Filename	mLocation
EAudioFileCodec	mCodec

Detailed Description

Definition at line 40 of file AudioFile.hxx.

Constructor & Destructor Documentation

CLAM::AudioFile::AudioFile ( )

Definition at line 35 of file AudioFile.cxx.

CLAM::AudioFile::AudioFile ( const AudioFile & obj )

Definition at line 41 of file AudioFile.cxx.

References mCodec, and mLocation.

CLAM::AudioFile::~AudioFile ( )

virtual

Definition at line 60 of file AudioFile.cxx.

Member Function Documentation

void CLAM::AudioFile::ActivateCodec ( )

protected

Definition at line 171 of file AudioFile.cxx.

References mLocation, CLAM::AudioCodecs::Codec::RetrieveHeaderData(), and CLAM::AudioCodecs::Codec::RetrieveTextDescriptors().

Referenced by CLAM::AudioFileSource::OpenExisting().

EAudioFileCodec CLAM::AudioFile::GetCodec ( ) const

Definition at line 145 of file AudioFile.cxx.

References mCodec.

Referenced by CLAM::MonoAudioFileReader::GetCodec(), and CLAM::MultiChannelAudioFileReader::GetCodec().

const AudioFileHeader& CLAM::AudioFile::GetHeader ( ) const

inline

Definition at line 50 of file AudioFile.hxx.

Referenced by CLAM::MonoAudioFileWriter::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileReader::Do(), CLAM::MultiChannelAudioFileReader::Do(), CLAM::MonoAudioFileReader::GetHeader(), CLAM::MultiChannelAudioFileReader::GetHeader(), CLAM::AudioCodecs::MpegAudioStream::MpegAudioStream(), CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream(), and CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream().

const Filename& CLAM::AudioFile::GetLocation ( ) const

inline

Definition at line 49 of file AudioFile.hxx.

References mLocation.

Referenced by CLAM::AudioCodecs::MpegAudioStream::MpegAudioStream(), CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream(), and CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream().

AudioCodecs::Stream * CLAM::AudioFile::GetStream ( )

Definition at line 165 of file AudioFile.cxx.

References CLAM::AudioCodecs::Codec::GetStreamFor().

Referenced by CLAM::MonoAudioFileWriter::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MultiChannelAudioFileWriter::ConcreteConfigure(), CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteStart(), CLAM::MultiChannelAudioFileWriter::ConcreteStart(), and CLAM::MultiChannelAudioFileReader::ConcreteStart().

const AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors ( ) const

inline

Definition at line 51 of file AudioFile.hxx.

Referenced by CLAM::MonoAudioFileReader::GetTextDescriptors(), and CLAM::MultiChannelAudioFileReader::GetTextDescriptors().

AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors ( )

inline

Definition at line 52 of file AudioFile.hxx.

bool CLAM::AudioFile::IsReadable ( ) const

Definition at line 155 of file AudioFile.cxx.

References CLAM::AudioCodecs::Codec::IsReadable(), and mLocation.

Referenced by CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), and ResolveCodec().

bool CLAM::AudioFile::IsValid ( ) const

Definition at line 150 of file AudioFile.cxx.

References NULL.

bool CLAM::AudioFile::IsWritable ( ) const

Definition at line 160 of file AudioFile.cxx.

References CLAM::AudioCodecs::Codec::IsWritable(), and mLocation.

Referenced by CLAM::MonoAudioFileWriter::ConcreteConfigure(), and CLAM::MultiChannelAudioFileWriter::ConcreteConfigure().

const AudioFile & CLAM::AudioFile::operator= ( const AudioFile & obj )

Definition at line 50 of file AudioFile.cxx.

References mCodec, and mLocation.

void CLAM::AudioFile::ResetHeaderData ( )

protected

Definition at line 178 of file AudioFile.cxx.

References CLAM::DynamicType::UpdateData().

Referenced by CLAM::AudioFileSource::OpenExisting().

void CLAM::AudioFile::ResolveCodec ( )

protected

Definition at line 64 of file AudioFile.cxx.

References CLAM::EAudioFileCodec::eMpeg, CLAM::EAudioFileCodec::eOggVorbis, CLAM::EAudioFileCodec::ePCM, SDIF::eUnknown, CLAM::AudioCodecs::Codec::FileExists(), CLAM::AudioCodecs::OggVorbisCodec::Instantiate(), CLAM::AudioCodecs::PCMCodec::Instantiate(), CLAM::AudioCodecs::MpegCodec::Instantiate(), Instantiate(), IsReadable(), mCodec, mLocation, and NULL.

Referenced by CLAM::AudioFileSource::OpenExisting().

bool CLAM::AudioFile::SetHeader ( const AudioFileHeader & newHeader )

protected

Usually the header is set into the file using CreateNew or OpenExistig (public) methods.

Definition at line 98 of file AudioFile.cxx.

References CLAM_ASSERT, CLAM::EAudioFileEndianess::eDefault, CLAM::EAudioFileCodec::eOggVorbis, CLAM::EAudioFileCodec::ePCM, CLAM::EAudioFileFormat::eVorbisMk1, Instantiate(), mCodec, and CLAM::DynamicType::UpdateData().

Referenced by CLAM::AudioFileTarget::CreateNew().

void CLAM::AudioFile::SetTextDescriptors ( const AudioTextDescriptors & descriptors )

inline

Definition at line 54 of file AudioFile.hxx.

Member Data Documentation

EAudioFileCodec CLAM::AudioFile::mCodec

protected

Definition at line 73 of file AudioFile.hxx.

Referenced by AudioFile(), GetCodec(), CLAM::AudioFileSource::OpenExisting(), operator=(), ResolveCodec(), and SetHeader().

Filename CLAM::AudioFile::mLocation

protected

Definition at line 72 of file AudioFile.hxx.

Referenced by ActivateCodec(), AudioFile(), CLAM::AudioFileTarget::CreateNew(), GetLocation(), IsReadable(), IsWritable(), CLAM::AudioFileSource::OpenExisting(), operator=(), and ResolveCodec().

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