2 Copyright (C) 2000-2002 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.
21 #ifndef __ardour_route_h__
22 #define __ardour_route_h__
30 #include <boost/shared_ptr.hpp>
32 #include <pbd/fastlog.h>
33 #include <glibmm/thread.h>
34 #include <pbd/xml++.h>
36 #include <pbd/stateful.h>
37 #include <pbd/controllable.h>
38 #include <pbd/destructible.h>
40 #include <ardour/ardour.h>
41 #include <ardour/io.h>
42 #include <ardour/session.h>
43 #include <ardour/redirect.h>
44 #include <ardour/types.h>
59 class Route : public IO
63 typedef list<boost::shared_ptr<Redirect> > RedirectList;
73 Route (Session&, std::string name, int input_min, int input_max, int output_min, int output_max,
74 Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
75 Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
78 std::string comment() { return _comment; }
79 void set_comment (std::string str, void *src);
81 long order_key(std::string name) const;
82 void set_order_key (std::string name, long n);
84 bool hidden() const { return _flags & Hidden; }
85 bool master() const { return _flags & MasterOut; }
86 bool control() const { return _flags & ControlOut; }
88 /* these are the core of the API of a Route. see the protected sections as well */
91 virtual int roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
92 nframes_t offset, int declick, bool can_record, bool rec_monitors_input);
94 virtual int no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
95 nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input);
97 virtual int silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
98 nframes_t offset, bool can_record, bool rec_monitors_input);
99 virtual void toggle_monitor_input ();
100 virtual bool can_record() { return false; }
101 virtual void set_record_enable (bool yn, void *src) {}
102 virtual bool record_enabled() const { return false; }
103 virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_redirects);
104 virtual void set_pending_declick (int);
106 /* end of vfunc-based API */
108 /* override IO::set_gain() to provide group control */
110 void set_gain (gain_t val, void *src);
111 void inc_gain (gain_t delta, void *src);
113 bool active() const { return _active; }
114 void set_active (bool yn);
116 void set_solo (bool yn, void *src);
117 bool soloed() const { return _soloed; }
119 void set_solo_safe (bool yn, void *src);
120 bool solo_safe() const { return _solo_safe; }
122 void set_mute (bool yn, void *src);
123 bool muted() const { return _muted; }
125 void set_mute_config (mute_type, bool, void *src);
126 bool get_mute_config (mute_type);
128 void set_phase_invert (bool yn, void *src);
129 bool phase_invert() const { return _phase_invert; }
131 void set_edit_group (RouteGroup *, void *);
132 void drop_edit_group (void *);
133 RouteGroup *edit_group () { return _edit_group; }
135 void set_mix_group (RouteGroup *, void *);
136 void drop_mix_group (void *);
137 RouteGroup *mix_group () { return _mix_group; }
139 virtual void set_meter_point (MeterPoint, void *src);
140 MeterPoint meter_point() const { return _meter_point; }
144 void flush_redirects ();
146 template<class T> void foreach_redirect (T *obj, void (T::*func)(boost::shared_ptr<Redirect>)) {
147 Glib::RWLock::ReaderLock lm (redirect_lock);
148 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
153 boost::shared_ptr<Redirect> nth_redirect (uint32_t n) {
154 Glib::RWLock::ReaderLock lm (redirect_lock);
155 RedirectList::iterator i;
156 for (i = _redirects.begin(); i != _redirects.end() && n; ++i, --n);
157 if (i == _redirects.end()) {
158 return boost::shared_ptr<Redirect> ();
164 uint32_t max_redirect_outs () const { return redirect_max_outs; }
166 int add_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
167 int add_redirects (const RedirectList&, void *src, uint32_t* err_streams = 0);
168 int remove_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
169 int copy_redirects (const Route&, Placement, uint32_t* err_streams = 0);
170 int sort_redirects (uint32_t* err_streams = 0);
172 void clear_redirects (void *src);
173 void all_redirects_flip();
174 void all_redirects_active (bool state);
176 virtual nframes_t update_total_latency();
177 nframes_t signal_latency() const { return _own_latency; }
178 virtual void set_latency_delay (nframes_t);
180 sigc::signal<void,void*> solo_changed;
181 sigc::signal<void,void*> solo_safe_changed;
182 sigc::signal<void,void*> comment_changed;
183 sigc::signal<void,void*> mute_changed;
184 sigc::signal<void,void*> pre_fader_changed;
185 sigc::signal<void,void*> post_fader_changed;
186 sigc::signal<void,void*> control_outs_changed;
187 sigc::signal<void,void*> main_outs_changed;
188 sigc::signal<void,void*> redirects_changed;
189 sigc::signal<void,void*> record_enable_changed;
190 sigc::signal<void,void*> edit_group_changed;
191 sigc::signal<void,void*> mix_group_changed;
192 sigc::signal<void> active_changed;
193 sigc::signal<void,void*> meter_change;
195 /* gui's call this for their own purposes. */
197 sigc::signal<void,std::string,void*> gui_changed;
201 XMLNode& get_state();
202 int set_state(const XMLNode& node);
203 virtual XMLNode& get_template();
205 sigc::signal<void,void*> SelectedChanged;
207 int set_control_outs (const vector<std::string>& ports);
208 IO* control_outs() { return _control_outs; }
210 bool feeds (boost::shared_ptr<Route>);
211 set<boost::shared_ptr<Route> > fed_by;
213 struct ToggleControllable : public PBD::Controllable {
219 ToggleControllable (std::string name, Route&, ToggleType);
220 void set_value (float);
221 float get_value (void) const;
227 PBD::Controllable& solo_control() {
228 return _solo_control;
231 PBD::Controllable& mute_control() {
232 return _mute_control;
235 void automation_snapshot (nframes_t now);
236 void protect_automation ();
238 void set_remote_control_id (uint32_t id);
239 uint32_t remote_control_id () const;
240 sigc::signal<void> RemoteControlIDChanged;
243 friend class Session;
245 void set_solo_mute (bool yn);
246 void set_block_size (nframes_t nframes);
247 bool has_external_redirects() const;
248 void curve_reallocate ();
251 unsigned char _flags;
253 /* tight cache-line access here is more important than sheer speed of
259 bool _solo_muted : 1;
261 bool _phase_invert : 1;
262 bool _recordable : 1;
264 bool _mute_affects_pre_fader : 1;
265 bool _mute_affects_post_fader : 1;
266 bool _mute_affects_control_outs : 1;
267 bool _mute_affects_main_outs : 1;
269 bool _declickable : 1;
270 int _pending_declick;
272 MeterPoint _meter_point;
276 gain_t desired_solo_gain;
277 gain_t desired_mute_gain;
279 nframes_t check_initial_delay (nframes_t, nframes_t&, nframes_t&);
281 nframes_t _initial_delay;
282 nframes_t _roll_delay;
283 nframes_t _own_latency;
284 RedirectList _redirects;
285 Glib::RWLock redirect_lock;
287 Glib::Mutex control_outs_lock;
288 RouteGroup *_edit_group;
289 RouteGroup *_mix_group;
290 std::string _comment;
291 bool _have_internal_generator;
293 ToggleControllable _solo_control;
294 ToggleControllable _mute_control;
296 void passthru (nframes_t start_frame, nframes_t end_frame,
297 nframes_t nframes, nframes_t offset, int declick, bool meter_inputs);
299 void process_output_buffers (vector<Sample*>& bufs, uint32_t nbufs,
300 nframes_t start_frame, nframes_t end_frame,
301 nframes_t nframes, nframes_t offset, bool with_redirects, int declick,
305 /* for derived classes */
307 virtual XMLNode& state(bool);
309 void silence (nframes_t nframes, nframes_t offset);
310 sigc::connection input_signal_connection;
312 uint32_t redirect_max_outs;
313 uint32_t _remote_control_id;
315 uint32_t pans_required() const;
316 uint32_t n_process_buffers ();
318 virtual int _set_state (const XMLNode&, bool call_base);
323 static uint32_t order_key_cnt;
324 typedef std::map<std::string,long> OrderKeys;
325 OrderKeys order_keys;
327 void input_change_handler (IOChange, void *src);
328 void output_change_handler (IOChange, void *src);
330 bool legal_redirect (Redirect&);
331 int reset_plugin_counts (uint32_t*); /* locked */
332 int _reset_plugin_counts (uint32_t*); /* unlocked */
334 /* plugin count handling */
337 boost::shared_ptr<ARDOUR::Insert> insert;
342 InsertCount (boost::shared_ptr<ARDOUR::Insert> ins) : insert (ins), cnt (-1) {}
345 int32_t apply_some_plugin_counts (std::list<InsertCount>& iclist);
346 int32_t check_some_plugin_counts (std::list<InsertCount>& iclist, int32_t required_inputs, uint32_t* err_streams);
348 void set_deferred_state ();
349 void add_redirect_from_xml (const XMLNode&);
350 void redirect_active_proxy (Redirect*, void*);
353 } // namespace ARDOUR
355 #endif /* __ardour_route_h__ */