2 * Copyright (C) 2015 Tim Mayberry <mojofunk@gmail.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #include "winmmemidi_output_device.h"
23 #include "pbd/debug.h"
24 #include "pbd/compose.h"
26 #include "rt_thread.h"
27 #include "win_utils.h"
28 #include "midi_util.h"
32 // remove dup with input_device
33 static const uint32_t MIDI_BUFFER_SIZE = 32768;
34 static const uint32_t MAX_MIDI_MSG_SIZE = 256; // fix this for sysex
35 static const uint32_t MAX_QUEUE_SIZE = 4096;
39 WinMMEMidiOutputDevice::WinMMEMidiOutputDevice (int index)
41 , m_queue_semaphore(0)
42 , m_sysex_semaphore(0)
46 , m_thread_running(false)
47 , m_thread_quit(false)
48 , m_midi_buffer(new RingBuffer<uint8_t>(MIDI_BUFFER_SIZE))
50 DEBUG_MIDI (string_compose ("Creating midi output device index: %1\n", index));
52 std::string error_msg;
54 if (!open (index, error_msg)) {
55 DEBUG_MIDI (error_msg);
56 throw std::runtime_error (error_msg);
59 set_device_name (index);
62 WinMMEMidiOutputDevice::~WinMMEMidiOutputDevice ()
64 std::string error_msg;
65 if (!close (error_msg)) {
66 DEBUG_MIDI (error_msg);
71 WinMMEMidiOutputDevice::enqueue_midi_event (uint64_t timestamp,
75 const uint32_t total_bytes = sizeof(MidiEventHeader) + size;
76 if (m_midi_buffer->write_space () < total_bytes) {
77 DEBUG_MIDI ("WinMMEMidiOutput: ring buffer overflow\n");
81 MidiEventHeader h (timestamp, size);
82 m_midi_buffer->write ((uint8_t*)&h, sizeof(MidiEventHeader));
83 m_midi_buffer->write (data, size);
85 signal (m_queue_semaphore);
90 WinMMEMidiOutputDevice::open (UINT index, std::string& error_msg)
92 MMRESULT result = midiOutOpen (&m_handle,
94 (DWORD_PTR)winmm_output_callback,
97 if (result != MMSYSERR_NOERROR) {
98 error_msg = get_error_string (result);
102 m_queue_semaphore = CreateSemaphore (NULL, 0, MAX_QUEUE_SIZE, NULL);
103 if (m_queue_semaphore == NULL) {
104 DEBUG_MIDI ("WinMMEMidiOutput: Unable to create queue semaphore\n");
107 m_sysex_semaphore = CreateSemaphore (NULL, 0, 1, NULL);
108 if (m_sysex_semaphore == NULL) {
109 DEBUG_MIDI ("WinMMEMidiOutput: Unable to create sysex semaphore\n");
116 WinMMEMidiOutputDevice::close (std::string& error_msg)
118 // return error message for first error encountered?
120 MMRESULT result = midiOutReset (m_handle);
121 if (result != MMSYSERR_NOERROR) {
122 error_msg = get_error_string (result);
123 DEBUG_MIDI (error_msg);
126 result = midiOutClose (m_handle);
127 if (result != MMSYSERR_NOERROR) {
128 error_msg = get_error_string (result);
129 DEBUG_MIDI (error_msg);
133 if (m_sysex_semaphore) {
134 if (!CloseHandle (m_sysex_semaphore)) {
135 DEBUG_MIDI ("WinMMEMidiOut Unable to close sysex semaphore\n");
138 m_sysex_semaphore = 0;
141 if (m_queue_semaphore) {
142 if (!CloseHandle (m_queue_semaphore)) {
143 DEBUG_MIDI ("WinMMEMidiOut Unable to close queue semaphore\n");
146 m_queue_semaphore = 0;
155 WinMMEMidiOutputDevice::set_device_name (UINT index)
157 MIDIOUTCAPS capabilities;
159 midiOutGetDevCaps (index, &capabilities, sizeof(capabilities));
161 if (result != MMSYSERR_NOERROR) {
162 DEBUG_MIDI (get_error_string (result));
163 m_name = "Unknown Midi Output Device";
166 m_name = capabilities.szPname;
172 WinMMEMidiOutputDevice::get_error_string (MMRESULT error_code)
174 char error_msg[MAXERRORLENGTH];
175 MMRESULT result = midiOutGetErrorText (error_code, error_msg, MAXERRORLENGTH);
176 if (result != MMSYSERR_NOERROR) {
179 return "WinMMEMidiOutput: Unknown Error code";
183 WinMMEMidiOutputDevice::start ()
185 if (m_thread_running) {
187 string_compose ("WinMMEMidiOutput: device %1 already started\n", m_name));
191 m_timer = CreateWaitableTimer (NULL, FALSE, NULL);
194 DEBUG_MIDI ("WinMMEMidiOutput: unable to create waitable timer\n");
198 if (!start_midi_output_thread ()) {
199 DEBUG_MIDI ("WinMMEMidiOutput: Failed to start MIDI output thread\n");
201 if (!CloseHandle (m_timer)) {
202 DEBUG_MIDI ("WinMMEMidiOutput: unable to close waitable timer\n");
210 WinMMEMidiOutputDevice::stop ()
212 if (!m_thread_running) {
213 DEBUG_MIDI ("WinMMEMidiOutputDevice: device already stopped\n");
217 if (!stop_midi_output_thread ()) {
218 DEBUG_MIDI ("WinMMEMidiOutput: Failed to start MIDI output thread\n");
222 if (!CloseHandle (m_timer)) {
223 DEBUG_MIDI ("WinMMEMidiOutput: unable to close waitable timer\n");
231 WinMMEMidiOutputDevice::start_midi_output_thread ()
233 m_thread_quit = false;
235 //pthread_attr_t attr;
236 size_t stacksize = 100000;
238 // TODO Use native threads
239 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
240 &m_output_thread_handle, midi_output_thread, this)) {
245 while (!m_thread_running && --timeout > 0) { Glib::usleep (1000); }
246 if (timeout == 0 || !m_thread_running) {
247 DEBUG_MIDI (string_compose ("Unable to start midi output device thread: %1\n",
255 WinMMEMidiOutputDevice::stop_midi_output_thread ()
258 m_thread_quit = true;
260 while (m_thread_running && --timeout > 0) { Glib::usleep (1000); }
261 if (timeout == 0 || m_thread_running) {
262 DEBUG_MIDI (string_compose ("Unable to stop midi output device thread: %1\n",
268 if (pthread_join (m_output_thread_handle, &status)) {
269 DEBUG_MIDI (string_compose ("Unable to join midi output device thread: %1\n",
277 WinMMEMidiOutputDevice::signal (HANDLE semaphore)
279 bool result = (bool)ReleaseSemaphore (semaphore, 1, NULL);
281 DEBUG_MIDI ("WinMMEMidiOutDevice: Cannot release semaphore\n");
287 WinMMEMidiOutputDevice::wait (HANDLE semaphore)
289 DWORD result = WaitForSingleObject (semaphore, INFINITE);
292 DEBUG_MIDI ("WinMMEMidiOutDevice: WaitForSingleObject Failed\n");
297 DEBUG_MIDI ("WinMMEMidiOutDevice: Unexpected result from WaitForSingleObject\n");
303 WinMMEMidiOutputDevice::winmm_output_callback (HMIDIOUT handle,
309 ((WinMMEMidiOutputDevice*)instance)
310 ->midi_output_callback (msg, midi_data, timestamp);
314 WinMMEMidiOutputDevice::midi_output_callback (UINT message,
320 DEBUG_MIDI ("WinMMEMidiOutput - MIDI device closed\n");
323 signal (m_sysex_semaphore);
326 DEBUG_MIDI ("WinMMEMidiOutput - MIDI device opened\n");
329 LPMIDIHDR header = (LPMIDIHDR)midi_data;
330 DEBUG_MIDI (string_compose ("WinMMEMidiOut - %1 bytes out of %2 bytes of "
331 "the current sysex message have been sent.\n",
333 header->dwBytesRecorded));
338 WinMMEMidiOutputDevice::midi_output_thread (void *arg)
340 WinMMEMidiOutputDevice* output_device = reinterpret_cast<WinMMEMidiOutputDevice*> (arg);
341 output_device->midi_output_thread ();
346 WinMMEMidiOutputDevice::midi_output_thread ()
348 m_thread_running = true;
350 DEBUG_MIDI ("WinMMEMidiOut: MIDI output thread started\n");
352 while (!m_thread_quit) {
353 if (!wait (m_queue_semaphore)) {
357 MidiEventHeader h (0, 0);
358 uint8_t data[MAX_MIDI_MSG_SIZE];
360 const uint32_t read_space = m_midi_buffer->read_space ();
362 if (read_space > sizeof(MidiEventHeader)) {
363 if (m_midi_buffer->read ((uint8_t*)&h, sizeof(MidiEventHeader)) !=
364 sizeof(MidiEventHeader)) {
365 DEBUG_MIDI ("WinMMEMidiOut: Garbled MIDI EVENT HEADER!!\n");
368 assert (read_space >= h.size);
370 if (h.size > MAX_MIDI_MSG_SIZE) {
371 m_midi_buffer->increment_read_idx (h.size);
372 DEBUG_MIDI ("WinMMEMidiOut: MIDI event too large!\n");
375 if (m_midi_buffer->read (&data[0], h.size) != h.size) {
376 DEBUG_MIDI ("WinMMEMidiOut: Garbled MIDI EVENT DATA!!\n");
381 DEBUG_MIDI ("WinMMEMidiOut: MIDI buffer underrun, shouldn't occur\n");
384 uint64_t current_time = utils::get_microseconds ();
386 DEBUG_TIMING (string_compose (
387 "WinMMEMidiOut: h.time = %1, current_time = %2\n", h.time, current_time));
389 if (h.time > current_time) {
391 DEBUG_TIMING (string_compose ("WinMMEMidiOut: waiting at %1 for %2 "
392 "milliseconds before sending message\n",
393 ((double)current_time) / 1000.0,
394 ((double)(h.time - current_time)) / 1000.0));
396 if (!wait_for_microseconds (h.time - current_time))
398 DEBUG_MIDI ("WinMMEMidiOut: Error waiting for timer\n");
402 uint64_t wakeup_time = utils::get_microseconds ();
403 DEBUG_TIMING (string_compose ("WinMMEMidiOut: woke up at %1(ms)\n",
404 ((double)wakeup_time) / 1000.0));
405 if (wakeup_time > h.time) {
406 DEBUG_TIMING (string_compose ("WinMMEMidiOut: overslept by %1(ms)\n",
407 ((double)(wakeup_time - h.time)) / 1000.0));
408 } else if (wakeup_time < h.time) {
409 DEBUG_TIMING (string_compose ("WinMMEMidiOut: woke up %1(ms) too early\n",
410 ((double)(h.time - wakeup_time)) / 1000.0));
413 } else if (h.time < current_time) {
414 DEBUG_TIMING (string_compose (
415 "WinMMEMidiOut: MIDI event at sent to driver %1(ms) late\n",
416 ((double)(current_time - h.time)) / 1000.0));
423 message |= (((DWORD)data[2]) << 16);
424 // Fallthrough on purpose.
426 message |= (((DWORD)data[1]) << 8);
427 // Fallthrough on purpose.
429 message |= (DWORD)data[0];
430 result = midiOutShortMsg (m_handle, message);
431 if (result != MMSYSERR_NOERROR) {
433 string_compose ("WinMMEMidiOutput: %1\n", get_error_string (result)));
440 header.dwBufferLength = h.size;
442 header.lpData = (LPSTR)data;
444 result = midiOutPrepareHeader (m_handle, &header, sizeof(MIDIHDR));
445 if (result != MMSYSERR_NOERROR) {
446 DEBUG_MIDI (string_compose ("WinMMEMidiOutput: midiOutPrepareHeader %1\n",
447 get_error_string (result)));
451 result = midiOutLongMsg (m_handle, &header, sizeof(MIDIHDR));
452 if (result != MMSYSERR_NOERROR) {
453 DEBUG_MIDI (string_compose ("WinMMEMidiOutput: midiOutLongMsg %1\n",
454 get_error_string (result)));
458 // Sysex messages may be sent synchronously or asynchronously. The
459 // choice is up to the WinMME driver. So, we wait until the message is
460 // sent, regardless of the driver's choice.
461 if (!wait (m_sysex_semaphore)) {
465 result = midiOutUnprepareHeader (m_handle, &header, sizeof(MIDIHDR));
466 if (result != MMSYSERR_NOERROR) {
467 DEBUG_MIDI (string_compose ("WinMMEMidiOutput: midiOutUnprepareHeader %1\n",
468 get_error_string (result)));
474 m_thread_running = false;
478 WinMMEMidiOutputDevice::wait_for_microseconds (int64_t wait_us)
480 LARGE_INTEGER due_time;
483 due_time.QuadPart = -((LONGLONG)(wait_us * 10));
484 if (!SetWaitableTimer (m_timer, &due_time, 0, NULL, NULL, 0)) {
485 DEBUG_MIDI ("WinMMEMidiOut: Error waiting for timer\n");
489 if (!wait (m_timer)) {
496 } // namespace ARDOUR