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