comparison win64-msvc/include/pa_win_wasapi.h @ 145:13a516fa8999

Update PortAudio build for Win64

     /* selects non-Event driven method of data read/write
        Note: WASAPI Event driven core is capable of 2ms latency!!!, but Polling
              method can only provide 15-20ms latency. */
     paWinWasapiPolling                  = (1 << 3),
 
-    /* forces custom thread priority setting. must be used if PaWasapiStreamInfo::threadPriority 
-       is set to custom value. */
+    /* forces custom thread priority setting, must be used if PaWasapiStreamInfo::threadPriority 
+       is set to a custom value */
     paWinWasapiThreadPriority           = (1 << 4)
 }
 PaWasapiFlags;
 #define paWinWasapiExclusive             (paWinWasapiExclusive)
 #define paWinWasapiRedirectHostProcessor (paWinWasapiRedirectHostProcessor)

 */
 typedef void (*PaWasapiHostProcessorCallback) (void *inputBuffer,  long inputFrames,
                                                void *outputBuffer, long outputFrames,
                                                void *userData);
 
-/* Device role */
+/* Device role. */
 typedef enum PaWasapiDeviceRole
 {
     eRoleRemoteNetworkDevice = 0,
     eRoleSpeakers,
     eRoleLineLevel,

     eRoleUnknownFormFactor
 }
 PaWasapiDeviceRole;
 
 
-/* Jack connection type */
+/* Jack connection type. */
 typedef enum PaWasapiJackConnectionType
 {
     eJackConnTypeUnknown,
     eJackConnType3Point5mm,
     eJackConnTypeQuarter,

     eJackConnTypeCombination
 } 
 PaWasapiJackConnectionType;
 
 
-/* Jack geometric location */
+/* Jack geometric location. */
 typedef enum PaWasapiJackGeoLocation
 {
-	eJackGeoLocUnk = 0,
+    eJackGeoLocUnk = 0,
     eJackGeoLocRear = 0x1, /* matches EPcxGeoLocation::eGeoLocRear */
     eJackGeoLocFront,
     eJackGeoLocLeft,
     eJackGeoLocRight,
     eJackGeoLocTop,

     eJackGeoLocReserved6,
 } 
 PaWasapiJackGeoLocation;
 
 
-/* Jack general location */
+/* Jack general location. */
 typedef enum PaWasapiJackGenLocation
 {
     eJackGenLocPrimaryBox = 0,
     eJackGenLocInternal,
     eJackGenLocSeparate,
     eJackGenLocOther
 } 
 PaWasapiJackGenLocation;
 
 
-/* Jack's type of port */
+/* Jack's type of port. */
 typedef enum PaWasapiJackPortConnection
 {
     eJackPortConnJack = 0,
     eJackPortConnIntegratedDevice,
     eJackPortConnBothIntegratedAndJack,
     eJackPortConnUnknown
 } 
 PaWasapiJackPortConnection;
 
 
-/* Thread priority */
+/* Thread priority. */
 typedef enum PaWasapiThreadPriority
 {
     eThreadPriorityNone = 0,
     eThreadPriorityAudio,            //!< Default for Shared mode.
     eThreadPriorityCapture,

     unsigned int               isConnected;
 }
 PaWasapiJackDescription;
 
 
