PortAudio 2.0
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 "portaudio.h"
00047 
00048 #include <AudioUnit/AudioUnit.h>
00049 //#include <AudioToolbox/AudioToolbox.h>
00050 
00051 #ifdef __cplusplus
00052 extern "C" {
00053 #endif
00054 
00055 
00056 /*
00057  * A pointer to a paMacCoreStreamInfo may be passed as
00058  * the hostApiSpecificStreamInfo in the PaStreamParameters struct
00059  * when opening a stream or querying the format. Use NULL, for the
00060  * defaults. Note that for duplex streams, flags for input and output
00061  * should be the same or behaviour is undefined.
00062  */
00063 typedef struct
00064 {
00065     unsigned long size;           
00066     PaHostApiTypeId hostApiType;  
00067     unsigned long version;        
00068     unsigned long flags;          /* flags to modify behaviour */
00069     SInt32 const * channelMap;    /* Channel map for HAL channel mapping , if not needed, use NULL;*/ 
00070     unsigned long channelMapSize; /* Channel map size for HAL channel mapping , if not needed, use 0;*/ 
00071 } PaMacCoreStreamInfo;
00072 
00073 /*
00074  * Functions
00075  */
00076 
00077 
00078 /* Use this function to initialize a paMacCoreStreamInfo struct
00079  * using the requested flags. Note that channel mapping is turned
00080  * off after a call to this function.
00081  * @param data The datastructure to initialize
00082  * @param flags The flags to initialize the datastructure with.
00083 */
00084 void PaMacCore_SetupStreamInfo( PaMacCoreStreamInfo *data, unsigned long flags );
00085 
00086 /* call this after pa_SetupMacCoreStreamInfo to use channel mapping as described in notes.txt.
00087  * @param data The stream info structure to assign a channel mapping to
00088  * @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.
00089  * @param channelMapSize The size of the channel map array.
00090  */
00091 void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const channelMap, unsigned long channelMapSize );
00092 
00093 /*
00094  * Retrieve the AudioDeviceID of the input device assigned to an open stream
00095  *
00096  * @param s The stream to query.
00097  *
00098  * @return A valid AudioDeviceID, or NULL if an error occurred.
00099  */
00100 AudioDeviceID PaMacCore_GetStreamInputDevice( PaStream* s );
00101  
00102 /*
00103  * Retrieve the AudioDeviceID of the output device assigned to an open stream
00104  *
00105  * @param s The stream to query.
00106  *
00107  * @return A valid AudioDeviceID, or NULL if an error occurred.
00108  */
00109 AudioDeviceID PaMacCore_GetStreamOutputDevice( PaStream* s );
00110 
00111 /*
00112  * Returns a statically allocated string with the device's name
00113  * for the given channel. NULL will be returned on failure.
00114  *
00115  * This function's implemenation is not complete!
00116  *
00117  * @param device The PortAudio device index.
00118  * @param channel The channel number who's name is requested.
00119  * @return a statically allocated string with the name of the device.
00120  *         Because this string is statically allocated, it must be
00121  *         coppied if it is to be saved and used by the user after
00122  *         another call to this function.
00123  *
00124  */
00125 const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input );
00126 
00127 /*
00128  * Flags
00129  */
00130 
00131 /*
00132  * The following flags alter the behaviour of PA on the mac platform.
00133  * they can be ORed together. These should work both for opening and
00134  * checking a device.
00135  */
00136 
00137 /* Allows PortAudio to change things like the device's frame size,
00138  * which allows for much lower latency, but might disrupt the device
00139  * if other programs are using it, even when you are just Querying
00140  * the device. */
00141 #define paMacCoreChangeDeviceParameters (0x01)
00142 
00143 /* In combination with the above flag,
00144  * causes the stream opening to fail, unless the exact sample rates
00145  * are supported by the device. */
00146 #define paMacCoreFailIfConversionRequired (0x02)
00147 
00148 /* These flags set the SR conversion quality, if required. The wierd ordering
00149  * allows Maximum Quality to be the default.*/
00150 #define paMacCoreConversionQualityMin    (0x0100)
00151 #define paMacCoreConversionQualityMedium (0x0200)
00152 #define paMacCoreConversionQualityLow    (0x0300)
00153 #define paMacCoreConversionQualityHigh   (0x0400)
00154 #define paMacCoreConversionQualityMax    (0x0000)
00155 
00156 /*
00157  * Here are some "preset" combinations of flags (above) to get to some
00158  * common configurations. THIS IS OVERKILL, but if more flags are added
00159  * it won't be.
00160  */
00161 
00162 /*This is the default setting: do as much sample rate conversion as possible
00163  * and as little mucking with the device as possible. */
00164 #define paMacCorePlayNice                    (0x00)
00165 /*This setting is tuned for pro audio apps. It allows SR conversion on input
00166   and output, but it tries to set the appropriate SR on the device.*/
00167 #define paMacCorePro                         (0x01)
00168 /*This is a setting to minimize CPU usage and still play nice.*/
00169 #define paMacCoreMinimizeCPUButPlayNice      (0x0100)
00170 /*This is a setting to minimize CPU usage, even if that means interrupting the device. */
00171 #define paMacCoreMinimizeCPU                 (0x0101)
00172 
00173 
00174 #ifdef __cplusplus
00175 }
00176 #endif /* __cplusplus */
00177 
00178 #endif /* PA_MAC_CORE_H */

Generated for PortAudio by  doxygen1.7.4