A multi-channel buffer containing floating point audio samples. More...

#include <juce_AudioSampleBuffer.h>

Inheritance diagram for juce::AudioBuffer< Type >:

[legend]

Collaboration diagram for juce::AudioBuffer< Type >:

[legend]

Public Types
using	SampleType = Type
	This allows templated code that takes an AudioBuffer to access its sample type. More...

Public Member Functions
	AudioBuffer () noexcept
	Creates an empty buffer with 0 channels and 0 length. More...

	AudioBuffer (AudioBuffer &&other) noexcept
	Move constructor. More...

	AudioBuffer (const AudioBuffer &other)
	Copies another buffer. More...

	AudioBuffer (int numChannelsToAllocate, int numSamplesToAllocate)
	Creates a buffer with a specified number of channels and samples. More...

	AudioBuffer (Type const dataToReferTo, int numChannelsToUse, int numSamples)
	Creates a buffer using a pre-allocated block of memory. More...

	AudioBuffer (Type const dataToReferTo, int numChannelsToUse, int startSample, int numSamples)
	Creates a buffer using a pre-allocated block of memory. More...

	~AudioBuffer ()=default
	Destructor. More...

void	addFrom (int destChannel, int destStartSample, const AudioBuffer &source, int sourceChannel, int sourceStartSample, int numSamples, Type gainToApplyToSource=Type(1)) noexcept
	Adds samples from another buffer to this one. More...

void	addFrom (int destChannel, int destStartSample, const Type *source, int numSamples, Type gainToApplyToSource=Type(1)) noexcept
	Adds samples from an array of floats to one of the channels. More...

void	addFromWithRamp (int destChannel, int destStartSample, const Type *source, int numSamples, Type startGain, Type endGain) noexcept
	Adds samples from an array of floats, applying a gain ramp to them. More...

void	addSample (int destChannel, int destSample, Type valueToAdd) noexcept
	Adds a value to a sample in the buffer. More...

void	applyGain (int channel, int startSample, int numSamples, Type gain) noexcept
	Applies a gain multiple to a region of one channel. More...

void	applyGain (int startSample, int numSamples, Type gain) noexcept
	Applies a gain multiple to a region of all the channels. More...

void	applyGain (Type gain) noexcept
	Applies a gain multiple to all the audio data. More...

void	applyGainRamp (int channel, int startSample, int numSamples, Type startGain, Type endGain) noexcept
	Applies a range of gains to a region of a channel. More...

void	applyGainRamp (int startSample, int numSamples, Type startGain, Type endGain) noexcept
	Applies a range of gains to a region of all channels. More...

void	clear () noexcept
	Clears all the samples in all channels and marks the buffer as cleared. More...

void	clear (int channel, int startSample, int numSamples) noexcept
	Clears a specified region of just one channel. More...

void	clear (int startSample, int numSamples) noexcept
	Clears a specified region of all the channels. More...

void	copyFrom (int destChannel, int destStartSample, const AudioBuffer &source, int sourceChannel, int sourceStartSample, int numSamples) noexcept
	Copies samples from another buffer to this one. More...

void	copyFrom (int destChannel, int destStartSample, const Type *source, int numSamples) noexcept
	Copies samples from an array of floats into one of the channels. More...

void	copyFrom (int destChannel, int destStartSample, const Type *source, int numSamples, Type gain) noexcept
	Copies samples from an array of floats into one of the channels, applying a gain to it. More...

void	copyFromWithRamp (int destChannel, int destStartSample, const Type *source, int numSamples, Type startGain, Type endGain) noexcept
	Copies samples from an array of floats into one of the channels, applying a gain ramp. More...

Range< Type >	findMinMax (int channel, int startSample, int numSamples) const noexcept
	Returns a Range indicating the lowest and highest sample values in a given section. More...

const Type **	getArrayOfReadPointers () const noexcept
	Returns an array of pointers to the channels in the buffer. More...

Type **	getArrayOfWritePointers () noexcept
	Returns an array of pointers to the channels in the buffer. More...

Type	getMagnitude (int channel, int startSample, int numSamples) const noexcept
	Finds the highest absolute sample value within a region of a channel. More...

