• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List
  • Globals

pa_mac_core.h

Go to the documentation of this file.
00001 #ifndef PA_MAC_CORE_H
00002 #define PA_MAC_CORE_H
00003 /*
00004  * PortAudio Portable Real-Time Audio Library
00005  * Macintosh Core Audio specific extensions
00006  * portaudio.h should be included before this file.
00007  *
00008  * Copyright (c) 2005-2006 Bjorn Roche
00009  *
00010  * Permission is hereby granted, free of charge, to any person obtaining
00011  * a copy of this software and associated documentation files
00012  * (the "Software"), to deal in the Software without restriction,
00013  * including without limitation the rights to use, copy, modify, merge,
00014  * publish, distribute, sublicense, and/or sell copies of the Software,
00015  * and to permit persons to whom the Software is furnished to do so,
00016  * subject to the following conditions:
00017  *
00018  * The above copyright notice and this permission notice shall be
00019  * included in all copies or substantial portions of the Software.
00020  *
00021  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00022  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00023  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00024  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
00025  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
00026  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00027  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00028  */
00029 
00030 /*
00031  * The text above constitutes the entire PortAudio license; however, 
00032  * the PortAudio community also makes the following non-binding requests:
00033  *
00034  * Any person wishing to distribute modifications to the Software is
00035  * requested to send the modifications to the original developer so that
00036  * they can be incorporated into the canonical version. It is also 
00037  * requested that these non-binding requests be included along with the 
00038  * license above.
00039  */
00040 
00046 #include <AudioUnit/AudioUnit.h>
00047 //#include <AudioToolbox/AudioToolbox.h>
00048 
00049 #ifdef __cplusplus
00050 extern "C" {
00051 #endif
00052 
00053 
00054 /*
00055  * A pointer to a paMacCoreStreamInfo may be passed as
00056  * the hostApiSpecificStreamInfo in the PaStreamParameters struct
00057  * when opening a stream or querying the format. Use NULL, for the
00058  * defaults. Note that for duplex streams, flags for input and output
00059  * should be the same or behaviour is undefined.
00060  */
00061 typedef struct
00062 {
00063     unsigned long size;           
00064     PaHostApiTypeId hostApiType;  
00065     unsigned long version;        
00066     unsigned long flags;          /* flags to modify behaviour */
00067     SInt32 const * channelMap;    /* Channel map for HAL channel mapping , if not needed, use NULL;*/ 
00068     unsigned long channelMapSize; /* Channel map size for HAL channel mapping , if not needed, use 0;*/ 
00069 } PaMacCoreStreamInfo;
00070 
00071 /*
00072  * Functions
00073  */
00074 
00075 
00076 /* Use this function to initialize a paMacCoreStreamInfo struct
00077  * using the requested flags. Note that channel mapping is turned
00078  * off after a call to this function.
00079  * @param data The datastructure to initialize
00080  * @param flags The flags to initialize the datastructure with.
00081 */
00082 void PaMacCore_SetupStreamInfo( PaMacCoreStreamInfo *data, unsigned long flags );
00083 
00084 /* call this after pa_SetupMacCoreStreamInfo to use channel mapping as described in notes.txt.
00085  * @param data The stream info structure to assign a channel mapping to
00086  * @param channelMap The channel map array, as described in notes.txt. This array pointer will be used directly (ie the underlying data will not be copied), so the caller should not free the array until after the stream has been opened.
00087  * @param channelMapSize The size of the channel map array.
00088  */
00089 void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const channelMap, unsigned long channelMapSize );
00090 
00091 /*
00092  * Retrieve the AudioDeviceID of the input device assigned to an open stream
00093  *
00094  * @param s The stream to query.
00095  *
00096  * @return A valid AudioDeviceID, or NULL if an error occurred.
00097  */
00098 AudioDeviceID PaMacCore_GetStreamInputDevice( PaStream* s );
00099  
00100 /*
00101  * Retrieve the AudioDeviceID of the output device assigned to an open stream
00102  *
00103  * @param s The stream to query.
00104  *
00105  * @return A valid AudioDeviceID, or NULL if an error occurred.
00106  */
00107 AudioDeviceID PaMacCore_GetStreamOutputDevice( PaStream* s );
00108 
00109 /*
00110  * Returns a statically allocated string with the device's name
00111  * for the given channel. NULL will be returned on failure.
00112  *
00113  * This function's implemenation is not complete!
00114  *
00115  * @param device The PortAudio device index.
00116  * @param channel The channel number who's name is requested.
00117  * @return a statically allocated string with the name of the device.
00118  *         Because this string is statically allocated, it must be
00119  *         coppied if it is to be saved and used by the user after
00120  *         another call to this function.
00121  *
00122  */
00123 const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input );
00124 
00125 /*
00126  * Flags
00127  */
00128 
00129 /*
00130  * The following flags alter the behaviour of PA on the mac platform.
00131  * they can be ORed together. These should work both for opening and
00132  * checking a device.
00133  */
00134 
00135 /* Allows PortAudio to change things like the device's frame size,
00136  * which allows for much lower latency, but might disrupt the device
00137  * if other programs are using it, even when you are just Querying
00138  * the device. */
00139 #define paMacCoreChangeDeviceParameters (0x01)
00140 
00141 /* In combination with the above flag,
00142  * causes the stream opening to fail, unless the exact sample rates
00143  * are supported by the device. */
00144 #define paMacCoreFailIfConversionRequired (0x02)
00145 
00146 /* These flags set the SR conversion quality, if required. The wierd ordering
00147  * allows Maximum Quality to be the default.*/
00148 #define paMacCoreConversionQualityMin    (0x0100)
00149 #define paMacCoreConversionQualityMedium (0x0200)
00150 #define paMacCoreConversionQualityLow    (0x0300)
00151 #define paMacCoreConversionQualityHigh   (0x0400)
00152 #define paMacCoreConversionQualityMax    (0x0000)
00153 
00154 /*
00155  * Here are some "preset" combinations of flags (above) to get to some
00156  * common configurations. THIS IS OVERKILL, but if more flags are added
00157  * it won't be.
00158  */
00159 
00160 /*This is the default setting: do as much sample rate conversion as possible
00161  * and as little mucking with the device as possible. */
00162 #define paMacCorePlayNice                    (0x00)
00163 /*This setting is tuned for pro audio apps. It allows SR conversion on input
00164   and output, but it tries to set the appropriate SR on the device.*/
00165 #define paMacCorePro                         (0x01)
00166 /*This is a setting to minimize CPU usage and still play nice.*/
00167 #define paMacCoreMinimizeCPUButPlayNice      (0x0100)
00168 /*This is a setting to minimize CPU usage, even if that means interrupting the device. */
00169 #define paMacCoreMinimizeCPU                 (0x0101)
00170 
00171 
00172 #ifdef __cplusplus
00173 }
00174 #endif /* __cplusplus */
00175 
00176 #endif /* PA_MAC_CORE_H */

Generated on Tue Aug 3 2010 05:17:29 for PortAudio by  doxygen 1.7.1