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