duplicate all ARDOUR::Location signals so that we have one static signal that identif...
[ardour.git] / libs / ardour / location.cc
index 96a289e06f8efadde00b279fd5f1c35c541ed3b0..94afad679d86e760f06ec8202189d547311367ff 100644 (file)
@@ -30,6 +30,7 @@
 #include "pbd/enumwriter.h"
 
 #include "ardour/location.h"
+#include "ardour/midi_scene_change.h"
 #include "ardour/session.h"
 #include "ardour/audiofilesource.h"
 #include "ardour/tempo.h"
@@ -42,6 +43,15 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+PBD::Signal0<void> Location::scene_changed;
+PBD::Signal1<void,Location*> Location::name_changed;
+PBD::Signal1<void,Location*> Location::end_changed;
+PBD::Signal1<void,Location*> Location::start_changed;
+PBD::Signal1<void,Location*> Location::flags_changed;
+PBD::Signal1<void,Location*> Location::lock_changed;
+PBD::Signal1<void,Location*> Location::position_lock_style_changed;
+PBD::Signal1<void,Location*> Location::changed;
+
 Location::Location (Session& s)
        : SessionHandleRef (s)
        , _start (0)
@@ -87,6 +97,8 @@ Location::Location (const Location& other)
 
        assert (_start >= 0);
        assert (_end >= 0);
+
+       /* scene change is NOT COPIED */
 }
 
 Location::Location (Session& s, const XMLNode& node)
@@ -105,6 +117,21 @@ Location::Location (Session& s, const XMLNode& node)
        assert (_end >= 0);
 }
 
+bool
+Location::operator== (const Location& other)
+{
+       if (_name != other._name ||
+           _start != other._start ||
+           _end != other._end ||
+           _bbt_start != other._bbt_start ||
+           _bbt_end != other._bbt_end ||
+           _flags != other._flags ||
+           _position_lock_style != other._position_lock_style) {
+               return false;
+       }
+       return true;
+}
+
 Location*
 Location::operator= (const Location& other)
 {
@@ -119,6 +146,8 @@ Location::operator= (const Location& other)
        _bbt_end = other._bbt_end;
        _flags = other._flags;
        _position_lock_style = other._position_lock_style;
+       
+       /* XXX need to copy scene change */
 
        /* copy is not locked even if original was */
 
@@ -140,6 +169,10 @@ Location::operator= (const Location& other)
 int
 Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
 {
+       if (s < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -159,7 +192,17 @@ Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
                        }
 
                        start_changed (this); /* EMIT SIGNAL */
+                       StartChanged (); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
+                       EndChanged (); /* EMIT SIGNAL */
+               }
+
+               /* moving the start (position) of a marker with a scene change
+                  requires an update in the Scene Changer.
+               */
+
+               if (_scene_change) {
+                       scene_changed (); /* EMIT SIGNAL */
                }
 
                assert (_start >= 0);
@@ -177,6 +220,8 @@ Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
                        recompute_bbt_from_frames ();
                }
                start_changed (this); /* EMIT SIGNAL */
+               StartChanged (); /* EMIT SIGNAL */
+                               
                if (is_session_range ()) {
                        Session::StartTimeChanged (old); /* EMIT SIGNAL */
                        AudioFileSource::set_header_position_offset (s);
@@ -196,6 +241,10 @@ Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
 int
 Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
 {
+       if (e < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -214,7 +263,9 @@ Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
                                recompute_bbt_from_frames ();
                        }
                        start_changed (this); /* EMIT SIGNAL */
+                       StartChanged (); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
+                       EndChanged (); /* EMIT SIGNAL */
                }
 
                assert (_start >= 0);
@@ -224,6 +275,7 @@ Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
        }
 
        if (e != _end) {
+
                framepos_t const old = _end;
 
                _end = e;
@@ -231,6 +283,7 @@ Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
                        recompute_bbt_from_frames ();
                }
                end_changed(this); /* EMIT SIGNAL */
