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_input_device.h"
24 #include "pbd/compose.h"
26 #include "win_utils.h"
27 #include "midi_util.h"
33 static const uint32_t MIDI_BUFFER_SIZE = 32768;
34 static const uint32_t SYSEX_BUFFER_SIZE = 32768;
38 WinMMEMidiInputDevice::WinMMEMidiInputDevice (int index)
40 , m_midi_buffer(new RingBuffer<uint8_t>(MIDI_BUFFER_SIZE))
41 , m_sysex_buffer(new uint8_t[SYSEX_BUFFER_SIZE])
43 DEBUG_MIDI (string_compose ("Creating midi input device index: %1\n", index));
45 std::string error_msg;
47 if (!open (index, error_msg)) {
48 DEBUG_MIDI (error_msg);
49 throw std::runtime_error (error_msg);
52 // perhaps this should be called in open
53 if (!add_sysex_buffer (error_msg)) {
54 DEBUG_MIDI (error_msg);
55 std::string close_error;
56 if (!close (close_error)) {
57 DEBUG_MIDI (close_error);
59 throw std::runtime_error (error_msg);
62 set_device_name (index);
65 WinMMEMidiInputDevice::~WinMMEMidiInputDevice ()
67 std::string error_msg;
68 if (!close (error_msg)) {
69 DEBUG_MIDI (error_msg);
74 WinMMEMidiInputDevice::open (UINT index, std::string& error_msg)
76 MMRESULT result = midiInOpen (&m_handle,
78 (DWORD_PTR) winmm_input_callback,
80 CALLBACK_FUNCTION | MIDI_IO_STATUS);
81 if (result != MMSYSERR_NOERROR) {
82 error_msg = get_error_string (result);
85 DEBUG_MIDI (string_compose ("Opened MIDI device index %1\n", index));
90 WinMMEMidiInputDevice::close (std::string& error_msg)
92 // return error message for first error encountered?
95 MMRESULT result = midiInReset (m_handle);
96 if (result != MMSYSERR_NOERROR) {
97 error_msg = get_error_string (result);
98 DEBUG_MIDI (error_msg);
101 result = midiInUnprepareHeader (m_handle, &m_sysex_header, sizeof(MIDIHDR));
102 if (result != MMSYSERR_NOERROR) {
103 error_msg = get_error_string (result);
104 DEBUG_MIDI (error_msg);
107 result = midiInClose (m_handle);
108 if (result != MMSYSERR_NOERROR) {
109 error_msg = get_error_string (result);
110 DEBUG_MIDI (error_msg);
115 DEBUG_MIDI (string_compose ("Closed MIDI device: %1\n", name ()));
117 DEBUG_MIDI (string_compose ("Unable to Close MIDI device: %1\n", name ()));
123 WinMMEMidiInputDevice::add_sysex_buffer (std::string& error_msg)
125 m_sysex_header.dwBufferLength = SYSEX_BUFFER_SIZE;
126 m_sysex_header.dwFlags = 0;
127 m_sysex_header.lpData = (LPSTR)m_sysex_buffer.get ();
129 MMRESULT result = midiInPrepareHeader (m_handle, &m_sysex_header, sizeof(MIDIHDR));
131 if (result != MMSYSERR_NOERROR) {
132 error_msg = get_error_string (result);
133 DEBUG_MIDI (error_msg);
136 result = midiInAddBuffer (m_handle, &m_sysex_header, sizeof(MIDIHDR));
137 if (result != MMSYSERR_NOERROR) {
138 error_msg = get_error_string (result);
139 DEBUG_MIDI (error_msg);
146 WinMMEMidiInputDevice::set_device_name (UINT index)
148 MIDIINCAPS capabilities;
149 MMRESULT result = midiInGetDevCaps (index, &capabilities, sizeof(capabilities));
150 if (result != MMSYSERR_NOERROR) {
151 DEBUG_MIDI (get_error_string (result));
152 m_name = "Unknown Midi Input Device";
155 m_name = capabilities.szPname;
161 WinMMEMidiInputDevice::get_error_string (MMRESULT error_code)
163 char error_msg[MAXERRORLENGTH];
164 MMRESULT result = midiInGetErrorText (error_code, error_msg, MAXERRORLENGTH);
165 if (result != MMSYSERR_NOERROR) {
168 return "WinMMEMidiInput: Unknown Error code";
172 WinMMEMidiInputDevice::winmm_input_callback(HMIDIIN handle,
178 WinMMEMidiInputDevice* midi_input = (WinMMEMidiInputDevice*)instance;
180 #ifdef USE_MMCSS_THREAD_PRIORITIES
182 static HANDLE input_thread = GetCurrentThread ();
183 static bool priority_boosted = false;
185 #if 0 // GetThreadId() is Vista or later only.
186 if (input_thread != GetCurrentThread ()) {
187 DWORD otid = GetThreadId (input_thread);
188 DWORD ntid = GetThreadId (GetCurrentThread ());
189 // There was a reference on the internet somewhere that it is possible
190 // for the callback to come from different threads(thread pool) this
191 // could be problematic but I haven't seen this behaviour yet
192 DEBUG_THREADS (string_compose (
193 "WinMME input Thread ID Changed: was %1, now %2\n", otid, ntid));
199 if (!priority_boosted) {
200 mmcss::set_thread_characteristics ("Pro Audio", &task_handle);
201 mmcss::set_thread_priority (task_handle, mmcss::AVRT_PRIORITY_HIGH);
202 priority_boosted = true;
209 // devices_changed_callback
212 // passing MIDI_IO_STATUS to midiInOpen means that MIM_MOREDATA
213 // will be sent when the callback isn't processing MIM_DATA messages
214 // fast enough to keep up with messages arriving at input device
215 // driver. I'm not sure what could be done differently if that occurs
216 // so just handle MIM_DATA as per normal
218 midi_input->handle_short_msg ((const uint8_t*)&midi_msg, (uint32_t)timestamp);
221 midi_input->handle_sysex_msg ((MIDIHDR*)&midi_msg, (uint32_t)timestamp);
224 DEBUG_MIDI ("WinMME: Driver sent an invalid MIDI message\n");
227 DEBUG_MIDI ("WinMME: Driver sent an invalid or incomplete SYSEX message\n");
233 WinMMEMidiInputDevice::handle_short_msg (const uint8_t* midi_data,
236 int length = get_midi_msg_length (midi_data[0]);
238 if (length == 0 || length == -1) {
239 DEBUG_MIDI ("ERROR: midi input driver sent an invalid midi message\n");
243 enqueue_midi_msg (midi_data, length, timestamp);
247 WinMMEMidiInputDevice::handle_sysex_msg (MIDIHDR* const midi_header,
251 LPMIDIHDR header = (LPMIDIHDR)midi_header;
252 size_t byte_count = header->dwBytesRecorded;
256 "ERROR: WinMME driver has returned sysex header to us with no bytes\n");
260 uint8_t* data = (uint8_t*)header->lpData;
262 if ((data[0] != 0xf0) || (data[byte_count - 1] != 0xf7)) {
263 DEBUG_MIDI (string_compose ("Discarding %1 byte sysex chunk\n", byte_count));
265 enqueue_midi_msg (data, byte_count, timestamp);
268 MMRESULT result = midiInAddBuffer (m_handle, &m_sysex_header, sizeof(MIDIHDR));
269 if (result != MMSYSERR_NOERROR) {
270 DEBUG_MIDI (get_error_string (result));
277 WinMMEMidiInputDevice::dequeue_midi_event (uint64_t timestamp_start,
278 uint64_t timestamp_end,
283 const uint32_t read_space = m_midi_buffer->read_space();
284 struct MidiEventHeader h(0,0);
286 if (read_space <= sizeof(MidiEventHeader)) {
290 RingBuffer<uint8_t>::rw_vector vector;
291 m_midi_buffer->get_read_vector (&vector);
292 if (vector.len[0] >= sizeof(MidiEventHeader)) {
293 memcpy ((uint8_t*)&h, vector.buf[0], sizeof(MidiEventHeader));
295 if (vector.len[0] > 0) {
296 memcpy ((uint8_t*)&h, vector.buf[0], vector.len[0]);
298 assert (vector.buf[1] || vector.len[0] == sizeof(MidiEventHeader));
299 memcpy (((uint8_t*)&h) + vector.len[0],
301 sizeof(MidiEventHeader) - vector.len[0]);
304 if (h.time >= timestamp_end) {
305 DEBUG_TIMING (string_compose ("WinMMEMidiInput EVENT %1(ms) early\n",
306 (h.time - timestamp_end) * 1e-3));
308 } else if (h.time < timestamp_start) {
309 DEBUG_TIMING (string_compose ("WinMMEMidiInput EVENT %1(ms) late\n",
310 (timestamp_start - h.time) * 1e-3));
313 m_midi_buffer->increment_read_idx (sizeof(MidiEventHeader));
316 if (h.size > data_size) {
317 DEBUG_MIDI ("WinMMEMidiInput::dequeue_event MIDI event too large!\n");
318 m_midi_buffer->increment_read_idx (h.size);
321 if (m_midi_buffer->read (&midi_data[0], h.size) != h.size) {
322 DEBUG_MIDI ("WinMMEMidiInput::dequeue_event Garbled MIDI EVENT DATA!!\n");
331 WinMMEMidiInputDevice::enqueue_midi_msg (const uint8_t* midi_data,
335 const uint32_t total_size = sizeof(MidiEventHeader) + data_size;
337 if (data_size == 0) {
338 DEBUG_MIDI ("ERROR: zero length midi data\n");
342 if (m_midi_buffer->write_space () < total_size) {
343 DEBUG_MIDI ("WinMMEMidiInput: ring buffer overflow\n");
347 // don't use winmme timestamps for now
348 uint64_t ts = utils::get_microseconds ();
350 DEBUG_TIMING (string_compose (
351 "Enqueing MIDI data device: %1 with timestamp: %2 and size %3\n",
356 struct MidiEventHeader h (ts, data_size);
357 m_midi_buffer->write ((uint8_t*)&h, sizeof(MidiEventHeader));
358 m_midi_buffer->write (midi_data, data_size);
363 WinMMEMidiInputDevice::start ()
366 MMRESULT result = midiInStart (m_handle);
367 m_started = (result == MMSYSERR_NOERROR);
369 DEBUG_MIDI (get_error_string (result));
372 string_compose ("WinMMEMidiInput: device %1 started\n", name ()));
379 WinMMEMidiInputDevice::stop ()
382 MMRESULT result = midiInStop (m_handle);
383 m_started = (result != MMSYSERR_NOERROR);
385 DEBUG_MIDI (get_error_string (result));
388 string_compose ("WinMMEMidiInput: device %1 stopped\n", name ()));
394 } // namespace ARDOUR