1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
/*++
Copyright (c) Microsoft Corporation All Rights Reserved
Module Name:
Common.h
Abstract:
CAdapterCommon class declaration.
--*/
#ifndef _SIMPLEAUDIOSAMPLE_COMMON_H_
#define _SIMPLEAUDIOSAMPLE_COMMON_H_
#define HNSTIME_PER_MILLISECOND 10000
//=============================================================================
// Macros
//=============================================================================
#define UNREFERENCED_VAR(status) \
status = status
//-------------------------------------------------------------------------
// Description:
//
// jump to the given label.
//
// Parameters:
//
// label - [in] label to jump if condition is met
//
#define JUMP(label) \
goto label;
//-------------------------------------------------------------------------
// Description:
//
// If the condition evaluates to TRUE, jump to the given label.
//
// Parameters:
//
// condition - [in] Code that fits in if statement
// label - [in] label to jump if condition is met
//
#define IF_TRUE_JUMP(condition, label) \
if (condition) \
{ \
goto label; \
}
//-------------------------------------------------------------------------
// Description:
//
// If the condition evaluates to TRUE, perform the given statement
// then jump to the given label.
//
// Parameters:
//
// condition - [in] Code that fits in if statement
// action - [in] action to perform in body of if statement
// label - [in] label to jump if condition is met
//
#define IF_TRUE_ACTION_JUMP(condition, action, label) \
if (condition) \
{ \
action; \
goto label; \
}
//-------------------------------------------------------------------------
// Description:
//
// If the ntStatus is not NT_SUCCESS, perform the given statement then jump to
// the given label.
//
// Parameters:
//
// ntStatus - [in] Value to check
// action - [in] action to perform in body of if statement
// label - [in] label to jump if condition is met
//
#define IF_FAILED_ACTION_JUMP(ntStatus, action, label) \
if (!NT_SUCCESS(ntStatus)) \
{ \
action; \
goto label; \
}
//-------------------------------------------------------------------------
// Description:
//
// If the ntStatus passed is not NT_SUCCESS, jump to the given label.
//
// Parameters:
//
// ntStatus - [in] Value to check
// label - [in] label to jump if condition is met
//
#define IF_FAILED_JUMP(ntStatus, label) \
if (!NT_SUCCESS(ntStatus)) \
{ \
goto label; \
}
#define SAFE_RELEASE(p) {if (p) { (p)->Release(); (p) = nullptr; } }
#define SAFE_DELETE_PTR_WITH_TAG(ptr, tag) if(ptr) { ExFreePoolWithTag((ptr), tag); (ptr) = NULL; }
// JACKDESC_RGB(r, g, b)
#define JACKDESC_RGB(r, g, b) \
((COLORREF)((r << 16) | (g << 8) | (b)))
// Min/Max defines.
#define MIN(x, y) ((x) < (y) ? (x) : (y))
#define MAX(x, y) ((x) > (y) ? (x) : (y))
#define MINWAVERT_POOLTAG 'RWNM'
#define MINTOPORT_POOLTAG 'RTNM'
#define MINADAPTER_POOLTAG 'uAyS'
typedef enum
{
eSpeakerDevice = 0,
eMicArrayDevice1,
eMaxDeviceType,
} eDeviceType;
//
// Signal processing modes and default formats structs.
//
typedef struct _MODE_AND_DEFAULT_FORMAT {
GUID Mode;
KSDATAFORMAT* DefaultFormat;
} MODE_AND_DEFAULT_FORMAT, *PMODE_AND_DEFAULT_FORMAT;
//
// Enumeration of the various types of pins implemented in this driver.
//
typedef enum
{
NoPin,
BridgePin,
SystemRenderPin,
SystemCapturePin,
} PINTYPE;
//
// PIN_DEVICE_FORMATS_AND_MODES
//
// Used to specify a pin's type (e.g. system, offload, etc.), formats, and
// modes. Conceptually serves similar purpose as the PCPIN_DESCRIPTOR to
// define a pin, but is more specific to driver implementation.
//
// Arrays of these structures follow the same order as the filter's
// pin descriptor array so that KS pin IDs can serve as an index.
//
typedef struct _PIN_DEVICE_FORMATS_AND_MODES
{
PINTYPE PinType;
KSDATAFORMAT_WAVEFORMATEXTENSIBLE * WaveFormats;
ULONG WaveFormatsCount;
MODE_AND_DEFAULT_FORMAT * ModeAndDefaultFormat;
ULONG ModeAndDefaultFormatCount;
} PIN_DEVICE_FORMATS_AND_MODES, *PPIN_DEVICE_FORMATS_AND_MODES;
// forward declaration.
typedef struct _ENDPOINT_MINIPAIR *PENDPOINT_MINIPAIR;
// both wave & topology miniport create function prototypes have this form:
typedef HRESULT (*PFNCREATEMINIPORT)(
_Out_ PUNKNOWN * Unknown,
_In_ REFCLSID,
_In_opt_ PUNKNOWN UnknownOuter,
_In_ POOL_FLAGS PoolFlags,
_In_ PUNKNOWN UnknownAdapter,
_In_opt_ PVOID DeviceContext,
_In_ PENDPOINT_MINIPAIR MiniportPair
);
//=============================================================================
//
//=============================================================================
typedef struct _SIMPLEAUDIOSAMPLE_DEVPROPERTY {
const DEVPROPKEY *PropertyKey;
DEVPROPTYPE Type;
ULONG BufferSize;
__field_bcount_opt(BufferSize) PVOID Buffer;
} SIMPLEAUDIOSAMPLE_DEVPROPERTY, PSIMPLEAUDIOSAMPLE_DEVPROPERTY;
#define ENDPOINT_NO_FLAGS 0x00000000
#define ENDPOINT_CELLULAR_PROVIDER1 0x00000008
#define ENDPOINT_CELLULAR_PROVIDER2 0x00000010
//
// Endpoint miniport pair (wave/topology) descriptor.
//
typedef struct _ENDPOINT_MINIPAIR
{
eDeviceType DeviceType;
// Topology miniport.
PWSTR TopoName; // make sure this or the template name matches with SIMPLEAUDIOSAMPLE.<TopoName>.szPname in the inf's [Strings] section
PWSTR TemplateTopoName; // optional template name
PFNCREATEMINIPORT TopoCreateCallback;
PCFILTER_DESCRIPTOR* TopoDescriptor;
ULONG TopoInterfacePropertyCount;
const SIMPLEAUDIOSAMPLE_DEVPROPERTY* TopoInterfaceProperties;
// Wave RT miniport.
PWSTR WaveName; // make sure this or the template name matches with SIMPLEAUDIOSAMPLE.<WaveName>.szPname in the inf's [Strings] section
PWSTR TemplateWaveName; // optional template name
PFNCREATEMINIPORT WaveCreateCallback;
PCFILTER_DESCRIPTOR* WaveDescriptor;
ULONG WaveInterfacePropertyCount;
const SIMPLEAUDIOSAMPLE_DEVPROPERTY* WaveInterfaceProperties;
USHORT DeviceMaxChannels;
PIN_DEVICE_FORMATS_AND_MODES* PinDeviceFormatsAndModes;
ULONG PinDeviceFormatsAndModesCount;
// Miniport physical connections.
PHYSICALCONNECTIONTABLE* PhysicalConnections;
ULONG PhysicalConnectionCount;
// General endpoint flags (one of more ENDPOINT_<flag-type>, see above)
ULONG DeviceFlags;
} ENDPOINT_MINIPAIR;
//=============================================================================
// Defines
//=============================================================================
DEFINE_GUID(IID_IAdapterCommon,
0x7eda2950, 0xbf9f, 0x11d0, 0x87, 0x1f, 0x0, 0xa0, 0xc9, 0x11, 0xb5, 0x44);
//=============================================================================
// Interfaces
//=============================================================================
///////////////////////////////////////////////////////////////////////////////
// IAdapterCommon
//
DECLARE_INTERFACE_(IAdapterCommon, IUnknown)
{
STDMETHOD_(NTSTATUS, Init)
(
THIS_
_In_ PDEVICE_OBJECT DeviceObject
) PURE;
STDMETHOD_(PDEVICE_OBJECT, GetDeviceObject)
(
THIS
) PURE;
STDMETHOD_(PDEVICE_OBJECT, GetPhysicalDeviceObject)
(
THIS
) PURE;
STDMETHOD_(WDFDEVICE, GetWdfDevice)
(
THIS
) PURE;
STDMETHOD_(VOID, SetWaveServiceGroup)
(
THIS_
_In_ PSERVICEGROUP ServiceGroup
) PURE;
STDMETHOD_(BOOL, bDevSpecificRead)
(
THIS_
) PURE;
STDMETHOD_(VOID, bDevSpecificWrite)
(
THIS_
_In_ BOOL bDevSpecific
);
STDMETHOD_(INT, iDevSpecificRead)
(
THIS_
) PURE;
STDMETHOD_(VOID, iDevSpecificWrite)
(
THIS_
_In_ INT iDevSpecific
);
STDMETHOD_(UINT, uiDevSpecificRead)
(
THIS_
) PURE;
STDMETHOD_(VOID, uiDevSpecificWrite)
(
THIS_
_In_ UINT uiDevSpecific
);
STDMETHOD_(BOOL, MixerMuteRead)
(
THIS_
_In_ ULONG Index,
_In_ ULONG Channel
) PURE;
STDMETHOD_(VOID, MixerMuteWrite)
(
THIS_
_In_ ULONG Index,
_In_ ULONG Channel,
_In_ BOOL Value
);
STDMETHOD_(ULONG, MixerMuxRead)
(
THIS
);
STDMETHOD_(VOID, MixerMuxWrite)
(
THIS_
_In_ ULONG Index
);
STDMETHOD_(LONG, MixerVolumeRead)
(
THIS_
_In_ ULONG Index,
_In_ ULONG Channel
) PURE;
STDMETHOD_(VOID, MixerVolumeWrite)
(
THIS_
_In_ ULONG Index,
_In_ ULONG Channel,
_In_ LONG Value
) PURE;
STDMETHOD_(LONG, MixerPeakMeterRead)
(
THIS_
_In_ ULONG Index,
_In_ ULONG Channel
) PURE;
STDMETHOD_(VOID, MixerReset)
(
THIS
) PURE;
STDMETHOD_(NTSTATUS, WriteEtwEvent)
(
THIS_
_In_ EPcMiniportEngineEvent miniportEventType,
_In_ ULONGLONG ullData1,
_In_ ULONGLONG ullData2,
_In_ ULONGLONG ullData3,
_In_ ULONGLONG ullData4
) PURE;
STDMETHOD_(VOID, SetEtwHelper)
(
THIS_
PPORTCLSETWHELPER _pPortClsEtwHelper
) PURE;
STDMETHOD_(NTSTATUS, InstallSubdevice)
(
_In_opt_ PIRP Irp,
_In_ PWSTR Name,
_In_opt_ PWSTR TemplateName,
_In_ REFGUID PortClassId,
_In_ REFGUID MiniportClassId,
_In_opt_ PFNCREATEMINIPORT MiniportCreate,
_In_ ULONG cPropertyCount,
_In_reads_opt_(cPropertyCount) const SIMPLEAUDIOSAMPLE_DEVPROPERTY * pProperties,
_In_opt_ PVOID DeviceContext,
_In_ PENDPOINT_MINIPAIR MiniportPair,
_In_opt_ PRESOURCELIST ResourceList,
_In_ REFGUID PortInterfaceId,
_Out_opt_ PUNKNOWN * OutPortInterface,
_Out_opt_ PUNKNOWN * OutPortUnknown,
_Out_opt_ PUNKNOWN * OutMiniportUnknown
);
STDMETHOD_(NTSTATUS, UnregisterSubdevice)
(
THIS_
_In_opt_ PUNKNOWN UnknownPort
);
STDMETHOD_(NTSTATUS, ConnectTopologies)
(
THIS_
_In_ PUNKNOWN UnknownTopology,
_In_ PUNKNOWN UnknownWave,
_In_ PHYSICALCONNECTIONTABLE* PhysicalConnections,
_In_ ULONG PhysicalConnectionCount
);
STDMETHOD_(NTSTATUS, DisconnectTopologies)
(
THIS_
_In_ PUNKNOWN UnknownTopology,
_In_ PUNKNOWN UnknownWave,
_In_ PHYSICALCONNECTIONTABLE* PhysicalConnections,
_In_ ULONG PhysicalConnectionCount
);
STDMETHOD_(NTSTATUS, InstallEndpointFilters)
(
THIS_
_In_opt_ PIRP Irp,
_In_ PENDPOINT_MINIPAIR MiniportPair,
_In_opt_ PVOID DeviceContext,
_Out_opt_ PUNKNOWN * UnknownTopology,
_Out_opt_ PUNKNOWN * UnknownWave,
_Out_opt_ PUNKNOWN * UnknownMiniportTopology,
_Out_opt_ PUNKNOWN * UnknownMiniportWave
);
STDMETHOD_(NTSTATUS, RemoveEndpointFilters)
(
THIS_
_In_ PENDPOINT_MINIPAIR MiniportPair,
_In_opt_ PUNKNOWN UnknownTopology,
_In_opt_ PUNKNOWN UnknownWave
);
STDMETHOD_(NTSTATUS, GetFilters)
(
THIS_
_In_ PENDPOINT_MINIPAIR MiniportPair,
_Out_opt_ PUNKNOWN *UnknownTopologyPort,
_Out_opt_ PUNKNOWN *UnknownTopologyMiniport,
_Out_opt_ PUNKNOWN *UnknownWavePort,
_Out_opt_ PUNKNOWN *UnknownWaveMiniport
);
STDMETHOD_(NTSTATUS, SetIdlePowerManagement)
(
THIS_
_In_ PENDPOINT_MINIPAIR MiniportPair,
_In_ BOOL bEnable
);
STDMETHOD_(VOID, Cleanup)();
};
typedef IAdapterCommon *PADAPTERCOMMON;
//=============================================================================
// Function Prototypes
//=============================================================================
NTSTATUS
NewAdapterCommon
(
_Out_ PUNKNOWN * Unknown,
_In_ REFCLSID,
_In_opt_ PUNKNOWN UnknownOuter,
_In_ POOL_FLAGS PoolFlags
);
#endif //_SIMPLEAUDIOSAMPLE_COMMON_H_
|
