OpenShot Library | OpenShotAudio
0.2.2
|
Minimal and lightweight data-structure which contains a list of pointers to channels containing some kind of sample data. More...
#include <juce_AudioBlock.h>
Public Types | |
using | NumericType = typename SampleTypeHelpers::ElementType< SampleType >::Type |
Public Member Functions | |
AudioBlock () noexcept=default | |
Create a zero-sized AudioBlock. | |
constexpr | AudioBlock (SampleType *const *channelData, size_t numberOfChannels, size_t numberOfSamples) noexcept |
Creates an AudioBlock from a pointer to an array of channels. More... | |
constexpr | AudioBlock (SampleType *const *channelData, size_t numberOfChannels, size_t startSampleIndex, size_t numberOfSamples) noexcept |
Creates an AudioBlock from a pointer to an array of channels. More... | |
AudioBlock (HeapBlock< char > &heapBlockToUseForAllocation, size_t numberOfChannels, size_t numberOfSamples, size_t alignmentInBytes=defaultAlignment) noexcept | |
Allocates a suitable amount of space in a HeapBlock, and initialises this object to point into it. More... | |
template<typename OtherSampleType > | |
constexpr | AudioBlock (AudioBuffer< OtherSampleType > &buffer) noexcept |
Creates an AudioBlock that points to the data in an AudioBuffer. More... | |
template<typename OtherSampleType > | |
AudioBlock (AudioBuffer< OtherSampleType > &buffer, size_t startSampleIndex) noexcept | |
Creates an AudioBlock that points to the data in an AudioBuffer. More... | |
AudioBlock (const AudioBlock &other) noexcept=default | |
AudioBlock & | operator= (const AudioBlock &other) noexcept=default |
template<typename OtherSampleType , MayUseConvertingConstructor< OtherSampleType > = 0> | |
AudioBlock (const AudioBlock< OtherSampleType > &other) noexcept | |
template<typename OtherSampleType , MayUseConvertingConstructor< OtherSampleType > = 0> | |
AudioBlock & | operator= (const AudioBlock< OtherSampleType > &other) noexcept |
void | swap (AudioBlock &other) noexcept |
template<typename OtherSampleType > | |
constexpr bool | operator== (const AudioBlock< OtherSampleType > &other) const noexcept |
template<typename OtherSampleType > | |
constexpr bool | operator!= (const AudioBlock< OtherSampleType > &other) const noexcept |
constexpr size_t | getNumChannels () const noexcept |
Returns the number of channels referenced by this block. | |
constexpr size_t | getNumSamples () const noexcept |
Returns the number of samples referenced by this block. | |
SampleType * | getChannelPointer (size_t channel) const noexcept |
Returns a raw pointer into one of the channels in this block. | |
AudioBlock | getSingleChannelBlock (size_t channel) const noexcept |
Returns an AudioBlock that represents one of the channels in this block. | |
AudioBlock | getSubsetChannelBlock (size_t channelStart, size_t numChannelsToUse) const noexcept |
Returns a subset of contiguous channels. More... | |
SampleType | getSample (int channel, int sampleIndex) const noexcept |
Returns a sample from the buffer. More... | |
void | setSample (int destChannel, int destSample, SampleType newValue) const noexcept |
Modifies a sample in the buffer. More... | |
void | addSample (int destChannel, int destSample, SampleType valueToAdd) const noexcept |
Adds a value to a sample in the buffer. More... | |
AudioBlock & | clear () noexcept |
Clears the memory referenced by this AudioBlock. | |
const AudioBlock & | clear () const noexcept |
AudioBlock &JUCE_VECTOR_CALLTYPE | fill (NumericType value) noexcept |
Fills the memory referenced by this AudioBlock with value. | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | fill (NumericType value) const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | copyFrom (const AudioBlock< OtherSampleType > &src) noexcept |
Copies the values in src to this block. | |
template<typename OtherSampleType > | |
const AudioBlock & | copyFrom (const AudioBlock< OtherSampleType > &src) const noexcept |
template<typename OtherNumericType > | |
AudioBlock & | copyFrom (const AudioBuffer< OtherNumericType > &src, size_t srcPos=0, size_t dstPos=0, size_t numElements=std::numeric_limits< size_t >::max()) |
Copy the values from an AudioBuffer to this block. More... | |
template<typename OtherNumericType > | |
const AudioBlock & | copyFrom (const AudioBuffer< OtherNumericType > &src, size_t srcPos=0, size_t dstPos=0, size_t numElements=std::numeric_limits< size_t >::max()) const |
void | copyTo (AudioBuffer< typename std::remove_const< NumericType >::type > &dst, size_t srcPos=0, size_t dstPos=0, size_t numElements=std::numeric_limits< size_t >::max()) const |
Copies the values from this block to an AudioBuffer. More... | |
AudioBlock & | move (size_t srcPos, size_t dstPos, size_t numElements=std::numeric_limits< size_t >::max()) noexcept |
Move memory within this block from the position srcPos to the position dstPos. More... | |
const AudioBlock & | move (size_t srcPos, size_t dstPos, size_t numElements=std::numeric_limits< size_t >::max()) const noexcept |
AudioBlock | getSubBlock (size_t newOffset, size_t newLength) const noexcept |
Return a new AudioBlock pointing to a sub-block inside this block. More... | |
AudioBlock | getSubBlock (size_t newOffset) const noexcept |
Return a new AudioBlock pointing to a sub-block inside this block. More... | |
AudioBlock &JUCE_VECTOR_CALLTYPE | add (NumericType value) noexcept |
Adds a fixed value to the elements in this block. | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | add (NumericType value) const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | add (AudioBlock< OtherSampleType > src) noexcept |
Adds the elements in the src block to the elements in this block. | |
template<typename OtherSampleType > | |
const AudioBlock & | add (AudioBlock< OtherSampleType > src) const noexcept |
template<typename OtherSampleType > | |
AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithSumOf (AudioBlock< OtherSampleType > src, NumericType value) noexcept |
Adds a fixed value to each source value and replaces the contents of this block. | |
template<typename OtherSampleType > | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithSumOf (AudioBlock< OtherSampleType > src, NumericType value) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | replaceWithSumOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Adds each source1 value to the corresponding source2 value and replaces the contents of this block. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | replaceWithSumOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
AudioBlock &JUCE_VECTOR_CALLTYPE | subtract (NumericType value) noexcept |
Subtracts a fixed value from the elements in this block. | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | subtract (NumericType value) const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | subtract (AudioBlock< OtherSampleType > src) noexcept |
Subtracts the source values from the elements in this block. | |
template<typename OtherSampleType > | |
const AudioBlock & | subtract (AudioBlock< OtherSampleType > src) const noexcept |
template<typename OtherSampleType > | |
AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithDifferenceOf (AudioBlock< OtherSampleType > src, NumericType value) noexcept |
Subtracts a fixed value from each source value and replaces the contents of this block. | |
template<typename OtherSampleType > | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithDifferenceOf (AudioBlock< OtherSampleType > src, NumericType value) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | replaceWithDifferenceOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Subtracts each source2 value from the corresponding source1 value and replaces the contents of this block. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | replaceWithDifferenceOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
AudioBlock &JUCE_VECTOR_CALLTYPE | multiplyBy (NumericType value) noexcept |
Multiplies the elements in this block by a fixed value. | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | multiplyBy (NumericType value) const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | multiplyBy (AudioBlock< OtherSampleType > src) noexcept |
Multiplies the elements in this block by the elements in the src block. | |
template<typename OtherSampleType > | |
const AudioBlock & | multiplyBy (AudioBlock< OtherSampleType > src) const noexcept |
template<typename OtherSampleType > | |
AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithProductOf (AudioBlock< OtherSampleType > src, NumericType value) noexcept |
Replaces the elements in this block with the product of the elements in the source src block and a fixed value. | |
template<typename OtherSampleType > | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | replaceWithProductOf (AudioBlock< OtherSampleType > src, NumericType value) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | replaceWithProductOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Replaces the elements in this block with the product of the elements in the src1 and scr2 blocks. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | replaceWithProductOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
template<typename SmoothingType > | |
AudioBlock & | multiplyBy (SmoothedValue< SampleType, SmoothingType > &value) noexcept |
Multiplies each channels of this block by a smoothly changing value. | |
template<typename SmoothingType > | |
const AudioBlock & | multiplyBy (SmoothedValue< SampleType, SmoothingType > &value) const noexcept |
template<typename OtherSampleType , typename SmoothingType > | |
AudioBlock & | replaceWithProductOf (AudioBlock< OtherSampleType > src, SmoothedValue< SampleType, SmoothingType > &value) noexcept |
Replaces each channel of this block with the product of the src block and a smoothed value. | |
template<typename OtherSampleType , typename SmoothingType > | |
const AudioBlock & | replaceWithProductOf (AudioBlock< OtherSampleType > src, SmoothedValue< SampleType, SmoothingType > &value) const noexcept |
template<typename OtherSampleType > | |
AudioBlock &JUCE_VECTOR_CALLTYPE | addProductOf (AudioBlock< OtherSampleType > src, NumericType factor) noexcept |
Multiplies each value in src by a fixed value and adds the result to this block. | |
template<typename OtherSampleType > | |
const AudioBlock &JUCE_VECTOR_CALLTYPE | addProductOf (AudioBlock< OtherSampleType > src, NumericType factor) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | addProductOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Multiplies each value in srcA with the corresponding value in srcB and adds the result to this block. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | addProductOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
AudioBlock & | negate () noexcept |
Negates each value of this block. | |
const AudioBlock & | negate () const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | replaceWithNegativeOf (AudioBlock< OtherSampleType > src) noexcept |
Replaces the contents of this block with the negative of the values in the src block. | |
template<typename OtherSampleType > | |
const AudioBlock & | replaceWithNegativeOf (AudioBlock< OtherSampleType > src) const noexcept |
template<typename OtherSampleType > | |
AudioBlock & | replaceWithAbsoluteValueOf (AudioBlock< OtherSampleType > src) noexcept |
Replaces the contents of this block with the absolute values of the src block. | |
template<typename OtherSampleType > | |
const AudioBlock & | replaceWithAbsoluteValueOf (AudioBlock< OtherSampleType > src) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | replaceWithMinOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Replaces each element of this block with the minimum of the corresponding element of the source arrays. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | replaceWithMinOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
template<typename Src1SampleType , typename Src2SampleType > | |
AudioBlock & | replaceWithMaxOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) noexcept |
Replaces each element of this block with the maximum of the corresponding element of the source arrays. | |
template<typename Src1SampleType , typename Src2SampleType > | |
const AudioBlock & | replaceWithMaxOf (AudioBlock< Src1SampleType > src1, AudioBlock< Src2SampleType > src2) const noexcept |
Range< typename std::remove_const< NumericType >::type > | findMinAndMax () const noexcept |
Finds the minimum and maximum value of the buffer. | |
AudioBlock &JUCE_VECTOR_CALLTYPE | operator+= (NumericType value) noexcept |
const AudioBlock &JUCE_VECTOR_CALLTYPE | operator+= (NumericType value) const noexcept |
AudioBlock & | operator+= (AudioBlock src) noexcept |
const AudioBlock & | operator+= (AudioBlock src) const noexcept |
AudioBlock &JUCE_VECTOR_CALLTYPE | operator-= (NumericType value) noexcept |
const AudioBlock &JUCE_VECTOR_CALLTYPE | operator-= (NumericType value) const noexcept |
AudioBlock & | operator-= (AudioBlock src) noexcept |
const AudioBlock & | operator-= (AudioBlock src) const noexcept |
AudioBlock &JUCE_VECTOR_CALLTYPE | operator*= (NumericType value) noexcept |
const AudioBlock &JUCE_VECTOR_CALLTYPE | operator*= (NumericType value) const noexcept |
AudioBlock & | operator*= (AudioBlock src) noexcept |
const AudioBlock & | operator*= (AudioBlock src) const noexcept |
template<typename SmoothingType > | |
AudioBlock & | operator*= (SmoothedValue< SampleType, SmoothingType > &value) noexcept |
template<typename SmoothingType > | |
const AudioBlock & | operator*= (SmoothedValue< SampleType, SmoothingType > &value) const noexcept |
Static Public Member Functions | |
template<typename Src1SampleType , typename Src2SampleType , typename FunctionType > | |
static void | process (AudioBlock< Src1SampleType > inBlock, AudioBlock< Src2SampleType > outBlock, FunctionType &&function) |
Applies a function to each value in an input block, putting the result into an output block. More... | |
Minimal and lightweight data-structure which contains a list of pointers to channels containing some kind of sample data.
This class doesn't own any of the data which it points to, it's simply a view into data that is owned elsewhere. You can construct one from some raw data that you've allocated yourself, or give it a HeapBlock to use, or give it an AudioBuffer which it can refer to, but in all cases the user is responsible for making sure that the data doesn't get deleted while there's still an AudioBlock using it.
Definition at line 68 of file juce_AudioBlock.h.
|
inlineconstexprnoexcept |
Creates an AudioBlock from a pointer to an array of channels.
AudioBlock does not copy nor own the memory pointed to by dataToUse. Therefore it is the user's responsibility to ensure that the memory is retained throughout the life-time of the AudioBlock and released when no longer needed.
Definition at line 92 of file juce_AudioBlock.h.
|
inlineconstexprnoexcept |
Creates an AudioBlock from a pointer to an array of channels.
AudioBlock does not copy nor own the memory pointed to by dataToUse. Therefore it is the user's responsibility to ensure that the memory is retained throughout the life-time of the AudioBlock and released when no longer needed.
Definition at line 105 of file juce_AudioBlock.h.
|
inlinenoexcept |
Allocates a suitable amount of space in a HeapBlock, and initialises this object to point into it.
The HeapBlock must of course not be freed or re-allocated while this object is still in use, because it will be referencing its data.
Definition at line 119 of file juce_AudioBlock.h.
|
inlineconstexprnoexcept |
Creates an AudioBlock that points to the data in an AudioBuffer.
AudioBlock does not copy nor own the memory pointed to by dataToUse. Therefore it is the user's responsibility to ensure that the buffer is retained throughout the life-time of the AudioBlock without being modified.
Definition at line 151 of file juce_AudioBlock.h.
|
inlinenoexcept |
Creates an AudioBlock that points to the data in an AudioBuffer.
AudioBlock does not copy nor own the memory pointed to by dataToUse. Therefore it is the user's responsibility to ensure that the buffer is retained throughout the life-time of the AudioBlock without being modified.
Definition at line 164 of file juce_AudioBlock.h.
|
inlinenoexcept |
Returns a subset of contiguous channels.
channelStart | First channel of the subset |
numChannelsToUse | Count of channels in the subset |
Definition at line 245 of file juce_AudioBlock.h.
|
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.
Definition at line 258 of file juce_AudioBlock.h.
|
inlinenoexcept |
Modifies 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.
Definition at line 270 of file juce_AudioBlock.h.
|
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.
Definition at line 282 of file juce_AudioBlock.h.
|
inline |
Copy the values from an AudioBuffer to this block.
All indices and sizes are in this AudioBlock's units, i.e. if SampleType is a SIMDRegister then incrementing srcPos by one will increase the sample position in the AudioBuffer's units by a factor of SIMDRegister<SampleType>::SIMDNumElements.
Definition at line 311 of file juce_AudioBlock.h.
|
inline |
Copies the values from this block to an AudioBuffer.
All indices and sizes are in this AudioBlock's units, i.e. if SampleType is a SIMDRegister then incrementing dstPos by one will increase the sample position in the AudioBuffer's units by a factor of SIMDRegister<SampleType>::SIMDNumElements.
Definition at line 326 of file juce_AudioBlock.h.
References juce::FloatVectorOperations::copy().
|
inlinenoexcept |
Move memory within this block from the position srcPos to the position dstPos.
If numElements is not specified then move will move the maximum amount of memory.
Definition at line 343 of file juce_AudioBlock.h.
|
inlinenoexcept |
Return a new AudioBlock pointing to a sub-block inside this block.
This function does not copy the memory and you must ensure that the original memory pointed to by the receiver remains valid through-out the life-time of the returned sub-block.
newOffset | The index of an element inside the receiver which will will become the first element of the return value. |
newLength | The number of elements of the newly created sub-block. |
Definition at line 358 of file juce_AudioBlock.h.
Referenced by juce::dsp::AudioBlock< SampleType >::getSubBlock(), and juce::dsp::Convolution::Pimpl::processSamples().
|
inlinenoexcept |
Return a new AudioBlock pointing to a sub-block inside this block.
This function does not copy the memory and you must ensure that the original memory pointed to by the receiver remains valid through-out the life-time of the returned sub-block.
newOffset | The index of an element inside the block which will will become the first element of the return value. The return value will include all subsequent elements of the receiver. |
Definition at line 376 of file juce_AudioBlock.h.
References juce::dsp::AudioBlock< SampleType >::getNumSamples(), and juce::dsp::AudioBlock< SampleType >::getSubBlock().
|
inlinestatic |
Applies a function to each value in an input block, putting the result into an output block.
The function supplied must take a SampleType as its parameter, and return a SampleType. The two blocks must have the same number of channels and samples.
Definition at line 563 of file juce_AudioBlock.h.
References juce::dsp::AudioBlock< SampleType >::getChannelPointer(), juce::dsp::AudioBlock< SampleType >::getNumChannels(), and juce::dsp::AudioBlock< SampleType >::getNumSamples().
Referenced by juce::dsp::WaveShaper< FloatType, Function >::process(), and juce::dsp::AudioBlockUnitTests< SampleType >::runTest().