X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fsmf_source.cc;h=7f5e8059c936c624b5d9a91bc29421bb740216ea;hb=b68a4e5cdc59ffb81c1952ac9cad63ddf0c76d06;hp=c3bc78c83dec8cc94b7f4cea564004de69fd2624;hpb=2f6065b32c26dba0f7ea5da5c980d0406c36cc55;p=ardour.git diff --git a/libs/ardour/smf_source.cc b/libs/ardour/smf_source.cc index c3bc78c83d..7f5e8059c9 100644 --- a/libs/ardour/smf_source.cc +++ b/libs/ardour/smf_source.cc @@ -26,20 +26,21 @@ #include #include -#include "pbd/pathscanner.h" +#include "pbd/file_utils.h" #include "pbd/stl_delete.h" #include "pbd/strsplit.h" +#include #include #include #include "evoral/Control.hpp" -#include "evoral/evoral/SMF.hpp" +#include "evoral/SMF.hpp" -#include "ardour/event_type_map.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" @@ -50,6 +51,7 @@ 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) @@ -57,6 +59,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) @@ -71,6 +74,8 @@ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags) 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) { @@ -90,6 +95,7 @@ SMFSource::SMFSource (Session& s, const string& path) , 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) @@ -97,16 +103,15 @@ SMFSource::SMFSource (Session& s, const string& path) { /* note that origin remains empty */ - if (init (_path, false)) { + if (init (_path, true)) { throw failed_constructor (); } assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); existence_check (); - /* file is not opened until write */ - if (_flags & Writable) { + /* file is not opened until write */ return; } @@ -122,6 +127,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) @@ -131,14 +137,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; + } } - assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); - existence_check (); + 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 (); } @@ -148,7 +187,7 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist) SMFSource::~SMFSource () { if (removable()) { - unlink (_path.c_str()); + ::g_unlink (_path.c_str()); } } @@ -164,7 +203,8 @@ SMFSource::open_for_write () /** 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, @@ -190,7 +230,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) { @@ -228,7 +268,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)); @@ -238,17 +278,12 @@ 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); - } + tracker->track(ev_buffer); } } else { break; @@ -264,12 +299,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; @@ -326,14 +362,14 @@ SMFSource::write_unlocked (MidiRingBuffer& source, 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 (); @@ -342,22 +378,35 @@ 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 = ", + /*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");*/ - 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; @@ -372,36 +421,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(); @@ -410,21 +463,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& @@ -454,33 +508,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; @@ -536,22 +587,18 @@ SMFSource::safe_midi_file_extension (const string& file) } static bool compare_eventlist ( - const std::pair< Evoral::Event*, gint >& a, - const std::pair< Evoral::Event*, gint >& b) { + 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; } @@ -562,6 +609,8 @@ SMFSource::load_model (bool lock, bool force_reload) _model->clear(); } + invalidate(lock); + if (writable() && !_open) { return; } @@ -570,7 +619,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 @@ -582,7 +631,7 @@ SMFSource::load_model (bool lock, bool force_reload) bool have_event_id; // TODO simplify event allocation - std::list< std::pair< Evoral::Event*, gint > > eventlist; + std::list< std::pair< Evoral::Event*, gint > > eventlist; for (unsigned i = 1; i <= num_tracks(); ++i) { if (seek_to_track(i)) continue; @@ -608,8 +657,8 @@ SMFSource::load_model (bool lock, bool force_reload) if (!have_event_id) { event_id = Evoral::next_event_id(); } - uint32_t event_type = EventTypeMap::instance().midi_event_type(buf[0]); - double event_time = time / (double) ppqn(); + 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; @@ -624,7 +673,7 @@ SMFSource::load_model (bool lock, bool force_reload) #endif eventlist.push_back(make_pair ( - new Evoral::Event ( + new Evoral::Event ( event_type, event_time, size, buf, true) , event_id)); @@ -643,37 +692,41 @@ SMFSource::load_model (bool lock, bool force_reload) eventlist.sort(compare_eventlist); - std::list< std::pair< Evoral::Event*, gint > >::iterator it; + 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->end_write (Evoral::Sequence::ResolveStuckNotes, _length_beats); _model->set_edited (false); - - _model_iter = _model->begin(); + 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; } + ensure_disk_file (lock); + Evoral::SMF::end_write (); /* data in the file means its no longer removable */ mark_nonremovable (); + + invalidate(lock); } void @@ -685,16 +738,21 @@ SMFSource::set_path (const string& p) /** 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. @@ -702,9 +760,6 @@ SMFSource::ensure_disk_file () if (!_open) { open_for_write (); } - - /* Flush, which will definitely put something on disk */ - flush_midi (); } } @@ -717,35 +772,5 @@ SMFSource::prevent_deletion () _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy)); } - -int -SMFSource::rename (const string& newname) -{ - Glib::Threads::Mutex::Lock lm (_lock); - string oldpath = _path; - string newpath = _session.new_source_path_from_name (DataType::MIDI, newname); - - if (newpath.empty()) { - error << string_compose (_("programming error: %1"), "cannot generate a changed file path") << endmsg; - return -1; - } - - // Test whether newpath exists, if yes notify the user but continue. - if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) { - error << string_compose (_("Programming error! %1 tried to rename a file over another file! It's safe to continue working, but please report this to the developers."), PROGRAM_NAME) << endmsg; - return -1; - } - - if (Glib::file_test (oldpath.c_str(), Glib::FILE_TEST_EXISTS)) { - /* rename only needed if file exists on disk */ - if (::rename (oldpath.c_str(), newpath.c_str()) != 0) { - error << string_compose (_("cannot rename file %1 to %2 (%3)"), oldpath, newpath, strerror(errno)) << endmsg; - return -1; - } - } - - _name = Glib::path_get_basename (newpath); - _path = newpath; - - return 0; -} + +