restore ability to create TOC and CUE files during export. this is an option in a...
[ardour.git] / libs / ardour / midi_source.cc
index 5a703f6772e9a564908a36a15204388d4b71ed7c..ad07269b6cec667405966e381d5bd904dfc815c4 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
@@ -55,8 +55,6 @@ PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
 
 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
        : Source(s, DataType::MIDI, name, flags)
-       , _read_data_count(0)
-       , _write_data_count(0)
        , _writing(false)
        , _model_iter_valid(false)
        , _length_beats(0.0)
@@ -67,17 +65,12 @@ MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
 
 MidiSource::MidiSource (Session& s, const XMLNode& node)
        : Source(s, node)
-       , _read_data_count(0)
-       , _write_data_count(0)
        , _writing(false)
        , _model_iter_valid(false)
        , _length_beats(0.0)
        , _last_read_end(0)
        , _last_write_end(0)
 {
-       _read_data_count = 0;
-       _write_data_count = 0;
-
        if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor();
        }
@@ -130,7 +123,7 @@ MidiSource::set_state (const XMLNode& node, int /*version*/)
                                error << _("Missing parameter property on InterpolationStyle") << endmsg;
                                return -1;
                        }
-                       
+
                        Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
 
                        if ((prop = (*i)->property (X_("style"))) == 0) {
@@ -140,16 +133,16 @@ MidiSource::set_state (const XMLNode& node, int /*version*/)
 
                        Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
                        set_interpolation_of (p, s);
-                       
+
                } else if ((*i)->name() == X_("AutomationState")) {
-                       
+
                        XMLProperty* prop;
 
                        if ((prop = (*i)->property (X_("parameter"))) == 0) {
                                error << _("Missing parameter property on AutomationState") << endmsg;
                                return -1;
                        }
-                       
+
                        Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
 
                        if ((prop = (*i)->property (X_("state"))) == 0) {
@@ -168,15 +161,15 @@ MidiSource::set_state (const XMLNode& node, int /*version*/)
 bool
 MidiSource::empty () const
 {
-        return _length_beats == 0;
+       return _length_beats == 0;
 }
 
 framecnt_t
 MidiSource::length (framepos_t pos) const
 {
-        if (_length_beats == 0) {
-                return 0;
-        }
+       if (_length_beats == 0) {
+               return 0;
+       }
 
        BeatsFramesConverter converter(_session.tempo_map(), pos);
        return converter.to(_length_beats);
@@ -196,16 +189,19 @@ MidiSource::invalidate ()
 }
 
 /** @param filtered A set of parameters whose MIDI messages will not be returned */
-nframes_t
-MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, framepos_t source_start,
-                       framepos_t start, nframes_t cnt,
+framecnt_t
+MidiSource::midi_read (Evoral::EventSink<framepos_t>& dst, framepos_t source_start,
+                       framepos_t start, framecnt_t cnt,
                        MidiStateTracker* tracker,
-                      std::set<Evoral::Parameter> const & filtered) const
+                       std::set<Evoral::Parameter> const & filtered) const
 {
        Glib::Mutex::Lock lm (_lock);
 
        BeatsFramesConverter converter(_session.tempo_map(), source_start);
 
+       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("MidiSource::midi-read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
+                                                         source_start, start, cnt, tracker, name()));
+
        if (_model) {
                Evoral::Sequence<double>::const_iterator& i = _model_iter;
 
@@ -214,12 +210,13 @@ MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, framepos_t source_star
                        DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
                        for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
                                if (converter.to(i->time()) >= start) {
+                                       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("***\tstop iterator search @ %1\n", i->time()));
                                        break;
                                }
                        }
                        _model_iter_valid = true;
                } else {
-                       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cached iterator for %1 / %2\n", _name, source_start, start));
+                       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cachediterator for %1 / %2\n", _name, source_start, start));
                }
 
                _last_read_end = start + cnt;
@@ -231,17 +228,22 @@ MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, framepos_t source_star
                                /* convert event times to session frames by adding on the source start position in session frames */
                                dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
 
