renamed PaAsio_GetAvailableLatencyValues to PaAsio_GetAvailableBufferSizes and included a backward compatibility #define. see ticket #111.

This commit is contained in:
rossb 2011-05-02 15:49:20 +00:00
commit 1938ce6628
2 changed files with 24 additions and 17 deletions

View file

@ -52,25 +52,32 @@ extern "C"
#endif /* __cplusplus */ #endif /* __cplusplus */
/** Retrieve legal latency settings for the specificed device, in samples. /** 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 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 minBufferSizeFrames A pointer to the location which will receive the minimum buffer size value.
@param maxLatency A pointer to the location which will recieve the maximum latency value. @param maxBufferSizeFrames A pointer to the location which will receive the maximum buffer size value.
@param preferredLatency A pointer to the location which will recieve the preferred latency 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 recieve the granularity. This value @param granularity A pointer to the location which will receive the "granularity". This value determines
determines which values between minLatency and maxLatency are available. ie the step size, the step size used to compute the legal values between minBufferSizeFrames and maxBufferSizeFrames.
if granularity is -1 then available latency settings are powers of two. If granularity is -1 then available buffer size values are powers of two.
@see ASIOGetBufferSize in the ASIO SDK. @see ASIOGetBufferSize in the ASIO SDK.
@todo This function should be renamed to PaAsio_GetAvailableBufferSizes. @note: this function used to be called PaAsio_GetAvailableLatencyValues. There is a
No reason to use a wildly different name from the ASIO version. #define that maps PaAsio_GetAvailableLatencyValues to this function for backwards compatibility.
*/ */
PaError PaAsio_GetAvailableLatencyValues( PaDeviceIndex device, PaError PaAsio_GetAvailableBufferSizes( PaDeviceIndex device,
long *minLatency, long *maxLatency, long *preferredLatency, long *granularity ); long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity );
/** Backwards compatibility alias for PaAsio_GetAvailableBufferSizes
@see PaAsio_GetAvailableBufferSizes
*/
#define PaAsio_GetAvailableLatencyValues PaAsio_GetAvailableBufferSizes
/** Display the ASIO control panel for the specified device. /** 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 device The global index of the device whose control panel is to be displayed.

View file

@ -906,8 +906,8 @@ typedef struct PaAsioDeviceInfo
PaAsioDeviceInfo; PaAsioDeviceInfo;
PaError PaAsio_GetAvailableLatencyValues( PaDeviceIndex device, PaError PaAsio_GetAvailableBufferSizes( PaDeviceIndex device,
long *minLatency, long *maxLatency, long *preferredLatency, long *granularity ) long *minBufferSizeFrames, long *maxBufferSizeFrames, long *preferredBufferSizeFrames, long *granularity )
{ {
PaError result; PaError result;
PaUtilHostApiRepresentation *hostApi; PaUtilHostApiRepresentation *hostApi;
@ -924,9 +924,9 @@ PaError PaAsio_GetAvailableLatencyValues( PaDeviceIndex device,
PaAsioDeviceInfo *asioDeviceInfo = PaAsioDeviceInfo *asioDeviceInfo =
(PaAsioDeviceInfo*)hostApi->deviceInfos[hostApiDevice]; (PaAsioDeviceInfo*)hostApi->deviceInfos[hostApiDevice];
*minLatency = asioDeviceInfo->minBufferSize; *minBufferSizeFrames = asioDeviceInfo->minBufferSize;
*maxLatency = asioDeviceInfo->maxBufferSize; *maxBufferSizeFrames = asioDeviceInfo->maxBufferSize;
*preferredLatency = asioDeviceInfo->preferredBufferSize; *preferredBufferSizeFrames = asioDeviceInfo->preferredBufferSize;
*granularity = asioDeviceInfo->bufferGranularity; *granularity = asioDeviceInfo->bufferGranularity;
} }
} }