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