A multi-channel buffer of 32-bit floating point audio samples. More...

Public Member Functions
	AudioSampleBuffer (int numChannels, int numSamples) noexcept
	Creates a buffer with a specified number of channels and samples.
	AudioSampleBuffer (float **dataToReferTo, int numChannels, int numSamples) noexcept
	Creates a buffer using a pre-allocated block of memory.
	AudioSampleBuffer (float **dataToReferTo, int numChannels, int startSample, int numSamples) noexcept
	Creates a buffer using a pre-allocated block of memory.
	AudioSampleBuffer (const AudioSampleBuffer &other) noexcept
	Copies another buffer.
AudioSampleBuffer &	operator= (const AudioSampleBuffer &other) noexcept
	Copies another buffer onto this one.
virtual	~AudioSampleBuffer () noexcept
	Destructor.
int	getNumChannels () const noexcept
	Returns the number of channels of audio data that this buffer contains.
int	getNumSamples () const noexcept
	Returns the number of samples allocated in each of the buffer's channels.
float *	getSampleData (const int channelNumber) const noexcept
	Returns a pointer one of the buffer's channels.
float *	getSampleData (const int channelNumber, const int sampleOffset) const noexcept
	Returns a pointer to a sample in one of the buffer's channels.
float **	getArrayOfChannels () const noexcept
	Returns an array of pointers to the channels in the buffer.
void	setSize (int newNumChannels, int newNumSamples, bool keepExistingContent=false, bool clearExtraSpace=false, bool avoidReallocating=false) noexcept
	Changes the buffer's size or number of channels.
void	setDataToReferTo (float **dataToReferTo, int numChannels, int numSamples) noexcept
	Makes this buffer point to a pre-allocated set of channel data arrays.
void	clear () noexcept
	Clears all the samples in all channels.
void	clear (int startSample, int numSamples) noexcept
	Clears a specified region of all the channels.
void	clear (int channel, int startSample, int numSamples) noexcept
	Clears a specified region of just one channel.
void	applyGain (int channel, int startSample, int numSamples, float gain) noexcept
	Applies a gain multiple to a region of one channel.
void	applyGain (int startSample, int numSamples, float gain) noexcept
	Applies a gain multiple to a region of all the channels.
void	applyGainRamp (int channel, int startSample, int numSamples, float startGain, float endGain) noexcept
	Applies a range of gains to a region of a channel.
void	addFrom (int destChannel, int destStartSample, const AudioSampleBuffer &source, int sourceChannel, int sourceStartSample, int numSamples, float gainToApplyToSource=1.0f) noexcept
	Adds samples from another buffer to this one.
void	addFrom (int destChannel, int destStartSample, const float *source, int numSamples, float gainToApplyToSource=1.0f) noexcept
	Adds samples from an array of floats to one of the channels.
void	addFromWithRamp (int destChannel, int destStartSample, const float *source, int numSamples, float startGain, float endGain) noexcept
	Adds samples from an array of floats, applying a gain ramp to them.
void	copyFrom (int destChannel, int destStartSample, const AudioSampleBuffer &source, int sourceChannel, int sourceStartSample, int numSamples) noexcept
	Copies samples from another buffer to this one.
void	copyFrom (int destChannel, int destStartSample, const float *source, int numSamples) noexcept
	Copies samples from an array of floats into one of the channels.
void	copyFrom (int destChannel, int destStartSample, const float *source, int numSamples, float gain) noexcept
	Copies samples from an array of floats into one of the channels, applying a gain to it.
void	copyFromWithRamp (int destChannel, int destStartSample, const float *source, int numSamples, float startGain, float endGain) noexcept
	Copies samples from an array of floats into one of the channels, applying a gain ramp.
void	findMinMax (int channel, int startSample, int numSamples, float &minVal, float &maxVal) const noexcept
	Finds the highest and lowest sample values in a given range.
float	getMagnitude (int channel, int startSample, int numSamples) const noexcept
	Finds the highest absolute sample value within a region of a channel.
float	getMagnitude (int startSample, int numSamples) const noexcept
	Finds the highest absolute sample value within a region on all channels.
