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