Fix up state save/load of location lock/glue settings.
[ardour.git] / libs / ardour / location.cc
index f855cb75cffff6c67248eaf0befb18d3461b714d..d9d5911555c612dcce670367afd78ccf3a3ce308 100644 (file)
@@ -25,7 +25,6 @@
 #include <ctime>
 #include <list>
 
-
 #include "pbd/stl_delete.h"
 #include "pbd/xml++.h"
 #include "pbd/enumwriter.h"
@@ -33,6 +32,7 @@
 #include "ardour/location.h"
 #include "ardour/session.h"
 #include "ardour/audiofilesource.h"
+#include "ardour/tempo.h"
 
 #include "i18n.h"
 
@@ -42,19 +42,47 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+Location::Location (Session& s)
+       : SessionHandleRef (s)
+       , _start (0)
+       , _end (0)
+       , _flags (Flags (0))
+       , _locked (false)
+       , _position_lock_style (AudioTime)
+{
+
+}
+
+Location::Location (Session& s, nframes64_t sample_start, nframes64_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)
+{
+       recompute_bbt_from_frames ();
+}
+
 Location::Location (const Location& other)
-       : StatefulDestructible(),
-         _name (other._name),
-         _start (other._start),
-         _end (other._end),
-         _flags (other._flags)
+       : SessionHandleRef (other._session)
+       , StatefulDestructible()
+       , _name (other._name)
+       , _start (other._start)
+       , _bbt_start (other._bbt_start)
+       , _end (other._end)
+       , _bbt_end (other._bbt_end)
+       , _flags (other._flags)
+       , _position_lock_style (other._position_lock_style)
 {
        /* copy is not locked even if original was */
 
        _locked = false;
 }
 
-Location::Location (const XMLNode& node)
+Location::Location (Session& s, const XMLNode& node)
+       : SessionHandleRef (s)
 {
        if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor ();
@@ -70,8 +98,11 @@ Location::operator= (const Location& other)
 
        _name = other._name;
        _start = other._start;
+       _bbt_start = other._bbt_start;
        _end = other._end;
+       _bbt_end = other._bbt_end;
        _flags = other._flags;
+       _position_lock_style = other._position_lock_style;
 
        /* copy is not locked even if original was */
 
@@ -82,21 +113,31 @@ Location::operator= (const Location& other)
        return this;
 }
 
+/** Set start position.
+ *  @param s New start.
+ *  @param force true to force setting, even if the given new start is after the current end.
+ *  @param allow_bbt_recompute True to recompute BBT start time from the new given start time.
+ */
 int