float	getRMSLevel (int channel, int startSample, int numSamples) const noexcept
	Returns the root mean squared level for a region of a channel.
void	readFromAudioReader (AudioFormatReader *reader, int startSample, int numSamples, int64 readerStartSample, bool useReaderLeftChan, bool useReaderRightChan)
	Fills a section of the buffer using an AudioReader as its source.
void	writeToAudioWriter (AudioFormatWriter *writer, int startSample, int numSamples) const
	Writes a section of this buffer to an audio writer.

Detailed Description

A multi-channel buffer of 32-bit floating point audio samples.

Constructor & Destructor Documentation

AudioSampleBuffer::AudioSampleBuffer	(	int	numChannels,
		int	numSamples
	)

Creates a buffer with a specified number of channels and samples.

The contents of the buffer will initially be undefined, so use clear() to set all the samples to zero.

The buffer will allocate its memory internally, and this will be released when the buffer is deleted.

AudioSampleBuffer::AudioSampleBuffer	(	float **	dataToReferTo,
		int	numChannels,
		int	numSamples
	)

Creates a buffer using a pre-allocated block of memory.

Note that if the buffer is resized or its number of channels is changed, it will re-allocate memory internally and copy the existing data to this new area, so it will then stop directly addressing this memory.

Parameters:

dataToReferTo	a pre-allocated array containing pointers to the data for each channel that should be used by this buffer. The buffer will only refer to this memory, it won't try to delete it when the buffer is deleted or resized.
numChannels	the number of channels to use - this must correspond to the number of elements in the array passed in
numSamples	the number of samples to use - this must correspond to the size of the arrays passed in

AudioSampleBuffer::AudioSampleBuffer	(	float **	dataToReferTo,
		int	numChannels,
		int	startSample,
		int	numSamples
	)

Creates a buffer using a pre-allocated block of memory.

Note that if the buffer is resized or its number of channels is changed, it will re-allocate memory internally and copy the existing data to this new area, so it will then stop directly addressing this memory.

Parameters:

dataToReferTo	a pre-allocated array containing pointers to the data for each channel that should be used by this buffer. The buffer will only refer to this memory, it won't try to delete it when the buffer is deleted or resized.
numChannels	the number of channels to use - this must correspond to the number of elements in the array passed in
startSample	the offset within the arrays at which the data begins
numSamples	the number of samples to use - this must correspond to the size of the arrays passed in

AudioSampleBuffer::AudioSampleBuffer ( const AudioSampleBuffer & other )

Copies another buffer.

This buffer will make its own copy of the other's data, unless the buffer was created using an external data buffer, in which case boths buffers will just point to the same shared block of data.

virtual AudioSampleBuffer::~AudioSampleBuffer ( ) [virtual]

Destructor.

This will free any memory allocated by the buffer.

Member Function Documentation

AudioSampleBuffer& AudioSampleBuffer::operator= ( const AudioSampleBuffer & other )

Copies another buffer onto this one.

This buffer's size will be changed to that of the other buffer.

int AudioSampleBuffer::getNumChannels ( ) const

Returns the number of channels of audio data that this buffer contains.

See also:: getSampleData

int AudioSampleBuffer::getNumSamples ( ) const

Returns the number of samples allocated in each of the buffer's channels.

See also:: getSampleData

float* AudioSampleBuffer::getSampleData ( const int channelNumber ) const

Returns a pointer one of the buffer's channels.

For speed, this doesn't check whether the channel number is out of range, so be careful when using it!

References isPositiveAndBelow(), and jassert.

float* AudioSampleBuffer::getSampleData	(	const int	channelNumber,
		const int	sampleOffset
	)		const

Returns a pointer to a sample in one of the buffer's channels.

For speed, this doesn't check whether the channel and sample number are out-of-range, so be careful when using it!

References isPositiveAndBelow(), and jassert.

float** AudioSampleBuffer::getArrayOfChannels ( ) const

Returns an array of pointers to the channels in the buffer.

Don't modify any of the pointers that are returned, and bear in mind that these will become invalid if the buffer is resized.

void AudioSampleBuffer::setSize	(	int	newNumChannels,
		int	newNumSamples,
		bool	keepExistingContent = `false`,
		bool	clearExtraSpace = `false`,
		bool	avoidReallocating = `false`
	)

