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