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