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

Inherits AudioFormat.

Public Member Functions
	WavAudioFormat ()
	Creates a format object.

	~WavAudioFormat ()
	Destructor.

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

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.

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

MemoryMappedAudioFormatReader *	createMemoryMappedReader (const File &file)
	Attempts to create a MemoryMappedAudioFormatReader, if possible for 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.

bool	replaceMetadataInFile (const File &wavFile, const StringPairArray &newMetadata)
	Utility function to replace the metadata in a wav file with a new set of values.

Public Member Functions inherited from AudioFormat
virtual	~AudioFormat ()
	Destructor.

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

const 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 bool	isCompressed ()
	Returns true if the format uses compressed data.

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

Static Public Member Functions
static StringPairArray	createBWAVMetadata (const String &description, const String &originator, const String &originatorRef, const Time &dateAndTime, const int64 timeReferenceSamples, const String &codingHistory)
	Utility function to fill out the appropriate metadata for a BWAV file.

Static Public Attributes
static const char *const	bwavDescription
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavOriginator
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavOriginatorRef
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavOriginationDate
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavOriginationTime
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavTimeReference
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	bwavCodingHistory
	Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

static const char *const	acidOneShot
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidRootSet
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidStretch
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidDiskBased
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidizerFlag
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidRootNote
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidBeats
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidDenominator
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidNumerator
	Metadata property name used when reading a WAV file with an acid chunk.

static const char *const	acidTempo
	Metadata property name used when reading a WAV file with an acid chunk.

Additional Inherited Members
Protected Member Functions inherited from AudioFormat
	AudioFormat (const String &formatName, const StringArray &fileExtensions)
	Creates an AudioFormat object.

Detailed Description

Reads and Writes WAV format audio files.

See Also: AudioFormat

Constructor & Destructor Documentation

WavAudioFormat::WavAudioFormat ( )

Creates a format object.

WavAudioFormat::~WavAudioFormat ( )

Destructor.

Member Function Documentation

static StringPairArray WavAudioFormat::createBWAVMetadata	(	const String &	description,
		const String &	originator,
		const String &	originatorRef,
		const Time &	dateAndTime,
		const int64	timeReferenceSamples,
		const String &	codingHistory
	)

static

Utility function to fill out the appropriate metadata for a BWAV file.

This just makes it easier than using the property names directly, and it fills out the time and date in the right format.

Array<int> WavAudioFormat::getPossibleSampleRates ( )

virtual

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

Implements AudioFormat.

Array<int> WavAudioFormat::getPossibleBitDepths ( )

virtual

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

Implements AudioFormat.

bool WavAudioFormat::canDoStereo ( )

virtual

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

Implements AudioFormat.

bool WavAudioFormat::canDoMono ( )

virtual

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

Implements AudioFormat.

AudioFormatReader* WavAudioFormat::createReaderFor	(	InputStream *	sourceStream,
		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.

MemoryMappedAudioFormatReader* WavAudioFormat::createMemoryMappedReader ( const File & file )

virtual

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

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

Reimplemented from AudioFormat.

AudioFormatWriter* WavAudioFormat::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.

bool WavAudioFormat::replaceMetadataInFile	(	const File &	wavFile,
		const StringPairArray &	newMetadata
	)

Utility function to replace the metadata in a wav file with a new set of values.

If possible, this cheats by overwriting just the metadata region of the file, rather than by copying the whole file again.

Member Data Documentation

const char* const WavAudioFormat::bwavDescription

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavOriginator

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavOriginatorRef

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavOriginationDate

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

Date format is: yyyy-mm-dd

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavOriginationTime

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

Time format is: hh-mm-ss

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavTimeReference

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

This is the number of samples from the start of an edit that the file is supposed to begin at. Seems like an obvious mistake to only allow a file to occur in an edit once, but that's the way it is..

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::bwavCodingHistory

static

Metadata property name used by wav readers and writers for adding a BWAV chunk to the file.

See Also: AudioFormatReader::metadataValues, createWriterFor

const char* const WavAudioFormat::acidOneShot

static