pongasoft::VST::AudioBuffers< SampleType > Class Template Reference

#include <AudioBuffer.h>

Classes
class	Channel

Public Types
typedef AudioBuffers< SampleType >	class_type

Public Member Functions
SampleType	absoluteMax ()
bool	adjustSilenceFlags ()
	AudioBuffers (AudioBusBuffers &buffer, int32 numSamples)
tresult	clear ()
tresult	copyFrom (class_type const &fromBuffer)
tresult	copyTo (class_type &toBuffer) const
Channel	getAudioChannel (int32 iChannel)
SampleType **	getBuffer () const
template<>
Sample32 **	getBuffer () const
template<>
Sample64 **	getBuffer () const
Channel	getLeftChannel ()
int32	getNumChannels () const
int32	getNumSamples () const
Channel	getRightChannel ()
uint64	getSilenceFlags () const
bool	isSilent () const
bool	isSilent (int32 iChannel) const
void	setSilenceFlag (int32 iChannel, bool iSilent)
void	setSilenceFlags (uint64 iFlags) const

Private Attributes
AudioBusBuffers &	fBuffer
const int32	fNumSamples

Detailed Description

template<typename SampleType>
class pongasoft::VST::AudioBuffers< SampleType >

Represents all the buffers (example for a stereo channel there is 2 underlying sample buffers)

Template Parameters

SampleType

Member Typedef Documentation

class_type

template<typename SampleType >

typedef AudioBuffers<SampleType> pongasoft::VST::AudioBuffers< SampleType >::class_type

Constructor & Destructor Documentation

AudioBuffers()

template<typename SampleType >

pongasoft::VST::AudioBuffers< SampleType >::AudioBuffers ( AudioBusBuffers &  buffer, int32  numSamples  )

inline

Member Function Documentation

absoluteMax()

template<typename SampleType >

SampleType pongasoft::VST::AudioBuffers< SampleType >::absoluteMax ( )

inline

Returns

the max sample (absolute) across all channels

adjustSilenceFlags()

template<typename SampleType >

bool pongasoft::VST::AudioBuffers< SampleType >::adjustSilenceFlags ( )

inline

Computes and adjust the silence flags

Returns

true if the buffer is silent (meaning all channels are silent)

clear()

template<typename SampleType >

tresult pongasoft::VST::AudioBuffers< SampleType >::clear ( )

inline

Clears the buffer (and sets the silence flag)

copyFrom()

template<typename SampleType >

tresult pongasoft::VST::AudioBuffers< SampleType >::copyFrom ( class_type const &  fromBuffer )

inline

Copy the content of the provided buffer to THIS buffer (up to num samples)

copyTo()

template<typename SampleType >

tresult pongasoft::VST::AudioBuffers< SampleType >::copyTo ( class_type &  toBuffer ) const

inline

Copy the content of THIS buffer to the provided buffer (up to num samples)

getAudioChannel()

template<typename SampleType >

Channel pongasoft::VST::AudioBuffers< SampleType >::getAudioChannel ( int32  iChannel )

inline

Returns

the audio channel provided its channel (make sure that iChannel is < getNumChannels!)

getBuffer() [1/3]

template<typename SampleType >

SampleType** pongasoft::VST::AudioBuffers< SampleType >::getBuffer ( ) const

inline

getBuffer() [2/3]

template<>

Sample32 ** pongasoft::VST::AudioBuffers< Sample32 >::getBuffer ( ) const

inline

getBuffer() [3/3]

template<>

Sample64 ** pongasoft::VST::AudioBuffers< Sample64 >::getBuffer ( ) const

inline

getLeftChannel()

template<typename SampleType >

Channel pongasoft::VST::AudioBuffers< SampleType >::getLeftChannel ( )

inline

Returns

the left channel (using the fact that the left channel is 0)

getNumChannels()

template<typename SampleType >

int32 pongasoft::VST::AudioBuffers< SampleType >::getNumChannels ( ) const

inline

Returns

number of channels (2 for stereo) of the underlying buffer

getNumSamples()

template<typename SampleType >

int32 pongasoft::VST::AudioBuffers< SampleType >::getNumSamples ( ) const

inline

Returns

number of samples in the buffer

getRightChannel()

template<typename SampleType >

Channel pongasoft::VST::AudioBuffers< SampleType >::getRightChannel ( )

inline

Returns

the right channel (using the fact that the left channel is 1)

getSilenceFlags()

template<typename SampleType >

uint64 pongasoft::VST::AudioBuffers< SampleType >::getSilenceFlags ( ) const

inline

isSilent() [1/2]

template<typename SampleType >

bool pongasoft::VST::AudioBuffers< SampleType >::isSilent ( ) const

inline

isSilent() [2/2]

template<typename SampleType >

bool pongasoft::VST::AudioBuffers< SampleType >::isSilent ( int32  iChannel ) const

inline

Returns

true if the channel is silent (according to silenceFlags)

setSilenceFlag()

template<typename SampleType >

void pongasoft::VST::AudioBuffers< SampleType >::setSilenceFlag ( int32  iChannel, bool  iSilent  )

inline

Sets a single channel silence flag

setSilenceFlags()

template<typename SampleType >

void pongasoft::VST::AudioBuffers< SampleType >::setSilenceFlags ( uint64  iFlags ) const

inline

Member Data Documentation

fBuffer

template<typename SampleType >

AudioBusBuffers& pongasoft::VST::AudioBuffers< SampleType >::fBuffer

private

fNumSamples

template<typename SampleType >

const int32 pongasoft::VST::AudioBuffers< SampleType >::fNumSamples

private

---

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

• pongasoft/VST/AudioBuffer.h