Merge branch 'cairocanvas' of git.ardour.org:ardour/ardour into cairocanvas
[ardour.git] / libs / ardour / location.cc
index ddf95b16498795198cd0cbb40565fdb9737739f0..90265af4e4262410fa4bfd37b09d5b117eee89a7 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,8 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+PBD::Signal0<void> Location::scene_changed;
+
 Location::Location (Session& s)
        : SessionHandleRef (s)
        , _start (0)
@@ -50,19 +53,24 @@ Location::Location (Session& s)
        , _locked (false)
        , _position_lock_style (AudioTime)
 {
-
+       assert (_start >= 0);
+       assert (_end >= 0);
 }
 
-Location::Location (Session& s, nframes64_t sample_start, nframes64_t sample_end, const std::string &name, Flags bits)
+/** Construct a new Location, giving it the position lock style determined by glue-new-markers-to-bars-and-beats */
+Location::Location (Session& s, framepos_t sample_start, framepos_t sample_end, const std::string &name, Flags bits)
        : SessionHandleRef (s)
        , _name (name)
        , _start (sample_start)
        , _end (sample_end)
        , _flags (bits)
        , _locked (false)
-       , _position_lock_style (AudioTime)
+       , _position_lock_style (s.config.get_glue_new_markers_to_bars_and_beats() ? MusicTime : AudioTime)
 {
        recompute_bbt_from_frames ();
+
+       assert (_start >= 0);
+       assert (_end >= 0);
 }
 
 Location::Location (const Location& other)
@@ -79,6 +87,11 @@ Location::Location (const Location& other)
        /* copy is not locked even if original was */
 
        _locked = false;
+
+       assert (_start >= 0);
+       assert (_end >= 0);
+
+       /* scene change is NOT COPIED */
 }
 
 Location::Location (Session& s, const XMLNode& node)
@@ -88,10 +101,28 @@ Location::Location (Session& s, const XMLNode& node)
        /* Note: _position_lock_style is initialised above in case set_state doesn't set it
           (for 2.X session file compatibility).
        */
-       
+
        if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor ();
        }
+
+       assert (_start >= 0);
+       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*
@@ -108,6 +139,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 */
 
@@ -115,6 +148,9 @@ Location::operator= (const Location& other)
 
        /* "changed" not emitted on purpose */
 
+       assert (_start >= 0);
+       assert (_end >= 0);
+
        return this;
 }
 
@@ -124,8 +160,12 @@ Location::operator= (const Location& other)
  *  @param allow_bbt_recompute True to recompute BBT start time from the new given start time.
  */
 int
-Location::set_start (nframes64_t s, bool force, bool allow_bbt_recompute)
+Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
 {
+       if (s < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -143,24 +183,34 @@ Location::set_start (nframes64_t s, bool force, bool allow_bbt_recompute)
                        if (allow_bbt_recompute) {
                                recompute_bbt_from_frames ();
                        }
+
                        start_changed (this); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
                }
+
+               assert (_start >= 0);
+               assert (_end >= 0);
+
                return 0;
        }
-       
+
        if (s != _start) {
+
+               framepos_t const old = _start;
+
                _start = s;
                if (allow_bbt_recompute) {
                        recompute_bbt_from_frames ();
                }
                start_changed (this); /* EMIT SIGNAL */
                if (is_session_range ()) {
-                       Session::StartTimeChanged (); /* EMIT SIGNAL */
+                       Session::StartTimeChanged (old); /* EMIT SIGNAL */
                        AudioFileSource::set_header_position_offset (s);
                }
        }
 
+       assert (_start >= 0);
+
        return 0;
 }
 
@@ -170,8 +220,12 @@ Location::set_start (nframes64_t s, bool force, bool allow_bbt_recompute)
  *  @param allow_bbt_recompute True to recompute BBT end time from the new given end time.
  */
 int
-Location::set_end (nframes64_t e, bool force, bool allow_bbt_recompute)
+Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
 {
+       if (e < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -181,7 +235,7 @@ Location::set_end (nframes64_t e, bool force, bool allow_bbt_recompute)
                        return -1;
                }
        }
-       
+
        if (is_mark()) {
                if (_start != e) {
                        _start = e;
@@ -192,10 +246,17 @@ Location::set_end (nframes64_t e, bool force, bool allow_bbt_recompute)
                        start_changed (this); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
                }
+
+               assert (_start >= 0);
+               assert (_end >= 0);
+
                return 0;
        }
 
        if (e != _end) {
+
+               framepos_t const old = _end;
+
                _end = e;
                if (allow_bbt_recompute) {
                        recompute_bbt_from_frames ();
@@ -203,16 +264,22 @@ Location::set_end (nframes64_t e, bool force, bool allow_bbt_recompute)
                end_changed(this); /* EMIT SIGNAL */
 
                if (is_session_range()) {
-                       Session::EndTimeChanged (); /* EMIT SIGNAL */
+                       Session::EndTimeChanged (old); /* EMIT SIGNAL */
                }
        }
 
+       assert (_end >= 0);
+
        return 0;
 }
 
 int
