CLAM::AudioFile Class Reference
[Audio File I/O]
#include <AudioFile.hxx>
Detailed Description
Definition at line 40 of file AudioFile.hxx.
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 |
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 mActiveCodec, mCodec, mHeaderData, mLocation, and mTextDescriptors.
| CLAM::AudioFile::~AudioFile | ( | ) | [virtual] |
Definition at line 60 of file AudioFile.cxx.
Member Function Documentation
Definition at line 50 of file AudioFile.cxx.
References mActiveCodec, mCodec, mHeaderData, mLocation, and mTextDescriptors.
| const Filename& CLAM::AudioFile::GetLocation | ( | ) | const [inline] |
Definition at line 49 of file AudioFile.hxx.
References mLocation.
Referenced by CLAM::AudioCodecs::PCMAudioStream::AudioFileToNative(), CLAM::AudioCodecs::OggVorbisAudioStream::AudioFileToNative(), and CLAM::AudioCodecs::MpegAudioStream::AudioFileToNative().
| const AudioFileHeader& CLAM::AudioFile::GetHeader | ( | ) | const [inline] |
Definition at line 50 of file AudioFile.hxx.
Referenced by CLAM::AudioCodecs::PCMAudioStream::AudioFileToNative(), CLAM::AudioCodecs::OggVorbisAudioStream::AudioFileToNative(), CLAM::AudioCodecs::MpegAudioStream::AudioFileToNative(), CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileWriter::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MultiChannelAudioFileReader::Do(), CLAM::MonoAudioFileReader::Do(), CLAM::MultiChannelAudioFileReader::GetHeader(), and CLAM::MonoAudioFileReader::GetHeader().
| const AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors | ( | ) | const [inline] |
Definition at line 51 of file AudioFile.hxx.
Referenced by CLAM::MultiChannelAudioFileReader::GetTextDescriptors(), and CLAM::MonoAudioFileReader::GetTextDescriptors().
| AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors | ( | ) | [inline] |
Definition at line 52 of file AudioFile.hxx.
| void CLAM::AudioFile::SetTextDescriptors | ( | const AudioTextDescriptors & | descriptors | ) | [inline] |
Definition at line 54 of file AudioFile.hxx.
| EAudioFileCodec CLAM::AudioFile::GetCodec | ( | ) | const |
Definition at line 145 of file AudioFile.cxx.
References mCodec.
Referenced by CLAM::MultiChannelAudioFileReader::GetCodec(), and CLAM::MonoAudioFileReader::GetCodec().
| bool CLAM::AudioFile::IsValid | ( | ) | const |
| bool CLAM::AudioFile::IsReadable | ( | ) | const |
Definition at line 155 of file AudioFile.cxx.
References CLAM::AudioCodecs::Codec::IsReadable(), and mLocation.
Referenced by CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteConfigure(), and ResolveCodec().
| bool CLAM::AudioFile::IsWritable | ( | ) | const |
Definition at line 160 of file AudioFile.cxx.
References CLAM::AudioCodecs::Codec::IsWritable(), and mLocation.
Referenced by CLAM::MultiChannelAudioFileWriter::ConcreteConfigure(), and CLAM::MonoAudioFileWriter::ConcreteConfigure().
| AudioCodecs::Stream * CLAM::AudioFile::GetStream | ( | ) |
Definition at line 165 of file AudioFile.cxx.
References CLAM::AudioCodecs::Codec::GetStreamFor().
Referenced by CLAM::MultiChannelAudioFileWriter::ConcreteConfigure(), CLAM::MultiChannelAudioFileReader::ConcreteConfigure(), CLAM::MonoAudioFileWriter::ConcreteConfigure(), CLAM::MonoAudioFileReader::ConcreteConfigure(), CLAM::MultiChannelAudioFileWriter::ConcreteStart(), CLAM::MultiChannelAudioFileReader::ConcreteStart(), CLAM::MonoAudioFileReader::ConcreteStart(), and CLAM::MonoAudioFileReader::Do().
| 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::ResolveCodec | ( | ) | [protected] |
Definition at line 64 of file AudioFile.cxx.
References CLAM::EAudioFileCodec::eMpeg, CLAM::EAudioFileCodec::eOggVorbis, CLAM::EAudioFileCodec::ePCM, CLAM::EAudioFileCodec::eUnknown, CLAM::AudioCodecs::Codec::FileExists(), CLAM::AudioCodecs::MpegCodec::Instantiate(), CLAM::AudioCodecs::OggVorbisCodec::Instantiate(), Instantiate(), CLAM::AudioCodecs::PCMCodec::Instantiate(), IsReadable(), mCodec, mLocation, and NULL.
Referenced by CLAM::AudioFileSource::OpenExisting().
| 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().
| void CLAM::AudioFile::ResetHeaderData | ( | ) | [protected] |
Definition at line 178 of file AudioFile.cxx.
References CLAM::DynamicType::UpdateData().
Referenced by CLAM::AudioFileSource::OpenExisting().
Member Data Documentation
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().
EAudioFileCodec CLAM::AudioFile::mCodec [protected] |
Definition at line 73 of file AudioFile.hxx.
Referenced by AudioFile(), GetCodec(), CLAM::AudioFileSource::OpenExisting(), operator=(), ResolveCodec(), and SetHeader().
The documentation for this class was generated from the following files:
