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;
40 pthread_t AsyncMIDIPort::_process_thread;
42 #define port_engine AudioEngine::instance()->port_engine()
44 AsyncMIDIPort::AsyncMIDIPort (string const & name, PortFlags flags)
45 : MidiPort (name, flags)
46 , MIDI::Port (name, MIDI::Port::Flags (0))
47 , _currently_in_cycle (false)
48 , _last_write_timestamp (0)
49 , _flush_at_cycle_start (false)
57 AsyncMIDIPort::~AsyncMIDIPort ()
62 AsyncMIDIPort::set_timer (boost::function<MIDI::framecnt_t (void)>& f)
69 AsyncMIDIPort::flush_output_fifo (MIDI::pframes_t nframes)
71 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0 } };
74 output_fifo.get_read_vector (&vec);
76 MidiBuffer& mb (get_midi_buffer (nframes));
79 Evoral::Event<double>* evp = vec.buf[0];
82 assert (evp->buffer());
84 for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
85 if (mb.push_back (evp->time(), evp->size(), evp->buffer())) {
92 Evoral::Event<double>* evp = vec.buf[1];
95 assert (evp->buffer());
97 for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
98 if (mb.push_back (evp->time(), evp->size(), evp->buffer())) {
104 /* do this "atomically" after we're done pushing events into the
108 output_fifo.increment_read_idx (written);
112 AsyncMIDIPort::cycle_start (MIDI::pframes_t nframes)
114 _currently_in_cycle = true;
115 MidiPort::cycle_start (nframes);
117 /* dump anything waiting in the output FIFO at the start of the port
121 if (ARDOUR::Port::sends_output()) {
122 flush_output_fifo (nframes);
123 if (_flush_at_cycle_start) {
124 flush_buffers (nframes);
128 /* copy incoming data from the port buffer into the input FIFO
129 and if necessary wakeup the reader
132 if (ARDOUR::Port::receives_input()) {
133 MidiBuffer& mb (get_midi_buffer (nframes));
139 when = AudioEngine::instance()->sample_time_at_cycle_start();
142 for (MidiBuffer::iterator b = mb.begin(); b != mb.end(); ++b) {
146 input_fifo.write (when, Evoral::NO_EVENT, (*b).size(), (*b).buffer());
157 AsyncMIDIPort::cycle_end (MIDI::pframes_t nframes)
159 if (ARDOUR::Port::sends_output() && !_flush_at_cycle_start) {
160 /* move any additional data from output FIFO into the port
163 flush_output_fifo (nframes);
166 MidiPort::cycle_end (nframes);
168 _currently_in_cycle = false;
171 /** wait for the output FIFO to be emptied by successive process() callbacks.
173 * Cannot be called from a processing thread.
176 AsyncMIDIPort::drain (int check_interval_usecs, int total_usecs_to_wait)
178 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
180 if (!AudioEngine::instance()->running() || AudioEngine::instance()->session() == 0) {
181 /* no more process calls - it will never drain */
186 if (is_process_thread()) {
187 error << "Process thread called MIDI::AsyncMIDIPort::drain() - this cannot work" << endmsg;
191 microseconds_t now = get_microseconds ();
192 microseconds_t end = now + total_usecs_to_wait;
195 output_fifo.get_write_vector (&vec);
196 if (vec.len[0] + vec.len[1] >= output_fifo.bufsize() - 1) {
199 Glib::usleep (check_interval_usecs);
200 now = get_microseconds();
205 AsyncMIDIPort::write (const MIDI::byte * msg, size_t msglen, MIDI::timestamp_t timestamp)
209 if (!ARDOUR::Port::sends_output()) {
213 if (!is_process_thread()) {
215 /* this is the best estimate of "when" this MIDI data is being
219 _parser->set_timestamp (AudioEngine::instance()->sample_time() + timestamp);
220 for (size_t n = 0; n < msglen; ++n) {
221 _parser->scanner (msg[n]);
224 Glib::Threads::Mutex::Lock lm (output_fifo_lock);
225 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
227 output_fifo.get_write_vector (&vec);
229 if (vec.len[0] + vec.len[1] < 1) {
230 error << "no space in FIFO for non-process thread MIDI write" << endmsg;
235 /* force each event inside the ringbuffer to own its
236 own buffer, but let that be null and of zero size
237 initially. When ::set() is called, the buffer will
238 be allocated to hold a *copy* of the data we're
239 storing, and then that buffer will be used over and
240 over, occasionally being upwardly resized as
243 if (!vec.buf[0]->owns_buffer()) {
244 vec.buf[0]->set_buffer (0, 0, true);
246 vec.buf[0]->set (msg, msglen, timestamp);
248 /* see comment in previous branch of if() statement */
249 if (!vec.buf[1]->owns_buffer()) {
250 vec.buf[1]->set_buffer (0, 0, true);
252 vec.buf[1]->set (msg, msglen, timestamp);
255 output_fifo.increment_write_idx (1);
261 _parser->set_timestamp (AudioEngine::instance()->sample_time_at_cycle_start() + timestamp);
262 for (size_t n = 0; n < msglen; ++n) {
263 _parser->scanner (msg[n]);
266 if (timestamp >= _cycle_nframes) {
267 std::cerr << "attempting to write MIDI event of " << msglen << " MIDI::bytes at time "
268 << timestamp << " of " << _cycle_nframes
269 << " (this will not work - needs a code fix)"
273 /* This is the process thread, which makes checking
274 * _currently_in_cycle atomic and safe, since it is only
275 * set from cycle_start() and cycle_end(), also called
276 * only from the process thread.
279 if (_currently_in_cycle) {
281 MidiBuffer& mb (get_midi_buffer (_cycle_nframes));
283 if (timestamp == 0) {
284 timestamp = _last_write_timestamp;
287 if (mb.push_back (timestamp, msglen, msg)) {
289 _last_write_timestamp = timestamp;
292 cerr << "AsyncMIDIPort (" << ARDOUR::Port::name() << "): write of " << msglen << " @ " << timestamp << " failed\n" << endl;
293 PBD::stacktrace (cerr, 20);
297 cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
298 PBD::stacktrace (cerr, 20);
307 AsyncMIDIPort::read (MIDI::byte *, size_t)
309 if (!ARDOUR::Port::receives_input()) {
314 Evoral::EventType type;
316 vector<MIDI::byte> buffer(input_fifo.capacity());
318 while (input_fifo.read (&time, &type, &size, &buffer[0])) {
319 _parser->set_timestamp (time);
320 for (uint32_t i = 0; i < size; ++i) {
321 _parser->scanner (buffer[i]);
329 AsyncMIDIPort::parse (MIDI::framecnt_t)
333 /* see ::read() to realize why buf is not used */
334 read (buf, sizeof (buf));
338 AsyncMIDIPort::set_process_thread (pthread_t thr)
340 _process_thread = thr;
344 AsyncMIDIPort::is_process_thread()
346 return pthread_equal (pthread_self(), _process_thread);