Chris@45: #ifndef PA_WIN_WDMKS_H
Chris@45: #define PA_WIN_WDMKS_H
Chris@45: /*
Chris@60:  * $Id$
Chris@45:  * PortAudio Portable Real-Time Audio Library
Chris@45:  * WDM/KS specific extensions
Chris@45:  *
Chris@45:  * Copyright (c) 1999-2007 Ross Bencina and Phil Burk
Chris@45:  *
Chris@45:  * Permission is hereby granted, free of charge, to any person obtaining
Chris@45:  * a copy of this software and associated documentation files
Chris@45:  * (the "Software"), to deal in the Software without restriction,
Chris@45:  * including without limitation the rights to use, copy, modify, merge,
Chris@45:  * publish, distribute, sublicense, and/or sell copies of the Software,
Chris@45:  * and to permit persons to whom the Software is furnished to do so,
Chris@45:  * subject to the following conditions:
Chris@45:  *
Chris@45:  * The above copyright notice and this permission notice shall be
Chris@45:  * included in all copies or substantial portions of the Software.
Chris@45:  *
Chris@45:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@45:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@45:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Chris@45:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
Chris@45:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@45:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@45:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@45:  */
Chris@45: 
Chris@45: /*
Chris@45:  * The text above constitutes the entire PortAudio license; however, 
Chris@45:  * the PortAudio community also makes the following non-binding requests:
Chris@45:  *
Chris@45:  * Any person wishing to distribute modifications to the Software is
Chris@45:  * requested to send the modifications to the original developer so that
Chris@45:  * they can be incorporated into the canonical version. It is also 
Chris@45:  * requested that these non-binding requests be included along with the 
Chris@45:  * license above.
Chris@45:  */
Chris@45: 
Chris@45: /** @file
Chris@45:  @ingroup public_header
Chris@45:  @brief WDM Kernel Streaming-specific PortAudio API extension header file.
Chris@45: */
Chris@45: 
Chris@45: 
Chris@45: #include "portaudio.h"
Chris@45: 
Chris@45: #include <windows.h>
Chris@45: 
Chris@45: #ifdef __cplusplus
Chris@45: extern "C"
Chris@45: {
Chris@45: #endif /* __cplusplus */
Chris@60: 
Chris@60:     /** Flags to indicate valid fields in PaWinWDMKSInfo.
Chris@60:      @see PaWinWDMKSInfo
Chris@60:      @version Available as of 19.5.0.
Chris@60:     */
Chris@60:     typedef enum PaWinWDMKSFlags
Chris@60:     {
Chris@60:         /** Makes WDMKS use the supplied latency figures instead of relying on the frame size reported
Chris@60:          by the WaveCyclic device. Use at own risk!
Chris@60:         */
Chris@60:         paWinWDMKSOverrideFramesize   = (1 << 0),
Chris@60: 
Chris@60:         /** Makes WDMKS (output stream) use the given channelMask instead of the default.
Chris@60:           @version Available as of 19.5.0.
Chris@60:         */
Chris@60:         paWinWDMKSUseGivenChannelMask = (1 << 1),
Chris@60: 
Chris@60:     } PaWinWDMKSFlags;
Chris@60: 
Chris@45:     typedef struct PaWinWDMKSInfo{
Chris@45:         unsigned long size;             /**< sizeof(PaWinWDMKSInfo) */
Chris@45:         PaHostApiTypeId hostApiType;    /**< paWDMKS */
Chris@45:         unsigned long version;          /**< 1 */
Chris@45: 
Chris@60:         /** Flags indicate which fields are valid.
Chris@60:          @see PaWinWDMKSFlags
Chris@60:          @version Available as of 19.5.0.
Chris@60:         */
Chris@60:         unsigned long flags;
Chris@60: 
Chris@60:         /** The number of packets to use for WaveCyclic devices, range is [2, 8]. Set to zero for default value of 2. */
Chris@45:         unsigned noOfPackets;
Chris@60: 
Chris@60:         /** If paWinWDMKSUseGivenChannelMask bit is set in flags, use this as channelMask instead of default.
Chris@60:          @see PaWinWDMKSFlags
Chris@60:          @version Available as of 19.5.0.
Chris@60:         */
Chris@60:         unsigned channelMask;
Chris@45:     } PaWinWDMKSInfo;
Chris@45: 
Chris@45:     typedef enum PaWDMKSType
Chris@45:     {
Chris@45:         Type_kNotUsed,
Chris@45:         Type_kWaveCyclic,
Chris@45:         Type_kWaveRT,
Chris@45:         Type_kCnt,
Chris@45:     } PaWDMKSType;
Chris@45: 
Chris@45:     typedef enum PaWDMKSSubType
Chris@45:     {
Chris@45:         SubType_kUnknown,
Chris@45:         SubType_kNotification,
Chris@45:         SubType_kPolled,
Chris@45:         SubType_kCnt,
Chris@45:     } PaWDMKSSubType;
Chris@45: 
Chris@45:     typedef struct PaWinWDMKSDeviceInfo {
Chris@45:         wchar_t filterPath[MAX_PATH];     /**< KS filter path in Unicode! */
Chris@45:         wchar_t topologyPath[MAX_PATH];   /**< Topology filter path in Unicode! */
Chris@45:         PaWDMKSType streamingType;
Chris@45:         GUID deviceProductGuid;           /**< The product GUID of the device (if supported) */
Chris@45:     } PaWinWDMKSDeviceInfo;
Chris@45: 
Chris@45:     typedef struct PaWDMKSDirectionSpecificStreamInfo
Chris@45:     {
Chris@45:         PaDeviceIndex device;
Chris@45:         unsigned channels;                  /**< No of channels the device is opened with */
Chris@45:         unsigned framesPerHostBuffer;       /**< No of frames of the device buffer */
Chris@45:         int endpointPinId;                  /**< Endpoint pin ID (on topology filter if topologyName is not empty) */
Chris@45:         int muxNodeId;                      /**< Only valid for input */
Chris@45:         PaWDMKSSubType streamingSubType;       /**< Not known until device is opened for streaming */
Chris@45:     } PaWDMKSDirectionSpecificStreamInfo;
Chris@45: 
Chris@45:     typedef struct PaWDMKSSpecificStreamInfo {
Chris@45:         PaWDMKSDirectionSpecificStreamInfo input;
Chris@45:         PaWDMKSDirectionSpecificStreamInfo output;
Chris@45:     } PaWDMKSSpecificStreamInfo;
Chris@45: 
Chris@45: #ifdef __cplusplus
Chris@45: }
Chris@45: #endif /* __cplusplus */
Chris@45: 
Chris@45: #endif /* PA_WIN_DS_H */