Reads and Writes AIFF format audio files. More...

#include <juce_AiffAudioFormat.h>

Inheritance diagram for juce::AiffAudioFormat:

Collaboration diagram for juce::AiffAudioFormat:

[legend]

Public Member Functions
	AiffAudioFormat ()
	Creates an format object. More...

	~AiffAudioFormat () override
	Destructor. More...

bool	canDoMono () override
	Returns true if the format can do 1-channel audio. More...

bool	canDoStereo () override
	Returns true if the format can do 2-channel audio. More...

bool	canHandleFile (const File &fileToTest) override
	Returns true if this the given file can be read by this format. More...

MemoryMappedAudioFormatReader *	createMemoryMappedReader (const File &) override
	Attempts to create a MemoryMappedAudioFormatReader, if possible for this format. More...

MemoryMappedAudioFormatReader *	createMemoryMappedReader (FileInputStream *) override

AudioFormatReader *	createReaderFor (InputStream *sourceStream, bool deleteStreamIfOpeningFails) override
	Tries to create an object that can read from a stream containing audio data in this format. More...

virtual AudioFormatWriter *	createWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, const AudioChannelSet &channelLayout, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex)
	Tries to create an object that can write to a stream with this audio format. More...

virtual AudioFormatWriter *	createWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, const AudioChannelSet &channelLayout, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex)
	Tries to create an object that can write to a stream with this audio format. More...

AudioFormatWriter *	createWriterFor (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. More...

virtual AudioFormatWriter *	createWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, unsigned int numberOfChannels, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex)=0
	Tries to create an object that can write to a stream with this audio format. More...

virtual StringArray	getFileExtensions () const
	Returns all the file extensions that might apply to a file of this format. More...

const String &	getFormatName () const
	Returns the name of this format. More...

Array< int >	getPossibleBitDepths () override
	Returns a set of bit depths that the format can read and write. More...

Array< int >	getPossibleSampleRates () override
	Returns a set of sample rates that the format can read and write. More...

virtual StringArray	getQualityOptions ()
	Returns a list of different qualities that can be used when writing. More...

virtual bool	isChannelLayoutSupported (const AudioChannelSet &channelSet)
	Returns true if the channel layout is supported by this format. More...

virtual bool	isCompressed ()
	Returns true if the format uses compressed data. More...

Static Public Attributes
static const char *const	appleBeats
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleDenominator
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleKey
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleNumerator
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleOneShot
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleRootNote
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleRootSet
	Metadata property name used when reading a aiff file with a basc chunk. More...

static const char *const	appleTag
	Metadata property name used when reading a aiff file with a basc chunk. More...

Private Attributes
StringArray	fileExtensions

String	formatName

Detailed Description

Reads and Writes AIFF format audio files.

See also: AudioFormat

@tags{Audio}

Constructor & Destructor Documentation

◆ AiffAudioFormat()

juce::AiffAudioFormat::AiffAudioFormat ( )

Creates an format object.

◆ ~AiffAudioFormat()

juce::AiffAudioFormat::~AiffAudioFormat ( )

override

Destructor.

Member Function Documentation

◆ canDoMono()

bool juce::AiffAudioFormat::canDoMono ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ canDoStereo()

bool juce::AiffAudioFormat::canDoStereo ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ canHandleFile()

bool juce::AiffAudioFormat::canHandleFile ( const File & fileToTest )

overridevirtual

Returns true if this the given file can be read by this format.

Subclasses shouldn't do too much work here, just check the extension or file type. The base class implementation just checks the file's extension against one of the ones that was registered in the constructor.

Reimplemented from juce::AudioFormat.

◆ createMemoryMappedReader() [1/2]

MemoryMappedAudioFormatReader* juce::AiffAudioFormat::createMemoryMappedReader ( const File & file )

overridevirtual

Attempts to create a MemoryMappedAudioFormatReader, if possible for this format.

If the format does not support this, the method will return nullptr;

Reimplemented from juce::AudioFormat.

◆ createMemoryMappedReader() [2/2]

MemoryMappedAudioFormatReader* juce::AiffAudioFormat::createMemoryMappedReader ( FileInputStream * )

overridevirtual

Reimplemented from juce::AudioFormat.

◆ createReaderFor()

AudioFormatReader* juce::AiffAudioFormat::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

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 juce::AudioFormat.

◆ createWriterFor() [1/4]

virtual AudioFormatWriter* juce::AudioFormat::createWriterFor

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 nullptr.

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()
channelLayout	the channel layout for the file. Use isChannelLayoutSupported to check if the writer supports this layout.
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

◆ createWriterFor() [2/4]

virtual AudioFormatWriter* juce::AudioFormat::createWriterFor	(	OutputStream *	streamToWriteTo,
		double	sampleRateToUse,
		const AudioChannelSet &	channelLayout,
		int	bitsPerSample,
		const StringPairArray &	metadataValues,
		int	qualityOptionIndex
	)

virtualinherited

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 nullptr.

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()
channelLayout	the channel layout for the file. Use isChannelLayoutSupported to check if the writer supports this layout.
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

Reimplemented in juce::WavAudioFormat.

◆ createWriterFor() [3/4]

AudioFormatWriter* juce::AiffAudioFormat::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 nullptr.

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
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 juce::AudioFormat.

◆ createWriterFor() [4/4]

virtual AudioFormatWriter* juce::AudioFormat::createWriterFor

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 nullptr.

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
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

◆ getFileExtensions()

virtual StringArray juce::AudioFormat::getFileExtensions ( ) const

virtualinherited

Returns all the file extensions that might apply to a file of this format.

The first item will be the one that's preferred when creating a new file. So for a wav file this might just return ".wav"; for an AIFF file it might return two items, ".aif" and ".aiff"

◆ getFormatName()

const String& juce::AudioFormat::getFormatName ( ) const

inherited

Returns the name of this format.

e.g. "WAV file" or "AIFF file"

◆ getPossibleBitDepths()

Array<int> juce::AiffAudioFormat::getPossibleBitDepths ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ getPossibleSampleRates()

Array<int> juce::AiffAudioFormat::getPossibleSampleRates ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ getQualityOptions()

virtual StringArray juce::AudioFormat::getQualityOptions ( )

virtualinherited

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 in juce::MP3AudioFormat, juce::FlacAudioFormat, juce::OggVorbisAudioFormat, and juce::LAMEEncoderAudioFormat.

◆ isChannelLayoutSupported()

virtual bool juce::AudioFormat::isChannelLayoutSupported ( const AudioChannelSet & channelSet )

virtualinherited

Returns true if the channel layout is supported by this format.

Reimplemented in juce::WavAudioFormat.

◆ isCompressed()

virtual bool juce::AudioFormat::isCompressed ( )

virtualinherited

Returns true if the format uses compressed data.

Reimplemented in juce::MP3AudioFormat, juce::FlacAudioFormat, juce::OggVorbisAudioFormat, juce::WindowsMediaAudioFormat, and juce::LAMEEncoderAudioFormat.