OpenShot Library | libopenshot-audio 0.2.0
juce::AiffAudioFormat Class Reference

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

#include <juce_AiffAudioFormat.h>

+ Inheritance diagram for juce::AiffAudioFormat:

Public Member Functions

 AiffAudioFormat ()
 Creates an format object.
 
 ~AiffAudioFormat () override
 Destructor.
 
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 canHandleFile (const File &fileToTest) override
 Returns true if this the given file can be read by this format.
 
AudioFormatReadercreateReaderFor (InputStream *sourceStream, bool deleteStreamIfOpeningFails) override
 Tries to create an object that can read from a stream containing audio data in this format.
 
MemoryMappedAudioFormatReadercreateMemoryMappedReader (const File &) override
 Attempts to create a MemoryMappedAudioFormatReader, if possible for this format.
 
MemoryMappedAudioFormatReadercreateMemoryMappedReader (FileInputStream *) override
 
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 juce::AudioFormat
virtual ~AudioFormat ()
 Destructor.
 
const StringgetFormatName () const
 Returns the name of this format.
 
virtual StringArray getFileExtensions () 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 Array< int > getPossibleSampleRates ()=0
 Returns a set of sample rates that the format can read and write.
 
virtual Array< int > getPossibleBitDepths ()=0
 Returns a set of bit depths that the format can read and write.
 
virtual bool canDoStereo ()=0
 Returns true if the format can do 2-channel audio.
 
virtual bool canDoMono ()=0
 Returns true if the format can do 1-channel audio.
 
virtual bool isCompressed ()
 Returns true if the format uses compressed data.
 
virtual bool isChannelLayoutSupported (const AudioChannelSet &channelSet)
 Returns true if the channel layout is supported by this format.
 
virtual StringArray getQualityOptions ()
 Returns a list of different qualities that can be used when writing.
 
virtual AudioFormatReadercreateReaderFor (InputStream *sourceStream, bool deleteStreamIfOpeningFails)=0
 Tries to create an object that can read from a stream containing audio data in this format.
 
virtual MemoryMappedAudioFormatReadercreateMemoryMappedReader (const File &file)
 Attempts to create a MemoryMappedAudioFormatReader, if possible for this format.
 
virtual MemoryMappedAudioFormatReadercreateMemoryMappedReader (FileInputStream *fin)
 
virtual AudioFormatWritercreateWriterFor (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.
 
virtual AudioFormatWritercreateWriterFor (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.
 

Static Public Attributes

static const char *const appleOneShot = "apple one shot"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleRootSet = "apple root set"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleRootNote = "apple root note"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleBeats = "apple beats"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleDenominator = "apple denominator"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleNumerator = "apple numerator"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleTag = "apple tag"
 Metadata property name used when reading a aiff file with a basc chunk.
 
static const char *const appleKey = "apple key"
 Metadata property name used when reading a aiff file with a basc chunk.
 

Additional Inherited Members

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

Detailed Description

Reads and Writes AIFF format audio files.

See also
AudioFormat

Definition at line 42 of file juce_AiffAudioFormat.h.

Constructor & Destructor Documentation

◆ AiffAudioFormat()

juce::AiffAudioFormat::AiffAudioFormat ( )

Creates an format object.

Definition at line 931 of file juce_AiffAudioFormat.cpp.

◆ ~AiffAudioFormat()

juce::AiffAudioFormat::~AiffAudioFormat ( )
override

Destructor.

Definition at line 932 of file juce_AiffAudioFormat.cpp.

Member Function Documentation

◆ getPossibleSampleRates()

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

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

Implements juce::AudioFormat.

Definition at line 934 of file juce_AiffAudioFormat.cpp.

◆ getPossibleBitDepths()

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

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

Implements juce::AudioFormat.

Definition at line 939 of file juce_AiffAudioFormat.cpp.

Referenced by createWriterFor().

◆ canDoStereo()

bool juce::AiffAudioFormat::canDoStereo ( )
overridevirtual

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

Implements juce::AudioFormat.

Definition at line 944 of file juce_AiffAudioFormat.cpp.

◆ canDoMono()

bool juce::AiffAudioFormat::canDoMono ( )
overridevirtual

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

Implements juce::AudioFormat.

Definition at line 945 of file juce_AiffAudioFormat.cpp.

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

Definition at line 948 of file juce_AiffAudioFormat.cpp.

References juce::AudioFormat::canHandleFile(), and juce::File::getMacOSType().

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

Definition at line 961 of file juce_AiffAudioFormat.cpp.

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

Definition at line 974 of file juce_AiffAudioFormat.cpp.

References juce::File::createInputStream(), and createMemoryMappedReader().

Referenced by createMemoryMappedReader().

◆ createMemoryMappedReader() [2/2]

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

Reimplemented from juce::AudioFormat.

Definition at line 979 of file juce_AiffAudioFormat.cpp.

◆ createWriterFor()

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

Definition at line 992 of file juce_AiffAudioFormat.cpp.

References getPossibleBitDepths().

Member Data Documentation

◆ appleOneShot

const char *const juce::AiffAudioFormat::appleOneShot = "apple one shot"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 54 of file juce_AiffAudioFormat.h.

◆ appleRootSet

const char *const juce::AiffAudioFormat::appleRootSet = "apple root set"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 56 of file juce_AiffAudioFormat.h.

◆ appleRootNote

const char *const juce::AiffAudioFormat::appleRootNote = "apple root note"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 58 of file juce_AiffAudioFormat.h.

◆ appleBeats

const char *const juce::AiffAudioFormat::appleBeats = "apple beats"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 60 of file juce_AiffAudioFormat.h.

◆ appleDenominator

const char *const juce::AiffAudioFormat::appleDenominator = "apple denominator"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 62 of file juce_AiffAudioFormat.h.

◆ appleNumerator

const char *const juce::AiffAudioFormat::appleNumerator = "apple numerator"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 64 of file juce_AiffAudioFormat.h.

◆ appleTag

const char *const juce::AiffAudioFormat::appleTag = "apple tag"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 66 of file juce_AiffAudioFormat.h.

◆ appleKey

const char *const juce::AiffAudioFormat::appleKey = "apple key"
static

Metadata property name used when reading a aiff file with a basc chunk.

Definition at line 68 of file juce_AiffAudioFormat.h.


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