+                                DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: add event @ %2 type %3 size = %4\n",
+                                                                                  _name, time_frames + source_start, i->event_type(), i->size()));
+
                                if (tracker) {
                                        Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
                                        if (ev.is_note_on()) {
-                                               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note on %2 @ %3 velocity %4\n", _name, ev.note(), time_frames, (int) ev.velocity()));
+                                               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note on %2 @ %3 velocity %4\n", _name, (int) ev.note(), time_frames, (int) ev.velocity()));
                                                tracker->add (ev.note(), ev.channel());
                                        } else if (ev.is_note_off()) {
-                                               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 add note off %2 @ %3\n", _name, ev.note(), time_frames));
+                                               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note off %2 @ %3\n", _name, (int) ev.note(), time_frames));
                                                tracker->remove (ev.note(), ev.channel());
                                        }
                                }
                        } else {
+                                DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: reached end with event @ %2 vs. %3\n",
+                                                                                  _name, time_frames, start+cnt));
                                break;
                        }
                }
@@ -255,129 +257,157 @@ MidiSource::midi_read (Evoral::EventSink<nframes_t>& dst, framepos_t source_star
  *  @param source Source to read from.
  *  @param source_start This source's start position in session frames.
  */
-nframes_t
-MidiSource::midi_write (MidiRingBuffer<nframes_t>& source, framepos_t source_start, nframes_t duration)
+framecnt_t
+MidiSource::midi_write (MidiRingBuffer<framepos_t>& source, framepos_t source_start, framecnt_t duration)
 {
        Glib::Mutex::Lock lm (_lock);
-       const nframes_t ret = write_unlocked (source, source_start, duration);
-       _last_write_end += duration;
+
+       const framecnt_t ret = write_unlocked (source, source_start, duration);
+
+       if (duration == max_framecnt) {
+               _last_read_end = 0;
+       } else {
+               _last_write_end += duration;
+       }
+
        return ret;
 }
 
 void
-MidiSource::mark_streaming_midi_write_started (NoteMode mode, framepos_t start_frame)
+MidiSource::mark_streaming_midi_write_started (NoteMode mode)
 {
-       set_timeline_position(start_frame);
-
        if (_model) {
-               _model->set_note_mode(mode);
-               _model->start_write();
+               _model->set_note_mode (mode);
+               _model->start_write ();
        }
 
-       _last_write_end = start_frame;
        _writing = true;
 }
 
+void
+MidiSource::mark_write_starting_now ()
+{
+       /* I'm not sure if this is the best way to approach this, but
+          _last_write_end needs to be set up with the transport frame
+          when a record actually starts, as it is used by
+          SMFSource::write_unlocked to decide whether incoming notes
+          are within the correct time range.
+          mark_streaming_midi_write_started (perhaps a more logical
+          place to do this) is not called at exactly the time when
+          record starts, and I don't think it necessarily can be
+          because it is not RT-safe.
+       */
+
+       set_timeline_position (_session.transport_frame ());
+       _last_write_end = _session.transport_frame ();
+       cerr << name() << " last write set to " << _last_write_end << endl;
+
+}
+
 void
 MidiSource::mark_streaming_write_started ()
 {
        NoteMode note_mode = _model ? _model->note_mode() : Sustained;
-       mark_streaming_midi_write_started(note_mode, _session.transport_frame());
+       mark_streaming_midi_write_started (note_mode);
 }
 
 void
-MidiSource::mark_streaming_write_completed ()
+MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option, Evoral::MusicalTime end)
 {
        if (_model) {
-               _model->end_write(false);
+               _model->end_write (option, end);
        }
 
        _writing = false;
 }
 
