X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fsmf_source.cc;h=812e06c27b08d30252630d1bb776fc4178567a8c;hb=cd8aa4e3044bfa2f6956e02ccc5458b3c9fbadc4;hp=5ad5c2b745bdf294e288275f215f01902d22e0bc;hpb=3225b24854e0810cf62c55a8ce179ff3e659bce4;p=ardour.git diff --git a/libs/ardour/smf_source.cc b/libs/ardour/smf_source.cc index 5ad5c2b745..812e06c27b 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,17 +24,18 @@ #include #include #include +#include -#include "pbd/mountpoint.h" #include "pbd/pathscanner.h" #include "pbd/stl_delete.h" #include "pbd/strsplit.h" +#include #include +#include #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" @@ -62,11 +63,24 @@ 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 (); } - - /* file is not opened until write */ + + assert (!Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); + existence_check (); + + /* file is not opened until write */ + + if (flags & Writable) { + return; + } + + if (open (_path)) { + throw failed_constructor (); + } + + _open = true; } /** Constructor used for existing internal-to-session files. */ @@ -83,21 +97,24 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist) throw failed_constructor (); } - if (init(_path, true)) { + if (init (_path, true)) { throw failed_constructor (); } + assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)); + existence_check (); + if (open(_path)) { throw failed_constructor (); } - _open = true; + _open = true; } SMFSource::~SMFSource () { if (removable()) { - unlink (_path.c_str()); + ::g_unlink (_path.c_str()); } } @@ -105,30 +122,30 @@ int SMFSource::open_for_write () { if (create (_path)) { - return -1; - } - _open = true; - return 0; + return -1; + } + _open = true; + return 0; } /** All stamps in audio frames */ framecnt_t -SMFSource::read_unlocked (Evoral::EventSink& destination, framepos_t const source_start, - framepos_t start, framecnt_t duration, - MidiStateTracker* tracker) const +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 - if (writable() && !_open) { - /* nothing to read since nothing has ben written */ - return duration; - } + if (writable() && !_open) { + /* nothing to read since nothing has ben written */ + return duration; + } DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration)); - _read_data_count = 0; - // Output parameters for read_event (which will allocate scratch in buffer as needed) uint32_t ev_delta_t = 0; uint32_t ev_type = 0; @@ -203,8 +220,6 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, framepos_t break; } - _read_data_count += ev_size; - if (ev_size > scratch_size) { scratch_size = ev_size; } @@ -214,18 +229,14 @@ SMFSource::read_unlocked (Evoral::EventSink& destination, framepos_t return duration; } -/** Write data to this source from a MidiRingBuffer. - * @param source Buffer to read from. - * @param position This source's start position in session frames. - */ framecnt_t -SMFSource::write_unlocked (MidiRingBuffer& source, framepos_t position, framecnt_t duration) +SMFSource::write_unlocked (MidiRingBuffer& source, + framepos_t position, + framecnt_t cnt) { - if (!_writing) { - mark_streaming_write_started (); - } - - _write_data_count = 0; + if (!_writing) { + mark_streaming_write_started (); + } framepos_t time; Evoral::EventType type; @@ -234,75 +245,84 @@ SMFSource::write_unlocked (MidiRingBuffer& source, framepos_t positi 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; - 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; } - /* convert from session time to time relative to the source start */ - 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); + 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; } @@ -325,26 +345,23 @@ 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 (framepos_t) */ void 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; } @@ -359,24 +376,21 @@ 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(), - (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 framepos_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& @@ -408,13 +422,13 @@ SMFSource::set_state (const XMLNode& node, int version) void SMFSource::mark_streaming_midi_write_started (NoteMode mode) { - /* CALLER MUST HOLD LOCK */ + /* 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; - } + 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 (); @@ -425,28 +439,63 @@ SMFSource::mark_streaming_midi_write_started (NoteMode mode) 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 */ - mark_nonremovable (); + mark_nonremovable (); } bool SMFSource::safe_midi_file_extension (const string& file) { - return (file.rfind(".mid") != string::npos); + static regex_t compiled_pattern; + static bool compile = true; + const int nmatches = 2; + regmatch_t matches[nmatches]; + + 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; + } + + 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 @@ -456,9 +505,9 @@ 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; @@ -470,9 +519,9 @@ SMFSource::load_model (bool lock, bool force_reload) _model->clear(); } - if (writable() && !_open) { - return; - } + if (writable() && !_open) { + return; + } _model->start_write(); Evoral::SMF::seek_to_start(); @@ -480,73 +529,85 @@ SMFSource::load_model (bool lock, bool force_reload) 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; + 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; - - if (ret == 0) { + for (unsigned i = 1; i <= num_tracks(); ++i) { + if (seek_to_track(i)) continue; - /* meta-event : did we get an event ID ? - */ + time = 0; + have_event_id = false; - if (event_id >= 0) { - have_event_id = true; - } + while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) { - continue; - } - - 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(); + } + uint32_t event_type = EventTypeMap::instance().midi_event_type(buf[0]); + double event_time = time / (double) ppqn(); #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; - } + 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())); + 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 , event_type, name())); #endif - - _model->append (ev, event_id); - if (ev.size() > scratch_size) { - scratch_size = ev.size(); + 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; + + _length_beats = max(_length_beats, event_time); } - - ev.size() = scratch_size; // ensure read_event only allocates if necessary - - _length_beats = max(_length_beats, ev.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 - */ - - have_event_id = false; + eventlist.sort(compare_eventlist); + + 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(false); - _model->set_edited(false); + _model->end_write (Evoral::Sequence::ResolveStuckNotes, _length_beats); + _model->set_edited (false); _model_iter = _model->begin(); @@ -567,9 +628,9 @@ SMFSource::flush_midi () return; } - Evoral::SMF::end_write(); + Evoral::SMF::end_write (); /* data in the file means its no longer removable */ - mark_nonremovable (); + mark_nonremovable (); } void @@ -578,3 +639,70 @@ 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 () +{ + 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 (); + } +} + +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)); +} + +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; +}