better handling of the inverse-push of solo-by-upstream. still not quite right, but...
[ardour.git] / libs / ardour / location.cc
index be34e343498920e29b9ff3bb29818b11d491be2c..f855cb75cffff6c67248eaf0befb18d3461b714d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <unistd.h>
 #include <cerrno>
 #include <ctime>
-#include <sigc++/bind.h>
+#include <list>
 
-#include <pbd/stl_delete.h>
-#include <pbd/xml++.h>
-#include <pbd/enumwriter.h>
 
-#include <ardour/location.h>
-#include <ardour/session.h>
-#include <ardour/audiofilesource.h>
+#include "pbd/stl_delete.h"
+#include "pbd/xml++.h"
+#include "pbd/enumwriter.h"
+
+#include "ardour/location.h"
+#include "ardour/session.h"
+#include "ardour/audiofilesource.h"
 
 #include "i18n.h"
 
 
 using namespace std;
 using namespace ARDOUR;
-using namespace sigc;
 using namespace PBD;
 
 Location::Location (const Location& other)
-       : _name (other._name),
+       : StatefulDestructible(),
+         _name (other._name),
          _start (other._start),
          _end (other._end),
          _flags (other._flags)
 {
-       /* start and end flags can never be copied, because there can only ever be one of each */
-
-       _flags = Flags (_flags & ~IsStart);
-       _flags = Flags (_flags & ~IsEnd);
-
        /* copy is not locked even if original was */
 
        _locked = false;
@@ -60,7 +56,7 @@ Location::Location (const Location& other)
 
 Location::Location (const XMLNode& node)
 {
-       if (set_state (node)) {
+       if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor ();
        }
 }
@@ -82,115 +78,87 @@ Location::operator= (const Location& other)
        _locked = false;
 
        /* "changed" not emitted on purpose */
-       
+
        return this;
 }
 
 int
-Location::set_start (nframes_t s)
+Location::set_start (nframes64_t s)
 {
        if (_locked) {
                return -1;
        }
 
+       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 ( 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;
-       }
-
+       
        if (s != _start) {
-               _start = s; 
-               start_changed(this); /* EMIT SIGNAL */
+               _start = s;
+               start_changed (this); /* EMIT SIGNAL */
+               if (is_session_range ()) {
+                       Session::StartTimeChanged (); /* EMIT SIGNAL */
+                       AudioFileSource::set_header_position_offset (s);
+               }
        }
 
        return 0;
 }
 
 int
-Location::set_end (nframes_t e)
+Location::set_end (nframes64_t e)
 {
        if (_locked) {
                return -1;
        }
 
+       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 ( 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()) && e <= _start) || e < _start) {
-               return -1;
-       }
-
        if (e != _end) {
-               _end = e; 
-                end_changed(this); /* EMIT SIGNAL */
+               _end = e;
+               end_changed(this); /* EMIT SIGNAL */
+
+               if (is_session_range()) {
+                       Session::EndTimeChanged (); /* EMIT SIGNAL */
+               }
        }
+
        return 0;
 }
 
 int
-Location::set (nframes_t start, nframes_t end)
+Location::set (nframes64_t start, nframes64_t end)
 {
-       if (_locked) {
-               return -1;
-       }
-
-       if (is_mark() && start != end) {
-               return -1;
-       } else if (((is_auto_punch() || is_auto_loop()) && start >= end) || (start > end)) {
-               return -1;
-       }
-       
-       if (_start != start) {
-               _start = start;
-               start_changed(this); /* EMIT SIGNAL */
-       }
+       int const s = set_start (start);
+       int const e = set_end (end);
 
-       if (_end != end) {
-               _end = end;
-               end_changed(this); /* EMIT SIGNAL */
-       }
-       return 0;
+       return (s == 0 && e == 0) ? 0 : -1;
 }
 
 int
-Location::move_to (nframes_t pos) 
+Location::move_to (nframes64_t pos)
 {
        if (_locked) {
                return -1;
@@ -199,10 +167,10 @@ Location::move_to (nframes_t pos)
        if (_start != pos) {
                _start = pos;
                _end = _start + length();
-               
+
                changed (this); /* EMIT SIGNAL */
        }
-       
+
        return 0;
 }
 
@@ -230,22 +198,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)
 {
@@ -255,7 +207,7 @@ Location::set_is_range_marker (bool yn, void *src)
 }
 
 void