+void
+MidiSource::mark_streaming_write_completed ()
+{
+       mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
+}
+
 boost::shared_ptr<MidiSource>
 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
 {
-        string newname = PBD::basename_nosuffix(_name.val());
-        string newpath;
+       string newname = PBD::basename_nosuffix(_name.val());
+       string newpath;
+
+       /* get a new name for the MIDI file we're going to write to
+        */
 
-        /* get a new name for the MIDI file we're going to write to
-         */
+       do {
 
-        do { 
+               newname = bump_name_once (newname, '-');
+               /* XXX build path safely */
+               newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
 
-                newname = bump_name_once (newname, '-');
-                /* XXX build path safely */
-                newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
+       } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
 
-        } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
-        
-        boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
-                SourceFactory::createWritable(DataType::MIDI, _session,
-                                              newpath, string(), false, _session.frame_rate()));
+       boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
+               SourceFactory::createWritable(DataType::MIDI, _session,
+                                             newpath, string(), false, _session.frame_rate()));
 
-        newsrc->set_timeline_position(_timeline_position);
+       newsrc->set_timeline_position(_timeline_position);
        newsrc->copy_interpolation_from (this);
        newsrc->copy_automation_state_from (this);
 
-        if (_model) {
-                if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
-                        _model->write_to (newsrc);
-                } else {
-                        _model->write_section_to (newsrc, begin, end);
-                }
-        } else {
-                error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
-                return boost::shared_ptr<MidiSource>();
-        }
-
-        newsrc->flush_midi();
-
-        /* force a reload of the model if the range is partial */
-        
-        if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
-                newsrc->load_model (true, true);
-        } else {
+       if (_model) {
+               if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
+                       _model->write_to (newsrc);
+               } else {
+                       _model->write_section_to (newsrc, begin, end);
+               }
+       } else {
+               error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
+               return boost::shared_ptr<MidiSource>();
+       }
+
+       newsrc->flush_midi();
+
+       /* force a reload of the model if the range is partial */
+
+       if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
+               newsrc->load_model (true, true);
+       } else {
                newsrc->set_model (_model);
        }
-        
-        return newsrc;
+
+       return newsrc;
 }
 
 void
 MidiSource::session_saved()
 {
-        /* this writes a copy of the data to disk. 
-           XXX do we need to do this every time?
-        */
+       /* this writes a copy of the data to disk.
+          XXX do we need to do this every time?
+       */
 
        if (_model && _model->edited()) {
 
+               // if the model is edited, write its contents into
+               // the current source file (overwiting previous contents.
 
+               /* temporarily drop our reference to the model so that
+                  as the model pushes its current state to us, we don't
+                  try to update it.
+               */
 
-                // if the model is edited, write its contents into
-                // the current source file (overwiting previous contents.
-
-                /* temporarily drop our reference to the model so that
-                   as the model pushes its current state to us, we don't
-                   try to update it.
-                */
-
-                boost::shared_ptr<MidiModel> mm = _model ;
-                _model.reset ();   
+               boost::shared_ptr<MidiModel> mm = _model;
+               _model.reset ();
 
-                /* flush model contents to disk
-                 */
+               /* flush model contents to disk
+                */
 
-                mm->sync_to_source ();
+               mm->sync_to_source ();
 
-                /* reacquire model */
+               /* reacquire model */
 
-                _model = mm;
+               _model = mm;
 
-        } else {
-                flush_midi();
-        }
+       } else {
+               flush_midi();
+       }
 }
 
 void
@@ -391,7 +421,7 @@ MidiSource::set_note_mode(NoteMode mode)
 void
 MidiSource::drop_model ()
 {
-        _model.reset(); 
+       _model.reset();
        ModelChanged (); /* EMIT SIGNAL */
 }
 
@@ -438,7 +468,7 @@ MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::Inte
        if (interpolation_of (p) == s) {
                return;
        }
-       
+
        if (EventTypeMap::instance().interpolation_of (p) == s) {
                /* interpolation type is being set to the default, so we don't need a note in our map */
                _interpolation_style.erase (p);
@@ -455,7 +485,7 @@ MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
        if (automation_state_of (p) == s) {
                return;
        }
-       
+
        if (s == Play) {
                /* automation state is being set to the default, so we don't need a note in our map */
                _automation_state.erase (p);