OpenShot Audio Library | OpenShotAudio 0.3.2
Loading...
Searching...
No Matches
juce::AudioFormatWriter Class Referenceabstract

#include <juce_AudioFormatWriter.h>

Inherited by juce::AiffAudioFormatWriter, and juce::WavAudioFormatWriter.

Classes

class  ThreadedWriter
 
struct  WriteHelper
 

Public Member Functions

virtual ~AudioFormatWriter ()
 
const StringgetFormatName () const noexcept
 
virtual bool write (const int **samplesToWrite, int numSamples)=0
 
virtual bool flush ()
 
bool writeFromAudioReader (AudioFormatReader &reader, int64 startSample, int64 numSamplesToRead)
 
bool writeFromAudioSource (AudioSource &source, int numSamplesToRead, int samplesPerBlock=2048)
 
bool writeFromAudioSampleBuffer (const AudioBuffer< float > &source, int startSample, int numSamples)
 
bool writeFromFloatArrays (const float *const *channels, int numChannels, int numSamples)
 
double getSampleRate () const noexcept
 
int getNumChannels () const noexcept
 
int getBitsPerSample () const noexcept
 
bool isFloatingPoint () const noexcept
 

Protected Member Functions

 AudioFormatWriter (OutputStream *destStream, const String &formatName, double sampleRate, unsigned int numberOfChannels, unsigned int bitsPerSample)
 
 AudioFormatWriter (OutputStream *destStream, const String &formatName, double sampleRate, const AudioChannelSet &audioChannelLayout, unsigned int bitsPerSample)
 

Protected Attributes

double sampleRate
 
unsigned int numChannels
 
unsigned int bitsPerSample
 
bool usesFloatingPointData
 
AudioChannelSet channelLayout
 
OutputStreamoutput
 

Detailed Description

Writes samples to an audio file stream.

A subclass that writes a specific type of audio format will be created by an AudioFormat object.

After creating one of these with the AudioFormat::createWriterFor() method you can call its write() method to store the samples, and then delete it.

See also
AudioFormat, AudioFormatReader

Definition at line 44 of file juce_AudioFormatWriter.h.

Constructor & Destructor Documentation

◆ AudioFormatWriter() [1/2]

juce::AudioFormatWriter::AudioFormatWriter ( OutputStream destStream,
const String formatName,
double  sampleRate,
unsigned int  numberOfChannels,
unsigned int  bitsPerSample 
)
protected

Creates an AudioFormatWriter object.

Parameters
destStreamthe stream to write to - this will be deleted by this object when it is no longer needed
formatNamethe description that will be returned by the getFormatName() method
sampleRatethe sample rate to use - the base class just stores this value, it doesn't do anything with it
numberOfChannelsthe number of channels to write - the base class just stores this value, it doesn't do anything with it
bitsPerSamplethe bit depth of the stream - the base class just stores this value, it doesn't do anything with it

Definition at line 30 of file juce_AudioFormatWriter.cpp.

◆ AudioFormatWriter() [2/2]

juce::AudioFormatWriter::AudioFormatWriter ( OutputStream destStream,
const String formatName,
double  sampleRate,
const AudioChannelSet audioChannelLayout,
unsigned int  bitsPerSample 
)
protected

Creates an AudioFormatWriter object.

Parameters
destStreamthe stream to write to - this will be deleted by this object when it is no longer needed
formatNamethe description that will be returned by the getFormatName() method
sampleRatethe sample rate to use - the base class just stores this value, it doesn't do anything with it
audioChannelLayoutthe channel layout to use for the writer - the base class just stores this value, it doesn't do anything with it
bitsPerSamplethe bit depth of the stream - the base class just stores this value, it doesn't do anything with it

Definition at line 45 of file juce_AudioFormatWriter.cpp.

◆ ~AudioFormatWriter()

juce::AudioFormatWriter::~AudioFormatWriter ( )
virtual

Destructor.

Definition at line 60 of file juce_AudioFormatWriter.cpp.

Member Function Documentation

◆ flush()

bool juce::AudioFormatWriter::flush ( )
virtual

Some formats may support a flush operation that makes sure the file is in a valid state before carrying on. If supported, this means that by calling flush periodically when writing data to a large file, then it should still be left in a readable state if your program crashes. It goes without saying that this method must be called from the same thread that's calling write()! If the format supports flushing and the operation succeeds, this returns true.

Definition at line 207 of file juce_AudioFormatWriter.cpp.

◆ getBitsPerSample()

int juce::AudioFormatWriter::getBitsPerSample ( ) const
inlinenoexcept

Returns the bit-depth of the data being written.

Definition at line 174 of file juce_AudioFormatWriter.h.

◆ getFormatName()

const String & juce::AudioFormatWriter::getFormatName ( ) const
inlinenoexcept

Returns a description of what type of format this is.

E.g. "AIFF file"

