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