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