Type	getMagnitude (int startSample, int numSamples) const noexcept
	Finds the highest absolute sample value within a region on all channels. More...

int	getNumChannels () const noexcept
	Returns the number of channels of audio data that this buffer contains. More...

int	getNumSamples () const noexcept
	Returns the number of samples allocated in each of the buffer's channels. More...

const Type *	getReadPointer (int channelNumber) const noexcept
	Returns a pointer to an array of read-only samples in one of the buffer's channels. More...

const Type *	getReadPointer (int channelNumber, int sampleIndex) const noexcept
	Returns a pointer to an array of read-only samples in one of the buffer's channels. More...

Type	getRMSLevel (int channel, int startSample, int numSamples) const noexcept
	Returns the root mean squared level for a region of a channel. More...

Type	getSample (int channel, int sampleIndex) const noexcept
	Returns a sample from the buffer. More...

Type *	getWritePointer (int channelNumber) noexcept
	Returns a writeable pointer to one of the buffer's channels. More...

Type *	getWritePointer (int channelNumber, int sampleIndex) noexcept
	Returns a writeable pointer to one of the buffer's channels. More...

bool	hasBeenCleared () const noexcept
	Returns true if the buffer has been entirely cleared. More...

template<typename OtherType >
void	makeCopyOf (const AudioBuffer< OtherType > &other, bool avoidReallocating=false)
	Resizes this buffer to match the given one, and copies all of its content across. More...

AudioBuffer &	operator= (AudioBuffer &&other) noexcept
	Move assignment. More...

AudioBuffer &	operator= (const AudioBuffer &other)
	Copies another buffer onto this one. More...

void	reverse (int channel, int startSample, int numSamples) const noexcept
	Reverses a part of a channel. More...

void	reverse (int startSample, int numSamples) const noexcept
	Reverses a part of the buffer. More...

void	setDataToReferTo (Type **dataToReferTo, int newNumChannels, int newNumSamples)
	Makes this buffer point to a pre-allocated set of channel data arrays. More...

void	setDataToReferTo (Type **dataToReferTo, int newNumChannels, int newStartSample, int newNumSamples)
	Makes this buffer point to a pre-allocated set of channel data arrays. More...

void	setNotClear () noexcept
	Forces the internal cleared flag of the buffer to false. More...

void	setSample (int destChannel, int destSample, Type newValue) noexcept
	Sets a sample in the buffer. More...

void	setSize (int newNumChannels, int newNumSamples, bool keepExistingContent=false, bool clearExtraSpace=false, bool avoidReallocating=false)
	Changes the buffer's size or number of channels. More...

Private Member Functions
void	allocateChannels (Type const dataToReferTo, int offset)

void	allocateData ()

Private Attributes
size_t	allocatedBytes = 0

HeapBlock< char, true >	allocatedData

Type **	channels

bool	isClear = false

int	numChannels = 0

Type *	preallocatedChannelSpace [32]

int	size = 0

Detailed Description

template<typename Type>
class juce::AudioBuffer< Type >

A multi-channel buffer containing floating point audio samples.

@tags{Audio}

Member Typedef Documentation

◆ SampleType

template<typename Type >

using juce::AudioBuffer< Type >::SampleType = Type

This allows templated code that takes an AudioBuffer to access its sample type.

Constructor & Destructor Documentation

