libs/ardour/midi_track.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3         By Dave Robillard, 2006
   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 #include "pbd/error.h"
  20
  21 #include "pbd/enumwriter.h"
  22 #include "pbd/convert.h"
  23 #include "midi++/events.h"
  24 #include "evoral/midi_util.h"
  25
  26 #include "ardour/amp.h"
  27 #include "ardour/buffer_set.h"
  28 #include "ardour/debug.h"
  29 #include "ardour/delivery.h"
  30 #include "ardour/io_processor.h"
  31 #include "ardour/meter.h"
  32 #include "ardour/midi_diskstream.h"
  33 #include "ardour/midi_playlist.h"
  34 #include "ardour/midi_port.h"
  35 #include "ardour/midi_region.h"
  36 #include "ardour/midi_source.h"
  37 #include "ardour/midi_track.h"
  38 #include "ardour/panner.h"
  39 #include "ardour/port.h"
  40 #include "ardour/processor.h"
  41 #include "ardour/route_group_specialized.h"
  42 #include "ardour/session.h"
  43 #include "ardour/session_playlists.h"
  44 #include "ardour/utils.h"
  45
  46 #include "i18n.h"
  47
  48 using namespace std;
  49 using namespace ARDOUR;
  50 using namespace PBD;
  51
  52 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
  53         : Track (sess, name, flag, mode, DataType::MIDI)
  54         , _immediate_events(1024) // FIXME: size?
  55         , _step_edit_ring_buffer(64) // FIXME: size?
  56         , _note_mode(Sustained)
  57         , _step_editing (false)
  58         , _default_channel (0)
  59         , _midi_thru (true)
  60 {
  61 }
  62
  63 MidiTrack::~MidiTrack ()
  64 {
  65 }
  66
  67 void
  68 MidiTrack::use_new_diskstream ()
  69 {
  70         MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
  71
  72         if (_flags & Hidden) {
  73                 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
  74         } else {
  75                 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
  76         }
  77
  78         assert(_mode != Destructive);
  79
  80         boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name(), dflags));
  81         ds->do_refill_with_alloc ();
  82         ds->set_block_size (_session.get_block_size ());
  83
  84         set_diskstream (ds);
  85 }
  86
  87 void
  88 MidiTrack::set_record_enabled (bool yn, void *src)
  89 {
  90         if (_step_editing) {
  91                 return;
  92         }
  93
  94         Track::set_record_enabled (yn, src);
  95 }
  96
  97 void
  98 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
  99 {
 100         Track::set_diskstream (ds);
 101
 102         _diskstream->set_track (this);
 103         _diskstream->set_destructive (_mode == Destructive);
 104
 105         _diskstream->set_record_enabled (false);
 106         //_diskstream->monitor_input (false);
 107
 108         _diskstream_data_recorded_connection.disconnect ();
 109         boost::shared_ptr<MidiDiskstream> mds = boost::dynamic_pointer_cast<MidiDiskstream> (ds);
 110         mds->DataRecorded.connect_same_thread (_diskstream_data_recorded_connection, boost::bind (&MidiTrack::diskstream_data_recorded, this, _1, _2));
 111
 112         DiskstreamChanged (); /* EMIT SIGNAL */
 113 }
 114
 115 boost::shared_ptr<MidiDiskstream>
 116 MidiTrack::midi_diskstream() const
 117 {
 118         return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
 119 }
 120
 121 int
 122 MidiTrack::set_state (const XMLNode& node, int version)
 123 {
 124         return _set_state (node, version, true);
 125 }
 126
 127 int
 128 MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
 129 {
 130         const XMLProperty *prop;
 131         XMLNodeConstIterator iter;
 132
 133         if (Route::_set_state (node, version, call_base)) {
 134                 return -1;
 135         }
 136
 137         // No destructive MIDI tracks (yet?)
 138         _mode = Normal;
 139
 140         if ((prop = node.property (X_("note-mode"))) != 0) {
 141                 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
 142         } else {
 143                 _note_mode = Sustained;
 144         }
 145
 146         if ((prop = node.property ("midi-thru")) != 0) {
 147                 set_midi_thru (prop->value() == "yes");
 148         }
 149
 150         if ((prop = node.property ("default-channel")) != 0) {
 151                 set_default_channel ((uint8_t) atoi (prop->value()));
 152         }
 153
 154         XMLNodeList nlist;
 155         XMLNodeConstIterator niter;
 156         XMLNode *child;
 157
 158         nlist = node.children();
 159
 160         if (version >= 3000) {
 161                 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
 162                         boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *child));
 163                         ds->do_refill_with_alloc ();
 164                         set_diskstream (ds);
 165                 }
 166         }
 167
 168         /* set rec-enable control *AFTER* setting up diskstream, because it may want to operate
 169            on the diskstream as it sets its own state
 170         */
 171
 172         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
 173                 child = *niter;
 174
 175                 if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
 176                         if (prop->value() == X_("recenable")) {
 177                                 _rec_enable_control->set_state (*child, version);
 178                         }
 179                 }
 180         }
 181
 182         pending_state = const_cast<XMLNode*> (&node);
 183
 184         if (_session.state_of_the_state() & Session::Loading) {
 185                 _session.StateReady.connect_same_thread (*this, boost::bind (&MidiTrack::set_state_part_two, this));
 186         } else {
 187                 set_state_part_two ();
 188         }
 189
 190         return 0;
 191 }
 192
 193 XMLNode&
 194 MidiTrack::state(bool full_state)
 195 {
 196         XMLNode& root (Route::state(full_state));
 197         XMLNode* freeze_node;
 198         char buf[64];
 199
 200         if (_freeze_record.playlist) {
 201                 XMLNode* inode;
 202
 203                 freeze_node = new XMLNode (X_("freeze-info"));
 204                 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
 205                 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
 206
 207                 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
 208                         inode = new XMLNode (X_("processor"));
 209                         (*i)->id.print (buf, sizeof(buf));
 210                         inode->add_property (X_("id"), buf);
 211                         inode->add_child_copy ((*i)->state);
 212
 213                         freeze_node->add_child_nocopy (*inode);
 214                 }
 215
 216                 root.add_child_nocopy (*freeze_node);
 217         }
 218
 219         root.add_property (X_("note-mode"), enum_2_string (_note_mode));
 220         root.add_child_nocopy (_rec_enable_control->get_state());
 221         root.add_child_nocopy (_diskstream->get_state ());
 222
 223         root.add_property ("step-editing", (_step_editing ? "yes" : "no"));
 224         root.add_property ("note-mode", enum_2_string (_note_mode));
 225         root.add_property ("midi-thru", (_midi_thru ? "yes" : "no"));
 226         snprintf (buf, sizeof (buf), "%d", (int) _default_channel);
 227         root.add_property ("default-channel", buf);
 228
 229         return root;
 230 }
 231
 232 void
 233 MidiTrack::set_state_part_two ()
 234 {
 235         XMLNode* fnode;
 236         XMLProperty* prop;
 237         LocaleGuard lg (X_("POSIX"));
 238
 239         /* This is called after all session state has been restored but before
 240            have been made ports and connections are established.
 241         */
 242
 243         if (pending_state == 0) {
 244                 return;
 245         }
 246
 247         if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
 248
 249                 _freeze_record.state = Frozen;
 250
 251                 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
 252                         delete *i;
 253                 }
 254                 _freeze_record.processor_info.clear ();
 255
 256                 if ((prop = fnode->property (X_("playlist"))) != 0) {
 257                         boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
 258                         if (pl) {
 259                                 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
 260                         } else {
 261                                 _freeze_record.playlist.reset();
 262                                 _freeze_record.state = NoFreeze;
 263                         return;
 264                         }
 265                 }
 266
 267                 if ((prop = fnode->property (X_("state"))) != 0) {
 268                         _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
 269                 }
 270
 271                 XMLNodeConstIterator citer;
 272                 XMLNodeList clist = fnode->children();
 273
 274                 for (citer = clist.begin(); citer != clist.end(); ++citer) {
 275                         if ((*citer)->name() != X_("processor")) {
 276                                 continue;
 277                         }
 278
 279                         if ((prop = (*citer)->property (X_("id"))) == 0) {
 280                                 continue;
 281                         }
 282
 283                         FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
 284                                                                                    boost::shared_ptr<Processor>());
 285                         frii->id = prop->value ();
 286                         _freeze_record.processor_info.push_back (frii);
 287                 }
 288         }
 289
 290         if ((fnode = find_named_node (*pending_state, X_("Diskstream"))) != 0) {
 291                 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *fnode));
 292                 ds->do_refill_with_alloc ();
 293                 ds->set_block_size (_session.get_block_size ());
 294                 set_diskstream (ds);
 295         }
 296
 297         return;
 298 }
 299
 300 int
 301 MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
 302                  bool can_record, bool rec_monitors_input, bool& needs_butler)
 303 {
 304         Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
 305         if (!lm.locked()) {
 306                 return 0;
 307         }
 308
 309         int dret;
 310         boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
 311
 312         automation_snapshot (start_frame);
 313
 314         if (n_outputs().n_total() == 0 && _processors.empty()) {
 315                 return 0;
 316         }
 317
 318         if (!_active) {
 319                 silence (nframes);
 320                 return 0;
 321         }
 322
 323         framepos_t transport_frame = _session.transport_frame();
 324
 325         if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
 326                 /* need to do this so that the diskstream sets its
 327                    playback distance to zero, thus causing diskstream::commit
 328                    to do nothing.
 329                    */
 330                 return diskstream->process (transport_frame, 0, can_record, rec_monitors_input, needs_butler);
 331         }
 332
 333         _silent = false;
 334
 335         if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input, needs_butler)) != 0) {
 336                 silence (nframes);
 337                 return dret;
 338         }
 339
 340         /* special condition applies */
 341
 342         if (_meter_point == MeterInput) {
 343                 _input->process_input (_meter, start_frame, end_frame, nframes);
 344         }
 345
 346         if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
 347
 348                 /* not actually recording, but we want to hear the input material anyway,
 349                    at least potentially (depending on monitoring options)
 350                 */
 351
 352                 passthru (start_frame, end_frame, nframes, 0);
 353
 354         } else {
 355                 /*
 356                    XXX is it true that the earlier test on n_outputs()
 357                    means that we can avoid checking it again here? i think
 358                    so, because changing the i/o configuration of an IO
 359                    requires holding the AudioEngine lock, which we hold
 360                    while in the process() tree.
 361                    */
 362
 363
 364                 /* copy the diskstream data to all output buffers */
 365
 366                 //const size_t limit = n_process_buffers().n_audio();
 367                 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
 368                 MidiBuffer& mbuf (bufs.get_midi (0));
 369
 370                 /* we are a MIDI track, so we always start the chain with a single-channel diskstream */
 371                 ChanCount c;
 372                 c.set_audio (0);
 373                 c.set_midi (1);
 374                 bufs.set_count (c);
 375
 376                 diskstream->get_playback (mbuf, start_frame, end_frame);
 377
 378                 /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
 379
 380                 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
 381
 382                 /* final argument: don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
 383
 384                 process_output_buffers (bufs, start_frame, end_frame, nframes,
 385                                         (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick,
 386                                         (!diskstream->record_enabled() && !_session.transport_stopped()));
 387         }
 388
 389         _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
 390
 391         return 0;
 392 }
 393
 394 int
 395 MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 396                     bool state_changing, bool can_record, bool rec_monitors_input)
 397 {
 398         int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record, rec_monitors_input);
 399
 400         if (ret == 0 && _step_editing) {
 401                 push_midi_input_to_step_edit_ringbuffer (nframes);
 402         }
 403
 404         return ret;
 405 }
 406
 407 void
 408 MidiTrack::realtime_handle_transport_stopped ()
 409 {
 410         Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
 411         if (!lm.locked ()) {
 412                 return;
 413         }
 414
 415         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 416                 (*i)->realtime_handle_transport_stopped ();
 417         }
 418 }
 419
 420 void
 421 MidiTrack::push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes)
 422 {
 423         PortSet& ports (_input->ports());
 424
 425         for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
 426
 427                 Buffer& b (p->get_buffer (nframes));
 428                 const MidiBuffer* const mb = dynamic_cast<MidiBuffer*>(&b);
 429                 assert (mb);
 430
 431                 for (MidiBuffer::const_iterator e = mb->begin(); e != mb->end(); ++e) {
 432
 433                         const Evoral::MIDIEvent<framepos_t> ev(*e, false);
 434
 435                         /* note on, since for step edit, note length is determined
 436                            elsewhere
 437                         */
 438
 439                         if (ev.is_note_on()) {
 440                                 /* we don't care about the time for this purpose */
 441                                 _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
 442                         }
 443                 }
 444         }
 445 }
 446
 447 void
 448 MidiTrack::write_out_of_band_data (BufferSet& bufs, framepos_t /*start*/, framepos_t /*end*/, framecnt_t nframes)
 449 {
 450         // Append immediate events
 451         MidiBuffer& buf (bufs.get_midi (0));
 452         if (_immediate_events.read_space()) {
 453                 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n",
 454                                                             name(), _immediate_events.read_space()));
 455         }
 456         _immediate_events.read (buf, 0, 1, nframes-1); // all stamps = 0
 457
 458         // MIDI thru: send incoming data "through" output
 459         if (_midi_thru && _session.transport_speed() != 0.0f && _input->n_ports().n_midi()) {
 460                 buf.merge_in_place (_input->midi(0)->get_midi_buffer(nframes));
 461         }
 462 }
 463
 464 int
 465 MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t /*end_frame*/)
 466 {
 467         return -1;
 468 }
 469
 470 void
 471 MidiTrack::set_latency_delay (framecnt_t longest_session_latency)
 472 {
 473         Route::set_latency_delay (longest_session_latency);
 474         _diskstream->set_roll_delay (_roll_delay);
 475 }
 476
 477 boost::shared_ptr<Region>
 478 MidiTrack::bounce (InterThreadInfo& /*itt*/)
 479 {
 480         throw;
 481         // vector<MidiSource*> srcs;
 482         // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
 483         return boost::shared_ptr<Region> ();
 484 }
 485
 486
 487 boost::shared_ptr<Region>
 488 MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
 489 {
 490         throw;
 491         //vector<MidiSource*> srcs;
 492         //return _session.write_one_track (*this, start, end, false, srcs, itt);
 493         return boost::shared_ptr<Region> ();
 494 }
 495
 496 void
 497 MidiTrack::freeze_me (InterThreadInfo& /*itt*/)
 498 {
 499 }
 500
 501 void
 502 MidiTrack::unfreeze ()
 503 {
 504         _freeze_record.state = UnFrozen;
 505         FreezeChange (); /* EMIT SIGNAL */
 506 }
 507
 508 void
 509 MidiTrack::set_note_mode (NoteMode m)
 510 {
 511         _note_mode = m;
 512         midi_diskstream()->set_note_mode(m);
 513 }
 514
 515 void
 516 MidiTrack::midi_panic()
 517 {
 518         DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
 519         for (uint8_t channel = 0; channel <= 0xF; channel++) {
 520                 uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
 521                 write_immediate_event(3, ev);
 522                 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
 523                 write_immediate_event(3, ev);
 524                 ev[1] = MIDI_CTL_RESET_CONTROLLERS;
 525                 write_immediate_event(3, ev);
 526         }
 527 }
 528
 529 /** \return true on success, false on failure (no buffer space left)
 530  */
 531 bool
 532 MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
 533 {
 534         if (!Evoral::midi_event_is_valid(buf, size)) {
 535                 cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
 536                 return false;
 537         }
 538         const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
 539         return (_immediate_events.write(0, type, size, buf) == size);
 540 }
 541
 542 void
 543 MidiTrack::MidiControl::set_value(double val)
 544 {
 545         bool valid = false;
 546         if (isinf(val)) {
 547                 cerr << "MIDIControl value is infinity" << endl;
 548         } else if (isnan(val)) {
 549                 cerr << "MIDIControl value is NaN" << endl;
 550         } else if (val < _list->parameter().min()) {
 551                 cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
 552         } else if (val > _list->parameter().max()) {
 553                 cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
 554         } else {
 555                 valid = true;
 556         }
 557
 558         if (!valid) {
 559                 return;
 560         }
 561
 562         assert(val <= _list->parameter().max());
 563         if ( ! automation_playback()) {
 564                 size_t size = 3;
 565                 uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
 566                 switch(_list->parameter().type()) {
 567                 case MidiCCAutomation:
 568                         ev[0] += MIDI_CMD_CONTROL;
 569                         ev[1] = _list->parameter().id();
 570                         ev[2] = int(val);
 571                         break;
 572
 573                 case MidiPgmChangeAutomation:
 574                         size = 2;
 575                         ev[0] += MIDI_CMD_PGM_CHANGE;
 576                         ev[1] = int(val);
 577                         break;
 578
 579                 case MidiChannelPressureAutomation:
 580                         size = 2;
 581                         ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
 582                         ev[1] = int(val);
 583                         break;
 584
 585                 case MidiPitchBenderAutomation:
 586                         ev[0] += MIDI_CMD_BENDER;
 587                         ev[1] = 0x7F & int(val);
 588                         ev[2] = 0x7F & (int(val) >> 7);
 589                         break;
 590
 591                 default:
 592                         assert(false);
 593                 }
 594                 _route->write_immediate_event(size,  ev);
 595         }
 596
 597         AutomationControl::set_value(val);
 598 }
 599
 600 void
 601 MidiTrack::set_step_editing (bool yn)
 602 {
 603         if (_session.record_status() != Session::Disabled) {
 604                 return;
 605         }
 606
 607         if (yn != _step_editing) {
 608                 _step_editing = yn;
 609                 StepEditStatusChange (yn);
 610         }
 611 }
 612
 613 void
 614 MidiTrack::set_default_channel (uint8_t chn)
 615 {
 616         _default_channel = std::min ((unsigned int) chn, 15U);
 617 }
 618
 619 void
 620 MidiTrack::set_midi_thru (bool yn)
 621 {
 622         _midi_thru = yn;
 623 }
 624
 625 boost::shared_ptr<SMFSource>
 626 MidiTrack::write_source (uint32_t)
 627 {
 628         return midi_diskstream()->write_source ();
 629 }
 630
 631 void
 632 MidiTrack::set_channel_mode (ChannelMode mode, uint16_t mask)
 633 {
 634         midi_diskstream()->set_channel_mode (mode, mask);
 635 }
 636
 637 ChannelMode
 638 MidiTrack::get_channel_mode ()
 639 {
 640         return midi_diskstream()->get_channel_mode ();
 641 }
 642
 643 uint16_t
 644 MidiTrack::get_channel_mask ()
 645 {
 646         return midi_diskstream()->get_channel_mask ();
 647 }
 648
 649 boost::shared_ptr<MidiPlaylist>
 650 MidiTrack::midi_playlist ()
 651 {
 652         return midi_diskstream()->midi_playlist ();
 653 }
 654
 655 void
 656 MidiTrack::diskstream_data_recorded (boost::shared_ptr<MidiBuffer> buf, boost::weak_ptr<MidiSource> src)
 657 {
 658         DataRecorded (buf, src); /* EMIT SIGNAL */
 659 }
 660