Changes the buffer's size or number of channels.

This can expand or contract the buffer's length, and add or remove channels.

If keepExistingContent is true, it will try to preserve as much of the old data as it can in the new buffer.

If clearExtraSpace is true, then any extra channels or space that is allocated will be also be cleared. If false, then this space is left uninitialised.

If avoidReallocating is true, then changing the buffer's size won't reduce the amount of memory that is currently allocated (but it will still increase it if the new size is bigger than the amount it currently has). If this is false, then a new allocation will be done so that the buffer uses takes up the minimum amount of memory that it needs.

void AudioSampleBuffer::setDataToReferTo	(	float **	dataToReferTo,
		int	numChannels,
		int	numSamples
	)

Makes this buffer point to a pre-allocated set of channel data arrays.

There's also a constructor that lets you specify arrays like this, but this lets you change the channels dynamically.

Note that if the buffer is resized or its number of channels is changed, it will re-allocate memory internally and copy the existing data to this new area, so it will then stop directly addressing this memory.

Parameters:

dataToReferTo	a pre-allocated array containing pointers to the data for each channel that should be used by this buffer. The buffer will only refer to this memory, it won't try to delete it when the buffer is deleted or resized.
numChannels	the number of channels to use - this must correspond to the number of elements in the array passed in
numSamples	the number of samples to use - this must correspond to the size of the arrays passed in

void AudioSampleBuffer::clear ( )

Clears all the samples in all channels.

void AudioSampleBuffer::clear	(	int	startSample,
		int	numSamples
	)

Clears a specified region of all the channels.

For speed, this doesn't check whether the channel and sample number are in-range, so be careful!

void AudioSampleBuffer::clear	(	int	channel,
		int	startSample,
		int	numSamples
	)

Clears a specified region of just one channel.

For speed, this doesn't check whether the channel and sample number are in-range, so be careful!

void AudioSampleBuffer::applyGain	(	int	channel,
		int	startSample,
		int	numSamples,
		float	gain
	)

Applies a gain multiple to a region of one channel.

For speed, this doesn't check whether the channel and sample number are in-range, so be careful!

void AudioSampleBuffer::applyGain	(	int	startSample,
		int	numSamples,
		float	gain
	)

Applies a gain multiple to a region of all the channels.

For speed, this doesn't check whether the sample numbers are in-range, so be careful!

void AudioSampleBuffer::applyGainRamp	(	int	channel,
		int	startSample,
		int	numSamples,
		float	startGain,
		float	endGain
	)

Applies a range of gains to a region of a channel.

The gain that is applied to each sample will vary from startGain on the first sample to endGain on the last Sample, so it can be used to do basic fades.

For speed, this doesn't check whether the sample numbers are in-range, so be careful!

void AudioSampleBuffer::addFrom	(	int	destChannel,
		int	destStartSample,
		const AudioSampleBuffer &	source,
		int	sourceChannel,
		int	sourceStartSample,
		int	numSamples,
		float	gainToApplyToSource = `1.0f`
	)

Adds samples from another buffer to this one.

Parameters:

destChannel	the channel within this buffer to add the samples to
destStartSample	the start sample within this buffer's channel
source	the source buffer to add from
sourceChannel	the channel within the source buffer to read from
sourceStartSample	the offset within the source buffer's channel to start reading samples from
numSamples	the number of samples to process
gainToApplyToSource	an optional gain to apply to the source samples before they are added to this buffer's samples

See also:: copyFrom

void AudioSampleBuffer::addFrom	(	int	destChannel,
		int	destStartSample,
		const float *	source,
		int	numSamples,
		float	gainToApplyToSource = `1.0f`
	)

Adds samples from an array of floats to one of the channels.

Parameters:

destChannel	the channel within this buffer to add the samples to
destStartSample	the start sample within this buffer's channel
source	the source data to use
numSamples	the number of samples to process
gainToApplyToSource	an optional gain to apply to the source samples before they are added to this buffer's samples

See also:: copyFrom

void AudioSampleBuffer::addFromWithRamp	(	int	destChannel,
		int	destStartSample,
		const float *	source,
		int	numSamples,
		float	startGain,
		float	endGain
	)

