dlls/winmm/winemm.h

   1 /*
   2  * Copyright 1998, Luiz Otavio L. Zorzella
   3  *           1999, Eric Pouech
   4  *
   5  * Purpose:   multimedia declarations (internal to WINMM & MMSYSTEM DLLs)
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include <stdarg.h>
  23
  24 #include "windef.h"
  25 #include "winbase.h"
  26 #include "mmddk.h"
  27
  28 #define WINE_DEFAULT_WINMM_DRIVER     "alsa,oss,coreaudio"
  29 #define WINE_DEFAULT_WINMM_MAPPER     "msacm32.drv"
  30 #define WINE_DEFAULT_WINMM_MIDI       "midimap.dll"
  31
  32 typedef enum {
  33     WINMM_MAP_NOMEM,    /* ko, memory problem */
  34     WINMM_MAP_MSGERROR, /* ko, unknown message */
  35     WINMM_MAP_OK,       /* ok, no memory allocated. to be sent to the proc. */
  36     WINMM_MAP_OKMEM,    /* ok, some memory allocated, need to call UnMapMsg. to be sent to the proc. */
  37 } WINMM_MapType;
  38
  39 /* Who said goofy boy ? */
  40 #define WINE_DI_MAGIC   0x900F1B01
  41
  42 typedef struct tagWINE_DRIVER
  43 {
  44     DWORD                       dwMagic;
  45     /* as usual LPWINE_DRIVER == hDriver32 */
  46     DWORD                       dwFlags;
  47     union {
  48         struct {
  49             HMODULE                     hModule;
  50             DRIVERPROC                  lpDrvProc;
  51             DWORD_PTR                   dwDriverID;
  52         } d32;
  53         struct {
  54             UINT16                      hDriver16;
  55         } d16;
  56     } d;
  57     struct tagWINE_DRIVER*      lpPrevItem;
  58     struct tagWINE_DRIVER*      lpNextItem;
  59 } WINE_DRIVER, *LPWINE_DRIVER;
  60
  61 typedef DWORD   (CALLBACK *WINEMM_msgFunc16)(UINT16, WORD, DWORD, DWORD, DWORD);
  62 typedef DWORD   (CALLBACK *WINEMM_msgFunc32)(UINT  , UINT, DWORD, DWORD, DWORD);
  63
  64 /* for each loaded driver and each known type of driver, this structure contains
  65  * the information needed to access it
  66  */
  67 typedef struct tagWINE_MM_DRIVER_PART {
  68     int                         nIDMin;         /* lower bound of global indexes for this type */
  69     int                         nIDMax;         /* hhigher bound of global indexes for this type */
  70     union {
  71         WINEMM_msgFunc32        fnMessage32;    /* pointer to function */
  72         WINEMM_msgFunc16        fnMessage16;
  73     } u;
  74 } WINE_MM_DRIVER_PART;
  75
  76 #define MMDRV_AUX               0
  77 #define MMDRV_MIXER             1
  78 #define MMDRV_MIDIIN            2
  79 #define MMDRV_MIDIOUT           3
  80 #define MMDRV_WAVEIN            4
  81 #define MMDRV_WAVEOUT           5
  82 #define MMDRV_MAX               6
  83
  84 /* each low-level .drv will be associated with an instance of this structure */
  85 typedef struct tagWINE_MM_DRIVER {
  86     HDRVR                       hDriver;
  87     LPSTR                       drvname;        /* name of the driver */
  88     unsigned                    bIs32 : 1,      /* TRUE if 32 bit driver, FALSE for 16 */
  89                                 bIsMapper : 1;  /* TRUE if mapper */
  90     WINE_MM_DRIVER_PART         parts[MMDRV_MAX];/* Information for all known types */
  91 } WINE_MM_DRIVER, *LPWINE_MM_DRIVER;
  92
  93 typedef struct tagWINE_MLD {
  94 /* EPP struct tagWINE_MLD*      lpNext; */              /* not used so far */
  95        UINT                     uDeviceID;
  96        UINT                     type;
  97        UINT                     mmdIndex;               /* index to low-level driver in MMDrvs table */
  98        DWORD                    dwDriverInstance;       /* this value is driver related, as opposed to
  99                                                          * opendesc.dwInstance which is client (callback) related */
 100        WORD                     bFrom32;
 101        WORD                     dwFlags;
 102        DWORD_PTR                dwCallback;
 103        DWORD_PTR                dwClientInstance;
 104 } WINE_MLD, *LPWINE_MLD;
 105
 106 typedef struct  {
 107        WINE_MLD                 mld;
 108 } WINE_WAVE, *LPWINE_WAVE;
 109
 110 typedef struct {
 111        WINE_MLD                 mld;
 112        MIDIOPENDESC             mod;                    /* FIXME: should be removed */
 113 } WINE_MIDI, *LPWINE_MIDI;
 114
 115 typedef struct {
 116        WINE_MLD                 mld;
 117 } WINE_MIXER, *LPWINE_MIXER;
 118
 119 #define WINE_MMTHREAD_CREATED   0x4153494C      /* "BSIL" */
 120 #define WINE_MMTHREAD_DELETED   0xDEADDEAD
 121
 122 typedef struct {
 123        DWORD                    dwSignature;            /* 00 "BSIL" when ok, 0xDEADDEAD when being deleted */
 124        DWORD                    dwCounter;              /* 04 > 1 when in mmThread functions */
 125        HANDLE                   hThread;                /* 08 hThread */
 126        DWORD                    dwThreadID;             /* 0C */
 127        DWORD                    fpThread;               /* 10 address of thread proc (segptr or lin depending on dwFlags) */
 128        DWORD                    dwThreadPmt;            /* 14 parameter to be passed upon thread creation to fpThread */
 129        LONG                     dwSignalCount;          /* 18 counter used for signaling */
 130        HANDLE                   hEvent;                 /* 1C event */
 131        HANDLE                   hVxD;                   /* 20 return from OpenVxDHandle */
 132        DWORD                    dwStatus;               /* 24 0x00, 0x10, 0x20, 0x30 */
 133        DWORD                    dwFlags;                /* 28 dwFlags upon creation */
 134        UINT16                   hTask;                  /* 2C handle to created task */
 135 } WINE_MMTHREAD;
 136
 137 typedef struct tagWINE_MCIDRIVER {
 138         UINT                    wDeviceID;
 139         UINT                    wType;
 140         LPWSTR                  lpstrElementName;
 141         LPWSTR                  lpstrDeviceType;
 142         LPWSTR                  lpstrAlias;
 143         HDRVR                   hDriver;
 144         DWORD                   dwPrivate;
 145         YIELDPROC               lpfnYieldProc;
 146         DWORD                   dwYieldData;
 147         BOOL                    bIs32;
 148         DWORD                   CreatorThread;
 149         UINT                    uTypeCmdTable;
 150         UINT                    uSpecificCmdTable;
 151         struct tagWINE_MCIDRIVER*lpNext;
 152 } WINE_MCIDRIVER, *LPWINE_MCIDRIVER;
 153
 154 #define WINE_TIMER_IS32 0x80
 155
 156 enum mmioProcType {MMIO_PROC_16,MMIO_PROC_32A,MMIO_PROC_32W};
 157
 158 struct IOProcList
 159 {
 160     struct IOProcList*pNext;       /* Next item in linked list */
 161     FOURCC            fourCC;      /* four-character code identifying IOProc */
 162     LPMMIOPROC        pIOProc;     /* pointer to IProc */
 163     enum mmioProcType type;        /* 16, 32A or 32W */
 164     int               count;       /* number of objects linked to it */
 165 };
 166
 167 typedef struct tagWINE_MMIO {
 168     MMIOINFO                    info;
 169     struct tagWINE_MMIO*        lpNext;
 170     struct IOProcList*          ioProc;
 171     unsigned                    bTmpIOProc : 1,
 172                                 bBufferLoaded : 1;
 173     DWORD                       segBuffer16;
 174     DWORD                       dwFileSize;
 175 } WINE_MMIO, *LPWINE_MMIO;
 176
 177 /* function prototypes */
 178
 179 typedef LONG                    (*MCIPROC)(DWORD, HDRVR, DWORD, DWORD, DWORD);
 180 typedef WINMM_MapType           (*MMDRV_MAPFUNC)(UINT wMsg, LPDWORD lpdwUser, DWORD_PTR* lpParam1, DWORD_PTR* lpParam2);
 181 typedef WINMM_MapType           (*MMDRV_UNMAPFUNC)(UINT wMsg, LPDWORD lpdwUser, DWORD_PTR* lpParam1, DWORD_PTR* lpParam2, MMRESULT ret);
 182
 183 LPWINE_DRIVER   DRIVER_FindFromHDrvr(HDRVR hDrvr);
 184 BOOL            DRIVER_GetLibName(LPCWSTR keyName, LPCWSTR sectName, LPWSTR buf, int sz);
 185 LPWINE_DRIVER   DRIVER_TryOpenDriver32(LPCWSTR fn, LPARAM lParam2);
 186 void            DRIVER_UnloadAll(void);
 187
 188 BOOL            MMDRV_Init(void);
 189 void            MMDRV_Exit(void);
 190 UINT            MMDRV_GetNum(UINT);
 191 LPWINE_MLD      MMDRV_Alloc(UINT size, UINT type, LPHANDLE hndl, DWORD* dwFlags,
 192                             DWORD_PTR* dwCallback, DWORD_PTR* dwInstance, BOOL bFrom32);
 193 void            MMDRV_Free(HANDLE hndl, LPWINE_MLD mld);
 194 DWORD           MMDRV_Open(LPWINE_MLD mld, UINT wMsg, DWORD dwParam1, DWORD dwParam2);
 195 DWORD           MMDRV_Close(LPWINE_MLD mld, UINT wMsg);
 196 LPWINE_MLD      MMDRV_Get(HANDLE hndl, UINT type, BOOL bCanBeID);
 197 LPWINE_MLD      MMDRV_GetRelated(HANDLE hndl, UINT srcType, BOOL bSrcCanBeID, UINT dstTyped);
 198 DWORD           MMDRV_Message(LPWINE_MLD mld, UINT wMsg, DWORD_PTR dwParam1, DWORD_PTR dwParam2, BOOL bFrom32);
 199 UINT            MMDRV_PhysicalFeatures(LPWINE_MLD mld, UINT uMsg, DWORD dwParam1, DWORD dwParam2);
 200 BOOL            MMDRV_Is32(unsigned int);
 201 void            MMDRV_InstallMap(unsigned int, MMDRV_MAPFUNC, MMDRV_UNMAPFUNC,
 202                                  MMDRV_MAPFUNC, MMDRV_UNMAPFUNC, LPDRVCALLBACK);
 203
 204 WINE_MCIDRIVER* MCI_GetDriver(UINT16 uDevID);
 205 UINT            MCI_GetDriverFromString(LPCWSTR str);
 206 DWORD           MCI_WriteString(LPWSTR lpDstStr, DWORD dstSize, LPCWSTR lpSrcStr);
 207 const char*     MCI_MessageToString(UINT wMsg);
 208 UINT    WINAPI  MCI_DefYieldProc(MCIDEVICEID wDevID, DWORD data);
 209 LRESULT         MCI_CleanUp(LRESULT dwRet, UINT wMsg, DWORD dwParam2);
 210 DWORD           MCI_SendCommand(UINT wDevID, UINT16 wMsg, DWORD_PTR dwParam1, DWORD_PTR dwParam2, BOOL bFrom32);
 211 DWORD           MCI_SendCommandFrom32(UINT wDevID, UINT16 wMsg, DWORD_PTR dwParam1, DWORD_PTR dwParam2);
 212 DWORD           MCI_SendCommandFrom16(UINT wDevID, UINT16 wMsg, DWORD_PTR dwParam1, DWORD_PTR dwParam2);
 213 UINT            MCI_SetCommandTable(void *table, UINT uDevType);
 214 BOOL            MCI_DeleteCommandTable(UINT uTbl, BOOL delete);
 215 LPWSTR          MCI_strdupAtoW(LPCSTR str);
 216 LPSTR           MCI_strdupWtoA(LPCWSTR str);
 217
 218 BOOL            WINMM_CheckForMMSystem(void);
 219 const char*     WINMM_ErrorToString(MMRESULT error);
 220
 221 UINT            MIXER_Open(LPHMIXER lphMix, UINT uDeviceID, DWORD_PTR dwCallback,
 222                            DWORD_PTR dwInstance, DWORD fdwOpen, BOOL bFrom32);
 223 UINT            MIDI_OutOpen(HMIDIOUT* lphMidiOut, UINT uDeviceID, DWORD_PTR dwCallback,
 224                              DWORD_PTR dwInstance, DWORD dwFlags, BOOL bFrom32);
 225 UINT            MIDI_InOpen(HMIDIIN* lphMidiIn, UINT uDeviceID, DWORD_PTR dwCallback,
 226                             DWORD_PTR dwInstance, DWORD dwFlags, BOOL bFrom32);
 227 MMRESULT        MIDI_StreamOpen(HMIDISTRM* lphMidiStrm, LPUINT lpuDeviceID,
 228                                 DWORD cMidi, DWORD_PTR dwCallback,
 229                                 DWORD_PTR dwInstance, DWORD fdwOpen, BOOL bFrom32);
 230 UINT            WAVE_Open(HANDLE* lphndl, UINT uDeviceID, UINT uType,
 231                           LPCWAVEFORMATEX lpFormat, DWORD_PTR dwCallback,
 232                           DWORD_PTR dwInstance, DWORD dwFlags, BOOL bFrom32);
 233
 234 HMMIO           MMIO_Open(LPSTR szFileName, MMIOINFO* refmminfo,
 235                           DWORD dwOpenFlags, enum mmioProcType type);
 236 LPMMIOPROC      MMIO_InstallIOProc(FOURCC fccIOProc, LPMMIOPROC pIOProc,
 237                                    DWORD dwFlags, enum mmioProcType type);
 238 LRESULT         MMIO_SendMessage(HMMIO hmmio, UINT uMessage, LPARAM lParam1,
 239                                  LPARAM lParam2, enum mmioProcType type);
 240 LPWINE_MMIO     MMIO_Get(HMMIO h);
 241
 242 WORD            TIME_SetEventInternal(UINT wDelay, UINT wResol, LPTIMECALLBACK lpFunc,
 243                                       DWORD dwUser, UINT wFlags);
 244 void            TIME_MMTimeStop(void);
 245
 246 /* Global variables */
 247 extern CRITICAL_SECTION WINMM_cs;
 248 extern HINSTANCE hWinMM32Instance;
 249 extern HANDLE psLastEvent;
 250 extern HANDLE psStopEvent;
 251
 252 /* pointers to 16 bit functions (if sibling MMSYSTEM.DLL is loaded
 253  * NULL otherwise
 254  */
 255 extern  WINE_MMTHREAD*  (*pFnGetMMThread16)(UINT16);
 256 extern  LPWINE_DRIVER   (*pFnOpenDriver16)(LPCWSTR,LPCWSTR,LPARAM);
 257 extern  LRESULT         (*pFnCloseDriver16)(UINT16,LPARAM,LPARAM);
 258 extern  LRESULT         (*pFnSendMessage16)(UINT16,UINT,LPARAM,LPARAM);
 259 extern  WINMM_MapType   (*pFnMciMapMsg16To32W)(WORD,WORD,DWORD,DWORD_PTR*);
 260 extern  WINMM_MapType   (*pFnMciUnMapMsg16To32W)(WORD,WORD,DWORD,DWORD_PTR);
 261 extern  WINMM_MapType   (*pFnMciMapMsg32WTo16)(WORD,WORD,DWORD,DWORD_PTR*);
 262 extern  WINMM_MapType   (*pFnMciUnMapMsg32WTo16)(WORD,WORD,DWORD,DWORD_PTR);
 263 extern  LRESULT         (*pFnCallMMDrvFunc16)(DWORD /* in fact FARPROC16 */,WORD,WORD,LONG,LONG,LONG);
 264 extern  unsigned        (*pFnLoadMMDrvFunc16)(LPCSTR,LPWINE_DRIVER, LPWINE_MM_DRIVER);
 265 extern  LRESULT         (*pFnMmioCallback16)(DWORD,LPMMIOINFO,UINT,LPARAM,LPARAM);
 266 extern  void            (WINAPI *pFnReleaseThunkLock)(DWORD*);
 267 extern  void            (WINAPI *pFnRestoreThunkLock)(DWORD);
 268
 269 /* GetDriverFlags() returned bits is not documented (nor the call itself)
 270  * Here are Wine only definitions of the bits
 271  */
 272 #define WINE_GDF_EXIST          0x80000000
 273 #define WINE_GDF_16BIT          0x10000000
 274 #define WINE_GDF_EXTERNAL_MASK  0xF0000000
 275 #define WINE_GDF_SESSION        0x00000001