/*
- 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
#ifndef __ardour_route_group_h__
#include <set>
#include <string>
#include <stdint.h>
-#include <sigc++/signal.h>
-#include <pbd/stateful.h>
-#include <ardour/types.h>
-using std::string;
-using std::list;
+#include "pbd/controllable.h"
+#include "pbd/signals.h"
+#include "pbd/stateful.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> group_relative;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_gain;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_mute;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_solo;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_recenable;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_select;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_route_active;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_color;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_monitoring;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> active;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<int32_t> group_master_number;
+ /* we use these declared in region.cc */
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
+};
+
class Route;
+class Track;
class AudioTrack;
class Session;
-class RouteGroup : public Stateful, public sigc::trackable {
- public:
- enum Flag {
- Relative = 0x1,
- Active = 0x2,
- Hidden = 0x4,
- };
-
- RouteGroup (Session& s, const string &n, Flag f = Flag(0));
-
- const string& name() { return _name; }
- void set_name (std::string str);
-
- 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();}
-
- gain_t get_max_factor(gain_t factor);
- gain_t get_min_factor(gain_t factor);
-
- int size() { return routes.size();}
- ARDOUR::Route * first () const { return *routes.begin();}
-
- void set_active (bool yn, void *src);
- void set_relative (bool yn, void *src);
- void set_hidden (bool yn, void *src);
-
- int add (Route *);
-
- int remove (Route *);
-
- void apply (void (Route::*func)(void *), void *src) {
- for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
- ((*i)->*func)(src);
- }
- }
-
- template<class T> void apply (void (Route::*func)(T, void *), T val, void *src) {
- for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
- ((*i)->*func)(val, src);
- }
- }
-
- template<class T> void foreach_route (T *obj, void (T::*func)(Route&)) {
- for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
- (obj->*func)(**i);
- }
- }
-
- /* to use these, #include <ardour/route_group_specialized.h> */
-
- template<class T> void apply (void (AudioTrack::*func)(T, void *), T val, void *src);
-
- /* fills at_set with all members of the group that are AudioTracks */
-
- void audio_track_group (std::set<AudioTrack*>& at_set);
-
- void clear () {
- routes.clear ();
- changed();
- }
-
- const list<Route*>& route_list() { return routes; }
-
- sigc::signal<void> changed;
- sigc::signal<void,void*> FlagsChanged;
-
- XMLNode& get_state (void);
+/** 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 ();
+
+ 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(); }
+ int32_t group_master_number() const { return _group_master_number.val(); }
+
+ bool empty() const {return routes->empty();}
+ size_t size() const { return routes->size();}
+
+ gain_t get_max_factor(gain_t factor);
+ gain_t get_min_factor(gain_t factor);
+
+ void set_active (bool yn, void *src);
+ void set_relative (bool yn, void *src);
+ void set_hidden (bool yn, void *src);
+
+ 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 enabled_property (PBD::PropertyID);
+
+ int add (boost::shared_ptr<Route>);
+ int remove (boost::shared_ptr<Route>);
+
+ 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, PBD::Controllable::GroupControlDisposition), T val, PBD::Controllable::GroupControlDisposition);
+
+ /* fills at_set with all members of the group that are AudioTracks */
+
+ void audio_track_group (std::set<boost::shared_ptr<AudioTrack> >& at_set);
+
+ void clear () {
+ routes->clear ();
+ 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 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);
+
+ void assign_master (boost::shared_ptr<VCA>);
+ void unassign_master (boost::shared_ptr<VCA>);
+ bool has_control_master() const;
+ bool slaved () const;
+
+ uint32_t rgba () const { return _rgba; }
+
+ /** set route-group color and notify UI about change */
+ void set_rgba (uint32_t);
+
+ /* directly set color only, used to convert old 5.x gui-object-state
+ * to libardour color */
+ void migrate_rgba (uint32_t color) { _rgba = color; }
+
+private:
+ boost::shared_ptr<RouteList> routes;
+ boost::shared_ptr<Route> subgroup_bus;
+ boost::weak_ptr<VCA> group_master;
+
+ 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;
+ PBD::Property<int32_t> _group_master_number;
+
+ 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;
- int set_state (const XMLNode&);
+ void remove_when_going_away (boost::weak_ptr<Route>);
+ int set_state_2X (const XMLNode&, int);
- private:
- Session& _session;
- list<Route *> routes;
- string _name;
- uint32_t _flags;
+ void post_set (PBD::PropertyChange const &);
+ void push_to_groups ();
- void remove_when_going_away (Route*);
+ uint32_t _rgba;
+ bool _used_to_share_gain;
};
} /* namespace */