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