possibly fix deadlocking issues with tempo map by rearranging code and adding RT...
[ardour.git] / libs / ardour / location.cc
index b3421d2b0b3f7843a727987026b6567d25889b07..e909957e0d9daaf27e1b67cd34504e6fec4f111c 100644 (file)
@@ -25,8 +25,6 @@
 #include <ctime>
 #include <list>
 
-#include <sigc++/bind.h>
-
 #include "pbd/stl_delete.h"
 #include "pbd/xml++.h"
 #include "pbd/enumwriter.h"
@@ -34,6 +32,7 @@
 #include "ardour/location.h"
 #include "ardour/session.h"
 #include "ardour/audiofilesource.h"
+#include "ardour/tempo.h"
 
 #include "i18n.h"
 
 
 using namespace std;
 using namespace ARDOUR;
-using namespace sigc;
 using namespace PBD;
 
-Location::Location (const Location& other)
-       : StatefulDestructible(),
-         _name (other._name),
-         _start (other._start),
-         _end (other._end),
-         _flags (other._flags)
+Location::Location (Session& s)
+       : SessionHandleRef (s)
+       , _start (0)
+       , _end (0)
+       , _flags (Flags (0))
+       , _locked (false)
+       , _position_lock_style (AudioTime)
 {
-       /* start and end flags can never be copied, because there can only ever be one of each */
+       assert (_start >= 0);
+       assert (_end >= 0);
+}
 
-       _flags = Flags (_flags & ~IsStart);
-       _flags = Flags (_flags & ~IsEnd);
+/** 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 (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)
+       : 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;
+
+       assert (_start >= 0);
+       assert (_end >= 0);
 }
 
-Location::Location (const XMLNode& node)
+Location::Location (Session& s, const XMLNode& node)
+       : SessionHandleRef (s)
+       , _position_lock_style (AudioTime)
 {
+       /* 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);
 }
 
 Location*
@@ -77,8 +114,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 */
 
@@ -86,114 +126,139 @@ Location::operator= (const Location& other)
 
        /* "changed" not emitted on purpose */
 
+       assert (_start >= 0);
+       assert (_end >= 0);
+
        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 (framepos_t s, bool force, bool allow_bbt_recompute)
 {
        if (_locked) {
                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;
-
-                       start_changed(this); /* EMIT SIGNAL */
-                       end_changed(this); /* EMIT SIGNAL */
-
-                       if ( is_start() ) {
-
-                               Session::StartTimeChanged (); /* EMIT SIGNAL */
-                               AudioFileSource::set_header_position_offset ( s );
+                       if (allow_bbt_recompute) {
+                               recompute_bbt_from_frames ();
                        }
 
-                       if ( is_end() ) {
-                               Session::EndTimeChanged (); /* EMIT SIGNAL */
-                       }
+                       start_changed (this); /* EMIT SIGNAL */
+                       end_changed (this); /* EMIT SIGNAL */
                }
-               return 0;
-       }
 
-       if (((is_auto_punch() || is_auto_loop()) && s >= _end) || s > _end) {
-               return -1;
+               assert (_start >= 0);
+               assert (_end >= 0);
+
+               return 0;
        }
 
        if (s != _start) {
+
+               framepos_t const old = _start;
+
                _start = s;
-               start_changed(this); /* EMIT SIGNAL */
+               if (allow_bbt_recompute) {
+                       recompute_bbt_from_frames ();
+               }
+               start_changed (this); /* EMIT SIGNAL */
+               if (is_session_range ()) {
+                       Session::StartTimeChanged (old); /* EMIT SIGNAL */
+                       AudioFileSource::set_header_position_offset (s);
+               }
        }
 
+       assert (_start >= 0);
+
        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 (framepos_t e, bool force, bool allow_bbt_recompute)
 {
        if (_locked) {
                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;
-                       start_changed(this); /* EMIT SIGNAL */
-                       end_changed(this); /* EMIT SIGNAL */
-
-                       if ( is_start() ) {
-                               Session::StartTimeChanged (); /* EMIT SIGNAL */
+                       if (allow_bbt_recompute) {
+                               recompute_bbt_from_frames ();
                        }
+                       start_changed (this); /* EMIT SIGNAL */
+                       end_changed (this); /* EMIT SIGNAL */
+               }
 
-                       if ( is_end() ) {
-                               Session::EndTimeChanged (); /* EMIT SIGNAL */
-                       }
+               assert (_start >= 0);
+               assert (_end >= 0);
 
-               }
                return 0;
        }
 
-       if (((is_auto_punch() || is_auto_loop()) && e <= _start) || e < _start) {
-               return -1;
-       }
-
        if (e != _end) {
+               framepos_t const old = _end;
+
                _end = e;
-                end_changed(this); /* EMIT SIGNAL */
+               if (allow_bbt_recompute) {
+                       recompute_bbt_from_frames ();
+               }
+               end_changed(this); /* EMIT SIGNAL */
+
+               if (is_session_range()) {
+                       Session::EndTimeChanged (old); /* EMIT SIGNAL */
+               }
        }
+
+       assert (_end >= 0);
+
        return 0;
 }
 
 int
