SV platform dependency builds

/*

* $Id$

* PortAudio Windows WDM-KS interface

*

* Author: Andrew Baldwin, Robert Bielik (WaveRT)

* Based on the Open Source API proposed by Ross Bencina

* Copyright (c) 1999-2004 Andrew Baldwin, Ross Bencina, Phil Burk

*

* Permission is hereby granted, free of charge, to any person obtaining

* a copy of this software and associated documentation files

* (the "Software"), to deal in the Software without restriction,

* including without limitation the rights to use, copy, modify, merge,

* publish, distribute, sublicense, and/or sell copies of the Software,

* and to permit persons to whom the Software is furnished to do so,

* subject to the following conditions:

*

* The above copyright notice and this permission notice shall be

* included in all copies or substantial portions of the Software.

*

* 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.

* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR

* 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 hostapi_src

@brief Portaudio WDM-KS host API.

@note This is the implementation of the Portaudio host API using the

Windows WDM/Kernel Streaming API in order to enable very low latency

playback and recording on all modern Windows platforms (e.g. 2K, XP, Vista, Win7)

Note: This API accesses the device drivers below the usual KMIXER

component which is normally used to enable multi-client mixing and

format conversion. That means that it will lock out all other users

of a device for the duration of active stream using those devices

*/

#include <stdio.h>

#if (defined(_WIN32) && (defined(_MSC_VER) && (_MSC_VER >= 1200))) /* MSC version 6 and above */

#pragma comment( lib, "setupapi.lib" )

#endif

/* Debugging/tracing support */

#define PA_LOGE_

#define PA_LOGL_

#ifdef __GNUC__

#include <initguid.h>

#define _WIN32_WINNT 0x0501

#define WINVER 0x0501

#endif

#include <string.h> /* strlen() */

#include <assert.h>

#include <wchar.h>  /* iswspace() */

#include "pa_util.h"

#include "pa_allocation.h"

#include "pa_hostapi.h"

#include "pa_stream.h"

#include "pa_cpuload.h"

#include "pa_process.h"

#include "portaudio.h"

#include "pa_debugprint.h"

#include "pa_memorybarrier.h"

#include "pa_ringbuffer.h"

#include "pa_trace.h"

#include "pa_win_waveformat.h"

#include "pa_win_wdmks.h"

#ifndef DRV_QUERYDEVICEINTERFACE

#define DRV_QUERYDEVICEINTERFACE     (DRV_RESERVED + 12)

#endif

#ifndef DRV_QUERYDEVICEINTERFACESIZE

#define DRV_QUERYDEVICEINTERFACESIZE (DRV_RESERVED + 13)

#endif

#include <windows.h>

#ifndef __GNUC__ /* Fix for ticket #257: MinGW-w64: Inclusion of <winioctl.h> triggers multiple redefinition errors. */

#include <winioctl.h>

#endif

#include <process.h>

#include <math.h>

#ifdef _MSC_VER

#define snprintf _snprintf

#define vsnprintf _vsnprintf

#endif

/* The PA_HP_TRACE macro is used in RT parts, so it can be switched off without affecting

the rest of the debug tracing */

#if 1

#define PA_HP_TRACE(x)  PaUtil_AddHighSpeedLogMessage x ;

#else

#define PA_HP_TRACE(x)

#endif

/* A define that selects whether the resulting pin names are chosen from pin category

instead of the available pin names, who sometimes can be quite cheesy, like "Volume control".

Default is to use the pin category.

*/

#ifndef PA_WDMKS_USE_CATEGORY_FOR_PIN_NAMES

#define PA_WDMKS_USE_CATEGORY_FOR_PIN_NAMES  1

#endif

#ifdef __GNUC__

#undef PA_LOGE_

#define PA_LOGE_ PA_DEBUG(("%s {\n",__FUNCTION__))

#undef PA_LOGL_

#define PA_LOGL_ PA_DEBUG(("} %s\n",__FUNCTION__))

/* These defines are set in order to allow the WIndows DirectX

* headers to compile with a GCC compiler such as MinGW

* NOTE: The headers may generate a few warning in GCC, but

* they should compile */

#define _INC_MMSYSTEM

#define _INC_MMREG

#define _NTRTL_ /* Turn off default definition of DEFINE_GUIDEX */

#define DEFINE_GUID_THUNK(name,guid) DEFINE_GUID(name,guid)

#define DEFINE_GUIDEX(n) DEFINE_GUID_THUNK( n, STATIC_##n )

#if !defined( DEFINE_WAVEFORMATEX_GUID )

#define DEFINE_WAVEFORMATEX_GUID(x) (USHORT)(x), 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71

#endif

#define  WAVE_FORMAT_ADPCM      0x0002

#define  WAVE_FORMAT_IEEE_FLOAT 0x0003

#define  WAVE_FORMAT_ALAW       0x0006

#define  WAVE_FORMAT_MULAW      0x0007

#define  WAVE_FORMAT_MPEG       0x0050

#define  WAVE_FORMAT_DRM        0x0009

#define DYNAMIC_GUID_THUNK(l,w1,w2,b1,b2,b3,b4,b5,b6,b7,b8) {l,w1,w2,{b1,b2,b3,b4,b5,b6,b7,b8}}

#define DYNAMIC_GUID(data) DYNAMIC_GUID_THUNK(data)

#endif

/* use CreateThread for CYGWIN/Windows Mobile, _beginthreadex for all others */

#if !defined(__CYGWIN__) && !defined(_WIN32_WCE)

#define CREATE_THREAD_FUNCTION (HANDLE)_beginthreadex

#define PA_THREAD_FUNC static unsigned WINAPI

#else

#define CREATE_THREAD_FUNCTION CreateThread

#define PA_THREAD_FUNC static DWORD WINAPI

#endif

#ifdef _MSC_VER

#define NOMMIDS

#define DYNAMIC_GUID(data) {data}

#define _NTRTL_ /* Turn off default definition of DEFINE_GUIDEX */