+               EndChanged(); /* EMIT SIGNAL */
 
                if (is_session_range()) {
                        Session::EndTimeChanged (old); /* EMIT SIGNAL */
@@ -245,6 +298,10 @@ Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
 int
 Location::set (framepos_t start, framepos_t end, bool allow_bbt_recompute)
 {
+       if (start < 0 || end < 0) {
+               return -1;
+       }
+
        /* check validity */
        if (((is_auto_punch() || is_auto_loop()) && start >= end) || (!is_mark() && start > end)) {
                return -1;
@@ -260,6 +317,10 @@ Location::set (framepos_t start, framepos_t end, bool allow_bbt_recompute)
 int
 Location::move_to (framepos_t pos)
 {
+       if (pos < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -270,6 +331,7 @@ Location::move_to (framepos_t pos)
                recompute_bbt_from_frames ();
 
                changed (this); /* EMIT SIGNAL */
+               Changed (); /* EMIT SIGNAL */
        }
 
        assert (_start >= 0);
@@ -279,58 +341,63 @@ Location::move_to (framepos_t pos)
 }
 
 void
-Location::set_hidden (bool yn, void *src)
+Location::set_hidden (bool yn, void*)
 {
        if (set_flag_internal (yn, IsHidden)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
+                flags_changed (this); /* EMIT SIGNAL */
+                 FlagsChanged ();
        }
 }
 
 void
-Location::set_cd (bool yn, void *src)
+Location::set_cd (bool yn, void*)
 {
        // XXX this really needs to be session start
        // but its not available here - leave to GUI
 
-       if (_start == 0) {
+       if (yn && _start == 0) {
                error << _("You cannot put a CD marker at this position") << endmsg;
                return;
        }
 
        if (set_flag_internal (yn, IsCDMarker)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
+                flags_changed (this); /* EMIT SIGNAL */
+                 FlagsChanged ();
        }
 }
 
 void
-Location::set_is_range_marker (bool yn, void *src)
+Location::set_is_range_marker (bool yn, void*)
 {
        if (set_flag_internal (yn, IsRangeMarker)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
+               flags_changed (this);
+                FlagsChanged (); /* EMIT SIGNAL */
        }
 }
 
 void
-Location::set_auto_punch (bool yn, void *src)
+Location::set_auto_punch (bool yn, void*)
 {
        if (is_mark() || _start == _end) {
                return;
        }
 
        if (set_flag_internal (yn, IsAutoPunch)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
+                flags_changed (this); /* EMIT SIGNAL */
+                FlagsChanged (); /* EMIT SIGNAL */
        }
 }
 
 void
-Location::set_auto_loop (bool yn, void *src)
+Location::set_auto_loop (bool yn, void*)
 {
        if (is_mark() || _start == _end) {
                return;
        }
 
        if (set_flag_internal (yn, IsAutoLoop)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
+                flags_changed (this); /* EMIT SIGNAL */
+                FlagsChanged (); /* EMIT SIGNAL */
        }
 }
 
@@ -399,11 +466,15 @@ Location::get_state ()
        node->add_property ("locked", (_locked ? "yes" : "no"));
        node->add_property ("position-lock-style", enum_2_string (_position_lock_style));
 
+       if (_scene_change) {
+               node->add_child_nocopy (_scene_change->get_state());
+       }
+
        return *node;
 }
 
 int
-Location::set_state (const XMLNode& node, int /*version*/)
+Location::set_state (const XMLNode& node, int version)
 {
        const XMLProperty *prop;
 
@@ -489,9 +560,16 @@ Location::set_state (const XMLNode& node, int /*version*/)
                _position_lock_style = PositionLockStyle (string_2_enum (prop->value(), _position_lock_style));
        }
 
+       XMLNode* scene_child = find_named_node (node, SceneChange::xml_node_name);
+       
+       if (scene_child) {
+               _scene_change = SceneChange::factory (*scene_child, version);
+       }
+
        recompute_bbt_from_frames ();
 
        changed (this); /* EMIT SIGNAL */
+       Changed (); /* EMIT SIGNAL */
 
        assert (_start >= 0);
        assert (_end >= 0);
@@ -510,7 +588,8 @@ Location::set_position_lock_style (PositionLockStyle ps)
 
        recompute_bbt_from_frames ();
 
-       PositionLockStyleChanged (this); /* EMIT SIGNAL */
+       position_lock_style_changed (this); /* EMIT SIGNAL */
+       PositionLockStyleChanged (); /* EMIT SIGNAL */
 }
 
 void
@@ -539,14 +618,24 @@ void
 Location::lock ()
 {
        _locked = true;
-       LockChanged (this);
+       lock_changed (this);
+       LockChanged ();
 }
 
 void
 Location::unlock ()
 {
        _locked = false;
-       LockChanged (this);
+       lock_changed (this);
+       LockChanged ();
+}
+
+void
+Location::set_scene_change (boost::shared_ptr<SceneChange>  sc)
+{
+       _scene_change = sc;
+
+       scene_changed (); /* EMIT SIGNAL */
 }
 
 /*---------------------------------------------------------------------- */
@@ -555,6 +644,10 @@ Locations::Locations (Session& s)
        : SessionHandleRef (s)
 {
        current_location = 0;
+
+       Location::changed.connect_same_thread (*this, boost::bind (&Locations::location_changed, this, _1));
+       Location::start_changed.connect_same_thread (*this, boost::bind (&Locations::location_changed, this, _1));
+       Location::end_changed.connect_same_thread (*this, boost::bind (&Locations::location_changed, this, _1));
 }
 
 Locations::~Locations ()
@@ -643,6 +736,7 @@ Locations::clear ()
                        ++tmp;
 
                        if (!(*i)->is_session_range()) {
+                               delete *i;
                                locations.erase (i);
                        }
 
@@ -668,6 +762,7 @@ Locations::clear_markers ()
                        ++tmp;
 
                        if ((*i)->is_mark() && !(*i)->is_session_range()) {
+                               delete *i;
                                locations.erase (i);
                        }
 
@@ -690,7 +785,19 @@ Locations::clear_ranges ()
                        tmp = i;
                        ++tmp;
 
+                       /* We do not remove these ranges as part of this
+                        * operation
+                        */
+
+                       if ((*i)->is_auto_punch() ||
+                           (*i)->is_auto_loop() ||
+                           (*i)->is_session_range()) {
+                               i = tmp;
+                               continue;
+                       }
+
                        if (!(*i)->is_mark()) {
+                               delete *i;
                                locations.erase (i);
 
                        }
@@ -747,6 +854,7 @@ Locations::remove (Location *loc)
 
                for (i = locations.begin(); i != locations.end(); ++i) {
                        if ((*i) == loc) {
+                               delete *i;
                                locations.erase (i);
                                was_removed = true;
                                if (current_location == loc) {
@@ -890,72 +998,125 @@ Locations::set_state (const XMLNode& node, int version)
        return 0;
 }
 
+
+typedef std::pair<framepos_t,Location*> LocationPair;
+
 struct LocationStartEarlierComparison
 {
-    bool operator() (Location *a, Location *b) {
-       return a->start() < b->start();
+    bool operator() (LocationPair a, LocationPair b) {
+           return a.first < b.first;
     }
 };
 
 struct LocationStartLaterComparison
 {
-    bool operator() (Location *a, Location *b) {
-       return a->start() > b->start();
+    bool operator() (LocationPair a, LocationPair b) {
+           return a.first > b.first;
     }
 };
 
-Location *
-Locations::first_location_before (framepos_t frame, bool include_special_ranges)
+framepos_t
+Locations::first_mark_before (framepos_t frame, bool include_special_ranges)
 {
-       LocationList locs;
-
-       {
-               Glib::Threads::Mutex::Lock lm (lock);
-               locs = locations;
+       Glib::Threads::Mutex::Lock lm (lock);
+       vector<LocationPair> locs;
+       
+       for (LocationList::iterator i = locations.begin(); i != locations.end(); ++i) {
+               locs.push_back (make_pair ((*i)->start(), (*i)));
+               if (!(*i)->is_mark()) {
+                       locs.push_back (make_pair ((*i)->end(), (*i)));
+               }
        }
 
        LocationStartLaterComparison cmp;
-       locs.sort (cmp);
+       sort (locs.begin(), locs.end(), cmp);
 
-       /* locs is now sorted latest..earliest */
+       /* locs is sorted in ascending order */
 
-       for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
-               if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
+       for (vector<LocationPair>::iterator i = locs.begin(); i != locs.end(); ++i) {
+               if ((*i).second->is_hidden()) {
+                       continue;
+               }
+               if (!include_special_ranges && ((*i).second->is_auto_loop() || (*i).second->is_auto_punch())) {
                        continue;
                }
-               if (!(*i)->is_hidden() && (*i)->start() < frame) {
-                       return (*i);
+               if ((*i).first < frame) {
+                       return (*i).first;
                }
        }
 
-       return 0;
+       return -1;
 }
 
-Location *
-Locations::first_location_after (framepos_t frame, bool include_special_ranges)
+Location*
+Locations::mark_at (framepos_t pos, framecnt_t slop) const
 {
-       LocationList locs;
+       Glib::Threads::Mutex::Lock lm (lock);
+       Location* closest = 0;
+       frameoffset_t mindelta = max_framepos;
+       frameoffset_t delta;
 
-       {
-               Glib::Threads::Mutex::Lock lm (lock);
-               locs = locations;
+       /* locations are not necessarily stored in linear time order so we have
+        * to iterate across all of them to find the one closest to a give point.
+        */
+
+       for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
+
+               if ((*i)->is_mark()) {
+                       if (pos > (*i)->start()) { 
+                               delta = pos - (*i)->start();
+                       } else {
+                               delta = (*i)->start() - pos;
+                       }
+                       
+                       if (slop == 0 && delta == 0) {
+                               /* special case: no slop, and direct hit for position */
+                               return *i;
+                       }
+
+                       if (delta <= slop) {
+                               if (delta < mindelta) {
+                                       closest = *i;
+                                       mindelta = delta;
+                               }
+                       }
+               }
        }
 
-       LocationStartEarlierComparison cmp;
-       locs.sort (cmp);
+       return closest;
+}
 
-       /* locs is now sorted earliest..latest */
+framepos_t
+Locations::first_mark_after (framepos_t frame, bool include_special_ranges)
+{
+       Glib::Threads::Mutex::Lock lm (lock);
+       vector<LocationPair> locs;
 
-       for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
-               if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
+       for (LocationList::iterator i = locations.begin(); i != locations.end(); ++i) {
+               locs.push_back (make_pair ((*i)->start(), (*i)));
+               if (!(*i)->is_mark()) {
+                       locs.push_back (make_pair ((*i)->end(), (*i)));
+               }
+       }
+
+       LocationStartEarlierComparison cmp;
+       sort (locs.begin(), locs.end(), cmp);
+       
+       /* locs is sorted in reverse order */
+
+       for (vector<LocationPair>::iterator i = locs.begin(); i != locs.end(); ++i) {
+               if ((*i).second->is_hidden()) {
                        continue;
                }
-               if (!(*i)->is_hidden() && (*i)->start() > frame) {
-                       return (*i);
+               if (!include_special_ranges && ((*i).second->is_auto_loop() || (*i).second->is_auto_punch())) {
+                       continue;
+               }
+               if ((*i).first > frame) {
+                       return (*i).first;
                }
        }
 
-       return 0;
+       return -1;
 }
 
 /** Look for the `marks' (either locations which are marks, or start/end points of range markers) either
@@ -1099,3 +1260,4 @@ Locations::find_all_between (framepos_t start, framepos_t end, LocationList& ll,
                }
        }
 }
+