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