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