Properly create new presets, i.e. without duplicate id's on save-after-rename
[ardour.git] / libs / ardour / midi_region.cc
index f166dafda8a3f19c0ef165c4048dcd5dfc07decd..f4058377b6c22af2877950d3da9083ab57a8a845 100644 (file)
@@ -24,7 +24,6 @@
 
 #include <set>
 
-
 #include <glibmm/thread.h>
 
 #include "pbd/basename.h"
@@ -37,6 +36,7 @@
 #include "ardour/dB.h"
 #include "ardour/playlist.h"
 #include "ardour/midi_source.h"
+#include "ardour/region_factory.h"
 #include "ardour/types.h"
 #include "ardour/midi_ring_buffer.h"
 
@@ -47,90 +47,152 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-/** Basic MidiRegion constructor (one channel) */
-MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src)
-       : Region (src)
+namespace ARDOUR {
+       namespace Properties {
+               PBD::PropertyDescriptor<void*>                midi_data;
+               PBD::PropertyDescriptor<Evoral::MusicalTime>  length_beats;
+       }
+}
+
+void
+MidiRegion::make_property_quarks ()
+{
+       Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
+       Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
+}
+
+void
+MidiRegion::register_properties ()
 {
-       assert(_name.val().find("/") == string::npos);
-       midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
+       add_property (_length_beats);
 }
 
 /* Basic MidiRegion constructor (many channels) */
 MidiRegion::MidiRegion (const SourceList& srcs)
        : Region (srcs)
+       , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
 {
+       register_properties ();
+
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
        assert(_name.val().find("/") == string::npos);
-       midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
+       assert(_type == DataType::MIDI);
 }
 
+MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
+       : Region (other)
+       , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
+{
+       update_length_beats ();
+       register_properties ();
+
+       assert(_name.val().find("/") == string::npos);
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
+}
 
 /** Create a new MidiRegion, that is part of an existing one */
-MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, bool offset_relative)
-       : Region (other, offset, offset_relative)
+MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset)
+       : Region (other, offset)
+       , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
 {
+       BeatsFramesConverter bfc (_session.tempo_map(), _position);
+       Evoral::MusicalTime const offset_beats = bfc.from (offset);
+
+       _length_beats = other->_length_beats - offset_beats;
+
+       register_properties ();
+
        assert(_name.val().find("/") == string::npos);
-       midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
 }
 
-MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, const XMLNode& node)
-       : Region (src, node)
+MidiRegion::~MidiRegion ()
 {
-       if (set_state (node, Stateful::loading_state_version)) {
-               throw failed_constructor();
-       }
+}
 
-       midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
-       assert(_name.val().find("/") == string::npos);
-       assert(_type == DataType::MIDI);
+/** Create a new MidiRegion that has its own version of some/all of the Source used by another. 
+ */
+boost::shared_ptr<MidiRegion>
+MidiRegion::clone ()
+{
+       BeatsFramesConverter bfc (_session.tempo_map(), _position);
+       Evoral::MusicalTime const bbegin = bfc.from (_start);
+       Evoral::MusicalTime const bend = bfc.from (_start + _length);
+
+       boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
+
+       PropertyList plist;
+
+       plist.add (Properties::name, ms->name());
+       plist.add (Properties::whole_file, true);
+       plist.add (Properties::start, _start);
+       plist.add (Properties::length, _length);
+       plist.add (Properties::length_beats, _length_beats);
+       plist.add (Properties::layer, 0);
+
+       return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
 }
 
-MidiRegion::MidiRegion (const SourceList& srcs, const XMLNode& node)
-       : Region (srcs, node)
+void
+MidiRegion::post_set (const PropertyChange& pc)
 {
-       if (set_state (node, Stateful::loading_state_version)) {
-               throw failed_constructor();
+       if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
+               update_length_beats ();
        }
+}
 
-       midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
-       assert(_name.val().find("/") == string::npos);
-       assert(_type == DataType::MIDI);
+void
+MidiRegion::set_length_internal (framecnt_t len)
+{
+       Region::set_length_internal (len);
+       update_length_beats ();
 }
 
-MidiRegion::~MidiRegion ()
+void
+MidiRegion::update_length_beats ()
 {
+       BeatsFramesConverter converter (_session.tempo_map(), _position);
+       _length_beats = converter.from (_length);
 }
 
 void
 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 {
-       BeatsFramesConverter old_converter(_session.tempo_map(), _position - _start);
-       double length_beats = old_converter.from(_length);
-
-       Region::set_position_internal(pos, allow_bbt_recompute);
-
-       BeatsFramesConverter new_converter(_session.tempo_map(), pos - _start);
-
-       set_length(new_converter.to(length_beats), 0);
+       Region::set_position_internal (pos, allow_bbt_recompute);
+       /* zero length regions don't exist - so if _length_beats is zero, this object
+          is under construction.
+       */
+       if (_length_beats) {
+               /* leave _length_beats alone, and change _length to reflect the state of things
+                  at the new position (tempo map may dictate a different number of frames
+               */
+               BeatsFramesConverter converter (_session.tempo_map(), _position);
+               Region::set_length_internal (converter.to (_length_beats));
+       }
 }
 
 framecnt_t
