git.oblomov.eu Git - wine/blob - dlls/midimap/midimap.c

   1 /*
   2  * Wine MIDI mapper driver
   3  *
   4  * Copyright    1999, 2000, 2001 Eric Pouech
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * TODO:
  21  *      notification has to be implemented
  22  *      IDF file loading
  23  */
  24
  25 #include <stdarg.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include "windef.h"
  29 #include "winbase.h"
  30 #include "wingdi.h"
  31 #include "winuser.h"
  32 #include "mmddk.h"
  33 #include "winreg.h"
  34 #include "wine/unicode.h"
  35 #include "wine/debug.h"
  36
  37 /*
  38  * Here's how Windows stores the midiOut mapping information.
  39  *
  40  * Full form (in HKU) is:
  41  *
  42  * [Software\\Microsoft\\Windows\\CurrentVersion\\Multimedia\\MIDIMap] 988836060
  43  * "AutoScheme"=dword:00000000
  44  * "ConfigureCount"=dword:00000004
  45  * "CurrentInstrument"="Wine OSS midi"
  46  * "CurrentScheme"="epp"
  47  * "DriverList"=""
  48  * "UseScheme"=dword:00000000
  49  *
  50  * AutoScheme:          ?
  51  * CurrentInstrument:   name of midiOut device to use when UseScheme is 0. Wine uses an extension
  52  *                      of the form #n to link to n'th midiOut device of the system
  53  * CurrentScheme:       when UseScheme is non null, it's the scheme to use (see below)
  54  * DriverList:          ?
  55  * UseScheme:           trigger for simple/complex mapping
  56  *
  57  * A scheme is defined (in HKLM) as:
  58  *
  59  * [System\\CurrentControlSet\\Control\\MediaProperties\\PrivateProperties\\Midi\\Schemes\\<nameScheme>]
  60  * <nameScheme>:        one key for each defined scheme (system wide)
  61  * under each one of these <nameScheme> keys, there's:
  62  * [...\\<nameScheme>\\<idxDevice>]
  63  * "Channels"="<bitMask>"
  64  * (the default value of this key also refers to the name of the device).
  65  *
  66  * this defines, for each midiOut device (identified by its index in <idxDevice>), which
  67  * channels have to be mapped onto it. The <bitMask> defines the channels (from 0 to 15)
  68  * will be mapped (mapping occurs for channel <ch> if bit <ch> is set in <bitMask>
  69  *
  70  * Further mapping information can also be defined in:
  71  * [System\\CurrentControlSet\\Control\\MediaProperties\\PrivateProperties\\Midi\\Ports\\<nameDevice>\\Instruments\\<idx>]
  72  * "Definition"="<.idf file>"
  73  * "FriendlyName"="#for .idx file#"
  74  * "Port"="<idxPort>"
  75  *
  76  * This last part isn't implemented (.idf file support).
  77  */
  78
  79 WINE_DEFAULT_DEBUG_CHANNEL(msacm);
  80
  81 typedef struct tagMIDIOUTPORT
  82 {
  83     WCHAR               name[MAXPNAMELEN];
  84     int                 loaded;
  85     HMIDIOUT            hMidi;
  86     unsigned short      uDevID;
  87     LPBYTE              lpbPatch;
  88     unsigned int        aChn[16];
  89 } MIDIOUTPORT;
  90
  91 typedef struct tagMIDIMAPDATA
  92 {
  93     struct tagMIDIMAPDATA*      self;
  94     MIDIOUTPORT*        ChannelMap[16];
  95 } MIDIMAPDATA;
  96
  97 static  MIDIOUTPORT*    midiOutPorts;
  98 static  unsigned        numMidiOutPorts;
  99
 100 static  BOOL    MIDIMAP_IsBadData(MIDIMAPDATA* mm)
 101 {
 102     if (!IsBadReadPtr(mm, sizeof(MIDIMAPDATA)) && mm->self == mm)
 103         return FALSE;
 104     TRACE("Bad midimap data (%p)\n", mm);
 105     return TRUE;
 106 }
 107
 108 static BOOL     MIDIMAP_FindPort(const WCHAR* name, unsigned* dev)
 109 {
 110     for (*dev = 0; *dev < numMidiOutPorts; (*dev)++)
 111     {
 112         TRACE("%s\n", wine_dbgstr_w(midiOutPorts[*dev].name));
 113         if (strcmpW(midiOutPorts[*dev].name, name) == 0)
 114             return TRUE;
 115     }
 116     /* try the form #nnn */
 117     if (*name == '#' && isdigit(name[1]))
 118     {
 119         const WCHAR*  ptr = name + 1;
 120         *dev = 0;
 121         do
 122         {
 123             *dev = *dev * 10 + *ptr - '0';
 124         } while (isdigit(*++ptr));
 125         if (*dev < numMidiOutPorts)
 126             return TRUE;
 127     }
 128     return FALSE;
 129 }
 130
 131 static BOOL     MIDIMAP_LoadSettingsDefault(MIDIMAPDATA* mom, const WCHAR* port)
 132 {
 133     unsigned i, dev = 0;
 134
 135     if (port != NULL && !MIDIMAP_FindPort(port, &dev))
 136     {
 137         ERR("Registry glitch: couldn't find midi out (%s)\n", wine_dbgstr_w(port));
 138         dev = 0;
 139     }
 140
 141     /* this is necessary when no midi out ports are present */
 142     if (dev >= numMidiOutPorts)
 143         return FALSE;
 144     /* sets default */
 145     for (i = 0; i < 16; i++) mom->ChannelMap[i] = &midiOutPorts[dev];
 146
 147     return TRUE;
 148 }
 149
 150 static BOOL     MIDIMAP_LoadSettingsScheme(MIDIMAPDATA* mom, const WCHAR* scheme)
 151 {
 152     HKEY        hSchemesKey, hKey, hPortKey;
 153     unsigned    i, idx, dev;
 154     WCHAR       buffer[256], port[256];
 155     DWORD       type, size, mask;
 156
 157     for (i = 0; i < 16; i++)    mom->ChannelMap[i] = NULL;
 158
 159     if (RegOpenKeyA(HKEY_LOCAL_MACHINE,
 160                     "System\\CurrentControlSet\\Control\\MediaProperties\\PrivateProperties\\Midi\\Schemes",
 161                     &hSchemesKey))
 162     {
 163         return FALSE;
 164     }
 165     if (RegOpenKeyW(hSchemesKey, scheme, &hKey))
 166     {
 167         RegCloseKey(hSchemesKey);
 168         return FALSE;
 169     }
 170
 171     for (idx = 0; !RegEnumKeyW(hKey, idx, buffer, sizeof(buffer)/sizeof(buffer[0])); idx++)
 172     {
 173         if (RegOpenKeyW(hKey, buffer, &hPortKey)) continue;
 174
 175         size = sizeof(port);
 176         if (RegQueryValueExW(hPortKey, NULL, 0, &type, (void*)port, &size)) continue;
 177
 178         if (!MIDIMAP_FindPort(port, &dev)) continue;
 179
 180         size = sizeof(mask);
 181         if (RegQueryValueExA(hPortKey, "Channels", 0, &type, (void*)&mask, &size))
 182             continue;
 183
 184         for (i = 0; i < 16; i++)
 185         {
 186             if (mask & (1 << i))
 187             {
 188                 if (mom->ChannelMap[i])
 189                     ERR("Quirks in registry, channel %u is mapped twice\n", i);
 190                 mom->ChannelMap[i] = &midiOutPorts[dev];
 191             }
 192         }
 193     }
 194
 195     RegCloseKey(hSchemesKey);
 196     RegCloseKey(hKey);
 197
 198     return TRUE;
 199 }
 200
 201 static BOOL     MIDIMAP_LoadSettings(MIDIMAPDATA* mom)
 202 {
 203     HKEY        hKey;
 204     BOOL        ret;
 205
 206     if (RegOpenKeyA(HKEY_CURRENT_USER,
 207                     "Software\\Microsoft\\Windows\\CurrentVersion\\Multimedia\\MIDIMap", &hKey))
 208     {
 209         ret = MIDIMAP_LoadSettingsDefault(mom, NULL);
 210     }
 211     else
 212     {
 213         DWORD   type, size, out;
 214         WCHAR   buffer[256];
 215
 216         ret = 2;
 217         size = sizeof(out);
 218         if (!RegQueryValueExA(hKey, "UseScheme", 0, &type, (void*)&out, &size) && out)
 219         {
 220             static const WCHAR cs[] = {'C','u','r','r','e','n','t','S','c','h','e','m','e',0};
 221             size = sizeof(buffer);
 222             if (!RegQueryValueExW(hKey, cs, 0, &type, (void*)buffer, &size))
 223             {
 224                 if (!(ret = MIDIMAP_LoadSettingsScheme(mom, buffer)))
 225                     ret = MIDIMAP_LoadSettingsDefault(mom, NULL);
 226             }
 227             else
 228             {
 229                 ERR("Wrong registry: UseScheme is active, but no CurrentScheme found\n");
 230             }
 231         }
 232         if (ret == 2)
 233         {
 234             static const WCHAR ci[] = {'C','u','r','r','e','n','t','I','n','s','t','r','u','m','e','n','t',0};
 235             size = sizeof(buffer);
 236             if (!RegQueryValueExW(hKey, ci, 0, &type, (void*)buffer, &size) && *buffer)
 237             {
 238                 ret = MIDIMAP_LoadSettingsDefault(mom, buffer);
 239             }
 240             else
 241             {
 242                 ret = MIDIMAP_LoadSettingsDefault(mom, NULL);
 243             }
 244         }
 245     }
 246     RegCloseKey(hKey);
 247
 248     if (ret && TRACE_ON(msacm))
 249     {
 250         unsigned        i;
 251
 252         for (i = 0; i < 16; i++)
 253         {
 254             TRACE("chnMap[%2d] => %d\n",
 255                   i, mom->ChannelMap[i] ? mom->ChannelMap[i]->uDevID : -1);
 256         }
 257     }
 258     return ret;
 259 }
 260
 261 static DWORD modOpen(DWORD_PTR *lpdwUser, LPMIDIOPENDESC lpDesc, DWORD dwFlags)
 262 {
 263     MIDIMAPDATA*        mom = HeapAlloc(GetProcessHeap(), 0, sizeof(MIDIMAPDATA));
 264
 265     TRACE("(%p %p %08x)\n", lpdwUser, lpDesc, dwFlags);
 266
 267     if (!mom) return MMSYSERR_NOMEM;
 268
 269     if (HIWORD(dwFlags & CALLBACK_TYPEMASK)) {
 270         FIXME("NIY callback flags %08x\n", dwFlags);
 271         HeapFree(GetProcessHeap(), 0, mom);
 272         return MMSYSERR_INVALFLAG;
 273     }
 274
 275     if (MIDIMAP_LoadSettings(mom))
 276     {
 277         *lpdwUser = (DWORD_PTR)mom;
 278         mom->self = mom;
 279
 280         return MMSYSERR_NOERROR;
 281     }
 282     HeapFree(GetProcessHeap(), 0, mom);
 283     return MIDIERR_INVALIDSETUP;
 284 }
 285
 286 static  DWORD   modClose(MIDIMAPDATA* mom)
 287 {
 288     UINT        i;
 289     DWORD       ret = MMSYSERR_NOERROR;
 290
 291     if (MIDIMAP_IsBadData(mom))         return MMSYSERR_ERROR;
 292
 293     for (i = 0; i < 16; i++)
 294     {
 295         DWORD   t;
 296         if (mom->ChannelMap[i] && mom->ChannelMap[i]->loaded > 0)
 297         {
 298             t = midiOutClose(mom->ChannelMap[i]->hMidi);
 299             if (t == MMSYSERR_NOERROR)
 300             {
 301                 mom->ChannelMap[i]->loaded = 0;
 302                 mom->ChannelMap[i]->hMidi = 0;
 303             }
 304             else if (ret == MMSYSERR_NOERROR)
 305                 ret = t;
 306         }
 307     }
 308     if (ret == MMSYSERR_NOERROR)
 309         HeapFree(GetProcessHeap(), 0, mom);
 310     return ret;
 311 }
 312
 313 static DWORD modLongData(MIDIMAPDATA* mom, LPMIDIHDR lpMidiHdr, DWORD_PTR dwParam2)
 314 {
 315     WORD        chn;
 316     DWORD       ret = MMSYSERR_NOERROR;
 317     MIDIHDR     mh;
 318
 319     if (MIDIMAP_IsBadData(mom))
 320         return MMSYSERR_ERROR;
 321
 322     mh = *lpMidiHdr;
 323     for (chn = 0; chn < 16; chn++)
 324     {
 325         if (mom->ChannelMap[chn] && mom->ChannelMap[chn]->loaded > 0)
 326         {
 327             mh.dwFlags = 0;
 328             midiOutPrepareHeader(mom->ChannelMap[chn]->hMidi, &mh, sizeof(mh));
 329             ret = midiOutLongMsg(mom->ChannelMap[chn]->hMidi, &mh, sizeof(mh));
 330             midiOutUnprepareHeader(mom->ChannelMap[chn]->hMidi, &mh, sizeof(mh));
 331             if (ret != MMSYSERR_NOERROR) break;
 332         }
 333     }
 334     return ret;
 335 }
 336
 337 static DWORD modData(MIDIMAPDATA* mom, DWORD_PTR dwParam)
 338 {
 339     BYTE        lb = LOBYTE(LOWORD(dwParam));
 340     WORD        chn = lb & 0x0F;
 341     DWORD       ret = MMSYSERR_NOERROR;
 342
 343     if (MIDIMAP_IsBadData(mom))
 344         return MMSYSERR_ERROR;
 345
 346     if (!mom->ChannelMap[chn]) return MMSYSERR_NOERROR;
 347
 348     switch (lb & 0xF0)
 349     {
 350     case 0x80:
 351     case 0x90:
 352     case 0xA0:
 353     case 0xB0:
 354     case 0xC0:
 355     case 0xD0:
 356     case 0xE0:
 357         if (mom->ChannelMap[chn]->loaded == 0)
 358         {
 359             if (midiOutOpen(&mom->ChannelMap[chn]->hMidi, mom->ChannelMap[chn]->uDevID,
 360                             0L, 0L, CALLBACK_NULL) == MMSYSERR_NOERROR)
 361                 mom->ChannelMap[chn]->loaded = 1;
 362             else
 363                 mom->ChannelMap[chn]->loaded = -1;
 364             /* FIXME: should load here the IDF midi data... and allow channel and
 365              * patch mappings
 366              */
 367         }
 368         if (mom->ChannelMap[chn]->loaded > 0)
 369         {
 370             /* change channel */
 371             dwParam &= ~0x0F;
 372             dwParam |= mom->ChannelMap[chn]->aChn[chn];
 373
 374             if ((LOBYTE(LOWORD(dwParam)) & 0xF0) == 0xC0 /* program change */ &&
 375                 mom->ChannelMap[chn]->lpbPatch)
 376             {
 377                 BYTE patch = HIBYTE(LOWORD(dwParam));
 378
 379                 /* change patch */
 380                 dwParam &= ~0x0000FF00;
 381                 dwParam |= mom->ChannelMap[chn]->lpbPatch[patch];
 382             }
 383             ret = midiOutShortMsg(mom->ChannelMap[chn]->hMidi, dwParam);
 384         }
 385         break;
 386     case 0xF0:
 387         for (chn = 0; chn < 16; chn++)
 388         {
 389             if (mom->ChannelMap[chn]->loaded > 0)
 390                 ret = midiOutShortMsg(mom->ChannelMap[chn]->hMidi, dwParam);
 391         }
 392         break;
 393     default:
 394         FIXME("ooch %lx\n", dwParam);
 395     }
 396
 397     return ret;
 398 }
 399
 400 static DWORD modPrepare(MIDIMAPDATA* mom, LPMIDIHDR lpMidiHdr, DWORD_PTR dwParam2)
 401 {
 402     if (MIDIMAP_IsBadData(mom)) return MMSYSERR_ERROR;
 403     if (lpMidiHdr->dwFlags & (MHDR_ISSTRM|MHDR_PREPARED))
 404         return MMSYSERR_INVALPARAM;
 405
 406     lpMidiHdr->dwFlags |= MHDR_PREPARED;
 407     return MMSYSERR_NOERROR;
 408 }
 409
 410 static DWORD modUnprepare(MIDIMAPDATA* mom, LPMIDIHDR lpMidiHdr, DWORD_PTR dwParam2)
 411 {
 412     if (MIDIMAP_IsBadData(mom)) return MMSYSERR_ERROR;
 413     if ((lpMidiHdr->dwFlags & MHDR_ISSTRM) || !(lpMidiHdr->dwFlags & MHDR_PREPARED))
 414         return MMSYSERR_INVALPARAM;
 415
 416     lpMidiHdr->dwFlags &= ~MHDR_PREPARED;
 417     return MMSYSERR_NOERROR;
 418 }
 419
 420 static DWORD modGetDevCaps(UINT wDevID, MIDIMAPDATA* mom, LPMIDIOUTCAPSW lpMidiCaps, DWORD_PTR size)
 421 {
 422     static const WCHAR name[] = {'W','i','n','e',' ','m','i','d','i',' ','m','a','p','p','e','r',0};
 423     lpMidiCaps->wMid = 0x00FF;
 424     lpMidiCaps->wPid = 0x0001;
 425     lpMidiCaps->vDriverVersion = 0x0100;
 426     lstrcpyW(lpMidiCaps->szPname, name);
 427     lpMidiCaps->wTechnology = MOD_MAPPER;
 428     lpMidiCaps->wVoices = 0;
 429     lpMidiCaps->wNotes = 0;
 430     lpMidiCaps->wChannelMask = 0xFFFF;
 431     lpMidiCaps->dwSupport = 0L;
 432
 433     return MMSYSERR_NOERROR;
 434 }
 435
 436 static  DWORD   modReset(MIDIMAPDATA* mom)
 437 {
 438     WORD        chn;
 439     DWORD       ret = MMSYSERR_NOERROR;
 440
 441     if (MIDIMAP_IsBadData(mom))
 442         return MMSYSERR_ERROR;
 443
 444     for (chn = 0; chn < 16; chn++)
 445     {
 446         if (mom->ChannelMap[chn] && mom->ChannelMap[chn]->loaded > 0)
 447         {
 448             ret = midiOutReset(mom->ChannelMap[chn]->hMidi);
 449             if (ret != MMSYSERR_NOERROR) break;
 450         }
 451     }
 452     return ret;
 453 }
 454
 455 /**************************************************************************
 456  *                              modMessage (MIDIMAP.@)
 457  */
 458 DWORD WINAPI MIDIMAP_modMessage(UINT wDevID, UINT wMsg, DWORD_PTR dwUser,
 459                                 DWORD_PTR dwParam1, DWORD_PTR dwParam2)
 460 {
 461     TRACE("(%u, %04X, %08lX, %08lX, %08lX);\n",
 462           wDevID, wMsg, dwUser, dwParam1, dwParam2);
 463
 464     switch (wMsg)
 465     {
 466     case DRVM_INIT:
 467     case DRVM_EXIT:
 468     case DRVM_ENABLE:
 469     case DRVM_DISABLE:
 470         /* FIXME: Pretend this is supported */
 471         return 0;
 472
 473     case MODM_OPEN: return modOpen((DWORD_PTR *)dwUser, (LPMIDIOPENDESC)dwParam1, dwParam2);
 474     case MODM_CLOSE:            return modClose         ((MIDIMAPDATA*)dwUser);
 475
 476     case MODM_DATA:             return modData          ((MIDIMAPDATA*)dwUser, dwParam1);
 477     case MODM_LONGDATA:         return modLongData      ((MIDIMAPDATA*)dwUser, (LPMIDIHDR)dwParam1,     dwParam2);
 478     case MODM_PREPARE:          return modPrepare       ((MIDIMAPDATA*)dwUser, (LPMIDIHDR)dwParam1,     dwParam2);
 479     case MODM_UNPREPARE:        return modUnprepare     ((MIDIMAPDATA*)dwUser, (LPMIDIHDR)dwParam1,     dwParam2);
 480     case MODM_RESET:            return modReset         ((MIDIMAPDATA*)dwUser);
 481
 482     case MODM_GETDEVCAPS:       return modGetDevCaps    (wDevID, (MIDIMAPDATA*)dwUser, (LPMIDIOUTCAPSW)dwParam1,dwParam2);
 483     case MODM_GETNUMDEVS:       return 1;
 484     case MODM_GETVOLUME:        return MMSYSERR_NOTSUPPORTED;
 485     case MODM_SETVOLUME:        return MMSYSERR_NOTSUPPORTED;
 486     default:
 487         FIXME("unknown message %d!\n", wMsg);
 488     }
 489     return MMSYSERR_NOTSUPPORTED;
 490 }
 491
 492 /*======================================================================*
 493  *                  Driver part                                         *
 494  *======================================================================*/
 495
 496 /**************************************************************************
 497  *                              MIDIMAP_drvOpen                 [internal]
 498  */
 499 static LRESULT MIDIMAP_drvOpen(LPSTR str)
 500 {
 501     MIDIOUTCAPSW        moc;
 502     unsigned            dev, i;
 503
 504     if (midiOutPorts)
 505         return 0;
 506
 507     numMidiOutPorts = midiOutGetNumDevs();
 508     midiOutPorts = HeapAlloc(GetProcessHeap(), 0,
 509                              numMidiOutPorts * sizeof(MIDIOUTPORT));
 510     for (dev = 0; dev < numMidiOutPorts; dev++)
 511     {
 512         if (midiOutGetDevCapsW(dev, &moc, sizeof(moc)) == 0L)
 513         {
 514             strcpyW(midiOutPorts[dev].name, moc.szPname);
 515             midiOutPorts[dev].loaded = 0;
 516             midiOutPorts[dev].hMidi = 0;
 517             midiOutPorts[dev].uDevID = dev;
 518             midiOutPorts[dev].lpbPatch = NULL;
 519             for (i = 0; i < 16; i++)
 520                 midiOutPorts[dev].aChn[i] = i;
 521         }
 522         else
 523         {
 524             midiOutPorts[dev].loaded = -1;
 525         }
 526     }
 527
 528     return 1;
 529 }
 530
 531 /**************************************************************************
 532  *                              MIDIMAP_drvClose                [internal]
 533  */
 534 static LRESULT MIDIMAP_drvClose(DWORD_PTR dwDevID)
 535 {
 536     if (midiOutPorts)
 537     {
 538         HeapFree(GetProcessHeap(), 0, midiOutPorts);
 539         midiOutPorts = NULL;
 540         return 1;
 541     }
 542     return 0;
 543 }
 544
 545 /**************************************************************************
 546  *                              DriverProc (MIDIMAP.@)
 547  */
 548 LRESULT CALLBACK MIDIMAP_DriverProc(DWORD_PTR dwDevID, HDRVR hDriv, UINT wMsg,
 549                                     LPARAM dwParam1, LPARAM dwParam2)
 550 {
 551 /* EPP     TRACE("(%08lX, %04X, %08lX, %08lX, %08lX)\n",  */
 552 /* EPP    dwDevID, hDriv, wMsg, dwParam1, dwParam2); */
 553
 554     switch (wMsg)
 555     {
 556     case DRV_LOAD:              return 1;
 557     case DRV_FREE:              return 1;
 558     case DRV_OPEN:              return MIDIMAP_drvOpen((LPSTR)dwParam1);
 559     case DRV_CLOSE:             return MIDIMAP_drvClose(dwDevID);
 560     case DRV_ENABLE:            return 1;
 561     case DRV_DISABLE:           return 1;
 562     case DRV_QUERYCONFIGURE:    return 1;
 563     case DRV_CONFIGURE:         MessageBoxA(0, "MIDIMAP MultiMedia Driver !", "OSS Driver", MB_OK);     return 1;
 564     case DRV_INSTALL:           return DRVCNF_RESTART;
 565     case DRV_REMOVE:            return DRVCNF_RESTART;
 566     default:
 567         return DefDriverProc(dwDevID, hDriv, wMsg, dwParam1, dwParam2);
 568     }
 569 }