-Location::set_start (nframes64_t s)
+Location::set_start (nframes64_t s, bool force, bool allow_bbt_recompute)
 {
        if (_locked) {
                return -1;
        }
 
-       if (((is_auto_punch() || is_auto_loop()) && s >= _end) || (!is_mark() && s > _end)) {
-               return -1;
+       if (!force) {
+               if (((is_auto_punch() || is_auto_loop()) && s >= _end) || (!is_mark() && s > _end)) {
+                       return -1;
+               }
        }
 
        if (is_mark()) {
                if (_start != s) {
                        _start = s;
                        _end = s;
+                       if (allow_bbt_recompute) {
+                               recompute_bbt_from_frames ();
+                       }
                        start_changed (this); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
                }
@@ -105,6 +146,9 @@ Location::set_start (nframes64_t s)
        
        if (s != _start) {
                _start = s;
+               if (allow_bbt_recompute) {
+                       recompute_bbt_from_frames ();
+               }
                start_changed (this); /* EMIT SIGNAL */
                if (is_session_range ()) {
                        Session::StartTimeChanged (); /* EMIT SIGNAL */
@@ -115,21 +159,31 @@ Location::set_start (nframes64_t s)
        return 0;
 }
 
+/** Set end position.
+ *  @param s New end.
+ *  @param force true to force setting, even if the given new start is after the current end.
+ *  @param allow_bbt_recompute True to recompute BBT end time from the new given end time.
+ */
 int
-Location::set_end (nframes64_t e)
+Location::set_end (nframes64_t e, bool force, bool allow_bbt_recompute)
 {
        if (_locked) {
                return -1;
        }
 
-       if (((is_auto_punch() || is_auto_loop()) && e <= _start) || e < _start) {
-               return -1;
+       if (!force) {
+               if (((is_auto_punch() || is_auto_loop()) && e <= _start) || e < _start) {
+                       return -1;
+               }
        }
        
        if (is_mark()) {
                if (_start != e) {
                        _start = e;
                        _end = e;
+                       if (allow_bbt_recompute) {
+                               recompute_bbt_from_frames ();
+                       }
                        start_changed (this); /* EMIT SIGNAL */
                        end_changed (this); /* EMIT SIGNAL */
                }
@@ -138,6 +192,9 @@ Location::set_end (nframes64_t e)
 
        if (e != _end) {
                _end = e;
+               if (allow_bbt_recompute) {
+                       recompute_bbt_from_frames ();
+               }
                end_changed(this); /* EMIT SIGNAL */
 
                if (is_session_range()) {
@@ -149,10 +206,16 @@ Location::set_end (nframes64_t e)
 }
 
 int
-Location::set (nframes64_t start, nframes64_t end)
+Location::set (nframes64_t start, nframes64_t end, bool allow_bbt_recompute)
 {
-       int const s = set_start (start);
-       int const e = set_end (end);
+       /* check validity */
+       if (((is_auto_punch() || is_auto_loop()) && start >= end) || (!is_mark() && start > end)) {
+               return -1;
+       }
+
+       /* now we know these values are ok, so force-set them */
+       int const s = set_start (start, true, allow_bbt_recompute);
+       int const e = set_end (end, true, allow_bbt_recompute);
 
        return (s == 0 && e == 0) ? 0 : -1;
 }
@@ -167,6 +230,7 @@ Location::move_to (nframes64_t pos)
        if (_start != pos) {
                _start = pos;
                _end = _start + length();
+               recompute_bbt_from_frames ();
 
                changed (this); /* EMIT SIGNAL */
        }
@@ -273,7 +337,7 @@ Location::cd_info_node(const string & name, const string & value)
 
 
 XMLNode&
-Location::get_state (void)
+Location::get_state ()
 {
        XMLNode *node = new XMLNode ("Location");
        char buf[64];
@@ -293,6 +357,7 @@ Location::get_state (void)
        node->add_property ("end", buf);
        node->add_property ("flags", enum_2_string (_flags));
        node->add_property ("locked", (_locked ? "yes" : "no"));
+       node->add_property ("position-lock-style", enum_2_string (_position_lock_style));
 
        return *node;
 }
@@ -363,35 +428,90 @@ Location::set_state (const XMLNode& node, int /*version*/)
                  cd_node = *cd_iter;
 
                  if (cd_node->name() != "CD-Info") {
-                   continue;
+                         continue;
                  }
 
                  if ((prop = cd_node->property ("name")) != 0) {
-                   cd_name = prop->value();
+                         cd_name = prop->value();
                  } else {
-                   throw failed_constructor ();
+                         throw failed_constructor ();
                  }
 
                  if ((prop = cd_node->property ("value")) != 0) {
-                   cd_value = prop->value();
+                         cd_value = prop->value();
                  } else {
-                   throw failed_constructor ();
+                         throw failed_constructor ();
                  }
 
 
                  cd_info[cd_name] = cd_value;
+       }
 
+       if ((prop = node.property ("position-lock-style")) != 0) {
+               _position_lock_style = PositionLockStyle (string_2_enum (prop->value(), _position_lock_style));
        }
 
-       changed(this); /* EMIT SIGNAL */
+       recompute_bbt_from_frames ();
+
+       changed (this); /* EMIT SIGNAL */
 
        return 0;
 }
 
-/*---------------------------------------------------------------------- */
+void
+Location::set_position_lock_style (PositionLockStyle ps)
+{
+       if (_position_lock_style == ps) {
+               return;
+       }
 
-Locations::Locations ()
+       _position_lock_style = ps;
 
+       recompute_bbt_from_frames ();
+
+       PositionLockStyleChanged (this); /* EMIT SIGNAL */
+}
+
+void
+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);
+}
+
+void
+Location::recompute_frames_from_bbt ()
+{
+       if (_position_lock_style != MusicTime) {
+               return;
+       }
+
+       TempoMap& map (_session.tempo_map());
+       set (map.frame_time (_bbt_start), map.frame_time (_bbt_end), false);
+}
+
+void
+Location::lock ()
+{
+       _locked = true;
+       LockChanged (this);
+}
+
+void
+Location::unlock ()
+{
+       _locked = false;
+       LockChanged (this);
+}
+
+/*---------------------------------------------------------------------- */
+
+Locations::Locations (Session& s)
+       : SessionHandleRef (s)
 {
        current_location = 0;
 }
@@ -408,7 +528,6 @@ Locations::~Locations ()
 
 int
 Locations::set_current (Location *loc, bool want_lock)
-
 {
        int ret;
 
@@ -492,7 +611,7 @@ Locations::clear ()
                current_location = 0;
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
        current_changed (0); /* EMIT SIGNAL */
 }
 
@@ -515,7 +634,7 @@ Locations::clear_markers ()
                }
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
 }
 
 void
@@ -541,13 +660,15 @@ Locations::clear_ranges ()
                current_location = 0;
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
        current_changed (0); /* EMIT SIGNAL */
 }
 
 void
 Locations::add (Location *loc, bool make_current)
 {
+       assert (loc);
+       
        {
                Glib::Mutex::Lock lm (lock);
                locations.push_back (loc);
@@ -566,7 +687,6 @@ Locations::add (Location *loc, bool make_current)
 
 void
 Locations::remove (Location *loc)
-
 {
        bool was_removed = false;
        bool was_current = false;
@@ -600,14 +720,14 @@ Locations::remove (Location *loc)
                         current_changed (0); /* EMIT SIGNAL */
                }
 
-               changed (); /* EMIT_SIGNAL */
+               changed (REMOVAL); /* EMIT_SIGNAL */
        }
 }
 
 void
 Locations::location_changed (Location* /*loc*/)
 {
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
 }
 
 XMLNode&
@@ -639,7 +759,7 @@ Locations::set_state (const XMLNode& node, int version)
 
        Location* session_range_location = 0;
        if (version < 3000) {
-               session_range_location = new Location (0, 0, _("session"), Location::IsSessionRange);
+               session_range_location = new Location (_session, 0, 0, _("session"), Location::IsSessionRange);
                locations.push_back (session_range_location);
        }
 
@@ -651,7 +771,7 @@ Locations::set_state (const XMLNode& node, int version)
 
                        try {
 
-                               Location *loc = new Location (**niter);
+                               Location *loc = new Location (_session, **niter);
 
                                bool add = true;
 
@@ -699,7 +819,7 @@ Locations::set_state (const XMLNode& node, int version)
                }
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
 
        return 0;
 }
@@ -773,10 +893,11 @@ Locations::first_location_after (nframes64_t frame, bool include_special_ranges)
 }
 
 /** Look for the `marks' (either locations which are marks, or start/end points of range markers) either
- *  side of a frame.
+ *  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 last `mark' after `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)
  */
 void
 Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nframes64_t& after) const
@@ -790,6 +911,8 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
                locs = locations;
        }
 
+       /* Get a list of positions; don't store any that are exactly on our requested position */
+       
        std::list<nframes64_t> positions;
 
        for (LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
@@ -799,10 +922,16 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
 
                if (!(*i)->is_hidden()) {
                        if ((*i)->is_mark ()) {
-                               positions.push_back ((*i)->start ());
+                               if ((*i)->start() != frame) {
+                                       positions.push_back ((*i)->start ());
+                               }
                        } else {
-                               positions.push_back ((*i)->start ());
-                               positions.push_back ((*i)->end ());
+                               if ((*i)->start() != frame) {
+                                       positions.push_back ((*i)->start ());
+                               }
+                               if ((*i)->end() != frame) {
+                                       positions.push_back ((*i)->end ());
+                               }
                        }
                }
        }