X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fsmf_source.cc;h=830fd75fdf6a9df618f09ea7a56918db7c7c63bb;hb=4caecfa310a973773a74e74939896133ad6d4c8d;hp=405f12881a3a495a7153b72e9e804a0e35747a87;hpb=bf91ed99ec2b1231c7150bde7f12c8ca573f0834;p=ardour.git diff --git a/libs/ardour/smf_source.cc b/libs/ardour/smf_source.cc index 405f12881a..830fd75fdf 100644 --- a/libs/ardour/smf_source.cc +++ b/libs/ardour/smf_source.cc @@ -1,6 +1,6 @@ /* Copyright (C) 2006 Paul Davis - Written by Dave Robillard, 2006 + Author: David Robillard This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -24,8 +24,8 @@ #include #include #include +#include -#include "pbd/mountpoint.h" #include "pbd/pathscanner.h" #include "pbd/stl_delete.h" #include "pbd/strsplit.h" @@ -34,7 +34,6 @@ #include "evoral/Control.hpp" -#include "ardour/audioengine.h" #include "ardour/event_type_map.h" #include "ardour/midi_model.h" #include "ardour/midi_ring_buffer.h" @@ -50,25 +49,23 @@ using namespace Glib; using namespace PBD; /** Constructor used for new internal-to-session files. File cannot exist. */ -SMFSource::SMFSource (Session& s, const ustring& path, Source::Flag flags) +SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags) : Source(s, DataType::MIDI, path, flags) - , MidiSource(s, path) - , FileSource(s, DataType::MIDI, path, flags) + , MidiSource(s, path, flags) + , FileSource(s, DataType::MIDI, path, string(), flags) , Evoral::SMF() , _last_ev_time_beats(0.0) , _last_ev_time_frames(0) , _smf_last_read_end (0) , _smf_last_read_time (0) { - if (init(_path, false)) { - throw failed_constructor (); - } + /* note that origin remains empty */ - if (create(path)) { + if (init(_path, false)) { throw failed_constructor (); } - load_model(true, true); // FIXME + /* file is not opened until write */ } /** Constructor used for existing internal-to-session files. */ @@ -93,7 +90,7 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist) throw failed_constructor (); } - load_model(true, true); // FIXME + _open = true; } SMFSource::~SMFSource () @@ -103,19 +100,33 @@ SMFSource::~SMFSource () } } +int +SMFSource::open_for_write () +{ + if (create (_path)) { + return -1; + } + _open = true; + return 0; +} + /** All stamps in audio frames */ -nframes_t -SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t source_start, - sframes_t start, nframes_t duration, - sframes_t stamp_offset, sframes_t negative_stamp_offset, - MidiStateTracker* tracker) const +framecnt_t +SMFSource::read_unlocked (Evoral::EventSink& destination, + framepos_t const source_start, + framepos_t start, + framecnt_t duration, + MidiStateTracker* tracker) const { int ret = 0; uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn - DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration)); + if (writable() && !_open) { + /* nothing to read since nothing has ben written */ + return duration; + } - _read_data_count = 0; + DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration)); // Output parameters for read_event (which will allocate scratch in buffer as needed) uint32_t ev_delta_t = 0; @@ -134,7 +145,7 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t s DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start)); Evoral::SMF::seek_to_start(); while (time < start_ticks) { - gint ignored; + gint ignored; ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored); if (ret == -1) { // EOF @@ -151,7 +162,7 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t s _smf_last_read_end = start + duration; while (true) { - gint ignored; /* XXX don't ignore note id's ??*/ + gint ignored; /* XXX don't ignore note id's ??*/ ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored); if (ret == -1) { // EOF @@ -171,16 +182,14 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t s ev_delta_t, time, ev_buffer[0], ev_type)); assert(time >= start_ticks); - const sframes_t ev_frame_time = converter.to(time / (double)ppqn()) + stamp_offset; -#if 0 - cerr << " frames = " << ev_frame_time - << " w/offset = " << ev_frame_time - negative_stamp_offset - << endl; -#endif + /* Note that we add on the source start time (in session frames) here so that ev_frame_time + is in session frames. + */ + const framepos_t ev_frame_time = converter.to(time / (double)ppqn()) + source_start; if (ev_frame_time < start + duration) { - destination.write(ev_frame_time - negative_stamp_offset, ev_type, ev_size, ev_buffer); + destination.write (ev_frame_time, ev_type, ev_size, ev_buffer); if (tracker) { if (ev_buffer[0] & MIDI_CMD_NOTE_ON) { @@ -193,8 +202,6 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t s break; } - _read_data_count += ev_size; - if (ev_size > scratch_size) { scratch_size = ev_size; } @@ -204,99 +211,110 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, sframes_t s return duration; } -/** All stamps in audio frames */ -nframes_t -SMFSource::write_unlocked (MidiRingBuffer& source, sframes_t position, nframes_t duration) +framecnt_t +SMFSource::write_unlocked (MidiRingBuffer& source, + framepos_t position, + framecnt_t cnt) { - _write_data_count = 0; + if (!_writing) { + mark_streaming_write_started (); + } - nframes_t time; + framepos_t time; Evoral::EventType type; uint32_t size; size_t buf_capacity = 4; uint8_t* buf = (uint8_t*)malloc(buf_capacity); - if (_model && ! _model->writing()) { + if (_model && !_model->writing()) { _model->start_write(); } - Evoral::MIDIEvent ev; - + Evoral::MIDIEvent ev; while (true) { - bool ret = source.peek_time(&time); - if (!ret || time > _last_write_end + duration) { + /* Get the event time, in frames since session start but ignoring looping. */ + bool ret; + if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) { + /* Ring is empty, no more events. */ break; } - ret = source.read_prefix(&time, &type, &size); - if (!ret) { - cerr << "ERROR: Unable to read event prefix, corrupt MIDI ring buffer" << endl; + if ((cnt != max_framecnt) && + (time > position + _capture_length + cnt)) { + /* The diskstream doesn't want us to write everything, and this + event is past the end of this block, so we're done for now. */ + break; + } + + /* Read the time, type, and size of the event. */ + if (!(ret = source.read_prefix (&time, &type, &size))) { + error << _("Unable to read event prefix, corrupt MIDI ring") << endmsg; break; } + /* Enlarge body buffer if necessary now that we know the size. */ if (size > buf_capacity) { buf_capacity = size; buf = (uint8_t*)realloc(buf, size); } + /* Read the event body into buffer. */ ret = source.read_contents(size, buf); if (!ret) { - cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl; + error << _("Event has time and size but no body, corrupt MIDI ring") << endmsg; break; } - assert(time >= position); + /* Convert event time from absolute to source relative. */ + if (time < position) { + error << _("Event time is before MIDI source position") << endmsg; + break; + } time -= position; - + ev.set(buf, size, time); ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0])); - ev.set_id (Evoral::next_event_id()); + ev.set_id(Evoral::next_event_id()); if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) { - /*cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type " - << std::hex << int(ev.buffer()[0]) << endl;*/ continue; } append_event_unlocked_frames(ev, position); } - Evoral::SMF::flush(); - free(buf); - - ViewDataRangeReady(position + _last_write_end, duration); /* EMIT SIGNAL */ + Evoral::SMF::flush (); + free (buf); - return duration; + return cnt; } - /** Append an event with a timestamp in beats (double) */ void SMFSource::append_event_unlocked_beats (const Evoral::Event& ev) { - assert(_writing); - if (ev.size() == 0) { + if (!_writing || ev.size() == 0) { return; } - - /* printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ", + + /*printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ", name().c_str(), ev.id(), ev.time(), ev.size()); - for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/ + for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/ - assert(ev.time() >= 0); if (ev.time() < _last_ev_time_beats) { - cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl; + warning << string_compose(_("Skipping event with unordered time %1"), ev.time()) + << endmsg; return; } - Evoral::event_id_t event_id; + Evoral::event_id_t event_id; - if (ev.id() < 0) { - event_id = Evoral::next_event_id(); - } else { - event_id = ev.id(); - } + if (ev.id() < 0) { + event_id = Evoral::next_event_id(); + } else { + event_id = ev.id(); + } if (_model) { _model->append (ev, event_id); @@ -309,64 +327,60 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event& ev) Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id); _last_ev_time_beats = ev.time(); - - _write_data_count += ev.size(); - } -/** Append an event with a timestamp in frames (nframes_t) */ +/** Append an event with a timestamp in frames (framepos_t) */ void -SMFSource::append_event_unlocked_frames (const Evoral::Event& ev, sframes_t position) +SMFSource::append_event_unlocked_frames (const Evoral::Event& ev, framepos_t position) { - assert(_writing); - if (ev.size() == 0) { + if (!_writing || ev.size() == 0) { return; } - /* printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ", - name().c_str(), ev.id(), ev.time(), ev.size()); - for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/ + // printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ", + // name().c_str(), ev.id(), ev.time(), ev.size()); + // for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n"); if (ev.time() < _last_ev_time_frames) { - cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl; + warning << string_compose(_("Skipping event with unordered time %1"), ev.time()) + << endmsg; return; } - + BeatsFramesConverter converter(_session.tempo_map(), position); - const double ev_time_beats = converter.from(ev.time()); - Evoral::event_id_t event_id; + const double ev_time_beats = converter.from(ev.time()); + Evoral::event_id_t event_id; - if (ev.id() < 0) { - event_id = Evoral::next_event_id(); - } else { - event_id = ev.id(); - } + if (ev.id() < 0) { + event_id = Evoral::next_event_id(); + } else { + event_id = ev.id(); + } if (_model) { - const Evoral::Event beat_ev (ev.event_type(), - ev_time_beats, - ev.size(), - (uint8_t*)ev.buffer()); + const Evoral::Event beat_ev (ev.event_type(), + ev_time_beats, + ev.size(), + const_cast(ev.buffer())); _model->append (beat_ev, event_id); - } + } _length_beats = max(_length_beats, ev_time_beats); - const sframes_t delta_time_frames = ev.time() - _last_ev_time_frames; - const double delta_time_beats = converter.from(delta_time_frames); - const uint32_t delta_time_ticks = (uint32_t)(lrint(delta_time_beats * (double)ppqn())); + const Evoral::MusicalTime last_time_beats = converter.from (_last_ev_time_frames); + const Evoral::MusicalTime delta_time_beats = ev_time_beats - last_time_beats; + const uint32_t delta_time_ticks = (uint32_t)(lrint(delta_time_beats * (double)ppqn())); Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id); _last_ev_time_frames = ev.time(); - - _write_data_count += ev.size(); - } XMLNode& SMFSource::get_state () { - return MidiSource::get_state(); + XMLNode& node = MidiSource::get_state(); + node.add_property (X_("origin"), _origin); + return node; } int @@ -388,10 +402,17 @@ SMFSource::set_state (const XMLNode& node, int version) } void -SMFSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame) +SMFSource::mark_streaming_midi_write_started (NoteMode mode) { - Glib::Mutex::Lock lm (_lock); - MidiSource::mark_streaming_midi_write_started (mode, start_frame); + /* CALLER MUST HOLD LOCK */ + + if (!_open && open_for_write()) { + error << string_compose (_("cannot open MIDI file %1 for write"), _path) << endmsg; + /* XXX should probably throw or return something */ + return; + } + + MidiSource::mark_streaming_midi_write_started (mode); Evoral::SMF::begin_write (); _last_ev_time_beats = 0.0; _last_ev_time_frames = 0; @@ -400,28 +421,50 @@ SMFSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_fra void SMFSource::mark_streaming_write_completed () { - Glib::Mutex::Lock lm (_lock); - MidiSource::mark_streaming_write_completed(); + mark_midi_streaming_write_completed (Evoral::Sequence::DeleteStuckNotes); +} + +void +SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when) +{ + Glib::Threads::Mutex::Lock lm (_lock); + MidiSource::mark_midi_streaming_write_completed (stuck_notes_option, when); if (!writable()) { + warning << string_compose ("attempt to write to unwritable SMF file %1", _path) << endmsg; return; } if (_model) { _model->set_edited(false); } - + Evoral::SMF::end_write (); - /* data in the file now, not removable */ + /* data in the file now, not removable */ - mark_nonremovable (); + mark_nonremovable (); } bool -SMFSource::safe_midi_file_extension (const Glib::ustring& file) +SMFSource::safe_midi_file_extension (const string& file) { - return (file.rfind(".mid") != Glib::ustring::npos); + static regex_t compiled_pattern; + static bool compile = true; + const int nmatches = 2; + regmatch_t matches[nmatches]; + + if (compile && regcomp (&compiled_pattern, "[mM][iI][dD][iI]?$", REG_EXTENDED)) { + return false; + } else { + compile = false; + } + + if (regexec (&compiled_pattern, file.c_str(), nmatches, matches, 0)) { + return false; + } + + return true; } void @@ -431,96 +474,95 @@ SMFSource::load_model (bool lock, bool force_reload) return; } - boost::shared_ptr lm; + boost::shared_ptr lm; if (lock) - lm = boost::shared_ptr(new Glib::Mutex::Lock(_lock)); + lm = boost::shared_ptr(new Glib::Threads::Mutex::Lock(_lock)); if (_model && !force_reload) { return; } - if (! _model) { - _model = boost::shared_ptr(new MidiModel(this)); - //cerr << _name << " loaded new model " << _model.get() << endl; + if (!_model) { + _model = boost::shared_ptr (new MidiModel (shared_from_this ())); } else { - /*cerr << _name << " reloading model " << _model.get() - << " (" << _model->n_notes() << " notes)" << endl;*/ _model->clear(); } + if (writable() && !_open) { + return; + } + _model->start_write(); Evoral::SMF::seek_to_start(); uint64_t time = 0; /* in SMF ticks */ Evoral::Event ev; - size_t scratch_size = 0; // keep track of scratch and minimize reallocs + uint32_t scratch_size = 0; // keep track of scratch and minimize reallocs uint32_t delta_t = 0; uint32_t size = 0; uint8_t* buf = NULL; int ret; - gint event_id; - bool have_event_id = false; + gint event_id; + bool have_event_id = false; while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) { time += delta_t; - - if (ret == 0) { - /* meta-event : did we get an event ID ? - */ + if (ret == 0) { - if (event_id >= 0) { - have_event_id = true; - } + /* meta-event : did we get an event ID ? + */ + + if (event_id >= 0) { + have_event_id = true; + } + + continue; + } - continue; - } - - if (ret > 0) { + if (ret > 0) { - /* not a meta-event */ + /* not a meta-event */ - ev.set (buf, size, time / (double)ppqn()); + ev.set (buf, size, time / (double)ppqn()); ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0])); - if (!have_event_id) { - event_id = Evoral::next_event_id(); - } + if (!have_event_id) { + event_id = Evoral::next_event_id(); + } #ifndef NDEBUG - std::string ss; - - for (uint32_t xx = 0; xx < size; ++xx) { - char b[8]; - snprintf (b, sizeof (b), "0x%x ", buf[xx]); - ss += b; - } - - DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n", - delta_t, time, size, ss , ev.event_type(), name())); + std::string ss; + + for (uint32_t xx = 0; xx < size; ++xx) { + char b[8]; + snprintf (b, sizeof (b), "0x%x ", buf[xx]); + ss += b; + } + + DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n", + delta_t, time, size, ss , ev.event_type(), name())); #endif - + _model->append (ev, event_id); - if (ev.size() > scratch_size) { - scratch_size = ev.size(); - } - - ev.size() = scratch_size; // ensure read_event only allocates if necessary - - _length_beats = max(_length_beats, ev.time()); - } + // Set size to max capacity to minimize allocs in read_event + scratch_size = std::max(size, scratch_size); + size = scratch_size; - /* event ID's must immediately precede the event they are for - */ - - have_event_id = false; + _length_beats = max(_length_beats, ev.time()); + } + + /* event ID's must immediately precede the event they are for + */ + + have_event_id = false; } - _model->end_write(false); - _model->set_edited(false); + _model->end_write (Evoral::Sequence::ResolveStuckNotes, _length_beats); + _model->set_edited (false); _model_iter = _model->begin(); @@ -537,18 +579,44 @@ SMFSource::destroy_model () void SMFSource::flush_midi () { - if (!writable()) { - return; - } + if (!writable() || (writable() && !_open)) { + return; + } - Evoral::SMF::end_write(); - /* data in the file means its no longer removable */ - mark_nonremovable (); + Evoral::SMF::end_write (); + /* data in the file means its no longer removable */ + mark_nonremovable (); } void SMFSource::set_path (const string& p) { - FileSource::set_path (p); - SMF::set_path (_path); + FileSource::set_path (p); + SMF::set_path (_path); } + +/** Ensure that this source has some file on disk, even if it's just a SMF header */ +void +SMFSource::ensure_disk_file () +{ + if (_model) { + /* We have a model, so write it to disk; see MidiSource::session_saved + for an explanation of what we are doing here. + */ + boost::shared_ptr mm = _model; + _model.reset (); + mm->sync_to_source (); + _model = mm; + } else { + /* No model; if it's not already open, it's an empty source, so create + and open it for writing. + */ + if (!_open) { + open_for_write (); + } + + /* Flush, which will definitely put something on disk */ + flush_midi (); + } +} +