pa_util.h File Reference

Prototypes for utility functions used by PortAudio implementations. More...

#include "portaudio.h"

Go to the source code of this file.

Functions
PaError	PaUtil_GetHostApiRepresentation (struct PaUtilHostApiRepresentation **hostApi, PaHostApiTypeId type)
PaError	PaUtil_DeviceIndexToHostApiDeviceIndex (PaDeviceIndex *hostApiDevice, PaDeviceIndex device, struct PaUtilHostApiRepresentation *hostApi)
void	PaUtil_SetLastHostErrorInfo (PaHostApiTypeId hostApiType, long errorCode, const char *errorText)
void *	PaUtil_AllocateMemory (long size)
void	PaUtil_FreeMemory (void *block)
int	PaUtil_CountCurrentlyAllocatedBlocks (void)
void	PaUtil_InitializeClock (void)
double	PaUtil_GetTime (void)

---

Detailed Description

Prototypes for utility functions used by PortAudio implementations.

Todo:

Document and adhere to the alignment guarantees provided by PaUtil_AllocateMemory().

---

Function Documentation

void* PaUtil_AllocateMemory

(

long

size

)

Allocate size bytes, guaranteed to be aligned to a FIXME byte boundary

int PaUtil_CountCurrentlyAllocatedBlocks

(

void

)

Return the number of currently allocated blocks. This function can be used for detecting memory leaks.

Note:

Allocations will only be tracked if PA_TRACK_MEMORY is defined. If it isn't, this function will always return 0.

PaError PaUtil_DeviceIndexToHostApiDeviceIndex	(	PaDeviceIndex *	hostApiDevice,
		PaDeviceIndex	device,
		struct PaUtilHostApiRepresentation *	hostApi
	)

Convert a PortAudio device index into a host API specific device index.

Parameters:

	hostApiDevice	Pointer to a device index, on success this will recieve the converted device index value.
	device	The PortAudio device index to convert.
	hostApi	The host api which the index should be converted for.

Returns:

On success returns PaNoError and places the converted index in the hostApiDevice parameter.

void PaUtil_FreeMemory

(

void *

block

)

Realease block if non-NULL. block may be NULL

PaError PaUtil_GetHostApiRepresentation	(	struct PaUtilHostApiRepresentation **	hostApi,
		PaHostApiTypeId	type
	)

Retrieve a specific host API representation. This function can be used by implementations to retrieve a pointer to their representation in host api specific extension functions which aren't passed a rep pointer by pa_front.c.

Parameters:

	hostApi	A pointer to a host API represenation pointer. Apon success this will receive the requested representation pointer.
	type	A valid host API type identifier.

Returns:

An error code. If the result is PaNoError then a pointer to the requested host API representation will be stored in *hostApi. If the host API specified by type is not found, this function returns paHostApiNotFound.

double PaUtil_GetTime

(

void

)

Return the system time in seconds. Used to implement CPU load functions

See also:

PaUtil_InitializeClock

void PaUtil_InitializeClock

(

void

)

Initialize the clock used by PaUtil_GetTime(). Call this before calling PaUtil_GetTime.

See also:

PaUtil_GetTime

void PaUtil_SetLastHostErrorInfo	(	PaHostApiTypeId	hostApiType,
		long	errorCode,
		const char *	errorText
	)

Set the host error information returned by Pa_GetLastHostErrorInfo. This function and the paUnanticipatedHostError error code should be used as a last resort. Implementors should use existing PA error codes where possible, or nominate new ones. Note that at it is always better to use PaUtil_SetLastHostErrorInfo() and paUnanticipatedHostError than to return an ambiguous or inaccurate PaError code.

Parameters:

	hostApiType	The host API which encountered the error (ie of the caller)
	errorCode	The error code returned by the native API function.
	errorText	A string describing the error. PaUtil_SetLastHostErrorInfo makes a copy of the string, so it is not necessary for the pointer to remain valid after the call to PaUtil_SetLastHostErrorInfo() returns.

---