PortAudio  2.0
Functions | Variables
#include <pthread.h>
#include <unistd.h>
#include <stdlib.h>
#include <time.h>
#include <sys/time.h>
#include <assert.h>
#include <string.h>
#include <math.h>
#include <errno.h>
#include "pa_util.h"
#include "pa_unix_util.h"
#include "pa_debugprint.h"


void * PaUtil_AllocateMemory (long size)
void PaUtil_FreeMemory (void *block)
int PaUtil_CountCurrentlyAllocatedBlocks (void)
void Pa_Sleep (long msec)
void PaUtil_InitializeClock (void)
PaTime PaUtil_GetTime (void)
PaError PaUtil_InitializeThreading (PaUtilThreading *threading)
void PaUtil_TerminateThreading (PaUtilThreading *threading)
PaError PaUtil_StartThreading (PaUtilThreading *threading, void *(*threadRoutine)(void *), void *data)
PaError PaUtil_CancelThreading (PaUtilThreading *threading, int wait, PaError *exitResult)
PaError PaUnixThreading_Initialize ()
PaError PaUnixThread_New (PaUnixThread *self, void *(*threadFunc)(void *), void *threadArg, PaTime waitForChild, int rtSched)
PaError PaUnixThread_Terminate (PaUnixThread *self, int wait, PaError *exitResult)
PaError PaUnixThread_PrepareNotify (PaUnixThread *self)
PaError PaUnixThread_NotifyParent (PaUnixThread *self)
int PaUnixThread_StopRequested (PaUnixThread *self)
PaError PaUnixMutex_Initialize (PaUnixMutex *self)
PaError PaUnixMutex_Terminate (PaUnixMutex *self)
PaError PaUnixMutex_Lock (PaUnixMutex *self)
PaError PaUnixMutex_Unlock (PaUnixMutex *self)


pthread_t paUnixMainThread = 0

Function Documentation

void Pa_Sleep ( long  msec)

Put the caller to sleep for at least 'msec' milliseconds. This function is provided only as a convenience for authors of portable code (such as the tests and examples in the PortAudio distribution.)

The function may sleep longer than requested so don't rely on this for accurate musical timing.

PaError PaUnixMutex_Initialize ( PaUnixMutex self)

References PA_ASSERT_CALL, and paNoError.

Referenced by PaUnixThread_New().

PaError PaUnixMutex_Lock ( PaUnixMutex self)

Lock mutex.

We're disabling thread cancellation while the thread is holding a lock, so mutexes are properly unlocked at termination time.

References PA_ENSURE_SYSTEM, and paNoError.

Referenced by PaUnixThread_New(), PaUnixThread_NotifyParent(), and PaUnixThread_PrepareNotify().

PaError PaUnixMutex_Terminate ( PaUnixMutex self)

References PA_ASSERT_CALL, and paNoError.

Referenced by PaUnixThread_Terminate().

PaError PaUnixMutex_Unlock ( PaUnixMutex self)

Unlock mutex.

Thread cancellation is enabled again after the mutex is properly unlocked.

References PA_ENSURE_SYSTEM, and paNoError.

Referenced by PaUnixThread_New(), and PaUnixThread_NotifyParent().

PaError PaUnixThread_New ( PaUnixThread self,
void *(*)(void *)  threadFunc,
void *  threadArg,
PaTime  waitForChild,
int  rtSched 

Spawn a thread.

Intended for spawning the callback thread from the main thread. This function can even block (for a certain time or indefinitely) untill notified by the callback thread (using PaUnixThread_NotifyParent), which can be useful in order to make sure that callback has commenced before returning from Pa_StartStream.

threadFunc,:The function to be executed in the child thread.
waitForChild,:If not 0, wait for child thread to call PaUnixThread_NotifyParent. Less than 0 means wait for ever, greater than 0 wait for the specified time.
rtSched,:Enable realtime scheduling?
: If timed out waiting on child, paTimedOut.

References PA_ASSERT_CALL, PA_DEBUG, PA_ENSURE, PA_ENSURE_SYSTEM, PA_MIN, PA_UNLESS, paInternalError, paNoError, paTimedOut, PaUnixMutex_Initialize(), PaUnixMutex_Lock(), PaUnixMutex_Unlock(), PaUnixThread_Terminate(), and PaUtil_GetTime().

PaError PaUnixThread_NotifyParent ( PaUnixThread self)

Notify waiting parent thread.

: If parent timed out waiting, paTimedOut. If parent was never waiting, paInternalError.

References PA_ENSURE, PA_UNLESS, paInternalError, paNoError, PaUnixMutex_Lock(), and PaUnixMutex_Unlock().

PaError PaUnixThread_PrepareNotify ( PaUnixThread self)

Prepare to notify waiting parent thread.

An internal lock must be held before the parent is notified in PaUnixThread_NotifyParent, call this to acquire it beforehand.

: If parent is not waiting, paInternalError.

References PA_ENSURE, PA_UNLESS, paInternalError, paNoError, and PaUnixMutex_Lock().

int PaUnixThread_StopRequested ( PaUnixThread self)

Has the parent thread requested this thread to stop?

PaError PaUnixThread_Terminate ( PaUnixThread self,
int  wait,
PaError exitResult 

Terminate thread.

wait,:If true, request that background thread stop and wait untill it does, else cancel it.
exitResult,:If non-null this will upon return contain the exit status of the thread.

References PA_ASSERT_CALL, PA_DEBUG, PA_ENSURE_SYSTEM, paNoError, and PaUnixMutex_Terminate().

Referenced by PaUnixThread_New().

PaError PaUnixThreading_Initialize ( )

Initialize global threading state.

References paNoError.

Referenced by PaAlsa_Initialize(), and PaAsiHpi_Initialize().

void* PaUtil_AllocateMemory ( long  size)

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

PaError PaUtil_CancelThreading ( PaUtilThreading threading,
int  wait,
PaError exitResult 
int PaUtil_CountCurrentlyAllocatedBlocks ( void  )

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

Allocations will only be tracked if PA_TRACK_MEMORY is #defined. If it isn't, this function will always return 0.
void PaUtil_FreeMemory ( void *  block)

Realease block if non-NULL. block may be NULL

PaTime PaUtil_GetTime ( void  )

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

See Also
void PaUtil_InitializeClock ( void  )

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

See Also
PaError PaUtil_InitializeThreading ( PaUtilThreading threading)

References paNoError.

PaError PaUtil_StartThreading ( PaUtilThreading threading,
void *(*)(void *)  threadRoutine,
void *  data 
void PaUtil_TerminateThreading ( PaUtilThreading threading)

Variable Documentation

pthread_t paUnixMainThread = 0