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