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
unsigned long	framesPerTempBuffer
unsigned int	inputChannelCount
unsigned int	bytesPerHostInputSample
unsigned int	bytesPerUserInputSample
int	userInputIsInterleaved
PaUtilConverter *	inputConverter
PaUtilZeroer *	inputZeroer
unsigned int	outputChannelCount
unsigned int	bytesPerHostOutputSample
unsigned int	bytesPerUserOutputSample
int	userOutputIsInterleaved
PaUtilConverter *	outputConverter
PaUtilZeroer *	outputZeroer
unsigned long	initialFramesInTempInputBuffer
unsigned long	initialFramesInTempOutputBuffer
void *	tempInputBuffer
void **	tempInputBufferPtrs
unsigned long	framesInTempInputBuffer
void *	tempOutputBuffer
void **	tempOutputBufferPtrs
unsigned long	framesInTempOutputBuffer
PaStreamCallbackTimeInfo *	timeInfo
PaStreamCallbackFlags	callbackStatusFlags
unsigned long	hostInputFrameCount [2]
PaUtilChannelDescriptor *	hostInputChannels [2]
unsigned long	hostOutputFrameCount [2]
PaUtilChannelDescriptor *	hostOutputChannels [2]
PaUtilTriangularDitherGenerator	ditherGenerator
double	samplePeriod
PaStreamCallback *	streamCallback
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

unsigned int PaUtilBufferProcessor::bytesPerHostInputSample

Referenced by PaUtil_CopyInput(), PaUtil_InitializeBufferProcessor(), PaUtil_Set2ndInterleavedInputChannels(), and PaUtil_SetInterleavedInputChannels().

unsigned int PaUtilBufferProcessor::bytesPerHostOutputSample

Referenced by PaUtil_CopyOutput(), PaUtil_InitializeBufferProcessor(), PaUtil_Set2ndInterleavedOutputChannels(), PaUtil_SetInterleavedOutputChannels(), and PaUtil_ZeroOutput().

unsigned int PaUtilBufferProcessor::bytesPerUserInputSample

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

unsigned int PaUtilBufferProcessor::bytesPerUserOutputSample

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

PaStreamCallbackFlags PaUtilBufferProcessor::callbackStatusFlags

Referenced by PaUtil_BeginBufferProcessing().

PaUtilTriangularDitherGenerator PaUtilBufferProcessor::ditherGenerator

Referenced by PaUtil_CopyInput(), PaUtil_CopyOutput(), and PaUtil_InitializeBufferProcessor().

unsigned long PaUtilBufferProcessor::framesInTempInputBuffer

frames remaining in input buffer from previous adaption iteration

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

unsigned long PaUtilBufferProcessor::framesInTempOutputBuffer

frames remaining in input buffer from previous adaption iteration

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

unsigned long PaUtilBufferProcessor::framesPerHostBuffer

Referenced by PaUtil_InitializeBufferProcessor(), PaUtil_SetInputFrameCount(), and PaUtil_SetOutputFrameCount().

unsigned long PaUtilBufferProcessor::framesPerTempBuffer

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_ResetBufferProcessor().

unsigned long PaUtilBufferProcessor::framesPerUserBuffer

Referenced by PaUtil_InitializeBufferProcessor().

PaUtilHostBufferSizeMode PaUtilBufferProcessor::hostBufferSizeMode

Referenced by PaUtil_EndBufferProcessing(), and PaUtil_InitializeBufferProcessor().

PaUtilChannelDescriptor* PaUtilBufferProcessor::hostInputChannels[2]

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

Referenced by PaUtil_CopyInput(), PaUtil_EndBufferProcessing(), PaUtil_InitializeBufferProcessor(), PaUtil_Set2ndInputChannel(), PaUtil_Set2ndInterleavedInputChannels(), PaUtil_Set2ndNonInterleavedInputChannel(), PaUtil_SetInputChannel(), PaUtil_SetInterleavedInputChannels(), PaUtil_SetNoInput(), PaUtil_SetNonInterleavedInputChannel(), and PaUtil_TerminateBufferProcessor().

