2 Copyright (C) 2016 Paul Davis
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.
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.
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.
20 #ifndef __libardour_stripable_h__
21 #define __libardour_stripable_h__
26 #include <boost/utility.hpp>
27 #include <boost/shared_ptr.hpp>
29 #include "pbd/signals.h"
31 #include "ardour/presentation_info.h"
32 #include "ardour/session_object.h"
33 #include "ardour/libardour_visibility.h"
37 class AutomationControl;
43 class SoloIsolateControl;
44 class SoloSafeControl;
46 class MonitorProcessor;
48 /* This is a virtual base class for any object that needs to be potentially
49 * represented by a control-centric user interface using the general model of a
50 * mixing console "strip" - a collection of controls that determine the state
51 * and behaviour of the object.
54 class LIBARDOUR_API Stripable : public SessionObject {
56 Stripable (Session& session, std::string const & name, PresentationInfo const &);
57 virtual ~Stripable () {}
63 bool is_auditioner() const { return _presentation_info.flags() & PresentationInfo::Auditioner; }
64 bool is_master() const { return _presentation_info.flags() & PresentationInfo::MasterOut; }
65 bool is_monitor() const { return _presentation_info.flags() & PresentationInfo::MonitorOut; }
67 int set_state (XMLNode const&, int);
69 bool is_hidden() const { return _presentation_info.flags() & PresentationInfo::Hidden; }
70 bool is_selected() const { return _presentation_info.flags() & PresentationInfo::Selected; }
72 PresentationInfo const & presentation_info () const { return _presentation_info; }
73 PresentationInfo& presentation_info () { return _presentation_info; }
75 /* set just the order */
77 void set_presentation_group_order (PresentationInfo::order_t, bool notify_class_listeners = true);
78 void set_presentation_group_order_explicit (PresentationInfo::order_t);
80 /* for things concerned about *this* route's RID */
82 PBD::Signal0<void> PresentationInfoChanged;
84 /* for things concerned about *any* route's RID changes */
86 static PBD::Signal0<void> PresentationInfoChange;
88 /***************************************************************
89 * Pure interface begins here
90 ***************************************************************/
93 virtual boost::shared_ptr<PeakMeter> peak_meter() = 0;
94 virtual boost::shared_ptr<const PeakMeter> peak_meter() const = 0;
96 virtual boost::shared_ptr<GainControl> gain_control() const = 0;
98 virtual boost::shared_ptr<SoloControl> solo_control() const = 0;
99 virtual boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const = 0;
100 virtual boost::shared_ptr<SoloSafeControl> solo_safe_control() const = 0;
101 virtual boost::shared_ptr<MuteControl> mute_control() const = 0;
103 virtual boost::shared_ptr<PhaseControl> phase_control() const = 0;
104 virtual boost::shared_ptr<GainControl> trim_control() const = 0;
106 virtual boost::shared_ptr<MonitorControl> monitoring_control() const = 0;
107 virtual boost::shared_ptr<AutomationControl> rec_enable_control() const { return boost::shared_ptr<AutomationControl>(); }
109 /* "well-known" controls for panning. Any or all of these may return
113 virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const = 0;
114 virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const = 0;
115 virtual boost::shared_ptr<AutomationControl> pan_width_control() const = 0;
116 virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const = 0;
117 virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const = 0;
119 /* "well-known" controls for an EQ in this route. Any or all may
120 * be null. eq_band_cnt() must return 0 if there is no EQ present.
121 * Passing an @param band value >= eq_band_cnt() will guarantee the
122 * return of a null ptr (or an empty string for eq_band_name()).
124 virtual uint32_t eq_band_cnt () const = 0;
125 virtual std::string eq_band_name (uint32_t) const = 0;
126 virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const = 0;
127 virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const = 0;
128 virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const = 0;
129 virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const = 0;
130 virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const = 0;
131 virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const = 0;
133 /* "well-known" controls for a compressor in this route. Any or all may
136 virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const = 0;
137 virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const = 0;
138 virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const = 0;
139 virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const = 0;
140 virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const = 0;
141 virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const = 0;
143 /* @param mode must be supplied by the comp_mode_controllable(). All other values
144 * result in undefined behaviour
146 virtual std::string comp_mode_name (uint32_t mode) const = 0;
147 /* @param mode - as for comp mode name. This returns the name for the
148 * parameter/control accessed via comp_speed_controllable(), which can
151 virtual std::string comp_speed_name (uint32_t mode) const = 0;
153 /* "well-known" controls for sends to well-known busses in this route. Any or all may
156 * In Mixbus, these are the sends that connect to the mixbusses.
157 * In Ardour, these are user-created sends that connect to user-created
160 virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const = 0;
161 virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const = 0;
162 /* for the same value of @param n, this returns the name of the send
163 * associated with the pair of controllables returned by the above two methods.
165 virtual std::string send_name (uint32_t n) const = 0;
167 /* well known control that enables/disables sending to the master bus.
169 * In Ardour, this returns null.
170 * In Mixbus, it will return a suitable control, or null depending on
173 virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const = 0;
175 virtual bool muted_by_others_soloing () const = 0;
177 virtual boost::shared_ptr<MonitorProcessor> monitor_control() const = 0;
180 PresentationInfo _presentation_info;
182 /* set the entire info. This should only be used in cases where the
183 * derived could not supply the correct Flag and/or order information
184 * in its constructor.
187 void set_presentation_info (PresentationInfo id, bool notify_class_listeners = true);
188 void set_presentation_info_explicit (PresentationInfo);
190 void add_state (XMLNode&) const;
193 struct PresentationInfoSorter {
194 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
195 return a->presentation_info() < b->presentation_info();
202 #endif /* __libardour_stripable_h__ */