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