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