-Location::set (nframes64_t start, nframes64_t end)
+Location::set (framepos_t start, framepos_t end, bool allow_bbt_recompute)
 {
-       if (_locked) {
+       /* check validity */
+       if (((is_auto_punch() || is_auto_loop()) && start >= end) || (!is_mark() && start > end)) {
                return -1;
        }
 
-       if (is_mark() && start != end) {
-               return -1;
-       } else if (((is_auto_punch() || is_auto_loop()) && start >= end) || (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);
 
-       if (_start != start) {
-               _start = start;
-               start_changed(this); /* EMIT SIGNAL */
-       }
-
-       if (_end != end) {
-               _end = end;
-               end_changed(this); /* EMIT SIGNAL */
-       }
-       return 0;
+       return (s == 0 && e == 0) ? 0 : -1;
 }
 
 int
-Location::move_to (nframes64_t pos)
+Location::move_to (framepos_t pos)
 {
        if (_locked) {
                return -1;
@@ -202,10 +267,14 @@ Location::move_to (nframes64_t pos)
        if (_start != pos) {
                _start = pos;
                _end = _start + length();
+               recompute_bbt_from_frames ();
 
                changed (this); /* EMIT SIGNAL */
        }
 
+       assert (_start >= 0);
+       assert (_end >= 0);
+
        return 0;
 }
 
@@ -233,22 +302,6 @@ Location::set_cd (bool yn, void *src)
        }
 }
 
-void
-Location::set_is_end (bool yn, void *src)
-{
-       if (set_flag_internal (yn, IsEnd)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
-       }
-}
-
-void
-Location::set_is_start (bool yn, void *src)
-{
-       if (set_flag_internal (yn, IsStart)) {
-                FlagsChanged (this, src); /* EMIT SIGNAL */
-       }
-}
-
 void
 Location::set_is_range_marker (bool yn, void *src)
 {
@@ -324,7 +377,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];
@@ -344,6 +397,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;
 }
@@ -365,10 +419,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) {
@@ -414,35 +466,93 @@ 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 */
+
+       assert (_start >= 0);
+       assert (_end >= 0);
 
        return 0;
 }
 
-/*---------------------------------------------------------------------- */
+void
+Location::set_position_lock_style (PositionLockStyle ps)
+{
+       if (_position_lock_style == ps) {
+               return;
+       }
+
+       _position_lock_style = ps;
+
+       recompute_bbt_from_frames ();
+
+       PositionLockStyleChanged (this); /* EMIT SIGNAL */
+}
+
+void
+Location::recompute_bbt_from_frames ()
+{
+       if (_position_lock_style != MusicTime) {
+               return;
+       }
 
-Locations::Locations ()
+       _session.bbt_time (_start, _bbt_start);
+       _session.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;
 }
@@ -459,7 +569,6 @@ Locations::~Locations ()
 
 int
 Locations::set_current (Location *loc, bool want_lock)
-
 {
        int ret;
 
@@ -533,7 +642,7 @@ Locations::clear ()
                        LocationList::iterator tmp = i;
                        ++tmp;
 
-                       if (!(*i)->is_end() && !(*i)->is_start()) {
+                       if (!(*i)->is_session_range()) {
                                locations.erase (i);
                        }
 
@@ -543,7 +652,7 @@ Locations::clear ()
                current_location = 0;
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
        current_changed (0); /* EMIT SIGNAL */
 }
 
@@ -558,7 +667,7 @@ Locations::clear_markers ()
                        tmp = i;
                        ++tmp;
 
-                       if ((*i)->is_mark() && !(*i)->is_end() && !(*i)->is_start()) {
+                       if ((*i)->is_mark() && !(*i)->is_session_range()) {
                                locations.erase (i);
                        }
 
@@ -566,7 +675,7 @@ Locations::clear_markers ()
                }
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
 }
 
 void
@@ -592,13 +701,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);
@@ -613,17 +724,21 @@ 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
 Locations::remove (Location *loc)
