80317f4d7cba5fabb2ec1526eaf2594c0d247fc5
[reactos.git] / reactos / dll / win32 / mmdrv / mmddk.h
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 typedef VOID (TASKCALLBACK) (DWORD dwInst);
33
34 typedef TASKCALLBACK FAR *LPTASKCALLBACK;
35
36 UINT APIENTRY mmTaskCreate(LPTASKCALLBACK lpfn, HANDLE FAR * lph, DWORD dwInst);
37 VOID APIENTRY mmTaskBlock(DWORD h);
38 BOOL APIENTRY mmTaskSignal(DWORD h);
39 VOID APIENTRY mmTaskYield(VOID);
40 DWORD APIENTRY mmGetCurrentTask(VOID);
41
42
43 #define MAX_MIDIINDRV (16)
44 /* For now I'm making 16 the maximum number of midi devices one can
45 * have. This should be more than enough for everybody. But as a purist,
46 * I intend to make it unbounded in the future, as soon as I figure
47 * a good way to do so.
48 */
49 #define MAX_MIDIOUTDRV (16)
50
51 /* ==================================
52 * Multimedia DDK compatible part
53 * ================================== */
54
55 #include <pshpack1.h>
56
57 #define DRVM_INIT 100
58 #define DRVM_EXIT 101
59 #define DRVM_DISABLE 102
60 #define DRVM_ENABLE 103
61
62 /* messages that have IOCTL format
63 * dw1 = NULL or handle
64 * dw2 = NULL or ptr to DRVM_IOCTL_DATA
65 * return is MMRESULT
66 */
67 #define DRVM_IOCTL 0x100
68 #define DRVM_ADD_THRU (DRVM_IOCTL+1)
69 #define DRVM_REMOVE_THRU (DRVM_IOCTL+2)
70 #define DRVM_IOCTL_LAST (DRVM_IOCTL+5)
71 typedef struct {
72 DWORD dwSize; /* size of this structure */
73 DWORD dwCmd; /* IOCTL command code, 0x80000000 and above reserved for system */
74 } DRVM_IOCTL_DATA, *LPDRVM_IOCTL_DATA;
75
76 /* command code ranges for dwCmd field of DRVM_IOCTL message
77 * - codes from 0 to 0x7FFFFFFF are user defined
78 * - codes from 0x80000000 to 0xFFFFFFFF are reserved for future definition by microsoft
79 */
80 #define DRVM_IOCTL_CMD_USER 0x00000000L
81 #define DRVM_IOCTL_CMD_SYSTEM 0x80000000L
82
83 #define DRVM_MAPPER 0x2000
84 #define DRVM_USER 0x4000
85 #define DRVM_MAPPER_STATUS (DRVM_MAPPER+0)
86 #define DRVM_MAPPER_RECONFIGURE (DRVM_MAPPER+1)
87 #define DRVM_MAPPER_PREFERRED_GET (DRVM_MAPPER+21)
88 #define DRVM_MAPPER_CONSOLEVOICECOM_GET (DRVM_MAPPER+23)
89
90 #define DRV_QUERYDRVENTRY (DRV_RESERVED + 1)
91 #define DRV_QUERYDEVNODE (DRV_RESERVED + 2)
92 #define DRV_QUERYNAME (DRV_RESERVED + 3)
93 #define DRV_QUERYDRIVERIDS (DRV_RESERVED + 4)
94 #define DRV_QUERYMAPPABLE (DRV_RESERVED + 5)
95 #define DRV_QUERYMODULE (DRV_RESERVED + 9)
96 #define DRV_PNPINSTALL (DRV_RESERVED + 11)
97 #define DRV_QUERYDEVICEINTERFACE (DRV_RESERVED + 12)
98 #define DRV_QUERYDEVICEINTERFACESIZE (DRV_RESERVED + 13)
99 #define DRV_QUERYSTRINGID (DRV_RESERVED + 14)
100 #define DRV_QUERYSTRINGIDSIZE (DRV_RESERVED + 15)
101 #define DRV_QUERYIDFROMSTRINGID (DRV_RESERVED + 16)
102 #ifdef __WINESRC__
103 #define DRV_QUERYDSOUNDIFACE (DRV_RESERVED + 20)
104 #define DRV_QUERYDSOUNDDESC (DRV_RESERVED + 21)
105 #define DRV_QUERYDSOUNDGUID (DRV_RESERVED + 22)
106 #endif
107
108 #define WODM_INIT DRVM_INIT
109 #define WODM_GETNUMDEVS 3
110 #define WODM_GETDEVCAPS 4
111 #define WODM_OPEN 5
112 #define WODM_CLOSE 6
113 #define WODM_PREPARE 7
114 #define WODM_UNPREPARE 8
115 #define WODM_WRITE 9
116 #define WODM_PAUSE 10
117 #define WODM_RESTART 11
118 #define WODM_RESET 12
119 #define WODM_GETPOS 13
120 #define WODM_GETPITCH 14
121 #define WODM_SETPITCH 15
122 #define WODM_GETVOLUME 16
123 #define WODM_SETVOLUME 17
124 #define WODM_GETPLAYBACKRATE 18
125 #define WODM_SETPLAYBACKRATE 19
126 #define WODM_BREAKLOOP 20
127 #define WODM_PREFERRED 21
128
129 #define WODM_MAPPER_STATUS (DRVM_MAPPER_STATUS + 0)
130 #define WAVEOUT_MAPPER_STATUS_DEVICE 0
131 #define WAVEOUT_MAPPER_STATUS_MAPPED 1
132 #define WAVEOUT_MAPPER_STATUS_FORMAT 2
133
134 #define WODM_BUSY 21
135
136 #define WIDM_INIT DRVM_INIT
137 #define WIDM_GETNUMDEVS 50
138 #define WIDM_GETDEVCAPS 51
139 #define WIDM_OPEN 52
140 #define WIDM_CLOSE 53
141 #define WIDM_PREPARE 54
142 #define WIDM_UNPREPARE 55
143 #define WIDM_ADDBUFFER 56
144 #define WIDM_START 57
145 #define WIDM_STOP 58
146 #define WIDM_RESET 59
147 #define WIDM_GETPOS 60
148 #define WIDM_PREFERRED 61
149 #define WIDM_MAPPER_STATUS (DRVM_MAPPER_STATUS + 0)
150 #define WAVEIN_MAPPER_STATUS_DEVICE 0
151 #define WAVEIN_MAPPER_STATUS_MAPPED 1
152 #define WAVEIN_MAPPER_STATUS_FORMAT 2
153
154 #define MODM_INIT DRVM_INIT
155 #define MODM_GETNUMDEVS 1
156 #define MODM_GETDEVCAPS 2
157 #define MODM_OPEN 3
158 #define MODM_CLOSE 4
159 #define MODM_PREPARE 5
160 #define MODM_UNPREPARE 6
161 #define MODM_DATA 7
162 #define MODM_LONGDATA 8
163 #define MODM_RESET 9
164 #define MODM_GETVOLUME 10
165 #define MODM_SETVOLUME 11
166 #define MODM_CACHEPATCHES 12
167 #define MODM_CACHEDRUMPATCHES 13
168
169 #define MIDM_INIT DRVM_INIT
170 #define MIDM_GETNUMDEVS 53
171 #define MIDM_GETDEVCAPS 54
172 #define MIDM_OPEN 55
173 #define MIDM_CLOSE 56
174 #define MIDM_PREPARE 57
175 #define MIDM_UNPREPARE 58
176 #define MIDM_ADDBUFFER 59
177 #define MIDM_START 60
178 #define MIDM_STOP 61
179 #define MIDM_RESET 62
180
181
182 #define AUXM_INIT DRVM_INIT
183 #define AUXDM_GETNUMDEVS 3
184 #define AUXDM_GETDEVCAPS 4
185 #define AUXDM_GETVOLUME 5
186 #define AUXDM_SETVOLUME 6
187
188 #define MXDM_INIT DRVM_INIT
189 #define MXDM_USER DRVM_USER
190 #define MXDM_MAPPER DRVM_MAPPER
191
192 #define MXDM_GETNUMDEVS 1
193 #define MXDM_GETDEVCAPS 2
194 #define MXDM_OPEN 3
195 #define MXDM_CLOSE 4
196 #define MXDM_GETLINEINFO 5
197 #define MXDM_GETLINECONTROLS 6
198 #define MXDM_GETCONTROLDETAILS 7
199 #define MXDM_SETCONTROLDETAILS 8
200
201 /* pre-defined joystick types */
202 #define JOY_HW_NONE 0
203 #define JOY_HW_CUSTOM 1
204 #define JOY_HW_2A_2B_GENERIC 2
205 #define JOY_HW_2A_4B_GENERIC 3
206 #define JOY_HW_2B_GAMEPAD 4
207 #define JOY_HW_2B_FLIGHTYOKE 5
208 #define JOY_HW_2B_FLIGHTYOKETHROTTLE 6
209 #define JOY_HW_3A_2B_GENERIC 7
210 #define JOY_HW_3A_4B_GENERIC 8
211 #define JOY_HW_4B_GAMEPAD 9
212 #define JOY_HW_4B_FLIGHTYOKE 10
213 #define JOY_HW_4B_FLIGHTYOKETHROTTLE 11
214 #define JOY_HW_LASTENTRY 12
215
216 /* calibration flags */
217 #define JOY_ISCAL_XY 0x00000001l /* XY are calibrated */
218 #define JOY_ISCAL_Z 0x00000002l /* Z is calibrated */
219 #define JOY_ISCAL_R 0x00000004l /* R is calibrated */
220 #define JOY_ISCAL_U 0x00000008l /* U is calibrated */
221 #define JOY_ISCAL_V 0x00000010l /* V is calibrated */
222 #define JOY_ISCAL_POV 0x00000020l /* POV is calibrated */
223
224 /* point of view constants */
225 #define JOY_POV_NUMDIRS 4
226 #define JOY_POVVAL_FORWARD 0
227 #define JOY_POVVAL_BACKWARD 1
228 #define JOY_POVVAL_LEFT 2
229 #define JOY_POVVAL_RIGHT 3
230
231 /* Specific settings for joystick hardware */
232 #define JOY_HWS_HASZ 0x00000001l /* has Z info? */
233 #define JOY_HWS_HASPOV 0x00000002l /* point of view hat present */
234 #define JOY_HWS_POVISBUTTONCOMBOS 0x00000004l /* pov done through combo of buttons */
235 #define JOY_HWS_POVISPOLL 0x00000008l /* pov done through polling */
236 #define JOY_HWS_ISYOKE 0x00000010l /* joystick is a flight yoke */
237 #define JOY_HWS_ISGAMEPAD 0x00000020l /* joystick is a game pad */
238 #define JOY_HWS_ISCARCTRL 0x00000040l /* joystick is a car controller */
239 /* X defaults to J1 X axis */
240 #define JOY_HWS_XISJ1Y 0x00000080l /* X is on J1 Y axis */
241 #define JOY_HWS_XISJ2X 0x00000100l /* X is on J2 X axis */
242 #define JOY_HWS_XISJ2Y 0x00000200l /* X is on J2 Y axis */
243 /* Y defaults to J1 Y axis */
244 #define JOY_HWS_YISJ1X 0x00000400l /* Y is on J1 X axis */
245 #define JOY_HWS_YISJ2X 0x00000800l /* Y is on J2 X axis */
246 #define JOY_HWS_YISJ2Y 0x00001000l /* Y is on J2 Y axis */
247 /* Z defaults to J2 Y axis */
248 #define JOY_HWS_ZISJ1X 0x00002000l /* Z is on J1 X axis */
249 #define JOY_HWS_ZISJ1Y 0x00004000l /* Z is on J1 Y axis */
250 #define JOY_HWS_ZISJ2X 0x00008000l /* Z is on J2 X axis */
251 /* POV defaults to J2 Y axis, if it is not button based */
252 #define JOY_HWS_POVISJ1X 0x00010000l /* pov done through J1 X axis */
253 #define JOY_HWS_POVISJ1Y 0x00020000l /* pov done through J1 Y axis */
254 #define JOY_HWS_POVISJ2X 0x00040000l /* pov done through J2 X axis */
255 /* R defaults to J2 X axis */
256 #define JOY_HWS_HASR 0x00080000l /* has R (4th axis) info */
257 #define JOY_HWS_RISJ1X 0x00100000l /* R done through J1 X axis */
258 #define JOY_HWS_RISJ1Y 0x00200000l /* R done through J1 Y axis */
259 #define JOY_HWS_RISJ2Y 0x00400000l /* R done through J2 X axis */
260 /* U & V for future hardware */
261 #define JOY_HWS_HASU 0x00800000l /* has U (5th axis) info */
262 #define JOY_HWS_HASV 0x01000000l /* has V (6th axis) info */
263
264 /* Usage settings */
265 #define JOY_US_HASRUDDER 0x00000001l /* joystick configured with rudder */
266 #define JOY_US_PRESENT 0x00000002l /* is joystick actually present? */
267 #define JOY_US_ISOEM 0x00000004l /* joystick is an OEM defined type */
268
269
270 /* struct for storing x,y, z, and rudder values */
271 typedef struct joypos_tag {
272 DWORD dwX;
273 DWORD dwY;
274 DWORD dwZ;
275 DWORD dwR;
276 DWORD dwU;
277 DWORD dwV;
278 } JOYPOS, *LPJOYPOS;
279
280 /* struct for storing ranges */
281 typedef struct joyrange_tag {
282 JOYPOS jpMin;
283 JOYPOS jpMax;
284 JOYPOS jpCenter;
285 } JOYRANGE,*LPJOYRANGE;
286
287 typedef struct joyreguservalues_tag {
288 DWORD dwTimeOut; /* value at which to timeout joystick polling */
289 JOYRANGE jrvRanges; /* range of values app wants returned for axes */
290 JOYPOS jpDeadZone; /* area around center to be considered
291 as "dead". specified as a percentage
292 (0-100). Only X & Y handled by system driver */
293 } JOYREGUSERVALUES, *LPJOYREGUSERVALUES;
294
295 typedef struct joyreghwsettings_tag {
296 DWORD dwFlags;
297 DWORD dwNumButtons; /* number of buttons */
298 } JOYREGHWSETTINGS, *LPJOYHWSETTINGS;
299
300 /* range of values returned by the hardware (filled in by calibration) */
301 typedef struct joyreghwvalues_tag {
302 JOYRANGE jrvHardware; /* values returned by hardware */
303 DWORD dwPOVValues[JOY_POV_NUMDIRS];/* POV values returned by hardware */
304 DWORD dwCalFlags; /* what has been calibrated */
305 } JOYREGHWVALUES, *LPJOYREGHWVALUES;
306
307 /* hardware configuration */
308 typedef struct joyreghwconfig_tag {
309 JOYREGHWSETTINGS hws; /* hardware settings */
310 DWORD dwUsageSettings;/* usage settings */
311 JOYREGHWVALUES hwv; /* values returned by hardware */
312 DWORD dwType; /* type of joystick */
313 DWORD dwReserved; /* reserved for OEM drivers */
314 } JOYREGHWCONFIG, *LPJOYREGHWCONFIG;
315
316 /* joystick calibration info structure */
317 typedef struct joycalibrate_tag {
318 UINT wXbase;
319 UINT wXdelta;
320 UINT wYbase;
321 UINT wYdelta;
322 UINT wZbase;
323 UINT wZdelta;
324 } JOYCALIBRATE;
325 typedef JOYCALIBRATE *LPJOYCALIBRATE;
326
327 /* prototype for joystick message function */
328 typedef UINT (CALLBACK * JOYDEVMSGPROC)(DWORD dwID, UINT uMessage, LPARAM lParam1, LPARAM lParam2);
329 typedef JOYDEVMSGPROC *LPJOYDEVMSGPROC;
330
331 /* messages sent to joystick driver's DriverProc() function */
332 #define JDD_GETNUMDEVS (DRV_RESERVED + 0x0001)
333 #define JDD_GETDEVCAPS (DRV_RESERVED + 0x0002)
334 #define JDD_GETPOS (DRV_RESERVED + 0x0101)
335 #define JDD_SETCALIBRATION (DRV_RESERVED + 0x0102)
336 #define JDD_CONFIGCHANGED (DRV_RESERVED + 0x0103)
337 #define JDD_GETPOSEX (DRV_RESERVED + 0x0104)
338
339 #define MCI_MAX_DEVICE_TYPE_LENGTH 80
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
389 #define MAKEMCIRESOURCE(wRet, wRes) MAKELRESULT((wRet), (wRes))
390
391 typedef struct {
392 DWORD dwCallback;
393 DWORD dwInstance;
394 HMIDIOUT hMidi;
395 DWORD dwFlags;
396 } PORTALLOC, *LPPORTALLOC;
397
398 typedef struct {
399 HWAVE hWave;
400 LPWAVEFORMATEX lpFormat;
401 DWORD dwCallback;
402 DWORD dwInstance;
403 UINT uMappedDeviceID;
404 DWORD dnDevNode;
405 } WAVEOPENDESC, *LPWAVEOPENDESC;
406
407 typedef struct {
408 DWORD dwStreamID;
409 WORD wDeviceID;
410 } MIDIOPENSTRMID;
411
412 typedef struct {
413 HMIDI hMidi;
414 DWORD dwCallback;
415 DWORD dwInstance;
416 DWORD dnDevNode;
417 DWORD cIds;
418 MIDIOPENSTRMID rgIds;
419 } MIDIOPENDESC, *LPMIDIOPENDESC;
420
421 typedef struct tMIXEROPENDESC
422 {
423 HMIXEROBJ hmx;
424 LPVOID pReserved0;
425 DWORD dwCallback;
426 DWORD dwInstance;
427 } MIXEROPENDESC, *LPMIXEROPENDESC;
428
429 typedef struct {
430 UINT wDeviceID; /* device ID */
431 LPSTR lpstrParams; /* parameter string for entry in SYSTEM.INI */
432 UINT wCustomCommandTable; /* custom command table (0xFFFF if none) * filled in by the driver */
433 UINT wType; /* driver type (filled in by the driver) */
434 } MCI_OPEN_DRIVER_PARMSA, *LPMCI_OPEN_DRIVER_PARMSA;
435
436 typedef struct {
437 UINT wDeviceID; /* device ID */
438 LPWSTR lpstrParams; /* parameter string for entry in SYSTEM.INI */
439 UINT wCustomCommandTable; /* custom command table (0xFFFF if none) * filled in by the driver */
440 UINT wType; /* driver type (filled in by the driver) */
441 } MCI_OPEN_DRIVER_PARMSW, *LPMCI_OPEN_DRIVER_PARMSW;
442 //DECL_WINELIB_TYPE_AW(MCI_OPEN_DRIVER_PARMS)
443 //DECL_WINELIB_TYPE_AW(LPMCI_OPEN_DRIVER_PARMS)
444
445 DWORD WINAPI mciGetDriverData(UINT uDeviceID);
446 BOOL WINAPI mciSetDriverData(UINT uDeviceID, DWORD dwData);
447 UINT WINAPI mciDriverYield(UINT uDeviceID);
448 BOOL WINAPI mciDriverNotify(HWND hwndCallback, UINT uDeviceID,
449 UINT uStatus);
450 UINT WINAPI mciLoadCommandResource(HINSTANCE hInstance,
451 LPCWSTR lpResName, UINT uType);
452 BOOL WINAPI mciFreeCommandResource(UINT uTable);
453
454 #define DCB_NULL 0x0000
455 #define DCB_WINDOW 0x0001 /* dwCallback is a HWND */
456 #define DCB_TASK 0x0002 /* dwCallback is a HTASK */
457 #define DCB_FUNCTION 0x0003 /* dwCallback is a FARPROC */
458 #define DCB_EVENT 0x0005 /* dwCallback is an EVENT Handler */
459 #define DCB_TYPEMASK 0x0007
460 #define DCB_NOSWITCH 0x0008 /* don't switch stacks for callback */
461
462 BOOL WINAPI DriverCallback(DWORD dwCallBack, UINT uFlags, HDRVR hDev,
463 UINT wMsg, DWORD dwUser, DWORD dwParam1, DWORD dwParam2);
464
465 #ifdef __WINESRC__
466 #define WAVE_DIRECTSOUND 0x0080
467 #endif
468
469 #include <poppack.h>
470
471 #endif /* __MMDDK_H */