universal change in the design of the way Route/Track controls are designed and used...
[ardour.git] / libs / ardour / ardour / route_group.h
index d5e4b274e117b60ba71cee879d9e9f79628d1d02..feeac6a467cba170104ff4f87888ef191377c6cd 100644 (file)
 #include <string>
 #include <stdint.h>
 
+#include "pbd/controllable.h"
 #include "pbd/signals.h"
 #include "pbd/stateful.h"
-#include "pbd/signals.h"
 
+#include "ardour/control_group.h"
 #include "ardour/types.h"
 #include "ardour/session_object.h"
 
+#include "ardour/libardour_visibility.h"
+
 namespace ARDOUR {
 
 namespace Properties {
-       extern PBD::PropertyDescriptor<bool> relative;
-       extern PBD::PropertyDescriptor<bool> active;
-       extern PBD::PropertyDescriptor<bool> gain;
-       extern PBD::PropertyDescriptor<bool> mute;
-       extern PBD::PropertyDescriptor<bool> solo;
-       extern PBD::PropertyDescriptor<bool> recenable;
-       extern PBD::PropertyDescriptor<bool> select;
-       extern PBD::PropertyDescriptor<bool> edit;
+       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 */
-       extern PBD::PropertyDescriptor<bool> hidden;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
 };
 
 class Route;
@@ -52,11 +57,18 @@ class Track;
 class AudioTrack;
 class Session;
 
-class RouteGroup : public SessionObject 
+/** 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 ();
 
@@ -68,7 +80,9 @@ class RouteGroup : public SessionObject
        bool is_solo () const { return _solo.val(); }
        bool is_recenable () const { return _recenable.val(); }
        bool is_select () const { return _select.val(); }
-       bool is_edit () const { return _edit.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 empty() const {return routes->empty();}
        size_t size() const { return routes->size();}
@@ -85,46 +99,25 @@ class RouteGroup : public SessionObject
        void set_solo (bool yn);
        void set_recenable (bool yn);
        void set_select (bool yn);
-       void set_edit (bool yn);
+       void set_route_active (bool yn);
+       void set_color (bool yn);
+       void set_monitoring (bool yn);
 
        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);
-               }
-       }
-
-       void apply (void (Route::*func)()) {
-               for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-                       ((*i).get()->*func)();
-               }
-       }
-
-       template<class T> void apply (void (Route::*func)(T, void *), T val, void *src) {
+       template<typename Function>
+       void foreach_route (Function f) {
                for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-                       ((*i).get()->*func)(val, src);
-               }
-       }
-
-       template<class T> void apply (void (Route::*func)(T), T val) {
-               for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
-                       ((*i).get()->*func)(val);
-               }
-       }
-
-       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);
+                       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 */
 
@@ -135,19 +128,22 @@ class RouteGroup : public SessionObject
                changed();
        }
 
+        bool has_subgroup() const;
        void make_subgroup (bool, Placement);
        void destroy_subgroup ();
 
        boost::shared_ptr<RouteList> route_list() { return routes; }
 
-       /** Emitted when a route has been added to or removed from this group */
-       PBD::Signal0<void> MembershipChanged;
+       /** 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:
+
+  private:
        boost::shared_ptr<RouteList> routes;
        boost::shared_ptr<Route> subgroup_bus;
 
@@ -159,10 +155,21 @@ private:
        PBD::Property<bool> _solo;
        PBD::Property<bool> _recenable;
        PBD::Property<bool> _select;
-       PBD::Property<bool> _edit;
+       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 */