pa_asio.cpp File Reference

#include <stdio.h>
#include <assert.h>
#include <string.h>
#include <new>
#include <windows.h>
#include <mmsystem.h>
#include "portaudio.h"
#include "pa_asio.h"
#include "pa_util.h"
#include "pa_allocation.h"
#include "pa_hostapi.h"
#include "pa_stream.h"
#include "pa_cpuload.h"
#include "pa_process.h"
#include "pa_debugprint.h"
#include "pa_ringbuffer.h"
#include "pa_win_coinitialize.h"
#include "pa_win_util.h"
#include "asiosys.h"
#include "asio.h"
#include "asiodrivers.h"
#include "iasiothiscallresolver.h"

Data Structures
struct	PaAsioDriverInfo
struct	PaAsioHostApiRepresentation
struct	PaAsioDeviceInfo
struct	PaAsioStreamBlockingState
struct	PaAsioStream

Macros
#define	WIN32
#define	CARBON_COMPATIBLE   (0)
#define	PA_ASIO_SET_LAST_HOST_ERROR(errorCode, errorText)
#define	PA_ASIO_SET_LAST_SYSTEM_ERROR(errorCode)
#define	PA_ASIO_SET_LAST_ASIO_ERROR(asioError)
#define	PA_SWAP32_(x)
#define	PA_SWAP_(x, y)
#define	PA_DEFAULTSAMPLERATESEARCHORDER_COUNT_   13 /* must be the same number of elements as in the array below */
#define	ASIO64toDouble(a)

Typedefs
typedef struct PaAsioDriverInfo	PaAsioDriverInfo
typedef void	PaAsioBufferConverter(void *, long, long)
typedef struct PaAsioDeviceInfo	PaAsioDeviceInfo
typedef BOOL(WINAPI *	IsDebuggerPresentPtr) (VOID)
typedef struct PaAsioStreamBlockingState	PaAsioStreamBlockingState
typedef struct PaAsioStream	PaAsioStream

Functions
PaError	PaAsio_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex hostApiIndex)
void	AsioSampleTypeLOG (ASIOSampleType type)
PaError	PaAsio_GetAvailableBufferSizes (PaDeviceIndex device, long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity)
PaError	PaAsio_ShowControlPanel (PaDeviceIndex device, void *systemSpecific)
PaError	PaAsio_GetInputChannelName (PaDeviceIndex device, int channelIndex, const char **channelName)
PaError	PaAsio_GetOutputChannelName (PaDeviceIndex device, int channelIndex, const char **channelName)
PaError	PaAsio_SetStreamSampleRate (PaStream *s, double sampleRate)

Variables
AsioDrivers *	asioDrivers
IsDebuggerPresentPtr	IsDebuggerPresent_ = 0
const double	twoRaisedTo32 = 4294967296.

Detailed Description

Note that specific support for paInputUnderflow, paOutputOverflow and paNeverDropInput is not necessary or possible with this driver due to the synchronous full duplex double-buffered architecture of ASIO.

Macro Definition Documentation

ASIO64toDouble

#define ASIO64toDouble

(

a

)

Value:

((a).lo + (a).hi * twoRaisedTo32)

CARBON_COMPATIBLE

#define CARBON_COMPATIBLE   (0)

PA_ASIO_SET_LAST_ASIO_ERROR

#define PA_ASIO_SET_LAST_ASIO_ERROR

(

asioError

)

Value:

    PaUtil_SetLastHostErrorInfo( paASIO, asioError, PaAsio_GetAsioErrorText( asioError ) )

Referenced by PaAsio_ShowControlPanel().

PA_ASIO_SET_LAST_HOST_ERROR

#define PA_ASIO_SET_LAST_HOST_ERROR	(		errorCode,
			errorText )

Value:

    PaUtil_SetLastHostErrorInfo( paASIO, errorCode, errorText )

PA_ASIO_SET_LAST_SYSTEM_ERROR

#define PA_ASIO_SET_LAST_SYSTEM_ERROR

(

errorCode

)

Value:

    PaAsio_SetLastSystemError( errorCode )

PA_DEFAULTSAMPLERATESEARCHORDER_COUNT_

#define PA_DEFAULTSAMPLERATESEARCHORDER_COUNT_   13 /* must be the same number of elements as in the array below */

PA_SWAP32_

#define PA_SWAP32_

(

x

)

Value:

((x>>24) | ((x>>8)&0xFF00) | ((x<<8)&0xFF0000) | (x<<24));

PA_SWAP_

#define PA_SWAP_	(		x,
			y )

Value:

temp=x; x = y; y = temp;

WIN32

#define WIN32

Typedef Documentation

IsDebuggerPresentPtr

typedef BOOL(WINAPI * IsDebuggerPresentPtr) (VOID)

PaAsioBufferConverter

typedef void PaAsioBufferConverter(void *, long, long)

PaAsioDeviceInfo

typedef struct PaAsioDeviceInfo PaAsioDeviceInfo

PaAsioDriverInfo

typedef struct PaAsioDriverInfo PaAsioDriverInfo

PaAsioStream

typedef struct PaAsioStream PaAsioStream

PaAsioStreamBlockingState

typedef struct PaAsioStreamBlockingState PaAsioStreamBlockingState

A data structure specifically for storing blocking i/o related data.

Function Documentation

AsioSampleTypeLOG()

