2 Copyright (C) 1998 Paul Barton-Davis
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.
24 #include <glibmm/timer.h>
26 #include "pbd/error.h"
27 #include "pbd/stacktrace.h"
29 #include "midi++/types.h"
31 #include "ardour/async_midi_port.h"
32 #include "ardour/audioengine.h"
33 #include "ardour/midi_buffer.h"
36 using namespace ARDOUR;
41 template class EventRingBuffer<MIDI::timestamp_t>;
44 pthread_t AsyncMIDIPort::_process_thread;
46 #define port_engine AudioEngine::instance()->port_engine()
48 AsyncMIDIPort::AsyncMIDIPort (string const & name, PortFlags flags)
49 : MidiPort (name, flags)
50 , MIDI::Port (name, MIDI::Port::Flags (0))
51 , _currently_in_cycle (false)
52 , _last_write_timestamp (0)
55 #ifndef PLATFORM_WINDOWS
61 AsyncMIDIPort::~AsyncMIDIPort ()
66 AsyncMIDIPort::flush_output_fifo (MIDI::pframes_t nframes)
68 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0 } };
71 output_fifo.get_read_vector (&vec);
73 MidiBuffer& mb (get_midi_buffer (nframes));
76 Evoral::Event<double>* evp = vec.buf[0];
78 for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
79 mb.push_back (evp->time(), evp->size(), evp->buffer());
84 Evoral::Event<double>* evp = vec.buf[1];
86 for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
87 mb.push_back (evp->time(), evp->size(), evp->buffer());
91 if ((written = vec.len[0] + vec.len[1]) != 0) {
92 output_fifo.increment_read_idx (written);
97 AsyncMIDIPort::cycle_start (MIDI::pframes_t nframes)
99 _currently_in_cycle = true;
100 MidiPort::cycle_start (nframes);
102 /* dump anything waiting in the output FIFO at the start of the port
106 if (ARDOUR::Port::sends_output()) {
107 flush_output_fifo (nframes);
110 /* copy incoming data from the port buffer into the input FIFO
111 and if necessary wakeup the reader
114 if (ARDOUR::Port::receives_input()) {
115 MidiBuffer& mb (get_midi_buffer (nframes));
116 pframes_t when = AudioEngine::instance()->sample_time_at_cycle_start();
118 for (MidiBuffer::iterator b = mb.begin(); b != mb.end(); ++b) {
119 input_fifo.write (when, (Evoral::EventType) 0, (*b).size(), (*b).buffer());
122 #ifndef PLATFORM_WINDOWS
131 AsyncMIDIPort::cycle_end (MIDI::pframes_t nframes)
133 if (ARDOUR::Port::sends_output()) {
134 /* move any additional data from output FIFO into the port
137 flush_output_fifo (nframes);
140 MidiPort::cycle_end (nframes);
142 _currently_in_cycle = false;
145 /** wait for the output FIFO to be emptied by successive process() callbacks.
147 * Cannot be called from a processing thread.
150 AsyncMIDIPort::drain (int check_interval_usecs)
152 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
154 if (!AudioEngine::instance()->running() || AudioEngine::instance()->session() == 0) {
155 /* no more process calls - it will never drain */
160 if (is_process_thread()) {
161 error << "Process thread called MIDI::AsyncMIDIPort::drain() - this cannot work" << endmsg;
166 output_fifo.get_write_vector (&vec);
167 if (vec.len[0] + vec.len[1] >= output_fifo.bufsize() - 1) {
170 Glib::usleep (check_interval_usecs);
175 AsyncMIDIPort::write (const MIDI::byte * msg, size_t msglen, MIDI::timestamp_t timestamp)
179 if (!ARDOUR::Port::sends_output()) {
183 if (!is_process_thread()) {
185 /* this is the best estimate of "when" this MIDI data is being
189 _parser->set_timestamp (AudioEngine::instance()->sample_time() + timestamp);
190 for (size_t n = 0; n < msglen; ++n) {
191 _parser->scanner (msg[n]);
194 Glib::Threads::Mutex::Lock lm (output_fifo_lock);
195 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
197 output_fifo.get_write_vector (&vec);
199 if (vec.len[0] + vec.len[1] < 1) {
200 error << "no space in FIFO for non-process thread MIDI write" << endmsg;
205 if (!vec.buf[0]->owns_buffer()) {
206 vec.buf[0]->set_buffer (0, 0, true);
208 vec.buf[0]->set (msg, msglen, timestamp);
210 if (!vec.buf[1]->owns_buffer()) {
211 vec.buf[1]->set_buffer (0, 0, true);
213 vec.buf[1]->set (msg, msglen, timestamp);
216 output_fifo.increment_write_idx (1);
222 _parser->set_timestamp (AudioEngine::instance()->sample_time_at_cycle_start() + timestamp);
223 for (size_t n = 0; n < msglen; ++n) {
224 _parser->scanner (msg[n]);
227 if (timestamp >= _cycle_nframes) {
228 std::cerr << "attempting to write MIDI event of " << msglen << " MIDI::bytes at time "
229 << timestamp << " of " << _cycle_nframes
230 << " (this will not work - needs a code fix)"
234 /* This is the process thread, which makes checking
235 * _currently_in_cycle atomic and safe, since it is only
236 * set from cycle_start() and cycle_end(), also called
237 * only from the process thread.
240 if (_currently_in_cycle) {
242 MidiBuffer& mb (get_midi_buffer (_cycle_nframes));
244 if (timestamp == 0) {
245 timestamp = _last_write_timestamp;
248 if (mb.push_back (timestamp, msglen, msg)) {
250 _last_write_timestamp = timestamp;
253 cerr << "AsyncMIDIPort (" << ARDOUR::Port::name() << "): write of " << msglen << " @ " << timestamp << " failed\n" << endl;
254 PBD::stacktrace (cerr, 20);
258 cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
259 PBD::stacktrace (cerr, 20);
268 AsyncMIDIPort::read (MIDI::byte *, size_t)
270 if (!ARDOUR::Port::receives_input()) {
275 Evoral::EventType type;
277 vector<MIDI::byte> buffer(input_fifo.capacity());
279 while (input_fifo.read (&time, &type, &size, &buffer[0])) {
280 _parser->set_timestamp (time);
281 for (uint32_t i = 0; i < size; ++i) {
282 _parser->scanner (buffer[i]);
290 AsyncMIDIPort::parse (MIDI::framecnt_t)
294 /* see ::read() to realize why buf is not used */
295 read (buf, sizeof (buf));
299 AsyncMIDIPort::set_process_thread (pthread_t thr)
301 _process_thread = thr;
305 AsyncMIDIPort::is_process_thread()
307 return pthread_equal (pthread_self(), _process_thread);