-Location::set_auto_punch (bool yn, void *src) 
+Location::set_auto_punch (bool yn, void *src)
 {
        if (is_mark() || _start == _end) {
                return;
@@ -267,7 +219,7 @@ Location::set_auto_punch (bool yn, void *src)
 }
 
 void
-Location::set_auto_loop (bool yn, void *src) 
+Location::set_auto_loop (bool yn, void *src)
 {
        if (is_mark() || _start == _end) {
                return;
@@ -303,7 +255,7 @@ Location::set_mark (bool yn)
        if (_start != _end) {
                return;
        }
-       
+
        set_flag_internal (yn, IsMark);
 }
 
@@ -315,11 +267,11 @@ Location::cd_info_node(const string & name, const string & value)
 
        root->add_property("name", name);
        root->add_property("value", value);
-       
+
        return *root;
 }
 
+
 XMLNode&
 Location::get_state (void)
 {
@@ -335,9 +287,9 @@ Location::get_state (void)
        id().print (buf, sizeof (buf));
        node->add_property("id", buf);
        node->add_property ("name", name());
-       snprintf (buf, sizeof (buf), "%u", start());
+       snprintf (buf, sizeof (buf), "%" PRId64, start());
        node->add_property ("start", buf);
-       snprintf (buf, sizeof (buf), "%u", end());
+       snprintf (buf, sizeof (buf), "%" PRId64, end());
        node->add_property ("end", buf);
        node->add_property ("flags", enum_2_string (_flags));
        node->add_property ("locked", (_locked ? "yes" : "no"));
@@ -346,14 +298,14 @@ Location::get_state (void)
 }
 
 int
-Location::set_state (const XMLNode& node)
+Location::set_state (const XMLNode& node, int /*version*/)
 {
        const XMLProperty *prop;
 
        XMLNodeList cd_list = node.children();
        XMLNodeConstIterator cd_iter;
        XMLNode *cd_node;
-       
+
        string cd_name;
        string cd_value;
 
@@ -372,67 +324,67 @@ Location::set_state (const XMLNode& node)
                error << _("XML node for Location has no name information") << endmsg;
                return -1;
        }
-               
+
        set_name (prop->value());
-               
+
        if ((prop = node.property ("start")) == 0) {
-               error << _("XML node for Location has no start information") << endmsg; 
+               error << _("XML node for Location has no start information") << endmsg;
                return -1;
        }
-               
+
                /* can't use set_start() here, because _end
                   may make the value of _start illegal.
                */
-               
-       _start = atoi (prop->value().c_str());
-               
+
+       sscanf (prop->value().c_str(), "%" PRId64, &_start);
+
        if ((prop = node.property ("end")) == 0) {
-                 error << _("XML node for Location has no end information") << endmsg; 
+                 error << _("XML node for Location has no end information") << endmsg;
                  return -1;
        }
-               
-       _end = atoi (prop->value().c_str());
-               
+
+       sscanf (prop->value().c_str(), "%" PRId64, &_end);
+
        if ((prop = node.property ("flags")) == 0) {
-                 error << _("XML node for Location has no flags information") << endmsg; 
+                 error << _("XML node for Location has no flags information") << endmsg;
                  return -1;
        }
-               
+
        _flags = Flags (string_2_enum (prop->value(), _flags));
 
        if ((prop = node.property ("locked")) != 0) {
-               _locked = (prop->value() == "yes");
+               _locked = string_is_affirmative (prop->value());
        } else {
                _locked = false;
        }
 
        for (cd_iter = cd_list.begin(); cd_iter != cd_list.end(); ++cd_iter) {
-                 
+
                  cd_node = *cd_iter;
-                 
+
                  if (cd_node->name() != "CD-Info") {
                    continue;
                  }
-                 
+
                  if ((prop = cd_node->property ("name")) != 0) {
                    cd_name = prop->value();
                  } else {
                    throw failed_constructor ();
                  }
-                 
+
                  if ((prop = cd_node->property ("value")) != 0) {
                    cd_value = prop->value();
                  } else {
                    throw failed_constructor ();
                  }
-                 
-                 
+
+
                  cd_info[cd_name] = cd_value;
-                 
+
        }
 
        changed(this); /* EMIT SIGNAL */
-               
+
        return 0;
 }
 
@@ -444,7 +396,7 @@ Locations::Locations ()
        current_location = 0;
 }
 
