pa_unix_hostapis.c File Reference

#include "pa_hostapi.h"

Functions
PaError	PaJack_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaAlsa_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaOSS_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaSGI_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaAsiHpi_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaMacCore_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)
PaError	PaSkeleton_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)

Variables
PaUtilHostApiInitializer *	paHostApiInitializers []

Function Documentation

PaError PaAlsa_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	hostApiIndex
	)

Uncommented because AlsaErrorHandler is unused for anything good yet. If AlsaErrorHandler is to be used, do not forget to register this callback in PaAlsa_Initialize, and unregister in Terminate.

If AlsaErrorHandler is to be used, do not forget to unregister callback pointer in Terminate function.

References PaAlsaHostApiRepresentation::allocations, PaAlsaHostApiRepresentation::alsaLibVersion, PaAlsaHostApiRepresentation::blockingStreamInterface, PaAlsaHostApiRepresentation::callbackStreamInterface, PaAlsaHostApiRepresentation::hostApiIndex, PA_ENSURE, PA_UNLESS, paALSA, paHostApiNotFound, paInsufficientMemory, paNoError, PaUnixThreading_Initialize(), PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), and PaUtil_InitializeStreamInterface().

PaError PaAsiHpi_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

Initialize host API implementation. This is the only function exported beyond this file. It is called by PortAudio to initialize the host API. It stores API info, finds and registers all devices, and sets up callback and blocking interfaces.

Parameters

hostApi	Pointer to host API struct
hostApiIndex	Index of current (HPI) host API

Returns

PortAudio error code

References PaAsiHpiHostApiRepresentation::allocations, PaAsiHpiHostApiRepresentation::baseHostApiRep, PaAsiHpiHostApiRepresentation::blockingStreamInterface, PaAsiHpiHostApiRepresentation::callbackStreamInterface, PaHostApiInfo::defaultInputDevice, PaHostApiInfo::defaultOutputDevice, PaHostApiInfo::deviceCount, PaAsiHpiHostApiRepresentation::hostApiIndex, PaHostApiInfo::name, PA_ASIHPI_UNLESS_, PA_DEBUG, PA_ENSURE_, PA_UNLESS_, paAudioScienceHPI, paInsufficientMemory, paNoDevice, paNoError, paUnanticipatedHostError, PaUnixThreading_Initialize(), PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeMemory(), PaUtil_InitializeStreamInterface(), PaHostApiInfo::structVersion, and PaHostApiInfo::type.

PaError PaJack_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

References ASSERT_CALL, PaJackHostApiRepresentation::blockingStreamInterface, PaJackHostApiRepresentation::callbackStreamInterface, PaJackHostApiRepresentation::commonHostApiRep, PaJackHostApiRepresentation::cond, PaJackHostApiRepresentation::deviceInfoMemory, ENSURE_PA, PaJackHostApiRepresentation::hostApiIndex, PaUtilHostApiRepresentation::info, PaJackHostApiRepresentation::inputBase, PaJackHostApiRepresentation::jack_buffer_size, PaJackHostApiRepresentation::jack_client, PaJackHostApiRepresentation::jackIsDown, PaJackHostApiRepresentation::mtx, PaJackHostApiRepresentation::outputBase, PA_DEBUG, paInsufficientMemory, paJACK, paNoError, paUnanticipatedHostError, PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), PaUtil_InitializeStreamInterface(), PaJackHostApiRepresentation::processQueue, PaHostApiInfo::structVersion, PaJackHostApiRepresentation::toAdd, PaJackHostApiRepresentation::toRemove, UNLESS, and PaJackHostApiRepresentation::xrun.

PaError PaMacCore_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

References PaMacAUHAL::allocations, PaMacAUHAL::blockingStreamInterface, PaMacAUHAL::callbackStreamInterface, PaMacAUHAL::defaultIn, PaMacAUHAL::defaultOut, PaMacAUHAL::devCount, PaMacAUHAL::devIds, GetStreamReadAvailable(), GetStreamWriteAvailable(), PaUtilHostApiRepresentation::info, PaMacAUHAL::inheritedHostApiRep, initializeXRunListenerList(), PaUtilHostApiRepresentation::IsFormatSupported, PaUtilHostApiRepresentation::OpenStream, paCoreAudio, paInsufficientMemory, paNoDevice, paNoError, PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), PaUtil_GroupAllocateMemory(), PaUtil_InitializeStreamInterface(), ReadStream(), PaHostApiInfo::structVersion, PaUtilHostApiRepresentation::Terminate, UNIX_ERR, VVDBUG, and WriteStream().

PaError PaOSS_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	hostApiIndex
	)

Initialize the OSS API implementation.

This function will initialize host API datastructures and query host devices for information.

Aspect DeviceCapabilities: Enumeration of host API devices is initiated from here

Aspect FreeResources: If an error is encountered under way we have to free each resource allocated in this function, this happens with the usual "error" label.

References PaOSSHostApiRepresentation::allocations, PaOSSHostApiRepresentation::blockingStreamInterface, PaOSSHostApiRepresentation::callbackStreamInterface, GetStreamReadAvailable(), GetStreamWriteAvailable(), PaOSSHostApiRepresentation::hostApiIndex, PaUtilHostApiRepresentation::info, PaOSSHostApiRepresentation::inheritedHostApiRep, PA_ENSURE, PA_UNLESS, paInsufficientMemory, paNoError, paOSS, PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), PaUtil_InitializeStreamInterface(), ReadStream(), PaHostApiInfo::structVersion, and WriteStream().

PaError PaSGI_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

PaError PaSkeleton_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

Variable Documentation

PaUtilHostApiInitializer* paHostApiInitializers[]

Note that on Linux, ALSA is placed before OSS so that the former is preferred over the latter.