PortAudio 2.0
PaUtilBufferProcessor Struct Reference

The main buffer processor data structure. More...

#include <pa_process.h>

Data Fields

unsigned long framesPerUserBuffer
 
unsigned long framesPerHostBuffer
 
PaUtilHostBufferSizeMode hostBufferSizeMode
 
int useNonAdaptingProcess
 
int userOutputSampleFormatIsEqualToHost
 
int userInputSampleFormatIsEqualToHost
 
unsigned long framesPerTempBuffer
 
unsigned int inputChannelCount
 
unsigned int bytesPerHostInputSample
 
unsigned int bytesPerUserInputSample
 
int userInputIsInterleaved
 
PaUtilConverterinputConverter
 
PaUtilZeroerinputZeroer
 
unsigned int outputChannelCount
 
unsigned int bytesPerHostOutputSample
 
unsigned int bytesPerUserOutputSample
 
int userOutputIsInterleaved
 
PaUtilConverteroutputConverter
 
PaUtilZeroeroutputZeroer
 
unsigned long initialFramesInTempInputBuffer
 
unsigned long initialFramesInTempOutputBuffer
 
void * tempInputBuffer
 
void ** tempInputBufferPtrs
 
unsigned long framesInTempInputBuffer
 
void * tempOutputBuffer
 
void ** tempOutputBufferPtrs
 
unsigned long framesInTempOutputBuffer
 
PaStreamCallbackTimeInfotimeInfo
 
PaStreamCallbackFlags callbackStatusFlags
 
int hostInputIsInterleaved
 
unsigned long hostInputFrameCount [2]
 
PaUtilChannelDescriptorhostInputChannels [2]
 
int hostOutputIsInterleaved
 
unsigned long hostOutputFrameCount [2]
 
PaUtilChannelDescriptorhostOutputChannels [2]
 
PaUtilTriangularDitherGenerator ditherGenerator
 
double samplePeriod
 
PaStreamCallbackstreamCallback
 
void * userData
 

Detailed Description

The main buffer processor data structure.

Allocate one of these, initialize it with PaUtil_InitializeBufferProcessor and terminate it with PaUtil_TerminateBufferProcessor.

Field Documentation

◆ bytesPerHostInputSample

◆ bytesPerHostOutputSample

◆ bytesPerUserInputSample

unsigned int PaUtilBufferProcessor::bytesPerUserInputSample

◆ bytesPerUserOutputSample

unsigned int PaUtilBufferProcessor::bytesPerUserOutputSample

◆ callbackStatusFlags

PaStreamCallbackFlags PaUtilBufferProcessor::callbackStatusFlags

◆ ditherGenerator

◆ framesInTempInputBuffer

unsigned long PaUtilBufferProcessor::framesInTempInputBuffer

frames remaining in input buffer from previous adaption iteration

Referenced by PaUtil_BeginBufferProcessing(), PaUtil_InitializeBufferProcessor(), and PaUtil_ResetBufferProcessor().

◆ framesInTempOutputBuffer

unsigned long PaUtilBufferProcessor::framesInTempOutputBuffer

frames remaining in input buffer from previous adaption iteration

Referenced by PaUtil_BeginBufferProcessing(), PaUtil_InitializeBufferProcessor(), PaUtil_IsBufferProcessorOutputEmpty(), and PaUtil_ResetBufferProcessor().

◆ framesPerHostBuffer

unsigned long PaUtilBufferProcessor::framesPerHostBuffer

◆ framesPerTempBuffer

unsigned long PaUtilBufferProcessor::framesPerTempBuffer

◆ framesPerUserBuffer

unsigned long PaUtilBufferProcessor::framesPerUserBuffer

◆ hostBufferSizeMode

PaUtilHostBufferSizeMode PaUtilBufferProcessor::hostBufferSizeMode

◆ hostInputChannels

◆ hostInputFrameCount

unsigned long PaUtilBufferProcessor::hostInputFrameCount[2]

◆ hostInputIsInterleaved

◆ hostOutputChannels

PaUtilChannelDescriptor* PaUtilBufferProcessor::hostOutputChannels[2]

pointers to arrays of channel descriptors. pointers are NULL for half-duplex input processing. hostOutputChannels[i].data is NULL when the caller calls PaUtil_SetNoOutput()

Referenced by PaUtil_CopyOutput(), PaUtil_EndBufferProcessing(), PaUtil_InitializeBufferProcessor(), PaUtil_Set2ndOutputChannel(), PaUtil_SetNoOutput(), PaUtil_SetOutputChannel(), PaUtil_TerminateBufferProcessor(), and PaUtil_ZeroOutput().

◆ hostOutputFrameCount

◆ hostOutputIsInterleaved

◆ initialFramesInTempInputBuffer

unsigned long PaUtilBufferProcessor::initialFramesInTempInputBuffer

◆ initialFramesInTempOutputBuffer

unsigned long PaUtilBufferProcessor::initialFramesInTempOutputBuffer

◆ inputChannelCount

◆ inputConverter

PaUtilConverter* PaUtilBufferProcessor::inputConverter

◆ inputZeroer

PaUtilZeroer* PaUtilBufferProcessor::inputZeroer

◆ outputChannelCount

◆ outputConverter

PaUtilConverter* PaUtilBufferProcessor::outputConverter

◆ outputZeroer

PaUtilZeroer* PaUtilBufferProcessor::outputZeroer

◆ samplePeriod

double PaUtilBufferProcessor::samplePeriod

◆ streamCallback

◆ tempInputBuffer

void* PaUtilBufferProcessor::tempInputBuffer

used for slips, block adaption, and conversion.

Referenced by PaUtil_InitializeBufferProcessor(), PaUtil_ResetBufferProcessor(), and PaUtil_TerminateBufferProcessor().

◆ tempInputBufferPtrs

void** PaUtilBufferProcessor::tempInputBufferPtrs

storage for non-interleaved buffer pointers, NULL for interleaved user input

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_TerminateBufferProcessor().

◆ tempOutputBuffer

void* PaUtilBufferProcessor::tempOutputBuffer

used for slips, block adaption, and conversion.

Referenced by PaUtil_InitializeBufferProcessor(), PaUtil_ResetBufferProcessor(), and PaUtil_TerminateBufferProcessor().

◆ tempOutputBufferPtrs

void** PaUtilBufferProcessor::tempOutputBufferPtrs

storage for non-interleaved buffer pointers, NULL for interleaved user output

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_TerminateBufferProcessor().

◆ timeInfo

PaStreamCallbackTimeInfo* PaUtilBufferProcessor::timeInfo

◆ useNonAdaptingProcess

int PaUtilBufferProcessor::useNonAdaptingProcess

◆ userData

void* PaUtilBufferProcessor::userData

◆ userInputIsInterleaved

int PaUtilBufferProcessor::userInputIsInterleaved

◆ userInputSampleFormatIsEqualToHost

int PaUtilBufferProcessor::userInputSampleFormatIsEqualToHost

◆ userOutputIsInterleaved

int PaUtilBufferProcessor::userOutputIsInterleaved

◆ userOutputSampleFormatIsEqualToHost

int PaUtilBufferProcessor::userOutputSampleFormatIsEqualToHost

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