unsigned long PaUtilBufferProcessor::hostInputFrameCount[2]

Referenced by PaUtil_BeginBufferProcessing(), PaUtil_CopyInput(), PaUtil_EndBufferProcessing(), PaUtil_Set2ndInputFrameCount(), and PaUtil_SetInputFrameCount().

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().

unsigned long PaUtilBufferProcessor::hostOutputFrameCount[2]

Referenced by PaUtil_BeginBufferProcessing(), PaUtil_CopyOutput(), PaUtil_EndBufferProcessing(), PaUtil_Set2ndOutputFrameCount(), PaUtil_SetOutputFrameCount(), and PaUtil_ZeroOutput().

unsigned long PaUtilBufferProcessor::initialFramesInTempInputBuffer

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

unsigned long PaUtilBufferProcessor::initialFramesInTempOutputBuffer

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

unsigned int PaUtilBufferProcessor::inputChannelCount

Referenced by PaUtil_CopyInput(), PaUtil_EndBufferProcessing(), PaUtil_InitializeBufferProcessor(), PaUtil_ResetBufferProcessor(), PaUtil_Set2ndInterleavedInputChannels(), PaUtil_SetInterleavedInputChannels(), and PaUtil_SetNoInput().

PaUtilConverter* PaUtilBufferProcessor::inputConverter

Referenced by PaUtil_CopyInput(), and PaUtil_InitializeBufferProcessor().

PaUtilZeroer* PaUtilBufferProcessor::inputZeroer

Referenced by PaUtil_InitializeBufferProcessor().

unsigned int PaUtilBufferProcessor::outputChannelCount

Referenced by PaUtil_CopyOutput(), PaUtil_EndBufferProcessing(), PaUtil_InitializeBufferProcessor(), PaUtil_ResetBufferProcessor(), PaUtil_Set2ndInterleavedOutputChannels(), PaUtil_SetInterleavedOutputChannels(), PaUtil_SetNoOutput(), and PaUtil_ZeroOutput().

PaUtilConverter* PaUtilBufferProcessor::outputConverter

Referenced by PaUtil_CopyOutput(), and PaUtil_InitializeBufferProcessor().

PaUtilZeroer* PaUtilBufferProcessor::outputZeroer

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_ZeroOutput().

double PaUtilBufferProcessor::samplePeriod

Referenced by PaUtil_BeginBufferProcessing(), and PaUtil_InitializeBufferProcessor().

PaStreamCallback* PaUtilBufferProcessor::streamCallback

Referenced by PaUtil_InitializeBufferProcessor().

void* PaUtilBufferProcessor::tempInputBuffer

used for slips, block adaption, and conversion.

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

void** PaUtilBufferProcessor::tempInputBufferPtrs

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

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_TerminateBufferProcessor().

void* PaUtilBufferProcessor::tempOutputBuffer

used for slips, block adaption, and conversion.

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

void** PaUtilBufferProcessor::tempOutputBufferPtrs

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

Referenced by PaUtil_InitializeBufferProcessor(), and PaUtil_TerminateBufferProcessor().

PaStreamCallbackTimeInfo* PaUtilBufferProcessor::timeInfo

Referenced by PaUtil_BeginBufferProcessing().

int PaUtilBufferProcessor::useNonAdaptingProcess

Referenced by PaUtil_EndBufferProcessing(), and PaUtil_InitializeBufferProcessor().

void* PaUtilBufferProcessor::userData

Referenced by PaUtil_InitializeBufferProcessor().

int PaUtilBufferProcessor::userInputIsInterleaved

Referenced by PaUtil_CopyInput(), and PaUtil_InitializeBufferProcessor().

int PaUtilBufferProcessor::userOutputIsInterleaved

Referenced by PaUtil_CopyOutput(), and PaUtil_InitializeBufferProcessor().

---

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

• pa_process.h