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