add copyright comments
[ardour.git] / libs / ardour / smf_source.cc
index 2a02e50da799ffaccb5548680cd823933457c5d5..626676ea83286a479738628e8813e8b727f0c0fe 100644 (file)
@@ -24,8 +24,8 @@
 #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"
@@ -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"
@@ -65,7 +64,7 @@ SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
        if (init(_path, false)) {
                throw failed_constructor ();
        }
-        
+
         /* file is not opened until write */
 }
 
@@ -106,7 +105,7 @@ SMFSource::open_for_write ()
 {
        if (create (_path)) {
                 return -1;
-        } 
+        }
         _open = true;
         return 0;
 }
@@ -127,8 +126,6 @@ SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination, framepos_t
 
        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 +200,6 @@ SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination, framepos_t
                        break;
                }
 
-               _read_data_count += ev_size;
-
                if (ev_size > scratch_size) {
                        scratch_size = ev_size;
                }
@@ -225,8 +220,6 @@ SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t positi
                 mark_streaming_write_started ();
         }
 
-       _write_data_count = 0;
-
        framepos_t        time;
        Evoral::EventType type;
        uint32_t          size;
@@ -240,15 +233,24 @@ SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t positi
 
        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) {
-               bool ret = source.peek ((uint8_t*)&time, sizeof (time));
-               if (!ret || time > _last_write_end + duration) {
+               bool ret;
+
+               if (!(ret = source.peek ((uint8_t*)&time, sizeof (time)))) {
+                       /* no more events to consider */
                        break;
                }
 
-               ret = source.read_prefix(&time, &type, &size);
-               if (!ret) {
-                       cerr << "ERROR: Unable to read event prefix, corrupt MIDI ring buffer" << endl;
+               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));
+                       break;
+               }
+
+               if (!(ret = source.read_prefix (&time, &type, &size))) {
+                       error << _("Unable to read event prefix, corrupt MIDI ring buffer") << endmsg;
                        break;
                }
 
@@ -259,7 +261,7 @@ SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t positi
 
                ret = source.read_contents(size, buf);
                if (!ret) {
-                       cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
+                       error << _("Read time/size but not buffer, corrupt MIDI ring buffer") << endmsg;
                        break;
                }
 
@@ -280,8 +282,8 @@ SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t positi
                append_event_unlocked_frames(ev, position);
        }
 
-       Evoral::SMF::flush();
-       free(buf);
+       Evoral::SMF::flush ();
+       free (buf);
 
        return duration;
 }
@@ -295,10 +297,10 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
        if (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) {
@@ -325,9 +327,6 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& 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) */
@@ -336,12 +335,13 @@ SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, fr
 {
        assert(_writing);
        if (ev.size() == 0)  {
+               cerr << "SMFSource: asked to append zero-size event\n";
                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;
@@ -359,24 +359,21 @@ SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, fr
        }
 
        if (_model) {
-               const Evoral::Event<double> beat_ev (ev.event_type(), 
-                                                    ev_time_beats, 
-                                                    ev.size(), 
-                                                    (uint8_t*)ev.buffer());
+               const Evoral::Event<double> beat_ev (ev.event_type(),
+                                                    ev_time_beats,
+                                                    ev.size(),
+                                                    const_cast<uint8_t*>(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&
@@ -413,7 +410,7 @@ SMFSource::mark_streaming_midi_write_started (NoteMode mode)
         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; 
+                return;
         }
 
        MidiSource::mark_streaming_midi_write_started (mode);
@@ -425,28 +422,50 @@ 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<Evoral::MusicalTime>::DeleteStuckNotes);
+}
+
+void
+SMFSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::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 (compile && regcomp (&compiled_pattern, "[mM][iI][dD]$", REG_EXTENDED)) {
+               return false;
+       } else {
+               compile = false;
+       }
+       
+       if (regexec (&compiled_pattern, file.c_str(), nmatches, matches, 0)) {
+               return false;
+       }
+
+       return true;
 }
 
 void
@@ -456,9 +475,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;
@@ -480,7 +499,7 @@ SMFSource::load_model (bool lock, bool force_reload)
        uint64_t time = 0; /* in SMF ticks */
        Evoral::Event<double> 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;
@@ -492,7 +511,7 @@ SMFSource::load_model (bool lock, bool force_reload)
        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 ?
@@ -503,9 +522,9 @@ SMFSource::load_model (bool lock, bool force_reload)
                        }
 
                        continue;
-               } 
-                        
-               if (ret > 0) { 
+               }
+
+               if (ret > 0) {
 
                        /* not a meta-event */
 
@@ -513,11 +532,11 @@ SMFSource::load_model (bool lock, bool force_reload)
                        ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
 
                        if (!have_event_id) {
-                               event_id = Evoral::next_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]);
@@ -527,26 +546,24 @@ SMFSource::load_model (bool lock, bool force_reload)
                        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
-                        
+                       // 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());
                }
 
                /* 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<Evoral::MusicalTime>::ResolveStuckNotes, _length_beats);
+       _model->set_edited (false);
 
        _model_iter = _model->begin();
 
@@ -567,9 +584,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