Mercurial > hg > sv-dependency-builds

annotate src/portaudio/include/pa_asio.h @ 101:62d01b0205cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add bzlib2 build
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 25 Mar 2013 12:21:28 +0000
parents 8a15ff55d9af
children
rev   line source
cannam@89 1 #ifndef PA_ASIO_H
cannam@89 2 #define PA_ASIO_H
cannam@89 3 /*
cannam@89 4 * $Id: pa_asio.h 1667 2011-05-02 15:49:20Z rossb $
cannam@89 5 * PortAudio Portable Real-Time Audio Library
cannam@89 6 * ASIO specific extensions
cannam@89 7 *
cannam@89 8 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@89 9 *
cannam@89 10 * Permission is hereby granted, free of charge, to any person obtaining
cannam@89 11 * a copy of this software and associated documentation files
cannam@89 12 * (the "Software"), to deal in the Software without restriction,
cannam@89 13 * including without limitation the rights to use, copy, modify, merge,
cannam@89 14 * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@89 15 * and to permit persons to whom the Software is furnished to do so,
cannam@89 16 * subject to the following conditions:
cannam@89 17 *
cannam@89 18 * The above copyright notice and this permission notice shall be
cannam@89 19 * included in all copies or substantial portions of the Software.
cannam@89 20 *
cannam@89 21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@89 22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@89 23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@89 24 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@89 25 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@89 26 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@89 27 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@89 28 */
cannam@89 29
cannam@89 30 /*
cannam@89 31 * The text above constitutes the entire PortAudio license; however,
cannam@89 32 * the PortAudio community also makes the following non-binding requests:
cannam@89 33 *
cannam@89 34 * Any person wishing to distribute modifications to the Software is
cannam@89 35 * requested to send the modifications to the original developer so that
cannam@89 36 * they can be incorporated into the canonical version. It is also
cannam@89 37 * requested that these non-binding requests be included along with the
cannam@89 38 * license above.
cannam@89 39 */
cannam@89 40
cannam@89 41
cannam@89 42 /** @file
cannam@89 43 @ingroup public_header
cannam@89 44 @brief ASIO-specific PortAudio API extension header file.
cannam@89 45 */
cannam@89 46
cannam@89 47 #include "portaudio.h"
cannam@89 48
cannam@89 49 #ifdef __cplusplus
cannam@89 50 extern "C"
cannam@89 51 {
cannam@89 52 #endif /* __cplusplus */
cannam@89 53
cannam@89 54
cannam@89 55 /** Retrieve legal native buffer sizes for the specificed device, in sample frames.
cannam@89 56
cannam@89 57 @param device The global index of the device about which the query is being made.
cannam@89 58 @param minBufferSizeFrames A pointer to the location which will receive the minimum buffer size value.
cannam@89 59 @param maxBufferSizeFrames A pointer to the location which will receive the maximum buffer size value.
cannam@89 60 @param preferredBufferSizeFrames A pointer to the location which will receive the preferred buffer size value.
cannam@89 61 @param granularity A pointer to the location which will receive the "granularity". This value determines
cannam@89 62 the step size used to compute the legal values between minBufferSizeFrames and maxBufferSizeFrames.
cannam@89 63 If granularity is -1 then available buffer size values are powers of two.
cannam@89 64
cannam@89 65 @see ASIOGetBufferSize in the ASIO SDK.
cannam@89 66
cannam@89 67 @note: this function used to be called PaAsio_GetAvailableLatencyValues. There is a
cannam@89 68 #define that maps PaAsio_GetAvailableLatencyValues to this function for backwards compatibility.
cannam@89 69 */
cannam@89 70 PaError PaAsio_GetAvailableBufferSizes( PaDeviceIndex device,
cannam@89 71 long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity );
cannam@89 72
cannam@89 73
cannam@89 74 /** Backwards compatibility alias for PaAsio_GetAvailableBufferSizes
cannam@89 75
cannam@89 76 @see PaAsio_GetAvailableBufferSizes
cannam@89 77 */
cannam@89 78 #define PaAsio_GetAvailableLatencyValues PaAsio_GetAvailableBufferSizes
cannam@89 79
cannam@89 80
cannam@89 81 /** Display the ASIO control panel for the specified device.
cannam@89 82
cannam@89 83 @param device The global index of the device whose control panel is to be displayed.
cannam@89 84 @param systemSpecific On Windows, the calling application's main window handle,
cannam@89 85 on Macintosh this value should be zero.
cannam@89 86 */
cannam@89 87 PaError PaAsio_ShowControlPanel( PaDeviceIndex device, void* systemSpecific );
cannam@89 88
cannam@89 89
cannam@89 90
cannam@89 91
cannam@89 92 /** Retrieve a pointer to a string containing the name of the specified
cannam@89 93 input channel. The string is valid until Pa_Terminate is called.
cannam@89 94
cannam@89 95 The string will be no longer than 32 characters including the null terminator.
cannam@89 96 */
cannam@89 97 PaError PaAsio_GetInputChannelName( PaDeviceIndex device, int channelIndex,
cannam@89 98 const char** channelName );
cannam@89 99
cannam@89 100
cannam@89 101 /** Retrieve a pointer to a string containing the name of the specified
cannam@89 102 input channel. The string is valid until Pa_Terminate is called.
cannam@89 103
cannam@89 104 The string will be no longer than 32 characters including the null terminator.
cannam@89 105 */
cannam@89 106 PaError PaAsio_GetOutputChannelName( PaDeviceIndex device, int channelIndex,
cannam@89 107 const char** channelName );
cannam@89 108
cannam@89 109
cannam@89 110 /** Set the sample rate of an open paASIO stream.
cannam@89 111
cannam@89 112 @param stream The stream to operate on.
cannam@89 113 @param sampleRate The new sample rate.
cannam@89 114
cannam@89 115 Note that this function may fail if the stream is alredy running and the
cannam@89 116 ASIO driver does not support switching the sample rate of a running stream.
cannam@89 117
cannam@89 118 Returns paIncompatibleStreamHostApi if stream is not a paASIO stream.
cannam@89 119 */
cannam@89 120 PaError PaAsio_SetStreamSampleRate( PaStream* stream, double sampleRate );
cannam@89 121
cannam@89 122
cannam@89 123 #define paAsioUseChannelSelectors (0x01)
cannam@89 124
cannam@89 125 typedef struct PaAsioStreamInfo{
cannam@89 126 unsigned long size; /**< sizeof(PaAsioStreamInfo) */
cannam@89 127 PaHostApiTypeId hostApiType; /**< paASIO */
cannam@89 128 unsigned long version; /**< 1 */
cannam@89 129
cannam@89 130 unsigned long flags;
cannam@89 131
cannam@89 132 /* Support for opening only specific channels of an ASIO device.
cannam@89 133 If the paAsioUseChannelSelectors flag is set, channelSelectors is a
cannam@89 134 pointer to an array of integers specifying the device channels to use.
cannam@89 135 When used, the length of the channelSelectors array must match the
cannam@89 136 corresponding channelCount parameter to Pa_OpenStream() otherwise a
cannam@89 137 crash may result.
cannam@89 138 The values in the selectors array must specify channels within the
cannam@89 139 range of supported channels for the device or paInvalidChannelCount will
cannam@89 140 result.
cannam@89 141 */
cannam@89 142 int *channelSelectors;
cannam@89 143 }PaAsioStreamInfo;
cannam@89 144
cannam@89 145
cannam@89 146 #ifdef __cplusplus
cannam@89 147 }
cannam@89 148 #endif /* __cplusplus */
cannam@89 149
cannam@89 150 #endif /* PA_ASIO_H */