+/** Stream category.
+   Note:
+    - values are equal to WASAPI AUDIO_STREAM_CATEGORY enum
+    - supported since Windows 8.0, noop on earler versions
+    - values 1,2 are deprecated on Windows 10 and not included into enumeration
+
+ @version Available as of 19.6.0
+*/
+typedef enum PaWasapiStreamCategory
+{
+    eAudioCategoryOther           = 0,
+    eAudioCategoryCommunications  = 3,
+    eAudioCategoryAlerts          = 4,
+    eAudioCategorySoundEffects    = 5,
+    eAudioCategoryGameEffects     = 6,
+    eAudioCategoryGameMedia       = 7,
+    eAudioCategoryGameChat        = 8,
+    eAudioCategorySpeech          = 9,
+    eAudioCategoryMovie           = 10,
+    eAudioCategoryMedia           = 11
+}
+PaWasapiStreamCategory;
+
+
+/** Stream option.
+   Note:
+    - values are equal to WASAPI AUDCLNT_STREAMOPTIONS enum
+    - supported since Windows 8.1, noop on earler versions
+
+ @version Available as of 19.6.0
+*/
+typedef enum PaWasapiStreamOption
+{
+    eStreamOptionNone        = 0, //!< default
+    eStreamOptionRaw         = 1, //!< bypass WASAPI Audio Engine DSP effects, supported since Windows 8.1
+    eStreamOptionMatchFormat = 2  //!< force WASAPI Audio Engine into a stream format, supported since Windows 10
+}
+PaWasapiStreamOption;
+
+
 /* Stream descriptor. */
 typedef struct PaWasapiStreamInfo 
 {
     unsigned long size;             /**< sizeof(PaWasapiStreamInfo) */
     PaHostApiTypeId hostApiType;    /**< paWASAPI */
     unsigned long version;          /**< 1 */
 
     unsigned long flags;            /**< collection of PaWasapiFlags */
 
-    /* Support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
+    /** Support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
        paWinWasapiUseChannelMask this allows you to specify which speakers 
        to address in a multichannel stream. Constants for channelMask
        are specified in pa_win_waveformat.h. Will be used only if 
        paWinWasapiUseChannelMask flag is specified.
     */
     PaWinWaveFormatChannelMask channelMask;
 
-    /* Delivers raw data to callback obtained from GetBuffer() methods skipping 
+    /** Delivers raw data to callback obtained from GetBuffer() methods skipping
        internal PortAudio processing inventory completely. userData parameter will 
        be the same that was passed to Pa_OpenStream method. Will be used only if 
        paWinWasapiRedirectHostProcessor flag is specified.
     */
     PaWasapiHostProcessorCallback hostProcessorOutput;
     PaWasapiHostProcessorCallback hostProcessorInput;
 
-    /* Specifies thread priority explicitly. Will be used only if paWinWasapiThreadPriority flag
+    /** Specifies thread priority explicitly. Will be used only if paWinWasapiThreadPriority flag
        is specified.
 
        Please note, if Input/Output streams are opened simultaniously (Full-Duplex mode)
        you shall specify same value for threadPriority or othervise one of the values will be used
        to setup thread priority.
     */
     PaWasapiThreadPriority threadPriority;
+
+    /** Stream category.
+     @see PaWasapiStreamCategory
+     @version Available as of 19.6.0
+    */
+    PaWasapiStreamCategory streamCategory;
+
+    /** Stream option.
+     @see PaWasapiStreamOption
+     @version Available as of 19.6.0
+    */
+    PaWasapiStreamOption streamOption;
 } 
 PaWasapiStreamInfo;
 
 
 /** Returns default sound format for device. Format is represented by PaWinWaveFormat or 

 PaError PaWasapi_GetFramesPerHostBuffer( PaStream *pStream, unsigned int *nInput, unsigned int *nOutput );
 
 
 /** Get number of jacks associated with a WASAPI device.  Use this method to determine if
     there are any jacks associated with the provided WASAPI device.  Not all audio devices
-	will support this capability.  This is valid for both input and output devices.
+    will support this capability.  This is valid for both input and output devices.
  @param  nDevice  device index.
  @param  jcount   Number of jacks is returned in this variable
  @return Error code indicating success or failure
  @see PaWasapi_GetJackDescription
  */
 PaError PaWasapi_GetJackCount(PaDeviceIndex nDevice, int *jcount);
 
 
 /** Get the jack description associated with a WASAPI device and jack number
     Before this function is called, use PaWasapi_GetJackCount to determine the
-	number of jacks associated with device.  If jcount is greater than zero, then
-	each jack from 0 to jcount can be queried with this function to get the jack
-	description.
+    number of jacks associated with device.  If jcount is greater than zero, then
+    each jack from 0 to jcount can be queried with this function to get the jack
+    description.
  @param  nDevice  device index.
  @param  jindex   Which jack to return information
  @param  KSJACK_DESCRIPTION This structure filled in on success.
  @return Error code indicating success or failure
  @see PaWasapi_GetJackCount

 
         1) Event-Driven:
         This is the most powerful WASAPI implementation which provides glitch-free
         audio at around 3ms latency in Exclusive mode. Lowest possible latency for this mode is 
         3 ms for HD Audio class audio chips. For the Shared mode latency can not be 
-		lower than 20 ms.
+        lower than 20 ms.
 
         2) Poll-Driven:
         Polling is another 2-nd method to operate with WASAPI. It is less efficient than Event-Driven
         and provides latency at around 10-13ms. Polling must be used to overcome a system bug
         under Windows Vista x64 when application is WOW64(32-bit) and Event-Driven method simply