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