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