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         , _length_beats(0.0)
  60         , _capture_length(0)
  61         , _capture_loop_length(0)
  62 {
  63 }
  64
  65 MidiSource::MidiSource (Session& s, const XMLNode& node)
  66         : Source(s, node)
  67         , _writing(false)
  68         , _length_beats(0.0)
  69         , _capture_length(0)
  70         , _capture_loop_length(0)
  71 {
  72         if (set_state (node, Stateful::loading_state_version)) {
  73                 throw failed_constructor();
  74         }
  75 }
  76
  77
  78 MidiSource::~MidiSource ()
  79 {
  80 }
  81
  82 XMLNode&
  83 MidiSource::get_state ()
  84 {
  85         XMLNode& node (Source::get_state());
  86
  87         if (_captured_for.length()) {
  88                 node.add_property ("captured-for", _captured_for);
  89         }
  90
  91         for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
  92                 XMLNode* child = node.add_child (X_("InterpolationStyle"));
  93                 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
  94                 child->add_property (X_("style"), enum_2_string (i->second));
  95         }
  96
  97         for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
  98                 XMLNode* child = node.add_child (X_("AutomationState"));
  99                 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
 100                 child->add_property (X_("state"), enum_2_string (i->second));
 101         }
 102
 103         return node;
 104 }
 105
 106 int
 107 MidiSource::set_state (const XMLNode& node, int /*version*/)
 108 {
 109         const XMLProperty* prop;
 110
 111         if ((prop = node.property ("captured-for")) != 0) {
 112                 _captured_for = prop->value();
 113         }
 114
 115         XMLNodeList children = node.children ();
 116         for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
 117                 if ((*i)->name() == X_("InterpolationStyle")) {
 118                         XMLProperty* prop;
 119
 120                         if ((prop = (*i)->property (X_("parameter"))) == 0) {
 121                                 error << _("Missing parameter property on InterpolationStyle") << endmsg;
 122                                 return -1;
 123                         }
 124
 125                         Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
 126
 127                         if ((prop = (*i)->property (X_("style"))) == 0) {
 128                                 error << _("Missing style property on InterpolationStyle") << endmsg;
 129                                 return -1;
 130                         }
 131
 132                         Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
 133                         set_interpolation_of (p, s);
 134
 135                 } else if ((*i)->name() == X_("AutomationState")) {
 136
 137                         XMLProperty* prop;
 138
 139                         if ((prop = (*i)->property (X_("parameter"))) == 0) {
 140                                 error << _("Missing parameter property on AutomationState") << endmsg;
 141                                 return -1;
 142                         }
 143
 144                         Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
 145
 146                         if ((prop = (*i)->property (X_("state"))) == 0) {
 147                                 error << _("Missing state property on AutomationState") << endmsg;
 148                                 return -1;
 149                         }
 150
 151                         AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
 152                         set_automation_state_of (p, s);
 153                 }
 154         }
 155
 156         return 0;
 157 }
 158
 159 bool
 160 MidiSource::empty () const
 161 {
 162         return _length_beats == 0;
 163 }
 164
 165 framecnt_t
 166 MidiSource::length (framepos_t pos) const
 167 {
 168         if (_length_beats == 0) {
 169                 return 0;
 170         }
 171
 172         BeatsFramesConverter converter(_session.tempo_map(), pos);
 173         return converter.to(_length_beats);
 174 }
 175
 176 void
 177 MidiSource::update_length (framecnt_t)
 178 {
 179         // You're not the boss of me!
 180 }
 181
 182 /** @param filtered A set of parameters whose MIDI messages will not be returned */
 183 framecnt_t
 184 MidiSource::midi_read (Evoral::EventSink<framepos_t>& dst, framepos_t source_start,
 185                        framepos_t start, framecnt_t cnt,
 186                        MidiStateTracker* tracker,
 187                        std::set<Evoral::Parameter> const & filtered) const
 188 {
 189         Glib::Threads::Mutex::Lock lm (_lock);
 190
 191         BeatsFramesConverter converter(_session.tempo_map(), source_start);
 192
 193         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("MidiSource::midi-read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
 194                                                           source_start, start, cnt, tracker, name()));
 195
 196         if (_model) {
 197                 // Read events up to end
 198                 const double start_beats = converter.from(start);
 199                 for (Evoral::Sequence<double>::const_iterator i = _model->begin(start_beats, false, filtered);
 200                      i != _model->end();
 201                      ++i) {
 202                         const framecnt_t time_frames = converter.to(i->time());
 203                         if (time_frames < start + cnt) {
 204                                 /* convert event times to session frames by adding on the source start position in session frames */
 205                                 dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
 206
 207                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: add event @ %2 type %3 size = %4\n",
 208                                                                                   _name, time_frames + source_start, i->event_type(), i->size()));
 209
 210                                 if (tracker) {
 211                                         Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(reinterpret_cast<Evoral::MIDIEvent<Evoral::MusicalTime>*>
 212                                                                                       (const_cast<Evoral::Event<Evoral::MusicalTime>*> (&(*i)))));
 213                                         if (ev.is_note_on()) {
 214                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note on %2 @ %3 velocity %4\n", _name, (int) ev.note(), time_frames, (int) ev.velocity()));
 215                                                 tracker->add (ev.note(), ev.channel());
 216                                         } else if (ev.is_note_off()) {
 217                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note off %2 @ %3\n", _name, (int) ev.note(), time_frames));
 218                                                 tracker->remove (ev.note(), ev.channel());
 219                                         }
 220                                 }
 221                         } else {
 222                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: reached end with event @ %2 vs. %3\n",
 223                                                                                   _name, time_frames, start+cnt));
 224                                 break;
 225                         }
 226                 }
 227                 return cnt;
 228         } else {
 229                 return read_unlocked (dst, source_start, start, cnt, tracker);
 230         }
 231 }
 232
 233 framecnt_t
 234 MidiSource::midi_write (MidiRingBuffer<framepos_t>& source,
 235                         framepos_t                  source_start,
 236                         framecnt_t                  cnt)
 237 {
 238         Glib::Threads::Mutex::Lock lm (_lock);
 239
 240         const framecnt_t ret = write_unlocked (source, source_start, cnt);
 241
 242         if (cnt != max_framecnt) {
 243                 _capture_length += cnt;
 244         }
 245
 246         return ret;
 247 }
 248
 249 void
 250 MidiSource::mark_streaming_midi_write_started (NoteMode mode)
 251 {
 252         if (_model) {
 253                 _model->set_note_mode (mode);
 254                 _model->start_write ();
 255         }
 256
 257         _writing = true;
 258 }
 259
 260 void
 261 MidiSource::mark_write_starting_now (framecnt_t position,
 262                                      framecnt_t capture_length,
 263                                      framecnt_t loop_length)
 264 {
 265         /* I'm not sure if this is the best way to approach this, but
 266            _capture_length needs to be set up with the transport frame
 267            when a record actually starts, as it is used by
 268            SMFSource::write_unlocked to decide whether incoming notes
 269            are within the correct time range.
 270            mark_streaming_midi_write_started (perhaps a more logical
 271            place to do this) is not called at exactly the time when
 272            record starts, and I don't think it necessarily can be
 273            because it is not RT-safe.
 274         */
 275
 276         set_timeline_position(position);
 277         _capture_length      = capture_length;
 278         _capture_loop_length = loop_length;
 279
 280         BeatsFramesConverter converter(_session.tempo_map(), position);
 281         _length_beats = converter.from(capture_length);
 282 }
 283
 284 void
 285 MidiSource::mark_streaming_write_started ()
 286 {
 287         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 288         mark_streaming_midi_write_started (note_mode);
 289 }
 290
 291 void
 292 MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option, Evoral::MusicalTime end)
 293 {
 294         if (_model) {
 295                 _model->end_write (option, end);
 296         }
 297
 298         _writing = false;
 299 }
 300
 301 void
 302 MidiSource::mark_streaming_write_completed ()
 303 {
 304         mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
 305 }
 306
 307 int
 308 MidiSource::write_to (boost::shared_ptr<MidiSource> newsrc, Evoral::MusicalTime begin, Evoral::MusicalTime end)
 309 {
 310         newsrc->set_timeline_position(_timeline_position);
 311         newsrc->copy_interpolation_from (this);
 312         newsrc->copy_automation_state_from (this);
 313
 314         if (_model) {
 315                 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
 316                         _model->write_to (newsrc);
 317                 } else {
 318                         _model->write_section_to (newsrc, begin, end);
 319                 }
 320         } else {
 321                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 322                 return -1;
 323         }
 324
 325         newsrc->flush_midi();
 326
 327         /* force a reload of the model if the range is partial */
 328
 329         if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
 330                 newsrc->load_model (true, true);
 331         } else {
 332                 newsrc->set_model (_model);
 333         }
 334
 335         /* this file is not removable (but since it is MIDI, it is mutable) */
 336
 337         boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
 338
 339         return 0;
 340 }
 341
 342 void
 343 MidiSource::session_saved()
 344 {
 345         /* this writes a copy of the data to disk.
 346            XXX do we need to do this every time?
 347         */
 348
 349         if (_model && _model->edited()) {
 350
 351                 // if the model is edited, write its contents into
 352                 // the current source file (overwiting previous contents.
 353
 354                 /* temporarily drop our reference to the model so that
 355                    as the model pushes its current state to us, we don't
 356                    try to update it.
 357                 */
 358
 359                 boost::shared_ptr<MidiModel> mm = _model;
 360                 _model.reset ();
 361
 362                 /* flush model contents to disk
 363                  */
 364
 365                 mm->sync_to_source ();
 366
 367                 /* reacquire model */
 368
 369                 _model = mm;
 370
 371         } else {
 372                 flush_midi();
 373         }
 374 }
 375
 376 void
 377 MidiSource::set_note_mode(NoteMode mode)
 378 {
 379         if (_model) {
 380                 _model->set_note_mode(mode);
 381         }
 382 }
 383
 384 void
 385 MidiSource::drop_model ()
 386 {
 387         _model.reset();
 388         ModelChanged (); /* EMIT SIGNAL */
 389 }
 390
 391 void
 392 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
 393 {
 394         _model = m;
 395         ModelChanged (); /* EMIT SIGNAL */
 396 }
 397
 398 /** @return Interpolation style that should be used for control parameter \a p */
 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 }