-Locations::~Locations () 
+Locations::~Locations ()
 {
        for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
                LocationList::iterator tmp = i;
@@ -498,7 +450,7 @@ Locations::next_available_name(string& result,string base)
                }
        }
        for (int k=1; k<=SUFFIX_MAX; k++) {
-               if (available[k]) { 
+               if (available[k]) {
                        snprintf (buf, 31, "%d", k);
                        result += buf;
                        return 1;
@@ -514,7 +466,7 @@ Locations::set_current_unlocked (Location *loc)
                error << _("Locations: attempt to use unknown location as selected location") << endmsg;
                return -1;
        }
-       
+
        current_location = loc;
        return 0;
 }
@@ -530,7 +482,7 @@ Locations::clear ()
                        LocationList::iterator tmp = i;
                        ++tmp;
 
-                       if (!(*i)->is_end() && !(*i)->is_start()) {
+                       if (!(*i)->is_session_range()) {
                                locations.erase (i);
                        }
 
@@ -542,7 +494,7 @@ Locations::clear ()
 
        changed (); /* EMIT SIGNAL */
        current_changed (0); /* EMIT SIGNAL */
-}      
+}
 
 void
 Locations::clear_markers ()
@@ -555,7 +507,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);
                        }
 
@@ -564,7 +516,7 @@ Locations::clear_markers ()
        }
 
        changed (); /* EMIT SIGNAL */
-}      
+}
 
 void
 Locations::clear_ranges ()
@@ -572,7 +524,7 @@ Locations::clear_ranges ()
        {
                Glib::Mutex::Lock lm (lock);
                LocationList::iterator tmp;
-               
+
                for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
 
                        tmp = i;
@@ -591,7 +543,7 @@ Locations::clear_ranges ()
 
        changed (); /* EMIT SIGNAL */
        current_changed (0); /* EMIT SIGNAL */
-}      
+}
 
 void
 Locations::add (Location *loc, bool make_current)
@@ -604,12 +556,12 @@ Locations::add (Location *loc, bool make_current)
                        current_location = loc;
                }
        }
-       
+
        added (loc); /* EMIT SIGNAL */
 
        if (make_current) {
                 current_changed (current_location); /* EMIT SIGNAL */
-       } 
+       }
 }
 
 void
@@ -620,7 +572,7 @@ Locations::remove (Location *loc)
        bool was_current = false;
        LocationList::iterator i;
 
-       if (loc->is_end() || loc->is_start()) {
+       if (loc->is_session_range()) {
                return;
        }
 
@@ -639,9 +591,9 @@ Locations::remove (Location *loc)
                        }
                }
        }
-       
+
        if (was_removed) {
-               
+
                removed (loc); /* EMIT SIGNAL */
 
                if (was_current) {
@@ -653,7 +605,7 @@ Locations::remove (Location *loc)
 }
 
 void
-Locations::location_changed (Location* loc)
+Locations::location_changed (Location* /*loc*/)
 {
        changed (); /* EMIT SIGNAL */
 }
@@ -664,48 +616,83 @@ Locations::get_state ()
        XMLNode *node = new XMLNode ("Locations");
        LocationList::iterator iter;
        Glib::Mutex::Lock lm (lock);
-       
+
        for (iter  = locations.begin(); iter != locations.end(); ++iter) {
                node->add_child_nocopy ((*iter)->get_state ());
        }
 
        return *node;
-}      
+}
 
 int
-Locations::set_state (const XMLNode& node)
+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();
 
        locations.clear ();
        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);
+       }
+
        {
                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);
+
+                               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());
+                                                               add = false;
+                                                       } else if (s == X_("IsEnd")) {
+                                                               session_range_location->set_end (loc->start());
+                                                               add = false;
+                                                       }
+
+                                                       if (c == string::npos) {
+                                                               break;
+                                                       }
+
+                                                       v = v.substr (c + 1);
+                                               }
+                                       }
+                               }
+
+                               if (add) {
+                                       locations.push_back (loc);
+                               }
                        }
 
                        catch (failed_constructor& err) {
                                error << _("could not load location from session file - ignored") << endmsg;
                        }
                }
-               
-               if (locations.size()) {
 
+               if (locations.size()) {
                        current_location = locations.front();
                } else {
                        current_location = 0;
@@ -713,18 +700,18 @@ Locations::set_state (const XMLNode& node)
        }
 
        changed (); /* EMIT SIGNAL */
-        
+
        return 0;
-}      
+}
 
-struct LocationStartEarlierComparison 
+struct LocationStartEarlierComparison
 {
     bool operator() (Location *a, Location *b) {
        return a->start() < b->start();
     }
 };
 
