#include <juce_WavAudioFormat.h>
Reads and Writes WAV format audio files.
- See also
- AudioFormat
◆ WavAudioFormat()
WavAudioFormat::WavAudioFormat |
( |
| ) |
|
◆ ~WavAudioFormat()
WavAudioFormat::~WavAudioFormat |
( |
| ) |
|
◆ canDoMono()
bool WavAudioFormat::canDoMono |
( |
| ) |
|
|
overridevirtual |
Returns true if the format can do 1-channel audio.
Implements AudioFormat.
◆ canDoStereo()
bool WavAudioFormat::canDoStereo |
( |
| ) |
|
|
overridevirtual |
Returns true if the format can do 2-channel audio.
Implements AudioFormat.
◆ createBWAVMetadata()
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()
◆ createReaderFor()
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.
◆ createWriterFor()
AudioFormatWriter * 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 AudioFormat.
◆ getPossibleBitDepths()
Array< int > WavAudioFormat::getPossibleBitDepths |
( |
| ) |
|
|
overridevirtual |
Returns a set of bit depths that the format can read and write.
Implements AudioFormat.
◆ getPossibleSampleRates()
Array< int > WavAudioFormat::getPossibleSampleRates |
( |
| ) |
|
|
overridevirtual |
Returns a set of sample rates that the format can read and write.
Implements AudioFormat.
◆ replaceMetadataInFile()
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.
◆ acidBeats
const char *const WavAudioFormat::acidBeats = "acid beats" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidDenominator
const char *const WavAudioFormat::acidDenominator = "acid denominator" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidDiskBased
const char *const WavAudioFormat::acidDiskBased = "acid disk based" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidizerFlag
const char *const WavAudioFormat::acidizerFlag = "acidizer flag" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidNumerator
const char *const WavAudioFormat::acidNumerator = "acid numerator" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidOneShot
const char *const WavAudioFormat::acidOneShot = "acid one shot" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidRootNote
const char *const WavAudioFormat::acidRootNote = "acid root note" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidRootSet
const char *const WavAudioFormat::acidRootSet = "acid root set" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidStretch
const char *const WavAudioFormat::acidStretch = "acid stretch" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ acidTempo
const char *const WavAudioFormat::acidTempo = "acid tempo" |
|
static |
Metadata property name used when reading a WAV file with an acid chunk.
◆ bwavCodingHistory
const char *const WavAudioFormat::bwavCodingHistory = "bwav coding history" |
|
static |
◆ bwavDescription
const char *const WavAudioFormat::bwavDescription = "bwav description" |
|
static |
◆ bwavOriginationDate
const char *const WavAudioFormat::bwavOriginationDate = "bwav origination date" |
|
static |
◆ bwavOriginationTime
const char *const WavAudioFormat::bwavOriginationTime = "bwav origination time" |
|
static |
◆ bwavOriginator
const char *const WavAudioFormat::bwavOriginator = "bwav originator" |
|
static |
◆ bwavOriginatorRef
const char *const WavAudioFormat::bwavOriginatorRef = "bwav originator ref" |
|
static |
◆ bwavTimeReference
const char *const WavAudioFormat::bwavTimeReference = "bwav time reference" |
|
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
◆ ISRC
const char *const WavAudioFormat::ISRC = "ISRC" |
|
static |
Metadata property name used when reading an ISRC code from an AXML chunk.
◆ tracktionLoopInfo
const char *const WavAudioFormat::tracktionLoopInfo = "tracktion loop info" |
|
static |
Metadata property name used when reading a WAV file with a Tracktion chunk.
The documentation for this class was generated from the following files: