libs/ardour/midi_source.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3         Written by Dave Robillard, 2006
   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 (sframes_t /*pos*/, sframes_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 nframes_t
 200 MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, sframes_t source_start,
 201                        sframes_t start, nframes_t cnt,
 202                        sframes_t stamp_offset, sframes_t negative_stamp_offset,
 203                        MidiStateTracker* tracker,
 204                        std::set<Evoral::Parameter> const & filtered) const
 205 {
 206         Glib::Mutex::Lock lm (_lock);
 207
 208         BeatsFramesConverter converter(_session.tempo_map(), source_start);
 209
 210         if (_model) {
 211                 Evoral::Sequence<double>::const_iterator& i = _model_iter;
 212
 213                 // If the cached iterator is invalid, search for the first event past start
 214                 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
 215                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
 216                         for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
 217                                 if (converter.to(i->time()) >= start) {
 218                                         break;
 219                                 }
 220                         }
 221                         _model_iter_valid = true;
 222                 } else {
 223                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cached iterator for %1 / %2\n", _name, source_start, start));
 224                 }
 225
 226                 _last_read_end = start + cnt;
 227
 228                 // Read events up to end
 229                 for (; i != _model->end(); ++i) {
 230                         const sframes_t time_frames = converter.to(i->time());
 231                         if (time_frames < start + cnt) {
 232                                 dst.write(time_frames + stamp_offset - negative_stamp_offset,
 233                                           i->event_type(), i->size(), i->buffer());
 234
 235                                 if (tracker) {
 236                                         Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
 237                                         if (ev.is_note_on()) {
 238                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note on %2 @ %3 velocity %4\n", _name, 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 add note off %2 @ %3\n", _name, ev.note(), time_frames));
 242                                                 tracker->remove (ev.note(), ev.channel());
 243                                         }
 244                                 }
 245                         } else {
 246                                 break;
 247                         }
 248                 }
 249                 return cnt;
 250         } else {
 251                 return read_unlocked (dst, source_start, start, cnt, stamp_offset, negative_stamp_offset, tracker);
 252         }
 253 }
 254
 255 nframes_t
 256 MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, sframes_t source_start, nframes_t duration)
 257 {
 258         Glib::Mutex::Lock lm (_lock);
 259         const nframes_t ret = write_unlocked (source, source_start, duration);
 260         _last_write_end += duration;
 261         return ret;
 262 }
 263
 264 void
 265 MidiSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
 266 {
 267         set_timeline_position(start_frame);
 268
 269         if (_model) {
 270                 _model->set_note_mode(mode);
 271                 _model->start_write();
 272         }
 273
 274         _last_write_end = start_frame;
 275         _writing = true;
 276 }
 277
 278 void
 279 MidiSource::mark_streaming_write_started ()
 280 {
 281         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 282         mark_streaming_midi_write_started(note_mode, _session.transport_frame());
 283 }
 284
 285 void
 286 MidiSource::mark_streaming_write_completed ()
 287 {
 288         if (_model) {
 289                 _model->end_write(false);
 290         }
 291
 292         _writing = false;
 293 }
 294
 295 boost::shared_ptr<MidiSource>
 296 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
 297 {
 298         string newname = PBD::basename_nosuffix(_name.val());
 299         string newpath;
 300
 301         /* get a new name for the MIDI file we're going to write to
 302          */
 303
 304         do {
 305
 306                 newname = bump_name_once (newname, '-');
 307                 /* XXX build path safely */
 308                 newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
 309
 310         } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
 311
 312         boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
 313                 SourceFactory::createWritable(DataType::MIDI, _session,
 314                                               newpath, false, _session.frame_rate()));
 315
 316         newsrc->set_timeline_position(_timeline_position);
 317         newsrc->copy_interpolation_from (this);
 318         newsrc->copy_automation_state_from (this);
 319
 320         if (_model) {
 321                 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
 322                         _model->write_to (newsrc);
 323                 } else {
 324                         _model->write_section_to (newsrc, begin, end);
 325                 }
 326         } else {
 327                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 328                 return boost::shared_ptr<MidiSource>();
 329         }
 330
 331         newsrc->flush_midi();
 332
 333         /* force a reload of the model if the range is partial */
 334
 335         if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
 336                 newsrc->load_model (true, true);
 337         } else {
 338                 newsrc->set_model (_model);
 339         }
 340
 341         return newsrc;
 342 }
 343
 344 void
 345 MidiSource::session_saved()
 346 {
 347         /* this writes a copy of the data to disk.
 348            XXX do we need to do this every time?
 349         */
 350
 351         if (_model && _model->edited()) {
 352
 353
 354
 355                 // if the model is edited, write its contents into
 356                 // the current source file (overwiting previous contents.
 357
 358                 /* temporarily drop our reference to the model so that
 359                    as the model pushes its current state to us, we don't
 360                    try to update it.
 361                 */
 362
 363                 boost::shared_ptr<MidiModel> mm = _model ;
 364                 _model.reset ();
 365
 366                 /* flush model contents to disk
 367                  */
 368
 369                 mm->sync_to_source ();
 370
 371                 /* reacquire model */
 372
 373                 _model = mm;
 374
 375         } else {
 376                 flush_midi();
 377         }
 378 }
 379
 380 void
 381 MidiSource::set_note_mode(NoteMode mode)
 382 {
 383         if (_model) {
 384                 _model->set_note_mode(mode);
 385         }
 386 }
 387
 388 void
 389 MidiSource::drop_model ()
 390 {
 391         _model.reset();
 392         ModelChanged (); /* EMIT SIGNAL */
 393 }
 394
 395 void
 396 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
 397 {
 398         _model = m;
 399         ModelChanged (); /* EMIT SIGNAL */
 400 }
 401
 402 /** @return Interpolation style that should be used for control parameter \a p */
 403 Evoral::ControlList::InterpolationStyle
 404 MidiSource::interpolation_of (Evoral::Parameter p) const
 405 {
 406         InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
 407         if (i == _interpolation_style.end()) {
 408                 return EventTypeMap::instance().interpolation_of (p);
 409         }
 410
 411         return i->second;
 412 }
 413
 414 AutoState
 415 MidiSource::automation_state_of (Evoral::Parameter p) const
 416 {
 417         AutomationStateMap::const_iterator i = _automation_state.find (p);
 418         if (i == _automation_state.end()) {
 419                 return Off;
 420         }
 421
 422         return i->second;
 423 }
 424
 425 /** Set interpolation style to be used for a given parameter.  This change will be
 426  *  propagated to anyone who needs to know.
 427  */
 428 void
 429 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
 430 {
 431         if (interpolation_of (p) == s) {
 432                 return;
 433         }
 434
 435         if (EventTypeMap::instance().interpolation_of (p) == s) {
 436                 /* interpolation type is being set to the default, so we don't need a note in our map */
 437                 _interpolation_style.erase (p);
 438         } else {
 439                 _interpolation_style[p] = s;
 440         }
 441
 442         InterpolationChanged (p, s); /* EMIT SIGNAL */
 443 }
 444
 445 void
 446 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
 447 {
 448         if (automation_state_of (p) == s) {
 449                 return;
 450         }
 451
 452         if (s == Off) {
 453                 /* automation state is being set to the default, so we don't need a note in our map */
 454                 _automation_state.erase (p);
 455         } else {
 456                 _automation_state[p] = s;
 457         }
 458
 459         AutomationStateChanged (p, s); /* EMIT SIGNAL */
 460 }
 461
 462 void
 463 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
 464 {
 465         copy_interpolation_from (s.get ());
 466 }
 467
 468 void
 469 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
 470 {
 471         copy_automation_state_from (s.get ());
 472 }
 473
 474 void
 475 MidiSource::copy_interpolation_from (MidiSource* s)
 476 {
 477         _interpolation_style = s->_interpolation_style;
 478
 479         /* XXX: should probably emit signals here */
 480 }
 481
 482 void
 483 MidiSource::copy_automation_state_from (MidiSource* s)
 484 {
 485         _automation_state = s->_automation_state;
 486
 487         /* XXX: should probably emit signals here */
 488 }