#undef DEFINE_GUID

#define DEFINE_GUID(n,data) EXTERN_C const GUID n = {data}

#define DEFINE_GUID_THUNK(n,data) DEFINE_GUID(n,data)

#define DEFINE_GUIDEX(n) DEFINE_GUID_THUNK(n, STATIC_##n)

#endif

#include <setupapi.h>

#ifndef EXTERN_C

#define EXTERN_C extern

#endif

#if defined(__GNUC__)

/* For MinGW we reference mingw-include files supplied with WASAPI */

#define WINBOOL BOOL

#include "../wasapi/mingw-include/ks.h"

#include "../wasapi/mingw-include/ksmedia.h"

#else

#include <mmreg.h>

#include <ks.h>

/* Note that Windows SDK V6.0A or later is needed for WaveRT specific structs to be present in

   ksmedia.h. Also make sure that the SDK include path is before other include paths (that may contain

   an "old" ksmedia.h), so the proper ksmedia.h is used */

#include <ksmedia.h>

#endif

#include <assert.h>

#include <stdio.h>

/* These next definitions allow the use of the KSUSER DLL */

typedef /*KSDDKAPI*/ DWORD WINAPI KSCREATEPIN(HANDLE, PKSPIN_CONNECT, ACCESS_MASK, PHANDLE);

extern HMODULE      DllKsUser;

extern KSCREATEPIN* FunctionKsCreatePin;

/* These definitions allows the use of AVRT.DLL on Vista and later OSs */

typedef enum _PA_AVRT_PRIORITY

{

    PA_AVRT_PRIORITY_LOW = -1,

    PA_AVRT_PRIORITY_NORMAL,

    PA_AVRT_PRIORITY_HIGH,

    PA_AVRT_PRIORITY_CRITICAL

} PA_AVRT_PRIORITY, *PPA_AVRT_PRIORITY;

typedef struct

{

    HINSTANCE hInstance;

    HANDLE  (WINAPI *AvSetMmThreadCharacteristics) (LPCSTR, LPDWORD);

    BOOL    (WINAPI *AvRevertMmThreadCharacteristics) (HANDLE);

    BOOL    (WINAPI *AvSetMmThreadPriority) (HANDLE, PA_AVRT_PRIORITY);

} PaWinWDMKSAvRtEntryPoints;

static PaWinWDMKSAvRtEntryPoints paWinWDMKSAvRtEntryPoints = {0};

/* An unspecified channel count (-1) is not treated correctly, so we replace it with

* an arbitrarily large number */ 

#define MAXIMUM_NUMBER_OF_CHANNELS 256

/* Forward definition to break circular type reference between pin and filter */

struct __PaWinWdmFilter;

typedef struct __PaWinWdmFilter PaWinWdmFilter;

struct __PaWinWdmPin;

typedef struct __PaWinWdmPin PaWinWdmPin;

struct __PaWinWdmStream;

typedef struct __PaWinWdmStream PaWinWdmStream;

/* Function prototype for getting audio position */

typedef PaError (*FunctionGetPinAudioPosition)(PaWinWdmPin*, unsigned long*);

/* Function prototype for memory barrier */

typedef void (*FunctionMemoryBarrier)(void);

struct __PaProcessThreadInfo;

typedef struct __PaProcessThreadInfo PaProcessThreadInfo;

typedef PaError (*FunctionPinHandler)(PaProcessThreadInfo* pInfo, unsigned eventIndex);

typedef enum __PaStreamStartEnum

{

    StreamStart_kOk,

    StreamStart_kFailed,

    StreamStart_kCnt

} PaStreamStartEnum;

/* Multiplexed input structure.

*  Very often several physical inputs are multiplexed through a MUX node (represented in the topology filter) */

typedef struct __PaWinWdmMuxedInput

{

    wchar_t                     friendlyName[MAX_PATH];

    ULONG                       muxPinId;

    ULONG                       muxNodeId;

    ULONG                       endpointPinId;

} PaWinWdmMuxedInput;

/* The Pin structure

* A pin is an input or output node, e.g. for audio flow */

struct __PaWinWdmPin

{

    HANDLE                      handle;

    PaWinWdmMuxedInput**        inputs;

    unsigned                    inputCount;

    wchar_t                     friendlyName[MAX_PATH];

    PaWinWdmFilter*             parentFilter;

    PaWDMKSSubType              pinKsSubType;

    unsigned long               pinId;

    unsigned long               endpointPinId;  /* For output pins */

    KSPIN_CONNECT*              pinConnect;

    unsigned long               pinConnectSize;

    KSDATAFORMAT_WAVEFORMATEX*  ksDataFormatWfx;

    KSPIN_COMMUNICATION         communication;

    KSDATARANGE*                dataRanges;

    KSMULTIPLE_ITEM*            dataRangesItem;

    KSPIN_DATAFLOW              dataFlow;

    KSPIN_CINSTANCES            instances;

    unsigned long               frameSize;

    int                         maxChannels;

    unsigned long               formats;

    int                         defaultSampleRate;

    ULONG                       *positionRegister;  /* WaveRT */

    ULONG                       hwLatency;          /* WaveRT */

    FunctionMemoryBarrier       fnMemBarrier;       /* WaveRT */

    FunctionGetPinAudioPosition fnAudioPosition;    /* WaveRT */

    FunctionPinHandler          fnEventHandler;

    FunctionPinHandler          fnSubmitHandler;

};

/* The Filter structure

* A filter has a number of pins and a "friendly name" */

struct __PaWinWdmFilter

{

    HANDLE         handle;

    PaWinWDMKSDeviceInfo    devInfo;  /* This will hold information that is exposed in PaDeviceInfo */

    DWORD            deviceNode;

    int            pinCount;

    PaWinWdmPin**  pins;

    PaWinWdmFilter*  topologyFilter;

    wchar_t          friendlyName[MAX_PATH];

    int              validPinCount;

