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/pathscanner.h"
29 #include "pbd/stl_delete.h"
30 #include "pbd/strsplit.h"
32 #include <glibmm/miscutils.h>
34 #include "evoral/Control.hpp"
36 #include "ardour/event_type_map.h"
37 #include "ardour/midi_model.h"
38 #include "ardour/midi_ring_buffer.h"
39 #include "ardour/midi_state_tracker.h"
40 #include "ardour/session.h"
41 #include "ardour/smf_source.h"
42 #include "ardour/debug.h"
46 using namespace ARDOUR;
50 /** Constructor used for new internal-to-session files. File cannot exist. */
51 SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
52 : Source(s, DataType::MIDI, path, flags)
53 , MidiSource(s, path, flags)
54 , FileSource(s, DataType::MIDI, path, string(), flags)
56 , _last_ev_time_beats(0.0)
57 , _last_ev_time_frames(0)
58 , _smf_last_read_end (0)
59 , _smf_last_read_time (0)
61 /* note that origin remains empty */
63 if (init(_path, false)) {
64 throw failed_constructor ();
67 /* file is not opened until write */
70 /** Constructor used for existing internal-to-session files. */
71 SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
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 , _smf_last_read_time (0)
80 if (set_state(node, Stateful::loading_state_version)) {
81 throw failed_constructor ();
84 if (init(_path, true)) {
85 throw failed_constructor ();
89 throw failed_constructor ();
95 SMFSource::~SMFSource ()
98 unlink (_path.c_str());
103 SMFSource::open_for_write ()
105 if (create (_path)) {
112 /** All stamps in audio frames */
114 SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination, framepos_t const source_start,
115 framepos_t start, framecnt_t duration,
116 MidiStateTracker* tracker) const
119 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
121 if (writable() && !_open) {
122 /* nothing to read since nothing has ben written */
126 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration));
128 // Output parameters for read_event (which will allocate scratch in buffer as needed)
129 uint32_t ev_delta_t = 0;
130 uint32_t ev_type = 0;
131 uint32_t ev_size = 0;
132 uint8_t* ev_buffer = 0;
134 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
136 BeatsFramesConverter converter(_session.tempo_map(), source_start);
138 const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn());
139 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start in ticks %1\n", start_ticks));
141 if (_smf_last_read_end == 0 || start != _smf_last_read_end) {
142 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start));
143 Evoral::SMF::seek_to_start();
144 while (time < start_ticks) {
147 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
148 if (ret == -1) { // EOF
149 _smf_last_read_end = start + duration;
152 time += ev_delta_t; // accumulate delta time
155 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: set time to %1\n", _smf_last_read_time));
156 time = _smf_last_read_time;
159 _smf_last_read_end = start + duration;
162 gint ignored; /* XXX don't ignore note id's ??*/
164 ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
165 if (ret == -1) { // EOF
169 time += ev_delta_t; // accumulate delta time
170 _smf_last_read_time = time;
172 if (ret == 0) { // meta-event (skipped, just accumulate time)
176 ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
178 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked delta %1, time %2, buf[0] %3, type %4\n",
179 ev_delta_t, time, ev_buffer[0], ev_type));
181 assert(time >= start_ticks);
183 /* Note that we add on the source start time (in session frames) here so that ev_frame_time
184 is in session frames.
186 const framepos_t ev_frame_time = converter.to(time / (double)ppqn()) + source_start;
188 if (ev_frame_time < start + duration) {
189 destination.write (ev_frame_time, ev_type, ev_size, ev_buffer);
192 if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
193 tracker->add (ev_buffer[1], ev_buffer[0] & 0xf);
194 } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) {
195 tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf);
202 if (ev_size > scratch_size) {
203 scratch_size = ev_size;
205 ev_size = scratch_size; // ensure read_event only allocates if necessary
211 /** Write data to this source from a MidiRingBuffer.
212 * @param source Buffer to read from.
213 * @param position This source's start position in session frames.
216 SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t position, framecnt_t duration)
219 mark_streaming_write_started ();
223 Evoral::EventType type;
226 size_t buf_capacity = 4;
227 uint8_t* buf = (uint8_t*)malloc(buf_capacity);
229 if (_model && ! _model->writing()) {
230 _model->start_write();
233 Evoral::MIDIEvent<framepos_t> ev;
235 // cerr << "SMFSource::write unlocked, begins writing from src buffer with _last_write_end = " << _last_write_end << " dur = " << duration << endl;
240 if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) {
241 /* no more events to consider */
245 if ((duration != max_framecnt) && (time > (_last_write_end + duration))) {
246 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("SMFSource::write_unlocked: dropping event @ %1 because it is later than %2 + %3\n",
247 time, _last_write_end, duration));
251 if (!(ret = source.read_prefix (&time, &type, &size))) {
252 error << _("Unable to read event prefix, corrupt MIDI ring buffer") << endmsg;
256 if (size > buf_capacity) {
258 buf = (uint8_t*)realloc(buf, size);
261 ret = source.read_contents(size, buf);
263 error << _("Read time/size but not buffer, corrupt MIDI ring buffer") << endmsg;
267 /* convert from session time to time relative to the source start */
268 assert(time >= position);
271 ev.set(buf, size, time);
272 ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0]));
273 ev.set_id (Evoral::next_event_id());
275 if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) {
276 /*cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type "
277 << std::hex << int(ev.buffer()[0]) << endl;*/
281 append_event_unlocked_frames(ev, position);
284 Evoral::SMF::flush();
291 /** Append an event with a timestamp in beats (double) */
293 SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
296 if (ev.size() == 0) {
300 /*printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ",
301 name().c_str(), ev.id(), ev.time(), ev.size());
302 for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
304 assert(ev.time() >= 0);
305 if (ev.time() < _last_ev_time_beats) {
306 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
310 Evoral::event_id_t event_id;
313 event_id = Evoral::next_event_id();
319 _model->append (ev, event_id);
322 _length_beats = max(_length_beats, ev.time());
324 const double delta_time_beats = ev.time() - _last_ev_time_beats;
325 const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn());
327 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
328 _last_ev_time_beats = ev.time();
331 /** Append an event with a timestamp in frames (framepos_t) */
333 SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, framepos_t position)
336 if (ev.size() == 0) {
337 cerr << "SMFSource: asked to append zero-size event\n";
341 /* printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ",
342 name().c_str(), ev.id(), ev.time(), ev.size());
343 for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
345 if (ev.time() < _last_ev_time_frames) {
346 cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
350 BeatsFramesConverter converter(_session.tempo_map(), position);
351 const double ev_time_beats = converter.from(ev.time());
352 Evoral::event_id_t event_id;
355 event_id = Evoral::next_event_id();
361 const Evoral::Event<double> beat_ev (ev.event_type(),
364 (uint8_t*)ev.buffer());
365 _model->append (beat_ev, event_id);
368 _length_beats = max(_length_beats, ev_time_beats);
370 const Evoral::MusicalTime last_time_beats = converter.from (_last_ev_time_frames);
371 const Evoral::MusicalTime delta_time_beats = ev_time_beats - last_time_beats;
372 const uint32_t delta_time_ticks = (uint32_t)(lrint(delta_time_beats * (double)ppqn()));
374 Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
375 _last_ev_time_frames = ev.time();
379 SMFSource::get_state ()
381 XMLNode& node = MidiSource::get_state();
382 node.add_property (X_("origin"), _origin);
387 SMFSource::set_state (const XMLNode& node, int version)
389 if (Source::set_state (node, version)) {
393 if (MidiSource::set_state (node, version)) {
397 if (FileSource::set_state (node, version)) {
405 SMFSource::mark_streaming_midi_write_started (NoteMode mode)
407 /* CALLER MUST HOLD LOCK */
409 if (!_open && open_for_write()) {
410 error << string_compose (_("cannot open MIDI file %1 for write"), _path) << endmsg;
411 /* XXX should probably throw or return something */
415 MidiSource::mark_streaming_midi_write_started (mode);
416 Evoral::SMF::begin_write ();
417 _last_ev_time_beats = 0.0;
418 _last_ev_time_frames = 0;
422 SMFSource::mark_streaming_write_completed ()
424 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
428 SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when)
430 Glib::Mutex::Lock lm (_lock);
431 MidiSource::mark_midi_streaming_write_completed (stuck_notes_option, when);
438 _model->set_edited(false);
441 Evoral::SMF::end_write ();
443 /* data in the file now, not removable */
445 mark_nonremovable ();
449 SMFSource::safe_midi_file_extension (const string& file)
451 return (file.rfind(".mid") != string::npos) || (file.rfind (".MID") != string::npos);
455 SMFSource::load_model (bool lock, bool force_reload)
461 boost::shared_ptr<Glib::Mutex::Lock> lm;
463 lm = boost::shared_ptr<Glib::Mutex::Lock>(new Glib::Mutex::Lock(_lock));
465 if (_model && !force_reload) {
470 _model = boost::shared_ptr<MidiModel> (new MidiModel (shared_from_this ()));
475 if (writable() && !_open) {
479 _model->start_write();
480 Evoral::SMF::seek_to_start();
482 uint64_t time = 0; /* in SMF ticks */
483 Evoral::Event<double> ev;
485 uint32_t scratch_size = 0; // keep track of scratch and minimize reallocs
487 uint32_t delta_t = 0;
492 bool have_event_id = false;
494 while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
500 /* meta-event : did we get an event ID ?
504 have_event_id = true;
512 /* not a meta-event */
514 ev.set (buf, size, time / (double)ppqn());
515 ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
517 if (!have_event_id) {
518 event_id = Evoral::next_event_id();
523 for (uint32_t xx = 0; xx < size; ++xx) {
525 snprintf (b, sizeof (b), "0x%x ", buf[xx]);
529 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n",
530 delta_t, time, size, ss , ev.event_type(), name()));
533 _model->append (ev, event_id);
535 // Set size to max capacity to minimize allocs in read_event
536 scratch_size = std::max(size, scratch_size);
539 _length_beats = max(_length_beats, ev.time());
542 /* event ID's must immediately precede the event they are for
545 have_event_id = false;
548 _model->end_write (Evoral::Sequence<Evoral::MusicalTime>::ResolveStuckNotes, _length_beats);
549 _model->set_edited (false);
551 _model_iter = _model->begin();
557 SMFSource::destroy_model ()
559 //cerr << _name << " destroying model " << _model.get() << endl;
564 SMFSource::flush_midi ()
566 if (!writable() || (writable() && !_open)) {
570 Evoral::SMF::end_write ();
571 /* data in the file means its no longer removable */
572 mark_nonremovable ();
576 SMFSource::set_path (const string& p)
578 FileSource::set_path (p);
579 SMF::set_path (_path);
582 /** Ensure that this source has some file on disk, even if it's just a SMF header */
584 SMFSource::ensure_disk_file ()
587 /* We have a model, so write it to disk; see MidiSource::session_saved
588 for an explanation of what we are doing here.
590 boost::shared_ptr<MidiModel> mm = _model;
592 mm->sync_to_source ();
595 /* No model; if it's not already open, it's an empty source, so create
596 and open it for writing.
602 /* Flush, which will definitely put something on disk */