libs/ardour/midi_source.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: David Robillard
   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
  20 #include <sys/stat.h>
  21 #include <unistd.h>
  22 #include <fcntl.h>
  23 #include <float.h>
  24 #include <cerrno>
  25 #include <ctime>
  26 #include <cmath>
  27 #include <iomanip>
  28 #include <algorithm>
  29
  30 #include <glibmm/fileutils.h>
  31 #include <glibmm/miscutils.h>
  32
  33 #include "pbd/xml++.h"
  34 #include "pbd/pthread_utils.h"
  35 #include "pbd/basename.h"
  36
  37 #include "evoral/Control.hpp"
  38 #include "evoral/EventSink.hpp"
  39
  40 #include "ardour/debug.h"
  41 #include "ardour/file_source.h"
  42 #include "ardour/midi_channel_filter.h"
  43 #include "ardour/midi_model.h"
  44 #include "ardour/midi_source.h"
  45 #include "ardour/midi_state_tracker.h"
  46 #include "ardour/session.h"
  47 #include "ardour/tempo.h"
  48 #include "ardour/session_directory.h"
  49 #include "ardour/source_factory.h"
  50
  51 #include "pbd/i18n.h"
  52
  53 namespace ARDOUR { template <typename T> class MidiRingBuffer; }
  54
  55 using namespace std;
  56 using namespace ARDOUR;
  57 using namespace PBD;
  58
  59 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
  60         : Source(s, DataType::MIDI, name, flags)
  61         , _writing(false)
  62         , _model_iter_valid(false)
  63         , _length_beats(0.0)
  64         , _last_read_end(0)
  65         , _capture_length(0)
  66         , _capture_loop_length(0)
  67 {
  68 }
  69
  70 MidiSource::MidiSource (Session& s, const XMLNode& node)
  71         : Source(s, node)
  72         , _writing(false)
  73         , _model_iter_valid(false)
  74         , _length_beats(0.0)
  75         , _last_read_end(0)
  76         , _capture_length(0)
  77         , _capture_loop_length(0)
  78 {
  79         if (set_state (node, Stateful::loading_state_version)) {
  80                 throw failed_constructor();
  81         }
  82 }
  83
  84 MidiSource::~MidiSource ()
  85 {
  86 }
  87
  88 XMLNode&
  89 MidiSource::get_state ()
  90 {
  91         XMLNode& node (Source::get_state());
  92
  93         if (_captured_for.length()) {
  94                 node.add_property ("captured-for", _captured_for);
  95         }
  96
  97         for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
  98                 XMLNode* child = node.add_child (X_("InterpolationStyle"));
  99                 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
 100                 child->add_property (X_("style"), enum_2_string (i->second));
 101         }
 102
 103         for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
 104                 XMLNode* child = node.add_child (X_("AutomationState"));
 105                 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
 106                 child->add_property (X_("state"), enum_2_string (i->second));
 107         }
 108
 109         return node;
 110 }
 111
 112 int
 113 MidiSource::set_state (const XMLNode& node, int /*version*/)
 114 {
 115         XMLProperty const * prop;
 116         if ((prop = node.property ("captured-for")) != 0) {
 117                 _captured_for = prop->value();
 118         }
 119
 120         XMLNodeList children = node.children ();
 121         for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
 122                 if ((*i)->name() == X_("InterpolationStyle")) {
 123                         if ((prop = (*i)->property (X_("parameter"))) == 0) {
 124                                 error << _("Missing parameter property on InterpolationStyle") << endmsg;
 125                                 return -1;
 126                         }
 127                         Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
 128
 129                         if ((prop = (*i)->property (X_("style"))) == 0) {
 130                                 error << _("Missing style property on InterpolationStyle") << endmsg;
 131                                 return -1;
 132                         }
 133                         Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle>(
 134                                 string_2_enum (prop->value(), s));
 135                         set_interpolation_of (p, s);
 136
 137                 } else if ((*i)->name() == X_("AutomationState")) {
 138                         if ((prop = (*i)->property (X_("parameter"))) == 0) {
 139                                 error << _("Missing parameter property on AutomationState") << endmsg;
 140                                 return -1;
 141                         }
 142                         Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
 143
 144                         if ((prop = (*i)->property (X_("state"))) == 0) {
 145                                 error << _("Missing state property on AutomationState") << endmsg;
 146                                 return -1;
 147                         }
 148                         AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
 149                         set_automation_state_of (p, s);
 150                 }
 151         }
 152
 153         return 0;
 154 }
 155
 156 bool
 157 MidiSource::empty () const
 158 {
 159         return !_length_beats;
 160 }
 161
 162 framecnt_t
 163 MidiSource::length (framepos_t pos) const
 164 {
 165         if (!_length_beats) {
 166                 return 0;
 167         }
 168
 169         BeatsFramesConverter converter(_session.tempo_map(), pos);
 170         return converter.to(_length_beats);
 171 }
 172
 173 void
 174 MidiSource::update_length (framecnt_t)
 175 {
 176         // You're not the boss of me!
 177 }
 178
 179 void
 180 MidiSource::invalidate (const Lock& lock, std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes)
 181 {
 182         _model_iter_valid = false;
 183         _model_iter.invalidate(notes);
 184 }
 185
 186 framecnt_t
 187 MidiSource::midi_read (const Lock&                        lm,
 188                        Evoral::EventSink<framepos_t>&     dst,
 189                        framepos_t                         source_start,
 190                        framepos_t                         start,
 191                        framecnt_t                         cnt,
 192                        Evoral::Range<framepos_t>*         loop_range,
 193                        MidiStateTracker*                  tracker,
 194                        MidiChannelFilter*                 filter,
 195                        const std::set<Evoral::Parameter>& filtered,
 196                        const double                       pulse,
 197                        const double                       start_beats) const
 198 {
 199         //BeatsFramesConverter converter(_session.tempo_map(), source_start);
 200
 201         const double start_qn = (pulse * 4.0) - start_beats;
 202
 203         DEBUG_TRACE (DEBUG::MidiSourceIO,
 204                      string_compose ("MidiSource::midi_read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
 205                                      source_start, start, cnt, tracker, name()));
 206
 207         if (!_model) {
 208                 return read_unlocked (lm, dst, source_start, start, cnt, loop_range, tracker, filter);
 209         }
 210
 211         // Find appropriate model iterator
 212         Evoral::Sequence<Evoral::Beats>::const_iterator& i = _model_iter;
 213         const bool linear_read = _last_read_end != 0 && start == _last_read_end;
 214         if (!linear_read || !_model_iter_valid) {
 215 #if 0
 216                 // Cached iterator is invalid, search for the first event past start
 217                 i = _model->begin(converter.from(start), false, filtered,
 218                                   linear_read ? &_model->active_notes() : NULL);
 219                 _model_iter_valid = true;
 220                 if (!linear_read) {
 221                         _model->active_notes().clear();
 222                 }
 223 #else
 224                 /* hot-fix http://tracker.ardour.org/view.php?id=6541
 225                  * "parallel playback of linked midi regions -> no note-offs"
 226                  *
 227                  * A midi source can be used by multiple tracks simultaneously,
 228                  * in which case midi_read() may be called from different tracks for
 229                  * overlapping time-ranges.
 230                  *
 231                  * However there is only a single iterator for a given midi-source.
 232                  * This results in every midi_read() performing a seek.
 233                  *
 234                  * If seeking is performed with
 235                  *    _model->begin(converter.from(start),...)
 236                  * the model is used for seeking. That method seeks to the first
 237                  * *note-on* event after 'start'.
 238                  *
 239                  * _model->begin(converter.from(  ) ,..) eventually calls
 240                  * Sequence<Time>::const_iterator() in libs/evoral/src/Sequence.cpp
 241                  * which looks up the note-event via seq.note_lower_bound(t);
 242                  * but the sequence 'seq' only contains note-on events(!).
 243                  * note-off events are implicit in Sequence<Time>::operator++()
 244                  * via _active_notes.pop(); and not part of seq.
 245                  *
 246                  * see also http://tracker.ardour.org/view.php?id=6287#c16671
 247                  *
 248                  * The linear search below assures that reading starts at the first
 249                  * event for the given time, regardless of its event-type.
 250                  *
 251                  * The performance of this approach is O(N), while the previous
 252                  * implementation is O(log(N)). This needs to be optimized:
 253                  * The model-iterator or event-sequence needs to be re-designed in
 254                  * some way (maybe keep an iterator per playlist).
 255                  */
 256                 for (i = _model->begin(); i != _model->end(); ++i) {
 257                         if (i->time().to_double() >= start_beats) {
 258                                 break;
 259                         }
 260                 }
 261                 _model_iter_valid = true;
 262                 if (!linear_read) {
 263                         _model->active_notes().clear();
 264                 }
 265 #endif
 266         }
 267
 268         _last_read_end = start + cnt;
 269
 270         // Copy events in [start, start + cnt) into dst
 271         for (; i != _model->end(); ++i) {
 272
 273                 // Offset by source start to convert event time to session time
 274
 275                 framepos_t time_frames = _session.tempo_map().frame_at_quarter_note (i->time().to_double() + start_qn);
 276
 277                 if (time_frames < start + source_start) {
 278                         /* event too early */
 279
 280                         continue;
 281
 282                 } else if (time_frames >= start + cnt + source_start) {
 283
 284                         DEBUG_TRACE (DEBUG::MidiSourceIO,
 285                                      string_compose ("%1: reached end with event @ %2 vs. %3\n",
 286                                                      _name, time_frames, start+cnt));
 287                         break;
 288
 289                 } else {
 290
 291                         /* in range */
 292
 293                         if (filter && filter->filter(i->buffer(), i->size())) {
 294                                 DEBUG_TRACE (DEBUG::MidiSourceIO,
 295                                              string_compose ("%1: filter event @ %2 type %3 size %4\n",
 296                                                              _name, time_frames, i->event_type(), i->size()));
 297                                 continue;
 298                         }
 299
 300                         if (loop_range) {
 301                                 time_frames = loop_range->squish (time_frames);
 302                         }
 303
 304                         dst.write (time_frames, i->event_type(), i->size(), i->buffer());
 305
 306 #ifndef NDEBUG
 307                         if (DEBUG_ENABLED(DEBUG::MidiSourceIO)) {
 308                                 DEBUG_STR_DECL(a);
 309                                 DEBUG_STR_APPEND(a, string_compose ("%1 added event @ %2 sz %3 within %4 .. %5 ",
 310                                                                     _name, time_frames, i->size(),
 311                                                                     start + source_start, start + cnt + source_start));
 312                                 for (size_t n=0; n < i->size(); ++n) {
 313                                         DEBUG_STR_APPEND(a,hex);
 314                                         DEBUG_STR_APPEND(a,"0x");
 315                                         DEBUG_STR_APPEND(a,(int)i->buffer()[n]);
 316                                         DEBUG_STR_APPEND(a,' ');
 317                                 }
 318                                 DEBUG_STR_APPEND(a,'\n');
 319                                 DEBUG_TRACE (DEBUG::MidiSourceIO, DEBUG_STR(a).str());
 320                         }
 321 #endif
 322
 323                         if (tracker) {
 324                                 tracker->track (*i);
 325                         }
 326                 }
 327         }
 328
 329         return cnt;
 330 }
 331
 332 framecnt_t
 333 MidiSource::midi_write (const Lock&                 lm,
 334                         MidiRingBuffer<framepos_t>& source,
 335                         framepos_t                  source_start,
 336                         framecnt_t                  cnt)
 337 {
 338         const framecnt_t ret = write_unlocked (lm, source, source_start, cnt);
 339
 340         if (cnt == max_framecnt) {
 341                 _last_read_end = 0;
 342                 invalidate(lm);
 343         } else {
 344                 _capture_length += cnt;
 345         }
 346
 347         return ret;
 348 }
 349
 350 void
 351 MidiSource::mark_streaming_midi_write_started (const Lock& lock, NoteMode mode)
 352 {
 353         if (_model) {
 354                 _model->set_note_mode (mode);
 355                 _model->start_write ();
 356         }
 357
 358         _writing = true;
 359 }
 360
 361 void
 362 MidiSource::mark_write_starting_now (framecnt_t position,
 363                                      framecnt_t capture_length,
 364                                      framecnt_t loop_length)
 365 {
 366         /* I'm not sure if this is the best way to approach this, but
 367            _capture_length needs to be set up with the transport frame
 368            when a record actually starts, as it is used by
 369            SMFSource::write_unlocked to decide whether incoming notes
 370            are within the correct time range.
 371            mark_streaming_midi_write_started (perhaps a more logical
 372            place to do this) is not called at exactly the time when
 373            record starts, and I don't think it necessarily can be
 374            because it is not RT-safe.
 375         */
 376
 377         set_timeline_position(position);
 378         _capture_length      = capture_length;
 379         _capture_loop_length = loop_length;
 380
 381         TempoMap& map (_session.tempo_map());
 382         BeatsFramesConverter converter(map, position);
 383         _length_beats = converter.from(capture_length);
 384 }
 385
 386 void
 387 MidiSource::mark_streaming_write_started (const Lock& lock)
 388 {
 389         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 390         mark_streaming_midi_write_started (lock, note_mode);
 391 }
 392
 393 void
 394 MidiSource::mark_midi_streaming_write_completed (const Lock&                                      lock,
 395                                                  Evoral::Sequence<Evoral::Beats>::StuckNoteOption option,
 396                                                  Evoral::Beats                                    end)
 397 {
 398         if (_model) {
 399                 _model->end_write (option, end);
 400
 401                 /* Make captured controls discrete to play back user input exactly. */
 402                 for (MidiModel::Controls::iterator i = _model->controls().begin(); i != _model->controls().end(); ++i) {
 403                         if (i->second->list()) {
 404                                 i->second->list()->set_interpolation(Evoral::ControlList::Discrete);
 405                                 _interpolation_style.insert(std::make_pair(i->second->parameter(), Evoral::ControlList::Discrete));
 406                         }
 407                 }
 408         }
 409
 410         invalidate(lock);
 411         _writing = false;
 412 }
 413
 414 void
 415 MidiSource::mark_streaming_write_completed (const Lock& lock)
 416 {
 417         mark_midi_streaming_write_completed (lock, Evoral::Sequence<Evoral::Beats>::DeleteStuckNotes);
 418 }
 419
 420 int
 421 MidiSource::export_write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Evoral::Beats begin, Evoral::Beats end)
 422 {
 423         Lock newsrc_lock (newsrc->mutex ());
 424
 425         if (!_model) {
 426                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during export"));
 427                 return -1;
 428         }
 429
 430         _model->write_section_to (newsrc, newsrc_lock, begin, end, true);
 431
 432         newsrc->flush_midi(newsrc_lock);
 433
 434         return 0;
 435 }
 436
 437 int
 438 MidiSource::write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Evoral::Beats begin, Evoral::Beats end)
 439 {
 440         Lock newsrc_lock (newsrc->mutex ());
 441
 442         newsrc->set_timeline_position (_timeline_position);
 443         newsrc->copy_interpolation_from (this);
 444         newsrc->copy_automation_state_from (this);
 445
 446         if (_model) {
 447                 if (begin == Evoral::MinBeats && end == Evoral::MaxBeats) {
 448                         _model->write_to (newsrc, newsrc_lock);
 449                 } else {
 450                         _model->write_section_to (newsrc, newsrc_lock, begin, end);
 451                 }
 452         } else {
 453                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 454                 return -1;
 455         }
 456
 457         newsrc->flush_midi(newsrc_lock);
 458
 459         /* force a reload of the model if the range is partial */
 460
 461         if (begin != Evoral::MinBeats || end != Evoral::MaxBeats) {
 462                 newsrc->load_model (newsrc_lock, true);
 463         } else {
 464                 newsrc->set_model (newsrc_lock, _model);
 465         }
 466
 467         /* this file is not removable (but since it is MIDI, it is mutable) */
 468
 469         boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
 470
 471         return 0;
 472 }
 473
 474 void
 475 MidiSource::session_saved()
 476 {
 477         Lock lm (_lock);
 478
 479         /* this writes a copy of the data to disk.
 480            XXX do we need to do this every time?
 481         */
 482
 483         if (_model && _model->edited()) {
 484                 /* The model is edited, write its contents into the current source
 485                    file (overwiting previous contents). */
 486
 487                 /* Temporarily drop our reference to the model so that as the model
 488                    pushes its current state to us, we don't try to update it. */
 489                 boost::shared_ptr<MidiModel> mm = _model;
 490                 _model.reset ();
 491
 492                 /* Flush model contents to disk. */
 493                 mm->sync_to_source (lm);
 494
 495                 /* Reacquire model. */
 496                 _model = mm;
 497
 498         } else {
 499                 flush_midi(lm);
 500         }
 501 }
 502
 503 void
 504 MidiSource::set_note_mode(const Lock& lock, NoteMode mode)
 505 {
 506         if (_model) {
 507                 _model->set_note_mode(mode);
 508         }
 509 }
 510
 511 void
 512 MidiSource::drop_model (const Lock& lock)
 513 {
 514         _model.reset();
 515         invalidate(lock);
 516         ModelChanged (); /* EMIT SIGNAL */
 517 }
 518
 519 void
 520 MidiSource::set_model (const Lock& lock, boost::shared_ptr<MidiModel> m)
 521 {
 522         _model = m;
 523         invalidate(lock);
 524         ModelChanged (); /* EMIT SIGNAL */
 525 }
 526
 527 Evoral::ControlList::InterpolationStyle
 528 MidiSource::interpolation_of (Evoral::Parameter p) const
 529 {
 530         InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
 531         if (i == _interpolation_style.end()) {
 532                 return EventTypeMap::instance().interpolation_of (p);
 533         }
 534
 535         return i->second;
 536 }
 537
 538 AutoState
 539 MidiSource::automation_state_of (Evoral::Parameter p) const
 540 {
 541         AutomationStateMap::const_iterator i = _automation_state.find (p);
 542         if (i == _automation_state.end()) {
 543                 /* default to `play', otherwise if MIDI is recorded /
 544                    imported with controllers etc. they are by default
 545                    not played back, which is a little surprising.
 546                 */
 547                 return Play;
 548         }
 549
 550         return i->second;
 551 }
 552
 553 /** Set interpolation style to be used for a given parameter.  This change will be
 554  *  propagated to anyone who needs to know.
 555  */
 556 void
 557 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
 558 {
 559         if (interpolation_of (p) == s) {
 560                 return;
 561         }
 562
 563         if (EventTypeMap::instance().interpolation_of (p) == s) {
 564                 /* interpolation type is being set to the default, so we don't need a note in our map */
 565                 _interpolation_style.erase (p);
 566         } else {
 567                 _interpolation_style[p] = s;
 568         }
 569
 570         InterpolationChanged (p, s); /* EMIT SIGNAL */
 571 }
 572
 573 void
 574 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
 575 {
 576         if (automation_state_of (p) == s) {
 577                 return;
 578         }
 579
 580         if (s == Play) {
 581                 /* automation state is being set to the default, so we don't need a note in our map */
 582                 _automation_state.erase (p);
 583         } else {
 584                 _automation_state[p] = s;
 585         }
 586
 587         AutomationStateChanged (p, s); /* EMIT SIGNAL */
 588 }
 589
 590 void
 591 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
 592 {
 593         copy_interpolation_from (s.get ());
 594 }
 595
 596 void
 597 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
 598 {
 599         copy_automation_state_from (s.get ());
 600 }
 601
 602 void
 603 MidiSource::copy_interpolation_from (MidiSource* s)
 604 {
 605         _interpolation_style = s->_interpolation_style;
 606
 607         /* XXX: should probably emit signals here */
 608 }
 609
 610 void
 611 MidiSource::copy_automation_state_from (MidiSource* s)
 612 {
 613         _automation_state = s->_automation_state;
 614
 615         /* XXX: should probably emit signals here */
 616 }