libs/midi++2/port.cc

   1 /*
   2     Copyright (C) 1998 Paul Barton-Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18     $Id$
  19 */
  20 #include <iostream>
  21 #include <cstdio>
  22 #include <fcntl.h>
  23 #include <errno.h>
  24
  25 #include <jack/jack.h>
  26 #include <jack/midiport.h>
  27
  28 #include "pbd/xml++.h"
  29 #include "pbd/error.h"
  30 #include "pbd/failed_constructor.h"
  31 #include "pbd/convert.h"
  32 #include "pbd/strsplit.h"
  33
  34 #include "midi++/types.h"
  35 #include "midi++/port.h"
  36 #include "midi++/channel.h"
  37
  38 using namespace MIDI;
  39 using namespace std;
  40 using namespace PBD;
  41
  42 pthread_t Port::_process_thread;
  43 Signal0<void> Port::JackHalted;
  44 Signal0<void> Port::MakeConnections;
  45 string Port::state_node_name = "MIDI-port";
  46
  47 Port::Port (string const & name, Flags flags, jack_client_t* jack_client)
  48         : _currently_in_cycle (false)
  49         , _nframes_this_cycle (0)
  50         , _jack_client (jack_client)
  51         , _jack_port (0)
  52         , _last_read_index (0)
  53         , output_fifo (512)
  54         , input_fifo (1024)
  55         , _flags (flags)
  56 {
  57         assert (jack_client);
  58         init (name, flags);
  59 }
  60
  61 Port::Port (const XMLNode& node, jack_client_t* jack_client)
  62         : _currently_in_cycle (false)
  63         , _nframes_this_cycle (0)
  64         , _jack_client (jack_client)
  65         , _jack_port (0)
  66         , _last_read_index (0)
  67         , output_fifo (512)
  68         , input_fifo (1024)
  69 {
  70         assert (jack_client);
  71
  72         Descriptor desc (node);
  73
  74         init (desc.tag, desc.flags);
  75
  76         set_state (node);
  77 }
  78
  79 void
  80 Port::init (string const & name, Flags flags)
  81 {
  82         _ok = false;  /* derived class must set to true if constructor
  83                          succeeds.
  84                       */
  85
  86         _parser = 0;
  87
  88         _tagname = name;
  89         _flags = flags;
  90
  91         _parser = new Parser (*this);
  92
  93         for (int i = 0; i < 16; i++) {
  94                 _channel[i] = new Channel (i, *this);
  95                 _channel[i]->connect_signals ();
  96         }
  97
  98         if (!create_port ()) {
  99                 _ok = true;
 100         }
 101
 102         MakeConnections.connect_same_thread (connect_connection, boost::bind (&Port::make_connections, this));
 103         JackHalted.connect_same_thread (halt_connection, boost::bind (&Port::jack_halted, this));
 104 }
 105
 106
 107 Port::~Port ()
 108 {
 109         for (int i = 0; i < 16; i++) {
 110                 delete _channel[i];
 111         }
 112
 113         if (_jack_port) {
 114                 if (_jack_client && _jack_port) {
 115                         jack_port_unregister (_jack_client, _jack_port);
 116                 }
 117                 _jack_port = 0;
 118         }
 119 }
 120
 121 void
 122 Port::parse (framecnt_t timestamp)
 123 {
 124         byte buf[512];
 125
 126         /* NOTE: parsing is done (if at all) by initiating a read from
 127            the port. Each port implementation calls on the parser
 128            once it has data ready.
 129         */
 130
 131         _parser->set_timestamp (timestamp);
 132
 133         while (1) {
 134
 135                 // cerr << "+++ READ ON " << name() << endl;
 136
 137                 int nread = read (buf, sizeof (buf));
 138
 139                 // cerr << "-- READ (" << nread << " ON " << name() << endl;
 140
 141                 if (nread > 0) {
 142                         if ((size_t) nread < sizeof (buf)) {
 143                                 break;
 144                         } else {
 145                                 continue;
 146                         }
 147                 } else if (nread == 0) {
 148                         break;
 149                 } else if (errno == EAGAIN) {
 150                         break;
 151                 } else {
 152                         fatal << "Error reading from MIDI port " << name() << endmsg;
 153                         /*NOTREACHED*/
 154                 }
 155         }
 156 }
 157
 158 /** Send a clock tick message.
 159  * \return true on success.
 160  */
 161 bool
 162 Port::clock (timestamp_t timestamp)
 163 {
 164         static byte clockmsg = 0xf8;
 165
 166         if (sends_output()) {
 167                 return midimsg (&clockmsg, 1, timestamp);
 168         }
 169
 170         return false;
 171 }
 172
 173 void
 174 Port::cycle_start (pframes_t nframes)
 175 {
 176         assert (_jack_port);
 177
 178         _currently_in_cycle = true;
 179         _nframes_this_cycle = nframes;
 180
 181         assert(_nframes_this_cycle == nframes);
 182         _last_read_index = 0;
 183         _last_write_timestamp = 0;
 184
 185         if (sends_output()) {
 186                 void *buffer = jack_port_get_buffer (_jack_port, nframes);
 187                 jack_midi_clear_buffer (buffer);
 188                 flush (buffer);
 189         }
 190
 191         if (receives_input()) {
 192                 void* jack_buffer = jack_port_get_buffer(_jack_port, nframes);
 193                 const pframes_t event_count = jack_midi_get_event_count(jack_buffer);
 194
 195                 jack_midi_event_t ev;
 196                 timestamp_t cycle_start_frame = jack_last_frame_time (_jack_client);
 197
 198                 for (pframes_t i = 0; i < event_count; ++i) {
 199                         jack_midi_event_get (&ev, jack_buffer, i);
 200                         input_fifo.write (cycle_start_frame + ev.time, (Evoral::EventType) 0, ev.size, ev.buffer);
 201                 }
 202
 203                 if (event_count) {
 204                         xthread.wakeup ();
 205                 }
 206         }
 207 }
 208
 209 void
 210 Port::cycle_end ()
 211 {
 212         if (sends_output()) {
 213                 flush (jack_port_get_buffer (_jack_port, _nframes_this_cycle));
 214         }
 215
 216         _currently_in_cycle = false;
 217         _nframes_this_cycle = 0;
 218 }
 219
 220 std::ostream & MIDI::operator << ( std::ostream & os, const MIDI::Port & port )
 221 {
 222         using namespace std;
 223         os << "MIDI::Port { ";
 224         os << "name: " << port.name();
 225         os << "; ";
 226         os << "ok: " << port.ok();
 227         os << "; ";
 228         os << " }";
 229         return os;
 230 }
 231
 232 Port::Descriptor::Descriptor (const XMLNode& node)
 233 {
 234         const XMLProperty *prop;
 235         bool have_tag = false;
 236         bool have_mode = false;
 237
 238         if ((prop = node.property ("tag")) != 0) {
 239                 tag = prop->value();
 240                 have_tag = true;
 241         }
 242
 243         if ((prop = node.property ("mode")) != 0) {
 244
 245                 if (strings_equal_ignore_case (prop->value(), "output") || strings_equal_ignore_case (prop->value(), "out")) {
 246                         flags = IsOutput;
 247                 } else if (strings_equal_ignore_case (prop->value(), "input") || strings_equal_ignore_case (prop->value(), "in")) {
 248                         flags = IsInput;
 249                 }
 250
 251                 have_mode = true;
 252         }
 253
 254         if (!have_tag || !have_mode) {
 255                 throw failed_constructor();
 256         }
 257 }
 258
 259 void
 260 Port::jack_halted ()
 261 {
 262         _jack_client = 0;
 263         _jack_port = 0;
 264 }
 265
 266 int
 267 Port::write(byte * msg, size_t msglen, timestamp_t timestamp)
 268 {
 269         int ret = 0;
 270
 271         if (!sends_output()) {
 272                 return ret;
 273         }
 274
 275         if (!is_process_thread()) {
 276
 277                 Glib::Mutex::Lock lm (output_fifo_lock);
 278                 RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
 279
 280                 output_fifo.get_write_vector (&vec);
 281
 282                 if (vec.len[0] + vec.len[1] < 1) {
 283                         error << "no space in FIFO for non-process thread MIDI write" << endmsg;
 284                         return 0;
 285                 }
 286
 287                 if (vec.len[0]) {
 288                         if (!vec.buf[0]->owns_buffer()) {
 289                                 vec.buf[0]->set_buffer (0, 0, true);
 290                         }
 291                         vec.buf[0]->set (msg, msglen, timestamp);
 292                 } else {
 293                         if (!vec.buf[1]->owns_buffer()) {
 294                                 vec.buf[1]->set_buffer (0, 0, true);
 295                         }
 296                         vec.buf[1]->set (msg, msglen, timestamp);
 297                 }
 298
 299                 output_fifo.increment_write_idx (1);
 300
 301                 ret = msglen;
 302
 303         } else {
 304
 305                 // XXX This had to be temporarily commented out to make export work again
 306                 if (!(timestamp < _nframes_this_cycle)) {
 307                         std::cerr << "assertion timestamp < _nframes_this_cycle failed!" << std::endl;
 308                 }
 309
 310                 if (_currently_in_cycle) {
 311                         if (timestamp == 0) {
 312                                 timestamp = _last_write_timestamp;
 313                         }
 314
 315                         if (jack_midi_event_write (jack_port_get_buffer (_jack_port, _nframes_this_cycle),
 316                                                 timestamp, msg, msglen) == 0) {
 317                                 ret = msglen;
 318                                 _last_write_timestamp = timestamp;
 319
 320                         } else {
 321                                 ret = 0;
 322                                 cerr << "write of " << msglen << " failed, port holds "
 323                                         << jack_midi_get_event_count (jack_port_get_buffer (_jack_port, _nframes_this_cycle))
 324                                         << endl;
 325                         }
 326                 } else {
 327                         cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
 328                 }
 329         }
 330
 331         if (ret > 0 && _parser) {
 332                 // ardour doesn't care about this and neither should your app, probably
 333                 // output_parser->raw_preparse (*output_parser, msg, ret);
 334                 for (int i = 0; i < ret; i++) {
 335                         _parser->scanner (msg[i]);
 336                 }
 337                 // ardour doesn't care about this and neither should your app, probably
 338                 // output_parser->raw_postparse (*output_parser, msg, ret);
 339         }
 340
 341         return ret;
 342 }
 343
 344 void
 345 Port::flush (void* jack_port_buffer)
 346 {
 347         RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0 } };
 348         size_t written;
 349
 350         output_fifo.get_read_vector (&vec);
 351
 352         if (vec.len[0] + vec.len[1]) {
 353                 // cerr << "Flush " << vec.len[0] + vec.len[1] << " events from non-process FIFO\n";
 354         }
 355
 356         if (vec.len[0]) {
 357                 Evoral::Event<double>* evp = vec.buf[0];
 358
 359                 for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
 360                         jack_midi_event_write (jack_port_buffer,
 361                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 362                 }
 363         }
 364
 365         if (vec.len[1]) {
 366                 Evoral::Event<double>* evp = vec.buf[1];
 367
 368                 for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
 369                         jack_midi_event_write (jack_port_buffer,
 370                                                (timestamp_t) evp->time(), evp->buffer(), evp->size());
 371                 }
 372         }
 373
 374         if ((written = vec.len[0] + vec.len[1]) != 0) {
 375                 output_fifo.increment_read_idx (written);
 376         }
 377 }
 378
 379 int
 380 Port::read (byte *, size_t)
 381 {
 382         if (!receives_input()) {
 383                 return 0;
 384         }
 385
 386         timestamp_t time;
 387         Evoral::EventType type;
 388         uint32_t size;
 389         byte buffer[input_fifo.capacity()];
 390
 391         while (input_fifo.read (&time, &type, &size, buffer)) {
 392                 _parser->set_timestamp (time);
 393                 for (uint32_t i = 0; i < size; ++i) {
 394                         _parser->scanner (buffer[i]);
 395                 }
 396         }
 397
 398         return 0;
 399 }
 400
 401 int
 402 Port::create_port ()
 403 {
 404         _jack_port = jack_port_register(_jack_client, _tagname.c_str(), JACK_DEFAULT_MIDI_TYPE, _flags, 0);
 405         return _jack_port == 0 ? -1 : 0;
 406 }
 407
 408 XMLNode&
 409 Port::get_state () const
 410 {
 411         XMLNode* root = new XMLNode (state_node_name);
 412         root->add_property ("tag", _tagname);
 413
 414         if (_flags == IsInput) {
 415                 root->add_property ("mode", "input");
 416         } else {
 417                 root->add_property ("mode", "output");
 418         }
 419
 420 #if 0
 421         byte device_inquiry[6];
 422
 423         device_inquiry[0] = 0xf0;
 424         device_inquiry[0] = 0x7e;
 425         device_inquiry[0] = 0x7f;
 426         device_inquiry[0] = 0x06;
 427         device_inquiry[0] = 0x02;
 428         device_inquiry[0] = 0xf7;
 429
 430         write (device_inquiry, sizeof (device_inquiry), 0);
 431 #endif
 432
 433         if (_jack_port) {
 434
 435                 const char** jc = jack_port_get_connections (_jack_port);
 436                 string connection_string;
 437                 if (jc) {
 438                         for (int i = 0; jc[i]; ++i) {
 439                                 if (i > 0) {
 440                                         connection_string += ',';
 441                                 }
 442                                 connection_string += jc[i];
 443                         }
 444                         free (jc);
 445                 }
 446
 447                 if (!connection_string.empty()) {
 448                         root->add_property ("connections", connection_string);
 449                 }
 450         } else {
 451                 if (!_connections.empty()) {
 452                         root->add_property ("connections", _connections);
 453                 }
 454         }
 455
 456         return *root;
 457 }
 458
 459 void
 460 Port::set_state (const XMLNode& node)
 461 {
 462         const XMLProperty* prop;
 463
 464         if ((prop = node.property ("tag")) == 0 || prop->value() != _tagname) {
 465                 return;
 466         }
 467
 468         if ((prop = node.property ("connections")) != 0 && _jack_port) {
 469                 _connections = prop->value ();
 470         }
 471 }
 472
 473 void
 474 Port::make_connections ()
 475 {
 476         if (!_connections.empty()) {
 477                 vector<string> ports;
 478                 split (_connections, ports, ',');
 479                 for (vector<string>::iterator x = ports.begin(); x != ports.end(); ++x) {
 480                         if (_jack_client) {
 481                                 if (receives_input()) {
 482                                         jack_connect (_jack_client, (*x).c_str(), jack_port_name (_jack_port));
 483                                 } else {
 484                                         jack_connect (_jack_client, jack_port_name (_jack_port), (*x).c_str());
 485                                 }
 486                                 /* ignore failures */
 487                         }
 488                 }
 489         }
 490
 491         connect_connection.disconnect ();
 492 }
 493
 494 void
 495 Port::set_process_thread (pthread_t thr)
 496 {
 497         _process_thread = thr;
 498 }
 499
 500 bool
 501 Port::is_process_thread()
 502 {
 503         return (pthread_self() == _process_thread);
 504 }
 505
 506 void
 507 Port::reestablish (jack_client_t* jack)
 508 {
 509         _jack_client = jack;
 510         int const r = create_port ();
 511
 512         if (r) {
 513                 PBD::error << "could not reregister ports for " << name() << endmsg;
 514         }
 515 }
 516
 517 void
 518 Port::reconnect ()
 519 {
 520         make_connections ();
 521 }