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