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