JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Attributes | List of all members
OggVorbisAudioFormat Class Reference

Reads and writes the Ogg-Vorbis audio format. More...

Inherits AudioFormat.

Public Member Functions

 OggVorbisAudioFormat ()
 
 ~OggVorbisAudioFormat ()
 
Array< int > getPossibleSampleRates () override
 Returns a set of sample rates that the format can read and write.
 
Array< int > getPossibleBitDepths () override
 Returns a set of bit depths that the format can read and write.
 
bool canDoStereo () override
 Returns true if the format can do 2-channel audio.
 
bool canDoMono () override
 Returns true if the format can do 1-channel audio.
 
bool isCompressed () override
 Returns true if the format uses compressed data.
 
StringArray getQualityOptions () override
 Returns a list of different qualities that can be used when writing.
 
int estimateOggFileQuality (const File &source)
 Tries to estimate the quality level of an ogg file based on its size.
 
AudioFormatReadercreateReaderFor (InputStream *sourceStream, bool deleteStreamIfOpeningFails) override
 Tries to create an object that can read from a stream containing audio data in this format.
 
AudioFormatWritercreateWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, unsigned int numberOfChannels, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex) override
 Tries to create an object that can write to a stream with this audio format.
 
- Public Member Functions inherited from AudioFormat
virtual ~AudioFormat ()
 Destructor.
 
const StringgetFormatName () const
 Returns the name of this format.
 
const StringArraygetFileExtensions () const
 Returns all the file extensions that might apply to a file of this format.
 
virtual bool canHandleFile (const File &fileToTest)
 Returns true if this the given file can be read by this format.
 
virtual
MemoryMappedAudioFormatReader
createMemoryMappedReader (const File &file)
 Attempts to create a MemoryMappedAudioFormatReader, if possible for this format.
 

Static Public Attributes

static const char *const encoderName
 Metadata property name used by the Ogg writer - if you set a string for this value, it will be written into the ogg file as the name of the encoder app.
 
static const char *const id3title
 Metadata key for setting an ID3 title.
 
static const char *const id3artist
 Metadata key for setting an ID3 artist name.
 
static const char *const id3album
 Metadata key for setting an ID3 album.
 
static const char *const id3comment
 Metadata key for setting an ID3 comment.
 
static const char *const id3date
 Metadata key for setting an ID3 date.
 
static const char *const id3genre
 Metadata key for setting an ID3 genre.
 
static const char *const id3trackNumber
 Metadata key for setting an ID3 track number.
 

Additional Inherited Members

- Protected Member Functions inherited from AudioFormat
 AudioFormat (String formatName, StringArray fileExtensions)
 Creates an AudioFormat object.
 
 AudioFormat (StringRef formatName, StringRef fileExtensions)
 Creates an AudioFormat object.
 

Detailed Description

Reads and writes the Ogg-Vorbis audio format.

To compile this, you'll need to set the JUCE_USE_OGGVORBIS flag.

See Also
AudioFormat,

Constructor & Destructor Documentation

OggVorbisAudioFormat::OggVorbisAudioFormat ( )
OggVorbisAudioFormat::~OggVorbisAudioFormat ( )

Member Function Documentation

Array<int> OggVorbisAudioFormat::getPossibleSampleRates ( )
overridevirtual

Returns a set of sample rates that the format can read and write.

Implements AudioFormat.

Array<int> OggVorbisAudioFormat::getPossibleBitDepths ( )
overridevirtual

Returns a set of bit depths that the format can read and write.

Implements AudioFormat.

bool OggVorbisAudioFormat::canDoStereo ( )
overridevirtual

Returns true if the format can do 2-channel audio.

Implements AudioFormat.

bool OggVorbisAudioFormat::canDoMono ( )
overridevirtual

Returns true if the format can do 1-channel audio.

Implements AudioFormat.

bool OggVorbisAudioFormat::isCompressed ( )
overridevirtual

Returns true if the format uses compressed data.

