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.
20 #ifndef __ardour_route_h__
21 #define __ardour_route_h__
29 #include <boost/shared_ptr.hpp>
31 #include <pbd/fastlog.h>
32 #include <glibmm/thread.h>
33 #include <pbd/xml++.h>
35 #include <pbd/stateful.h>
36 #include <pbd/controllable.h>
37 #include <pbd/destructible.h>
39 #include <ardour/ardour.h>
40 #include <ardour/io.h>
41 #include <ardour/session.h>
42 #include <ardour/io_processor.h>
43 #include <ardour/types.h>
58 class Route : public IO
62 typedef list<boost::shared_ptr<Processor> > ProcessorList;
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 static std::string ensure_track_or_route_name(std::string, Session &);
80 std::string comment() { return _comment; }
81 void set_comment (std::string str, void *src);
83 long order_key (const char* name) const;
84 void set_order_key (const char* name, long n);
86 bool is_hidden() const { return _flags & Hidden; }
87 bool is_master() const { return _flags & MasterOut; }
88 bool is_control() const { return _flags & ControlOut; }
90 /* these are the core of the API of a Route. see the protected sections as well */
93 virtual int roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
94 nframes_t offset, int declick, bool can_record, bool rec_monitors_input);
96 virtual int no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
97 nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input);
99 virtual int silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
100 nframes_t offset, bool can_record, bool rec_monitors_input);
101 virtual void toggle_monitor_input ();
102 virtual bool can_record() { return false; }
103 virtual void set_record_enable (bool yn, void *src) {}
104 virtual bool record_enabled() const { return false; }
105 virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
106 virtual void set_pending_declick (int);
108 /* end of vfunc-based API */
110 /* override IO::set_gain() to provide group control */
112 void set_gain (gain_t val, void *src);
113 void inc_gain (gain_t delta, void *src);
115 void set_solo (bool yn, void *src);
116 bool soloed() const { return _soloed; }
118 void set_solo_safe (bool yn, void *src);
119 bool solo_safe() const { return _solo_safe; }
121 void set_mute (bool yn, void *src);
122 bool muted() const { return _muted; }
123 bool solo_muted() const { return desired_solo_gain == 0.0; }
125 void set_mute_config (mute_type, bool, void *src);
126 bool get_mute_config (mute_type);
128 void set_edit_group (RouteGroup *, void *);
129 void drop_edit_group (void *);
130 RouteGroup *edit_group () { return _edit_group; }
132 void set_mix_group (RouteGroup *, void *);
133 void drop_mix_group (void *);
134 RouteGroup *mix_group () { return _mix_group; }
136 virtual void set_meter_point (MeterPoint, void *src);
137 MeterPoint meter_point() const { return _meter_point; }
141 void flush_processors ();
143 template<class T> void foreach_processor (T *obj, void (T::*func)(boost::shared_ptr<Processor>)) {
144 Glib::RWLock::ReaderLock lm (_processor_lock);
145 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
150 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
151 Glib::RWLock::ReaderLock lm (_processor_lock);
152 ProcessorList::iterator i;
153 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n);
154 if (i == _processors.end()) {
155 return boost::shared_ptr<IOProcessor> ();
161 ChanCount max_processor_outs () const { return processor_max_outs; }
162 ChanCount pre_fader_streams() const;
164 /** A record of the stream configuration at some point in the processor list.
165 * Used to return where and why an processor list configuration request failed.
167 struct ProcessorStreams {
168 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
170 size_t index; ///< Index of processor where configuration failed
171 ChanCount count; ///< Input requested of processor
174 int add_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
175 int add_processors (const ProcessorList&, ProcessorStreams* err = 0);
176 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
177 int copy_processors (const Route&, Placement, ProcessorStreams* err = 0);
178 int sort_processors (ProcessorStreams* err = 0);
179 void disable_processors (Placement);
180 void disable_processors ();
181 void disable_plugins (Placement);
182 void disable_plugins ();
183 void ab_plugins (bool forward);
184 void clear_processors (Placement);
185 void all_processors_flip();
186 void all_processors_active (Placement, bool state);
188 virtual nframes_t update_total_latency();
189 void set_latency_delay (nframes_t);
190 void set_user_latency (nframes_t);
191 nframes_t initial_delay() const { return _initial_delay; }
193 sigc::signal<void,void*> solo_changed;
194 sigc::signal<void,void*> solo_safe_changed;
195 sigc::signal<void,void*> comment_changed;
196 sigc::signal<void,void*> mute_changed;
197 sigc::signal<void,void*> pre_fader_changed;
198 sigc::signal<void,void*> post_fader_changed;
199 sigc::signal<void,void*> control_outs_changed;
200 sigc::signal<void,void*> main_outs_changed;
201 sigc::signal<void> processors_changed;
202 sigc::signal<void,void*> record_enable_changed;
203 sigc::signal<void,void*> edit_group_changed;
204 sigc::signal<void,void*> mix_group_changed;
205 sigc::signal<void,void*> meter_change;
206 sigc::signal<void> signal_latency_changed;
207 sigc::signal<void> initial_delay_changed;
209 /* gui's call this for their own purposes. */
211 sigc::signal<void,std::string,void*> gui_changed;
215 XMLNode& get_state();
216 int set_state(const XMLNode& node);
217 virtual XMLNode& get_template();
219 XMLNode& get_processor_state ();
220 int set_processor_state (const XMLNode&);
222 sigc::signal<void,void*> SelectedChanged;
224 int set_control_outs (const vector<std::string>& ports);
225 IO* control_outs() { return _control_outs; }
227 bool feeds (boost::shared_ptr<Route>);
228 set<boost::shared_ptr<Route> > fed_by;
230 struct ToggleControllable : public PBD::Controllable {
236 ToggleControllable (std::string name, Route&, ToggleType);
237 void set_value (float);
238 float get_value (void) const;
244 boost::shared_ptr<PBD::Controllable> solo_control() {
245 return _solo_control;
248 boost::shared_ptr<PBD::Controllable> mute_control() {
249 return _mute_control;
252 void automation_snapshot (nframes_t now, bool force=false);
253 void protect_automation ();
255 void set_remote_control_id (uint32_t id);
256 uint32_t remote_control_id () const;
257 sigc::signal<void> RemoteControlIDChanged;
259 void sync_order_keys ();
260 static sigc::signal<void> SyncOrderKeys;
263 friend class Session;
265 void set_solo_mute (bool yn);
266 void set_block_size (nframes_t nframes);
267 bool has_external_redirects() const;
268 void curve_reallocate ();
273 /* tight cache-line access here is more important than sheer speed of
280 bool _recordable : 1;
281 bool _mute_affects_pre_fader : 1;
282 bool _mute_affects_post_fader : 1;
283 bool _mute_affects_control_outs : 1;
284 bool _mute_affects_main_outs : 1;
286 bool _declickable : 1;
287 int _pending_declick;
289 MeterPoint _meter_point;
293 gain_t desired_solo_gain;
294 gain_t desired_mute_gain;
298 nframes_t _initial_delay;
299 nframes_t _roll_delay;
300 ProcessorList _processors;
301 Glib::RWLock _processor_lock;
303 Glib::Mutex _control_outs_lock;
304 RouteGroup *_edit_group;
305 RouteGroup *_mix_group;
306 std::string _comment;
307 bool _have_internal_generator;
309 boost::shared_ptr<ToggleControllable> _solo_control;
310 boost::shared_ptr<ToggleControllable> _mute_control;
312 nframes_t check_initial_delay (nframes_t, nframes_t&, nframes_t&);
314 void passthru (nframes_t start_frame, nframes_t end_frame,
315 nframes_t nframes, nframes_t offset, int declick, bool meter_inputs);
317 virtual void process_output_buffers (BufferSet& bufs,
318 nframes_t start_frame, nframes_t end_frame,
319 nframes_t nframes, nframes_t offset, bool with_processors, int declick,
324 virtual XMLNode& state(bool);
326 void passthru_silence (nframes_t start_frame, nframes_t end_frame,
327 nframes_t nframes, nframes_t offset, int declick,
330 void silence (nframes_t nframes, nframes_t offset);
332 sigc::connection input_signal_connection;
334 ChanCount processor_max_outs;
335 uint32_t _remote_control_id;
337 uint32_t pans_required() const;
338 ChanCount n_process_buffers ();
340 virtual int _set_state (const XMLNode&, bool call_base);
341 virtual void _set_processor_states (const XMLNodeList&);
346 static uint32_t order_key_cnt;
350 bool operator()(const char* s1, const char* s2) const
352 return strcmp(s1, s2) < 0;
356 typedef std::map<const char*,long,ltstr> OrderKeys;
357 OrderKeys order_keys;
359 void input_change_handler (IOChange, void *src);
360 void output_change_handler (IOChange, void *src);
362 int reset_plugin_counts (ProcessorStreams*); /* locked */
363 int _reset_plugin_counts (ProcessorStreams*); /* unlocked */
365 /* processor I/O channels and plugin count handling */
367 struct ProcessorCount {
368 boost::shared_ptr<ARDOUR::Processor> processor;
372 ProcessorCount (boost::shared_ptr<ARDOUR::Processor> ins) : processor(ins) {}
375 int32_t apply_some_plugin_counts (std::list<ProcessorCount>& iclist);
376 bool check_some_plugin_counts (std::list<ProcessorCount>& iclist, ChanCount required_inputs, ProcessorStreams* err_streams);
378 void set_deferred_state ();
379 void add_processor_from_xml (const XMLNode&);
382 } // namespace ARDOUR
384 #endif /* __ardour_route_h__ */