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

#include <juce_WavAudioFormat.h>

Inheritance diagram for juce::WavAudioFormat:

Collaboration diagram for juce::WavAudioFormat:

[legend]

Public Member Functions
	WavAudioFormat ()
	Creates a format object. More...

	~WavAudioFormat () 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...

virtual bool	canHandleFile (const File &fileToTest)
	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...

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

AudioFormatWriter *	createWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, const AudioChannelSet &channelLayout, 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 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...

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

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

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

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

Static Public Attributes
static const char *const	acidBeats
	Metadata property name used in acid chunks. More...

static const char *const	acidDenominator
	Metadata property name used in acid chunks. More...

static const char *const	acidDiskBased
	Metadata property name used in acid chunks. More...

static const char *const	acidizerFlag
	Metadata property name used in acid chunks. More...

static const char *const	acidNumerator
	Metadata property name used in acid chunks. More...

static const char *const	acidOneShot
	Metadata property name used in acid chunks. More...

static const char *const	acidRootNote
	Metadata property name used in acid chunks. More...

static const char *const	acidRootSet
	Metadata property name used in acid chunks. More...

static const char *const	acidStretch
	Metadata property name used in acid chunks. More...

static const char *const	acidTempo
	Metadata property name used in acid chunks. More...

static const char *const	bwavCodingHistory
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavDescription
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavOriginationDate
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavOriginationTime
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavOriginator
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavOriginatorRef
	Metadata property name used in BWAV chunks. More...

static const char *const	bwavTimeReference
	Metadata property name used in BWAV chunks. More...

static const char *const	ISRC
	Metadata property name used when reading an ISRC code from an AXML chunk. More...

static const char *const	riffInfoArchivalLocation
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoArtist
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoBaseURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCinematographer
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoComment
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoComment2
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoComments
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCommissioned
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCopyright
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCostumeDesigner
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCountry
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoCropped
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDateCreated
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDateTimeOriginal
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDefaultAudioStream
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDimension
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDirectory
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDistributedBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoDotsPerInch
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoEditedBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoEighthLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoEncodedBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoEndTimecode
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoEngineer
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoFifthLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoFirstLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoFourthLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoGenre
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoKeywords
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLength
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLightness
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLocation
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLogoIconURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoLogoURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMedium
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMoreInfoBannerImage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMoreInfoBannerURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMoreInfoText
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMoreInfoURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoMusicBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoNinthLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoNumberOfParts
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoOrganisation
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoPart
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoProducedBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoProductionDesigner
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoProductionStudio
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoProductName
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoRate
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoRated
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoRating
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoRippedBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSecondaryGenre
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSecondLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSeventhLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSharpness
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSixthLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSoftware
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSoundSchemeTitle
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSource
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSourceFrom
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoStarring_ISTR
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoStarring_STAR
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoStartTimecode
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoStatistics
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoSubject
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTapeName
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTechnician
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoThirdLanguage
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTimeCode
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTitle
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTrackNo
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoTrackNumber
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoVegasVersionMajor
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoVegasVersionMinor
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoVersion
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoWatermarkURL
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoWrittenBy
	Metadata property name used in INFO chunks. More...

static const char *const	riffInfoYear
	Metadata property name used in INFO chunks. More...

static const char *const	tracktionLoopInfo
	Metadata property name used when reading a WAV file with a Tracktion chunk. More...

Detailed Description

Reads and Writes WAV format audio files.

See also: AudioFormat

{Audio}

Constructor & Destructor Documentation

◆ WavAudioFormat()

juce::WavAudioFormat::WavAudioFormat ( )

Creates a format object.

◆ ~WavAudioFormat()

juce::WavAudioFormat::~WavAudioFormat ( )

override

Destructor.

Member Function Documentation

◆ canDoMono()

bool juce::WavAudioFormat::canDoMono ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ canDoStereo()

bool juce::WavAudioFormat::canDoStereo ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ canHandleFile()

virtual bool juce::AudioFormat::canHandleFile ( const File & fileToTest )

