|
|
@@ -1,7 +1,7 @@ |
|
|
|
#ifndef PA_ASIO_H |
|
|
|
#define PA_ASIO_H |
|
|
|
/* |
|
|
|
* $Id: pa_asio.h,v 1.1.2.2 2006/06/20 14:44:48 letz Exp $ |
|
|
|
* $Id: pa_asio.h 1667 2011-05-02 15:49:20Z rossb $ |
|
|
|
* PortAudio Portable Real-Time Audio Library |
|
|
|
* ASIO specific extensions |
|
|
|
* |
|
|
@@ -18,10 +18,6 @@ |
|
|
|
* The above copyright notice and this permission notice shall be |
|
|
|
* included in all copies or substantial portions of the Software. |
|
|
|
* |
|
|
|
* Any person wishing to distribute modifications to the Software is |
|
|
|
* requested to send the modifications to the original developer so that |
|
|
|
* they can be incorporated into the canonical version. |
|
|
|
* |
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
|
@@ -29,14 +25,25 @@ |
|
|
|
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF |
|
|
|
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
|
|
*/ |
|
|
|
|
|
|
|
/* |
|
|
|
* The text above constitutes the entire PortAudio license; however, |
|
|
|
* the PortAudio community also makes the following non-binding requests: |
|
|
|
* |
|
|
|
* Any person wishing to distribute modifications to the Software is |
|
|
|
* requested to send the modifications to the original developer so that |
|
|
|
* they can be incorporated into the canonical version. It is also |
|
|
|
* requested that these non-binding requests be included along with the |
|
|
|
* license above. |
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
|
|
/** @file |
|
|
|
@ingroup public_header |
|
|
|
@brief ASIO-specific PortAudio API extension header file. |
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
|
|
#include "portaudio.h" |
|
|
|
|
|
|
|
#ifdef __cplusplus |
|
|
@@ -45,75 +52,95 @@ extern "C" |
|
|
|
#endif /* __cplusplus */ |
|
|
|
|
|
|
|
|
|
|
|
/** Retrieve legal latency settings for the specificed device, in samples. |
|
|
|
|
|
|
|
@param device The global index of the device about which the query is being made. |
|
|
|
@param minLatency A pointer to the location which will recieve the minimum latency value. |
|
|
|
@param maxLatency A pointer to the location which will recieve the maximum latency value. |
|
|
|
@param preferredLatency A pointer to the location which will recieve the preferred latency value. |
|
|
|
@param granularity A pointer to the location which will recieve the granularity. This value |
|
|
|
determines which values between minLatency and maxLatency are available. ie the step size, |
|
|
|
if granularity is -1 then available latency settings are powers of two. |
|
|
|
|
|
|
|
@see ASIOGetBufferSize in the ASIO SDK. |
|
|
|
|
|
|
|
@todo This function should have a better name, any suggestions? |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetAvailableLatencyValues( PaDeviceIndex device, |
|
|
|
long *minLatency, long *maxLatency, long *preferredLatency, long *granularity ); |
|
|
|
/** Retrieve legal native buffer sizes for the specificed device, in sample frames. |
|
|
|
|
|
|
|
@param device The global index of the device about which the query is being made. |
|
|
|
@param minBufferSizeFrames A pointer to the location which will receive the minimum buffer size value. |
|
|
|
@param maxBufferSizeFrames A pointer to the location which will receive the maximum buffer size value. |
|
|
|
@param preferredBufferSizeFrames A pointer to the location which will receive the preferred buffer size value. |
|
|
|
@param granularity A pointer to the location which will receive the "granularity". This value determines |
|
|
|
the step size used to compute the legal values between minBufferSizeFrames and maxBufferSizeFrames. |
|
|
|
If granularity is -1 then available buffer size values are powers of two. |
|
|
|
|
|
|
|
/** Display the ASIO control panel for the specified device. |
|
|
|
|
|
|
|
@param device The global index of the device whose control panel is to be displayed. |
|
|
|
@param systemSpecific On Windows, the calling application's main window handle, |
|
|
|
on Macintosh this value should be zero. |
|
|
|
*/ |
|
|
|
PaError PaAsio_ShowControlPanel( PaDeviceIndex device, void* systemSpecific ); |
|
|
|
@see ASIOGetBufferSize in the ASIO SDK. |
|
|
|
|
|
|
|
@note: this function used to be called PaAsio_GetAvailableLatencyValues. There is a |
|
|
|
#define that maps PaAsio_GetAvailableLatencyValues to this function for backwards compatibility. |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetAvailableBufferSizes( PaDeviceIndex device, |
|
|
|
long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity ); |
|
|
|
|
|
|
|
|
|
|
|
/** Backwards compatibility alias for PaAsio_GetAvailableBufferSizes |
|
|
|
|
|
|
|
/** Retrieve a pointer to a string containing the name of the specified |
|
|
|
input channel. The string is valid until Pa_Terminate is called. |
|
|
|
|
|
|
|
The string will be no longer than 32 characters including the null terminator. |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetInputChannelName( PaDeviceIndex device, int channelIndex, |
|
|
|
const char** channelName ); |
|
|
|
@see PaAsio_GetAvailableBufferSizes |
|
|
|
*/ |
|
|
|
#define PaAsio_GetAvailableLatencyValues PaAsio_GetAvailableBufferSizes |
|
|
|
|
|
|
|
|
|
|
|
/** Retrieve a pointer to a string containing the name of the specified |
|
|
|
input channel. The string is valid until Pa_Terminate is called. |
|
|
|
|
|
|
|
The string will be no longer than 32 characters including the null terminator. |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetOutputChannelName( PaDeviceIndex device, int channelIndex, |
|
|
|
const char** channelName ); |
|
|
|
/** Display the ASIO control panel for the specified device. |
|
|
|
|
|
|
|
@param device The global index of the device whose control panel is to be displayed. |
|
|
|
@param systemSpecific On Windows, the calling application's main window handle, |
|
|
|
on Macintosh this value should be zero. |
|
|
|
*/ |
|
|
|
PaError PaAsio_ShowControlPanel( PaDeviceIndex device, void* systemSpecific ); |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** Retrieve a pointer to a string containing the name of the specified |
|
|
|
input channel. The string is valid until Pa_Terminate is called. |
|
|
|
|
|
|
|
The string will be no longer than 32 characters including the null terminator. |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetInputChannelName( PaDeviceIndex device, int channelIndex, |
|
|
|
const char** channelName ); |
|
|
|
|
|
|
|
|
|
|
|
/** Retrieve a pointer to a string containing the name of the specified |
|
|
|
input channel. The string is valid until Pa_Terminate is called. |
|
|
|
|
|
|
|
The string will be no longer than 32 characters including the null terminator. |
|
|
|
*/ |
|
|
|
PaError PaAsio_GetOutputChannelName( PaDeviceIndex device, int channelIndex, |
|
|
|
const char** channelName ); |
|
|
|
|
|
|
|
|
|
|
|
/** Set the sample rate of an open paASIO stream. |
|
|
|
|
|
|
|
@param stream The stream to operate on. |
|
|
|
@param sampleRate The new sample rate. |
|
|
|
|
|
|
|
Note that this function may fail if the stream is alredy running and the |
|
|
|
ASIO driver does not support switching the sample rate of a running stream. |
|
|
|
|
|
|
|
Returns paIncompatibleStreamHostApi if stream is not a paASIO stream. |
|
|
|
*/ |
|
|
|
PaError PaAsio_SetStreamSampleRate( PaStream* stream, double sampleRate ); |
|
|
|
|
|
|
|
|
|
|
|
#define paAsioUseChannelSelectors (0x01) |
|
|
|
|
|
|
|
typedef struct PaAsioStreamInfo { |
|
|
|
unsigned long size; /**< sizeof(PaAsioStreamInfo) */ |
|
|
|
PaHostApiTypeId hostApiType; /**< paASIO */ |
|
|
|
unsigned long version; /**< 1 */ |
|
|
|
|
|
|
|
unsigned long flags; |
|
|
|
|
|
|
|
/* Support for opening only specific channels of an ASIO device. |
|
|
|
If the paAsioUseChannelSelectors flag is set, channelSelectors is a |
|
|
|
pointer to an array of integers specifying the device channels to use. |
|
|
|
When used, the length of the channelSelectors array must match the |
|
|
|
corresponding channelCount parameter to Pa_OpenStream() otherwise a |
|
|
|
crash may result. |
|
|
|
The values in the selectors array must specify channels within the |
|
|
|
range of supported channels for the device or paInvalidChannelCount will |
|
|
|
result. |
|
|
|
*/ |
|
|
|
int *channelSelectors; |
|
|
|
} |
|
|
|
PaAsioStreamInfo; |
|
|
|
typedef struct PaAsioStreamInfo{ |
|
|
|
unsigned long size; /**< sizeof(PaAsioStreamInfo) */ |
|
|
|
PaHostApiTypeId hostApiType; /**< paASIO */ |
|
|
|
unsigned long version; /**< 1 */ |
|
|
|
|
|
|
|
unsigned long flags; |
|
|
|
|
|
|
|
/* Support for opening only specific channels of an ASIO device. |
|
|
|
If the paAsioUseChannelSelectors flag is set, channelSelectors is a |
|
|
|
pointer to an array of integers specifying the device channels to use. |
|
|
|
When used, the length of the channelSelectors array must match the |
|
|
|
corresponding channelCount parameter to Pa_OpenStream() otherwise a |
|
|
|
crash may result. |
|
|
|
The values in the selectors array must specify channels within the |
|
|
|
range of supported channels for the device or paInvalidChannelCount will |
|
|
|
result. |
|
|
|
*/ |
|
|
|
int *channelSelectors; |
|
|
|
}PaAsioStreamInfo; |
|
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus |
|
|
|