    int            usageCount;

    KSMULTIPLE_ITEM* connections;

    KSMULTIPLE_ITEM* nodes;

    int              filterRefCount;

};

typedef struct __PaWinWdmDeviceInfo

{

    PaDeviceInfo    inheritedDeviceInfo;

    char            compositeName[MAX_PATH];   /* Composite name consists of pin name + device name in utf8 */

    PaWinWdmFilter* filter;

    unsigned long   pin;

    int             muxPosition;    /* Used only for input devices */

    int             endpointPinId;

}

PaWinWdmDeviceInfo;

/* PaWinWdmHostApiRepresentation - host api datastructure specific to this implementation */

typedef struct __PaWinWdmHostApiRepresentation

{

    PaUtilHostApiRepresentation  inheritedHostApiRep;

    PaUtilStreamInterface        callbackStreamInterface;

    PaUtilStreamInterface        blockingStreamInterface;

    PaUtilAllocationGroup*       allocations;

    int                          deviceCount;

}

PaWinWdmHostApiRepresentation;

typedef struct __DATAPACKET

{

    KSSTREAM_HEADER  Header;

    OVERLAPPED       Signal;

} DATAPACKET;

typedef struct __PaIOPacket

{

    DATAPACKET*     packet;

    unsigned        startByte;

    unsigned        lengthBytes;

} PaIOPacket;

typedef struct __PaWinWdmIOInfo

{

    PaWinWdmPin*        pPin;

    char*               hostBuffer;

    unsigned            hostBufferSize;

    unsigned            framesPerBuffer;

    unsigned            bytesPerFrame;

    unsigned            bytesPerSample;

    unsigned            noOfPackets;    /* Only used in WaveCyclic */

    HANDLE              *events;        /* noOfPackets handles (WaveCyclic) 1 (WaveRT) */

    DATAPACKET          *packets;       /* noOfPackets packets (WaveCyclic) 2 (WaveRT) */

    /* WaveRT polled mode */

    unsigned            lastPosition; 

    unsigned            pollCntr;

} PaWinWdmIOInfo;

/* PaWinWdmStream - a stream data structure specifically for this implementation */

struct __PaWinWdmStream

{

    PaUtilStreamRepresentation  streamRepresentation;

    PaWDMKSSpecificStreamInfo   hostApiStreamInfo;    /* This holds info that is exposed through PaStreamInfo */

    PaUtilCpuLoadMeasurer       cpuLoadMeasurer;

    PaUtilBufferProcessor       bufferProcessor;

#if PA_TRACE_REALTIME_EVENTS

    LogHandle                   hLog;

#endif

    PaUtilAllocationGroup*      allocGroup;

    PaWinWdmIOInfo              capture;

    PaWinWdmIOInfo              render;

    int                         streamStarted;

    int                         streamActive;

    int                         streamStop;

    int                         streamAbort;

    int                         oldProcessPriority;

    HANDLE                      streamThread;

    HANDLE                      eventAbort;

    HANDLE                      eventStreamStart[StreamStart_kCnt];        /* 0 = OK, 1 = Failed */

    PaError                     threadResult;

    PaStreamFlags               streamFlags;

    /* Capture ring buffer */

    PaUtilRingBuffer            ringBuffer;

    char*                       ringBufferData;

    /* These values handle the case where the user wants to use fewer

    * channels than the device has */

    int                         userInputChannels;

    int                         deviceInputChannels;

    int                         userOutputChannels;

    int                         deviceOutputChannels;

};

/* Gather all processing variables in a struct */

struct __PaProcessThreadInfo 

{

    PaWinWdmStream              *stream;

    PaStreamCallbackTimeInfo    ti;

    PaStreamCallbackFlags       underover;

    int                         cbResult;

    volatile int                pending;

    volatile int                priming;

    volatile int                pinsStarted;

    unsigned long               timeout;

    unsigned                    captureHead;

    unsigned                    captureTail;

    unsigned                    renderHead;

    unsigned                    renderTail;

    PaIOPacket                  capturePackets[4];

    PaIOPacket                  renderPackets[4];

};

/* Used for transferring device infos during scanning / rescanning */

typedef struct __PaWinWDMScanDeviceInfosResults

{ 

    PaDeviceInfo **deviceInfos;

    PaDeviceIndex defaultInputDevice;

    PaDeviceIndex defaultOutputDevice;

} PaWinWDMScanDeviceInfosResults;

static const unsigned cPacketsArrayMask = 3;

HMODULE      DllKsUser = NULL;

KSCREATEPIN* FunctionKsCreatePin = NULL;

/* prototypes for functions declared in this file */

#ifdef __cplusplus

extern "C"

{

#endif /* __cplusplus */

    PaError PaWinWdm_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );

#ifdef __cplusplus

}

#endif /* __cplusplus */

/* Low level I/O functions */

static PaError WdmSyncIoctl(HANDLE handle,

                            unsigned long ioctlNumber,

                            void* inBuffer,

                            unsigned long inBufferCount,

                            void* outBuffer,

                            unsigned long outBufferCount,

                            unsigned long* bytesReturned);

static PaError WdmGetPropertySimple(HANDLE handle,

                                    const GUID* const guidPropertySet,

                                    unsigned long property,

                                    void* value,

                                    unsigned long valueCount);

static PaError WdmSetPropertySimple(HANDLE handle,

                                    const GUID* const guidPropertySet,

                                    unsigned long property,

                                    void* value,

                                    unsigned long valueCount,

                                    void* instance,

                                    unsigned long instanceCount);

static PaError WdmGetPinPropertySimple(HANDLE  handle,

                                       unsigned long pinId,

                                       const GUID* const guidPropertySet,

                                       unsigned long property,

                                       void* value,

                                       unsigned long valueCount,

                                       unsigned long* byteCount);

static PaError WdmGetPinPropertyMulti(HANDLE  handle,

                                      unsigned long pinId,

                                      const GUID* const guidPropertySet,

                                      unsigned long property,

                                      KSMULTIPLE_ITEM** ksMultipleItem);