Reimplemented from AudioFormat.

StringArray OggVorbisAudioFormat::getQualityOptions ( )
overridevirtual

Returns a list of different qualities that can be used when writing.

Non-compressed formats will just return an empty array, but for something like Ogg-Vorbis or MP3, it might return a list of bit-rates, etc.

When calling createWriterFor(), an index from this array is passed in to tell the format which option is required.

Reimplemented from AudioFormat.

int OggVorbisAudioFormat::estimateOggFileQuality ( const File source)

Tries to estimate the quality level of an ogg file based on its size.

If it can't read the file for some reason, this will just return 1 (medium quality), otherwise it will return the approximate quality setting that would have been used to create the file.

See Also
getQualityOptions
AudioFormatReader* OggVorbisAudioFormat::createReaderFor ( InputStream sourceStream,
bool  deleteStreamIfOpeningFails 
)
overridevirtual

Tries to create an object that can read from a stream containing audio data in this format.

The reader object that is returned can be used to read from the stream, and should then be deleted by the caller.

Parameters
sourceStreamthe stream to read from - the AudioFormatReader object that is returned will delete this stream when it no longer needs it.
deleteStreamIfOpeningFailsif no reader can be created, this determines whether this method should delete the stream object that was passed-in. (If a valid reader is returned, it will always be in charge of deleting the stream, so this parameter is ignored)
See Also
AudioFormatReader

Implements AudioFormat.

AudioFormatWriter* OggVorbisAudioFormat::createWriterFor ( OutputStream streamToWriteTo,
double  sampleRateToUse,
unsigned int  numberOfChannels,
int  bitsPerSample,
const StringPairArray metadataValues,
int  qualityOptionIndex 
)
overridevirtual

Tries to create an object that can write to a stream with this audio format.

The writer object that is returned can be used to write to the stream, and should then be deleted by the caller.

If the stream can't be created for some reason (e.g. the parameters passed in here aren't suitable), this will return 0.

Parameters
streamToWriteTothe stream that the data will go to - this will be deleted by the AudioFormatWriter object when it's no longer needed. If no AudioFormatWriter can be created by this method, the stream will NOT be deleted, so that the caller can re-use it to try to open a different format, etc
sampleRateToUsethe sample rate for the file, which must be one of the ones returned by getPossibleSampleRates()
numberOfChannelsthe number of channels - this must be either 1 or 2, and the choice will depend on the results of canDoMono() and canDoStereo()
bitsPerSamplethe bits per sample to use - this must be one of the values returned by getPossibleBitDepths()
metadataValuesa set of metadata values that the writer should try to write to the stream. Exactly what these are depends on the format, and the subclass doesn't actually have to do anything with them if it doesn't want to. Have a look at the specific format implementation classes to see possible values that can be used
qualityOptionIndexthe index of one of compression qualities returned by the getQualityOptions() method. If there aren't any quality options for this format, just pass 0 in this parameter, as it'll be ignored
See Also
AudioFormatWriter

Implements AudioFormat.

Member Data Documentation

const char* const OggVorbisAudioFormat::encoderName
static

Metadata property name used by the Ogg writer - if you set a string for this value, it will be written into the ogg file as the name of the encoder app.

See Also
createWriterFor
const char* const OggVorbisAudioFormat::id3title
static

Metadata key for setting an ID3 title.

const char* const OggVorbisAudioFormat::id3artist
static

Metadata key for setting an ID3 artist name.

const char* const OggVorbisAudioFormat::id3album
static

Metadata key for setting an ID3 album.

const char* const OggVorbisAudioFormat::id3comment
static

Metadata key for setting an ID3 comment.

const char* const OggVorbisAudioFormat::id3date
static

Metadata key for setting an ID3 date.

const char* const OggVorbisAudioFormat::id3genre
static

Metadata key for setting an ID3 genre.

const char* const OggVorbisAudioFormat::id3trackNumber
static

Metadata key for setting an ID3 track number.


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