universal change in the design of the way Route/Track controls are designed and used...
[ardour.git] / libs / ardour / ardour / route_group.h
index fe4079050d754971d0cdc00c53f096c0e64ef886..feeac6a467cba170104ff4f87888ef191377c6cd 100644 (file)
 #include <set>
 #include <string>
 #include <stdint.h>
-#include <boost/signals2.hpp>
 
+#include "pbd/controllable.h"
+#include "pbd/signals.h"
 #include "pbd/stateful.h"
-#include "pbd/scoped_connections.h"
 
+#include "ardour/control_group.h"
 #include "ardour/types.h"
+#include "ardour/session_object.h"
+
+#include "ardour/libardour_visibility.h"
 
 namespace ARDOUR {
 
+namespace Properties {
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> relative;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> active;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> gain;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> mute;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> solo;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> recenable;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> select;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> route_active;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> color;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> monitoring;
+       /* we use this, but its declared in region.cc */
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
+};
+
 class Route;
 class Track;
 class AudioTrack;
 class Session;
 
-class RouteGroup : public PBD::Stateful, public PBD::ScopedConnectionList {
-public:
-       enum Flag {
-               Relative = 0x1,
-               Active = 0x2,
-               Hidden = 0x4
-       };
-
-       enum Property {
-               Gain = 0x1,
-               Mute = 0x2,
-               Solo = 0x4,
-               RecEnable = 0x8,
-               Select = 0x10,
-               Edit = 0x20
-       };
-
-       RouteGroup (Session& s, const std::string &n, Flag f = Flag(0), Property p = Property(0));
+/** A group identifier for routes.
+ *
+ * RouteGroups permit to define properties which are shared
+ * among all Routes that use the given identifier.
+ *
+ * A route can at most be in one group.
+ */
+class LIBARDOUR_API RouteGroup : public SessionObject
+{
+  public:
+       static void make_property_quarks();
+
+       RouteGroup (Session& s, const std::string &n);
        ~RouteGroup ();
 
-       const std::string& name() { return _name; }
-       void set_name (std::string str);
+       bool is_active () const { return _active.val(); }
+       bool is_relative () const { return _relative.val(); }
+       bool is_hidden () const { return _hidden.val(); }
+       bool is_gain () const { return _gain.val(); }
+       bool is_mute () const { return _mute.val(); }
+       bool is_solo () const { return _solo.val(); }
+       bool is_recenable () const { return _recenable.val(); }
+       bool is_select () const { return _select.val(); }
+       bool is_route_active () const { return _route_active.val(); }
+       bool is_color () const { return _color.val(); }
+       bool is_monitoring() const { return _monitoring.val(); }
 
-       bool is_active () const { return _flags & Active; }
-       bool is_relative () const { return _flags & Relative; }
-       bool is_hidden () const { return _flags & Hidden; }
        bool empty() const {return routes->empty();}
        size_t size() const { return routes->size();}
 
@@ -74,45 +94,30 @@ public:
        void set_relative (bool yn, void *src);
        void set_hidden (bool yn, void *src);
 
-       bool property (Property p) const {
-               return ((_properties & p) == p);
-       }
+       void set_gain (bool yn);
+       void set_mute (bool yn);
+       void set_solo (bool yn);
+       void set_recenable (bool yn);
+       void set_select (bool yn);
+       void set_route_active (bool yn);
+       void set_color (bool yn);
+       void set_monitoring (bool yn);
 
-       bool active_property (Property p) const {
-               return is_active() && property (p);
-       }
-
-       void set_property (Property p, bool v) {
-               _properties = (Property) (_properties & ~p);
-               if (v) {
-                       _properties = (Property) (_properties | p);
-               }
-       }
+       bool enabled_property (PBD::PropertyID);
 
        int add (boost::shared_ptr<Route>);
        int remove (boost::shared_ptr<Route>);
 
-       void apply (void (Route::*func)(void *), void *src) {
-               for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
-                       ((*i).get()->*func)(src);
-               }
-       }
-
-       template<class T> void apply (void (Route::*func)(T, void *), T val, void *src) {
-               for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
-                       ((*i).get()->*func)(val, src);
-               }
-       }
-
-       template<class T> void foreach_route (T *obj, void (T::*func)(Route&)) {
-               for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
-                       (obj->*func)(**i);
+       template<typename Function>
+       void foreach_route (Function f) {
+               for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+                       f (i->get());
                }
        }
 
        /* to use these, #include "ardour/route_group_specialized.h" */
 
-       template<class T> void apply (void (Track::*func)(T, void *), T val, void *src);
+       template<class T> void apply (void (Track::*func)(T, PBD::Controllable::GroupControlDisposition), T val, PBD::Controllable::GroupControlDisposition);
 
        /* fills at_set with all members of the group that are AudioTracks */
 
@@ -123,28 +128,48 @@ public:
                changed();
        }
 
-       void make_subgroup ();
+        bool has_subgroup() const;
+       void make_subgroup (bool, Placement);
        void destroy_subgroup ();
 
        boost::shared_ptr<RouteList> route_list() { return routes; }
 
-       boost::signals2::signal<void()> changed;
-       boost::signals2::signal<void(void*)> FlagsChanged;
+       /** Emitted when a route has been added to this group */
+       PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteAdded;
+       /** Emitted when a route has been removed from this group */
+       PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteRemoved;
 
        XMLNode& get_state ();
-       
+
        int set_state (const XMLNode&, int version);
-       
-private:
-       Session& _session;
+
+  private:
        boost::shared_ptr<RouteList> routes;
        boost::shared_ptr<Route> subgroup_bus;
-       std::string _name;
-       Flag _flags;
-       Property _properties;
+
+       PBD::Property<bool> _relative;
+       PBD::Property<bool> _active;
+       PBD::Property<bool> _hidden;
+       PBD::Property<bool> _gain;
+       PBD::Property<bool> _mute;
+       PBD::Property<bool> _solo;
+       PBD::Property<bool> _recenable;
+       PBD::Property<bool> _select;
+       PBD::Property<bool> _route_active;
+       PBD::Property<bool> _color;
+       PBD::Property<bool> _monitoring;
+
+       boost::shared_ptr<ControlGroup> _solo_group;
+       boost::shared_ptr<ControlGroup> _mute_group;
+       boost::shared_ptr<ControlGroup> _rec_enable_group;
+       boost::shared_ptr<ControlGroup> _gain_group;
+       boost::shared_ptr<ControlGroup> _monitoring_group;
 
        void remove_when_going_away (boost::weak_ptr<Route>);
        int set_state_2X (const XMLNode&, int);
+
+       void post_set (PBD::PropertyChange const &);
+       void push_to_groups ();
 };
 
 } /* namespace */