FlacAudioFormat Class Reference

Reads and writes the lossless-compression FLAC audio format. More...

Inherits AudioFormat.

List of all members.

Public Member Functions
	FlacAudioFormat ()
	~FlacAudioFormat ()
const Array< int >	getPossibleSampleRates ()
	Returns a set of sample rates that the format can read and write.
const Array< int >	getPossibleBitDepths ()
	Returns a set of bit depths that the format can read and write.
bool	canDoStereo ()
	Returns true if the format can do 2-channel audio.
bool	canDoMono ()
	Returns true if the format can do 1-channel audio.
bool	isCompressed ()
	Returns true if the format uses compressed data.
AudioFormatReader *	createReaderFor (InputStream *sourceStream, const bool deleteStreamIfOpeningFails)
	Tries to create an object that can read from a stream containing audio data in this format.
AudioFormatWriter *	createWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, unsigned int numberOfChannels, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex)
	Tries to create an object that can write to a stream with this audio format.

---

Detailed Description

Reads and writes the lossless-compression FLAC audio format.

To compile this, you'll need to set the JUCE_USE_FLAC flag in juce_Config.h, and make sure your include search path and library search path are set up to find the FLAC header files and static libraries.

See also:

AudioFormat

---

Constructor & Destructor Documentation

FlacAudioFormat::FlacAudioFormat

(

)

FlacAudioFormat::~FlacAudioFormat

(

)

---

Member Function Documentation

const Array<int> FlacAudioFormat::getPossibleSampleRates

(

)

[virtual]

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

Implements AudioFormat.

const Array<int> FlacAudioFormat::getPossibleBitDepths

(

)

[virtual]

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

Implements AudioFormat.

bool FlacAudioFormat::canDoStereo

(

)

[virtual]

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

Implements AudioFormat.

bool FlacAudioFormat::canDoMono

(

)

[virtual]

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

Implements AudioFormat.

bool FlacAudioFormat::isCompressed

(

)

[virtual]

Returns true if the format uses compressed data.

Reimplemented from AudioFormat.

AudioFormatReader* FlacAudioFormat::createReaderFor	(	InputStream *	sourceStream,
		const bool	deleteStreamIfOpeningFails
	)			[virtual]

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:

	sourceStream	the stream to read from - the AudioFormatReader object that is returned will delete this stream when it no longer needs it.
	deleteStreamIfOpeningFails	if 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* FlacAudioFormat::createWriterFor	(	OutputStream *	streamToWriteTo,
		double	sampleRateToUse,
		unsigned int	numberOfChannels,
		int	bitsPerSample,
		const StringPairArray &	metadataValues,
		int	qualityOptionIndex
	)			[virtual]

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:

	streamToWriteTo	the 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
	sampleRateToUse	the sample rate for the file, which must be one of the ones returned by getPossibleSampleRates()
	numberOfChannels	the number of channels - this must be either 1 or 2, and the choice will depend on the results of canDoMono() and canDoStereo()
	bitsPerSample	the bits per sample to use - this must be one of the values returned by getPossibleBitDepths()
	metadataValues	a 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
	qualityOptionIndex	the 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.

---

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

• juce_FlacAudioFormat.h