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.
28 #include "pbd/mountpoint.h"
29 #include "pbd/pathscanner.h"
30 #include "pbd/stl_delete.h"
31 #include "pbd/strsplit.h"
33 #include <glibmm/miscutils.h>
35 #include "evoral/Control.hpp"
37 #include "ardour/audioengine.h"
38 #include "ardour/event_type_map.h"
39 #include "ardour/midi_model.h"
40 #include "ardour/midi_ring_buffer.h"
41 #include "ardour/midi_state_tracker.h"
42 #include "ardour/session.h"
43 #include "ardour/smf_source.h"
44 #include "ardour/debug.h"
48 using namespace ARDOUR;
52 /** Constructor used for new internal-to-session files. File cannot exist. */
53 SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
54 : Source(s, DataType::MIDI, path, flags)
55 , MidiSource(s, path, flags)
56 , FileSource(s, DataType::MIDI, path, string(), flags)
58 , _last_ev_time_beats(0.0)
59 , _last_ev_time_frames(0)
60 , _smf_last_read_end (0)
61 , _smf_last_read_time (0)
63 /* note that origin remains empty */
65 if (init(_path, false)) {
66 throw failed_constructor ();
69 /* file is not opened until write */
72 /** Constructor used for existing internal-to-session files. */
73 SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
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 , _smf_last_read_time (0)
82 if (set_state(node, Stateful::loading_state_version)) {
83 throw failed_constructor ();
86 if (init(_path, true)) {
87 throw failed_constructor ();
91 throw failed_constructor ();
97 SMFSource::~SMFSource ()
100 unlink (_path.c_str());
105 SMFSource::open_for_write ()
107 if (create (_path)) {
114 /** All stamps in audio frames */
116 SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination, framepos_t const source_start,
117 framepos_t start, framecnt_t duration,
118 MidiStateTracker* tracker) const
121 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
123 if (writable() && !_open) {
124 /* nothing to read since nothing has ben written */
128 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration));
130 // Output parameters for read_event (which will allocate scratch in buffer as needed)
131 uint32_t ev_delta_t = 0;
132 uint32_t ev_type = 0;
133 uint32_t ev_size = 0;
134 uint8_t* ev_buffer = 0;
136 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
138 BeatsFramesConverter converter(_session.tempo_map(), source_start);
140 const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn());
141 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start in ticks %1\n", start_ticks));
143 if (_smf_last_read_end == 0 || start != _smf_last_read_end) {
144 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start));
145 Evoral::SMF::seek_to_start();
146 while (time < start_ticks) {
149 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
150 if (ret == -1) { // EOF
151 _smf_last_read_end = start + duration;
154 time += ev_delta_t; // accumulate delta time
157 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: set time to %1\n", _smf_last_read_time));
158 time = _smf_last_read_time;
161 _smf_last_read_end = start + duration;
164 gint ignored; /* XXX don't ignore note id's ??*/
166 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
167 if (ret == -1) { // EOF
171 time += ev_delta_t; // accumulate delta time
172 _smf_last_read_time = time;
174 if (ret == 0) { // meta-event (skipped, just accumulate time)
178 ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
180 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked delta %1, time %2, buf[0] %3, type %4\n",
181 ev_delta_t, time, ev_buffer[0], ev_type));
183 assert(time >= start_ticks);
185 /* Note that we add on the source start time (in session frames) here so that ev_frame_time
186 is in session frames.
188 const framepos_t ev_frame_time = converter.to(time / (double)ppqn()) + source_start;
190 if (ev_frame_time < start + duration) {
191 destination.write (ev_frame_time, ev_type, ev_size, ev_buffer);
194 if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
195 tracker->add (ev_buffer[1], ev_buffer[0] & 0xf);
196 } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) {
197 tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf);
204 if (ev_size > scratch_size) {
205 scratch_size = ev_size;
207 ev_size = scratch_size; // ensure read_event only allocates if necessary
213 /** Write data to this source from a MidiRingBuffer.
214 * @param source Buffer to read from.
215 * @param position This source's start position in session frames.
218 SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t position, framecnt_t duration)
221 mark_streaming_write_started ();
225 Evoral::EventType type;
228 size_t buf_capacity = 4;
229 uint8_t* buf = (uint8_t*)malloc(buf_capacity);
231 if (_model && ! _model->writing()) {
232 _model->start_write();
235 Evoral::MIDIEvent<framepos_t> ev;
237 // cerr << "SMFSource::write unlocked, begins writing from src buffer with _last_write_end = " << _last_write_end << " dur = " << duration << endl;
242 if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) {
243 /* no more events to consider */
247 if ((duration != max_framecnt) && (time > (_last_write_end + duration))) {
248 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("SMFSource::write_unlocked: dropping event @ %1 because it is later than %2 + %3\n",
249 time, _last_write_end, duration));
253 if (!(ret = source.read_prefix (&time, &type, &size))) {
254 error << _("Unable to read event prefix, corrupt MIDI ring buffer") << endmsg;
258 if (size > buf_capacity) {
260 buf = (uint8_t*)realloc(buf, size);
263 ret = source.read_contents(size, buf);
265 error << _("Read time/size but not buffer, corrupt MIDI ring buffer") << endmsg;
269 /* convert from session time to time relative to the source start */
270 assert(time >= position);
273 ev.set(buf, size, time);
274 ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0]));
275 ev.set_id (Evoral::next_event_id());
277 if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) {
278 /*cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type "
279 << std::hex << int(ev.buffer()[0]) << endl;*/
283 append_event_unlocked_frames(ev, position);
286 Evoral::SMF::flush();
293 /** Append an event with a timestamp in beats (double) */
295 SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
298 if (ev.size() == 0) {
302 /*printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ",
303 name().c_str(), ev.id(), ev.time(), ev.size());
304 for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
306 assert(ev.time() >= 0);
307 if (ev.time() < _last_ev_time_beats) {
308 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
312 Evoral::event_id_t event_id;
315 event_id = Evoral::next_event_id();
321 _model->append (ev, event_id);
324 _length_beats = max(_length_beats, ev.time());
326 const double delta_time_beats = ev.time() - _last_ev_time_beats;
327 const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn());
329 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
330 _last_ev_time_beats = ev.time();
333 /** Append an event with a timestamp in frames (framepos_t) */
335 SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, framepos_t position)
338 if (ev.size() == 0) {
339 cerr << "SMFSource: asked to append zero-size event\n";
343 /* printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ",
344 name().c_str(), ev.id(), ev.time(), ev.size());
345 for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
347 if (ev.time() < _last_ev_time_frames) {
348 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
352 BeatsFramesConverter converter(_session.tempo_map(), position);
353 const double ev_time_beats = converter.from(ev.time());
354 Evoral::event_id_t event_id;
357 event_id = Evoral::next_event_id();
363 const Evoral::Event<double> beat_ev (ev.event_type(),
366 (uint8_t*)ev.buffer());
367 _model->append (beat_ev, event_id);
370 _length_beats = max(_length_beats, ev_time_beats);
372 const Evoral::MusicalTime last_time_beats = converter.from (_last_ev_time_frames);
373 const Evoral::MusicalTime delta_time_beats = ev_time_beats - last_time_beats;
374 const uint32_t delta_time_ticks = (uint32_t)(lrint(delta_time_beats * (double)ppqn()));
376 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
377 _last_ev_time_frames = ev.time();
381 SMFSource::get_state ()
383 XMLNode& node = MidiSource::get_state();
384 node.add_property (X_("origin"), _origin);
389 SMFSource::set_state (const XMLNode& node, int version)
391 if (Source::set_state (node, version)) {
395 if (MidiSource::set_state (node, version)) {
399 if (FileSource::set_state (node, version)) {
407 SMFSource::mark_streaming_midi_write_started (NoteMode mode)
409 /* CALLER MUST HOLD LOCK */
411 if (!_open && open_for_write()) {
412 error << string_compose (_("cannot open MIDI file %1 for write"), _path) << endmsg;
413 /* XXX should probably throw or return something */
417 MidiSource::mark_streaming_midi_write_started (mode);
418 Evoral::SMF::begin_write ();
419 _last_ev_time_beats = 0.0;
420 _last_ev_time_frames = 0;
424 SMFSource::mark_streaming_write_completed ()
426 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
430 SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when)
432 Glib::Mutex::Lock lm (_lock);
433 MidiSource::mark_midi_streaming_write_completed (stuck_notes_option, when);
440 _model->set_edited(false);
443 Evoral::SMF::end_write ();
445 /* data in the file now, not removable */
447 mark_nonremovable ();
451 SMFSource::safe_midi_file_extension (const string& file)
453 return (file.rfind(".mid") != string::npos) || (file.rfind (".MID") != string::npos);
457 SMFSource::load_model (bool lock, bool force_reload)
463 boost::shared_ptr<Glib::Mutex::Lock> lm;
465 lm = boost::shared_ptr<Glib::Mutex::Lock>(new Glib::Mutex::Lock(_lock));
467 if (_model && !force_reload) {
472 _model = boost::shared_ptr<MidiModel> (new MidiModel (shared_from_this ()));
477 if (writable() && !_open) {
481 _model->start_write();
482 Evoral::SMF::seek_to_start();
484 uint64_t time = 0; /* in SMF ticks */
485 Evoral::Event<double> ev;
487 uint32_t scratch_size = 0; // keep track of scratch and minimize reallocs
489 uint32_t delta_t = 0;
494 bool have_event_id = false;
496 while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
502 /* meta-event : did we get an event ID ?
506 have_event_id = true;
514 /* not a meta-event */
516 ev.set (buf, size, time / (double)ppqn());
517 ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
519 if (!have_event_id) {
520 event_id = Evoral::next_event_id();
525 for (uint32_t xx = 0; xx < size; ++xx) {
527 snprintf (b, sizeof (b), "0x%x ", buf[xx]);
531 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n",
532 delta_t, time, size, ss , ev.event_type(), name()));
535 _model->append (ev, event_id);
537 // Set size to max capacity to minimize allocs in read_event
538 scratch_size = std::max(size, scratch_size);
541 _length_beats = max(_length_beats, ev.time());
544 /* event ID's must immediately precede the event they are for
547 have_event_id = false;
550 _model->end_write (Evoral::Sequence<Evoral::MusicalTime>::ResolveStuckNotes, _length_beats);
551 _model->set_edited (false);
553 _model_iter = _model->begin();
559 SMFSource::destroy_model ()
561 //cerr << _name << " destroying model " << _model.get() << endl;
566 SMFSource::flush_midi ()
568 if (!writable() || (writable() && !_open)) {
572 Evoral::SMF::end_write ();
573 /* data in the file means its no longer removable */
574 mark_nonremovable ();
578 SMFSource::set_path (const string& p)
580 FileSource::set_path (p);
581 SMF::set_path (_path);
584 /** Ensure that this source has some file on disk, even if it's just a SMF header */
586 SMFSource::ensure_disk_file ()
589 /* We have a model, so write it to disk; see MidiSource::session_saved
590 for an explanation of what we are doing here.
592 boost::shared_ptr<MidiModel> mm = _model;
594 mm->sync_to_source ();
597 /* No model; if it's not already open, it's an empty source, so create
598 and open it for writing.
604 /* Flush, which will definitely put something on disk */