cannam@124: #ifndef PA_WIN_WASAPI_H cannam@124: #define PA_WIN_WASAPI_H cannam@124: /* cannam@124: * $Id: $ cannam@124: * PortAudio Portable Real-Time Audio Library cannam@124: * DirectSound specific extensions cannam@124: * cannam@124: * Copyright (c) 1999-2007 Ross Bencina and Phil Burk cannam@124: * cannam@124: * Permission is hereby granted, free of charge, to any person obtaining cannam@124: * a copy of this software and associated documentation files cannam@124: * (the "Software"), to deal in the Software without restriction, cannam@124: * including without limitation the rights to use, copy, modify, merge, cannam@124: * publish, distribute, sublicense, and/or sell copies of the Software, cannam@124: * and to permit persons to whom the Software is furnished to do so, cannam@124: * subject to the following conditions: cannam@124: * cannam@124: * The above copyright notice and this permission notice shall be cannam@124: * included in all copies or substantial portions of the Software. cannam@124: * cannam@124: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@124: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@124: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. cannam@124: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR cannam@124: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@124: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@124: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@124: */ cannam@124: cannam@124: /* cannam@124: * The text above constitutes the entire PortAudio license; however, cannam@124: * the PortAudio community also makes the following non-binding requests: cannam@124: * cannam@124: * Any person wishing to distribute modifications to the Software is cannam@124: * requested to send the modifications to the original developer so that cannam@124: * they can be incorporated into the canonical version. It is also cannam@124: * requested that these non-binding requests be included along with the cannam@124: * license above. cannam@124: */ cannam@124: cannam@124: /** @file cannam@124: @ingroup public_header cannam@124: @brief WASAPI-specific PortAudio API extension header file. cannam@124: */ cannam@124: cannam@124: #include "portaudio.h" cannam@124: #include "pa_win_waveformat.h" cannam@124: cannam@124: #ifdef __cplusplus cannam@124: extern "C" cannam@124: { cannam@124: #endif /* __cplusplus */ cannam@124: cannam@124: cannam@124: /* Setup flags */ cannam@124: typedef enum PaWasapiFlags cannam@124: { cannam@124: /* puts WASAPI into exclusive mode */ cannam@124: paWinWasapiExclusive = (1 << 0), cannam@124: cannam@124: /* allows to skip internal PA processing completely */ cannam@124: paWinWasapiRedirectHostProcessor = (1 << 1), cannam@124: cannam@124: /* assigns custom channel mask */ cannam@124: paWinWasapiUseChannelMask = (1 << 2), cannam@124: cannam@124: /* selects non-Event driven method of data read/write cannam@124: Note: WASAPI Event driven core is capable of 2ms latency!!!, but Polling cannam@124: method can only provide 15-20ms latency. */ cannam@124: paWinWasapiPolling = (1 << 3), cannam@124: cannam@124: /* forces custom thread priority setting. must be used if PaWasapiStreamInfo::threadPriority cannam@124: is set to custom value. */ cannam@124: paWinWasapiThreadPriority = (1 << 4) cannam@124: } cannam@124: PaWasapiFlags; cannam@124: #define paWinWasapiExclusive (paWinWasapiExclusive) cannam@124: #define paWinWasapiRedirectHostProcessor (paWinWasapiRedirectHostProcessor) cannam@124: #define paWinWasapiUseChannelMask (paWinWasapiUseChannelMask) cannam@124: #define paWinWasapiPolling (paWinWasapiPolling) cannam@124: #define paWinWasapiThreadPriority (paWinWasapiThreadPriority) cannam@124: cannam@124: cannam@124: /* Host processor. Allows to skip internal PA processing completely. cannam@124: You must set paWinWasapiRedirectHostProcessor flag to PaWasapiStreamInfo::flags member cannam@124: in order to have host processor redirected to your callback. cannam@124: Use with caution! inputFrames and outputFrames depend solely on final device setup. cannam@124: To query maximal values of inputFrames/outputFrames use PaWasapi_GetFramesPerHostBuffer. cannam@124: */ cannam@124: typedef void (*PaWasapiHostProcessorCallback) (void *inputBuffer, long inputFrames, cannam@124: void *outputBuffer, long outputFrames, cannam@124: void *userData); cannam@124: cannam@124: /* Device role */ cannam@124: typedef enum PaWasapiDeviceRole cannam@124: { cannam@124: eRoleRemoteNetworkDevice = 0, cannam@124: eRoleSpeakers, cannam@124: eRoleLineLevel, cannam@124: eRoleHeadphones, cannam@124: eRoleMicrophone, cannam@124: eRoleHeadset, cannam@124: eRoleHandset, cannam@124: eRoleUnknownDigitalPassthrough, cannam@124: eRoleSPDIF, cannam@124: eRoleHDMI, cannam@124: eRoleUnknownFormFactor cannam@124: } cannam@124: PaWasapiDeviceRole; cannam@124: cannam@124: cannam@124: /* Jack connection type */ cannam@124: typedef enum PaWasapiJackConnectionType cannam@124: { cannam@124: eJackConnTypeUnknown, cannam@124: eJackConnType3Point5mm, cannam@124: eJackConnTypeQuarter, cannam@124: eJackConnTypeAtapiInternal, cannam@124: eJackConnTypeRCA, cannam@124: eJackConnTypeOptical, cannam@124: eJackConnTypeOtherDigital, cannam@124: eJackConnTypeOtherAnalog, cannam@124: eJackConnTypeMultichannelAnalogDIN, cannam@124: eJackConnTypeXlrProfessional, cannam@124: eJackConnTypeRJ11Modem, cannam@124: eJackConnTypeCombination cannam@124: } cannam@124: PaWasapiJackConnectionType; cannam@124: cannam@124: cannam@124: /* Jack geometric location */ cannam@124: typedef enum PaWasapiJackGeoLocation cannam@124: { cannam@124: eJackGeoLocUnk = 0, cannam@124: eJackGeoLocRear = 0x1, /* matches EPcxGeoLocation::eGeoLocRear */ cannam@124: eJackGeoLocFront, cannam@124: eJackGeoLocLeft, cannam@124: eJackGeoLocRight, cannam@124: eJackGeoLocTop, cannam@124: eJackGeoLocBottom, cannam@124: eJackGeoLocRearPanel, cannam@124: eJackGeoLocRiser, cannam@124: eJackGeoLocInsideMobileLid, cannam@124: eJackGeoLocDrivebay, cannam@124: eJackGeoLocHDMI, cannam@124: eJackGeoLocOutsideMobileLid, cannam@124: eJackGeoLocATAPI, cannam@124: eJackGeoLocReserved5, cannam@124: eJackGeoLocReserved6, cannam@124: } cannam@124: PaWasapiJackGeoLocation; cannam@124: cannam@124: cannam@124: /* Jack general location */ cannam@124: typedef enum PaWasapiJackGenLocation cannam@124: { cannam@124: eJackGenLocPrimaryBox = 0, cannam@124: eJackGenLocInternal, cannam@124: eJackGenLocSeparate, cannam@124: eJackGenLocOther cannam@124: } cannam@124: PaWasapiJackGenLocation; cannam@124: cannam@124: cannam@124: /* Jack's type of port */ cannam@124: typedef enum PaWasapiJackPortConnection cannam@124: { cannam@124: eJackPortConnJack = 0, cannam@124: eJackPortConnIntegratedDevice, cannam@124: eJackPortConnBothIntegratedAndJack, cannam@124: eJackPortConnUnknown cannam@124: } cannam@124: PaWasapiJackPortConnection; cannam@124: cannam@124: cannam@124: /* Thread priority */ cannam@124: typedef enum PaWasapiThreadPriority cannam@124: { cannam@124: eThreadPriorityNone = 0, cannam@124: eThreadPriorityAudio, //!< Default for Shared mode. cannam@124: eThreadPriorityCapture, cannam@124: eThreadPriorityDistribution, cannam@124: eThreadPriorityGames, cannam@124: eThreadPriorityPlayback, cannam@124: eThreadPriorityProAudio, //!< Default for Exclusive mode. cannam@124: eThreadPriorityWindowManager cannam@124: } cannam@124: PaWasapiThreadPriority; cannam@124: cannam@124: cannam@124: /* Stream descriptor. */ cannam@124: typedef struct PaWasapiJackDescription cannam@124: { cannam@124: unsigned long channelMapping; cannam@124: unsigned long color; /* derived from macro: #define RGB(r,g,b) ((COLORREF)(((BYTE)(r)|((WORD)((BYTE)(g))<<8))|(((DWORD)(BYTE)(b))<<16))) */ cannam@124: PaWasapiJackConnectionType connectionType; cannam@124: PaWasapiJackGeoLocation geoLocation; cannam@124: PaWasapiJackGenLocation genLocation; cannam@124: PaWasapiJackPortConnection portConnection; cannam@124: unsigned int isConnected; cannam@124: } cannam@124: PaWasapiJackDescription; cannam@124: cannam@124: cannam@124: /* Stream descriptor. */ cannam@124: typedef struct PaWasapiStreamInfo cannam@124: { cannam@124: unsigned long size; /**< sizeof(PaWasapiStreamInfo) */ cannam@124: PaHostApiTypeId hostApiType; /**< paWASAPI */ cannam@124: unsigned long version; /**< 1 */ cannam@124: cannam@124: unsigned long flags; /**< collection of PaWasapiFlags */ cannam@124: cannam@124: /* Support for WAVEFORMATEXTENSIBLE channel masks. If flags contains cannam@124: paWinWasapiUseChannelMask this allows you to specify which speakers cannam@124: to address in a multichannel stream. Constants for channelMask cannam@124: are specified in pa_win_waveformat.h. Will be used only if cannam@124: paWinWasapiUseChannelMask flag is specified. cannam@124: */ cannam@124: PaWinWaveFormatChannelMask channelMask; cannam@124: cannam@124: /* Delivers raw data to callback obtained from GetBuffer() methods skipping cannam@124: internal PortAudio processing inventory completely. userData parameter will cannam@124: be the same that was passed to Pa_OpenStream method. Will be used only if cannam@124: paWinWasapiRedirectHostProcessor flag is specified. cannam@124: */ cannam@124: PaWasapiHostProcessorCallback hostProcessorOutput; cannam@124: PaWasapiHostProcessorCallback hostProcessorInput; cannam@124: cannam@124: /* Specifies thread priority explicitly. Will be used only if paWinWasapiThreadPriority flag cannam@124: is specified. cannam@124: cannam@124: Please note, if Input/Output streams are opened simultaniously (Full-Duplex mode) cannam@124: you shall specify same value for threadPriority or othervise one of the values will be used cannam@124: to setup thread priority. cannam@124: */ cannam@124: PaWasapiThreadPriority threadPriority; cannam@124: } cannam@124: PaWasapiStreamInfo; cannam@124: cannam@124: cannam@124: /** Returns default sound format for device. Format is represented by PaWinWaveFormat or cannam@124: WAVEFORMATEXTENSIBLE structure. cannam@124: cannam@124: @param pFormat Pointer to PaWinWaveFormat or WAVEFORMATEXTENSIBLE structure. cannam@124: @param nFormatSize Size of PaWinWaveFormat or WAVEFORMATEXTENSIBLE structure in bytes. cannam@124: @param nDevice Device index. cannam@124: cannam@124: @return Non-negative value indicating the number of bytes copied into format decriptor cannam@124: or, a PaErrorCode (which are always negative) if PortAudio is not initialized cannam@124: or an error is encountered. cannam@124: */ cannam@124: int PaWasapi_GetDeviceDefaultFormat( void *pFormat, unsigned int nFormatSize, PaDeviceIndex nDevice ); cannam@124: cannam@124: cannam@124: /** Returns device role (PaWasapiDeviceRole enum). cannam@124: cannam@124: @param nDevice device index. cannam@124: cannam@124: @return Non-negative value indicating device role or, a PaErrorCode (which are always negative) cannam@124: if PortAudio is not initialized or an error is encountered. cannam@124: */ cannam@124: int/*PaWasapiDeviceRole*/ PaWasapi_GetDeviceRole( PaDeviceIndex nDevice ); cannam@124: cannam@124: cannam@124: /** Boost thread priority of calling thread (MMCSS). Use it for Blocking Interface only for thread cannam@124: which makes calls to Pa_WriteStream/Pa_ReadStream. cannam@124: cannam@124: @param hTask Handle to pointer to priority task. Must be used with PaWasapi_RevertThreadPriority cannam@124: method to revert thread priority to initial state. cannam@124: cannam@124: @param nPriorityClass Id of thread priority of PaWasapiThreadPriority type. Specifying cannam@124: eThreadPriorityNone does nothing. cannam@124: cannam@124: @return Error code indicating success or failure. cannam@124: @see PaWasapi_RevertThreadPriority cannam@124: */ cannam@124: PaError PaWasapi_ThreadPriorityBoost( void **hTask, PaWasapiThreadPriority nPriorityClass ); cannam@124: cannam@124: cannam@124: /** Boost thread priority of calling thread (MMCSS). Use it for Blocking Interface only for thread cannam@124: which makes calls to Pa_WriteStream/Pa_ReadStream. cannam@124: cannam@124: @param hTask Task handle obtained by PaWasapi_BoostThreadPriority method. cannam@124: @return Error code indicating success or failure. cannam@124: @see PaWasapi_BoostThreadPriority cannam@124: */ cannam@124: PaError PaWasapi_ThreadPriorityRevert( void *hTask ); cannam@124: cannam@124: cannam@124: /** Get number of frames per host buffer. This is maximal value of frames of WASAPI buffer which cannam@124: can be locked for operations. Use this method as helper to findout maximal values of cannam@124: inputFrames/outputFrames of PaWasapiHostProcessorCallback. cannam@124: cannam@124: @param pStream Pointer to PaStream to query. cannam@124: @param nInput Pointer to variable to receive number of input frames. Can be NULL. cannam@124: @param nOutput Pointer to variable to receive number of output frames. Can be NULL. cannam@124: @return Error code indicating success or failure. cannam@124: @see PaWasapiHostProcessorCallback cannam@124: */ cannam@124: PaError PaWasapi_GetFramesPerHostBuffer( PaStream *pStream, unsigned int *nInput, unsigned int *nOutput ); cannam@124: cannam@124: cannam@124: /** Get number of jacks associated with a WASAPI device. Use this method to determine if cannam@124: there are any jacks associated with the provided WASAPI device. Not all audio devices cannam@124: will support this capability. This is valid for both input and output devices. cannam@124: @param nDevice device index. cannam@124: @param jcount Number of jacks is returned in this variable cannam@124: @return Error code indicating success or failure cannam@124: @see PaWasapi_GetJackDescription cannam@124: */ cannam@124: PaError PaWasapi_GetJackCount(PaDeviceIndex nDevice, int *jcount); cannam@124: cannam@124: cannam@124: /** Get the jack description associated with a WASAPI device and jack number cannam@124: Before this function is called, use PaWasapi_GetJackCount to determine the cannam@124: number of jacks associated with device. If jcount is greater than zero, then cannam@124: each jack from 0 to jcount can be queried with this function to get the jack cannam@124: description. cannam@124: @param nDevice device index. cannam@124: @param jindex Which jack to return information cannam@124: @param KSJACK_DESCRIPTION This structure filled in on success. cannam@124: @return Error code indicating success or failure cannam@124: @see PaWasapi_GetJackCount cannam@124: */ cannam@124: PaError PaWasapi_GetJackDescription(PaDeviceIndex nDevice, int jindex, PaWasapiJackDescription *pJackDescription); cannam@124: cannam@124: cannam@124: /* cannam@124: IMPORTANT: cannam@124: cannam@124: WASAPI is implemented for Callback and Blocking interfaces. It supports Shared and Exclusive cannam@124: share modes. cannam@124: cannam@124: Exclusive Mode: cannam@124: cannam@124: Exclusive mode allows to deliver audio data directly to hardware bypassing cannam@124: software mixing. cannam@124: Exclusive mode is specified by 'paWinWasapiExclusive' flag. cannam@124: cannam@124: Callback Interface: cannam@124: cannam@124: Provides best audio quality with low latency. Callback interface is implemented in cannam@124: two versions: cannam@124: cannam@124: 1) Event-Driven: cannam@124: This is the most powerful WASAPI implementation which provides glitch-free cannam@124: audio at around 3ms latency in Exclusive mode. Lowest possible latency for this mode is cannam@124: 3 ms for HD Audio class audio chips. For the Shared mode latency can not be cannam@124: lower than 20 ms. cannam@124: cannam@124: 2) Poll-Driven: cannam@124: Polling is another 2-nd method to operate with WASAPI. It is less efficient than Event-Driven cannam@124: and provides latency at around 10-13ms. Polling must be used to overcome a system bug cannam@124: under Windows Vista x64 when application is WOW64(32-bit) and Event-Driven method simply cannam@124: times out (event handle is never signalled on buffer completion). Please note, such WOW64 bug cannam@124: does not exist in Vista x86 or Windows 7. cannam@124: Polling can be setup by speciying 'paWinWasapiPolling' flag. Our WASAPI implementation detects cannam@124: WOW64 bug and sets 'paWinWasapiPolling' automatically. cannam@124: cannam@124: Thread priority: cannam@124: cannam@124: Normally thread priority is set automatically and does not require modification. Although cannam@124: if user wants some tweaking thread priority can be modified by setting 'paWinWasapiThreadPriority' cannam@124: flag and specifying 'PaWasapiStreamInfo::threadPriority' with value from PaWasapiThreadPriority cannam@124: enum. cannam@124: cannam@124: Blocking Interface: cannam@124: cannam@124: Blocking interface is implemented but due to above described Poll-Driven method can not cannam@124: deliver lowest possible latency. Specifying too low latency in Shared mode will result in cannam@124: distorted audio although Exclusive mode adds stability. cannam@124: cannam@124: Pa_IsFormatSupported: cannam@124: cannam@124: To check format with correct Share Mode (Exclusive/Shared) you must supply cannam@124: PaWasapiStreamInfo with flags paWinWasapiExclusive set through member of cannam@124: PaStreamParameters::hostApiSpecificStreamInfo structure. cannam@124: cannam@124: Pa_OpenStream: cannam@124: cannam@124: To set desired Share Mode (Exclusive/Shared) you must supply cannam@124: PaWasapiStreamInfo with flags paWinWasapiExclusive set through member of cannam@124: PaStreamParameters::hostApiSpecificStreamInfo structure. cannam@124: */ cannam@124: cannam@124: #ifdef __cplusplus cannam@124: } cannam@124: #endif /* __cplusplus */ cannam@124: cannam@124: #endif /* PA_WIN_WASAPI_H */