-Location::set (nframes64_t start, nframes64_t end, bool allow_bbt_recompute)
+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;
@@ -226,8 +293,12 @@ Location::set (nframes64_t start, nframes64_t end, bool allow_bbt_recompute)
 }
 
 int
-Location::move_to (nframes64_t pos)
+Location::move_to (framepos_t pos)
 {
+       if (pos < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -240,6 +311,9 @@ Location::move_to (nframes64_t pos)
                changed (this); /* EMIT SIGNAL */
        }
 
+       assert (_start >= 0);
+       assert (_end >= 0);
+
        return 0;
 }
 
@@ -364,11 +438,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;
 
@@ -384,10 +462,8 @@ Location::set_state (const XMLNode& node, int /*version*/)
                return -1;
        }
 
-       if ((prop = node.property ("id")) == 0) {
+       if (!set_id (node)) {
                warning << _("XML node for Location has no ID information") << endmsg;
-       } else {
-               _id = prop->value ();
        }
 
        if ((prop = node.property ("name")) == 0) {
@@ -456,10 +532,23 @@ 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);
+
+               if (_scene_change) {
+                       _scene_change->set_time (_start);
+               }
+       }
+
        recompute_bbt_from_frames ();
 
        changed (this); /* EMIT SIGNAL */
 
+       assert (_start >= 0);
+       assert (_end >= 0);
+
        return 0;
 }
 
@@ -483,9 +572,9 @@ Location::recompute_bbt_from_frames ()
        if (_position_lock_style != MusicTime) {
                return;
        }
-       
-       _session.tempo_map().bbt_time (_start, _bbt_start);
-       _session.tempo_map().bbt_time (_end, _bbt_end);
+
+       _session.bbt_time (_start, _bbt_start);
+       _session.bbt_time (_end, _bbt_end);
 }
 
 void
@@ -513,6 +602,14 @@ Location::unlock ()
        LockChanged (this);
 }
 
+void
+Location::set_scene_change (boost::shared_ptr<SceneChange>  sc)
+{
+       _scene_change = sc;
+
+       scene_changed (); /* EMIT SIGNAL */
+}
+
 /*---------------------------------------------------------------------- */
 
 Locations::Locations (Session& s)
