X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fsmf_source.cc;h=2aae26d847156c4c9f3bc8cb5e5864757ca3788f;hb=480e0b2a5f9f3ced1c0dee6b0a6b178e35f9e89a;hp=d915bba8456025805284055bbd70604c12077a2c;hpb=6acdfc69b785841ac10a324484ddd0208612a213;p=ardour.git diff --git a/libs/ardour/smf_source.cc b/libs/ardour/smf_source.cc index d915bba845..2aae26d847 100644 --- a/libs/ardour/smf_source.cc +++ b/libs/ardour/smf_source.cc @@ -26,28 +26,33 @@ #include #include -#include "pbd/pathscanner.h" +#include "pbd/file_utils.h" #include "pbd/stl_delete.h" #include "pbd/strsplit.h" -#include +#include "pbd/gstdio_compat.h" #include +#include #include "evoral/Control.hpp" +#include "evoral/SMF.hpp" -#include "ardour/event_type_map.h" +#include "ardour/debug.h" +#include "ardour/midi_channel_filter.h" #include "ardour/midi_model.h" #include "ardour/midi_ring_buffer.h" #include "ardour/midi_state_tracker.h" +#include "ardour/parameter_types.h" #include "ardour/session.h" #include "ardour/smf_source.h" -#include "ardour/debug.h" -#include "i18n.h" +#include "pbd/i18n.h" using namespace ARDOUR; using namespace Glib; using namespace PBD; +using namespace Evoral; +using namespace std; /** Constructor used for new internal-to-session files. File cannot exist. */ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags) @@ -55,6 +60,7 @@ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags) , MidiSource(s, path, flags) , FileSource(s, DataType::MIDI, path, string(), flags) , Evoral::SMF() + , _open (false) , _last_ev_time_beats(0.0) , _last_ev_time_frames(0) , _smf_last_read_end (0) @@ -62,11 +68,59 @@ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags) { /* note that origin remains empty */ - if (init(_path, false)) { + if (init (_path, false)) { throw failed_constructor (); } + assert (!Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); + existence_check (); + + _flags = Source::Flag (_flags | Empty); + /* file is not opened until write */ + + if (flags & Writable) { + return; + } + + if (open (_path)) { + throw failed_constructor (); + } + + _open = true; +} + +/** Constructor used for external-to-session files. File must exist. */ +SMFSource::SMFSource (Session& s, const string& path) + : Source(s, DataType::MIDI, path, Source::Flag (0)) + , MidiSource(s, path, Source::Flag (0)) + , FileSource(s, DataType::MIDI, path, string(), Source::Flag (0)) + , Evoral::SMF() + , _open (false) + , _last_ev_time_beats(0.0) + , _last_ev_time_frames(0) + , _smf_last_read_end (0) + , _smf_last_read_time (0) +{ + /* note that origin remains empty */ + + if (init (_path, true)) { + throw failed_constructor (); + } + + assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); + existence_check (); + + if (_flags & Writable) { + /* file is not opened until write */ + return; + } + + if (open (_path)) { + throw failed_constructor (); + } + + _open = true; } /** Constructor used for existing internal-to-session files. */ @@ -74,6 +128,7 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist) : Source(s, node) , MidiSource(s, node) , FileSource(s, node, must_exist) + , _open (false) , _last_ev_time_beats(0.0) , _last_ev_time_frames(0) , _smf_last_read_end (0) @@ -83,11 +138,47 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist) throw failed_constructor (); } - if (init(_path, true)) { - throw failed_constructor (); + /* we expect the file to exist, but if no MIDI data was ever added + it will have been removed at last session close. so, we don't + require it to exist if it was marked Empty. + */ + + try { + + if (init (_path, true)) { + throw failed_constructor (); + } + + } catch (MissingSource& err) { + + if (_flags & Source::Empty) { + /* we don't care that the file was not found, because + it was empty. But FileSource::init() will have + failed to set our _path correctly, so we have to do + this ourselves. Use the first entry in the search + path for MIDI files, which is assumed to be the + correct "main" location. + */ + std::vector sdirs = s.source_search_path (DataType::MIDI); + _path = Glib::build_filename (sdirs.front(), _path); + /* This might be important, too */ + _file_is_new = true; + } else { + /* pass it on */ + throw; + } + } + + if (!(_flags & Source::Empty)) { + assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); + existence_check (); + } else { + assert (_flags & Source::Writable); + /* file will be opened on write */ + return; } - if (open(_path)) { + if (open (_path)) { throw failed_constructor (); } @@ -111,13 +202,21 @@ SMFSource::open_for_write () return 0; } +void +SMFSource::close () +{ + /* nothing to do: file descriptor is never kept open */ +} + /** All stamps in audio frames */ framecnt_t -SMFSource::read_unlocked (Evoral::EventSink& destination, +SMFSource::read_unlocked (const Lock& lock, + Evoral::EventSink& destination, framepos_t const source_start, framepos_t start, framecnt_t duration, - MidiStateTracker* tracker) const + MidiStateTracker* tracker, + MidiChannelFilter* filter) const { int ret = 0; uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn @@ -139,7 +238,7 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, BeatsFramesConverter converter(_session.tempo_map(), source_start); - const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn()); + const uint64_t start_ticks = converter.from(start).to_ticks(); DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start in ticks %1\n", start_ticks)); if (_smf_last_read_end == 0 || start != _smf_last_read_end) { @@ -177,7 +276,7 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, continue; } - ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]); + ev_type = midi_parameter_type(ev_buffer[0]); DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked delta %1, time %2, buf[0] %3, type %4\n", ev_delta_t, time, ev_buffer[0], ev_type)); @@ -187,16 +286,13 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, /* 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; + const framepos_t ev_frame_time = converter.to(Evoral::Beats::ticks_at_rate(time, ppqn())) + source_start; if (ev_frame_time < start + duration) { - destination.write (ev_frame_time, ev_type, ev_size, ev_buffer); - - if (tracker) { - if (ev_buffer[0] & MIDI_CMD_NOTE_ON) { - tracker->add (ev_buffer[1], ev_buffer[0] & 0xf); - } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) { - tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf); + if (!filter || !filter->filter(ev_buffer, ev_size)) { + destination.write (ev_frame_time, ev_type, ev_size, ev_buffer); + if (tracker) { + tracker->track(ev_buffer); } } } else { @@ -213,12 +309,13 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, } framecnt_t -SMFSource::write_unlocked (MidiRingBuffer& source, +SMFSource::write_unlocked (const Lock& lock, + MidiRingBuffer& source, framepos_t position, framecnt_t cnt) { if (!_writing) { - mark_streaming_write_started (); + mark_streaming_write_started (lock); } framepos_t time; @@ -273,16 +370,16 @@ SMFSource::write_unlocked (MidiRingBuffer& source, break; } time -= position; - + ev.set(buf, size, time); - ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0])); + ev.set_event_type(midi_parameter_type(ev.buffer()[0])); ev.set_id(Evoral::next_event_id()); if (!(ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex())) { continue; } - append_event_unlocked_frames(ev, position); + append_event_frames(lock, ev, position); } Evoral::SMF::flush (); @@ -291,22 +388,37 @@ SMFSource::write_unlocked (MidiRingBuffer& source, return cnt; } -/** Append an event with a timestamp in beats (double) */ +/** Append an event with a timestamp in beats */ void -SMFSource::append_event_unlocked_beats (const Evoral::Event& ev) +SMFSource::append_event_beats (const Glib::Threads::Mutex::Lock& lock, + const Evoral::Event& ev) { if (!_writing || ev.size() == 0) { return; } - /*printf("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ", +#if 0 + printf("SMFSource: %s - append_event_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"); +#endif - if (ev.time() < _last_ev_time_beats) { - warning << string_compose(_("Skipping event with unordered time %1"), ev.time()) - << endmsg; - return; + Evoral::Beats time = ev.time(); + if (time < _last_ev_time_beats) { + const Evoral::Beats difference = _last_ev_time_beats - time; + if (difference.to_double() / (double)ppqn() < 1.0) { + /* Close enough. This problem occurs because Sequence is not + actually ordered due to fuzzy time comparison. I'm pretty sure + this is inherently a bad idea which causes problems all over the + place, but tolerate it here for now anyway. */ + time = _last_ev_time_beats; + } else { + /* Out of order by more than a tick. */ + warning << string_compose(_("Skipping event with unordered beat time %1 < %2 (off by %3 beats, %4 ticks)"), + ev.time(), _last_ev_time_beats, difference, difference.to_double() / (double)ppqn()) + << endmsg; + return; + } } Evoral::event_id_t event_id; @@ -321,36 +433,40 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event& ev) _model->append (ev, event_id); } - _length_beats = max(_length_beats, ev.time()); + _length_beats = max(_length_beats, time); - const double delta_time_beats = ev.time() - _last_ev_time_beats; - const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn()); + const Evoral::Beats delta_time_beats = time - _last_ev_time_beats; + const uint32_t delta_time_ticks = delta_time_beats.to_ticks(ppqn()); Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id); - _last_ev_time_beats = ev.time(); + _last_ev_time_beats = time; + _flags = Source::Flag (_flags & ~Empty); } /** Append an event with a timestamp in frames (framepos_t) */ void -SMFSource::append_event_unlocked_frames (const Evoral::Event& ev, framepos_t position) +SMFSource::append_event_frames (const Glib::Threads::Mutex::Lock& lock, + const Evoral::Event& ev, + framepos_t position) { if (!_writing || ev.size() == 0) { return; } - // printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ", + // printf("SMFSource: %s - append_event_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) { - warning << string_compose(_("Skipping event with unordered time %1"), ev.time()) + warning << string_compose(_("Skipping event with unordered frame time %1 < %2"), + ev.time(), _last_ev_time_frames) << endmsg; return; } BeatsFramesConverter converter(_session.tempo_map(), position); - const double ev_time_beats = converter.from(ev.time()); - Evoral::event_id_t event_id; + const Evoral::Beats ev_time_beats = converter.from(ev.time()); + Evoral::event_id_t event_id; if (ev.id() < 0) { event_id = Evoral::next_event_id(); @@ -359,21 +475,22 @@ SMFSource::append_event_unlocked_frames (const Evoral::Event& ev, fr } if (_model) { - const Evoral::Event beat_ev (ev.event_type(), - ev_time_beats, - ev.size(), - const_cast(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 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())); + const Evoral::Beats last_time_beats = converter.from (_last_ev_time_frames); + const Evoral::Beats delta_time_beats = ev_time_beats - last_time_beats; + const uint32_t delta_time_ticks = delta_time_beats.to_ticks(ppqn()); Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id); _last_ev_time_frames = ev.time(); + _flags = Source::Flag (_flags & ~Empty); } XMLNode& @@ -403,33 +520,30 @@ SMFSource::set_state (const XMLNode& node, int version) } void -SMFSource::mark_streaming_midi_write_started (NoteMode mode) +SMFSource::mark_streaming_midi_write_started (const Lock& lock, NoteMode mode) { - /* 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); + MidiSource::mark_streaming_midi_write_started (lock, mode); Evoral::SMF::begin_write (); - _last_ev_time_beats = 0.0; + _last_ev_time_beats = Evoral::Beats(); _last_ev_time_frames = 0; } void -SMFSource::mark_streaming_write_completed () +SMFSource::mark_streaming_write_completed (const Lock& lock) { - mark_midi_streaming_write_completed (Evoral::Sequence::DeleteStuckNotes); + mark_midi_streaming_write_completed (lock, Evoral::Sequence::DeleteStuckNotes); } void -SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when) +SMFSource::mark_midi_streaming_write_completed (const Lock& lm, Evoral::Sequence::StuckNoteOption stuck_notes_option, Evoral::Beats when) { - Glib::Threads::Mutex::Lock lm (_lock); - MidiSource::mark_midi_streaming_write_completed (stuck_notes_option, when); + MidiSource::mark_midi_streaming_write_completed (lm, stuck_notes_option, when); if (!writable()) { warning << string_compose ("attempt to write to unwritable SMF file %1", _path) << endmsg; @@ -440,13 +554,22 @@ SMFSource::mark_midi_streaming_write_completed (Evoral::Sequenceset_edited(false); } - Evoral::SMF::end_write (); + Evoral::SMF::end_write (_path); /* data in the file now, not removable */ mark_nonremovable (); } +bool +SMFSource::valid_midi_file (const string& file) +{ + if (safe_midi_file_extension (file) ) { + return (SMF::test (file) ); + } + return false; +} + bool SMFSource::safe_midi_file_extension (const string& file) { @@ -454,13 +577,20 @@ SMFSource::safe_midi_file_extension (const string& file) static bool compile = true; const int nmatches = 2; regmatch_t matches[nmatches]; - - if (compile && regcomp (&compiled_pattern, "[mM][iI][dD][iI]?$", REG_EXTENDED)) { + + if (Glib::file_test (file, Glib::FILE_TEST_EXISTS)) { + if (!Glib::file_test (file, Glib::FILE_TEST_IS_REGULAR)) { + /* exists but is not a regular file */ + return false; + } + } + + 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; } @@ -468,17 +598,19 @@ SMFSource::safe_midi_file_extension (const string& file) return true; } +static bool compare_eventlist ( + const std::pair< Evoral::Event*, gint >& a, + const std::pair< Evoral::Event*, gint >& b) { + return ( a.first->time() < b.first->time() ); +} + void -SMFSource::load_model (bool lock, bool force_reload) +SMFSource::load_model (const Glib::Threads::Mutex::Lock& lock, bool force_reload) { if (_writing) { return; } - boost::shared_ptr lm; - if (lock) - lm = boost::shared_ptr(new Glib::Threads::Mutex::Lock(_lock)); - if (_model && !force_reload) { return; } @@ -489,6 +621,8 @@ SMFSource::load_model (bool lock, bool force_reload) _model->clear(); } + invalidate(lock); + if (writable() && !_open) { return; } @@ -497,7 +631,7 @@ SMFSource::load_model (bool lock, bool force_reload) Evoral::SMF::seek_to_start(); uint64_t time = 0; /* in SMF ticks */ - Evoral::Event ev; + Evoral::Event ev; uint32_t scratch_size = 0; // keep track of scratch and minimize reallocs @@ -506,108 +640,134 @@ SMFSource::load_model (bool lock, bool force_reload) uint8_t* buf = NULL; int ret; gint event_id; - bool have_event_id = false; + bool have_event_id; - while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) { + // TODO simplify event allocation + std::list< std::pair< Evoral::Event*, gint > > eventlist; - time += delta_t; + for (unsigned i = 1; i <= num_tracks(); ++i) { + if (seek_to_track(i)) continue; - if (ret == 0) { - - /* meta-event : did we get an event ID ? - */ - - if (event_id >= 0) { - have_event_id = true; - } + time = 0; + have_event_id = false; - continue; - } + while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) { - if (ret > 0) { + time += delta_t; - /* not a meta-event */ + if (ret == 0) { + /* meta-event : did we get an event ID ? */ + if (event_id >= 0) { + have_event_id = true; + } + continue; + } - ev.set (buf, size, time / (double)ppqn()); - ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0])); + if (ret > 0) { + /* not a meta-event */ - if (!have_event_id) { - event_id = Evoral::next_event_id(); - } + if (!have_event_id) { + event_id = Evoral::next_event_id(); + } + const uint32_t event_type = midi_parameter_type(buf[0]); + const Evoral::Beats event_time = Evoral::Beats::ticks_at_rate(time, ppqn()); #ifndef NDEBUG - std::string ss; + std::string ss; - for (uint32_t xx = 0; xx < size; ++xx) { - char b[8]; - snprintf (b, sizeof (b), "0x%x ", buf[xx]); - ss += b; - } + 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())); + DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %7 load model delta %1, time %2, size %3 buf %4, type %5 id %6\n", + delta_t, time, size, ss , event_type, event_id, name())); #endif - _model->append (ev, event_id); + eventlist.push_back(make_pair ( + new Evoral::Event ( + event_type, event_time, + size, buf, true) + , event_id)); - // Set size to max capacity to minimize allocs in read_event - scratch_size = std::max(size, scratch_size); - size = scratch_size; + // Set size to max capacity to minimize allocs in read_event + scratch_size = std::max(size, scratch_size); + size = scratch_size; - _length_beats = max(_length_beats, ev.time()); + _length_beats = max(_length_beats, event_time); + } + + /* event ID's must immediately precede the event they are for */ + have_event_id = false; } + } - /* event ID's must immediately precede the event they are for - */ + eventlist.sort(compare_eventlist); - have_event_id = false; + std::list< std::pair< Evoral::Event*, gint > >::iterator it; + for (it=eventlist.begin(); it!=eventlist.end(); ++it) { + _model->append (*it->first, it->second); + delete it->first; } - _model->end_write (Evoral::Sequence::ResolveStuckNotes, _length_beats); - _model->set_edited (false); + // cerr << "----SMF-SRC-----\n"; + // _playback_buf->dump (cerr); + // cerr << "----------------\n"; - _model_iter = _model->begin(); + _model->end_write (Evoral::Sequence::ResolveStuckNotes, _length_beats); + _model->set_edited (false); + invalidate(lock); free(buf); } void -SMFSource::destroy_model () +SMFSource::destroy_model (const Glib::Threads::Mutex::Lock& lock) { //cerr << _name << " destroying model " << _model.get() << endl; _model.reset(); + invalidate(lock); } void -SMFSource::flush_midi () +SMFSource::flush_midi (const Lock& lock) { - if (!writable() || (writable() && !_open)) { + if (!writable() || _length_beats == 0.0) { return; } - Evoral::SMF::end_write (); + ensure_disk_file (lock); + + Evoral::SMF::end_write (_path); /* data in the file means its no longer removable */ mark_nonremovable (); + + invalidate(lock); } void SMFSource::set_path (const string& p) { 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 () +SMFSource::ensure_disk_file (const Lock& lock) { + if (!writable()) { + return; + } + 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 (); + mm->sync_to_source (lock); _model = mm; + invalidate(lock); } else { /* No model; if it's not already open, it's an empty source, so create and open it for writing. @@ -615,9 +775,17 @@ SMFSource::ensure_disk_file () if (!_open) { open_for_write (); } - - /* Flush, which will definitely put something on disk */ - flush_midi (); } } +void +SMFSource::prevent_deletion () +{ + /* Unlike the audio case, the MIDI file remains mutable (because we can + edit MIDI data) + */ + + _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy)); +} + +