Adds samples from an array of floats, applying a gain ramp to them.

Parameters:

destChannel	the channel within this buffer to add the samples to
destStartSample	the start sample within this buffer's channel
source	the source data to use
numSamples	the number of samples to process
startGain	the gain to apply to the first sample (this is multiplied with the source samples before they are added to this buffer)
endGain	the gain to apply to the final sample. The gain is linearly interpolated between the first and last samples.

void AudioSampleBuffer::copyFrom	(	int	destChannel,
		int	destStartSample,
		const AudioSampleBuffer &	source,
		int	sourceChannel,
		int	sourceStartSample,
		int	numSamples
	)

Copies samples from another buffer to this one.

Parameters:

destChannel	the channel within this buffer to copy the samples to
destStartSample	the start sample within this buffer's channel
source	the source buffer to read from
sourceChannel	the channel within the source buffer to read from
sourceStartSample	the offset within the source buffer's channel to start reading samples from
numSamples	the number of samples to process

See also:: addFrom

void AudioSampleBuffer::copyFrom	(	int	destChannel,
		int	destStartSample,
		const float *	source,
		int	numSamples
	)

Copies samples from an array of floats into one of the channels.

Parameters:

destChannel	the channel within this buffer to copy the samples to
destStartSample	the start sample within this buffer's channel
source	the source buffer to read from
numSamples	the number of samples to process

See also:: addFrom

void AudioSampleBuffer::copyFrom	(	int	destChannel,
		int	destStartSample,
		const float *	source,
		int	numSamples,
		float	gain
	)

Copies samples from an array of floats into one of the channels, applying a gain to it.

Parameters:

destChannel	the channel within this buffer to copy the samples to
destStartSample	the start sample within this buffer's channel
source	the source buffer to read from
numSamples	the number of samples to process
gain	the gain to apply

See also:: addFrom

void AudioSampleBuffer::copyFromWithRamp	(	int	destChannel,
		int	destStartSample,
		const float *	source,
		int	numSamples,
		float	startGain,
		float	endGain
	)

Copies samples from an array of floats into one of the channels, applying a gain ramp.

Parameters:

destChannel	the channel within this buffer to copy the samples to
destStartSample	the start sample within this buffer's channel
source	the source buffer to read from
numSamples	the number of samples to process
startGain	the gain to apply to the first sample (this is multiplied with the source samples before they are copied to this buffer)
endGain	the gain to apply to the final sample. The gain is linearly interpolated between the first and last samples.

See also:: addFrom

void AudioSampleBuffer::findMinMax	(	int	channel,
		int	startSample,
		int	numSamples,
		float &	minVal,
		float &	maxVal
	)		const

Finds the highest and lowest sample values in a given range.

Parameters:

channel	the channel to read from
startSample	the start sample within the channel
numSamples	the number of samples to check
minVal	on return, the lowest value that was found
maxVal	on return, the highest value that was found

float AudioSampleBuffer::getMagnitude	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

Finds the highest absolute sample value within a region of a channel.

float AudioSampleBuffer::getMagnitude	(	int	startSample,
		int	numSamples
	)		const

Finds the highest absolute sample value within a region on all channels.

float AudioSampleBuffer::getRMSLevel	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

Returns the root mean squared level for a region of a channel.

void AudioSampleBuffer::readFromAudioReader	(	AudioFormatReader *	reader,
		int	startSample,
		int	numSamples,
		int64	readerStartSample,
		bool	useReaderLeftChan,
		bool	useReaderRightChan
	)

Fills a section of the buffer using an AudioReader as its source.

This will convert the reader's fixed- or floating-point data to the buffer's floating-point format, and will try to intelligently cope with mismatches between the number of channels in the reader and the buffer.

See also:: writeToAudioWriter

void AudioSampleBuffer::writeToAudioWriter	(	AudioFormatWriter *	writer,
		int	startSample,
		int	numSamples
	)		const

Writes a section of this buffer to an audio writer.

This saves you having to mess about with channels or floating/fixed point conversion.

See also:: readFromAudioReader

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

juce_AudioSampleBuffer.h

AudioSampleBuffer Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation