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         return node;
 107 }
 108
 109 int
 110 MidiSource::set_state (const XMLNode& node, int /*version*/)
 111 {
 112         const XMLProperty* prop;
 113
 114         if ((prop = node.property ("captured-for")) != 0) {
 115                 _captured_for = prop->value();
 116         }
 117
 118         XMLNodeList children = node.children ();
 119         for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
 120                 if ((*i)->name() == X_("InterpolationStyle")) {
 121                         XMLProperty* prop;
 122
 123                         if ((prop = (*i)->property (X_("parameter"))) == 0) {
 124                                 error << _("Missing parameter property on InterpolationStyle") << endmsg;
 125                                 return -1;
 126                         }
 127
 128                         Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
 129
 130                         if ((prop = (*i)->property (X_("style"))) == 0) {
 131                                 error << _("Missing style property on InterpolationStyle") << endmsg;
 132                                 return -1;
 133                         }
 134
 135                         Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
 136                         set_interpolation_of (p, s);
 137                 }
 138         }
 139
 140         return 0;
 141 }
 142
 143 bool
 144 MidiSource::empty () const
 145 {
 146         return _length_beats == 0;
 147 }
 148
 149 framecnt_t
 150 MidiSource::length (framepos_t pos) const
 151 {
 152         if (_length_beats == 0) {
 153                 return 0;
 154         }
 155
 156         BeatsFramesConverter converter(_session.tempo_map(), pos);
 157         return converter.to(_length_beats);
 158 }
 159
 160 void
 161 MidiSource::update_length (sframes_t /*pos*/, sframes_t /*cnt*/)
 162 {
 163         // You're not the boss of me!
 164 }
 165
 166 void
 167 MidiSource::invalidate ()
 168 {
 169         _model_iter_valid = false;
 170         _model_iter.invalidate();
 171 }
 172
 173 /** @param filtered A set of parameters whose MIDI messages will not be returned */
 174 nframes_t
 175 MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, sframes_t source_start,
 176                        sframes_t start, nframes_t cnt,
 177                        sframes_t stamp_offset, sframes_t negative_stamp_offset,
 178                        MidiStateTracker* tracker,
 179                        std::set<Evoral::Parameter> const & filtered) const
 180 {
 181         Glib::Mutex::Lock lm (_lock);
 182
 183         BeatsFramesConverter converter(_session.tempo_map(), source_start);
 184
 185         if (_model) {
 186                 Evoral::Sequence<double>::const_iterator& i = _model_iter;
 187
 188                 // If the cached iterator is invalid, search for the first event past start
 189                 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
 190                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
 191                         for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
 192                                 if (converter.to(i->time()) >= start) {
 193                                         break;
 194                                 }
 195                         }
 196                         _model_iter_valid = true;
 197                 } else {
 198                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cached iterator for %1 / %2\n", _name, source_start, start));
 199                 }
 200
 201                 _last_read_end = start + cnt;
 202
 203                 // Read events up to end
 204                 for (; i != _model->end(); ++i) {
 205                         const sframes_t time_frames = converter.to(i->time());
 206                         if (time_frames < start + cnt) {
 207                                 dst.write(time_frames + stamp_offset - negative_stamp_offset,
 208                                           i->event_type(), i->size(), i->buffer());
 209
 210                                 if (tracker) {
 211                                         Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
 212                                         if (ev.is_note_on()) {
 213                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note on %2 @ %3 velocity %4\n", _name, ev.note(), time_frames, (int) ev.velocity()));
 214                                                 tracker->add (ev.note(), ev.channel());
 215                                         } else if (ev.is_note_off()) {
 216                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note off %2 @ %3\n", _name, ev.note(), time_frames));
 217                                                 tracker->remove (ev.note(), ev.channel());
 218                                         }
 219                                 }
 220                         } else {
 221                                 break;
 222                         }
 223                 }
 224                 return cnt;
 225         } else {
 226                 return read_unlocked (dst, source_start, start, cnt, stamp_offset, negative_stamp_offset, tracker);
 227         }
 228 }
 229
 230 nframes_t
 231 MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, sframes_t source_start, nframes_t duration)
 232 {
 233         Glib::Mutex::Lock lm (_lock);
 234         const nframes_t ret = write_unlocked (source, source_start, duration);
 235         _last_write_end += duration;
 236         return ret;
 237 }
 238
 239 void
 240 MidiSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
 241 {
 242         set_timeline_position(start_frame);
 243
 244         if (_model) {
 245                 _model->set_note_mode(mode);
 246                 _model->start_write();
 247         }
 248
 249         _last_write_end = start_frame;
 250         _writing = true;
 251 }
 252
 253 void
 254 MidiSource::mark_streaming_write_started ()
 255 {
 256         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 257         mark_streaming_midi_write_started(note_mode, _session.transport_frame());
 258 }
 259
 260 void
 261 MidiSource::mark_streaming_write_completed ()
 262 {
 263         if (_model) {
 264                 _model->end_write(false);
 265         }
 266
 267         _writing = false;
 268 }
 269
 270 boost::shared_ptr<MidiSource>
 271 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
 272 {
 273         string newname = PBD::basename_nosuffix(_name.val());
 274         string newpath;
 275
 276         /* get a new name for the MIDI file we're going to write to
 277          */
 278
 279         do {
 280
 281                 newname = bump_name_once (newname, '-');
 282                 /* XXX build path safely */
 283                 newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
 284
 285         } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
 286
 287         boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
 288                 SourceFactory::createWritable(DataType::MIDI, _session,
 289                                               newpath, false, _session.frame_rate()));
 290
 291         newsrc->set_timeline_position(_timeline_position);
 292         newsrc->copy_interpolation_from (this);
 293
 294         if (_model) {
 295                 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
 296                         _model->write_to (newsrc);
 297                 } else {
 298                         _model->write_section_to (newsrc, begin, end);
 299                 }
 300         } else {
 301                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 302                 return boost::shared_ptr<MidiSource>();
 303         }
 304
 305         newsrc->flush_midi();
 306
 307         /* force a reload of the model if the range is partial */
 308
 309         if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
 310                 newsrc->load_model (true, true);
 311         } else {
 312                 newsrc->set_model (_model);
 313         }
 314
 315         return newsrc;
 316 }
 317
 318 void
 319 MidiSource::session_saved()
 320 {
 321         /* this writes a copy of the data to disk.
 322            XXX do we need to do this every time?
 323         */
 324
 325         if (_model && _model->edited()) {
 326
 327
 328
 329                 // if the model is edited, write its contents into
 330                 // the current source file (overwiting previous contents.
 331
 332                 /* temporarily drop our reference to the model so that
 333                    as the model pushes its current state to us, we don't
 334                    try to update it.
 335                 */
 336
 337                 boost::shared_ptr<MidiModel> mm = _model ;
 338                 _model.reset ();
 339
 340                 /* flush model contents to disk
 341                  */
 342
 343                 mm->sync_to_source ();
 344
 345                 /* reacquire model */
 346
 347                 _model = mm;
 348
 349         } else {
 350                 flush_midi();
 351         }
 352 }
 353
 354 void
 355 MidiSource::set_note_mode(NoteMode mode)
 356 {
 357         if (_model) {
 358                 _model->set_note_mode(mode);
 359         }
 360 }
 361
 362 void
 363 MidiSource::drop_model ()
 364 {
 365         _model.reset();
 366         ModelChanged (); /* EMIT SIGNAL */
 367 }
 368
 369 void
 370 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
 371 {
 372         _model = m;
 373         ModelChanged (); /* EMIT SIGNAL */
 374 }
 375
 376 /** @return Interpolation style that should be used for control parameter \a p */
 377 Evoral::ControlList::InterpolationStyle
 378 MidiSource::interpolation_of (Evoral::Parameter p) const
 379 {
 380         InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
 381         if (i == _interpolation_style.end()) {
 382                 return EventTypeMap::instance().interpolation_of (p);
 383         }
 384
 385         return i->second;
 386 }
 387
 388 /** Set interpolation style to be used for a given parameter.  This change will be
 389  *  propagated to anyone who needs to know.
 390  */
 391 void
 392 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
 393 {
 394         if (interpolation_of (p) == s) {
 395                 return;
 396         }
 397
 398         if (EventTypeMap::instance().interpolation_of (p) == s) {
 399                 /* interpolation type is being set to the default, so we don't need a note in our map */
 400                 _interpolation_style.erase (p);
 401         } else {
 402                 _interpolation_style[p] = s;
 403         }
 404
 405         InterpolationChanged (p, s); /* EMIT SIGNAL */
 406 }
 407
 408 void
 409 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
 410 {
 411         copy_interpolation_from (s.get ());
 412 }
 413
 414 void
 415 MidiSource::copy_interpolation_from (MidiSource* s)
 416 {
 417         _interpolation_style = s->_interpolation_style;
 418
 419         /* XXX: should probably emit signals here */
 420 }