Definition at line 96 of file juce_AudioFormatWriter.h.

◆ getNumChannels()

int juce::AudioFormatWriter::getNumChannels ( ) const
inlinenoexcept

Returns the number of channels being written.

Definition at line 171 of file juce_AudioFormatWriter.h.

Referenced by writeFromAudioSource().

◆ getSampleRate()

double juce::AudioFormatWriter::getSampleRate ( ) const
inlinenoexcept

Returns the sample rate being used.

Definition at line 168 of file juce_AudioFormatWriter.h.

◆ isFloatingPoint()

bool juce::AudioFormatWriter::isFloatingPoint ( ) const
inlinenoexcept

Returns true if it's a floating-point format, false if it's fixed-point.

Definition at line 177 of file juce_AudioFormatWriter.h.

Referenced by writeFromAudioReader(), and writeFromFloatArrays().

◆ write()

virtual bool juce::AudioFormatWriter::write ( const int **  samplesToWrite,
int  numSamples 
)
pure virtual

Writes a set of samples to the audio stream.

Note that if you're trying to write the contents of an AudioBuffer, you can use writeFromAudioSampleBuffer().

Parameters
samplesToWritean array of arrays containing the sample data for each channel to write. This is a zero-terminated array of arrays, and can contain a different number of channels than the actual stream uses, and the writer should do its best to cope with this. If the format is fixed-point, each channel will be formatted as an array of signed integers using the full 32-bit range -0x80000000 to 0x7fffffff, regardless of the source's bit-depth. If it is a floating-point format, you should treat the arrays as arrays of floats, and just cast it to an (int**) to pass it into the method.
numSamplesthe number of samples to write

Referenced by writeFromAudioReader(), and writeFromFloatArrays().

◆ writeFromAudioReader()

bool juce::AudioFormatWriter::writeFromAudioReader ( AudioFormatReader reader,
int64  startSample,
int64  numSamplesToRead 
)

Reads a section of samples from an AudioFormatReader, and writes these to the output.

This will take care of any floating-point conversion that's required to convert between the two formats. It won't deal with sample-rate conversion, though.

If numSamplesToRead < 0, it will write the entire length of the reader.

Returns
false if it can't read or write properly during the operation

Definition at line 82 of file juce_AudioFormatWriter.cpp.

◆ writeFromAudioSampleBuffer()

bool juce::AudioFormatWriter::writeFromAudioSampleBuffer ( const AudioBuffer< float > &  source,
int  startSample,
int  numSamples 
)

Writes some samples from an AudioBuffer.

Definition at line 188 of file juce_AudioFormatWriter.cpp.

Referenced by writeFromAudioSource().

◆ writeFromAudioSource()

bool juce::AudioFormatWriter::writeFromAudioSource ( AudioSource source,
int  numSamplesToRead,
int  samplesPerBlock = 2048 
)

Reads some samples from an AudioSource, and writes these to the output.

The source must already have been initialised with the AudioSource::prepareToPlay() method

Parameters
sourcethe source to read from
numSamplesToReadtotal number of samples to read and write
samplesPerBlockthe maximum number of samples to fetch from the source
Returns
false if it can't read or write properly during the operation

Definition at line 129 of file juce_AudioFormatWriter.cpp.

◆ writeFromFloatArrays()

bool juce::AudioFormatWriter::writeFromFloatArrays ( const float *const channels,
int  numChannels,
int  numSamples 
)

Writes some samples from a set of float data channels.

Definition at line 151 of file juce_AudioFormatWriter.cpp.

Referenced by writeFromAudioSampleBuffer().

Member Data Documentation

◆ bitsPerSample

unsigned int juce::AudioFormatWriter::bitsPerSample
protected

The bit depth of the file.

Definition at line 255 of file juce_AudioFormatWriter.h.

◆ channelLayout

AudioChannelSet juce::AudioFormatWriter::channelLayout
protected

The audio channel layout that the writer should use

Definition at line 261 of file juce_AudioFormatWriter.h.

◆ numChannels

unsigned int juce::AudioFormatWriter::numChannels
protected

The number of channels being written to the stream.

Definition at line 252 of file juce_AudioFormatWriter.h.

Referenced by writeFromAudioReader(), and writeFromAudioSampleBuffer().

◆ output

OutputStream* juce::AudioFormatWriter::output
protected

The output stream for use by subclasses.

Definition at line 264 of file juce_AudioFormatWriter.h.

Referenced by ~AudioFormatWriter().

◆ sampleRate

double juce::AudioFormatWriter::sampleRate
protected

The sample rate of the stream.

Definition at line 249 of file juce_AudioFormatWriter.h.

◆ usesFloatingPointData

bool juce::AudioFormatWriter::usesFloatingPointData
protected

True if it's a floating-point format, false if it's fixed-point.

Definition at line 258 of file juce_AudioFormatWriter.h.


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