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         return node;
 101 }
 102
 103 int
 104 MidiSource::set_state (const XMLNode& node, int /*version*/)
 105 {
 106         const XMLProperty* prop;
 107
 108         if ((prop = node.property ("captured-for")) != 0) {
 109                 _captured_for = prop->value();
 110         }
 111
 112         return 0;
 113 }
 114
 115 bool
 116 MidiSource::empty () const
 117 {
 118         return _length_beats == 0;
 119 }
 120
 121 framecnt_t
 122 MidiSource::length (framepos_t pos) const
 123 {
 124         if (_length_beats == 0) {
 125                 return 0;
 126         }
 127
 128         BeatsFramesConverter converter(_session.tempo_map(), pos);
 129         return converter.to(_length_beats);
 130 }
 131
 132 void
 133 MidiSource::update_length (sframes_t /*pos*/, sframes_t /*cnt*/)
 134 {
 135         // You're not the boss of me!
 136 }
 137
 138 void
 139 MidiSource::invalidate ()
 140 {
 141         _model_iter_valid = false;
 142         _model_iter.invalidate();
 143 }
 144
 145 nframes_t
 146 MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, sframes_t source_start,
 147                        sframes_t start, nframes_t cnt,
 148                        sframes_t stamp_offset, sframes_t negative_stamp_offset,
 149                        MidiStateTracker* tracker) const
 150 {
 151         Glib::Mutex::Lock lm (_lock);
 152
 153         BeatsFramesConverter converter(_session.tempo_map(), source_start);
 154
 155         if (_model) {
 156                 Evoral::Sequence<double>::const_iterator& i = _model_iter;
 157
 158                 // If the cached iterator is invalid, search for the first event past start
 159                 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
 160                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
 161                         for (i = _model->begin(); i != _model->end(); ++i) {
 162                                 if (converter.to(i->time()) >= start) {
 163                                         break;
 164                                 }
 165                         }
 166                         _model_iter_valid = true;
 167                 } else {
 168                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cached iterator for %1 / %2\n", _name, source_start, start));
 169                 }
 170
 171                 _last_read_end = start + cnt;
 172
 173                 // Read events up to end
 174                 for (; i != _model->end(); ++i) {
 175                         const sframes_t time_frames = converter.to(i->time());
 176                         if (time_frames < start + cnt) {
 177                                 dst.write(time_frames + stamp_offset - negative_stamp_offset,
 178                                                 i->event_type(), i->size(), i->buffer());
 179                                 if (tracker) {
 180                                         Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
 181                                         if (ev.is_note_on()) {
 182                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note on %2 @ %3\n", _name, ev.note(), time_frames));
 183                                                 tracker->add (ev.note(), ev.channel());
 184                                         } else if (ev.is_note_off()) {
 185                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note off %2 @ %3\n", _name, ev.note(), time_frames));
 186                                                 tracker->remove (ev.note(), ev.channel());
 187                                         }
 188                                 }
 189                         } else {
 190                                 break;
 191                         }
 192                 }
 193                 return cnt;
 194         } else {
 195                 return read_unlocked (dst, source_start, start, cnt, stamp_offset, negative_stamp_offset, tracker);
 196         }
 197 }
 198
 199 nframes_t
 200 MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, sframes_t source_start, nframes_t duration)
 201 {
 202         Glib::Mutex::Lock lm (_lock);
 203         const nframes_t ret = write_unlocked (source, source_start, duration);
 204         _last_write_end += duration;
 205         return ret;
 206 }
 207
 208 void
 209 MidiSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
 210 {
 211         set_timeline_position(start_frame);
 212
 213         if (_model) {
 214                 _model->set_note_mode(mode);
 215                 _model->start_write();
 216         }
 217
 218         _last_write_end = start_frame;
 219         _writing = true;
 220 }
 221
 222 void
 223 MidiSource::mark_streaming_write_started ()
 224 {
 225         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 226         mark_streaming_midi_write_started(note_mode, _session.transport_frame());
 227 }
 228
 229 void
 230 MidiSource::mark_streaming_write_completed ()
 231 {
 232         if (_model) {
 233                 _model->end_write(false);
 234         }
 235
 236         _writing = false;
 237 }
 238
 239 boost::shared_ptr<MidiSource>
 240 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
 241 {
 242         string newname = PBD::basename_nosuffix(_name.val());
 243         string newpath;
 244
 245         /* get a new name for the MIDI file we're going to write to
 246          */
 247
 248         do {
 249
 250                 newname = bump_name_once (newname, '-');
 251                 /* XXX build path safely */
 252                 newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
 253
 254         } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
 255
 256         boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
 257                 SourceFactory::createWritable(DataType::MIDI, _session,
 258                                               newpath, false, _session.frame_rate()));
 259
 260         newsrc->set_timeline_position(_timeline_position);
 261
 262         if (_model) {
 263                 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
 264                         _model->write_to (newsrc);
 265                 } else {
 266                         _model->write_section_to (newsrc, begin, end);
 267                 }
 268         } else {
 269                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 270                 return boost::shared_ptr<MidiSource>();
 271         }
 272
 273         newsrc->flush_midi();
 274
 275         /* force a reload of the model if the range is partial */
 276
 277         if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
 278                 newsrc->load_model (true, true);
 279         } else {
 280                 newsrc->set_model (_model);
 281         }
 282
 283         return newsrc;
 284 }
 285
 286 void
 287 MidiSource::session_saved()
 288 {
 289         flush_midi();
 290
 291         if (_model && _model->edited()) {
 292                 boost::shared_ptr<MidiSource> newsrc = clone ();
 293
 294                 if (newsrc) {
 295                         _model->set_midi_source (newsrc.get());
 296                         Switched (newsrc); /* EMIT SIGNAL */
 297                 }
 298         }
 299 }
 300
 301 void
 302 MidiSource::set_note_mode(NoteMode mode)
 303 {
 304         if (_model) {
 305                 _model->set_note_mode(mode);
 306         }
 307 }
 308
 309 void
 310 MidiSource::drop_model ()
 311 {
 312         cerr << name() << " drop model\n";
 313         _model.reset();
 314 }