libs/ardour/smf_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
  21 #include <vector>
  22
  23 #include <sys/time.h>
  24 #include <sys/stat.h>
  25 #include <unistd.h>
  26 #include <errno.h>
  27
  28 #include "pbd/mountpoint.h"
  29 #include "pbd/pathscanner.h"
  30 #include "pbd/stl_delete.h"
  31 #include "pbd/strsplit.h"
  32
  33 #include <glibmm/miscutils.h>
  34
  35 #include "evoral/SMFReader.hpp"
  36 #include "evoral/Control.hpp"
  37
  38 #include "ardour/audioengine.h"
  39 #include "ardour/event_type_map.h"
  40 #include "ardour/midi_model.h"
  41 #include "ardour/midi_ring_buffer.h"
  42 #include "ardour/midi_state_tracker.h"
  43 #include "ardour/session.h"
  44 #include "ardour/smf_source.h"
  45
  46 #include "i18n.h"
  47
  48 using namespace ARDOUR;
  49 using namespace Glib;
  50
  51 /** Constructor used for new internal-to-session files.  File cannot exist. */
  52 SMFSource::SMFSource (Session& s, const ustring& path, bool embedded, Source::Flag flags)
  53         : Source(s, DataType::MIDI, path, flags)
  54         , MidiSource(s, path)
  55         , FileSource(s, DataType::MIDI, path, embedded, flags)
  56         , Evoral::SMF()
  57         , _last_ev_time_beats(0.0)
  58         , _last_ev_time_frames(0)
  59         , _smf_last_read_end (0)
  60 {
  61         if (init(_name, false)) {
  62                 throw failed_constructor ();
  63         }
  64
  65         if (create(path)) {
  66                 throw failed_constructor ();
  67         }
  68 }
  69
  70 /** Constructor used for existing internal-to-session files. */
  71 SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
  72         : Source(s, node)
  73         , MidiSource(s, node)
  74         , FileSource(s, node, must_exist)
  75         , _last_ev_time_beats(0.0)
  76         , _last_ev_time_frames(0)
  77         , _smf_last_read_end (0)
  78 {
  79         if (set_state(node, Stateful::loading_state_version)) {
  80                 throw failed_constructor ();
  81         }
  82
  83         if (init(_name, true)) {
  84                 throw failed_constructor ();
  85         }
  86
  87         if (open(_path)) {
  88                 throw failed_constructor ();
  89         }
  90 }
  91
  92 SMFSource::~SMFSource ()
  93 {
  94         if (removable()) {
  95                 unlink (_path.c_str());
  96         }
  97 }
  98
  99 /** All stamps in audio frames */
 100 nframes_t
 101 SMFSource::read_unlocked (MidiRingBuffer<nframes_t>& destination, sframes_t source_start,
 102                           sframes_t start, nframes_t duration,
 103                           sframes_t stamp_offset, sframes_t negative_stamp_offset,
 104                           MidiStateTracker* tracker) const
 105 {
 106         int      ret  = 0;
 107         uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
 108
 109         _read_data_count = 0;
 110
 111         // Output parameters for read_event (which will allocate scratch in buffer as needed)
 112         uint32_t ev_delta_t = 0;
 113         uint32_t ev_type    = 0;
 114         uint32_t ev_size    = 0;
 115         uint8_t* ev_buffer  = 0;
 116
 117         size_t scratch_size = 0; // keep track of scratch to minimize reallocs
 118
 119         BeatsFramesConverter converter(_session, source_start);
 120
 121         const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn());
 122
 123         if (_smf_last_read_end == 0 || start != _smf_last_read_end) {
 124                 //cerr << "SMFSource::read_unlocked seeking to " << start << endl;
 125                 Evoral::SMF::seek_to_start();
 126                 while (time < start_ticks) {
 127                         ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
 128                         if (ret == -1) { // EOF
 129                                 _smf_last_read_end = start + duration;
 130                                 return duration;
 131                         }
 132                         time += ev_delta_t; // accumulate delta time
 133                 }
 134         }
 135
 136         _smf_last_read_end = start + duration;
 137
 138         while (true) {
 139                 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
 140                 if (ret == -1) { // EOF
 141                         break;
 142                 }
 143
 144                 time += ev_delta_t; // accumulate delta time
 145
 146                 if (ret == 0) { // meta-event (skipped, just accumulate time)
 147                         continue;
 148                 }
 149
 150                 ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
 151
 152 #if 0
 153                 cerr << "+++ SMF source read "
 154                      << " delta = " << ev_delta_t
 155                      << " time = " << time
 156                      << " buf[0] " << hex << (int) ev_buffer[0] << dec
 157                      << " type = " << ev_type;
 158 #endif
 159
 160                 assert(time >= start_ticks);
 161                 const sframes_t ev_frame_time = converter.to(time / (double)ppqn()) + stamp_offset;
 162
 163 #if 0
 164                 cerr << " frames = " << ev_frame_time
 165                      << " w/offset = " << ev_frame_time - negative_stamp_offset
 166                      << endl;
 167 #endif
 168
 169                 if (ev_frame_time < start + duration) {
 170                         destination.write(ev_frame_time - negative_stamp_offset, ev_type, ev_size, ev_buffer);
 171
 172                         if (tracker) {
 173                                 if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
 174                                         tracker->add (ev_buffer[1], ev_buffer[0] & 0xf);
 175                                 } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) {
 176                                         tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf);
 177                                 }
 178                         }
 179                 } else {
 180                         break;
 181                 }
 182
 183                 _read_data_count += ev_size;
 184
 185                 if (ev_size > scratch_size) {
 186                         scratch_size = ev_size;
 187                 }
 188                 ev_size = scratch_size; // ensure read_event only allocates if necessary
 189         }
 190
 191         return duration;
 192 }
 193
 194 /** All stamps in audio frames */
 195 nframes_t
 196 SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position, nframes_t duration)
 197 {
 198         _write_data_count = 0;
 199
 200         nframes_t         time;
 201         Evoral::EventType type;
 202         uint32_t          size;
 203
 204         size_t   buf_capacity = 4;
 205         uint8_t* buf          = (uint8_t*)malloc(buf_capacity);
 206
 207         if (_model && ! _model->writing()) {
 208                 _model->start_write();
 209         }
 210
 211         Evoral::MIDIEvent<nframes_t> ev;
 212
 213         while (true) {
 214                 bool ret = source.peek_time(&time);
 215                 if (!ret || time > _last_write_end + duration) {
 216                         break;
 217                 }
 218
 219                 ret = source.read_prefix(&time, &type, &size);
 220                 if (!ret) {
 221                         cerr << "ERROR: Unable to read event prefix, corrupt MIDI ring buffer" << endl;
 222                         break;
 223                 }
 224
 225                 if (size > buf_capacity) {
 226                         buf_capacity = size;
 227                         buf = (uint8_t*)realloc(buf, size);
 228                 }
 229
 230                 ret = source.read_contents(size, buf);
 231                 if (!ret) {
 232                         cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
 233                         break;
 234                 }
 235
 236                 assert(time >= position);
 237                 time -= position;
 238
 239                 ev.set(buf, size, time);
 240                 ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0]));
 241                 if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) {
 242                         cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type "
 243                                         << std::hex << int(ev.buffer()[0]) << endl;
 244                         continue;
 245                 }
 246
 247                 append_event_unlocked_frames(ev, position);
 248         }
 249
 250         if (_model) {
 251                 set_default_controls_interpolation();
 252         }
 253
 254         Evoral::SMF::flush();
 255         free(buf);
 256
 257         ViewDataRangeReady(position + _last_write_end, duration); /* EMIT SIGNAL */
 258
 259         return duration;
 260 }
 261
 262
 263 /** Append an event with a timestamp in beats (double) */
 264 void
 265 SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
 266 {
 267         if (ev.size() == 0)  {
 268                 return;
 269         }
 270
 271         /*printf("SMFSource: %s - append_event_unlocked_beats time = %lf, size = %u, data = ",
 272                         name().c_str(), ev.time(), ev.size());
 273         for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
 274
 275         assert(ev.time() >= 0);
 276         if (ev.time() < _last_ev_time_beats) {
 277                 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
 278                 return;
 279         }
 280
 281         _length_beats = max(_length_beats, ev.time());
 282
 283         const double delta_time_beats   = ev.time() - _last_ev_time_beats;
 284         const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn());
 285
 286         Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer());
 287         _last_ev_time_beats = ev.time();
 288
 289         _write_data_count += ev.size();
 290
 291         if (_model) {
 292                 _model->append(ev);
 293         }
 294 }
 295
 296 /** Append an event with a timestamp in frames (nframes_t) */
 297 void
 298 SMFSource::append_event_unlocked_frames (const Evoral::Event<nframes_t>& ev, sframes_t position)
 299 {
 300         if (ev.size() == 0)  {
 301                 return;
 302         }
 303
 304         /*printf("SMFSource: %s - append_event_unlocked_frames time = %u, size = %u, data = ",
 305                         name().c_str(), ev.time(), ev.size());
 306         for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
 307
 308         if (ev.time() < _last_ev_time_frames) {
 309                 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
 310                 return;
 311         }
 312
 313         BeatsFramesConverter converter(_session, position);
 314
 315         _length_beats = max(_length_beats, converter.from(ev.time()));
 316
 317         const sframes_t delta_time_frames = ev.time() - _last_ev_time_frames;
 318         const double    delta_time_beats  = converter.from(delta_time_frames);
 319         const uint32_t  delta_time_ticks  = (uint32_t)(lrint(delta_time_beats * (double)ppqn()));
 320
 321         Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer());
 322         _last_ev_time_frames = ev.time();
 323
 324         _write_data_count += ev.size();
 325
 326         if (_model) {
 327                 const double ev_time_beats = converter.from(ev.time());
 328                 const Evoral::Event<double> beat_ev(
 329                                 ev.event_type(), ev_time_beats, ev.size(), (uint8_t*)ev.buffer());
 330                 _model->append(beat_ev);
 331         }
 332 }
 333
 334 XMLNode&
 335 SMFSource::get_state ()
 336 {
 337         return MidiSource::get_state();
 338 }
 339
 340 int
 341 SMFSource::set_state (const XMLNode& node, int version)
 342 {
 343         if (Source::set_state (node, version)) {
 344                 return -1;
 345         }
 346
 347         if (MidiSource::set_state (node, version)) {
 348                 return -1;
 349         }
 350
 351         if (FileSource::set_state (node, version)) {
 352                 return -1;
 353         }
 354
 355         return 0;
 356 }
 357
 358 void
 359 SMFSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
 360 {
 361         MidiSource::mark_streaming_midi_write_started (mode, start_frame);
 362         Evoral::SMF::begin_write ();
 363         _last_ev_time_beats = 0.0;
 364         _last_ev_time_frames = 0;
 365 }
 366
 367 void
 368 SMFSource::mark_streaming_write_completed ()
 369 {
 370         MidiSource::mark_streaming_write_completed();
 371
 372         if (!writable()) {
 373                 return;
 374         }
 375
 376         _model->set_edited(false);
 377         Evoral::SMF::end_write ();
 378 }
 379
 380 bool
 381 SMFSource::safe_midi_file_extension (const Glib::ustring& file)
 382 {
 383         return (file.rfind(".mid") != Glib::ustring::npos);
 384 }
 385
 386 void
 387 SMFSource::load_model (bool lock, bool force_reload)
 388 {
 389         if (_writing) {
 390                 return;
 391         }
 392
 393         if (lock) {
 394                 Glib::Mutex::Lock lm (_lock);
 395         }
 396
 397         if (_model && !force_reload) {
 398                 return;
 399         }
 400
 401         if (! _model) {
 402                 _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
 403                 //cerr << _name << " loaded new model " << _model.get() << endl;
 404         } else {
 405                 /*cerr << _name << " reloading model " << _model.get()
 406                         << " (" << _model->n_notes() << " notes)" << endl;*/
 407                 _model->clear();
 408         }
 409
 410         _model->start_write();
 411         Evoral::SMF::seek_to_start();
 412
 413         uint64_t time = 0; /* in SMF ticks */
 414         Evoral::Event<double> ev;
 415
 416         size_t scratch_size = 0; // keep track of scratch and minimize reallocs
 417
 418         uint32_t delta_t = 0;
 419         uint32_t size    = 0;
 420         uint8_t* buf     = NULL;
 421         int ret;
 422         while ((ret = read_event(&delta_t, &size, &buf)) >= 0) {
 423                 time += delta_t;
 424                 ev.set(buf, size, time / (double)ppqn());
 425
 426                 if (ret > 0) { // didn't skip (meta) event
 427                         ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
 428                         _model->append(ev);
 429                 }
 430
 431                 if (ev.size() > scratch_size) {
 432                         scratch_size = ev.size();
 433                 }
 434                 ev.size() = scratch_size; // ensure read_event only allocates if necessary
 435
 436                 _length_beats = max(_length_beats, ev.time());
 437         }
 438
 439         set_default_controls_interpolation();
 440
 441         _model->end_write(false);
 442         _model->set_edited(false);
 443
 444         _model_iter = _model->begin();
 445
 446         free(buf);
 447 }
 448
 449 #define LINEAR_INTERPOLATION_MODE_WORKS_PROPERLY 0
 450
 451 void
 452 SMFSource::set_default_controls_interpolation ()
 453 {
 454         // set interpolation style to defaults, can be changed by the GUI later
 455         Evoral::ControlSet::Controls controls = _model->controls();
 456         for (Evoral::ControlSet::Controls::iterator c = controls.begin(); c != controls.end(); ++c) {
 457                 (*c).second->list()->set_interpolation(
 458                         // to be enabled when ControlList::rt_safe_earliest_event_linear_unlocked works properly
 459                         #if LINEAR_INTERPOLATION_MODE_WORKS_PROPERLY
 460                         EventTypeMap::instance().interpolation_of((*c).first));
 461                         #else
 462                         Evoral::ControlList::Discrete);
 463                         #endif
 464         }
 465 }
 466
 467
 468 void
 469 SMFSource::destroy_model ()
 470 {
 471         //cerr << _name << " destroying model " << _model.get() << endl;
 472         _model.reset();
 473 }
 474
 475 void
 476 SMFSource::flush_midi ()
 477 {
 478         Evoral::SMF::end_write();
 479 }
 480