Fix stub LV2 persist implementation.
[ardour.git] / libs / ardour / smf_source.cc
index 99d0e8c5e6fa0a33bfd58da23205718d305294cd..7a664b30d6ed3c86bc5da2711a62821e28b4ba9e 100644 (file)
@@ -50,16 +50,18 @@ using namespace Glib;
 using namespace PBD;
 
 /** Constructor used for new internal-to-session files.  File cannot exist. */
-SMFSource::SMFSource (Session& s, const ustring& path, Source::Flag flags)
+SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
        : Source(s, DataType::MIDI, path, flags)
        , MidiSource(s, path)
-       , FileSource(s, DataType::MIDI, path, flags)
+       , FileSource(s, DataType::MIDI, path, string(), flags)
        , Evoral::SMF()
        , _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, false)) {
                throw failed_constructor ();
        }
@@ -105,9 +107,8 @@ SMFSource::~SMFSource ()
 
 /** All stamps in audio frames */
 nframes_t
-SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t source_start,
-                         sframes_t start, nframes_t duration,
-                         sframes_t stamp_offset, sframes_t negative_stamp_offset,
+SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, framepos_t const source_start,
+                         framepos_t start, nframes_t duration,
                          MidiStateTracker* tracker) const
 {
        int      ret  = 0;
@@ -134,7 +135,9 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t s
                DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start));
                Evoral::SMF::seek_to_start();
                while (time < start_ticks) {
-                       ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
+                        gint ignored;
+
+                       ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
                        if (ret == -1) { // EOF
                                _smf_last_read_end = start + duration;
                                return duration;
@@ -149,7 +152,9 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t s
        _smf_last_read_end = start + duration;
 
        while (true) {
-               ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
+                gint ignored; /* XXX don't ignore note id's ??*/
+
+               ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
                if (ret == -1) { // EOF
                        break;
                }
@@ -167,16 +172,14 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t s
                                                                  ev_delta_t, time, ev_buffer[0], ev_type));
 
                assert(time >= start_ticks);
-               const sframes_t ev_frame_time = converter.to(time / (double)ppqn()) + stamp_offset;
 
-#if 1
-               cerr << " frames = " << ev_frame_time
-                    << " w/offset = " << ev_frame_time - negative_stamp_offset
-                    << endl;
-#endif
+               /* 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;
 
                if (ev_frame_time < start + duration) {
-                       destination.write(ev_frame_time - negative_stamp_offset, ev_type, ev_size, ev_buffer);
+                       destination.write (ev_frame_time, ev_type, ev_size, ev_buffer);
 
                        if (tracker) {
                                if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
@@ -200,9 +203,12 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t s
        return duration;
 }
 
-/** All stamps in audio frames */
+/** Write data to this source from a MidiRingBuffer.
+ *  @param source Buffer to read from.
+ *  @param position This source's start position in session frames.
+ */
 nframes_t
-SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position, nframes_t duration)
+SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, framepos_t position, nframes_t duration)
 {
        _write_data_count = 0;
 
@@ -242,11 +248,14 @@ SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position
                        break;
                }
 
+               /* convert from session time to time relative to the source start */
                assert(time >= position);
                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());
+
                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;*/
@@ -256,15 +265,9 @@ SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position
                append_event_unlocked_frames(ev, position);
        }
 
-       if (_model) {
-               set_default_controls_interpolation();
-       }
-
        Evoral::SMF::flush();
        free(buf);
 
-       ViewDataRangeReady(position + _last_write_end, duration); /* EMIT SIGNAL */
-
        return duration;
 }
 
@@ -277,10 +280,10 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
        if (ev.size() == 0)  {
                return;
        }
-
-       /*printf("SMFSource: %s - append_event_unlocked_beats time = %lf, size = %u, data = ",
-                       name().c_str(), 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_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");*/
 
        assert(ev.time() >= 0);
        if (ev.time() < _last_ev_time_beats) {
@@ -288,64 +291,85 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
                return;
        }
 
+        Evoral::event_id_t event_id;
+
+        if (ev.id() < 0) {
+                event_id  = Evoral::next_event_id();
+        } else {
+                event_id = ev.id();
+        }
+
+       if (_model) {
+               _model->append (ev, event_id);
+       }
+
        _length_beats = max(_length_beats, ev.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());
 
-       Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer());
+       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();
 
-       if (_model) {
-               _model->append (ev);
-       }
 }
 
 /** Append an event with a timestamp in frames (nframes_t) */
 void
