fix merge conflict with master
[ardour.git] / libs / ardour / smf_source.cc
index 1fd058dbd84347be1d9dfe165afb646b80de098a..dfaa51481d352a4e1fb32b407a76260640fd3d32 100644 (file)
 #include <sys/stat.h>
 #include <unistd.h>
 #include <errno.h>
+#include <regex.h>
 
-#include "pbd/mountpoint.h"
 #include "pbd/pathscanner.h"
 #include "pbd/stl_delete.h"
 #include "pbd/strsplit.h"
 
+#include <glib/gstdio.h>
 #include <glibmm/miscutils.h>
 
 #include "evoral/Control.hpp"
@@ -65,7 +66,16 @@ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
                throw failed_constructor ();
        }
 
-        /* file is not opened until write */
+       /* 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. */
@@ -90,13 +100,13 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
                throw failed_constructor ();
        }
 
-        _open = true;
+       _open = true;
 }
 
 SMFSource::~SMFSource ()
 {
        if (removable()) {
-               unlink (_path.c_str());
+               ::g_unlink (_path.c_str());
        }
 }
 
@@ -104,25 +114,27 @@ 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<framepos_t>& destination, framepos_t const source_start,
-                         framepos_t start, framecnt_t duration,
-                         MidiStateTracker* tracker) const
+SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& 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));
 
@@ -209,16 +221,14 @@ SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& 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<framepos_t>& source, framepos_t position, framecnt_t duration)
+SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source,
+                           framepos_t                  position,
+                           framecnt_t                  cnt)
 {
-        if (!_writing) {
-                mark_streaming_write_started ();
-        }
+       if (!_writing) {
+               mark_streaming_write_started ();
+       }
 
        framepos_t        time;
        Evoral::EventType type;
@@ -227,74 +237,74 @@ SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& 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<framepos_t> ev;
-
-       // cerr << "SMFSource::write unlocked, begins writing from src buffer with _last_write_end = " << _last_write_end << " dur = " << duration << endl;
-
        while (true) {
+               /* Get the event time, in frames since session start but ignoring looping. */
                bool ret;
-
                if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) {
-                       /* no more events to consider */
+                       /* Ring is empty, no more events. */
                        break;
                }
 
-               if ((duration != max_framecnt) && (time > (_last_write_end + duration))) {
-                       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("SMFSource::write_unlocked: dropping event @ %1 because it is later than %2 + %3\n",
-                                                                   time, _last_write_end, duration));
+               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 buffer") << endmsg;
+                       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) {
-                       error << _("Read time/size but not buffer, corrupt MIDI ring buffer") << endmsg;
+                       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();
+       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<double>& ev)
 {
-       assert(_writing);
-       if (ev.size() == 0)  {
+       if (!_writing || ev.size() == 0)  {
                return;
        }
 
@@ -302,9 +312,9 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
                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");*/
 
-       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;
        }
 
@@ -333,18 +343,17 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
 void
 SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, framepos_t position)
 {
-       assert(_writing);
-       if (ev.size() == 0)  {
-               cerr << "SMFSource: asked to append zero-size event\n";
+       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;
        }
 
@@ -362,7 +371,7 @@ SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, fr
                const Evoral::Event<double> beat_ev (ev.event_type(),
                                                     ev_time_beats,
                                                     ev.size(),
-                                                    (uint8_t*)ev.buffer());
+                                                    const_cast<uint8_t*>(ev.buffer()));
                _model->append (beat_ev, event_id);
        }
 
@@ -405,13 +414,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 ();
@@ -428,10 +437,11 @@ SMFSource::mark_streaming_write_completed ()
 void
 SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_notes_option, Evoral::MusicalTime when)
 {
-       Glib::Mutex::Lock lm (_lock);
+       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;
        }
 
@@ -449,7 +459,28 @@ SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::Musical
 bool
 SMFSource::safe_midi_file_extension (const string& file)
 {
-       return (file.rfind(".mid") != string::npos) || (file.rfind (".MID") != string::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;
+}
+
+static bool compare_eventlist (
+               const std::pair< Evoral::Event<double>*, gint >& a,
+               const std::pair< Evoral::Event<double>*, gint >& b) {
+       return ( a.first->time() < b.first->time() );
 }
 
 void
@@ -459,9 +490,9 @@ SMFSource::load_model (bool lock, bool force_reload)
                return;
        }
 
-       boost::shared_ptr<Glib::Mutex::Lock> lm;
+       boost::shared_ptr<Glib::Threads::Mutex::Lock> lm;
        if (lock)
-               lm = boost::shared_ptr<Glib::Mutex::Lock>(new Glib::Mutex::Lock(_lock));
+               lm = boost::shared_ptr<Glib::Threads::Mutex::Lock>(new Glib::Threads::Mutex::Lock(_lock));
 
        if (_model && !force_reload) {
                return;
@@ -473,9 +504,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();
@@ -490,60 +521,74 @@ SMFSource::load_model (bool lock, bool force_reload)
        uint8_t* buf     = NULL;
        int ret;
        gint event_id;
-       bool have_event_id = false;
-
-       while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
+       bool have_event_id;
 
-               time += delta_t;
+       // TODO simplify event allocation
+       std::list< std::pair< Evoral::Event<double>*, gint > > eventlist;
 
-               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;
-               }
+                       time += delta_t;
 
-               if (ret > 0) {
-
-                       /* 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;
+                               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 %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);
+                               eventlist.push_back(make_pair (
+                                                       new Evoral::Event<double> (
+                                                               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, event_time);
+                       }
 
-                       _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
-                */
+       eventlist.sort(compare_eventlist);
 
-               have_event_id = false;
+       std::list< std::pair< Evoral::Event<double>*, 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<Evoral::MusicalTime>::ResolveStuckNotes, _length_beats);