void AsioSampleTypeLOG

(

ASIOSampleType

type

)

References PA_DEBUG.

PaAsio_GetAvailableBufferSizes()

PaError PaAsio_GetAvailableBufferSizes	(	PaDeviceIndex	device,
		long *	minBufferSizeFrames,
		long *	maxBufferSizeFrames,
		long *	preferredBufferSizeFrames,
		long *	granularity )

Retrieve legal native buffer sizes for the specified device, in sample frames.

Parameters

device	The global index of the device about which the query is being made.
minBufferSizeFrames	A pointer to the location which will receive the minimum buffer size value.
maxBufferSizeFrames	A pointer to the location which will receive the maximum buffer size value.
preferredBufferSizeFrames	A pointer to the location which will receive the preferred buffer size value.
granularity	A pointer to the location which will receive the "granularity". This value determines the step size used to compute the legal values between minBufferSizeFrames and maxBufferSizeFrames. If granularity is -1 then available buffer size values are powers of two.

See also

ASIOGetBufferSize in the ASIO SDK.

Note

: this function used to be called PaAsio_GetAvailableLatencyValues. There is a #define that maps PaAsio_GetAvailableLatencyValues to this function for backwards compatibility.

References PaAsioDeviceInfo::bufferGranularity, PaUtilHostApiRepresentation::deviceInfos, PaAsioDeviceInfo::maxBufferSize, PaAsioDeviceInfo::minBufferSize, paASIO, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), PaUtil_GetHostApiRepresentation(), and PaAsioDeviceInfo::preferredBufferSize.

PaAsio_GetInputChannelName()

PaError PaAsio_GetInputChannelName	(	PaDeviceIndex	device,
		int	channelIndex,
		const char **	channelName )

Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.

The string will be no longer than 32 characters including the null terminator.

References PaAsioDeviceInfo::asioChannelInfos, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::maxInputChannels, paASIO, paInvalidChannelCount, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), and PaUtil_GetHostApiRepresentation().

PaAsio_GetOutputChannelName()

PaError PaAsio_GetOutputChannelName	(	PaDeviceIndex	device,
		int	channelIndex,
		const char **	channelName )

Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.

The string will be no longer than 32 characters including the null terminator.

References PaAsioDeviceInfo::asioChannelInfos, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::maxInputChannels, PaDeviceInfo::maxOutputChannels, paASIO, paInvalidChannelCount, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), and PaUtil_GetHostApiRepresentation().

PaAsio_Initialize()

PaError PaAsio_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	hostApiIndex )

References PaAsioHostApiRepresentation::allocations, asioDrivers, PaAsioHostApiRepresentation::asioDrivers, PaAsioHostApiRepresentation::blockingStreamInterface, PaAsioHostApiRepresentation::callbackStreamInterface, PaAsioHostApiRepresentation::comInitializationResult, PaAsioDeviceInfo::commonDeviceInfo, PaDeviceInfo::hostApi, PaUtilHostApiRepresentation::info, PaAsioHostApiRepresentation::inheritedHostApiRep, IsDebuggerPresent_, PaDeviceInfo::name, PaAsioHostApiRepresentation::openAsioDeviceIndex, PA_DEBUG, paASIO, paInsufficientMemory, paNoDevice, paNoError, PaUtil_AllocateZeroInitializedMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), PaUtil_GroupAllocateZeroInitializedMemory(), PaUtil_InitializeStreamInterface(), PaWinUtil_CoInitialize(), PaWinUtil_CoUninitialize(), PaDeviceInfo::structVersion, PaHostApiInfo::structVersion, and PaAsioHostApiRepresentation::systemSpecific.

PaAsio_SetStreamSampleRate()

PaError PaAsio_SetStreamSampleRate	(	PaStream *	stream,
		double	sampleRate )

Set the sample rate of an open paASIO stream.

Parameters

stream	The stream to operate on.
sampleRate	The new sample rate.

Note that this function may fail if the stream is already running and the ASIO driver does not support switching the sample rate of a running stream.

Returns paIncompatibleStreamHostApi if stream is not a paASIO stream.

References paBadStreamPtr, and paNoError.

PaAsio_ShowControlPanel()

PaError PaAsio_ShowControlPanel	(	PaDeviceIndex	device,
		void *	systemSpecific )

Display the ASIO control panel for the specified device.

Parameters

device	The global index of the device whose control panel is to be displayed.
systemSpecific	On Windows, the calling application's main window handle, on Macintosh this value should be zero.

References PaAsioHostApiRepresentation::asioDrivers, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::name, PaAsioHostApiRepresentation::openAsioDeviceIndex, PA_ASIO_SET_LAST_ASIO_ERROR, PA_DEBUG, paASIO, paDeviceUnavailable, paNoDevice, paNoError, paUnanticipatedHostError, PaUtil_DeviceIndexToHostApiDeviceIndex(), PaUtil_GetHostApiRepresentation(), PaWinUtil_CoInitialize(), and PaWinUtil_CoUninitialize().

Variable Documentation

asioDrivers

AsioDrivers* asioDrivers

extern

Referenced by PaAsio_Initialize().

IsDebuggerPresent_

IsDebuggerPresentPtr IsDebuggerPresent_ = 0

Referenced by PaAsio_Initialize().

twoRaisedTo32

const double twoRaisedTo32 = 4294967296.