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