pa_mac_core_blocking.c File Reference

#include "pa_mac_core_blocking.h"
#include "pa_mac_core_internal.h"
#include <assert.h>
#include <libkern/OSAtomic.h>

Functions
PaError	initializeBlioRingBuffers (PaMacBlio *blio, PaSampleFormat inputSampleFormat, PaSampleFormat outputSampleFormat, long ringBufferSizeInFrames, int inChan, int outChan)
PaError	resetBlioRingBuffers (PaMacBlio *blio)
PaError	destroyBlioRingBuffers (PaMacBlio *blio)
int	BlioCallback (const void *input, void *output, unsigned long frameCount, const PaStreamCallbackTimeInfo *timeInfo, PaStreamCallbackFlags statusFlags, void *userData)
PaError	ReadStream (PaStream *stream, void *buffer, unsigned long framesRequested)
PaError	WriteStream (PaStream *stream, const void *buffer, unsigned long framesRequested)
PaError	waitUntilBlioWriteBufferIsEmpty (PaMacBlio *blio, double sampleRate, size_t framesPerBuffer)
signed long	GetStreamReadAvailable (PaStream *stream)
signed long	GetStreamWriteAvailable (PaStream *stream)

Detailed Description

This file contains the implementation required for blocking I/O. It is separated from pa_mac_core.c simply to ease development.

Function Documentation

BlioCallback()

int BlioCallback	(	const void *	input,
		void *	output,
		unsigned long	frameCount,
		const PaStreamCallbackTimeInfo *	timeInfo,
		PaStreamCallbackFlags	statusFlags,
		void *	userData )

References PaMacBlio::inChan, PaMacBlio::inputRingBuffer, PaMacBlio::outChan, PaMacBlio::outputRingBuffer, PaMacBlio::outputSampleSizeActual, paContinue, paInputOverflow, paOutputUnderflow, PaUtil_GetRingBufferReadAvailable(), PaUtil_GetRingBufferWriteAvailable(), PaUtil_ReadRingBuffer(), PaUtil_WriteRingBuffer(), and PaMacBlio::statusFlags.

destroyBlioRingBuffers()

PaError destroyBlioRingBuffers

(

PaMacBlio *

blio

)

References PaUtilRingBuffer::buffer, PaMacBlio::inputRingBuffer, PaMacBlio::outputRingBuffer, paNoError, and UNIX_ERR.

Referenced by initializeBlioRingBuffers().

GetStreamReadAvailable()

static signed long GetStreamReadAvailable

(

PaStream *

stream

)

References PaMacBlio::inputRingBuffer, PaUtil_GetRingBufferReadAvailable(), and VVDBUG.

Referenced by PaMacCore_Initialize(), PaOSS_Initialize(), PaSkeleton_Initialize(), PaWasapi_Initialize(), PaWinDs_Initialize(), PaWinMme_Initialize(), and PaWinWdm_Initialize().

GetStreamWriteAvailable()

static signed long GetStreamWriteAvailable

(

PaStream *

stream

)

References PaMacBlio::outputRingBuffer, PaUtil_GetRingBufferWriteAvailable(), and VVDBUG.

Referenced by PaMacCore_Initialize(), PaOSS_Initialize(), PaSkeleton_Initialize(), PaWasapi_Initialize(), PaWinDs_Initialize(), PaWinMme_Initialize(), and PaWinWdm_Initialize().

initializeBlioRingBuffers()

PaError initializeBlioRingBuffers	(	PaMacBlio *	blio,
		PaSampleFormat	inputSampleFormat,
		PaSampleFormat	outputSampleFormat,
		long	ringBufferSizeInFrames,
		int	inChan,
		int	outChan )

This should be called with the relevant info when initializing a stream for callback.

Parameters

ringBufferSizeInFrames

must be a power of 2

