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                                 input_parser->scanner (ev.buffer[i]);
  82                         }
  83                         input_parser->raw_postparse (*input_parser, ev.buffer, ev.size);
  84                 }
  85         }
  86 }
  87
  88 int
  89 JACK_MidiPort::write(byte * msg, size_t msglen, timestamp_t timestamp)
  90 {
  91         int ret = 0;
  92
  93         if (!is_process_thread()) {
  94
  95                 Glib::Mutex::Lock lm (non_process_thread_fifo_lock);
  96                 RingBuffer<Evoral::Event>::rw_vector vec;
  97
  98                 non_process_thread_fifo.get_write_vector (&vec);
  99
 100                 if (vec.len[0] + vec.len[1] < 1) {
 101                         error << "no space in FIFO for non-process thread MIDI write"
 102                               << endmsg;
 103                         return 0;
 104                 }
 105
 106                 if (vec.len[0]) {
 107                         vec.buf[0]->set (msg, msglen, timestamp);
 108                 } else {
 109                         vec.buf[1]->set (msg, msglen, timestamp);
 110                 }
 111
 112                 non_process_thread_fifo.increment_write_idx (1);
 113
 114                 ret = msglen;
 115
 116         } else {
 117
 118                 assert(_jack_output_port);
 119
 120                 // XXX This had to be temporarily commented out to make export work again
 121                 if (!(timestamp < _nframes_this_cycle)) {
 122                         std::cerr << "assertion timestamp < _nframes_this_cycle failed!" << std::endl;
 123                 }
 124
 125                 if (_currently_in_cycle) {
 126                         if (timestamp == 0) {
 127                                 timestamp = _last_write_timestamp;
 128                         }
 129
 130                         if (jack_midi_event_write (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle),
 131                                                 timestamp, msg, msglen) == 0) {
 132                                 ret = msglen;
 133                                 _last_write_timestamp = timestamp;
 134
 135                         } else {
 136                                 ret = 0;
 137                                 cerr << "write of " << msglen << " failed, port holds "
 138                                         << jack_midi_get_event_count (jack_port_get_buffer (_jack_output_port, _nframes_this_cycle))
 139                                         << endl;
 140                         }
 141                 } else {
 142                         cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
 143                 }
 144         }
 145
 146         if (ret > 0 && output_parser) {
 147                 output_parser->raw_preparse (*output_parser, msg, ret);
 148                 for (int i = 0; i < ret; i++) {
 149                         output_parser->scanner (msg[i]);
 150                 }
 151                 output_parser->raw_postparse (*output_parser, msg, ret);
 152         }
 153
 154         return ret;
 155 }
 156
 157 void
 158 JACK_MidiPort::flush (void* jack_port_buffer)
 159 {
 160         RingBuffer<Evoral::Event>::rw_vector vec;
 161         size_t written;
 162
 163         non_process_thread_fifo.get_read_vector (&vec);
 164
 165         if (vec.len[0] + vec.len[1]) {
 166                 cerr << "Flush " << vec.len[0] + vec.len[1] << " events from non-process FIFO\n";
 167         }
 168
 169         if (vec.len[0]) {
 170                 Evoral::Event* evp = vec.buf[0];
 171
 172                 for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
 173                         jack_midi_event_write (jack_port_buffer,
 174                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 175                 }
 176         }
 177
 178         if (vec.len[1]) {
 179                 Evoral::Event* evp = vec.buf[1];
 180
 181                 for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
 182                         jack_midi_event_write (jack_port_buffer,
 183                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 184                 }
 185         }
 186
 187         if ((written = vec.len[0] + vec.len[1]) != 0) {
 188                 non_process_thread_fifo.increment_read_idx (written);
 189         }
 190 }
 191
 192 int
 193 JACK_MidiPort::read(byte * buf, size_t bufsize)
 194 {
 195         assert(_currently_in_cycle);
 196         assert(_jack_input_port);
 197
 198         jack_midi_event_t ev;
 199
 200         int err = jack_midi_event_get (&ev,
 201                                        jack_port_get_buffer(_jack_input_port, _nframes_this_cycle),
 202                                        _last_read_index++);
 203
 204         // XXX this doesn't handle ev.size > max
 205
 206         if (!err) {
 207                 size_t limit = min (bufsize, ev.size);
 208                 memcpy(buf, ev.buffer, limit);
 209
 210                 if (input_parser) {
 211                         input_parser->raw_preparse (*input_parser, buf, limit);
 212                         for (size_t i = 0; i < limit; i++) {
 213                                 input_parser->scanner (buf[i]);
 214                         }
 215                         input_parser->raw_postparse (*input_parser, buf, limit);
 216                 }
 217
 218                 return limit;
 219         } else {
 220                 return 0;
 221         }
 222 }
 223
 224 int
 225 JACK_MidiPort::create_ports(const XMLNode& node)
 226 {
 227         Descriptor desc (node);
 228
 229         assert(!_jack_input_port);
 230         assert(!_jack_output_port);
 231
 232         jack_nframes_t nframes = jack_get_buffer_size(_jack_client);
 233
 234         bool ret = true;
 235
 236         if (desc.mode == O_RDWR || desc.mode == O_WRONLY) {
 237                 _jack_output_port = jack_port_register(_jack_client,
 238                                                        string(desc.tag).append("_out").c_str(),
 239                                                        JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
 240                 jack_midi_clear_buffer(jack_port_get_buffer(_jack_output_port, nframes));
 241                 ret = ret && (_jack_output_port != NULL);
 242         }
 243
 244         if (desc.mode == O_RDWR || desc.mode == O_RDONLY) {
 245                 _jack_input_port = jack_port_register(_jack_client,
 246                                                       string(desc.tag).append("_in").c_str(),
 247                                                       JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
 248                 jack_midi_clear_buffer(jack_port_get_buffer(_jack_input_port, nframes));
 249                 ret = ret && (_jack_input_port != NULL);
 250         }
 251
 252         return ret ? 0 : -1;
 253 }
 254
 255 XMLNode&
 256 JACK_MidiPort::get_state () const
 257 {
 258         XMLNode& root (Port::get_state ());
 259         return root;
 260 }
 261
 262 void
 263 JACK_MidiPort::set_state (const XMLNode& node)
 264 {
 265 }
 266
 267 void
 268 JACK_MidiPort::set_process_thread (pthread_t thr)
 269 {
 270         _process_thread = thr;
 271 }
 272
 273 bool
 274 JACK_MidiPort::is_process_thread()
 275 {
 276         return (pthread_self() == _process_thread);
 277 }