static PaError WdmGetPropertyMulti(HANDLE handle,

                                   const GUID* const guidPropertySet,

                                   unsigned long property,

                                   KSMULTIPLE_ITEM** ksMultipleItem);

static PaError WdmSetMuxNodeProperty(HANDLE handle,

                                     ULONG nodeId,

                                     ULONG pinId);

/** Pin management functions */

static PaWinWdmPin* PinNew(PaWinWdmFilter* parentFilter, unsigned long pinId, PaError* error);

static void PinFree(PaWinWdmPin* pin);

static void PinClose(PaWinWdmPin* pin);

static PaError PinInstantiate(PaWinWdmPin* pin);

/*static PaError PinGetState(PaWinWdmPin* pin, KSSTATE* state); NOT USED */

static PaError PinSetState(PaWinWdmPin* pin, KSSTATE state);

static PaError PinSetFormat(PaWinWdmPin* pin, const WAVEFORMATEX* format);

static PaError PinIsFormatSupported(PaWinWdmPin* pin, const WAVEFORMATEX* format);

/* WaveRT support */

static PaError PinQueryNotificationSupport(PaWinWdmPin* pPin, BOOL* pbResult);

static PaError PinGetBuffer(PaWinWdmPin* pPin, void** pBuffer, DWORD* pRequestedBufSize, BOOL* pbCallMemBarrier);

static PaError PinRegisterPositionRegister(PaWinWdmPin* pPin);

static PaError PinRegisterNotificationHandle(PaWinWdmPin* pPin, HANDLE handle);

static PaError PinUnregisterNotificationHandle(PaWinWdmPin* pPin, HANDLE handle);

static PaError PinGetHwLatency(PaWinWdmPin* pPin, ULONG* pFifoSize, ULONG* pChipsetDelay, ULONG* pCodecDelay);

static PaError PinGetAudioPositionMemoryMapped(PaWinWdmPin* pPin, ULONG* pPosition);

static PaError PinGetAudioPositionViaIOCTLRead(PaWinWdmPin* pPin, ULONG* pPosition);

static PaError PinGetAudioPositionViaIOCTLWrite(PaWinWdmPin* pPin, ULONG* pPosition);

/* Filter management functions */

static PaWinWdmFilter* FilterNew(PaWDMKSType type, DWORD devNode, const wchar_t* filterName, const wchar_t* friendlyName, PaError* error);

static PaError FilterInitializePins(PaWinWdmFilter* filter);

static void FilterFree(PaWinWdmFilter* filter);

static void FilterAddRef(PaWinWdmFilter* filter);

static PaWinWdmPin* FilterCreatePin(

                                    PaWinWdmFilter* filter,

                                    int pinId,

                                    const WAVEFORMATEX* wfex,

                                    PaError* error);

static PaError FilterUse(PaWinWdmFilter* filter);

static void FilterRelease(PaWinWdmFilter* filter);

/* Hot plug functions */

static BOOL IsDeviceTheSame(const PaWinWdmDeviceInfo* pDev1,

                            const PaWinWdmDeviceInfo* pDev2);

/* Interface functions */

static void Terminate( struct PaUtilHostApiRepresentation *hostApi );

static PaError IsFormatSupported(

struct PaUtilHostApiRepresentation *hostApi,

    const PaStreamParameters *inputParameters,

    const PaStreamParameters *outputParameters,

    double sampleRate );

static PaError ScanDeviceInfos( struct PaUtilHostApiRepresentation *hostApi, PaHostApiIndex index, void **newDeviceInfos, int *newDeviceCount );

static PaError CommitDeviceInfos( struct PaUtilHostApiRepresentation *hostApi, PaHostApiIndex index, void *deviceInfos, int deviceCount );

static PaError DisposeDeviceInfos( struct PaUtilHostApiRepresentation *hostApi, void *deviceInfos, int deviceCount );

static PaError OpenStream(

struct PaUtilHostApiRepresentation *hostApi,

    PaStream** s,

    const PaStreamParameters *inputParameters,

    const PaStreamParameters *outputParameters,

    double sampleRate,

    unsigned long framesPerBuffer,

    PaStreamFlags streamFlags,

    PaStreamCallback *streamCallback,

    void *userData );

static PaError CloseStream( PaStream* stream );

static PaError StartStream( PaStream *stream );

static PaError StopStream( PaStream *stream );

static PaError AbortStream( PaStream *stream );

static PaError IsStreamStopped( PaStream *s );

static PaError IsStreamActive( PaStream *stream );

static PaTime GetStreamTime( PaStream *stream );

static double GetStreamCpuLoad( PaStream* stream );

static PaError ReadStream(

                          PaStream* stream,

                          void *buffer,

                          unsigned long frames );

static PaError WriteStream(

                           PaStream* stream,

                           const void *buffer,

                           unsigned long frames );

static signed long GetStreamReadAvailable( PaStream* stream );

static signed long GetStreamWriteAvailable( PaStream* stream );

/* Utility functions */

static unsigned long GetWfexSize(const WAVEFORMATEX* wfex);

static PaWinWdmFilter** BuildFilterList(int* filterCount, int* noOfPaDevices, PaError* result);

static BOOL PinWrite(HANDLE h, DATAPACKET* p);

static BOOL PinRead(HANDLE h, DATAPACKET* p);

static void DuplicateFirstChannelInt16(void* buffer, int channels, int samples);

static void DuplicateFirstChannelInt24(void* buffer, int channels, int samples);

PA_THREAD_FUNC ProcessingThread(void*);

/* Pin handler functions */

