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