◆ AudioBuffer() [1/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer ( )

inlinenoexcept

Creates an empty buffer with 0 channels and 0 length.

◆ AudioBuffer() [2/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer	(	int	numChannelsToAllocate,
		int	numSamplesToAllocate
	)

inline

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. If the memory can't be allocated, this will throw a std::bad_alloc exception.

◆ AudioBuffer() [3/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer	(	Type const	dataToReferTo,
		int	numChannelsToUse,
		int	numSamples
	)

inline

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

◆ AudioBuffer() [4/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer	(	Type const	dataToReferTo,
		int	numChannelsToUse,
		int	startSample,
		int	numSamples
	)

inline

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

◆ AudioBuffer() [5/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer ( const AudioBuffer< Type > & other )

inline

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 both buffers will just point to the same shared block of data.

◆ ~AudioBuffer()

template<typename Type >

juce::AudioBuffer< Type >::~AudioBuffer ( )

default

Destructor.

This will free any memory allocated by the buffer.

◆ AudioBuffer() [6/6]

template<typename Type >

juce::AudioBuffer< Type >::AudioBuffer ( AudioBuffer< Type > && other )

inlinenoexcept

Move constructor.

Member Function Documentation

◆ addFrom() [1/2]

template<typename Type >

void juce::AudioBuffer< Type >::addFrom	(	int	destChannel,
		int	destStartSample,
		const AudioBuffer< Type > &	source,
		int	sourceChannel,
		int	sourceStartSample,
		int	numSamples,
		Type	gainToApplyToSource = `Type (1)`
	)

inlinenoexcept

Adds samples from another buffer to this one.

The hasBeenCleared method will return false after this call if samples have been added.

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

Referenced by juce::AudioBuffer< float >::addFromWithRamp().

◆ addFrom() [2/2]

template<typename Type >

void juce::AudioBuffer< Type >::addFrom	(	int	destChannel,
		int	destStartSample,
		const Type *	source,
		int	numSamples,
		Type	gainToApplyToSource = `Type (1)`
	)

inlinenoexcept

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

The hasBeenCleared method will return false after this call if samples have been added.

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

◆ addFromWithRamp()

template<typename Type >

void juce::AudioBuffer< Type >::addFromWithRamp	(	int	destChannel,
		int	destStartSample,
		const Type *	source,
		int	numSamples,
		Type	startGain,
		Type	endGain
	)

inlinenoexcept

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

The hasBeenCleared method will return false after this call if samples have been added.

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.

◆ addSample()

template<typename Type >

void juce::AudioBuffer< Type >::addSample	(	int	destChannel,
		int	destSample,
		Type	valueToAdd
	)

inlinenoexcept

Adds a value to a sample in the buffer.

The channel and index are not checked - they are expected to be in-range. If not, an assertion will be thrown, but in a release build, you're into 'undefined behaviour' territory.

The hasBeenCleared method will return false after this call.

◆ allocateChannels()

template<typename Type >

void juce::AudioBuffer< Type >::allocateChannels	(	Type const	dataToReferTo,
		int	offset
	)

inlineprivate

Referenced by juce::AudioBuffer< float >::AudioBuffer(), and juce::AudioBuffer< float >::setDataToReferTo().

◆ allocateData()

template<typename Type >

void juce::AudioBuffer< Type >::allocateData ( )

inlineprivate

Referenced by juce::AudioBuffer< float >::AudioBuffer().

◆ applyGain() [1/3]

template<typename Type >

void juce::AudioBuffer< Type >::applyGain	(	int	channel,
		int	startSample,
		int	numSamples,
		Type	gain
	)

inlinenoexcept

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!

Referenced by juce::AudioBuffer< float >::applyGain(), and juce::AudioBuffer< float >::applyGainRamp().

◆ applyGain() [2/3]

template<typename Type >

void juce::AudioBuffer< Type >::applyGain	(	int	startSample,
		int	numSamples,
		Type	gain
	)

inlinenoexcept

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!

◆ applyGain() [3/3]

template<typename Type >

void juce::AudioBuffer< Type >::applyGain ( Type gain )

inlinenoexcept

Applies a gain multiple to all the audio data.

◆ applyGainRamp() [1/2]

template<typename Type >

void juce::AudioBuffer< Type >::applyGainRamp	(	int	channel,
		int	startSample,
		int	numSamples,
		Type	startGain,
		Type	endGain
	)

inlinenoexcept

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!

Referenced by juce::AudioBuffer< float >::applyGainRamp().

◆ applyGainRamp() [2/2]

template<typename Type >

void juce::AudioBuffer< Type >::applyGainRamp	(	int	startSample,
		int	numSamples,
		Type	startGain,
		Type	endGain
	)

inlinenoexcept

Applies a range of gains to a region of all channels.

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!

◆ clear() [1/3]

template<typename Type >

void juce::AudioBuffer< Type >::clear ( )

inlinenoexcept

Clears all the samples in all channels and marks the buffer as cleared.

This method will do nothing if the buffer has been marked as cleared (i.e. the hasBeenCleared method returns true.)

See also: hasBeenCleared, setNotClear

Referenced by juce::AudioBuffer< float >::AudioBuffer(), juce::StandalonePluginHolder::audioDeviceAboutToStart(), juce::StandalonePluginHolder::audioDeviceIOCallback(), juce::AudioBuffer< float >::makeCopyOf(), and juce::AudioBuffer< float >::operator=().

◆ clear() [2/3]

template<typename Type >

void juce::AudioBuffer< Type >::clear	(	int	channel,
		int	startSample,
		int	numSamples
	)

inlinenoexcept

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!

This method will do nothing if the buffer has been marked as cleared (i.e. the hasBeenCleared method returns true.)

See also: hasBeenCleared, setNotClear

◆ clear() [3/3]

template<typename Type >

void juce::AudioBuffer< Type >::clear	(	int	startSample,
		int	numSamples
	)

inlinenoexcept

Clears a specified region of all the channels.

This will mark the buffer as cleared if the entire buffer contents are cleared.

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

This method will do nothing if the buffer has been marked as cleared (i.e. the hasBeenCleared method returns true.)

See also: hasBeenCleared, setNotClear

◆ copyFrom() [1/3]

template<typename Type >

void juce::AudioBuffer< Type >::copyFrom	(	int	destChannel,
		int	destStartSample,
		const AudioBuffer< Type > &	source,
		int	sourceChannel,
		int	sourceStartSample,
		int	numSamples
	)

inlinenoexcept

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

Referenced by juce::AudioBuffer< float >::copyFromWithRamp().

◆ copyFrom() [2/3]

template<typename Type >

void juce::AudioBuffer< Type >::copyFrom	(	int	destChannel,
		int	destStartSample,
		const Type *	source,
		int	numSamples
	)

inlinenoexcept

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

The hasBeenCleared method will return false after this call if samples have been copied.

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

◆ copyFrom() [3/3]

template<typename Type >

void juce::AudioBuffer< Type >::copyFrom	(	int	destChannel,
		int	destStartSample,
		const Type *	source,
		int	numSamples,
		Type	gain
	)

inlinenoexcept

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

The hasBeenCleared method will return false after this call if samples have been copied.

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

◆ copyFromWithRamp()

template<typename Type >

void juce::AudioBuffer< Type >::copyFromWithRamp	(	int	destChannel,
		int	destStartSample,
		const Type *	source,
		int	numSamples,
		Type	startGain,
		Type	endGain
	)

inlinenoexcept

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

The hasBeenCleared method will return false after this call if samples have been copied.

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

◆ findMinMax()

template<typename Type >

Range<Type> juce::AudioBuffer< Type >::findMinMax	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

inlinenoexcept

Returns a Range indicating the lowest and highest sample values in a given section.

Parameters

channel	the channel to read from
startSample	the start sample within the channel
numSamples	the number of samples to check

Referenced by juce::AudioBuffer< float >::getMagnitude().

◆ getArrayOfReadPointers()

template<typename Type >

const Type** juce::AudioBuffer< Type >::getArrayOfReadPointers ( ) const

inlinenoexcept

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.

Referenced by juce::StandalonePluginHolder::audioDeviceIOCallback().

◆ getArrayOfWritePointers()

template<typename Type >

Type** juce::AudioBuffer< Type >::getArrayOfWritePointers ( )

inlinenoexcept

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.

This will mark the buffer as not cleared and the hasBeenCleared method will return false after this call. If you retain this write pointer and write some data to the buffer after calling its clear method, subsequent clear calls will do nothing. To avoid this either call this method each time you need to write data, or use the setNotClear method to force the internal cleared flag to false.

See also: setNotClear

Referenced by juce::AudioProcessor::getBusBuffer().

◆ getMagnitude() [1/2]

template<typename Type >

Type juce::AudioBuffer< Type >::getMagnitude	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

inlinenoexcept

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

Referenced by juce::AudioBuffer< float >::getMagnitude().

◆ getMagnitude() [2/2]

template<typename Type >

Type juce::AudioBuffer< Type >::getMagnitude	(	int	startSample,
		int	numSamples
	)		const

inlinenoexcept

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

◆ getNumChannels()

template<typename Type >

int juce::AudioBuffer< Type >::getNumChannels ( ) const

inlinenoexcept

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

See also: getNumSamples, getReadPointer, getWritePointer

Referenced by juce::AudioBuffer< float >::makeCopyOf(), and juce::AudioBuffer< float >::operator=().

◆ getNumSamples()

template<typename Type >

int juce::AudioBuffer< Type >::getNumSamples ( ) const

inlinenoexcept

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

See also: getNumChannels, getReadPointer, getWritePointer

Referenced by juce::AudioProcessor::getBusBuffer(), juce::AudioBuffer< float >::makeCopyOf(), and juce::AudioBuffer< float >::operator=().

◆ getReadPointer() [1/2]

template<typename Type >

const Type* juce::AudioBuffer< Type >::getReadPointer ( int channelNumber ) const

inlinenoexcept

Returns a pointer to an array of read-only samples in 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!

If you need to write to the data, do NOT call this method and const_cast the result! Instead, you must call getWritePointer so that the buffer knows you're planning on modifying the data.

Referenced by juce::dsp::DelayLine< SampleType, juce::dsp::DelayLineInterpolationTypes::Thiran >::interpolateSample(), and juce::AudioBuffer< float >::makeCopyOf().

◆ getReadPointer() [2/2]

template<typename Type >

const Type* juce::AudioBuffer< Type >::getReadPointer	(	int	channelNumber,
		int	sampleIndex
	)		const

inlinenoexcept

Returns a pointer to an array of read-only samples in one of the buffer's channels.

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

If you need to write to the data, do NOT call this method and const_cast the result! Instead, you must call getWritePointer so that the buffer knows you're planning on modifying the data.

◆ getRMSLevel()

template<typename Type >

Type juce::AudioBuffer< Type >::getRMSLevel	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

inlinenoexcept

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

◆ getSample()

template<typename Type >

Type juce::AudioBuffer< Type >::getSample	(	int	channel,
		int	sampleIndex
	)		const

inlinenoexcept

Returns a sample from the buffer.

The channel and index are not checked - they are expected to be in-range. If not, an assertion will be thrown, but in a release build, you're into 'undefined behaviour' territory.

Referenced by juce::dsp::DelayLine< SampleType, juce::dsp::DelayLineInterpolationTypes::Thiran >::interpolateSample().

◆ getWritePointer() [1/2]

template<typename Type >

Type* juce::AudioBuffer< Type >::getWritePointer ( int channelNumber )

inlinenoexcept

Returns a writeable pointer to 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!

Note that if you're not planning on writing to the data, you should always use getReadPointer instead.

This will mark the buffer as not cleared and the hasBeenCleared method will return false after this call. If you retain this write pointer and write some data to the buffer after calling its clear method, subsequent clear calls will do nothing. To avoid this either call this method each time you need to write data, or use the setNotClear method to force the internal cleared flag to false.

See also: setNotClear

Referenced by juce::dsp::Phaser< SampleType >::process(), and juce::dsp::Chorus< SampleType >::process().

◆ getWritePointer() [2/2]

template<typename Type >

Type* juce::AudioBuffer< Type >::getWritePointer	(	int	channelNumber,
		int	sampleIndex
	)

inlinenoexcept

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

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

Note that if you're not planning on writing to the data, you should use getReadPointer instead.

This will mark the buffer as not cleared and the hasBeenCleared method will return false after this call. If you retain this write pointer and write some data to the buffer after calling its clear method, subsequent clear calls will do nothing. To avoid this either call this method each time you need to write data, or use the setNotClear method to force the internal cleared flag to false.

See also: setNotClear

◆ hasBeenCleared()

template<typename Type >

bool juce::AudioBuffer< Type >::hasBeenCleared ( ) const

inlinenoexcept

Returns true if the buffer has been entirely cleared.

Note that this does not actually measure the contents of the buffer - it simply returns a flag that is set when the buffer is cleared, and which is reset whenever functions like getWritePointer are invoked. That means the method is quick, but it may return false negatives when in fact the buffer is still empty.

Referenced by juce::AudioBuffer< float >::makeCopyOf().

◆ makeCopyOf()

template<typename Type >

template<typename OtherType >

void juce::AudioBuffer< Type >::makeCopyOf	(	const AudioBuffer< OtherType > &	other,
		bool	avoidReallocating = `false`
	)

inline

Resizes this buffer to match the given one, and copies all of its content across.

The source buffer can contain a different floating point type, so this can be used to convert between 32 and 64 bit float buffer types.

The hasBeenCleared method will return false after this call if the other buffer contains data.

◆ operator=() [1/2]

template<typename Type >

AudioBuffer& juce::AudioBuffer< Type >::operator= ( AudioBuffer< Type > && other )

inlinenoexcept

Move assignment.

◆ operator=() [2/2]

template<typename Type >

AudioBuffer& juce::AudioBuffer< Type >::operator= ( const AudioBuffer< Type > & other )

inline

Copies another buffer onto this one.

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

◆ reverse() [1/2]

template<typename Type >

void juce::AudioBuffer< Type >::reverse	(	int	channel,
		int	startSample,
		int	numSamples
	)		const

inlinenoexcept

Reverses a part of a channel.

Referenced by juce::AudioBuffer< float >::reverse().

◆ reverse() [2/2]

template<typename Type >

void juce::AudioBuffer< Type >::reverse	(	int	startSample,
		int	numSamples
	)		const

inlinenoexcept

Reverses a part of the buffer.

◆ setDataToReferTo() [1/2]

template<typename Type >

void juce::AudioBuffer< Type >::setDataToReferTo	(	Type **	dataToReferTo,
		int	newNumChannels,
		int	newNumSamples
	)

inline

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.

The hasBeenCleared method will return false after this call.

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.
newNumChannels	the number of channels to use - this must correspond to the number of elements in the array passed in
newNumSamples	the number of samples to use - this must correspond to the size of the arrays passed in

◆ setDataToReferTo() [2/2]

template<typename Type >

void juce::AudioBuffer< Type >::setDataToReferTo	(	Type **	dataToReferTo,
		int	newNumChannels,
		int	newStartSample,
		int	newNumSamples
	)

inline

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.

The hasBeenCleared method will return false after this call.

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.
newNumChannels	the number of channels to use - this must correspond to the number of elements in the array passed in
newStartSample	the offset within the arrays at which the data begins
newNumSamples	the number of samples to use - this must correspond to the size of the arrays passed in

Referenced by juce::AudioBuffer< float >::setDataToReferTo().

◆ setNotClear()

template<typename Type >

void juce::AudioBuffer< Type >::setNotClear ( )

inlinenoexcept

Forces the internal cleared flag of the buffer to false.

This may be useful in the case where you are holding on to a write pointer and call the clear method before writing some data. You can then use this method to mark the buffer as containing data so that subsequent clear calls will succeed. However a better solution is to call getWritePointer each time you need to write data.

◆ setSample()

template<typename Type >

void juce::AudioBuffer< Type >::setSample	(	int	destChannel,
		int	destSample,
		Type	newValue
	)

inlinenoexcept

Sets a sample in the buffer.

The channel and index are not checked - they are expected to be in-range. If not, an assertion will be thrown, but in a release build, you're into 'undefined behaviour' territory.

The hasBeenCleared method will return false after this call.

◆ setSize()

template<typename Type >

void juce::AudioBuffer< Type >::setSize	(	int	newNumChannels,
		int	newNumSamples,
		bool	keepExistingContent = `false`,
		bool	clearExtraSpace = `false`,
		bool	avoidReallocating = `false`
	)

inline

Changes the buffer's size or number of channels.

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

Note that if keepExistingContent and avoidReallocating are both true, then it will only avoid reallocating if neither the channel count or length in samples increase.

If the required memory can't be allocated, this will throw a std::bad_alloc exception.

Parameters

newNumChannels	the new number of channels.
newNumSamples	the new number of samples.
keepExistingContent	if this is true, it will try to preserve as much of the old data as it can in the new buffer.
clearExtraSpace	if this is true, then any extra channels or space that is allocated will be also be cleared. If false, then this space is left uninitialised.
avoidReallocating	if this 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.

Referenced by juce::StandalonePluginHolder::audioDeviceAboutToStart(), juce::StandalonePluginHolder::audioDeviceStopped(), juce::AudioBuffer< float >::makeCopyOf(), and juce::AudioBuffer< float >::operator=().

Member Data Documentation

◆ allocatedBytes

template<typename Type >

size_t juce::AudioBuffer< Type >::allocatedBytes = 0

private

Referenced by juce::AudioBuffer< float >::allocateData(), juce::AudioBuffer< float >::AudioBuffer(), juce::AudioBuffer< float >::operator=(), juce::AudioBuffer< float >::setDataToReferTo(), and juce::AudioBuffer< float >::setSize().

◆ allocatedData

template<typename Type >

HeapBlock<char, true> juce::AudioBuffer< Type >::allocatedData

private

Referenced by juce::AudioBuffer< float >::allocateChannels(), juce::AudioBuffer< float >::allocateData(), juce::AudioBuffer< float >::operator=(), juce::AudioBuffer< float >::setDataToReferTo(), and juce::AudioBuffer< float >::setSize().

◆ channels

template<typename Type >

Type** juce::AudioBuffer< Type >::channels

private

◆ isClear

template<typename Type >

bool juce::AudioBuffer< Type >::isClear = false

private

◆ numChannels

template<typename Type >

int juce::AudioBuffer< Type >::numChannels = 0

private

◆ preallocatedChannelSpace

template<typename Type >

Type* juce::AudioBuffer< Type >::preallocatedChannelSpace[32]

private

Referenced by juce::AudioBuffer< float >::allocateChannels(), juce::AudioBuffer< float >::AudioBuffer(), and juce::AudioBuffer< float >::operator=().

◆ size

template<typename Type >

int juce::AudioBuffer< Type >::size = 0

private

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

juce_AudioSampleBuffer.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename Type> class juce::AudioBuffer< Type >

Member Typedef Documentation

◆ SampleType

Constructor & Destructor Documentation

◆ AudioBuffer() [1/6]

◆ AudioBuffer() [2/6]

◆ AudioBuffer() [3/6]

◆ AudioBuffer() [4/6]

◆ AudioBuffer() [5/6]

◆ ~AudioBuffer()

◆ AudioBuffer() [6/6]

Member Function Documentation

◆ addFrom() [1/2]

◆ addFrom() [2/2]

◆ addFromWithRamp()

◆ addSample()

◆ allocateChannels()

◆ allocateData()

◆ applyGain() [1/3]

◆ applyGain() [2/3]

◆ applyGain() [3/3]

◆ applyGainRamp() [1/2]

◆ applyGainRamp() [2/2]

◆ clear() [1/3]

◆ clear() [2/3]

◆ clear() [3/3]

◆ copyFrom() [1/3]

◆ copyFrom() [2/3]

◆ copyFrom() [3/3]

◆ copyFromWithRamp()

◆ findMinMax()

◆ getArrayOfReadPointers()

◆ getArrayOfWritePointers()

◆ getMagnitude() [1/2]

◆ getMagnitude() [2/2]

◆ getNumChannels()

◆ getNumSamples()

◆ getReadPointer() [1/2]

◆ getReadPointer() [2/2]

◆ getRMSLevel()

◆ getSample()

◆ getWritePointer() [1/2]

◆ getWritePointer() [2/2]

◆ hasBeenCleared()

◆ makeCopyOf()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reverse() [1/2]

◆ reverse() [2/2]

◆ setDataToReferTo() [1/2]

◆ setDataToReferTo() [2/2]

◆ setNotClear()

◆ setSample()

◆ setSize()

Member Data Documentation

◆ allocatedBytes

◆ allocatedData

◆ channels

◆ isClear

◆ numChannels

◆ preallocatedChannelSpace

◆ size

template<typename Type>
class juce::AudioBuffer< Type >