2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
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.
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.
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.
29 #include "pbd/pathscanner.h"
30 #include "pbd/stl_delete.h"
31 #include "pbd/strsplit.h"
33 #include <glib/gstdio.h>
34 #include <glibmm/miscutils.h>
35 #include <glibmm/fileutils.h>
37 #include "evoral/Control.hpp"
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 #include "ardour/debug.h"
49 using namespace ARDOUR;
53 /** Constructor used for new internal-to-session files. File cannot exist. */
54 SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
55 : Source(s, DataType::MIDI, path, flags)
56 , MidiSource(s, path, flags)
57 , FileSource(s, DataType::MIDI, path, string(), flags)
59 , _last_ev_time_beats(0.0)
60 , _last_ev_time_frames(0)
61 , _smf_last_read_end (0)
62 , _smf_last_read_time (0)
64 /* note that origin remains empty */
66 if (init(_path, false)) {
67 throw failed_constructor ();
70 /* file is not opened until write */
72 if (flags & Writable) {
77 throw failed_constructor ();
82 /** Constructor used for existing internal-to-session files. */
83 SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
86 , FileSource(s, node, must_exist)
87 , _last_ev_time_beats(0.0)
88 , _last_ev_time_frames(0)
89 , _smf_last_read_end (0)
90 , _smf_last_read_time (0)
92 if (set_state(node, Stateful::loading_state_version)) {
93 throw failed_constructor ();
96 if (init(_path, true)) {
97 throw failed_constructor ();
101 throw failed_constructor ();
107 SMFSource::~SMFSource ()
110 ::g_unlink (_path.c_str());
115 SMFSource::open_for_write ()
117 if (create (_path)) {
124 /** All stamps in audio frames */
126 SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination,
127 framepos_t const source_start,
130 MidiStateTracker* tracker) const
133 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
135 if (writable() && !_open) {
136 /* nothing to read since nothing has ben written */
140 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration));
142 // Output parameters for read_event (which will allocate scratch in buffer as needed)
143 uint32_t ev_delta_t = 0;
144 uint32_t ev_type = 0;
145 uint32_t ev_size = 0;
146 uint8_t* ev_buffer = 0;
148 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
150 BeatsFramesConverter converter(_session.tempo_map(), source_start);
152 const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn());
153 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start in ticks %1\n", start_ticks));
155 if (_smf_last_read_end == 0 || start != _smf_last_read_end) {
156 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start));
157 Evoral::SMF::seek_to_start();
158 while (time < start_ticks) {
161 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
162 if (ret == -1) { // EOF
163 _smf_last_read_end = start + duration;
166 time += ev_delta_t; // accumulate delta time
169 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: set time to %1\n", _smf_last_read_time));
170 time = _smf_last_read_time;
173 _smf_last_read_end = start + duration;
176 gint ignored; /* XXX don't ignore note id's ??*/
178 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
179 if (ret == -1) { // EOF
183 time += ev_delta_t; // accumulate delta time
184 _smf_last_read_time = time;
186 if (ret == 0) { // meta-event (skipped, just accumulate time)
190 ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
192 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked delta %1, time %2, buf[0] %3, type %4\n",
193 ev_delta_t, time, ev_buffer[0], ev_type));
195 assert(time >= start_ticks);
197 /* Note that we add on the source start time (in session frames) here so that ev_frame_time
198 is in session frames.
200 const framepos_t ev_frame_time = converter.to(time / (double)ppqn()) + source_start;
202 if (ev_frame_time < start + duration) {
203 destination.write (ev_frame_time, ev_type, ev_size, ev_buffer);
206 if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
207 tracker->add (ev_buffer[1], ev_buffer[0] & 0xf);
208 } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) {
209 tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf);
216 if (ev_size > scratch_size) {
217 scratch_size = ev_size;
219 ev_size = scratch_size; // ensure read_event only allocates if necessary
226 SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source,
231 mark_streaming_write_started ();
235 Evoral::EventType type;
238 size_t buf_capacity = 4;
239 uint8_t* buf = (uint8_t*)malloc(buf_capacity);
241 if (_model && !_model->writing()) {
242 _model->start_write();
245 Evoral::MIDIEvent<framepos_t> ev;
247 /* Get the event time, in frames since session start but ignoring looping. */
249 if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) {
250 /* Ring is empty, no more events. */
254 if ((cnt != max_framecnt) &&
255 (time > position + _capture_length + cnt)) {
256 /* The diskstream doesn't want us to write everything, and this
257 event is past the end of this block, so we're done for now. */
261 /* Read the time, type, and size of the event. */
262 if (!(ret = source.read_prefix (&time, &type, &size))) {
263 error << _("Unable to read event prefix, corrupt MIDI ring") << endmsg;
267 /* Enlarge body buffer if necessary now that we know the size. */
268 if (size > buf_capacity) {
270 buf = (uint8_t*)realloc(buf, size);
273 /* Read the event body into buffer. */
274 ret = source.read_contents(size, buf);
276 error << _("Event has time and size but no body, corrupt MIDI ring") << endmsg;
280 /* Convert event time from absolute to source relative. */
281 if (time < position) {
282 error << _("Event time is before MIDI source position") << endmsg;
287 ev.set(buf, size, time);
288 ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0]));
289 ev.set_id(Evoral::next_event_id());
291 if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) {
295 append_event_unlocked_frames(ev, position);
298 Evoral::SMF::flush ();
304 /** Append an event with a timestamp in beats (double) */
306 SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
308 if (!_writing || ev.size() == 0) {
312 /*printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ",
313 name().c_str(), ev.id(), ev.time(), ev.size());
314 for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
316 if (ev.time() < _last_ev_time_beats) {
317 warning << string_compose(_("Skipping event with unordered time %1"), ev.time())
322 Evoral::event_id_t event_id;
325 event_id = Evoral::next_event_id();
331 _model->append (ev, event_id);
334 _length_beats = max(_length_beats, ev.time());
336 const double delta_time_beats = ev.time() - _last_ev_time_beats;
337 const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn());
339 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
340 _last_ev_time_beats = ev.time();
343 /** Append an event with a timestamp in frames (framepos_t) */
345 SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, framepos_t position)
347 if (!_writing || ev.size() == 0) {
351 // printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ",
352 // name().c_str(), ev.id(), ev.time(), ev.size());
353 // for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");
355 if (ev.time() < _last_ev_time_frames) {
356 warning << string_compose(_("Skipping event with unordered time %1"), ev.time())
361 BeatsFramesConverter converter(_session.tempo_map(), position);
362 const double ev_time_beats = converter.from(ev.time());
363 Evoral::event_id_t event_id;
366 event_id = Evoral::next_event_id();
372 const Evoral::Event<double> beat_ev (ev.event_type(),
375 const_cast<uint8_t*>(ev.buffer()));
376 _model->append (beat_ev, event_id);
379 _length_beats = max(_length_beats, ev_time_beats);
381 const Evoral::MusicalTime last_time_beats = converter.from (_last_ev_time_frames);
382 const Evoral::MusicalTime delta_time_beats = ev_time_beats - last_time_beats;
383 const uint32_t delta_time_ticks = (uint32_t)(lrint(delta_time_beats * (double)ppqn()));
385 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
386 _last_ev_time_frames = ev.time();
390 SMFSource::get_state ()
392 XMLNode& node = MidiSource::get_state();
393 node.add_property (X_("origin"), _origin);
398 SMFSource::set_state (const XMLNode& node, int version)
400 if (Source::set_state (node, version)) {
404 if (MidiSource::set_state (node, version)) {
408 if (FileSource::set_state (node, version)) {
416 SMFSource::mark_streaming_midi_write_started (NoteMode mode)
418 /* CALLER MUST HOLD LOCK */
420 if (!_open && open_for_write()) {
421 error << string_compose (_("cannot open MIDI file %1 for write"), _path) << endmsg;
422 /* XXX should probably throw or return something */
426 MidiSource::mark_streaming_midi_write_started (mode);
427 Evoral::SMF::begin_write ();
428 _last_ev_time_beats = 0.0;
429 _last_ev_time_frames = 0;
433 SMFSource::mark_streaming_write_completed ()
435 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
439 SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when)
441 Glib::Threads::Mutex::Lock lm (_lock);
442 MidiSource::mark_midi_streaming_write_completed (stuck_notes_option, when);
445 warning << string_compose ("attempt to write to unwritable SMF file %1", _path) << endmsg;
450 _model->set_edited(false);
453 Evoral::SMF::end_write ();
455 /* data in the file now, not removable */
457 mark_nonremovable ();
461 SMFSource::safe_midi_file_extension (const string& file)
463 static regex_t compiled_pattern;
464 static bool compile = true;
465 const int nmatches = 2;
466 regmatch_t matches[nmatches];
468 if (Glib::file_test (file, Glib::FILE_TEST_EXISTS)) {
469 if (!Glib::file_test (file, Glib::FILE_TEST_IS_REGULAR)) {
470 /* exists but is not a regular file */
475 if (compile && regcomp (&compiled_pattern, "\\.[mM][iI][dD][iI]?$", REG_EXTENDED)) {
481 if (regexec (&compiled_pattern, file.c_str(), nmatches, matches, 0)) {
488 static bool compare_eventlist (
489 const std::pair< Evoral::Event<double>*, gint >& a,
490 const std::pair< Evoral::Event<double>*, gint >& b) {
491 return ( a.first->time() < b.first->time() );
495 SMFSource::load_model (bool lock, bool force_reload)
501 boost::shared_ptr<Glib::Threads::Mutex::Lock> lm;
503 lm = boost::shared_ptr<Glib::Threads::Mutex::Lock>(new Glib::Threads::Mutex::Lock(_lock));
505 if (_model && !force_reload) {
510 _model = boost::shared_ptr<MidiModel> (new MidiModel (shared_from_this ()));
515 if (writable() && !_open) {
519 _model->start_write();
520 Evoral::SMF::seek_to_start();
522 uint64_t time = 0; /* in SMF ticks */
523 Evoral::Event<double> ev;
525 uint32_t scratch_size = 0; // keep track of scratch and minimize reallocs
527 uint32_t delta_t = 0;
534 // TODO simplify event allocation
535 std::list< std::pair< Evoral::Event<double>*, gint > > eventlist;
537 for (unsigned i = 1; i <= num_tracks(); ++i) {
538 if (seek_to_track(i)) continue;
541 have_event_id = false;
543 while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
548 /* meta-event : did we get an event ID ? */
550 have_event_id = true;
556 /* not a meta-event */
558 if (!have_event_id) {
559 event_id = Evoral::next_event_id();
561 uint32_t event_type = EventTypeMap::instance().midi_event_type(buf[0]);
562 double event_time = time / (double) ppqn();
566 for (uint32_t xx = 0; xx < size; ++xx) {
568 snprintf (b, sizeof (b), "0x%x ", buf[xx]);
572 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n",
573 delta_t, time, size, ss , event_type, name()));
576 eventlist.push_back(make_pair (
577 new Evoral::Event<double> (
578 event_type, event_time,
582 // Set size to max capacity to minimize allocs in read_event
583 scratch_size = std::max(size, scratch_size);
586 _length_beats = max(_length_beats, event_time);
589 /* event ID's must immediately precede the event they are for */
590 have_event_id = false;
594 eventlist.sort(compare_eventlist);
596 std::list< std::pair< Evoral::Event<double>*, gint > >::iterator it;
597 for (it=eventlist.begin(); it!=eventlist.end(); ++it) {
598 _model->append (*it->first, it->second);
602 _model->end_write (Evoral::Sequence<Evoral::MusicalTime>::ResolveStuckNotes, _length_beats);
603 _model->set_edited (false);
605 _model_iter = _model->begin();
611 SMFSource::destroy_model ()
613 //cerr << _name << " destroying model " << _model.get() << endl;
618 SMFSource::flush_midi ()
620 if (!writable() || (writable() && !_open)) {
624 Evoral::SMF::end_write ();
625 /* data in the file means its no longer removable */
626 mark_nonremovable ();
630 SMFSource::set_path (const string& p)
632 FileSource::set_path (p);
633 SMF::set_path (_path);
636 /** Ensure that this source has some file on disk, even if it's just a SMF header */
638 SMFSource::ensure_disk_file ()
641 /* We have a model, so write it to disk; see MidiSource::session_saved
642 for an explanation of what we are doing here.
644 boost::shared_ptr<MidiModel> mm = _model;
646 mm->sync_to_source ();
649 /* No model; if it's not already open, it's an empty source, so create
650 and open it for writing.
656 /* Flush, which will definitely put something on disk */