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 /** @param filtered A set of parameters whose MIDI messages will not be returned */
 146 nframes_t
 147 MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, sframes_t source_start,
 148                        sframes_t start, nframes_t cnt,
 149                        sframes_t stamp_offset, sframes_t negative_stamp_offset,
 150                        MidiStateTracker* tracker,
 151                        std::set<Evoral::Parameter> const & filtered) const
 152 {
 153         Glib::Mutex::Lock lm (_lock);
 154
 155         BeatsFramesConverter converter(_session.tempo_map(), source_start);
 156
 157         if (_model) {
 158                 Evoral::Sequence<double>::const_iterator& i = _model_iter;
 159
 160                 // If the cached iterator is invalid, search for the first event past start
 161                 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
 162                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
 163                         for (i = _model->begin(0, filtered); i != _model->end(); ++i) {
 164                                 if (converter.to(i->time()) >= start) {
 165                                         break;
 166                                 }
 167                         }
 168                         _model_iter_valid = true;
 169                 } else {
 170                         DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cached iterator for %1 / %2\n", _name, source_start, start));
 171                 }
 172
 173                 _last_read_end = start + cnt;
 174
 175                 // Read events up to end
 176                 for (; i != _model->end(); ++i) {
 177                         const sframes_t time_frames = converter.to(i->time());
 178                         if (time_frames < start + cnt) {
 179                                 dst.write(time_frames + stamp_offset - negative_stamp_offset,
 180                                                 i->event_type(), i->size(), i->buffer());
 181                                 if (tracker) {
 182                                         Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
 183                                         if (ev.is_note_on()) {
 184                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note on %2 @ %3\n", _name, ev.note(), time_frames));
 185                                                 tracker->add (ev.note(), ev.channel());
 186                                         } else if (ev.is_note_off()) {
 187                                                 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note off %2 @ %3\n", _name, ev.note(), time_frames));
 188                                                 tracker->remove (ev.note(), ev.channel());
 189                                         }
 190                                 }
 191                         } else {
 192                                 break;
 193                         }
 194                 }
 195                 return cnt;
 196         } else {
 197                 return read_unlocked (dst, source_start, start, cnt, stamp_offset, negative_stamp_offset, tracker);
 198         }
 199 }
 200
 201 nframes_t
 202 MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, sframes_t source_start, nframes_t duration)
 203 {
 204         Glib::Mutex::Lock lm (_lock);
 205         const nframes_t ret = write_unlocked (source, source_start, duration);
 206         _last_write_end += duration;
 207         return ret;
 208 }
 209
 210 void
 211 MidiSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
 212 {
 213         set_timeline_position(start_frame);
 214
 215         if (_model) {
 216                 _model->set_note_mode(mode);
 217                 _model->start_write();
 218         }
 219
 220         _last_write_end = start_frame;
 221         _writing = true;
 222 }
 223
 224 void
 225 MidiSource::mark_streaming_write_started ()
 226 {
 227         NoteMode note_mode = _model ? _model->note_mode() : Sustained;
 228         mark_streaming_midi_write_started(note_mode, _session.transport_frame());
 229 }
 230
 231 void
 232 MidiSource::mark_streaming_write_completed ()
 233 {
 234         if (_model) {
 235                 _model->end_write(false);
 236         }
 237
 238         _writing = false;
 239 }
 240
 241 boost::shared_ptr<MidiSource>
 242 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
 243 {
 244         string newname = PBD::basename_nosuffix(_name.val());
 245         string newpath;
 246
 247         /* get a new name for the MIDI file we're going to write to
 248          */
 249
 250         do {
 251
 252                 newname = bump_name_once (newname, '-');
 253                 /* XXX build path safely */
 254                 newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
 255
 256         } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
 257
 258         boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
 259                 SourceFactory::createWritable(DataType::MIDI, _session,
 260                                               newpath, false, _session.frame_rate()));
 261
 262         newsrc->set_timeline_position(_timeline_position);
 263
 264         if (_model) {
 265                 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
 266                         _model->write_to (newsrc);
 267                 } else {
 268                         _model->write_section_to (newsrc, begin, end);
 269                 }
 270         } else {
 271                 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
 272                 return boost::shared_ptr<MidiSource>();
 273         }
 274
 275         newsrc->flush_midi();
 276
 277         /* force a reload of the model if the range is partial */
 278
 279         if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
 280                 newsrc->load_model (true, true);
 281         } else {
 282                 newsrc->set_model (_model);
 283         }
 284
 285         return newsrc;
 286 }
 287
 288 void
 289 MidiSource::session_saved()
 290 {
 291         /* this writes a copy of the data to disk.
 292            XXX do we need to do this every time?
 293         */
 294
 295         flush_midi();
 296         cerr << name() << " @ " << this << " length at save = " << _length_beats << endl;
 297
 298 #if 0 // old style: clone the source if necessary on every session save
 299       // and switch to the new source
 300
 301         if (_model && _model->edited()) {
 302                 cerr << "Model exists and is edited\n";
 303
 304                 boost::shared_ptr<MidiSource> newsrc = clone ();
 305
 306                 if (newsrc) {
 307                         _model->set_midi_source (newsrc.get());
 308                         Switched (newsrc); /* EMIT SIGNAL */
 309                 }
 310         }
 311 #endif
 312 }
 313
 314 void
 315 MidiSource::set_note_mode(NoteMode mode)
 316 {
 317         if (_model) {
 318                 _model->set_note_mode(mode);
 319         }
 320 }
 321
 322 void
 323 MidiSource::drop_model ()
 324 {
 325         cerr << name() << " drop model\n";
 326         _model.reset();
 327         ModelChanged (); /* EMIT SIGNAL */
 328 }
 329
 330 void
 331 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
 332 {
 333         _model = m;
 334         ModelChanged (); /* EMIT SIGNAL */
 335 }