libs/midi++2/jack_midiport.cc

   1 /*
   2   Copyright (C) 2006 Paul Davis
   3   Written by Dave Robillard
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9
  10   This program is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, write to the Free Software
  17   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <fcntl.h>
  21 #include <cerrno>
  22 #include <cassert>
  23
  24 #include <pbd/error.h>
  25
  26 #include <midi++/types.h>
  27 #include <midi++/jack.h>
  28
  29 using namespace std;
  30 using namespace MIDI;
  31 using namespace PBD;
  32
  33 pthread_t JACK_MidiPort::_process_thread;
  34
  35 JACK_MidiPort::JACK_MidiPort(const XMLNode& node, jack_client_t* jack_client)
  36         : Port(node)
  37         , _jack_client(jack_client)
  38         , _jack_input_port(NULL)
  39         , _jack_output_port(NULL)
  40         , _last_read_index(0)
  41         , non_process_thread_fifo (512)
  42 {
  43         int err = create_ports (node);
  44
  45         if (!err) {
  46                 _ok = true;
  47         }
  48 }
  49
  50 JACK_MidiPort::~JACK_MidiPort()
  51 {
  52         // FIXME: remove port
  53 }
  54
  55 void
  56 JACK_MidiPort::cycle_start (nframes_t nframes)
  57 {
  58         Port::cycle_start(nframes);
  59         assert(_nframes_this_cycle == nframes);
  60         _last_read_index = 0;
  61         _last_write_timestamp = 0;
  62
  63         // output
  64         void *buffer = jack_port_get_buffer (_jack_output_port, nframes);
  65         jack_midi_clear_buffer (buffer);
  66         flush (buffer);
  67
  68         // input
  69         void* jack_buffer = jack_port_get_buffer(_jack_input_port, nframes);
  70         const nframes_t event_count = jack_midi_get_event_count(jack_buffer);
  71
  72         jack_midi_event_t ev;
  73
  74         for (nframes_t i=0; i < event_count; ++i) {
  75
  76                 jack_midi_event_get (&ev, jack_buffer, i);
  77
  78                 if (input_parser) {
  79                         input_parser->raw_preparse (*input_parser, ev.buffer, ev.size);
  80                         for (size_t i = 0; i < ev.size; i++) {
  81                                 // the midi events here are used for MIDI clock only
  82                                 input_parser->set_midi_clock_timestamp(ev.time + jack_last_frame_time(_jack_client));
  83                                 input_parser->scanner (ev.buffer[i]);
  84                         }
  85                         input_parser->raw_postparse (*input_parser, ev.buffer, ev.size);
  86                 }
  87         }
  88 }
  89
  90 int
  91 JACK_MidiPort::write(byte * msg, size_t msglen, timestamp_t timestamp)
  92 {
  93         int ret = 0;
  94
  95         if (!is_process_thread()) {
  96
  97                 Glib::Mutex::Lock lm (non_process_thread_fifo_lock);
  98                 RingBuffer<Evoral::Event>::rw_vector vec;
  99
 100                 non_process_thread_fifo.get_write_vector (&vec);
 101
 102                 if (vec.len[0] + vec.len[1] < 1) {
 103                         error << "no space in FIFO for non-process thread MIDI write"
 104                               << endmsg;
 105                         return 0;
 106                 }
 107
 108                 if (vec.len[0]) {
 109                         vec.buf[0]->set (msg, msglen, timestamp);
 110                 } else {
 111                         vec.buf[1]->set (msg, msglen, timestamp);
 112                 }
 113
 114                 non_process_thread_fifo.increment_write_idx (1);
 115
 116                 ret = msglen;
 117
 118         } else {
 119
 120                 assert(_jack_output_port);
 121
 122                 // XXX This had to be temporarily commented out to make export work again
 123                 if (!(timestamp < _nframes_this_cycle)) {
 124                         std::cerr << "assertion timestamp < _nframes_this_cycle failed!" << std::endl;
 125                 }
 126
 127                 if (_currently_in_cycle) {
 128                         if (timestamp == 0) {
 129                                 timestamp = _last_write_timestamp;
 130                         }
 131
 132                         if (jack_midi_event_write (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle),
 133                                                 timestamp, msg, msglen) == 0) {
 134                                 ret = msglen;
 135                                 _last_write_timestamp = timestamp;
 136
 137                         } else {
 138                                 ret = 0;
 139                                 cerr << "write of " << msglen << " failed, port holds "
 140                                         << jack_midi_get_event_count (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle))
 141                                         << endl;
 142                         }
 143                 } else {
 144                         cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
 145                 }
 146         }
 147
 148         if (ret > 0 && output_parser) {
 149                 output_parser->raw_preparse (*output_parser, msg, ret);
 150                 for (int i = 0; i < ret; i++) {
 151                         output_parser->scanner (msg[i]);
 152                 }
 153                 output_parser->raw_postparse (*output_parser, msg, ret);
 154         }
 155
 156         return ret;
 157 }
 158
 159 void
 160 JACK_MidiPort::flush (void* jack_port_buffer)
 161 {
 162         RingBuffer<Evoral::Event>::rw_vector vec;
 163         size_t written;
 164
 165         non_process_thread_fifo.get_read_vector (&vec);
 166
 167         if (vec.len[0] + vec.len[1]) {
 168                 cerr << "Flush " << vec.len[0] + vec.len[1] << " events from non-process FIFO\n";
 169         }
 170
 171         if (vec.len[0]) {
 172                 Evoral::Event* evp = vec.buf[0];
 173
 174                 for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
 175                         jack_midi_event_write (jack_port_buffer,
 176                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 177                 }
 178         }
 179
 180         if (vec.len[1]) {
 181                 Evoral::Event* evp = vec.buf[1];
 182
 183                 for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
 184                         jack_midi_event_write (jack_port_buffer,
 185                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 186                 }
 187         }
 188
 189         if ((written = vec.len[0] + vec.len[1]) != 0) {
 190                 non_process_thread_fifo.increment_read_idx (written);
 191         }
 192 }
 193
 194 int
 195 JACK_MidiPort::read(byte * buf, size_t bufsize)
 196 {
 197         assert(_currently_in_cycle);
 198         assert(_jack_input_port);
 199
 200         jack_midi_event_t ev;
 201
 202         int err = jack_midi_event_get (&ev,
 203                                        jack_port_get_buffer(_jack_input_port, _nframes_this_cycle),
 204                                        _last_read_index++);
 205
 206         // XXX this doesn't handle ev.size > max
 207
 208         if (!err) {
 209                 size_t limit = min (bufsize, ev.size);
 210                 memcpy(buf, ev.buffer, limit);
 211
 212                 if (input_parser) {
 213                         input_parser->raw_preparse (*input_parser, buf, limit);
 214                         for (size_t i = 0; i < limit; i++) {
 215                                 input_parser->scanner (buf[i]);
 216                         }
 217                         input_parser->raw_postparse (*input_parser, buf, limit);
 218                 }
 219
 220                 return limit;
 221         } else {
 222                 return 0;
 223         }
 224 }
 225
 226 int
 227 JACK_MidiPort::create_ports(const XMLNode& node)
 228 {
 229         Descriptor desc (node);
 230
 231         assert(!_jack_input_port);
 232         assert(!_jack_output_port);
 233
 234         jack_nframes_t nframes = jack_get_buffer_size(_jack_client);
 235
 236         bool ret = true;
 237
 238         if (desc.mode == O_RDWR || desc.mode == O_WRONLY) {
 239                 _jack_output_port = jack_port_register(_jack_client,
 240                                                        string(desc.tag).append("_out").c_str(),
 241                                                        JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
 242                 jack_midi_clear_buffer(jack_port_get_buffer(_jack_output_port, nframes));
 243                 ret = ret && (_jack_output_port != NULL);
 244         }
 245
 246         if (desc.mode == O_RDWR || desc.mode == O_RDONLY) {
 247                 _jack_input_port = jack_port_register(_jack_client,
 248                                                       string(desc.tag).append("_in").c_str(),
 249                                                       JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
 250                 jack_midi_clear_buffer(jack_port_get_buffer(_jack_input_port, nframes));
 251                 ret = ret && (_jack_input_port != NULL);
 252         }
 253
 254         return ret ? 0 : -1;
 255 }
 256
 257 XMLNode&
 258 JACK_MidiPort::get_state () const
 259 {
 260         XMLNode& root (Port::get_state ());
 261         return root;
 262 }
 263
 264 void
 265 JACK_MidiPort::set_state (const XMLNode& node)
 266 {
 267 }
 268
 269 void
 270 JACK_MidiPort::set_process_thread (pthread_t thr)
 271 {
 272         _process_thread = thr;
 273 }
 274
 275 bool
 276 JACK_MidiPort::is_process_thread()
 277 {
 278         return (pthread_self() == _process_thread);
 279 }