virtualinherited

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 in juce::AiffAudioFormat, and juce::LAMEEncoderAudioFormat.

◆ createBWAVMetadata()

static StringPairArray juce::WavAudioFormat::createBWAVMetadata	(	const String &	description,
		const String &	originator,
		const String &	originatorRef,
		Time	dateAndTime,
		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.

◆ createMemoryMappedReader() [1/2]

MemoryMappedAudioFormatReader* juce::WavAudioFormat::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::WavAudioFormat::createMemoryMappedReader ( FileInputStream * )

overridevirtual

Reimplemented from juce::AudioFormat.

◆ createReaderFor()

AudioFormatReader* juce::WavAudioFormat::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/2]

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

◆ createWriterFor() [2/2]

AudioFormatWriter* juce::WavAudioFormat::createWriterFor	(	OutputStream *	streamToWriteTo,
		double	sampleRateToUse,
		const AudioChannelSet &	channelLayout,
		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()
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 from juce::AudioFormat.

◆ 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::WavAudioFormat::getPossibleBitDepths ( )

overridevirtual

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

Implements juce::AudioFormat.

◆ getPossibleSampleRates()

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

◆ isChannelLayoutSupported()

bool juce::WavAudioFormat::isChannelLayoutSupported ( const AudioChannelSet & channelSet )

overridevirtual

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

Reimplemented from juce::AudioFormat.

◆ isCompressed()

virtual bool juce::AudioFormat::isCompressed ( )

virtualinherited

Returns true if the format uses compressed data.

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

◆ replaceMetadataInFile()

bool juce::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

◆ acidBeats

const char* const juce::WavAudioFormat::acidBeats

static

Metadata property name used in acid chunks.

◆ acidDenominator

const char* const juce::WavAudioFormat::acidDenominator

static

Metadata property name used in acid chunks.

◆ acidDiskBased

const char* const juce::WavAudioFormat::acidDiskBased

static

Metadata property name used in acid chunks.

◆ acidizerFlag

const char* const juce::WavAudioFormat::acidizerFlag

static

Metadata property name used in acid chunks.

◆ acidNumerator

const char* const juce::WavAudioFormat::acidNumerator

static

Metadata property name used in acid chunks.

◆ acidOneShot

const char* const juce::WavAudioFormat::acidOneShot

static

Metadata property name used in acid chunks.

◆ acidRootNote

const char* const juce::WavAudioFormat::acidRootNote

static

Metadata property name used in acid chunks.

◆ acidRootSet

const char* const juce::WavAudioFormat::acidRootSet

static

Metadata property name used in acid chunks.

◆ acidStretch

const char* const juce::WavAudioFormat::acidStretch

static

Metadata property name used in acid chunks.

◆ acidTempo

const char* const juce::WavAudioFormat::acidTempo

static

Metadata property name used in acid chunks.

◆ bwavCodingHistory

const char* const juce::WavAudioFormat::bwavCodingHistory

static

Metadata property name used in BWAV chunks.

◆ bwavDescription

const char* const juce::WavAudioFormat::bwavDescription

static

Metadata property name used in BWAV chunks.

◆ bwavOriginationDate

const char* const juce::WavAudioFormat::bwavOriginationDate

static

Metadata property name used in BWAV chunks.

The format should be: yyyy-mm-dd

◆ bwavOriginationTime

const char* const juce::WavAudioFormat::bwavOriginationTime

static

Metadata property name used in BWAV chunks.

The format should be: format is: hh-mm-ss

◆ bwavOriginator

const char* const juce::WavAudioFormat::bwavOriginator

static

Metadata property name used in BWAV chunks.

◆ bwavOriginatorRef

const char* const juce::WavAudioFormat::bwavOriginatorRef

static

Metadata property name used in BWAV chunks.

◆ bwavTimeReference

const char* const juce::WavAudioFormat::bwavTimeReference

static

Metadata property name used in BWAV chunks.

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

◆ ISRC

const char* const juce::WavAudioFormat::ISRC

static

Metadata property name used when reading an ISRC code from an AXML chunk.