libs/ardour/ardour/route_group.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_route_group_h__
  21 #define __ardour_route_group_h__
  22
  23 #include <list>
  24 #include <set>
  25 #include <string>
  26 #include <stdint.h>
  27
  28 #include "pbd/controllable.h"
  29 #include "pbd/signals.h"
  30 #include "pbd/stateful.h"
  31
  32 #include "ardour/control_group.h"
  33 #include "ardour/types.h"
  34 #include "ardour/session_object.h"
  35
  36 #include "ardour/libardour_visibility.h"
  37
  38 namespace ARDOUR {
  39
  40 namespace Properties {
  41         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_relative;
  42         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_gain;
  43         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_mute;
  44         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_solo;
  45         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_recenable;
  46         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_select;
  47         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_route_active;
  48         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_color;
  49         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> group_monitoring;
  50         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> active;
  51         /* we use these declared in region.cc */
  52         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
  53 };
  54
  55 class Route;
  56 class Track;
  57 class AudioTrack;
  58 class Session;
  59
  60 /** A group identifier for routes.
  61  *
  62  * RouteGroups permit to define properties which are shared
  63  * among all Routes that use the given identifier.
  64  *
  65  * A route can at most be in one group.
  66  */
  67 class LIBARDOUR_API RouteGroup : public SessionObject
  68 {
  69   public:
  70         static void make_property_quarks();
  71
  72         RouteGroup (Session& s, const std::string &n);
  73         ~RouteGroup ();
  74
  75         bool is_active () const { return _active.val(); }
  76         bool is_relative () const { return _relative.val(); }
  77         bool is_hidden () const { return _hidden.val(); }
  78         bool is_gain () const { return _gain.val(); }
  79         bool is_mute () const { return _mute.val(); }
  80         bool is_solo () const { return _solo.val(); }
  81         bool is_recenable () const { return _recenable.val(); }
  82         bool is_select () const { return _select.val(); }
  83         bool is_route_active () const { return _route_active.val(); }
  84         bool is_color () const { return _color.val(); }
  85         bool is_monitoring() const { return _monitoring.val(); }
  86
  87         bool empty() const {return routes->empty();}
  88         size_t size() const { return routes->size();}
  89
  90         gain_t get_max_factor(gain_t factor);
  91         gain_t get_min_factor(gain_t factor);
  92
  93         void set_active (bool yn, void *src);
  94         void set_relative (bool yn, void *src);
  95         void set_hidden (bool yn, void *src);
  96
  97         void set_gain (bool yn);
  98         void set_mute (bool yn);
  99         void set_solo (bool yn);
 100         void set_recenable (bool yn);
 101         void set_select (bool yn);
 102         void set_route_active (bool yn);
 103         void set_color (bool yn);
 104         void set_monitoring (bool yn);
 105
 106         bool enabled_property (PBD::PropertyID);
 107
 108         int add (boost::shared_ptr<Route>);
 109         int remove (boost::shared_ptr<Route>);
 110
 111         template<typename Function>
 112         void foreach_route (Function f) {
 113                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 114                         f (i->get());
 115                 }
 116         }
 117
 118         /* to use these, #include "ardour/route_group_specialized.h" */
 119
 120         template<class T> void apply (void (Track::*func)(T, PBD::Controllable::GroupControlDisposition), T val, PBD::Controllable::GroupControlDisposition);
 121
 122         /* fills at_set with all members of the group that are AudioTracks */
 123
 124         void audio_track_group (std::set<boost::shared_ptr<AudioTrack> >& at_set);
 125
 126         void clear () {
 127                 routes->clear ();
 128                 changed();
 129         }
 130
 131         bool has_subgroup() const;
 132         void make_subgroup (bool, Placement);
 133         void destroy_subgroup ();
 134
 135         boost::shared_ptr<RouteList> route_list() { return routes; }
 136
 137         /** Emitted when a route has been added to this group */
 138         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteAdded;
 139         /** Emitted when a route has been removed from this group */
 140         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteRemoved;
 141
 142         XMLNode& get_state ();
 143
 144         int set_state (const XMLNode&, int version);
 145
 146         void assign_master (boost::shared_ptr<VCA>);
 147         void unassign_master (boost::shared_ptr<VCA>);
 148         bool slaved () const;
 149
 150   private:
 151         boost::shared_ptr<RouteList> routes;
 152         boost::shared_ptr<Route> subgroup_bus;
 153         boost::weak_ptr<VCA> group_master;
 154
 155         PBD::Property<bool> _relative;
 156         PBD::Property<bool> _active;
 157         PBD::Property<bool> _hidden;
 158         PBD::Property<bool> _gain;
 159         PBD::Property<bool> _mute;
 160         PBD::Property<bool> _solo;
 161         PBD::Property<bool> _recenable;
 162         PBD::Property<bool> _select;
 163         PBD::Property<bool> _route_active;
 164         PBD::Property<bool> _color;
 165         PBD::Property<bool> _monitoring;
 166
 167         boost::shared_ptr<ControlGroup> _solo_group;
 168         boost::shared_ptr<ControlGroup> _mute_group;
 169         boost::shared_ptr<ControlGroup> _rec_enable_group;
 170         boost::shared_ptr<ControlGroup> _gain_group;
 171         boost::shared_ptr<ControlGroup> _monitoring_group;
 172
 173         void remove_when_going_away (boost::weak_ptr<Route>);
 174         int set_state_2X (const XMLNode&, int);
 175
 176         void post_set (PBD::PropertyChange const &);
 177         void push_to_groups ();
 178 };
 179
 180 } /* namespace */
 181
 182 #endif /* __ardour_route_group_h__ */