dlls/winmm/tests/midi.c

   1 /*
   2  * Test winmm midi
   3  *
   4  * Copyright 2010 Jörg Höhle
   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
  21 #include <stdio.h>
  22 #include <stddef.h>
  23 #include "windows.h"
  24 #include "mmsystem.h"
  25 #include "wine/test.h"
  26
  27 extern const char* mmsys_error(MMRESULT error); /* from wave.c */
  28
  29 /* Test in order of increasing probability to hang.
  30  * On many UNIX systems, the Timidity softsynth provides
  31  * MIDI sequencer services and it is not particularly robust.
  32  */
  33
  34 #define MYCBINST 0x4CAFE5A8 /* not used with window or thread callbacks */
  35 #define WHATEVER 0xFEEDF00D
  36
  37 static BOOL spurious_message(LPMSG msg)
  38 {
  39   /* WM_DEVICECHANGE 0x0219 appears randomly */
  40   if(msg->message == WM_DEVICECHANGE) {
  41     trace("skipping spurious message %04x\n", msg->message);
  42     return TRUE;
  43   }
  44   return FALSE;
  45 }
  46
  47 static UINT      cbmsg  = 0;
  48 static DWORD_PTR cbval1 = WHATEVER;
  49 static DWORD_PTR cbval2 = 0;
  50 static DWORD_PTR cbinst = MYCBINST;
  51
  52 static void CALLBACK callback_func(HWAVEOUT hwo, UINT uMsg,
  53                                    DWORD_PTR dwInstance,
  54                                    DWORD_PTR dwParam1, DWORD_PTR dwParam2)
  55 {
  56     if (winetest_debug>1)
  57         trace("Callback! msg=%x %lx %lx\n", uMsg, dwParam1, dwParam2);
  58     cbmsg = uMsg;
  59     cbval1 = dwParam1;   /* mhdr or 0 */
  60     cbval2 = dwParam2;   /* always 0 */
  61     cbinst = dwInstance; /* MYCBINST, see midiOut/StreamOpen */
  62 }
  63
  64 static void test_notification(HWND hwnd, const char* command, UINT m1, DWORD_PTR p2)
  65 {   /* Use message type 0 as meaning no message */
  66     MSG msg;
  67     if (hwnd) {
  68         /* msg.wParam is hmidiout, msg.lParam is the mhdr (or 0) */
  69         BOOL seen;
  70         do { seen = PeekMessageA(&msg, hwnd, 0, 0, PM_REMOVE); }
  71         while(seen && spurious_message(&msg));
  72         if (m1 && !seen) {
  73           /* We observe transient delayed notification, mostly on native.
  74            * Perhaps the OS preempts the player thread after setting MHDR_DONE
  75            * or clearing MHDR_INQUEUE, before calling DriverCallback. */
  76           DWORD rc;
  77           trace("Waiting for delayed message %x from %s\n", m1, command);
  78           SetLastError(0xDEADBEEF);
  79           rc = MsgWaitForMultipleObjects(0, NULL, FALSE, 3000, QS_POSTMESSAGE);
  80           ok(rc==WAIT_OBJECT_0, "Wait failed: %04x %d\n", rc, GetLastError());
  81           seen = PeekMessageA(&msg, hwnd, 0, 0, PM_REMOVE);
  82         }
  83         if (seen) {
  84             trace("Message %x, wParam=%lx, lParam=%lx from %s\n",
  85                   msg.message, msg.wParam, msg.lParam, command);
  86             ok(msg.hwnd==hwnd, "Didn't get the handle to our test window\n");
  87             ok(msg.message==m1 && msg.lParam==p2, "bad message %x/%lx from %s, expect %x/%lx\n", msg.message, msg.lParam, command, m1, p2);
  88         }
  89         else ok(m1==0, "Expect message %x from %s\n", m1, command);
  90     }
  91     else {
  92         /* FIXME: MOM_POSITIONCB and MOM_DONE are so close that a queue is needed. */
  93         if (cbmsg) {
  94             ok(cbmsg==m1 && cbval1==p2 && cbval2==0, "bad callback %x/%lx/%lx from %s, expect %x/%lx\n", cbmsg, cbval1, cbval2, command, m1, p2);
  95             cbmsg = 0; /* Mark as read */
  96             cbval1 = cbval2 = WHATEVER;
  97             ok(cbinst==MYCBINST, "callback dwInstance changed to %lx\n", cbinst);
  98         }
  99         else ok(m1==0, "Expect callback %x from %s\n", m1, command);
 100     }
 101 }
 102
 103
 104 static void test_midiIn_device(UINT udev, HWND hwnd)
 105 {
 106     HMIDIIN hm;
 107     MMRESULT rc;
 108     MIDIINCAPSA capsA;
 109     MIDIHDR mhdr;
 110
 111     rc = midiInGetDevCapsA(udev, &capsA, sizeof(capsA));
 112     ok((MIDIMAPPER==udev) ? (rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*nt,w2k*/)) : rc==0,
 113        "midiInGetDevCaps(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 114     if (!rc) {
 115         /* MIDI IN capsA.dwSupport may contain garbage, absent in old MS-Windows */
 116         trace("* %s: manufacturer=%d, product=%d, support=%X\n", capsA.szPname, capsA.wMid, capsA.wPid, capsA.dwSupport);
 117     }
 118
 119     if (hwnd)
 120         rc = midiInOpen(&hm, udev, (DWORD_PTR)hwnd, (DWORD_PTR)MYCBINST, CALLBACK_WINDOW);
 121     else
 122         rc = midiInOpen(&hm, udev, (DWORD_PTR)callback_func, (DWORD_PTR)MYCBINST, CALLBACK_FUNCTION);
 123     ok((MIDIMAPPER!=udev) ? rc==0 : (rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*nt,w2k*/)),
 124        "midiInOpen(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 125     if (rc) return;
 126
 127     test_notification(hwnd, "midiInOpen", MIM_OPEN, 0);
 128
 129     mhdr.dwFlags = 0;
 130     mhdr.dwUser = 0x56FA552C;
 131     mhdr.dwBufferLength = 70000; /* > 64KB! */
 132     mhdr.lpData = HeapAlloc(GetProcessHeap(), 0 , mhdr.dwBufferLength);
 133     ok(mhdr.lpData!=NULL, "No %d bytes of memory!\n", mhdr.dwBufferLength);
 134     if (mhdr.lpData) {
 135         rc = midiInPrepareHeader(hm, &mhdr, offsetof(MIDIHDR,dwOffset)-1);
 136         ok(rc==MMSYSERR_INVALPARAM, "midiInPrepare tiny rc=%s\n", mmsys_error(rc));
 137         rc = midiInPrepareHeader(hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 138         ok(!rc, "midiInPrepare old size rc=%s\n", mmsys_error(rc));
 139         rc = midiInPrepareHeader(hm, &mhdr, sizeof(mhdr));
 140         ok(!rc, "midiInPrepare rc=%s\n", mmsys_error(rc));
 141         rc = midiInUnprepareHeader(hm, &mhdr, sizeof(mhdr));
 142         ok(!rc, "midiInUnprepare rc=%s\n", mmsys_error(rc));
 143         trace("MIDIHDR flags=%x when unsent\n", mhdr.dwFlags);
 144
 145         HeapFree(GetProcessHeap(), 0, mhdr.lpData);
 146     }
 147     ok(mhdr.dwUser==0x56FA552C, "MIDIHDR.dwUser changed to %lx\n", mhdr.dwUser);
 148
 149     rc = midiInReset(hm); /* Return any pending buffer */
 150     ok(!rc, "midiInReset rc=%s\n", mmsys_error(rc));
 151
 152     rc = midiInClose(hm);
 153     ok(!rc, "midiInClose rc=%s\n", mmsys_error(rc));
 154     test_notification(hwnd, "midiInClose", MIM_CLOSE, 0);
 155     test_notification(hwnd, "midiIn over", 0, WHATEVER);
 156 }
 157
 158 static void test_midi_infns(HWND hwnd)
 159 {
 160     HMIDIIN hm;
 161     MMRESULT rc;
 162     UINT udev, ndevs = midiInGetNumDevs();
 163
 164     rc = midiInOpen(&hm, ndevs, 0, 0, CALLBACK_NULL);
 165     ok(rc==MMSYSERR_BADDEVICEID, "midiInOpen udev>max rc=%s\n", mmsys_error(rc));
 166     if (!rc) {
 167         rc = midiInClose(hm);
 168         ok(!rc, "midiInClose rc=%s\n", mmsys_error(rc));
 169     }
 170     if (!ndevs) {
 171         trace("Found no MIDI IN device\n"); /* no skip for this common situation */
 172         rc = midiInOpen(&hm, MIDIMAPPER, 0, 0, CALLBACK_NULL);
 173         ok(rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*nt,w2k*/), "midiInOpen MAPPER with no MIDI rc=%s\n", mmsys_error(rc));
 174         if (!rc) {
 175             rc = midiInClose(hm);
 176             ok(!rc, "midiInClose rc=%s\n", mmsys_error(rc));
 177         }
 178         return;
 179     }
 180     trace("Found %d MIDI IN devices\n", ndevs);
 181     for (udev=0; udev < ndevs; udev++) {
 182         trace("** Testing device %d\n", udev);
 183         test_midiIn_device(udev, hwnd);
 184         Sleep(50);
 185     }
 186     trace("** Testing MIDI mapper\n");
 187     test_midiIn_device(MIDIMAPPER, hwnd);
 188 }
 189
 190
 191 static void test_midi_mci(HWND hwnd)
 192 {
 193     MCIERROR err;
 194     char buf[1024];
 195     memset(buf, 0, sizeof(buf));
 196
 197     err = mciSendString("sysinfo sequencer quantity", buf, sizeof(buf), hwnd);
 198     ok(!err, "mci sysinfo sequencer quantity returned %d\n", err);
 199     if (!err) trace("Found %s MCI sequencer devices\n", buf);
 200 }
 201
 202
 203 static void test_midiOut_device(UINT udev, HWND hwnd)
 204 {
 205     HMIDIOUT hm;
 206     MMRESULT rc;
 207     MIDIOUTCAPSA capsA;
 208     DWORD ovolume;
 209     MIDIHDR mhdr;
 210
 211     rc = midiOutGetDevCapsA(udev, &capsA, sizeof(capsA));
 212     ok(!rc, "midiOutGetDevCaps(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 213     if (!rc) {
 214       trace("* %s: manufacturer=%d, product=%d, tech=%d, support=%X: %d voices, %d notes\n",
 215             capsA.szPname, capsA.wMid, capsA.wPid, capsA.wTechnology, capsA.dwSupport, capsA.wVoices, capsA.wNotes);
 216     }
 217
 218     if (hwnd)
 219         rc = midiOutOpen(&hm, udev, (DWORD_PTR)hwnd, (DWORD_PTR)MYCBINST, CALLBACK_WINDOW);
 220     else
 221         rc = midiOutOpen(&hm, udev, (DWORD_PTR)callback_func, (DWORD_PTR)MYCBINST, CALLBACK_FUNCTION);
 222     ok(!rc, "midiOutOpen(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 223     if (rc) return;
 224
 225     test_notification(hwnd, "midiOutOpen", MOM_OPEN, 0);
 226
 227     rc = midiOutGetVolume(hm, &ovolume);
 228     ok((capsA.dwSupport & MIDICAPS_VOLUME) ? rc==MMSYSERR_NOERROR : rc==MMSYSERR_NOTSUPPORTED, "midiOutGetVolume rc=%s\n", mmsys_error(rc));
 229     /* The native mapper responds with FFFFFFFF initially,
 230      * real devices with the volume GUI SW-synth settings. */
 231     if (!rc) trace("Current volume %x on device %d\n", ovolume, udev);
 232
 233     /* The W95 ESFM Synthesis device reports NOTENABLED although
 234      * GetVolume by handle works and music plays. */
 235     rc = midiOutGetVolume((HMIDIOUT)udev, &ovolume);
 236     ok((capsA.dwSupport & MIDICAPS_VOLUME) ? rc==MMSYSERR_NOERROR || broken(rc==MMSYSERR_NOTENABLED) : rc==MMSYSERR_NOTSUPPORTED, "midiOutGetVolume(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 237
 238     /* Tests with midiOutSetvolume show that the midi mapper forwards
 239      * the value to the real device, but Get initially always reports
 240      * FFFFFFFF.  Therefore, a Get+SetVolume pair with the mapper is
 241      * not adequate to restore the value prior to tests.
 242      */
 243     if (winetest_interactive && (capsA.dwSupport & MIDICAPS_VOLUME)) {
 244         DWORD volume2 = (ovolume < 0x80000000) ? 0xC000C000 : 0x40004000;
 245         rc = midiOutSetVolume(hm, volume2);
 246         ok(!rc, "midiOutSetVolume rc=%s\n", mmsys_error(rc));
 247         if (!rc) {
 248             DWORD volume3;
 249             rc = midiOutGetVolume(hm, &volume3);
 250             ok(!rc, "midiOutGetVolume new rc=%s\n", mmsys_error(rc));
 251             if (!rc) trace("New volume %x on device %d\n", volume3, udev);
 252             todo_wine ok(volume2==volume3, "volume Set %x = Get %x\n", volume2, volume3);
 253
 254             rc = midiOutSetVolume(hm, ovolume);
 255             ok(!rc, "midiOutSetVolume restore rc=%s\n", mmsys_error(rc));
 256         }
 257     }
 258     rc = midiOutGetDevCapsA((UINT_PTR)hm, &capsA, sizeof(capsA));
 259     ok(!rc, "midiOutGetDevCaps(dev=%d) by handle rc=%s\n", udev, mmsys_error(rc));
 260     rc = midiInGetDevCapsA((UINT_PTR)hm, (LPMIDIINCAPSA)&capsA, sizeof(DWORD));
 261     ok(rc==MMSYSERR_BADDEVICEID, "midiInGetDevCaps(dev=%d) by out handle rc=%s\n", udev, mmsys_error(rc));
 262
 263     {   DWORD e = 0x006F4893; /* velocity, note (#69 would be 440Hz) channel */
 264         trace("ShortMsg type %x\n", LOBYTE(LOWORD(e)));
 265         rc = midiOutShortMsg(hm, e);
 266         ok(!rc, "midiOutShortMsg rc=%s\n", mmsys_error(rc));
 267         if (!rc) Sleep(400); /* Hear note */
 268     }
 269
 270     mhdr.dwFlags = 0;
 271     mhdr.dwUser   = 0x56FA552C;
 272     mhdr.dwOffset = 0xDEADBEEF;
 273     mhdr.dwBufferLength = 70000; /* > 64KB! */
 274     mhdr.lpData = HeapAlloc(GetProcessHeap(), 0 , mhdr.dwBufferLength);
 275     ok(mhdr.lpData!=NULL, "No %d bytes of memory!\n", mhdr.dwBufferLength);
 276     if (mhdr.lpData) {
 277         rc = midiOutLongMsg(hm, &mhdr, sizeof(mhdr));
 278         ok(rc==MIDIERR_UNPREPARED, "midiOutLongMsg unprepared rc=%s\n", mmsys_error(rc));
 279         test_notification(hwnd, "midiOutLong unprepared", 0, WHATEVER);
 280
 281         rc = midiOutPrepareHeader(hm, &mhdr, offsetof(MIDIHDR,dwOffset)-1);
 282         ok(rc==MMSYSERR_INVALPARAM, "midiOutPrepare tiny rc=%s\n", mmsys_error(rc));
 283         rc = midiOutPrepareHeader(hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 284         ok(!rc, "midiOutPrepare old size rc=%s\n", mmsys_error(rc));
 285         rc = midiOutPrepareHeader(hm, &mhdr, sizeof(mhdr));
 286         ok(!rc, "midiOutPrepare rc=%s\n", mmsys_error(rc));
 287         rc = midiOutUnprepareHeader(hm, &mhdr, sizeof(mhdr));
 288         ok(!rc, "midiOutUnprepare rc=%s\n", mmsys_error(rc));
 289         trace("MIDIHDR flags=%x when unsent\n", mhdr.dwFlags);
 290
 291         HeapFree(GetProcessHeap(), 0, mhdr.lpData);
 292     }
 293     ok(mhdr.dwUser==0x56FA552C, "MIDIHDR.dwUser changed to %lx\n", mhdr.dwUser);
 294     ok(mhdr.dwOffset==0xDEADBEEF, "MIDIHDR.dwOffset changed to %x\n", mhdr.dwOffset);
 295
 296     rc = midiOutReset(hm); /* Quiet everything */
 297     ok(!rc, "midiOutReset rc=%s\n", mmsys_error(rc));
 298
 299     rc = midiOutClose(hm);
 300     ok(!rc, "midiOutClose rc=%s\n", mmsys_error(rc));
 301     test_notification(hwnd, "midiOutClose", MOM_CLOSE, 0);
 302     test_notification(hwnd, "midiOut over", 0, WHATEVER);
 303 }
 304
 305 static void test_position(HMIDISTRM hm, UINT typein, UINT typeout)
 306 {
 307     MMRESULT rc;
 308     MMTIME mmtime;
 309     mmtime.wType = typein;
 310     rc = midiStreamPosition(hm, &mmtime, sizeof(MMTIME));
 311     /* Ugly, but a single ok() herein enables using the todo_wine prefix */
 312     ok(!rc && (mmtime.wType == typeout), "midiStreamPosition type %x converted to %x rc=%s\n", typein, mmtime.wType, mmsys_error(rc));
 313     if (!rc) switch(mmtime.wType) {
 314     case TIME_MS:
 315         trace("Stream position %ums\n", mmtime.u.ms);
 316         break;
 317     case TIME_TICKS:
 318         trace("Stream position %u ticks\n", mmtime.u.ticks);
 319         break;
 320     case TIME_MIDI:
 321         trace("Stream position song pointer %u\n", mmtime.u.midi.songptrpos);
 322         break;
 323     }
 324 }
 325
 326 /* Native crashes on a second run with the const qualifier set on this data! */
 327 static BYTE strmEvents[] = { /* A set of variable-sized MIDIEVENT structs */
 328     0, 0, 0, 0,  0, 0, 0, 0, /* dwDeltaTime and dwStreamID */
 329     0, 0, 0, MEVT_NOP | 0x40, /* with MEVT_F_CALLBACK */
 330     0, 0, 0, 0,  0, 0, 0, 0, /* dwDeltaTime and dwStreamID */
 331     0x93, 0x48, 0x6F, MEVT_SHORTMSG,
 332 };
 333
 334 static BYTE strmNops[] = { /* Test callback + dwOffset */
 335     0, 0, 0, 0,  0, 0, 0, 0,
 336     0, 0, 0, MEVT_NOP | 0x40, /* with MEVT_F_CALLBACK */
 337     0, 0, 0, 0,  0, 0, 0, 0,
 338     0, 0, 0, MEVT_NOP | 0x40, /* with MEVT_F_CALLBACK */
 339 };
 340
 341 static MMRESULT playStream(HMIDISTRM hm, LPMIDIHDR lpMidiHdr)
 342 {
 343     MMRESULT rc = midiStreamOut(hm, lpMidiHdr, sizeof(MIDIHDR));
 344     /* virtual machines may return MIDIERR_STILLPLAYING from the next request
 345      * even after MHDR_DONE is set. It's still too early, so add MHDR_INQUEUE. */
 346     if (!rc) while (!(lpMidiHdr->dwFlags & MHDR_DONE) || (lpMidiHdr->dwFlags & MHDR_INQUEUE)) { Sleep(100); }
 347     return rc;
 348 }
 349
 350 static void test_midiStream(UINT udev, HWND hwnd)
 351 {
 352     HMIDISTRM hm;
 353     MMRESULT rc, rc2;
 354     MIDIHDR mhdr;
 355     union {
 356         MIDIPROPTEMPO tempo;
 357         MIDIPROPTIMEDIV tdiv;
 358     } midiprop;
 359     BYTE * const evt1 = &strmNops[1*offsetof(MIDIEVENT,dwParms)-1];
 360     BYTE * const evt2 = &strmNops[2*offsetof(MIDIEVENT,dwParms)-1];
 361
 362     if (hwnd)
 363         rc = midiStreamOpen(&hm, &udev, 1, (DWORD_PTR)hwnd, (DWORD_PTR)MYCBINST, CALLBACK_WINDOW);
 364     else
 365         rc = midiStreamOpen(&hm, &udev, 1, (DWORD_PTR)callback_func, (DWORD_PTR)MYCBINST, CALLBACK_FUNCTION);
 366     ok(!rc, "midiStreamOpen(dev=%d) rc=%s\n", udev, mmsys_error(rc));
 367     if (rc) return;
 368
 369     test_notification(hwnd, "midiStreamOpen", MOM_OPEN, 0);
 370
 371     midiprop.tempo.cbStruct = sizeof(midiprop.tempo);
 372     rc = midiStreamProperty(hm, (void*)&midiprop, MIDIPROP_GET|MIDIPROP_TEMPO);
 373     ok(!rc, "midiStreamProperty TEMPO rc=%s\n", mmsys_error(rc));
 374     ok(midiprop.tempo.dwTempo==500000, "default stream tempo %u microsec per quarter note\n", midiprop.tempo.dwTempo);
 375
 376     midiprop.tdiv.cbStruct = sizeof(midiprop.tdiv);
 377     rc = midiStreamProperty(hm, (void*)&midiprop, MIDIPROP_GET|MIDIPROP_TIMEDIV);
 378     ok(!rc, "midiStreamProperty TIMEDIV rc=%s\n", mmsys_error(rc));
 379     todo_wine ok(24==LOWORD(midiprop.tdiv.dwTimeDiv), "default stream time division %u\n", midiprop.tdiv.dwTimeDiv);
 380
 381     mhdr.dwFlags = 0;
 382     mhdr.dwUser   = 0x56FA552C;
 383     mhdr.dwOffset = 1234567890;
 384     mhdr.dwBufferLength = sizeof(strmEvents) * sizeof(strmEvents[0]);
 385     mhdr.dwBytesRecorded = mhdr.dwBufferLength;
 386     mhdr.lpData = (LPSTR)&strmEvents[0];
 387     if (mhdr.lpData) {
 388         rc = midiOutLongMsg((HMIDIOUT)hm, &mhdr, sizeof(mhdr));
 389         ok(rc==MIDIERR_UNPREPARED, "midiOutLongMsg unprepared rc=%s\n", mmsys_error(rc));
 390         test_notification(hwnd, "midiOutLong unprepared", 0, WHATEVER);
 391
 392         rc = midiOutPrepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset)-1);
 393         ok(rc==MMSYSERR_INVALPARAM, "midiOutPrepare tiny rc=%s\n", mmsys_error(rc));
 394         rc = midiOutPrepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 395         ok(!rc, "midiOutPrepare old size rc=%s\n", mmsys_error(rc));
 396         ok(mhdr.dwFlags & MHDR_PREPARED, "MHDR.dwFlags when prepared %x\n", mhdr.dwFlags);
 397
 398         /* The device is still in paused mode and should queue the message. */
 399         rc = midiStreamOut(hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 400         ok(!rc, "midiStreamOut old size rc=%s\n", mmsys_error(rc));
 401         rc2 = rc;
 402         trace("MIDIHDR flags=%x when submitted\n", mhdr.dwFlags);
 403         /* w9X/me does not set MHDR_ISSTRM when StreamOut exits,
 404          * but it will be set on all systems after the job is finished. */
 405
 406         Sleep(90);
 407         /* Wine <1.1.39 started playing immediately */
 408         test_notification(hwnd, "midiStream still paused", 0, WHATEVER);
 409
 410     /* MSDN asks to use midiStreamRestart prior to midiStreamOut()
 411      * because the starting state is 'pause', but some apps seem to
 412      * work with the inverse order.
 413      */
 414
 415         rc = midiStreamRestart(hm);
 416         ok(!rc, "midiStreamRestart rc=%s\n", mmsys_error(rc));
 417
 418         if (!rc2) while(mhdr.dwFlags & MHDR_INQUEUE) {
 419             trace("async MIDI still queued\n");
 420             Sleep(100);
 421         } /* Checking INQUEUE is not the recommended way to wait for the end of a job, but we're testing. */
 422         /* MHDR_ISSTRM is not necessarily set when midiStreamOut returns
 423          * rather than when the queue is eventually processed. */
 424         ok(mhdr.dwFlags & MHDR_ISSTRM, "MHDR.dwFlags %x no ISSTRM when out of queue\n", mhdr.dwFlags);
 425         if (!rc2) while(!(mhdr.dwFlags & MHDR_DONE)) {
 426             /* Never to be seen except perhaps on multicore */
 427             trace("async MIDI still not done\n");
 428             Sleep(100);
 429         }
 430         ok(mhdr.dwFlags & MHDR_DONE, "MHDR.dwFlags %x not DONE when out of queue\n", mhdr.dwFlags);
 431         test_notification(hwnd, "midiStream callback", MOM_POSITIONCB, (DWORD_PTR)&mhdr);
 432         test_notification(hwnd, "midiStreamOut", MOM_DONE, (DWORD_PTR)&mhdr);
 433
 434         /* Native fills dwOffset regardless of the cbMidiHdr size argument to midiStreamOut */
 435         ok(1234567890!=mhdr.dwOffset, "play left MIDIHDR.dwOffset at %u\n", mhdr.dwOffset);
 436
 437         rc = midiOutUnprepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 438         ok(!rc, "midiOutUnprepare rc=%s\n", mmsys_error(rc));
 439         rc = midiOutUnprepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 440         ok(!rc, "midiOutUnprepare #2 rc=%s\n", mmsys_error(rc));
 441
 442         trace("MIDIHDR stream flags=%x when finished\n", mhdr.dwFlags);
 443         ok(mhdr.dwFlags & MHDR_DONE, "MHDR.dwFlags when done %x\n", mhdr.dwFlags);
 444
 445         test_position(hm, TIME_MS,      TIME_MS);
 446         test_position(hm, TIME_TICKS,   TIME_TICKS);
 447         todo_wine test_position(hm, TIME_MIDI,    TIME_MIDI);
 448         test_position(hm, TIME_SMPTE,   TIME_MS);
 449         test_position(hm, TIME_SAMPLES, TIME_MS);
 450         test_position(hm, TIME_BYTES,   TIME_MS);
 451
 452         Sleep(400); /* Hear note */
 453
 454         rc = midiStreamRestart(hm);
 455         ok(!rc, "midiStreamRestart #2 rc=%s\n", mmsys_error(rc));
 456
 457         mhdr.dwFlags |= MHDR_ISSTRM; /* just in case */
 458         /* Preset flags (e.g. MHDR_ISSTRM) do not disturb. */
 459         rc = midiOutPrepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 460         ok(!rc, "midiOutPrepare used flags %x rc=%s\n", mhdr.dwFlags, mmsys_error(rc));
 461         rc = midiOutUnprepareHeader((HMIDIOUT)hm, &mhdr, offsetof(MIDIHDR,dwOffset));
 462         ok(!rc, "midiOutUnprepare used flags %x rc=%s\n", mhdr.dwFlags, mmsys_error(rc));
 463
 464         rc = midiStreamRestart(hm);
 465         ok(!rc, "midiStreamRestart #3 rc=%s\n", mmsys_error(rc));
 466     }
 467     ok(mhdr.dwUser==0x56FA552C, "MIDIHDR.dwUser changed to %lx\n", mhdr.dwUser);
 468     trace("dwStreamID set to %x\n", ((LPMIDIEVENT)&strmEvents[0])->dwStreamID);
 469
 470     /* dwBytesRecorded controls how much is played, not dwBufferLength
 471      * allowing to immediately forward packets from midiIn to midiOut */
 472     mhdr.dwOffset = 1234123123;
 473     mhdr.dwBufferLength = sizeof(strmNops) * sizeof(strmNops[0]);
 474     mhdr.dwBytesRecorded = 0;
 475     mhdr.lpData = (LPSTR)&strmNops[0];
 476     *evt1 |= 0x40; /* MEVT_CALLBACK flag */
 477     *evt2 |= 0x40;
 478
 479     rc = midiOutPrepareHeader((HMIDIOUT)hm, &mhdr, sizeof(mhdr));
 480     ok(!rc, "midiOutPrepare rc=%s\n", mmsys_error(rc));
 481
 482     rc = playStream(hm, &mhdr);
 483     ok(!rc, "midiStreamOut 0 bytes recorded rc=%s\n", mmsys_error(rc));
 484
 485     test_notification(hwnd, "midiStreamOut", MOM_DONE, (DWORD_PTR)&mhdr);
 486     test_notification(hwnd, "0 bytes recorded", 0, WHATEVER);
 487
 488     /* FIXME: check dwOffset within callback
 489      * instead of the unspecified value afterwards */
 490     ok(1234123123==mhdr.dwOffset || broken(0==mhdr.dwOffset), "play 0 set MIDIHDR.dwOffset to %u\n", mhdr.dwOffset);
 491     /* w2k and later only set dwOffset when processing MEVT_T_CALLBACK,
 492      * while w9X/me/nt always sets it.  Have Wine behave like w2k because the
 493      * dwOffset slot does not exist in the small size MIDIHDR. */
 494
 495     mhdr.dwOffset = 1234123123;
 496     mhdr.dwBytesRecorded = offsetof(MIDIEVENT,dwParms);
 497
 498     rc = playStream(hm, &mhdr);
 499     ok(!rc, "midiStreamOut 1 event out of 2 rc=%s\n", mmsys_error(rc));
 500
 501     test_notification(hwnd, "1 of 2 events", MOM_POSITIONCB, (DWORD_PTR)&mhdr);
 502     test_notification(hwnd, "1 of 2 events", MOM_DONE, (DWORD_PTR)&mhdr);
 503     test_notification(hwnd, "1 of 2 events", 0, WHATEVER);
 504     ok(0==mhdr.dwOffset, "MIDIHDR.dwOffset 1/2 changed to %u\n", mhdr.dwOffset);
 505     trace("MIDIHDR.dwOffset left at %u\n", mhdr.dwOffset);
 506
 507     mhdr.dwOffset = 1234123123;
 508     mhdr.dwBytesRecorded = 2*offsetof(MIDIEVENT,dwParms);
 509
 510     rc = playStream(hm, &mhdr);
 511     ok(!rc, "midiStreamOut 1 event out of 2 rc=%s\n", mmsys_error(rc));
 512
 513     test_notification(hwnd, "2 of 2 events", MOM_POSITIONCB, (DWORD_PTR)&mhdr);
 514     test_notification(hwnd, "2 of 2 events", MOM_POSITIONCB, (DWORD_PTR)&mhdr);
 515     test_notification(hwnd, "2 of 2 events", MOM_DONE, (DWORD_PTR)&mhdr);
 516     test_notification(hwnd, "2 of 2 events", 0, WHATEVER);
 517     ok(3*sizeof(DWORD)==mhdr.dwOffset, "MIDIHDR.dwOffset 2/2 changed to %u\n", mhdr.dwOffset);
 518     trace("MIDIHDR.dwOffset left at %u\n", mhdr.dwOffset);
 519
 520     *evt1 &= ~0x40; /* MEVT_CALLBACK flag */
 521     *evt2 &= ~0x40;
 522     mhdr.dwOffset = 1234123123;
 523     rc = playStream(hm, &mhdr);
 524     ok(!rc, "midiStreamOut 1 event out of 2 rc=%s\n", mmsys_error(rc));
 525
 526     test_notification(hwnd, "0 CB in 2 events", MOM_DONE, (DWORD_PTR)&mhdr);
 527     test_notification(hwnd, "0 CB in 2 events", 0, WHATEVER);
 528     /* w9X/me/nt set dwOffset to the position played last */
 529     ok(1234123123==mhdr.dwOffset || broken(3*sizeof(DWORD)==mhdr.dwOffset), "MIDIHDR.dwOffset nocb changed to %u\n", mhdr.dwOffset);
 530
 531     mhdr.dwBytesRecorded = mhdr.dwBufferLength-1;
 532     rc = playStream(hm, &mhdr);
 533     todo_wine ok(rc==MMSYSERR_INVALPARAM,"midiStreamOut dwBytesRecorded/MIDIEVENT rc=%s\n", mmsys_error(rc));
 534     if (!rc) {
 535          test_notification(hwnd, "2 of 2 events", MOM_DONE, (DWORD_PTR)&mhdr);
 536     }
 537
 538     mhdr.dwBytesRecorded = mhdr.dwBufferLength+1;
 539     rc = playStream(hm, &mhdr);
 540     ok(rc==MMSYSERR_INVALPARAM,"midiStreamOut dwBufferLength<dwBytesRecorded rc=%s\n", mmsys_error(rc));
 541     test_notification(hwnd, "past MIDIHDR tests", 0, WHATEVER);
 542
 543     rc = midiStreamStop(hm);
 544     ok(!rc, "midiStreamStop rc=%s\n", mmsys_error(rc));
 545     ok(mhdr.dwUser==0x56FA552C, "MIDIHDR.dwUser changed to %lx\n", mhdr.dwUser);
 546
 547     rc = midiOutUnprepareHeader((HMIDIOUT)hm, &mhdr, sizeof(mhdr));
 548     ok(!rc, "midiOutUnprepare rc=%s\n", mmsys_error(rc));
 549
 550     mhdr.dwBufferLength = 70000; /* > 64KB! */
 551     mhdr.lpData = HeapAlloc(GetProcessHeap(), 0 , mhdr.dwBufferLength);
 552     ok(mhdr.lpData!=NULL, "No %d bytes of memory!\n", mhdr.dwBufferLength);
 553     if (mhdr.lpData) {
 554         mhdr.dwFlags = 0;
 555         /* PrepareHeader detects the too large buffer is for a stream. */
 556         rc = midiOutPrepareHeader((HMIDIOUT)hm, &mhdr, sizeof(mhdr));
 557         todo_wine ok(rc==MMSYSERR_INVALPARAM, "midiOutPrepare stream too large rc=%s\n", mmsys_error(rc));
 558
 559         rc = midiOutUnprepareHeader((HMIDIOUT)hm, &mhdr, sizeof(mhdr));
 560         ok(!rc, "midiOutUnprepare rc=%s\n", mmsys_error(rc));
 561
 562         HeapFree(GetProcessHeap(), 0, mhdr.lpData);
 563     }
 564
 565     rc = midiStreamClose(hm);
 566     ok(!rc, "midiStreamClose rc=%s\n", mmsys_error(rc));
 567     test_notification(hwnd, "midiStreamClose", MOM_CLOSE, 0);
 568     test_notification(hwnd, "midiStream over", 0, WHATEVER);
 569 }
 570
 571 static void test_midi_outfns(HWND hwnd)
 572 {
 573     HMIDIOUT hm;
 574     MMRESULT rc;
 575     UINT udev, ndevs = midiOutGetNumDevs();
 576
 577     rc = midiOutOpen(&hm, ndevs, 0, 0, CALLBACK_NULL);
 578     ok(rc==MMSYSERR_BADDEVICEID, "midiOutOpen udev>max rc=%s\n", mmsys_error(rc));
 579     if (!rc) {
 580         rc = midiOutClose(hm);
 581         ok(!rc, "midiOutClose rc=%s\n", mmsys_error(rc));
 582     }
 583     if (!ndevs) {
 584         MIDIOUTCAPSA capsA;
 585         skip("Found no MIDI out device\n");
 586
 587         rc = midiOutGetDevCapsA(MIDIMAPPER, &capsA, sizeof(capsA));
 588         /* GetDevCaps and Open must return compatible results */
 589         ok(rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*nt,w2k*/), "midiOutGetDevCaps MAPPER with no MIDI rc=%s\n", mmsys_error(rc));
 590
 591         rc = midiOutOpen(&hm, MIDIMAPPER, 0, 0, CALLBACK_NULL);
 592         if (rc==MIDIERR_INVALIDSETUP) todo_wine /* Wine without snd-seq */
 593         ok(rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*w2k*/), "midiOutOpen MAPPER with no MIDI rc=%s\n", mmsys_error(rc));
 594         else
 595         ok(rc==MMSYSERR_BADDEVICEID || broken(rc==MMSYSERR_NODRIVER /*w2k sound disabled*/),
 596            "midiOutOpen MAPPER with no MIDI rc=%s\n", mmsys_error(rc));
 597         if (!rc) {
 598             rc = midiOutClose(hm);
 599             ok(!rc, "midiOutClose rc=%s\n", mmsys_error(rc));
 600         }
 601         return;
 602     }
 603     trace("Found %d MIDI OUT devices\n", ndevs);
 604
 605     test_midi_mci(hwnd);
 606
 607     for (udev=0; udev < ndevs; udev++) {
 608         trace("** Testing device %d\n", udev);
 609         test_midiOut_device(udev, hwnd);
 610         Sleep(800); /* Let the synth rest */
 611         test_midiStream(udev, hwnd);
 612         Sleep(800);
 613     }
 614     trace("** Testing MIDI mapper\n");
 615     test_midiOut_device(MIDIMAPPER, hwnd);
 616     Sleep(800);
 617     test_midiStream(MIDIMAPPER, hwnd);
 618 }
 619
 620 START_TEST(midi)
 621 {
 622     HWND hwnd;
 623     if (1) /* select 1 for CALLBACK_WINDOW or 0 for CALLBACK_FUNCTION */
 624     hwnd = CreateWindowExA(0, "static", "winmm midi test", WS_POPUP, 0,0,100,100,
 625                            0, 0, 0, NULL);
 626     test_midi_infns(hwnd);
 627     test_midi_outfns(hwnd);
 628     if (hwnd) DestroyWindow(hwnd);
 629 }