pa_util.h

Go to the documentation of this file.
00001 #ifndef PA_UTIL_H
00002 #define PA_UTIL_H
00003 /*
00004  * $Id: pa_util.h 1229 2007-06-15 16:11:11Z rossb $
00005  * Portable Audio I/O Library implementation utilities header
00006  * common implementation utilities and interfaces
00007  *
00008  * Based on the Open Source API proposed by Ross Bencina
00009  * Copyright (c) 1999-2002 Ross Bencina, Phil Burk
00010  *
00011  * Permission is hereby granted, free of charge, to any person obtaining
00012  * a copy of this software and associated documentation files
00013  * (the "Software"), to deal in the Software without restriction,
00014  * including without limitation the rights to use, copy, modify, merge,
00015  * publish, distribute, sublicense, and/or sell copies of the Software,
00016  * and to permit persons to whom the Software is furnished to do so,
00017  * subject to the following conditions:
00018  *
00019  * The above copyright notice and this permission notice shall be
00020  * included in all copies or substantial portions of the Software.
00021  *
00022  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
00026  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
00027  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00028  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00029  */
00030 
00031 /*
00032  * The text above constitutes the entire PortAudio license; however, 
00033  * the PortAudio community also makes the following non-binding requests:
00034  *
00035  * Any person wishing to distribute modifications to the Software is
00036  * requested to send the modifications to the original developer so that
00037  * they can be incorporated into the canonical version. It is also 
00038  * requested that these non-binding requests be included along with the 
00039  * license above.
00040  */
00041 
00052 #include "portaudio.h"
00053 
00054 #ifdef __cplusplus
00055 extern "C"
00056 {
00057 #endif /* __cplusplus */
00058 
00059 
00060 struct PaUtilHostApiRepresentation;
00061 
00062 
00077 PaError PaUtil_GetHostApiRepresentation( struct PaUtilHostApiRepresentation **hostApi,
00078         PaHostApiTypeId type );
00079 
00080 
00090 PaError PaUtil_DeviceIndexToHostApiDeviceIndex(
00091         PaDeviceIndex *hostApiDevice, PaDeviceIndex device,
00092         struct PaUtilHostApiRepresentation *hostApi );
00093 
00094 
00111 void PaUtil_SetLastHostErrorInfo( PaHostApiTypeId hostApiType, long errorCode,
00112         const char *errorText );
00113 
00114 
00115         
00116 /* the following functions are implemented in a platform platform specific
00117  .c file
00118 */
00119 
00121 void *PaUtil_AllocateMemory( long size );
00122 
00123 
00125 void PaUtil_FreeMemory( void *block );
00126 
00127 
00134 int PaUtil_CountCurrentlyAllocatedBlocks( void );
00135 
00136 
00142 void PaUtil_InitializeClock( void );
00143 
00144 
00149 double PaUtil_GetTime( void );
00150 
00151 
00152 /* void Pa_Sleep( long msec );  must also be implemented in per-platform .c file */
00153 
00154 
00155 
00156 #ifdef __cplusplus
00157 }
00158 #endif /* __cplusplus */
00159 #endif /* PA_UTIL_H */

Generated on Sun Feb 3 05:57:02 2008 for PortAudio by  doxygen 1.5.4