-SMFSource::append_event_unlocked_frames (const Evoral::Event<nframes_t>& ev, sframes_t position)
+SMFSource::append_event_unlocked_frames (const Evoral::Event<nframes_t>& ev, framepos_t position)
 {
        assert(_writing);
        if (ev.size() == 0)  {
                return;
        }
 
-       /*printf("SMFSource: %s - append_event_unlocked_frames time = %u, size = %u, data = ",
-                       name().c_str(), 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;
                return;
        }
-
+        
        BeatsFramesConverter converter(_session.tempo_map(), position);
+        const double ev_time_beats = converter.from(ev.time());
+        Evoral::event_id_t event_id;
+
+        if (ev.id() < 0) {
+                event_id  = Evoral::next_event_id();
+        } else {
+                event_id = ev.id();
+        }
 
-       _length_beats = max(_length_beats, converter.from(ev.time()));
+       if (_model) {
+               const Evoral::Event<double> beat_ev (ev.event_type(), 
+                                                     ev_time_beats, 
+                                                     ev.size(), 
+                                                     (uint8_t*)ev.buffer());
+               _model->append (beat_ev, event_id);
+       } 
 
-       const sframes_t delta_time_frames = ev.time() - _last_ev_time_frames;
+       _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()));
 
-       Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer());
+       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();
 
-       if (_model) {
-               const double ev_time_beats = converter.from(ev.time());
-               const Evoral::Event<double> beat_ev(
-                               ev.event_type(), ev_time_beats, ev.size(), (uint8_t*)ev.buffer());
-               _model->append (beat_ev);
-       }
 }
 
 XMLNode&
 SMFSource::get_state ()
 {
-       return MidiSource::get_state();
+        XMLNode& node = MidiSource::get_state();
+        node.add_property (X_("origin"), _origin);
+        return node;
 }
 
 int
@@ -367,7 +391,7 @@ SMFSource::set_state (const XMLNode& node, int version)
 }
 
 void
-SMFSource::mark_streaming_midi_write_started (NoteMode mode, sframes_t start_frame)
+SMFSource::mark_streaming_midi_write_started (NoteMode mode, framepos_t start_frame)
 {
        Glib::Mutex::Lock lm (_lock);
        MidiSource::mark_streaming_midi_write_started (mode, start_frame);
@@ -386,14 +410,21 @@ SMFSource::mark_streaming_write_completed ()
                return;
        }
 
-       _model->set_edited(false);
+       if (_model) {
+               _model->set_edited(false);
+       }
+       
        Evoral::SMF::end_write ();
+
+        /* data in the file now, not removable */
+
+        mark_nonremovable (); 
 }
 
 bool
-SMFSource::safe_midi_file_extension (const Glib::ustring& file)
+SMFSource::safe_midi_file_extension (const string& file)
 {
-       return (file.rfind(".mid") != Glib::ustring::npos);
+       return (file.rfind(".mid") != string::npos);
 }
 
 void
@@ -413,10 +444,7 @@ SMFSource::load_model (bool lock, bool force_reload)
 
        if (! _model) {
                _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
-               //cerr << _name << " loaded new model " << _model.get() << endl;
        } else {
-               /*cerr << _name << " reloading model " << _model.get()
-                       << " (" << _model->n_notes() << " notes)" << endl;*/
                _model->clear();
        }
 
@@ -432,13 +460,35 @@ SMFSource::load_model (bool lock, bool force_reload)
        uint32_t size    = 0;
        uint8_t* buf     = NULL;
        int ret;
-       while ((ret = read_event(&delta_t, &size, &buf)) >= 0) {
+        gint event_id;
+        bool have_event_id = false;
+
+       while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
+
                time += delta_t;
-               ev.set(buf, size, time / (double)ppqn());
+                
+                if (ret == 0) {
+
+                        /* meta-event : did we get an event ID ?
+                         */
+
+                        if (event_id >= 0) {
+                                have_event_id = true;
+                        }
 
-               if (ret > 0) { // didn't skip (meta) event
+                        continue;
+                } 
+                        
+               if (ret > 0) { 
+
+                        /* not a meta-event */
+
+                        ev.set (buf, size, time / (double)ppqn());
                        ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
 
+                        if (!have_event_id) {
+                                event_id = Evoral::next_event_id();   
+                        }
 #ifndef NDEBUG
                         std::string ss;
                         
@@ -452,19 +502,23 @@ SMFSource::load_model (bool lock, bool force_reload)
                                                                           delta_t, time, size, ss , ev.event_type(), name()));
 #endif
                         
-                       _model->append (ev);
-               }
+                       _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
+                        if (ev.size() > scratch_size) {
+                                scratch_size = ev.size();
+                        }
+                        
+                        ev.size() = scratch_size; // ensure read_event only allocates if necessary
+                        
+                        _length_beats = max(_length_beats, ev.time());
+                }
 
-               _length_beats = max(_length_beats, ev.time());
+                /* event ID's must immediately precede the event they are for
+                 */
+                   
+                have_event_id = false;
        }
 
-       set_default_controls_interpolation();
-
        _model->end_write(false);
        _model->set_edited(false);
 
@@ -473,18 +527,6 @@ SMFSource::load_model (bool lock, bool force_reload)
        free(buf);
 }
 
-void
-SMFSource::set_default_controls_interpolation ()
-{
-       // set interpolation style to defaults, can be changed by the GUI later
-       Evoral::ControlSet::Controls controls = _model->controls();
-       for (Evoral::ControlSet::Controls::iterator c = controls.begin(); c != controls.end(); ++c) {
-               (*c).second->list()->set_interpolation(
-                       EventTypeMap::instance().interpolation_of((*c).first));
-       }
-}
-
-
 void
 SMFSource::destroy_model ()
 {
@@ -495,6 +537,18 @@ SMFSource::destroy_model ()
 void
 SMFSource::flush_midi ()
 {
+        if (!writable()) {
+                return;
+        }
+
        Evoral::SMF::end_write();
+        /* data in the file means its no longer removable */
+        mark_nonremovable (); 
 }
 
+void
+SMFSource::set_path (const string& p)
+{
+        FileSource::set_path (p);
+        SMF::set_path (_path);
+}