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