2 Copyright (C) 2016 Paul Davis
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2 of the License, or (at your option)
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 675 Mass Ave, Cambridge, MA 02139, USA.
19 #ifndef __ardour_vca_h__
20 #define __ardour_vca_h__
23 #include <boost/shared_ptr.hpp>
24 #include <boost/enable_shared_from_this.hpp>
26 #include "pbd/controllable.h"
27 #include "pbd/statefuldestructible.h"
29 #include "ardour/automatable.h"
30 #include "ardour/muteable.h"
31 #include "ardour/monitorable.h"
32 #include "ardour/recordable.h"
33 #include "ardour/soloable.h"
34 #include "ardour/slavable.h"
35 #include "ardour/stripable.h"
45 class LIBARDOUR_API VCA : public Stripable,
51 public boost::enable_shared_from_this<VCA> {
53 VCA (Session& session, uint32_t num, const std::string& name);
56 uint32_t number () const { return _number; }
57 uint32_t remote_control_id() const;
61 int set_state (XMLNode const&, int version);
65 bool slaved_to (boost::shared_ptr<VCA>) const;
70 void clear_all_solo_state ();
73 void push_solo_upstream (int32_t) {}
74 void push_solo_isolate_upstream (int32_t) {}
75 bool can_solo() const { return true; }
76 bool is_safe () const { return false; }
80 bool can_be_muted_by_others () const { return true; }
81 bool muted_by_others_soloing() const { return false; }
85 int prep_record_enabled (bool yn) { return 0; }
86 bool can_be_record_enabled() { return true; }
87 bool can_be_record_safe() { return true; }
91 MonitorState monitoring_state() const;
93 static std::string default_name_template ();
94 static int next_vca_number ();
95 static std::string xml_node_name;
97 /* used by Session to save/restore the atomic counter */
98 static uint32_t get_next_vca_number ();
99 static void set_next_vca_number (uint32_t);
101 virtual boost::shared_ptr<GainControl> gain_control() const { return _gain_control; }
102 virtual boost::shared_ptr<SoloControl> solo_control() const { return _solo_control; }
103 virtual boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const { return boost::shared_ptr<SoloIsolateControl>(); }
104 virtual boost::shared_ptr<SoloSafeControl> solo_safe_control() const { return boost::shared_ptr<SoloSafeControl>(); }
105 virtual boost::shared_ptr<MuteControl> mute_control() const { return _mute_control; }
106 virtual boost::shared_ptr<AutomationControl> recenable_control() const { return _recenable_control; }
107 virtual boost::shared_ptr<MonitorControl> monitoring_control() const { return _monitor_control; }
109 /* null Stripable API, because VCAs don't have any of this */
111 virtual boost::shared_ptr<PeakMeter> peak_meter() { return boost::shared_ptr<PeakMeter>(); }
112 virtual boost::shared_ptr<const PeakMeter> peak_meter() const { return boost::shared_ptr<PeakMeter>(); }
113 virtual boost::shared_ptr<PhaseControl> phase_control() const { return boost::shared_ptr<PhaseControl>(); }
114 virtual boost::shared_ptr<GainControl> trim_control() const { return boost::shared_ptr<GainControl>(); }
115 virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const { return boost::shared_ptr<AutomationControl>(); }
116 virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const { return boost::shared_ptr<AutomationControl>(); }
117 virtual boost::shared_ptr<AutomationControl> pan_width_control() const { return boost::shared_ptr<AutomationControl>(); }
118 virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const { return boost::shared_ptr<AutomationControl>(); }
119 virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const { return boost::shared_ptr<AutomationControl>(); }
120 virtual uint32_t eq_band_cnt () const { return 0; }
121 virtual std::string eq_band_name (uint32_t) const { return std::string(); }
122 virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
123 virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
124 virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
125 virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
126 virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
127 virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const { return boost::shared_ptr<AutomationControl>(); }
128 virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
129 virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const { return boost::shared_ptr<AutomationControl>(); }
130 virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const { return boost::shared_ptr<AutomationControl>(); }
131 virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const { return boost::shared_ptr<AutomationControl>(); }
132 virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const { return boost::shared_ptr<AutomationControl>(); }
133 virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const { return boost::shared_ptr<AutomationControl>(); }
134 virtual std::string comp_mode_name (uint32_t mode) const { return std::string(); }
135 virtual std::string comp_speed_name (uint32_t mode) const { return std::string(); }
136 virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const { return boost::shared_ptr<AutomationControl>(); }
137 virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const { return boost::shared_ptr<AutomationControl>(); }
138 virtual std::string send_name (uint32_t n) const { return std::string(); }
139 virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
140 boost::shared_ptr<MonitorProcessor> monitor_control() const { return boost::shared_ptr<MonitorProcessor>(); }
145 boost::shared_ptr<GainControl> _gain_control;
146 boost::shared_ptr<SoloControl> _solo_control;
147 boost::shared_ptr<MuteControl> _mute_control;
148 boost::shared_ptr<AutomationControl> _recenable_control;
149 // boost::shared_ptr<AutomationControl> _record_safe_control;
150 boost::shared_ptr<MonitorControl> _monitor_control;
152 static gint next_number;
154 void solo_target_going_away (boost::weak_ptr<Route>);
155 void mute_target_going_away (boost::weak_ptr<Route>);
156 bool soloed_locked () const;
157 bool muted_locked () const;
162 #endif /* __ardour_vca_h__ */