Fix problem with multiple timespan export. Most probably originated in r13305.
[ardour.git] / libs / ardour / location.cc
index 3f62d8949d255b103bc0c0d387b875839ef0df7c..2a27fc318a9d986a3afc00fdda2f5082fee1d98d 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,23 +42,82 @@ 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)
+{
+       assert (_start >= 0);
+       assert (_end >= 0);
+}
+
+/** 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)
-       : 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;
+
+       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);
+}
+
+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*
@@ -70,8 +129,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 */
 
@@ -79,16 +141,24 @@ 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, bool force)
+Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
 {
+       if (s < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -103,31 +173,52 @@ Location::set_start (nframes64_t s, bool force)
                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 */
                }
+
+               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;
 }
 
 /** 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, bool force)
+Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
 {
+       if (e < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -137,47 +228,70 @@ Location::set_end (nframes64_t e, bool force)
                        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 */
                }
+
+               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 ();
+               }
                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)
+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;
        }
 
        /* now we know these values are ok, so force-set them */
-       int const s = set_start (start, true);
-       int const e = set_end (end, true);
+       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;
 }
 
 int
-Location::move_to (nframes64_t pos)
+Location::move_to (framepos_t pos)
 {
+       if (pos < 0) {
+               return -1;
+       }
+
        if (_locked) {
                return -1;
        }
@@ -185,10 +299,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;
 }
 
@@ -291,7 +409,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];
@@ -311,6 +429,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;
 }
@@ -332,10 +451,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) {
@@ -381,35 +498,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;
 
-Locations::Locations ()
+       recompute_bbt_from_frames ();
+
+       PositionLockStyleChanged (this); /* EMIT SIGNAL */
+}
 
+void
+Location::recompute_bbt_from_frames ()
+{
+       if (_position_lock_style != MusicTime) {
+               return;
+       }
+
+       _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;
 }
@@ -426,12 +601,11 @@ Locations::~Locations ()
 
 int
 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);
@@ -493,7 +667,7 @@ void
 Locations::clear ()
 {
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
 
                for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
 
@@ -518,7 +692,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(); ) {
@@ -540,7 +714,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(); ) {
@@ -567,9 +741,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) {
@@ -582,6 +756,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
@@ -596,7 +775,7 @@ 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) {
@@ -634,9 +813,9 @@ 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) {
+       for (iter = locations.begin(); iter != locations.end(); ++iter) {
                node->add_child_nocopy ((*iter)->get_state ());
        }
 
@@ -653,24 +832,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 (0, 0, _("session"), Location::IsSessionRange);
-               locations.push_back (session_range_location);
+               session_range_location = new Location (_session, 0, 0, _("session"), Location::IsSessionRange);
+               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 (**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;
 
@@ -685,10 +882,10 @@ Locations::set_state (const XMLNode& node, int version)
                                                        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());
+                                                               session_range_location->set_start (loc->start(), true);
                                                                add = false;
                                                        } else if (s == X_("IsEnd")) {
-                                                               session_range_location->set_end (loc->start());
+                                                               session_range_location->set_end (loc->start(), true);
                                                                add = false;
                                                        }
 
@@ -702,7 +899,7 @@ Locations::set_state (const XMLNode& node, int version)
                                }
 
                                if (add) {
-                                       locations.push_back (loc);
+                                       new_locations.push_back (loc);
                                }
                        }
 
@@ -711,6 +908,8 @@ Locations::set_state (const XMLNode& node, int version)
                        }
                }
 
+               locations = new_locations;
+
                if (locations.size()) {
                        current_location = locations.front();
                } else {
@@ -723,93 +922,111 @@ 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)
+framepos_t
+Locations::first_mark_after (framepos_t frame, bool include_special_ranges)
 {
-       LocationList locs;
+       Glib::Threads::Mutex::Lock lm (lock);
+       vector<LocationPair> locs;
 
-       {
-               Glib::Mutex::Lock lm (lock);
-               locs = locations;
+       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;
-       locs.sort (cmp);
-
-       /* locs is now sorted earliest..latest */
+       sort (locs.begin(), locs.end(), cmp);
+       
+       /* locs is sorted in reverse 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 (!(*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.
+ *  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;
 
        {
-               Glib::Mutex::Lock lm (lock);
+               Glib::Threads::Mutex::Lock lm (lock);
                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())) {
@@ -818,10 +1035,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 ());
+                               }
                        }
                }
        }
@@ -832,7 +1055,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;
        }
@@ -849,7 +1072,7 @@ Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nfra
                /* none before */
                return;
        }
-       
+
        --i;
        before = *i;
 }
@@ -891,7 +1114,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;
@@ -912,9 +1135,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)) &&