@@ -537,7 +634,7 @@ Locations::set_current (Location *loc, bool want_lock)
        int ret;
 
        if (want_lock) {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                ret = set_current_unlocked (loc);
        } else {
                ret = set_current_unlocked (loc);
@@ -599,7 +696,7 @@ void
 Locations::clear ()
 {
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
 
                for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
 
@@ -607,6 +704,7 @@ Locations::clear ()
                        ++tmp;
 
                        if (!(*i)->is_session_range()) {
+                               delete *i;
                                locations.erase (i);
                        }
 
@@ -624,7 +722,7 @@ void
 Locations::clear_markers ()
 {
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                LocationList::iterator tmp;
 
                for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
@@ -632,6 +730,7 @@ Locations::clear_markers ()
                        ++tmp;
 
                        if ((*i)->is_mark() && !(*i)->is_session_range()) {
+                               delete *i;
                                locations.erase (i);
                        }
 
@@ -646,7 +745,7 @@ void
 Locations::clear_ranges ()
 {
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                LocationList::iterator tmp;
 
                for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
@@ -655,6 +754,7 @@ Locations::clear_ranges ()
                        ++tmp;
 
                        if (!(*i)->is_mark()) {
+                               delete *i;
                                locations.erase (i);
 
                        }
@@ -673,9 +773,9 @@ void
 Locations::add (Location *loc, bool make_current)
 {
        assert (loc);
-       
+
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                locations.push_back (loc);
 
                if (make_current) {
@@ -688,6 +788,11 @@ Locations::add (Location *loc, bool make_current)
        if (make_current) {
                 current_changed (current_location); /* EMIT SIGNAL */
        }
+
+       if (loc->is_session_range()) {
+               Session::StartTimeChanged (0);
+               Session::EndTimeChanged (1);
+       }
 }
 
 void
@@ -702,10 +807,11 @@ Locations::remove (Location *loc)
        }
 
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
 
                for (i = locations.begin(); i != locations.end(); ++i) {
                        if ((*i) == loc) {
+                               delete *i;
                                locations.erase (i);
                                was_removed = true;
                                if (current_location == loc) {
@@ -740,7 +846,7 @@ Locations::get_state ()
 {
        XMLNode *node = new XMLNode ("Locations");
        LocationList::iterator iter;
-       Glib::Mutex::Lock lm (lock);
+       Glib::Threads::Mutex::Lock lm (lock);
 
        for (iter = locations.begin(); iter != locations.end(); ++iter) {
                node->add_child_nocopy ((*iter)->get_state ());
@@ -759,24 +865,42 @@ Locations::set_state (const XMLNode& node, int version)
 
        XMLNodeList nlist = node.children();
 
-       locations.clear ();
+       /* build up a new locations list in here */
+       LocationList new_locations;
+
        current_location = 0;
 
        Location* session_range_location = 0;
        if (version < 3000) {
                session_range_location = new Location (_session, 0, 0, _("session"), Location::IsSessionRange);
-               locations.push_back (session_range_location);
+               new_locations.push_back (session_range_location);
        }
 
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
 
                XMLNodeConstIterator niter;
                for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
                        try {
 
-                               Location *loc = new Location (_session, **niter);
+                               XMLProperty const * prop_id = (*niter)->property ("id");
+                               assert (prop_id);
+                               PBD::ID id (prop_id->value ());
+
+                               LocationList::const_iterator i = locations.begin();
+                               while (i != locations.end () && (*i)->id() != id) {
+                                       ++i;
+                               }
+
+                               Location* loc;
+                               if (i != locations.end()) {
+                                       /* we can re-use an old Location object */
+                                       loc = *i;
+                                       loc->set_state (**niter, version);
+                               } else {
+                                       loc = new Location (_session, **niter);
+                               }
 
                                bool add = true;
 
@@ -808,7 +932,7 @@ Locations::set_state (const XMLNode& node, int version)
                                }
 
                                if (add) {
-                                       locations.push_back (loc);
+                                       new_locations.push_back (loc);
                                }
                        }
 
@@ -817,6 +941,8 @@ Locations::set_state (const XMLNode& node, int version)
                        }
                }
 
+               locations = new_locations;
+
                if (locations.size()) {
                        current_location = locations.front();
                } else {
@@ -829,96 +955,149 @@ 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 (nframes64_t frame, bool include_special_ranges)
+framepos_t
+Locations::first_mark_before (framepos_t frame, bool include_special_ranges)
 {
-       LocationList locs;
-
-       {
-               Glib::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 (nframes64_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::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
  *  side of a frame.  Note that if frame is exactly on a `mark', that mark will not be considered for returning
  *  as before/after.
  *  @param frame Frame to look for.
- *  @param before Filled in with the position of the last `mark' before `frame' (or max_frames if none exists)
- *  @param after Filled in with the position of the next `mark' after `frame' (or max_frames if none exists)
+ *  @param before Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists)
+ *  @param after Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists)
  */
 void
-Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nframes64_t& after) const
+Locations::marks_either_side (framepos_t const frame, framepos_t& before, framepos_t& after) const
 {
-       before = after = max_frames;
-       
+       before = after = max_framepos;
+
        LocationList locs;
 
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                locs = locations;
        }
 
        /* Get a list of positions; don't store any that are exactly on our requested position */
-       
-       std::list<nframes64_t> positions;
+
+       std::list<framepos_t> positions;
 
        for (LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
                if (((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
@@ -947,7 +1126,7 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
 
        positions.sort ();
 
-       std::list<nframes64_t>::iterator i = positions.begin ();
+       std::list<framepos_t>::iterator i = positions.begin ();
        while (i != positions.end () && *i < frame) {
                ++i;
        }
@@ -964,7 +1143,7 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
                /* none before */
                return;
        }
-       
+
        --i;
        before = *i;
 }
@@ -1006,7 +1185,7 @@ uint32_t
 Locations::num_range_markers () const
 {
        uint32_t cnt = 0;
-       Glib::Mutex::Lock lm (lock);
+       Glib::Threads::Mutex::Lock lm (lock);
        for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
                if ((*i)->is_range_marker()) {
                        ++cnt;
@@ -1027,9 +1206,9 @@ Locations::get_location_by_id(PBD::ID id)
 }
 
 void
-Locations::find_all_between (nframes64_t start, nframes64_t end, LocationList& ll, Location::Flags flags)
+Locations::find_all_between (framepos_t start, framepos_t end, LocationList& ll, Location::Flags flags)
 {
-       Glib::Mutex::Lock lm (lock);
+       Glib::Threads::Mutex::Lock lm (lock);
 
        for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
                if ((flags == 0 || (*i)->matches (flags)) &&
@@ -1038,3 +1217,4 @@ Locations::find_all_between (nframes64_t start, nframes64_t end, LocationList& l
                }
        }
 }
+