-struct LocationStartLaterComparison 
+struct LocationStartLaterComparison
 {
     bool operator() (Location *a, Location *b) {
        return a->start() > b->start();
@@ -732,7 +719,7 @@ struct LocationStartLaterComparison
 };
 
 Location *
-Locations::first_location_before (nframes_t frame, bool include_special_ranges)
+Locations::first_location_before (nframes64_t frame, bool include_special_ranges)
 {
        LocationList locs;
 
@@ -745,7 +732,7 @@ Locations::first_location_before (nframes_t frame, bool include_special_ranges)
        locs.sort (cmp);
 
        /* locs is now sorted latest..earliest */
-       
+
        for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
                if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
                        continue;
@@ -759,7 +746,7 @@ Locations::first_location_before (nframes_t frame, bool include_special_ranges)
 }
 
 Location *
-Locations::first_location_after (nframes_t frame, bool include_special_ranges)
+Locations::first_location_after (nframes64_t frame, bool include_special_ranges)
 {
        LocationList locs;
 
@@ -772,7 +759,7 @@ Locations::first_location_after (nframes_t frame, bool include_special_ranges)
        locs.sort (cmp);
 
        /* locs is now sorted earliest..latest */
-       
+
        for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
                if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
                        continue;
@@ -785,107 +772,79 @@ Locations::first_location_after (nframes_t frame, bool include_special_ranges)
        return 0;
 }
 
-nframes_t
-Locations::first_mark_before (nframes_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.
+ *  @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)
+ */
+void
+Locations::marks_either_side (nframes64_t const frame, nframes64_t& before, nframes64_t& after) const
 {
+       before = after = max_frames;
+       
        LocationList locs;
 
        {
-        Glib::Mutex::Lock lm (lock);
+               Glib::Mutex::Lock lm (lock);
                locs = locations;
        }
 
-       LocationStartLaterComparison cmp;
-       locs.sort (cmp);
+       std::list<nframes64_t> positions;
 
-       /* locs is now sorted latest..earliest */
-       
-       for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
-               if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
+       for (LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
+               if (((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
                        continue;
                }
+
                if (!(*i)->is_hidden()) {
-                       if ((*i)->is_mark()) {
-                               /* MARK: start == end */
-                               if ((*i)->start() < frame) {
-                                       return (*i)->start();
-                               }
+                       if ((*i)->is_mark ()) {
+                               positions.push_back ((*i)->start ());
                        } else {
-                               /* RANGE: start != end, compare start and end */
-                               if ((*i)->end() < frame) {
-                                       return (*i)->end();
-                               }
-                               if ((*i)->start () < frame) {
-                                       return (*i)->start();
-                               }
+                               positions.push_back ((*i)->start ());
+                               positions.push_back ((*i)->end ());
                        }
                }
        }
 
-       return 0;
-}
+       if (positions.empty ()) {
+               return;
+       }
 
-nframes_t
-Locations::first_mark_after (nframes_t frame, bool include_special_ranges)
-{
-       LocationList locs;
+       positions.sort ();
 
-       {
-        Glib::Mutex::Lock lm (lock);
-               locs = locations;
+       std::list<nframes64_t>::iterator i = positions.begin ();
+       while (i != positions.end () && *i < frame) {
+               ++i;
        }
 
-       LocationStartEarlierComparison cmp;
-       locs.sort (cmp);
-
-       /* locs is now sorted earliest..latest */
-       
-       for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
-               if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
-                       continue;
-               }
-               if (!(*i)->is_hidden()) {
-                       if ((*i)->is_mark()) {
-                               /* MARK, start == end so just compare start */
-                               if ((*i)->start() > frame) {
-                                       return (*i)->start();
-                               }
-                       } else {
-                               /* RANGE, start != end, compare start and end */
-                               if ((*i)->start() > frame ) {
-                                       return (*i)->start ();
-                               }
-                               if ((*i)->end() > frame) {
-                                       return (*i)->end ();
-                               }
-                       }
-               }
+       if (i == positions.end ()) {
+               /* run out of marks */
+               before = positions.back ();
+               return;
        }
 
-       return max_frames;
-}
+       after = *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);
-               }
+       if (i == positions.begin ()) {
+               /* none before */
+               return;
        }
-       return 0;
-}      
+       
+       --i;
+       before = *i;
+}
 
 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);
                }
        }
        return 0;
-}      
+}
 
 Location*
 Locations::auto_loop_location () const
@@ -896,7 +855,7 @@ Locations::auto_loop_location () const
                }
        }
        return 0;
-}      
+}
 
 Location*
 Locations::auto_punch_location () const
@@ -907,7 +866,7 @@ Locations::auto_punch_location () const
                }
        }
        return 0;
-}      
+}
 
 uint32_t
 Locations::num_range_markers () const
@@ -926,7 +885,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;
 
@@ -939,7 +898,7 @@ Locations::find_all_between (nframes64_t start, nframes64_t end, LocationList& l
        Glib::Mutex::Lock lm (lock);
 
        for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
-               if ((flags == 0 || (*i)->matches (flags)) && 
+               if ((flags == 0 || (*i)->matches (flags)) &&
                    ((*i)->start() >= start && (*i)->end() < end)) {
                        ll.push_back (*i);
                }