static PaError PaPinCaptureEventHandler_WaveCyclic(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinCaptureSubmitHandler_WaveCyclic(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderEventHandler_WaveCyclic(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderSubmitHandler_WaveCyclic(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinCaptureEventHandler_WaveRTEvent(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinCaptureEventHandler_WaveRTPolled(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinCaptureSubmitHandler_WaveRTEvent(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinCaptureSubmitHandler_WaveRTPolled(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderEventHandler_WaveRTEvent(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderEventHandler_WaveRTPolled(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderSubmitHandler_WaveRTEvent(PaProcessThreadInfo* pInfo, unsigned eventIndex);

static PaError PaPinRenderSubmitHandler_WaveRTPolled(PaProcessThreadInfo* pInfo, unsigned eventIndex);

/* Function bodies */

#if defined(_DEBUG) && defined(PA_ENABLE_DEBUG_OUTPUT)

#define PA_WDMKS_SET_TREF

static PaTime tRef = 0;

static void PaWinWdmDebugPrintf(const char* fmt, ...)

{

    va_list list;

    char buffer[1024];

    PaTime t = PaUtil_GetTime() - tRef;

    va_start(list, fmt);

    _vsnprintf(buffer, 1023, fmt, list);

    va_end(list);

    PaUtil_DebugPrint("%6.3lf: %s", t, buffer);

}

#ifdef PA_DEBUG

#undef PA_DEBUG

#define PA_DEBUG(x)    PaWinWdmDebugPrintf x ;

#endif

#endif

static BOOL IsDeviceTheSame(const PaWinWdmDeviceInfo* pDev1,

                            const PaWinWdmDeviceInfo* pDev2)

{

    if (pDev1 == NULL || pDev2 == NULL)

        return FALSE;

    if (pDev1 == pDev2)

        return TRUE;

    if (strcmp(pDev1->compositeName, pDev2->compositeName) == 0)

        return TRUE;

    return FALSE;

}

static BOOL IsEarlierThanVista()

{

/*

NOTE: GetVersionEx() is deprecated as of Windows 8.1 and can not be used to reliably detect

versions of Windows higher than Windows 8 (due to manifest requirements for reporting higher versions).

Microsoft recommends switching to VerifyVersionInfo (available on Win 2k and later), however GetVersionEx

is is faster, for now we just disable the deprecation warning.

See: https://msdn.microsoft.com/en-us/library/windows/desktop/ms724451(v=vs.85).aspx

See: http://www.codeproject.com/Articles/678606/Part-Overcoming-Windows-s-deprecation-of-GetVe

*/

#pragma warning (disable : 4996) /* use of GetVersionEx */

    OSVERSIONINFO osvi;

    osvi.dwOSVersionInfoSize = sizeof(osvi);

    if (GetVersionEx(&osvi) && osvi.dwMajorVersion<6)

    {

        return TRUE;

    }

    return FALSE;

#pragma warning (default : 4996)

}

static void MemoryBarrierDummy(void)

{

    /* Do nothing */

}

static void MemoryBarrierRead(void)

{

    PaUtil_ReadMemoryBarrier();

}

static void MemoryBarrierWrite(void)

{

    PaUtil_WriteMemoryBarrier();

}

static unsigned long GetWfexSize(const WAVEFORMATEX* wfex)

{

    if( wfex->wFormatTag == WAVE_FORMAT_PCM )

    {

        return sizeof( WAVEFORMATEX );

    }

    else

    {

        return (sizeof( WAVEFORMATEX ) + wfex->cbSize);

    }

}

static void PaWinWDM_SetLastErrorInfo(long errCode, const char* fmt, ...)

{

    va_list list;

    char buffer[1024];

    va_start(list, fmt);

    _vsnprintf(buffer, 1023, fmt, list);

    va_end(list);

    PaUtil_SetLastHostErrorInfo(paWDMKS, errCode, buffer);

}

/*

Low level pin/filter access functions

*/

static PaError WdmSyncIoctl(

                            HANDLE handle,

                            unsigned long ioctlNumber,

                            void* inBuffer,

                            unsigned long inBufferCount,

                            void* outBuffer,

                            unsigned long outBufferCount,

                            unsigned long* bytesReturned)

{

    PaError result = paNoError;

    unsigned long dummyBytesReturned = 0;

    BOOL bRes;

    if( !bytesReturned )

    {

        /* Use a dummy as the caller hasn't supplied one */

        bytesReturned = &dummyBytesReturned;

    }

    bRes = DeviceIoControl(handle, ioctlNumber, inBuffer, inBufferCount, outBuffer, outBufferCount, bytesReturned, NULL);

    if (!bRes)

    {

        unsigned long error = GetLastError();

        if ( !(((error == ERROR_INSUFFICIENT_BUFFER ) || ( error == ERROR_MORE_DATA )) && 

            ( ioctlNumber == IOCTL_KS_PROPERTY ) &&

            ( outBufferCount == 0 ) ) ) 

        {

            KSPROPERTY* ksProperty = (KSPROPERTY*)inBuffer;

            PaWinWDM_SetLastErrorInfo(result, "WdmSyncIoctl: DeviceIoControl GLE = 0x%08X (prop_set = {%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}, prop_id = %u)",

                error,

                ksProperty->Set.Data1, ksProperty->Set.Data2, ksProperty->Set.Data3,

                ksProperty->Set.Data4[0], ksProperty->Set.Data4[1],

                ksProperty->Set.Data4[2], ksProperty->Set.Data4[3],

                ksProperty->Set.Data4[4], ksProperty->Set.Data4[5],

                ksProperty->Set.Data4[6], ksProperty->Set.Data4[7],

                ksProperty->Id

                );

            result = paUnanticipatedHostError;

        }

    }

    return result;

}

static PaError WdmGetPropertySimple(HANDLE handle,

                                    const GUID* const guidPropertySet,

                                    unsigned long property,

                                    void* value,

                                    unsigned long valueCount)

{

    PaError result;

    KSPROPERTY ksProperty;

    ksProperty.Set = *guidPropertySet;

    ksProperty.Id = property;

    ksProperty.Flags = KSPROPERTY_TYPE_GET;

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksProperty,

        sizeof(KSPROPERTY),

        value,

        valueCount,

        NULL);

    return result;

}

static PaError WdmSetPropertySimple(

                                    HANDLE handle,

                                    const GUID* const guidPropertySet,

                                    unsigned long property,

                                    void* value,

                                    unsigned long valueCount,

                                    void* instance,

                                    unsigned long instanceCount)

{

    PaError result;

    KSPROPERTY* ksProperty;

    unsigned long propertyCount  = 0;

    propertyCount = sizeof(KSPROPERTY) + instanceCount;

    ksProperty = (KSPROPERTY*)_alloca( propertyCount );

    if( !ksProperty )

    {

        return paInsufficientMemory;

    }

    ksProperty->Set = *guidPropertySet;

    ksProperty->Id = property;

    ksProperty->Flags = KSPROPERTY_TYPE_SET;

    if( instance )

    {

        memcpy((void*)((char*)ksProperty + sizeof(KSPROPERTY)), instance, instanceCount);

    }

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        ksProperty,

        propertyCount,

        value,

        valueCount,

        NULL);

    return result;

}

static PaError WdmGetPinPropertySimple(

                                       HANDLE  handle,

                                       unsigned long pinId,

                                       const GUID* const guidPropertySet,

                                       unsigned long property,

                                       void* value,

                                       unsigned long valueCount,

                                       unsigned long *byteCount)

{

    PaError result;

    KSP_PIN ksPProp;

    ksPProp.Property.Set = *guidPropertySet;

    ksPProp.Property.Id = property;

    ksPProp.Property.Flags = KSPROPERTY_TYPE_GET;

    ksPProp.PinId = pinId;

    ksPProp.Reserved = 0;

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksPProp,

        sizeof(KSP_PIN),

        value,

        valueCount,

        byteCount);

    return result;

}

static PaError WdmGetPinPropertyMulti(

                                      HANDLE handle,

                                      unsigned long pinId,

                                      const GUID* const guidPropertySet,

                                      unsigned long property,

                                      KSMULTIPLE_ITEM** ksMultipleItem)

{

    PaError result;

    unsigned long multipleItemSize = 0;

    KSP_PIN ksPProp;

    ksPProp.Property.Set = *guidPropertySet;

    ksPProp.Property.Id = property;

    ksPProp.Property.Flags = KSPROPERTY_TYPE_GET;

    ksPProp.PinId = pinId;

    ksPProp.Reserved = 0;

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksPProp.Property,

        sizeof(KSP_PIN),

        NULL,

        0,

        &multipleItemSize);

    if( result != paNoError )

    {

        return result;

    }

    *ksMultipleItem = (KSMULTIPLE_ITEM*)PaUtil_AllocateMemory( multipleItemSize );

    if( !*ksMultipleItem )

    {

        return paInsufficientMemory;

    }

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksPProp,

        sizeof(KSP_PIN),

        (void*)*ksMultipleItem,

        multipleItemSize,

        NULL);

    if( result != paNoError )

    {

        PaUtil_FreeMemory( ksMultipleItem );

    }

    return result;

}

static PaError WdmGetPropertyMulti(HANDLE handle,

                                   const GUID* const guidPropertySet,

                                   unsigned long property,

                                   KSMULTIPLE_ITEM** ksMultipleItem)

{

    PaError result;

    unsigned long multipleItemSize = 0;

    KSPROPERTY ksProp;

    ksProp.Set = *guidPropertySet;

    ksProp.Id = property;

    ksProp.Flags = KSPROPERTY_TYPE_GET;

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksProp,

        sizeof(KSPROPERTY),

        NULL,

        0,

        &multipleItemSize);

    if( result != paNoError )

    {

        return result;

    }

    *ksMultipleItem = (KSMULTIPLE_ITEM*)PaUtil_AllocateMemory( multipleItemSize );

    if( !*ksMultipleItem )

    {

        return paInsufficientMemory;

    }

    result = WdmSyncIoctl(

        handle,

        IOCTL_KS_PROPERTY,

        &ksProp,

        sizeof(KSPROPERTY),

        (void*)*ksMultipleItem,

        multipleItemSize,

        NULL);

    if( result != paNoError )

    {

        PaUtil_FreeMemory( ksMultipleItem );

    }

    return result;

}

static PaError WdmSetMuxNodeProperty(HANDLE handle,

                                     ULONG nodeId,

                                     ULONG pinId)

{

    PaError result = paNoError;

    KSNODEPROPERTY prop;

    prop.Property.Set = KSPROPSETID_Audio;

    prop.Property.Id = KSPROPERTY_AUDIO_MUX_SOURCE;

    prop.Property.Flags = KSPROPERTY_TYPE_SET | KSPROPERTY_TYPE_TOPOLOGY;

    prop.NodeId = nodeId;

    prop.Reserved = 0;

    result = WdmSyncIoctl(handle, IOCTL_KS_PROPERTY, &prop, sizeof(KSNODEPROPERTY), &pinId, sizeof(ULONG), NULL);

    return result;

}

/* Used when traversing topology for outputs */

static const KSTOPOLOGY_CONNECTION* GetConnectionTo(const KSTOPOLOGY_CONNECTION* pFrom, PaWinWdmFilter* filter, int muxIdx)

{

    unsigned i;

    const KSTOPOLOGY_CONNECTION* retval = NULL;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    (void)muxIdx;

    PA_DEBUG(("GetConnectionTo: Checking %u connections... (pFrom = %p)", filter->connections->Count, pFrom));

    for (i = 0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        if (pConn == pFrom)

            continue;

        if (pConn->FromNode == pFrom->ToNode)

        {

            retval = pConn;

            break;

        }

    }

    PA_DEBUG(("GetConnectionTo: Returning %p\n", retval));

    return retval;

}

/* Used when traversing topology for inputs */

static const KSTOPOLOGY_CONNECTION* GetConnectionFrom(const KSTOPOLOGY_CONNECTION* pTo, PaWinWdmFilter* filter, int muxIdx)

{

    unsigned i;

    const KSTOPOLOGY_CONNECTION* retval = NULL;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    int muxCntr = 0;

    PA_DEBUG(("GetConnectionFrom: Checking %u connections... (pTo = %p)\n", filter->connections->Count, pTo));

    for (i = 0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        if (pConn == pTo)

            continue;

        if (pConn->ToNode == pTo->FromNode)

        {

            if (muxIdx >= 0)

            {

                if (muxCntr < muxIdx)

                {

                    ++muxCntr;

                    continue;

                }

            }

            retval = pConn;

            break;

        }

    }

    PA_DEBUG(("GetConnectionFrom: Returning %p\n", retval));

    return retval;

}

static ULONG GetNumberOfConnectionsTo(const KSTOPOLOGY_CONNECTION* pTo, PaWinWdmFilter* filter)

{

    ULONG retval = 0;

    unsigned i;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    PA_DEBUG(("GetNumberOfConnectionsTo: Checking %u connections...\n", filter->connections->Count));

    for (i = 0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        if (pConn->ToNode == pTo->FromNode &&

            (pTo->FromNode != KSFILTER_NODE || pConn->ToNodePin == pTo->FromNodePin))

        {

            ++retval;

        }

    }

    PA_DEBUG(("GetNumberOfConnectionsTo: Returning %d\n", retval));

    return retval;

}

typedef const KSTOPOLOGY_CONNECTION *(*TFnGetConnection)(const KSTOPOLOGY_CONNECTION*, PaWinWdmFilter*, int);

static const KSTOPOLOGY_CONNECTION* FindStartConnectionFrom(ULONG startPin, PaWinWdmFilter* filter)

{

    unsigned i;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    PA_DEBUG(("FindStartConnectionFrom: Startpin %u, Checking %u connections...\n", startPin, filter->connections->Count));

    for (i = 0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        if (pConn->ToNode == KSFILTER_NODE && pConn->ToNodePin == startPin)

        {

            PA_DEBUG(("FindStartConnectionFrom: returning %p\n", pConn));

            return pConn;

        }

    }

    PA_DEBUG(("FindStartConnectionFrom: returning NULL\n"));

    assert(FALSE);

    return 0;

}

static const KSTOPOLOGY_CONNECTION* FindStartConnectionTo(ULONG startPin, PaWinWdmFilter* filter)

{

    unsigned i;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    PA_DEBUG(("FindStartConnectionTo: Startpin %u, Checking %u connections...\n", startPin, filter->connections->Count));

    for (i = 0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        if (pConn->FromNode == KSFILTER_NODE && pConn->FromNodePin == startPin)

        {

            PA_DEBUG(("FindStartConnectionTo: returning %p\n", pConn));

            return pConn;

        }

    }

    PA_DEBUG(("FindStartConnectionTo: returning NULL\n"));

    assert(FALSE);

    return 0;

}

static ULONG GetConnectedPin(ULONG startPin, BOOL forward, PaWinWdmFilter* filter, int muxPosition, ULONG *muxInputPinId, ULONG *muxNodeId)

{

    int limit=1000;

    const KSTOPOLOGY_CONNECTION *conn = NULL; 

    TFnGetConnection fnGetConnection = forward ? GetConnectionTo : GetConnectionFrom ;

    PA_LOGE_;

    while (1)

    {

        limit--;

        if (limit == 0) {

           PA_DEBUG(("GetConnectedPin: LOOP LIMIT REACHED\n"));

           break;

        }

        if (conn == NULL)

        {

            conn = forward ? FindStartConnectionTo(startPin, filter) : FindStartConnectionFrom(startPin, filter);

        }

        else

        {

            conn = fnGetConnection(conn, filter, -1);

        }

        /* Handling case of erroneous connection list */

        if (conn == NULL)

        {

            break;

        }

        if (forward ? conn->ToNode == KSFILTER_NODE : conn->FromNode == KSFILTER_NODE)

        {

            return forward ? conn->ToNodePin : conn->FromNodePin;

        }

        else

        {

            PA_DEBUG(("GetConnectedPin: count=%d, forward=%d, muxPosition=%d\n", filter->nodes->Count, forward, muxPosition));

            if (filter->nodes->Count > 0 && !forward && muxPosition >= 0)

            {

                const GUID* nodes = (const GUID*)(filter->nodes + 1);

                if (IsEqualGUID(&nodes[conn->FromNode], &KSNODETYPE_MUX))

                {

                    ULONG nConn = GetNumberOfConnectionsTo(conn, filter);

                    conn = fnGetConnection(conn, filter, muxPosition);

                    if (conn == NULL)

                    {

                        break;

                    }

                    if (muxInputPinId != 0)

                    {

                        *muxInputPinId = conn->ToNodePin;

                    }

                    if (muxNodeId != 0)

                    {

                        *muxNodeId = conn->ToNode;

                    }

                }

            }

        }

    }

    PA_LOGL_;

    return KSFILTER_NODE;

}

static void DumpConnectionsAndNodes(PaWinWdmFilter* filter)

{

    unsigned i;

    const KSTOPOLOGY_CONNECTION* connections = (const KSTOPOLOGY_CONNECTION*)(filter->connections + 1);

    const GUID* nodes = (const GUID*)(filter->nodes + 1);

    PA_LOGE_;

    PA_DEBUG(("DumpConnectionsAndNodes: connections=%d, nodes=%d\n", filter->connections->Count, filter->nodes->Count));

    for (i=0; i < filter->connections->Count; ++i)

    {

        const KSTOPOLOGY_CONNECTION* pConn = connections + i;

        PA_DEBUG(("  Connection: %u - FromNode=%u,FromPin=%u -> ToNode=%u,ToPin=%u\n", 

            i,

            pConn->FromNode, pConn->FromNodePin,

            pConn->ToNode, pConn->ToNodePin

            ));

    }

    for (i=0; i < filter->nodes->Count; ++i)

    {

        const GUID* pConn = nodes + i;

        PA_DEBUG(("  Node: %d - {%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}\n",

            i,

            pConn->Data1, pConn->Data2, pConn->Data3,

            pConn->Data4[0], pConn->Data4[1],

            pConn->Data4[2], pConn->Data4[3],

            pConn->Data4[4], pConn->Data4[5],

            pConn->Data4[6], pConn->Data4[7]

        ));

    }

    PA_LOGL_;

}

typedef struct __PaUsbTerminalGUIDToName 

{

    USHORT     usbGUID;

    wchar_t    name[64];

} PaUsbTerminalGUIDToName;

static const PaUsbTerminalGUIDToName kNames[] =

{

    /* Types copied from: http://msdn.microsoft.com/en-us/library/ff537742(v=vs.85).aspx */

    /* Input terminal types */

    { 0x0201, L"Microphone" },

    { 0x0202, L"Desktop Microphone" },

    { 0x0203, L"Personal Microphone" },

    { 0x0204, L"Omni Directional Microphone" },

    { 0x0205, L"Microphone Array" },

    { 0x0206, L"Processing Microphone Array" },

    /* Output terminal types */

    { 0x0301, L"Speakers" },

    { 0x0302, L"Headphones" },

    { 0x0303, L"Head Mounted Display Audio" },

    { 0x0304, L"Desktop Speaker" },

    { 0x0305, L"Room Speaker" },

    { 0x0306, L"Communication Speaker" },

    { 0x0307, L"LFE Speakers" },

    /* External terminal types */

    { 0x0601, L"Analog" },

    { 0x0602, L"Digital" },

    { 0x0603, L"Line" },

    { 0x0604, L"Audio" },

    { 0x0605, L"SPDIF" },

};

static const unsigned kNamesCnt = sizeof(kNames)/sizeof(PaUsbTerminalGUIDToName);

static int PaUsbTerminalGUIDToNameCmp(const void* lhs, const void* rhs)

{

    const PaUsbTerminalGUIDToName* pL = (const PaUsbTerminalGUIDToName*)lhs;

    const PaUsbTerminalGUIDToName* pR = (const PaUsbTerminalGUIDToName*)rhs;

    return ((int)(pL->usbGUID) - (int)(pR->usbGUID));

}

static PaError GetNameFromCategory(const GUID* pGUID, BOOL input, wchar_t* name, unsigned length)

{

    PaError result = paUnanticipatedHostError;

    USHORT usbTerminalGUID = (USHORT)(pGUID->Data1 - 0xDFF219E0);

    PA_LOGE_;

    if (input && usbTerminalGUID >= 0x301 && usbTerminalGUID < 0x400)

    {

        /* Output terminal name for an input !? Set it to Line! */

        usbTerminalGUID = 0x603;

    }

    if (!input && usbTerminalGUID >= 0x201 && usbTerminalGUID < 0x300)

    {

        /* Input terminal name for an output !? Set it to Line! */

        usbTerminalGUID = 0x603;

    }

    if (usbTerminalGUID >= 0x201 && usbTerminalGUID < 0x713)

    {

        PaUsbTerminalGUIDToName s = { usbTerminalGUID };

        const PaUsbTerminalGUIDToName* ptr = bsearch(

            &s,

            kNames,

            kNamesCnt,

            sizeof(PaUsbTerminalGUIDToName),

            PaUsbTerminalGUIDToNameCmp

            );

        if (ptr != 0)

        {

            PA_DEBUG(("GetNameFromCategory: USB GUID %04X -> '%S'\n", usbTerminalGUID, ptr->name));

            if (name != NULL && length > 0)

            {

                int n = _snwprintf(name, length, L"%s", ptr->name);

                if (usbTerminalGUID >= 0x601 && usbTerminalGUID < 0x700)

                {

                    _snwprintf(name + n, length - n, L" %s", (input ? L"In":L"Out"));

                }

            }

            result = paNoError;

        }

    }

    else

    {

        PaWinWDM_SetLastErrorInfo(result, "GetNameFromCategory: usbTerminalGUID = %04X ", usbTerminalGUID);

    }

    PA_LOGL_;

    return result;

}

static BOOL IsFrequencyWithinRange(const KSDATARANGE_AUDIO* range, int frequency)

{

    if (frequency < (int)range->MinimumSampleFrequency)

        return FALSE;

    if (frequency > (int)range->MaximumSampleFrequency)

        return FALSE;

    return TRUE;

}

static BOOL IsBitsWithinRange(const KSDATARANGE_AUDIO* range, int noOfBits)

{

    if (noOfBits < (int)range->MinimumBitsPerSample)

        return FALSE;

    if (noOfBits > (int)range->MaximumBitsPerSample)

        return FALSE;

    return TRUE;

}

/* Note: Somewhat different order compared to WMME implementation, as we want to focus on fidelity first */

static const int defaultSampleRateSearchOrder[] =

{ 44100, 48000, 88200, 96000, 192000, 32000, 24000, 22050, 16000, 12000, 11025, 9600, 8000 };

static const int defaultSampleRateSearchOrderCount = sizeof(defaultSampleRateSearchOrder)/sizeof(defaultSampleRateSearchOrder[0]);

static int DefaultSampleFrequencyIndex(const KSDATARANGE_AUDIO* range)

{

    int i;

    for(i=0; i < defaultSampleRateSearchOrderCount; ++i)

    {

        int currentFrequency = defaultSampleRateSearchOrder[i];

        if (IsFrequencyWithinRange(range, currentFrequency))

        {

            return i;

        }

    }

    return -1;

}

/*

Create a new pin object belonging to a filter

The pin object holds all the configuration information about the pin

before it is opened, and then the handle of the pin after is opened

*/

static PaWinWdmPin* PinNew(PaWinWdmFilter* parentFilter, unsigned long pinId, PaError* error)

{

    PaWinWdmPin* pin;

    PaError result;