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