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