huwcampbell.com
Reactos
1/* -*- tab-width: 8; c-basic-offset: 4 -*- */
2
3/*****************************************************************************
4 * Copyright 1998, Luiz Otavio L. Zorzella
5 * 1999, Eric Pouech
6 *
7 * Purpose: multimedia declarations (external to WINMM & MMSYSTEM DLLs
8 * for other DLLs (MCI, drivers...))
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 *
24 *****************************************************************************
25 */
26#ifndef __MMDDK_H
27#define __MMDDK_H
28
29#include <mmsystem.h>
30#include <winbase.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/* Maxium drivers */
37#define MAXWAVEDRIVERS 10
38
39#define MAX_MIDIINDRV (16)
40/* For now I'm making 16 the maximum number of midi devices one can
41 * have. This should be more than enough for everybody. But as a purist,
42 * I intend to make it unbounded in the future, as soon as I figure
43 * a good way to do so.
44 */
45#define MAX_MIDIOUTDRV (16)
46
47/* ==================================
48 * Multimedia DDK compatible part
49 * ================================== */
50
51#include <pshpack1.h>
52
53#define DRVM_INIT 100
54#define DRVM_EXIT 101
55#define DRVM_DISABLE 102
56#define DRVM_ENABLE 103
57
58/* messages that have IOCTL format
59 * dw1 = NULL or handle
60 * dw2 = NULL or ptr to DRVM_IOCTL_DATA
61 * return is MMRESULT
62 */
63#define DRVM_IOCTL 0x100
64#define DRVM_ADD_THRU (DRVM_IOCTL+1)
65#define DRVM_REMOVE_THRU (DRVM_IOCTL+2)
66#define DRVM_IOCTL_LAST (DRVM_IOCTL+5)
67typedef struct {
68 DWORD dwSize; /* size of this structure */
69 DWORD dwCmd; /* IOCTL command code, 0x80000000 and above reserved for system */
70} DRVM_IOCTL_DATA, *LPDRVM_IOCTL_DATA;
71
72/* command code ranges for dwCmd field of DRVM_IOCTL message
73 * - codes from 0 to 0x7FFFFFFF are user defined
74 * - codes from 0x80000000 to 0xFFFFFFFF are reserved for future definition by microsoft
75 */
76#define DRVM_IOCTL_CMD_USER 0x00000000L
77#define DRVM_IOCTL_CMD_SYSTEM 0x80000000L
78
79#define DRVM_MAPPER 0x2000
80#define DRVM_USER 0x4000
81#define DRVM_MAPPER_STATUS (DRVM_MAPPER+0)
82#define DRVM_MAPPER_RECONFIGURE (DRVM_MAPPER+1)
83#define DRVM_MAPPER_PREFERRED_GET (DRVM_MAPPER+21)
84#define DRVM_MAPPER_CONSOLEVOICECOM_GET (DRVM_MAPPER+23)
85
86#define DRV_QUERYDRVENTRY (DRV_RESERVED + 1)
87#define DRV_QUERYDEVNODE (DRV_RESERVED + 2)
88#define DRV_QUERYNAME (DRV_RESERVED + 3)
89#define DRV_QUERYDRIVERIDS (DRV_RESERVED + 4)
90#define DRV_QUERYMAPPABLE (DRV_RESERVED + 5)
91#define DRV_QUERYMODULE (DRV_RESERVED + 9)
92#define DRV_PNPINSTALL (DRV_RESERVED + 11)
93#define DRV_QUERYDEVICEINTERFACE (DRV_RESERVED + 12)
94#define DRV_QUERYDEVICEINTERFACESIZE (DRV_RESERVED + 13)
95#define DRV_QUERYSTRINGID (DRV_RESERVED + 14)
96#define DRV_QUERYSTRINGIDSIZE (DRV_RESERVED + 15)
97#define DRV_QUERYIDFROMSTRINGID (DRV_RESERVED + 16)
98#define DRV_QUERYFUNCTIONINSTANCEID (DRV_RESERVED + 17)
99#ifdef _WINE
100#define DRV_QUERYDSOUNDIFACE (DRV_RESERVED + 20)
101#define DRV_QUERYDSOUNDDESC (DRV_RESERVED + 21)
102#define DRV_QUERYDSOUNDGUID (DRV_RESERVED + 22)
103#endif
104
105#define WODM_INIT DRVM_INIT
106#define WODM_GETNUMDEVS 3
107#define WODM_GETDEVCAPS 4
108#define WODM_OPEN 5
109#define WODM_CLOSE 6
110#define WODM_PREPARE 7
111#define WODM_UNPREPARE 8
112#define WODM_WRITE 9
113#define WODM_PAUSE 10
114#define WODM_RESTART 11
115#define WODM_RESET 12
116#define WODM_GETPOS 13
117#define WODM_GETPITCH 14
118#define WODM_SETPITCH 15
119#define WODM_GETVOLUME 16
120#define WODM_SETVOLUME 17
121#define WODM_GETPLAYBACKRATE 18
122#define WODM_SETPLAYBACKRATE 19
123#define WODM_BREAKLOOP 20
124#define WODM_PREFERRED 21
125
126#define WODM_MAPPER_STATUS (DRVM_MAPPER_STATUS + 0)
127#define WAVEOUT_MAPPER_STATUS_DEVICE 0
128#define WAVEOUT_MAPPER_STATUS_MAPPED 1
129#define WAVEOUT_MAPPER_STATUS_FORMAT 2
130
131#define WODM_BUSY 21
132
133#define WIDM_INIT DRVM_INIT
134#define WIDM_GETNUMDEVS 50
135#define WIDM_GETDEVCAPS 51
136#define WIDM_OPEN 52
137#define WIDM_CLOSE 53
138#define WIDM_PREPARE 54
139#define WIDM_UNPREPARE 55
140#define WIDM_ADDBUFFER 56
141#define WIDM_START 57
142#define WIDM_STOP 58
143#define WIDM_RESET 59
144#define WIDM_GETPOS 60
145#define WIDM_PREFERRED 61
146#define WIDM_MAPPER_STATUS (DRVM_MAPPER_STATUS + 0)
147#define WAVEIN_MAPPER_STATUS_DEVICE 0
148#define WAVEIN_MAPPER_STATUS_MAPPED 1
149#define WAVEIN_MAPPER_STATUS_FORMAT 2
150
151#define MODM_INIT DRVM_INIT
152#define MODM_GETNUMDEVS 1
153#define MODM_GETDEVCAPS 2
154#define MODM_OPEN 3
155#define MODM_CLOSE 4
156#define MODM_PREPARE 5
157#define MODM_UNPREPARE 6
158#define MODM_DATA 7
159#define MODM_LONGDATA 8
160#define MODM_RESET 9
161#define MODM_GETVOLUME 10
162#define MODM_SETVOLUME 11
163#define MODM_CACHEPATCHES 12
164#define MODM_CACHEDRUMPATCHES 13
165
166#define MIDM_INIT DRVM_INIT
167#define MIDM_GETNUMDEVS 53
168#define MIDM_GETDEVCAPS 54
169#define MIDM_OPEN 55
170#define MIDM_CLOSE 56
171#define MIDM_PREPARE 57
172#define MIDM_UNPREPARE 58
173#define MIDM_ADDBUFFER 59
174#define MIDM_START 60
175#define MIDM_STOP 61
176#define MIDM_RESET 62
177
178
179#define AUXM_INIT DRVM_INIT
180#define AUXDM_GETNUMDEVS 3
181#define AUXDM_GETDEVCAPS 4
182#define AUXDM_GETVOLUME 5
183#define AUXDM_SETVOLUME 6
184
185#define MXDM_INIT DRVM_INIT
186#define MXDM_USER DRVM_USER
187#define MXDM_MAPPER DRVM_MAPPER
188
189#define MXDM_GETNUMDEVS 1
190#define MXDM_GETDEVCAPS 2
191#define MXDM_OPEN 3
192#define MXDM_CLOSE 4
193#define MXDM_GETLINEINFO 5
194#define MXDM_GETLINECONTROLS 6
195#define MXDM_GETCONTROLDETAILS 7
196#define MXDM_SETCONTROLDETAILS 8
197
198/* pre-defined joystick types */
199#define JOY_HW_NONE 0
200#define JOY_HW_CUSTOM 1
201#define JOY_HW_2A_2B_GENERIC 2
202#define JOY_HW_2A_4B_GENERIC 3
203#define JOY_HW_2B_GAMEPAD 4
204#define JOY_HW_2B_FLIGHTYOKE 5
205#define JOY_HW_2B_FLIGHTYOKETHROTTLE 6
206#define JOY_HW_3A_2B_GENERIC 7
207#define JOY_HW_3A_4B_GENERIC 8
208#define JOY_HW_4B_GAMEPAD 9
209#define JOY_HW_4B_FLIGHTYOKE 10
210#define JOY_HW_4B_FLIGHTYOKETHROTTLE 11
211#define JOY_HW_LASTENTRY 12
212
213/* calibration flags */
214#define JOY_ISCAL_XY 0x00000001l /* XY are calibrated */
215#define JOY_ISCAL_Z 0x00000002l /* Z is calibrated */
216#define JOY_ISCAL_R 0x00000004l /* R is calibrated */
217#define JOY_ISCAL_U 0x00000008l /* U is calibrated */
218#define JOY_ISCAL_V 0x00000010l /* V is calibrated */
219#define JOY_ISCAL_POV 0x00000020l /* POV is calibrated */
220
221/* point of view constants */
222#define JOY_POV_NUMDIRS 4
223#define JOY_POVVAL_FORWARD 0
224#define JOY_POVVAL_BACKWARD 1
225#define JOY_POVVAL_LEFT 2
226#define JOY_POVVAL_RIGHT 3
227
228/* Specific settings for joystick hardware */
229#define JOY_HWS_HASZ 0x00000001l /* has Z info? */
230#define JOY_HWS_HASPOV 0x00000002l /* point of view hat present */
231#define JOY_HWS_POVISBUTTONCOMBOS 0x00000004l /* pov done through combo of buttons */
232#define JOY_HWS_POVISPOLL 0x00000008l /* pov done through polling */
233#define JOY_HWS_ISYOKE 0x00000010l /* joystick is a flight yoke */
234#define JOY_HWS_ISGAMEPAD 0x00000020l /* joystick is a game pad */
235#define JOY_HWS_ISCARCTRL 0x00000040l /* joystick is a car controller */
236/* X defaults to J1 X axis */
237#define JOY_HWS_XISJ1Y 0x00000080l /* X is on J1 Y axis */
238#define JOY_HWS_XISJ2X 0x00000100l /* X is on J2 X axis */
239#define JOY_HWS_XISJ2Y 0x00000200l /* X is on J2 Y axis */
240/* Y defaults to J1 Y axis */
241#define JOY_HWS_YISJ1X 0x00000400l /* Y is on J1 X axis */
242#define JOY_HWS_YISJ2X 0x00000800l /* Y is on J2 X axis */
243#define JOY_HWS_YISJ2Y 0x00001000l /* Y is on J2 Y axis */
244/* Z defaults to J2 Y axis */
245#define JOY_HWS_ZISJ1X 0x00002000l /* Z is on J1 X axis */
246#define JOY_HWS_ZISJ1Y 0x00004000l /* Z is on J1 Y axis */
247#define JOY_HWS_ZISJ2X 0x00008000l /* Z is on J2 X axis */
248/* POV defaults to J2 Y axis, if it is not button based */
249#define JOY_HWS_POVISJ1X 0x00010000l /* pov done through J1 X axis */
250#define JOY_HWS_POVISJ1Y 0x00020000l /* pov done through J1 Y axis */
251#define JOY_HWS_POVISJ2X 0x00040000l /* pov done through J2 X axis */
252/* R defaults to J2 X axis */
253#define JOY_HWS_HASR 0x00080000l /* has R (4th axis) info */
254#define JOY_HWS_RISJ1X 0x00100000l /* R done through J1 X axis */
255#define JOY_HWS_RISJ1Y 0x00200000l /* R done through J1 Y axis */
256#define JOY_HWS_RISJ2Y 0x00400000l /* R done through J2 X axis */
257/* U & V for future hardware */
258#define JOY_HWS_HASU 0x00800000l /* has U (5th axis) info */
259#define JOY_HWS_HASV 0x01000000l /* has V (6th axis) info */
260
261/* Usage settings */
262#define JOY_US_HASRUDDER 0x00000001l /* joystick configured with rudder */
263#define JOY_US_PRESENT 0x00000002l /* is joystick actually present? */
264#define JOY_US_ISOEM 0x00000004l /* joystick is an OEM defined type */
265
266
267/* struct for storing x,y, z, and rudder values */
268typedef struct joypos_tag {
269 DWORD dwX;
270 DWORD dwY;
271 DWORD dwZ;
272 DWORD dwR;
273 DWORD dwU;
274 DWORD dwV;
275} JOYPOS, *LPJOYPOS;
276
277/* struct for storing ranges */
278typedef struct joyrange_tag {
279 JOYPOS jpMin;
280 JOYPOS jpMax;
281 JOYPOS jpCenter;
282} JOYRANGE,*LPJOYRANGE;
283
284typedef struct joyreguservalues_tag {
285 DWORD dwTimeOut; /* value at which to timeout joystick polling */
286 JOYRANGE jrvRanges; /* range of values app wants returned for axes */
287 JOYPOS jpDeadZone; /* area around center to be considered
288 as "dead". specified as a percentage
289 (0-100). Only X & Y handled by system driver */
290} JOYREGUSERVALUES, *LPJOYREGUSERVALUES;
291
292typedef struct joyreghwsettings_tag {
293 DWORD dwFlags;
294 DWORD dwNumButtons; /* number of buttons */
295} JOYREGHWSETTINGS, *LPJOYHWSETTINGS;
296
297/* range of values returned by the hardware (filled in by calibration) */
298typedef struct joyreghwvalues_tag {
299 JOYRANGE jrvHardware; /* values returned by hardware */
300 DWORD dwPOVValues[JOY_POV_NUMDIRS];/* POV values returned by hardware */
301 DWORD dwCalFlags; /* what has been calibrated */
302} JOYREGHWVALUES, *LPJOYREGHWVALUES;
303
304/* hardware configuration */
305typedef struct joyreghwconfig_tag {
306 JOYREGHWSETTINGS hws; /* hardware settings */
307 DWORD dwUsageSettings;/* usage settings */
308 JOYREGHWVALUES hwv; /* values returned by hardware */
309 DWORD dwType; /* type of joystick */
310 DWORD dwReserved; /* reserved for OEM drivers */
311} JOYREGHWCONFIG, *LPJOYREGHWCONFIG;
312
313/* joystick calibration info structure */
314typedef struct joycalibrate_tag {
315 UINT wXbase;
316 UINT wXdelta;
317 UINT wYbase;
318 UINT wYdelta;
319 UINT wZbase;
320 UINT wZdelta;
321} JOYCALIBRATE;
322typedef JOYCALIBRATE *LPJOYCALIBRATE;
323
324/* prototype for joystick message function */
325typedef UINT (CALLBACK * JOYDEVMSGPROC)(DWORD dwID, UINT uMessage, LPARAM lParam1, LPARAM lParam2);
326typedef JOYDEVMSGPROC *LPJOYDEVMSGPROC;
327
328/* messages sent to joystick driver's DriverProc() function */
329#define JDD_GETNUMDEVS (DRV_RESERVED + 0x0001)
330#define JDD_GETDEVCAPS (DRV_RESERVED + 0x0002)
331#define JDD_GETPOS (DRV_RESERVED + 0x0101)
332#define JDD_SETCALIBRATION (DRV_RESERVED + 0x0102)
333#define JDD_CONFIGCHANGED (DRV_RESERVED + 0x0103)
334#define JDD_GETPOSEX (DRV_RESERVED + 0x0104)
335
336#define MCI_MAX_DEVICE_TYPE_LENGTH 80
337
338#define MCI_OPEN_DRIVER 0x0801
339#define MCI_CLOSE_DRIVER 0x0802
340
341#define MCI_FALSE (MCI_STRING_OFFSET + 19)
342#define MCI_TRUE (MCI_STRING_OFFSET + 20)
343
344#define MCI_FORMAT_RETURN_BASE MCI_FORMAT_MILLISECONDS_S
345#define MCI_FORMAT_MILLISECONDS_S (MCI_STRING_OFFSET + 21)
346#define MCI_FORMAT_HMS_S (MCI_STRING_OFFSET + 22)
347#define MCI_FORMAT_MSF_S (MCI_STRING_OFFSET + 23)
348#define MCI_FORMAT_FRAMES_S (MCI_STRING_OFFSET + 24)
349#define MCI_FORMAT_SMPTE_24_S (MCI_STRING_OFFSET + 25)
350#define MCI_FORMAT_SMPTE_25_S (MCI_STRING_OFFSET + 26)
351#define MCI_FORMAT_SMPTE_30_S (MCI_STRING_OFFSET + 27)
352#define MCI_FORMAT_SMPTE_30DROP_S (MCI_STRING_OFFSET + 28)
353#define MCI_FORMAT_BYTES_S (MCI_STRING_OFFSET + 29)
354#define MCI_FORMAT_SAMPLES_S (MCI_STRING_OFFSET + 30)
355#define MCI_FORMAT_TMSF_S (MCI_STRING_OFFSET + 31)
356
357#define MCI_VD_FORMAT_TRACK_S (MCI_VD_OFFSET + 5)
358
359#define WAVE_FORMAT_PCM_S (MCI_WAVE_OFFSET + 0)
360#define WAVE_MAPPER_S (MCI_WAVE_OFFSET + 1)
361
362#define MCI_SEQ_MAPPER_S (MCI_SEQ_OFFSET + 5)
363#define MCI_SEQ_FILE_S (MCI_SEQ_OFFSET + 6)
364#define MCI_SEQ_MIDI_S (MCI_SEQ_OFFSET + 7)
365#define MCI_SEQ_SMPTE_S (MCI_SEQ_OFFSET + 8)
366#define MCI_SEQ_FORMAT_SONGPTR_S (MCI_SEQ_OFFSET + 9)
367#define MCI_SEQ_NONE_S (MCI_SEQ_OFFSET + 10)
368#define MIDIMAPPER_S (MCI_SEQ_OFFSET + 11)
369
370#define MCI_RESOURCE_RETURNED 0x00010000 /* resource ID */
371#define MCI_COLONIZED3_RETURN 0x00020000 /* colonized ID, 3 bytes data */
372#define MCI_COLONIZED4_RETURN 0x00040000 /* colonized ID, 4 bytes data */
373#define MCI_INTEGER_RETURNED 0x00080000 /* integer conversion needed */
374#define MCI_RESOURCE_DRIVER 0x00100000 /* driver owns returned resource */
375
376#define MCI_NO_COMMAND_TABLE 0xFFFF
377
378#define MCI_COMMAND_HEAD 0
379#define MCI_STRING 1
380#define MCI_INTEGER 2
381#define MCI_END_COMMAND 3
382#define MCI_RETURN 4
383#define MCI_FLAG 5
384#define MCI_END_COMMAND_LIST 6
385#define MCI_RECT 7
386#define MCI_CONSTANT 8
387#define MCI_END_CONSTANT 9
388#define MCI_HWND 10
389#define MCI_HPAL 11
390#define MCI_HDC 12
391
392#ifdef _WIN64
393#define MCI_INTEGER64 13
394#endif /* _WIN64 */
395
396#define MAKEMCIRESOURCE(wRet, wRes) MAKELRESULT((wRet), (wRes))
397
398typedef struct {
399 DWORD_PTR dwCallback;
400 DWORD_PTR dwInstance;
401 HMIDIOUT hMidi;
402 DWORD dwFlags;
403} PORTALLOC, *LPPORTALLOC;
404
405typedef struct {
406 HWAVE hWave;
407 LPWAVEFORMATEX lpFormat;
408 DWORD_PTR dwCallback;
409 DWORD_PTR dwInstance;
410 UINT uMappedDeviceID;
411 DWORD_PTR dnDevNode;
412} WAVEOPENDESC, *LPWAVEOPENDESC;
413
414typedef struct {
415 DWORD dwStreamID;
416 WORD wDeviceID;
417} MIDIOPENSTRMID;
418
419typedef struct {
420 HMIDI hMidi;
421 DWORD_PTR dwCallback;
422 DWORD_PTR dwInstance;
423 DWORD_PTR dnDevNode;
424 DWORD cIds;
425 MIDIOPENSTRMID rgIds;
426} MIDIOPENDESC, *LPMIDIOPENDESC;
427
428typedef struct tMIXEROPENDESC
429{
430 HMIXEROBJ hmx;
431 LPVOID pReserved0;
432 DWORD_PTR dwCallback;
433 DWORD_PTR dwInstance;
434 DWORD_PTR dnDevNode;
435} MIXEROPENDESC, *LPMIXEROPENDESC;
436
437typedef struct {
438 UINT wDeviceID; /* device ID */
439 LPSTR lpstrParams; /* parameter string for entry in SYSTEM.INI */
440 UINT wCustomCommandTable; /* custom command table (0xFFFF if none) * filled in by the driver */
441 UINT wType; /* driver type (filled in by the driver) */
442} MCI_OPEN_DRIVER_PARMSA, *LPMCI_OPEN_DRIVER_PARMSA;
443
444typedef struct {
445 UINT wDeviceID; /* device ID */
446 LPWSTR lpstrParams; /* parameter string for entry in SYSTEM.INI */
447 UINT wCustomCommandTable; /* custom command table (0xFFFF if none) * filled in by the driver */
448 UINT wType; /* driver type (filled in by the driver) */
449} MCI_OPEN_DRIVER_PARMSW, *LPMCI_OPEN_DRIVER_PARMSW;
450
451DWORD_PTR WINAPI mciGetDriverData(UINT uDeviceID);
452BOOL WINAPI mciSetDriverData(UINT uDeviceID, DWORD_PTR dwData);
453UINT WINAPI mciDriverYield(UINT uDeviceID);
454BOOL WINAPI mciDriverNotify(HWND hwndCallback, UINT uDeviceID,
455 UINT uStatus);
456UINT WINAPI mciLoadCommandResource(HINSTANCE hInstance,
457 LPCWSTR lpResName, UINT uType);
458BOOL WINAPI mciFreeCommandResource(UINT uTable);
459
460#define DCB_NULL 0x0000
461#define DCB_WINDOW 0x0001 /* dwCallback is a HWND */
462#define DCB_TASK 0x0002 /* dwCallback is a HTASK */
463#define DCB_FUNCTION 0x0003 /* dwCallback is a FARPROC */
464#define DCB_EVENT 0x0005 /* dwCallback is an EVENT Handler */
465#define DCB_TYPEMASK 0x0007
466#define DCB_NOSWITCH 0x0008 /* don't switch stacks for callback */
467
468BOOL APIENTRY DriverCallback(DWORD_PTR dwCallBack, DWORD uFlags, HDRVR hDev,
469 DWORD wMsg, DWORD_PTR dwUser, DWORD_PTR dwParam1, DWORD_PTR dwParam2);
470
471typedef void (*LPTASKCALLBACK)(DWORD dwInst);
472
473#define TASKERR_NOTASKSUPPORT 1
474#define TASKERR_OUTOFMEMORY 2
475UINT WINAPI mmTaskCreate(LPTASKCALLBACK, HANDLE*, DWORD_PTR);
476void WINAPI mmTaskBlock(DWORD);
477BOOL WINAPI mmTaskSignal(DWORD);
478void WINAPI mmTaskYield(void);
479DWORD WINAPI mmGetCurrentTask(void);
480
481
482#define WAVE_DIRECTSOUND 0x0080
483
484
485#include <poppack.h>
486
487#ifdef __cplusplus
488} // extern "C"
489#endif
490
491#endif /* __MMDDK_H */