References PaUtilRingBuffer::buffer, destroyBlioRingBuffers(), PaMacBlio::errors, PaMacBlio::inChan, PaMacBlio::inputRingBuffer, PaMacBlio::inputSampleFormat, PaMacBlio::inputSampleSizeActual, PaMacBlio::inputSampleSizePow2, PaMacBlio::outChan, PaMacBlio::outputRingBuffer, PaMacBlio::outputSampleFormat, PaMacBlio::outputSampleSizeActual, PaMacBlio::outputSampleSizePow2, paInsufficientMemory, PaMacCore_SetUnixError(), paNoError, PaUtil_InitializeRingBuffer(), resetBlioRingBuffers(), PaMacBlio::ringBufferFrames, PaMacBlio::statusFlags, and UNIX_ERR.

ReadStream()

static PaError ReadStream	(	PaStream *	stream,
		void *	buffer,
		unsigned long	framesRequested )

Todo

REVIEW: consider what to do if the input overflows. do we requeue all of the buffers? should we be running a thread to make sure they are always queued? see: http://www.portaudio.com/trac/ticket/117

References buffer, PaMacBlio::inChan, PaMacBlio::inputRingBuffer, PaMacBlio::inputSampleSizeActual, MIN, PA_MAC_BLIO_BUSY_WAIT_SLEEP_INTERVAL, Pa_Sleep(), paInputOverflow, paInputOverflowed, paNoError, PaUtil_GetRingBufferReadAvailable(), PaUtil_ReadRingBuffer(), PaMacBlio::statusFlags, UNIX_ERR, and VVDBUG.

Referenced by PaMacCore_Initialize(), PaOSS_Initialize(), PaSkeleton_Initialize(), PaWasapi_Initialize(), PaWinDs_Initialize(), PaWinMme_Initialize(), and PaWinWdm_Initialize().

resetBlioRingBuffers()

PaError resetBlioRingBuffers

(

PaMacBlio *

blio

)

References PaUtilRingBuffer::buffer, PaUtilRingBuffer::bufferSize, PaUtilRingBuffer::elementSizeBytes, PaMacBlio::inputRingBuffer, PaMacBlio::outputRingBuffer, paNoError, PaUtil_AdvanceRingBufferWriteIndex(), PaUtil_FlushRingBuffer(), PaMacBlio::ringBufferFrames, and PaMacBlio::statusFlags.

Referenced by initializeBlioRingBuffers().

waitUntilBlioWriteBufferIsEmpty()

PaError waitUntilBlioWriteBufferIsEmpty	(	PaMacBlio *	blio,
		double	sampleRate,
		size_t	framesPerBuffer )

References PaUtilRingBuffer::buffer, PaMacBlio::outputRingBuffer, Pa_Sleep(), paNoError, paTimedOut, PaUtil_GetRingBufferReadAvailable(), PaUtil_GetTime(), and VDBUG.

WriteStream()

static PaError WriteStream	(	PaStream *	stream,
		const void *	buffer,
		unsigned long	framesRequested )

Todo

REVIEW: consider what to do if the output underflows. do we requeue all the existing buffers with zeros? should we run a separate thread to keep the buffers enqueued at all times? see: http://www.portaudio.com/trac/ticket/117

References PaMacCoreStream::blio, buffer, MIN, PaMacBlio::outChan, PaMacBlio::outputRingBuffer, PaMacBlio::outputSampleSizeActual, PA_MAC_BLIO_BUSY_WAIT_SLEEP_INTERVAL, Pa_Sleep(), paInternalError, paNoError, paOutputUnderflow, paOutputUnderflowed, PaUtil_GetRingBufferWriteAvailable(), PaUtil_WriteRingBuffer(), PaMacCoreStream::state, PaMacBlio::statusFlags, UNIX_ERR, and VVDBUG.

Referenced by PaMacCore_Initialize(), PaOSS_Initialize(), PaSkeleton_Initialize(), PaWasapi_Initialize(), PaWinDs_Initialize(), PaWinMme_Initialize(), and PaWinWdm_Initialize().