initial pass at session-renaming functionality
[ardour.git] / libs / ardour / smf_source.cc
index f8a2d10e976208cafab98f6c63ad3abe3e3e19c6..9078a17608aaad0c2a7eebb002a2dd66cdf37e0a 100644 (file)
@@ -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
@@ -50,25 +50,23 @@ 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)
+       , MidiSource(s, 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)
 {
-       if (init(_path, false)) {
-               throw failed_constructor ();
-       }
+       /* note that origin remains empty */
 
-       if (create(path)) {
+       if (init(_path, false)) {
                throw failed_constructor ();
        }
 
-       load_model(true, true); // FIXME
+        /* file is not opened until write */
 }
 
 /** Constructor used for existing internal-to-session files. */
@@ -93,7 +91,7 @@ SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
                throw failed_constructor ();
        }
 
-       load_model(true, true); // FIXME
+        _open = true;
 }
 
 SMFSource::~SMFSource ()
@@ -103,16 +101,30 @@ SMFSource::~SMFSource ()
        }
 }
 
+int
+SMFSource::open_for_write ()
+{
+       if (create (_path)) {
+                return -1;
+        }
+        _open = true;
+        return 0;
+}
+
 /** 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,
+framecnt_t
+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;
+        }
+
        DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration));
 
        _read_data_count = 0;
@@ -134,7 +146,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 +163,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 +183,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 0
-               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,13 +214,20 @@ SMFSource::read_unlocked (Evoral::EventSink<nframes_t>& destination, sframes_t s
        return duration;
 }
 
-/** All stamps in audio frames */
-nframes_t
-SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position, nframes_t 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)
 {
+        if (!_writing) {
+                mark_streaming_write_started ();
+        }
+
        _write_data_count = 0;
 
-       nframes_t         time;
+       framepos_t        time;
        Evoral::EventType type;
        uint32_t          size;
 
@@ -217,11 +238,15 @@ SMFSource::write_unlocked (MidiRingBuffer<nframes_t>& source, sframes_t position
                _model->start_write();
        }
 
-       Evoral::MIDIEvent<nframes_t> ev;
+       Evoral::MIDIEvent<framepos_t> ev;
+
+       cerr << "SMFSource::write unlocked, begins writing from src buffer\n";
 
        while (true) {
-               bool ret = source.peek_time(&time);
+               bool ret = source.peek ((uint8_t*)&time, sizeof (time));
                if (!ret || time > _last_write_end + duration) {
+                       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("SMFSource::write_unlocked: dropping event @ %1 because ret %4 or it is later than %2 + %3\n",
+                                                                   time, _last_write_end, duration, ret));
                        break;
                }
 
@@ -242,24 +267,26 @@ 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;*/
                        continue;
                }
 
+               cerr << "SMFSource:: calling append_event_unlocked_frames()\n";
                append_event_unlocked_frames(ev, position);
        }
 
        Evoral::SMF::flush();
-       free(buf);
-
-       ViewDataRangeReady(position + _last_write_end, duration); /* EMIT SIGNAL */
+       free (buf);
 
        return duration;
 }
@@ -274,9 +301,9 @@ SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
                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) {
@@ -284,33 +311,43 @@ 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) */
+/** Append an event with a timestamp in frames (framepos_t) */
 void
-SMFSource::append_event_unlocked_frames (const Evoral::Event<nframes_t>& ev, sframes_t position)
+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";
                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;
@@ -318,30 +355,42 @@ SMFSource::append_event_unlocked_frames (const Evoral::Event<nframes_t>& ev, sfr
        }
 
        BeatsFramesConverter converter(_session.tempo_map(), position);
+       const double ev_time_beats = converter.from(ev.time());
+       Evoral::event_id_t event_id;
 
-       _length_beats = max(_length_beats, converter.from(ev.time()));
+       if (ev.id() < 0) {
+               event_id  = Evoral::next_event_id();
+       } else {
+               event_id = ev.id();
+       }
 
-       const sframes_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()));
+       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);
+       }
+
+       _length_beats = max(_length_beats, ev_time_beats);
 
-       Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer());
+       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(), 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
@@ -363,10 +412,17 @@ 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)
 {
-       Glib::Mutex::Lock lm (_lock);
-       MidiSource::mark_streaming_midi_write_started (mode, start_frame);
+        /* 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);
        Evoral::SMF::begin_write ();
        _last_ev_time_beats = 0.0;
        _last_ev_time_frames = 0;
@@ -385,18 +441,18 @@ SMFSource::mark_streaming_write_completed ()
        if (_model) {
                _model->set_edited(false);
        }
-       
+
        Evoral::SMF::end_write ();
 
-        /* data in the file now, not removable */
+       /* data in the file now, not removable */
 
-        mark_nonremovable (); 
+       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) || (file.rfind (".MID") != string::npos);
 }
 
 void
@@ -414,15 +470,16 @@ SMFSource::load_model (bool lock, bool force_reload)
                return;
        }
 
-       if (! _model) {
-               _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
-               //cerr << _name << " loaded new model " << _model.get() << endl;
+       if (!_model) {
+               _model = boost::shared_ptr<MidiModel> (new MidiModel (shared_from_this ()));
        } else {
-               /*cerr << _name << " reloading model " << _model.get()
-                       << " (" << _model->n_notes() << " notes)" << endl;*/
                _model->clear();
        }
 
+        if (writable() && !_open) {
+                return;
+        }
+
        _model->start_write();
        Evoral::SMF::seek_to_start();
 
@@ -435,39 +492,68 @@ 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) { // didn't skip (meta) event
+               if (ret == 0) {
+
+                       /* meta-event : did we get an event ID ?
+                        */
+
+                       if (event_id >= 0) {
+                               have_event_id = true;
+                       }
+
+                       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;
-                        
-                        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()));
+                       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()));
 #endif
-                        
-                       _model->append (ev);
-               }
 
-               if (ev.size() > scratch_size) {
-                       scratch_size = ev.size();
+                       _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
+
+                       _length_beats = max(_length_beats, ev.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;
        }
 
-       _model->end_write(false);
-       _model->set_edited(false);
+       _model->end_write (_length_beats, false, true);
+       //_model->end_write (false);
+       _model->set_edited (false);
 
        _model_iter = _model->begin();
 
@@ -484,18 +570,44 @@ SMFSource::destroy_model ()
 void
 SMFSource::flush_midi ()
 {
-        if (!writable()) {
-                return;
-        }
+       if (!writable() || (writable() && !_open)) {
+               return;
+       }
 
-       Evoral::SMF::end_write();
-        /* data in the file means its no longer removable */
-        mark_nonremovable (); 
+       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);
+       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<MidiModel> 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 ();
+       }
+}
+