git.sesse.net Git - casparcg/blob - dependencies/portaudio/include/pa_mac_core.h

   1 #ifndef PA_MAC_CORE_H
   2 #define PA_MAC_CORE_H
   3 /*
   4  * PortAudio Portable Real-Time Audio Library
   5  * Macintosh Core Audio specific extensions
   6  * portaudio.h should be included before this file.
   7  *
   8  * Copyright (c) 2005-2006 Bjorn Roche
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining
  11  * a copy of this software and associated documentation files
  12  * (the "Software"), to deal in the Software without restriction,
  13  * including without limitation the rights to use, copy, modify, merge,
  14  * publish, distribute, sublicense, and/or sell copies of the Software,
  15  * and to permit persons to whom the Software is furnished to do so,
  16  * subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be
  19  * included in all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  24  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  25  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  26  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28  */
  29
  30 /*
  31  * The text above constitutes the entire PortAudio license; however,
  32  * the PortAudio community also makes the following non-binding requests:
  33  *
  34  * Any person wishing to distribute modifications to the Software is
  35  * requested to send the modifications to the original developer so that
  36  * they can be incorporated into the canonical version. It is also
  37  * requested that these non-binding requests be included along with the
  38  * license above.
  39  */
  40
  41 /** @file
  42  *  @ingroup public_header
  43  *  @brief CoreAudio-specific PortAudio API extension header file.
  44  */
  45
  46 #include "portaudio.h"
  47
  48 #include <AudioUnit/AudioUnit.h>
  49 //#include <AudioToolbox/AudioToolbox.h>
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55
  56 /**
  57  * A pointer to a paMacCoreStreamInfo may be passed as
  58  * the hostApiSpecificStreamInfo in the PaStreamParameters struct
  59  * when opening a stream or querying the format. Use NULL, for the
  60  * defaults. Note that for duplex streams, flags for input and output
  61  * should be the same or behaviour is undefined.
  62  */
  63 typedef struct
  64 {
  65     unsigned long size;           /**size of whole structure including this header */
  66     PaHostApiTypeId hostApiType;  /**host API for which this data is intended */
  67     unsigned long version;        /**structure version */
  68     unsigned long flags;          /** flags to modify behaviour */
  69     SInt32 const * channelMap;    /** Channel map for HAL channel mapping , if not needed, use NULL;*/
  70     unsigned long channelMapSize; /** Channel map size for HAL channel mapping , if not needed, use 0;*/
  71 } PaMacCoreStreamInfo;
  72
  73 /**
  74  * Functions
  75  */
  76
  77
  78 /** Use this function to initialize a paMacCoreStreamInfo struct
  79  * using the requested flags. Note that channel mapping is turned
  80  * off after a call to this function.
  81  * @param data The datastructure to initialize
  82  * @param flags The flags to initialize the datastructure with.
  83 */
  84 void PaMacCore_SetupStreamInfo( PaMacCoreStreamInfo *data, unsigned long flags );
  85
  86 /** call this after pa_SetupMacCoreStreamInfo to use channel mapping as described in notes.txt.
  87  * @param data The stream info structure to assign a channel mapping to
  88  * @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.
  89  * @param channelMapSize The size of the channel map array.
  90  */
  91 void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const channelMap, unsigned long channelMapSize );
  92
  93 /**
  94  * Retrieve the AudioDeviceID of the input device assigned to an open stream
  95  *
  96  * @param s The stream to query.
  97  *
  98  * @return A valid AudioDeviceID, or NULL if an error occurred.
  99  */
 100 AudioDeviceID PaMacCore_GetStreamInputDevice( PaStream* s );
 101
 102 /**
 103  * Retrieve the AudioDeviceID of the output device assigned to an open stream
 104  *
 105  * @param s The stream to query.
 106  *
 107  * @return A valid AudioDeviceID, or NULL if an error occurred.
 108  */
 109 AudioDeviceID PaMacCore_GetStreamOutputDevice( PaStream* s );
 110
 111 /**
 112  * Returns a statically allocated string with the device's name
 113  * for the given channel. NULL will be returned on failure.
 114  *
 115  * This function's implemenation is not complete!
 116  *
 117  * @param device The PortAudio device index.
 118  * @param channel The channel number who's name is requested.
 119  * @return a statically allocated string with the name of the device.
 120  *         Because this string is statically allocated, it must be
 121  *         coppied if it is to be saved and used by the user after
 122  *         another call to this function.
 123  *
 124  */
 125 const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input );
 126
 127 /**
 128  * Flags
 129  */
 130
 131 /**
 132  * The following flags alter the behaviour of PA on the mac platform.
 133  * they can be ORed together. These should work both for opening and
 134  * checking a device.
 135  */
 136
 137 /** Allows PortAudio to change things like the device's frame size,
 138  * which allows for much lower latency, but might disrupt the device
 139  * if other programs are using it, even when you are just Querying
 140  * the device. */
 141 #define paMacCoreChangeDeviceParameters (0x01)
 142
 143 /** In combination with the above flag,
 144  * causes the stream opening to fail, unless the exact sample rates
 145  * are supported by the device. */
 146 #define paMacCoreFailIfConversionRequired (0x02)
 147
 148 /** These flags set the SR conversion quality, if required. The wierd ordering
 149  * allows Maximum Quality to be the default.*/
 150 #define paMacCoreConversionQualityMin    (0x0100)
 151 #define paMacCoreConversionQualityMedium (0x0200)
 152 #define paMacCoreConversionQualityLow    (0x0300)
 153 #define paMacCoreConversionQualityHigh   (0x0400)
 154 #define paMacCoreConversionQualityMax    (0x0000)
 155
 156 /**
 157  * Here are some "preset" combinations of flags (above) to get to some
 158  * common configurations. THIS IS OVERKILL, but if more flags are added
 159  * it won't be.
 160  */
 161
 162 /**This is the default setting: do as much sample rate conversion as possible
 163  * and as little mucking with the device as possible. */
 164 #define paMacCorePlayNice                    (0x00)
 165 /**This setting is tuned for pro audio apps. It allows SR conversion on input
 166   and output, but it tries to set the appropriate SR on the device.*/
 167 #define paMacCorePro                         (0x01)
 168 /**This is a setting to minimize CPU usage and still play nice.*/
 169 #define paMacCoreMinimizeCPUButPlayNice      (0x0100)
 170 /**This is a setting to minimize CPU usage, even if that means interrupting the device. */
 171 #define paMacCoreMinimizeCPU                 (0x0101)
 172
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif /** __cplusplus */
 177
 178 #endif /** PA_MAC_CORE_H */