Now using the same structs for low-level drivers as Windows do.
[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  * File:      mmddk.h
8  * Purpose:   multimedia declarations (external to WINMM & MMSYSTEM DLLs
9  *                                     for other DLLs (MCI, drivers...))
10  *
11  *****************************************************************************
12  */
13 #ifndef __MMDDK_H 
14 #define __MMDDK_H
15
16 #include "mmsystem.h"
17 #include "winbase.h"
18
19 #define MAX_MIDIINDRV   (16)
20 /* For now I'm making 16 the maximum number of midi devices one can
21  * have. This should be more than enough for everybody. But as a purist,
22  * I intend to make it unbounded in the future, as soon as I figure
23  * a good way to do so.
24  */
25 #define MAX_MIDIOUTDRV  (16)
26
27 /* ================================== 
28  *   Multimedia DDK compatible part
29  * ================================== */
30
31 #include "pshpack1.h"
32
33 #define DRVM_INIT               100
34 #define DRVM_EXIT               101
35 #define DRVM_DISABLE            102
36 #define DRVM_ENABLE             103
37
38 /* messages that have IOCTL format
39  *    dw1 = NULL or handle
40  *    dw2 = NULL or ptr to DRVM_IOCTL_DATA
41  *    return is MMRESULT
42  */
43 #define DRVM_IOCTL              0x100
44 #define DRVM_ADD_THRU           (DRVM_IOCTL+1)
45 #define DRVM_REMOVE_THRU        (DRVM_IOCTL+2)
46 #define DRVM_IOCTL_LAST         (DRVM_IOCTL+5)
47 typedef struct {
48     DWORD  dwSize;      /* size of this structure */
49     DWORD  dwCmd;       /* IOCTL command code, 0x80000000 and above reserved for system */
50 } DRVM_IOCTL_DATA, *LPDRVM_IOCTL_DATA;
51
52 /* command code ranges for dwCmd field of DRVM_IOCTL message
53  * - codes from 0 to 0x7FFFFFFF are user defined
54  * - codes from 0x80000000 to 0xFFFFFFFF are reserved for future definition by microsoft
55  */
56 #define DRVM_IOCTL_CMD_USER   0x00000000L
57 #define DRVM_IOCTL_CMD_SYSTEM 0x80000000L
58
59 #define DRVM_MAPPER             0x2000
60 #define DRVM_USER               0x4000
61 #define DRVM_MAPPER_STATUS      (DRVM_MAPPER+0)
62 #define DRVM_MAPPER_RECONFIGURE (DRVM_MAPPER+1)
63
64 #define WODM_INIT               DRVM_INIT
65 #define WODM_GETNUMDEVS          3
66 #define WODM_GETDEVCAPS          4
67 #define WODM_OPEN                5
68 #define WODM_CLOSE               6
69 #define WODM_PREPARE             7
70 #define WODM_UNPREPARE           8
71 #define WODM_WRITE               9
72 #define WODM_PAUSE              10
73 #define WODM_RESTART            11
74 #define WODM_RESET              12 
75 #define WODM_GETPOS             13
76 #define WODM_GETPITCH           14
77 #define WODM_SETPITCH           15
78 #define WODM_GETVOLUME          16
79 #define WODM_SETVOLUME          17
80 #define WODM_GETPLAYBACKRATE    18
81 #define WODM_SETPLAYBACKRATE    19
82 #define WODM_BREAKLOOP          20
83
84 #define WODM_MAPPER_STATUS      (DRVM_MAPPER_STATUS + 0)
85 #define WAVEOUT_MAPPER_STATUS_DEVICE    0
86 #define WAVEOUT_MAPPER_STATUS_MAPPED    1
87 #define WAVEOUT_MAPPER_STATUS_FORMAT    2
88
89 #define WIDM_INIT               DRVM_INIT
90 #define WIDM_GETNUMDEVS         50
91 #define WIDM_GETDEVCAPS         51
92 #define WIDM_OPEN               52
93 #define WIDM_CLOSE              53
94 #define WIDM_PREPARE            54
95 #define WIDM_UNPREPARE          55
96 #define WIDM_ADDBUFFER          56
97 #define WIDM_START              57
98 #define WIDM_STOP               58
99 #define WIDM_RESET              59
100 #define WIDM_GETPOS             60
101
102 #define WIDM_MAPPER_STATUS      (DRVM_MAPPER_STATUS + 0)
103 #define WAVEIN_MAPPER_STATUS_DEVICE     0
104 #define WAVEIN_MAPPER_STATUS_MAPPED     1
105 #define WAVEIN_MAPPER_STATUS_FORMAT     2
106
107 #define MODM_INIT               DRVM_INIT
108 #define MODM_GETNUMDEVS         1
109 #define MODM_GETDEVCAPS         2
110 #define MODM_OPEN               3
111 #define MODM_CLOSE              4
112 #define MODM_PREPARE            5
113 #define MODM_UNPREPARE          6
114 #define MODM_DATA               7
115 #define MODM_LONGDATA           8
116 #define MODM_RESET              9
117 #define MODM_GETVOLUME          10
118 #define MODM_SETVOLUME          11
119 #define MODM_CACHEPATCHES       12      
120 #define MODM_CACHEDRUMPATCHES   13     
121
122 #define MIDM_INIT               DRVM_INIT
123 #define MIDM_GETNUMDEVS         53
124 #define MIDM_GETDEVCAPS         54
125 #define MIDM_OPEN               55
126 #define MIDM_CLOSE              56
127 #define MIDM_PREPARE            57
128 #define MIDM_UNPREPARE          58
129 #define MIDM_ADDBUFFER          59
130 #define MIDM_START              60
131 #define MIDM_STOP               61
132 #define MIDM_RESET              62
133
134
135 #define AUXM_INIT             DRVM_INIT
136 #define AUXDM_GETNUMDEVS        3
137 #define AUXDM_GETDEVCAPS        4
138 #define AUXDM_GETVOLUME         5
139 #define AUXDM_SETVOLUME         6
140
141 #define MXDM_GETNUMDEVS         1
142 #define MXDM_GETDEVCAPS         2
143 #define MXDM_OPEN               3
144 #define MXDM_CLOSE              4
145 #define MXDM_GETLINEINFO        5
146 #define MXDM_GETLINECONTROLS    6
147 #define MXDM_GETCONTROLDETAILS  7
148 #define MXDM_SETCONTROLDETAILS  8
149
150 #define MCI_MAX_DEVICE_TYPE_LENGTH 80
151
152 #define MCI_FALSE                       (MCI_STRING_OFFSET + 19)
153 #define MCI_TRUE                        (MCI_STRING_OFFSET + 20)
154
155 #define MCI_FORMAT_RETURN_BASE          MCI_FORMAT_MILLISECONDS_S
156 #define MCI_FORMAT_MILLISECONDS_S       (MCI_STRING_OFFSET + 21)
157 #define MCI_FORMAT_HMS_S                (MCI_STRING_OFFSET + 22)
158 #define MCI_FORMAT_MSF_S                (MCI_STRING_OFFSET + 23)
159 #define MCI_FORMAT_FRAMES_S             (MCI_STRING_OFFSET + 24)
160 #define MCI_FORMAT_SMPTE_24_S           (MCI_STRING_OFFSET + 25)
161 #define MCI_FORMAT_SMPTE_25_S           (MCI_STRING_OFFSET + 26)
162 #define MCI_FORMAT_SMPTE_30_S           (MCI_STRING_OFFSET + 27)
163 #define MCI_FORMAT_SMPTE_30DROP_S       (MCI_STRING_OFFSET + 28)
164 #define MCI_FORMAT_BYTES_S              (MCI_STRING_OFFSET + 29)
165 #define MCI_FORMAT_SAMPLES_S            (MCI_STRING_OFFSET + 30)
166 #define MCI_FORMAT_TMSF_S               (MCI_STRING_OFFSET + 31)
167
168 #define MCI_VD_FORMAT_TRACK_S           (MCI_VD_OFFSET + 5)
169
170 #define WAVE_FORMAT_PCM_S               (MCI_WAVE_OFFSET + 0)
171 #define WAVE_MAPPER_S                   (MCI_WAVE_OFFSET + 1)
172
173 #define MCI_SEQ_MAPPER_S                (MCI_SEQ_OFFSET + 5)
174 #define MCI_SEQ_FILE_S                  (MCI_SEQ_OFFSET + 6)
175 #define MCI_SEQ_MIDI_S                  (MCI_SEQ_OFFSET + 7)
176 #define MCI_SEQ_SMPTE_S                 (MCI_SEQ_OFFSET + 8)
177 #define MCI_SEQ_FORMAT_SONGPTR_S        (MCI_SEQ_OFFSET + 9)
178 #define MCI_SEQ_NONE_S                  (MCI_SEQ_OFFSET + 10)
179 #define MIDIMAPPER_S                    (MCI_SEQ_OFFSET + 11)
180
181 #define MCI_RESOURCE_RETURNED       0x00010000  /* resource ID */
182 #define MCI_COLONIZED3_RETURN       0x00020000  /* colonized ID, 3 bytes data */
183 #define MCI_COLONIZED4_RETURN       0x00040000  /* colonized ID, 4 bytes data */
184 #define MCI_INTEGER_RETURNED        0x00080000  /* integer conversion needed */
185 #define MCI_RESOURCE_DRIVER         0x00100000  /* driver owns returned resource */
186
187 #define MCI_NO_COMMAND_TABLE    0xFFFF
188
189 #define MCI_COMMAND_HEAD        0
190 #define MCI_STRING              1
191 #define MCI_INTEGER             2
192 #define MCI_END_COMMAND         3
193 #define MCI_RETURN              4
194 #define MCI_FLAG                5
195 #define MCI_END_COMMAND_LIST    6
196 #define MCI_RECT                7
197 #define MCI_CONSTANT            8
198 #define MCI_END_CONSTANT        9
199
200 #define MAKEMCIRESOURCE(wRet, wRes) MAKELRESULT((wRet), (wRes))
201
202 typedef struct {
203         DWORD                   dwCallback;
204         DWORD                   dwInstance;
205         HMIDIOUT                hMidi;
206         DWORD                   dwFlags;
207 } PORTALLOC16, *LPPORTALLOC16;
208
209 typedef struct {
210         DWORD                   dwCallback;
211         DWORD                   dwInstance;
212         HMIDIOUT                hMidi;
213         DWORD                   dwFlags;
214 } PORTALLOC, *LPPORTALLOC;
215
216 typedef struct {
217         HWAVE16                 hWave;
218         LPWAVEFORMATEX          lpFormat;
219         DWORD                   dwCallback;
220         DWORD                   dwInstance;
221         UINT16                  uMappedDeviceID;
222         DWORD                   dnDevNode;
223 } WAVEOPENDESC16, *LPWAVEOPENDESC16;
224
225 typedef struct {
226         HWAVE                   hWave;
227         LPWAVEFORMATEX          lpFormat;
228         DWORD                   dwCallback;
229         DWORD                   dwInstance;
230         UINT                    uMappedDeviceID;
231         DWORD                   dnDevNode;
232 } WAVEOPENDESC, *LPWAVEOPENDESC;
233
234 typedef struct {
235         DWORD                   dwStreamID;
236         WORD                    wDeviceID;
237 } MIDIOPENSTRMID;
238
239 typedef struct {
240         HMIDI16                 hMidi;
241         DWORD                   dwCallback;
242         DWORD                   dwInstance;
243         UINT16                  reserved;
244         DWORD                   dnDevNode;
245         DWORD                   cIds;
246         MIDIOPENSTRMID          rgIds;
247 } MIDIOPENDESC16, *LPMIDIOPENDESC16;
248
249 typedef struct {
250         HMIDI                   hMidi;
251         DWORD                   dwCallback;
252         DWORD                   dwInstance;
253         DWORD                   dnDevNode;
254         DWORD                   cIds;
255         MIDIOPENSTRMID          rgIds;
256 } MIDIOPENDESC, *LPMIDIOPENDESC;
257
258 #if 0
259 typedef struct {
260         UINT16                  wDelay;
261         UINT16                  wResolution;
262         LPTIMECALLBACK16        lpFunction;
263         DWORD                   dwUser;
264         UINT16                  wFlags;
265 } TIMEREVENT, *LPTIMEREVENT;
266 #endif
267
268 typedef struct tMIXEROPENDESC16
269 {
270         HMIXEROBJ16             hmx;
271         LPVOID                  pReserved0;
272         DWORD                   dwCallback;
273         DWORD                   dwInstance;
274 } MIXEROPENDESC16, *LPMIXEROPENDESC16;
275
276 typedef struct tMIXEROPENDESC
277 {
278         HMIXEROBJ               hmx;
279         LPVOID                  pReserved0;
280         DWORD                   dwCallback;
281         DWORD                   dwInstance;
282 } MIXEROPENDESC, *LPMIXEROPENDESC;
283
284 typedef struct {
285         UINT16                  wDeviceID;              /* device ID */
286         LPSTR                   lpstrParams;            /* parameter string for entry in SYSTEM.INI */
287         UINT16                  wCustomCommandTable;    /* custom command table (0xFFFF if none)
288                                                          * filled in by the driver */
289         UINT16                  wType;                  /* driver type (filled in by the driver) */
290 } MCI_OPEN_DRIVER_PARMS16, *LPMCI_OPEN_DRIVER_PARMS16;
291
292 typedef struct {
293         UINT                    wDeviceID;              /* device ID */
294         LPSTR                   lpstrParams;            /* parameter string for entry in SYSTEM.INI */
295         UINT                    wCustomCommandTable;    /* custom command table (0xFFFF if none) * filled in by the driver */
296         UINT                    wType;                  /* driver type (filled in by the driver) */
297 } MCI_OPEN_DRIVER_PARMSA, *LPMCI_OPEN_DRIVER_PARMSA;
298
299 typedef struct {
300         UINT                    wDeviceID;              /* device ID */
301         LPWSTR                  lpstrParams;            /* parameter string for entry in SYSTEM.INI */
302         UINT                    wCustomCommandTable;    /* custom command table (0xFFFF if none) * filled in by the driver */
303         UINT                    wType;                  /* driver type (filled in by the driver) */
304 } MCI_OPEN_DRIVER_PARMSW, *LPMCI_OPEN_DRIVER_PARMSW;
305 DECL_WINELIB_TYPE_AW(MCI_OPEN_DRIVER_PARMS)
306 DECL_WINELIB_TYPE_AW(LPMCI_OPEN_DRIVER_PARMS)
307
308 DWORD                   WINAPI  mciGetDriverData16(UINT16 uDeviceID);
309 DWORD                   WINAPI  mciGetDriverData(UINT uDeviceID);
310
311 BOOL16                  WINAPI  mciSetDriverData16(UINT16 uDeviceID, DWORD dwData);
312 BOOL                    WINAPI  mciSetDriverData(UINT uDeviceID, DWORD dwData);
313
314 UINT16                  WINAPI  mciDriverYield16(UINT16 uDeviceID);
315 UINT                    WINAPI  mciDriverYield(UINT uDeviceID);
316
317 BOOL16                  WINAPI  mciDriverNotify16(HWND16 hwndCallback, UINT16 uDeviceID,
318                                                   UINT16 uStatus);
319 BOOL                    WINAPI  mciDriverNotify(HWND hwndCallback, UINT uDeviceID,
320                                                 UINT uStatus);
321
322 UINT16                  WINAPI  mciLoadCommandResource16(HINSTANCE16 hInstance,
323                                                  LPCSTR lpResName, UINT16 uType);
324 UINT                    WINAPI  mciLoadCommandResource(HINSTANCE hInstance,
325                                                LPCWSTR lpResName, UINT uType);
326
327 BOOL16                  WINAPI  mciFreeCommandResource16(UINT16 uTable);
328 BOOL                    WINAPI  mciFreeCommandResource(UINT uTable);
329
330 HINSTANCE16             WINAPI  mmTaskCreate16(SEGPTR spProc, HINSTANCE16 *lphMmTask, DWORD dwPmt);
331 void                    WINAPI  mmTaskBlock16(HINSTANCE16 hInst);
332 LRESULT                 WINAPI  mmTaskSignal16(HTASK16 ht);
333 void                    WINAPI  mmTaskYield16(void);
334
335 LRESULT                 WINAPI  mmThreadCreate16(FARPROC16 fpThreadAddr, LPHANDLE lpHndl,
336                                                  DWORD dwPmt, DWORD dwFlags);
337 void                    WINAPI  mmThreadSignal16(HANDLE16 hndl);
338 void                    WINAPI  mmThreadBlock16(HANDLE16 hndl);
339 HANDLE16                WINAPI  mmThreadGetTask16(HANDLE16 hndl);
340 BOOL16                  WINAPI  mmThreadIsValid16(HANDLE16 hndl);
341 BOOL16                  WINAPI  mmThreadIsCurrent16(HANDLE16 hndl);
342
343 #define DCB_NULL                0x0000
344 #define DCB_WINDOW              0x0001                  /* dwCallback is a HWND */
345 #define DCB_TASK                0x0002                  /* dwCallback is a HTASK */
346 #define DCB_FUNCTION            0x0003                  /* dwCallback is a FARPROC */
347 #define DCB_EVENT               0x0005                  /* dwCallback is an EVENT Handler */
348 #define DCB_TYPEMASK            0x0007
349 #define DCB_NOSWITCH            0x0008                  /* don't switch stacks for callback */
350
351 BOOL16                  WINAPI  DriverCallback16(DWORD dwCallBack, UINT16 uFlags, HANDLE16 hDev, 
352                                                  WORD wMsg, DWORD dwUser, DWORD dwParam1, DWORD dwParam2);
353 BOOL                    WINAPI  DriverCallback(DWORD dwCallBack, UINT uFlags, HANDLE hDev, 
354                                                UINT wMsg, DWORD dwUser, DWORD dwParam1, DWORD dwParam2);
355
356 /* FIXME: the Wine builtin MCI drivers still use those winmm internal functions
357  *              remove them ASAP
358  */
359 extern DWORD                    MCI_WriteString(LPSTR lpDstStr, DWORD dstSize, LPCSTR lpSrcStr);
360 extern const char*              MCI_MessageToString(UINT16 wMsg);
361 extern DWORD                    MCI_SendCommandAsync(UINT wDevID, UINT wMsg, DWORD dwParam1, DWORD dwParam2, UINT size);
362
363
364 #include "poppack.h"
365
366 #endif /* __MMDDK_H */
367