-MidiRegion::read_at (Evoral::EventSink<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
+MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 {
        return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 }
 
 framecnt_t
-MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
+MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 {
        return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 }
 
 framecnt_t
-MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n, 
+MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n, 
                      NoteMode mode, MidiStateTracker* tracker) const
 {
        frameoffset_t internal_offset = 0;
-       frameoffset_t src_offset      = 0;
        framecnt_t to_read         = 0;
 
        /* precondition: caller has verified that we cover the desired section */
@@ -142,12 +204,12 @@ MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>&
        }
 
        if (position < _position) {
+               /* we are starting the read from before the start of the region */
                internal_offset = 0;
-               src_offset = _position - position;
-               dur -= src_offset;
+               dur -= _position - position;
        } else {
+               /* we are starting the read from after the start of the region */
                internal_offset = position - _position;
-               src_offset = 0;
        }
 
        if (internal_offset >= _length) {
@@ -162,34 +224,24 @@ MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>&
 
        boost::shared_ptr<MidiSource> src = midi_source(chan_n);
        src->set_note_mode(mode);
+        
+       /*
+         cerr << "MR read @ " << position << " * " << to_read
+         << " _position = " << _position
+         << " _start = " << _start
+         << " intoffset = " << internal_offset
+         << endl;
+       */
 
-       framepos_t output_buffer_position = 0;
-       framepos_t negative_output_buffer_position = 0;
-       if (_position >= _start) {
-               // handle resizing of beginnings of regions correctly
-               output_buffer_position = _position - _start;
-       } else {
-               // when _start is greater than _position, we have to subtract
-               // _start from the note times in the midi source
-               negative_output_buffer_position = _start;
-       }
-
-       /*cerr << "MR read @ " << position << " * " << to_read
-               << " _position = " << _position
-           << " _start = " << _start
-           << " offset = " << output_buffer_position
-           << " negoffset = " << negative_output_buffer_position
-           << " intoffset = " << internal_offset
-           << endl;*/
+       /* This call reads events from a source and writes them to `dst' timed in session frames */
 
        if (src->midi_read (
                        dst, // destination buffer
-                       _position - _start, // start position of the source in this read context
+                       _position - _start, // start position of the source in session frames
                        _start + internal_offset, // where to start reading in the source
                        to_read, // read duration in frames
-                       output_buffer_position, // the offset in the output buffer
-                       negative_output_buffer_position, // amount to substract from note times
-                       tracker
+                       tracker,
+                       _filtered_parameters
                    ) != to_read) {
                return 0; /* "read nothing" */
        }
@@ -200,46 +252,28 @@ MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>&
 }
 
 XMLNode&
-MidiRegion::state (bool full)
+MidiRegion::state ()
 {
-       XMLNode& node (Region::state (full));
-       char buf[64];
-       char buf2[64];
-       LocaleGuard lg (X_("POSIX"));
-
-       // XXX these should move into Region
-
-       for (uint32_t n=0; n < _sources.size(); ++n) {
-               snprintf (buf2, sizeof(buf2), "source-%d", n);
-               _sources[n]->id().print (buf, sizeof(buf));
-               node.add_property (buf2, buf);
-       }
-
-       for (uint32_t n=0; n < _master_sources.size(); ++n) {
-               snprintf (buf2, sizeof(buf2), "master-source-%d", n);
-               _master_sources[n]->id().print (buf, sizeof (buf));
-               node.add_property (buf2, buf);
-       }
-
-       if (full && _extra_xml) {
-               node.add_child_copy (*_extra_xml);
-       }
-
-       return node;
+       return Region::state ();
 }
 
 int
 MidiRegion::set_state (const XMLNode& node, int version)
 {
-       return Region::set_state (node, version);
+       int ret = Region::set_state (node, version);
+
+       if (ret == 0) {
+               update_length_beats ();
+       }
+
+       return ret;
 }
 
 void
 MidiRegion::recompute_at_end ()
 {
        /* our length has changed
-        * (non destructively) "chop" notes that pass the end boundary, to
-        * prevent stuck notes.
+        * so what? stuck notes are dealt with via a note state tracker
         */
 }
 
@@ -275,18 +309,72 @@ MidiRegion::midi_source (uint32_t n) const
        return boost::dynamic_pointer_cast<MidiSource>(source(n));
 }
 
-
 void
-MidiRegion::switch_source(boost::shared_ptr<Source> src)
+MidiRegion::model_changed ()
 {
-       boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
-       if (!msrc)
+       if (!model()) {
                return;
+       }
+       
+       /* build list of filtered Parameters, being those whose automation state is not `Play' */
+
+       _filtered_parameters.clear ();
 
-       // MIDI regions have only one source
-       _sources.clear();
-       _sources.push_back(msrc);
+       Automatable::Controls const & c = model()->controls();
 
-       set_name(msrc->name());
+       for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
+               boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
+               assert (ac);
+               if (ac->alist()->automation_state() != Play) {
+                       _filtered_parameters.insert (ac->parameter ());
+               }
+       }
+
+       /* watch for changes to controls' AutoState */
+       midi_source()->AutomationStateChanged.connect_same_thread (
+               _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
+               );
+
+       model()->ContentsChanged.connect_same_thread (
+               _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
+}
+
+void
+MidiRegion::model_contents_changed ()
+{
+       send_change (PropertyChange (Properties::midi_data));        
 }
 
+void
+MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
+{
+       /* Update our filtered parameters list after a change to a parameter's AutoState */
+       
+       boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
+       assert (ac);
+
+       if (ac->alist()->automation_state() == Play) {
+               _filtered_parameters.erase (p);
+       } else {
+               _filtered_parameters.insert (p);
+       }
+
+       /* the source will have an iterator into the model, and that iterator will have been set up
+          for a given set of filtered_parameters, so now that we've changed that list we must invalidate
+          the iterator.
+       */
+       Glib::Mutex::Lock lm (midi_source(0)->mutex());
+       midi_source(0)->invalidate ();
+}
+
+/** This is called when a trim drag has resulted in a -ve _start time for this region.
+ *  Fix it up by adding some empty space to the source.
+ */
+void
+MidiRegion::fix_negative_start ()
+{
+       BeatsFramesConverter c (_session.tempo_map(), _position);
+
+       model()->insert_silence_at_start (c.from (-_start));
+       _start = 0;
+}