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/signals.h"
  29 #include "pbd/stateful.h"
  30 #include "pbd/signals.h"
  31
  32 #include "ardour/libardour_visibility.h"
  33 #include "ardour/types.h"
  34 #include "ardour/session_object.h"
  35
  36 namespace ARDOUR {
  37
  38 namespace Properties {
  39         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> relative;
  40         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> active;
  41         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> gain;
  42         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> mute;
  43         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> solo;
  44         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> recenable;
  45         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> select;
  46         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> route_active;
  47         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> color;
  48         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> monitoring;
  49         /* we use this, but its declared in region.cc */
  50         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
  51 };
  52
  53 class Route;
  54 class Track;
  55 class AudioTrack;
  56 class Session;
  57
  58 class LIBARDOUR_API RouteGroup : public SessionObject
  59 {
  60   public:
  61         static void make_property_quarks();
  62
  63         RouteGroup (Session& s, const std::string &n);
  64         ~RouteGroup ();
  65
  66         bool is_active () const { return _active.val(); }
  67         bool is_relative () const { return _relative.val(); }
  68         bool is_hidden () const { return _hidden.val(); }
  69         bool is_gain () const { return _gain.val(); }
  70         bool is_mute () const { return _mute.val(); }
  71         bool is_solo () const { return _solo.val(); }
  72         bool is_recenable () const { return _recenable.val(); }
  73         bool is_select () const { return _select.val(); }
  74         bool is_route_active () const { return _route_active.val(); }
  75         bool is_color () const { return _color.val(); }
  76         bool is_monitoring() const { return _monitoring.val(); }
  77
  78         bool empty() const {return routes->empty();}
  79         size_t size() const { return routes->size();}
  80
  81         gain_t get_max_factor(gain_t factor);
  82         gain_t get_min_factor(gain_t factor);
  83
  84         void set_active (bool yn, void *src);
  85         void set_relative (bool yn, void *src);
  86         void set_hidden (bool yn, void *src);
  87
  88         void set_gain (bool yn);
  89         void set_mute (bool yn);
  90         void set_solo (bool yn);
  91         void set_recenable (bool yn);
  92         void set_select (bool yn);
  93         void set_route_active (bool yn);
  94         void set_color (bool yn);
  95         void set_monitoring (bool yn);
  96
  97         bool enabled_property (PBD::PropertyID);
  98
  99         int add (boost::shared_ptr<Route>);
 100         int remove (boost::shared_ptr<Route>);
 101
 102         template<typename Function>
 103         void foreach_route (Function f) {
 104                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 105                         f (i->get());
 106                 }
 107         }
 108
 109         /* to use these, #include "ardour/route_group_specialized.h" */
 110
 111         template<class T> void apply (void (Track::*func)(T, void *), T val, void *src);
 112
 113         /* fills at_set with all members of the group that are AudioTracks */
 114
 115         void audio_track_group (std::set<boost::shared_ptr<AudioTrack> >& at_set);
 116
 117         void clear () {
 118                 routes->clear ();
 119                 changed();
 120         }
 121
 122         bool has_subgroup() const;
 123         void make_subgroup (bool, Placement);
 124         void destroy_subgroup ();
 125
 126         boost::shared_ptr<RouteList> route_list() { return routes; }
 127
 128         /** Emitted when a route has been added to this group */
 129         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteAdded;
 130         /** Emitted when a route has been removed from this group */
 131         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<ARDOUR::Route> > RouteRemoved;
 132
 133         XMLNode& get_state ();
 134
 135         int set_state (const XMLNode&, int version);
 136
 137 private:
 138         boost::shared_ptr<RouteList> routes;
 139         boost::shared_ptr<Route> subgroup_bus;
 140
 141         PBD::Property<bool> _relative;
 142         PBD::Property<bool> _active;
 143         PBD::Property<bool> _hidden;
 144         PBD::Property<bool> _gain;
 145         PBD::Property<bool> _mute;
 146         PBD::Property<bool> _solo;
 147         PBD::Property<bool> _recenable;
 148         PBD::Property<bool> _select;
 149         PBD::Property<bool> _route_active;
 150         PBD::Property<bool> _color;
 151         PBD::Property<bool> _monitoring;
 152
 153         void remove_when_going_away (boost::weak_ptr<Route>);
 154         int set_state_2X (const XMLNode&, int);
 155 };
 156
 157 } /* namespace */
 158
 159 #endif /* __ardour_route_group_h__ */