-
 {
        bool was_removed = false;
        bool was_current = false;
        LocationList::iterator i;
 
-       if (loc->is_end() || loc->is_start()) {
+       if (loc->is_session_range()) {
                return;
        }
 
@@ -651,14 +766,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&
@@ -668,7 +783,7 @@ Locations::get_state ()
        LocationList::iterator iter;
        Glib::Mutex::Lock lm (lock);
 
-       for (iter  = locations.begin(); iter != locations.end(); ++iter) {
+       for (iter = locations.begin(); iter != locations.end(); ++iter) {
                node->add_child_nocopy ((*iter)->get_state ());
        }
 
@@ -676,30 +791,84 @@ Locations::get_state ()
 }
 
 int
-Locations::set_state (const XMLNode& node, int /*version*/)
+Locations::set_state (const XMLNode& node, int version)
 {
-       XMLNodeList nlist;
-       XMLNodeConstIterator niter;
-
        if (node.name() != "Locations") {
                error << _("incorrect XML mode passed to Locations::set_state") << endmsg;
                return -1;
        }
 
-       nlist = node.children();
+       XMLNodeList nlist = node.children();
+
+       /* build up a new locations list in here */
+       LocationList new_locations;
 
-       locations.clear ();
        current_location = 0;
 
+       Location* session_range_location = 0;
+       if (version < 3000) {
+               session_range_location = new Location (_session, 0, 0, _("session"), Location::IsSessionRange);
+               new_locations.push_back (session_range_location);
+       }
+
        {
                Glib::Mutex::Lock lm (lock);
 
+               XMLNodeConstIterator niter;
                for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
                        try {
 
-                               Location *loc = new Location (**niter);
-                               locations.push_back (loc);
+                               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;
+
+                               if (version < 3000) {
+                                       /* look for old-style IsStart / IsEnd properties in this location;
+                                          if they are present, update the session_range_location accordingly
+                                       */
+                                       XMLProperty const * prop = (*niter)->property ("flags");
+                                       if (prop) {
+                                               string v = prop->value ();
+                                               while (1) {
+                                                       string::size_type const c = v.find_first_of (',');
+                                                       string const s = v.substr (0, c);
+                                                       if (s == X_("IsStart")) {
+                                                               session_range_location->set_start (loc->start(), true);
+                                                               add = false;
+                                                       } else if (s == X_("IsEnd")) {
+                                                               session_range_location->set_end (loc->start(), true);
+                                                               add = false;
+                                                       }
+
+                                                       if (c == string::npos) {
+                                                               break;
+                                                       }
+
+                                                       v = v.substr (c + 1);
+                                               }
+                                       }
+                               }
+
+                               if (add) {
+                                       new_locations.push_back (loc);
+                               }
                        }
 
                        catch (failed_constructor& err) {
@@ -707,15 +876,16 @@ Locations::set_state (const XMLNode& node, int /*version*/)
                        }
                }
 
-               if (locations.size()) {
+               locations = new_locations;
 
+               if (locations.size()) {
                        current_location = locations.front();
                } else {
                        current_location = 0;
                }
        }
 
-       changed (); /* EMIT SIGNAL */
+       changed (OTHER); /* EMIT SIGNAL */
 
        return 0;
 }
@@ -735,7 +905,7 @@ struct LocationStartLaterComparison
 };
 
 Location *
-Locations::first_location_before (nframes64_t frame, bool include_special_ranges)
+Locations::first_location_before (framepos_t frame, bool include_special_ranges)
 {
        LocationList locs;
 
@@ -762,7 +932,7 @@ Locations::first_location_before (nframes64_t frame, bool include_special_ranges
 }
 
 Location *
-Locations::first_location_after (nframes64_t frame, bool include_special_ranges)
+Locations::first_location_after (framepos_t frame, bool include_special_ranges)
 {
        LocationList locs;
 
@@ -789,16 +959,17 @@ 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 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;
 
        {
@@ -806,7 +977,9 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
                locs = locations;
        }
 
-       std::list<nframes64_t> positions;
+       /* Get a list of positions; don't store any that are exactly on our requested position */
+
+       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())) {
@@ -815,10 +988,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 ());
+                               }
                        }
                }
        }
@@ -829,7 +1008,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;
        }
@@ -846,27 +1025,16 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
                /* none before */
                return;
        }
-       
+
        --i;
        before = *i;
 }
 
 Location*
-Locations::end_location () const
-{
-       for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
-               if ((*i)->is_end()) {
-                       return const_cast<Location*> (*i);
-               }
-       }
-       return 0;
-}
-
-Location*
-Locations::start_location () const
+Locations::session_range_location () const
 {
        for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
-               if ((*i)->is_start()) {
+               if ((*i)->is_session_range()) {
                        return const_cast<Location*> (*i);
                }
        }
@@ -912,7 +1080,7 @@ Location *
 Locations::get_location_by_id(PBD::ID id)
 {
     LocationList::iterator it;
-    for (it  = locations.begin(); it != locations.end(); it++)
+    for (it  = locations.begin(); it != locations.end(); ++it)
         if (id == (*it)->id())
             return *it;
 
@@ -920,7 +1088,7 @@ 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);