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__
30 #include <boost/shared_ptr.hpp>
31 #include <boost/weak_ptr.hpp>
33 #include <glibmm/thread.h>
34 #include "pbd/fastlog.h"
35 #include "pbd/xml++.h"
37 #include "pbd/stateful.h"
38 #include "pbd/controllable.h"
39 #include "pbd/destructible.h"
41 #include "ardour/ardour.h"
42 #include "ardour/io.h"
43 #include "ardour/types.h"
44 #include "ardour/mute_master.h"
57 class Route : public SessionObject, public AutomatableControls
61 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
69 Route (Session&, std::string name, Flag flags = Flag(0),
70 DataType default_type = DataType::AUDIO);
71 Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
74 boost::shared_ptr<IO> input() const { return _input; }
75 boost::shared_ptr<IO> output() const { return _output; }
77 ChanCount n_inputs() const { return _input->n_ports(); }
78 ChanCount n_outputs() const { return _output->n_ports(); }
80 bool active() const { return _active; }
81 void set_active (bool yn);
84 static std::string ensure_track_or_route_name(std::string, Session &);
86 std::string comment() { return _comment; }
87 void set_comment (std::string str, void *src);
89 bool set_name (const std::string& str);
91 long order_key (std::string const &) const;
92 void set_order_key (std::string const &, long);
94 bool is_hidden() const { return _flags & Hidden; }
95 bool is_master() const { return _flags & MasterOut; }
96 bool is_control() const { return _flags & ControlOut; }
98 /* these are the core of the API of a Route. see the protected sections as well */
100 virtual int roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
101 int declick, bool can_record, bool rec_monitors_input);
103 virtual int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
104 bool state_changing, bool can_record, bool rec_monitors_input);
106 virtual int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
107 bool can_record, bool rec_monitors_input);
109 virtual void toggle_monitor_input ();
110 virtual bool can_record() { return false; }
112 virtual void set_record_enable (bool yn, void *src) {}
113 virtual bool record_enabled() const { return false; }
114 virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
115 virtual void set_pending_declick (int);
117 /* end of vfunc-based API */
119 void shift (nframes64_t, nframes64_t);
121 void set_gain (gain_t val, void *src);
122 void inc_gain (gain_t delta, void *src);
124 void set_mute (bool yn, void* src);
128 /* controls use set_solo() to modify this route's solo state
131 void set_solo (bool yn, void *src);
132 bool soloed () const { return (bool) _solo_level; }
134 void set_solo_isolated (bool yn, void *src);
135 bool solo_isolated() const;
137 void set_listen (bool yn, void* src);
138 bool listening () const;
140 void set_phase_invert (bool yn);
141 bool phase_invert() const;
143 void set_denormal_protection (bool yn);
144 bool denormal_protection() const;
146 void set_route_group (RouteGroup *, void *);
147 void drop_route_group (void *);
148 RouteGroup *route_group () const { return _route_group; }
150 virtual void set_meter_point (MeterPoint, void *src);
151 MeterPoint meter_point() const { return _meter_point; }
156 boost::shared_ptr<Amp> amp() const { return _amp; }
157 PeakMeter& peak_meter() { return *_meter.get(); }
158 const PeakMeter& peak_meter() const { return *_meter.get(); }
159 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
161 void flush_processors ();
163 void foreach_processor (sigc::slot<void, boost::weak_ptr<Processor> > method) {
164 Glib::RWLock::ReaderLock lm (_processor_lock);
165 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
166 method (boost::weak_ptr<Processor> (*i));
170 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
171 Glib::RWLock::ReaderLock lm (_processor_lock);
172 ProcessorList::iterator i;
173 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
174 if (i == _processors.end()) {
175 return boost::shared_ptr<Processor> ();
181 bool processor_is_prefader (boost::shared_ptr<Processor> p);
183 ChanCount max_processor_streams () const { return processor_max_streams; }
185 /* special processors */
187 boost::shared_ptr<Delivery> control_outs() const { return _control_outs; }
188 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
189 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
190 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
191 void add_internal_return ();
192 BufferSet* get_return_buffer () const;
193 void release_return_buffer () const;
194 void put_control_outs_at (Placement);
196 /** A record of the stream configuration at some point in the processor list.
197 * Used to return where and why an processor list configuration request failed.
199 struct ProcessorStreams {
200 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
202 uint32_t index; ///< Index of processor where configuration failed
203 ChanCount count; ///< Input requested of processor
206 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
207 int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0);
208 int add_processors (const ProcessorList&, Placement placement, ProcessorStreams* err = 0);
209 int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
210 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
211 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
212 void disable_processors (Placement);
213 void disable_processors ();
214 void disable_plugins (Placement);
215 void disable_plugins ();
216 void ab_plugins (bool forward);
217 void clear_processors (Placement);
218 void all_processors_flip();
219 void all_processors_active (Placement, bool state);
221 virtual nframes_t update_total_latency();
222 void set_latency_delay (nframes_t);
223 void set_user_latency (nframes_t);
224 nframes_t initial_delay() const { return _initial_delay; }
226 sigc::signal<void> active_changed;
227 sigc::signal<void> phase_invert_changed;
228 sigc::signal<void> denormal_protection_changed;
229 sigc::signal<void,void*> listen_changed;
230 sigc::signal<void,void*> solo_changed;
231 sigc::signal<void,void*> solo_safe_changed;
232 sigc::signal<void,void*> solo_isolated_changed;
233 sigc::signal<void,void*> comment_changed;
234 sigc::signal<void,void*> mute_changed;
235 sigc::signal<void,void*> pre_fader_changed;
236 sigc::signal<void,void*> post_fader_changed;
237 sigc::signal<void,void*> control_outs_changed;
238 sigc::signal<void,void*> main_outs_changed;
239 sigc::signal<void> processors_changed;
240 sigc::signal<void,void*> record_enable_changed;
241 sigc::signal<void,void*> route_group_changed;
242 sigc::signal<void,void*> meter_change;
243 sigc::signal<void> signal_latency_changed;
244 sigc::signal<void> initial_delay_changed;
246 /* gui's call this for their own purposes. */
248 sigc::signal<void,std::string,void*> gui_changed;
252 XMLNode& get_state();
253 int set_state(const XMLNode& node);
254 virtual XMLNode& get_template();
256 XMLNode& get_processor_state ();
257 virtual void set_processor_state (const XMLNode&);
259 int save_as_template (const std::string& path, const std::string& name);
261 sigc::signal<void,void*> SelectedChanged;
263 int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
264 void drop_listen (boost::shared_ptr<Route>);
266 bool feeds (boost::shared_ptr<Route>);
267 std::set<boost::shared_ptr<Route> > fed_by;
269 /* Controls (not all directly owned by the Route */
271 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
273 struct SoloControllable : public AutomationControl {
274 SoloControllable (std::string name, Route&);
275 void set_value (float);
276 float get_value (void) const;
281 boost::shared_ptr<AutomationControl> solo_control() const {
282 return _solo_control;
285 boost::shared_ptr<AutomationControl> mute_control() const {
289 boost::shared_ptr<MuteMaster> mute_master() const {
293 /* Route doesn't own these items, but sub-objects that it does own have them
294 and to make UI code a bit simpler, we provide direct access to them
298 boost::shared_ptr<Panner> panner() const;
299 boost::shared_ptr<AutomationControl> gain_control() const;
301 void automation_snapshot (nframes_t now, bool force=false);
302 void protect_automation ();
304 void set_remote_control_id (uint32_t id);
305 uint32_t remote_control_id () const;
306 sigc::signal<void> RemoteControlIDChanged;
308 void sync_order_keys (std::string const &);
309 static sigc::signal<void, std::string const &> SyncOrderKeys;
312 friend class Session;
314 void catch_up_on_solo_mute_override ();
315 void mod_solo_level (int32_t);
316 uint32_t solo_level () const { return _solo_level; }
317 void set_block_size (nframes_t nframes);
318 bool has_external_redirects() const;
319 void curve_reallocate ();
320 void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
323 nframes_t check_initial_delay (nframes_t, nframes_t&);
325 void passthru (sframes_t start_frame, sframes_t end_frame,
326 nframes_t nframes, int declick);
328 virtual void process_output_buffers (BufferSet& bufs,
329 sframes_t start_frame, sframes_t end_frame,
330 nframes_t nframes, bool with_processors, int declick);
332 boost::shared_ptr<IO> _input;
333 boost::shared_ptr<IO> _output;
336 nframes_t _initial_delay;
337 nframes_t _roll_delay;
339 ProcessorList _processors;
340 mutable Glib::RWLock _processor_lock;
341 boost::shared_ptr<Delivery> _main_outs;
342 boost::shared_ptr<Delivery> _control_outs;
343 boost::shared_ptr<InternalReturn> _intreturn;
346 int _pending_declick;
347 MeterPoint _meter_point;
348 uint32_t _phase_invert;
349 uint32_t _solo_level;
352 bool _denormal_protection;
354 bool _recordable : 1;
356 bool _declickable : 1;
358 boost::shared_ptr<SoloControllable> _solo_control;
359 boost::shared_ptr<MuteMaster> _mute_master;
361 RouteGroup* _route_group;
362 std::string _comment;
363 bool _have_internal_generator;
365 DataType _default_type;
369 virtual XMLNode& state(bool);
371 void passthru_silence (sframes_t start_frame, sframes_t end_frame,
372 nframes_t nframes, int declick);
374 void silence (nframes_t nframes);
376 sigc::connection input_signal_connection;
378 ChanCount processor_max_streams;
379 uint32_t _remote_control_id;
381 uint32_t pans_required() const;
382 ChanCount n_process_buffers ();
384 virtual int _set_state (const XMLNode&, bool call_base);
386 boost::shared_ptr<Amp> _amp;
387 boost::shared_ptr<PeakMeter> _meter;
388 sigc::connection _meter_connection;
393 static uint32_t order_key_cnt;
395 typedef std::map<std::string, long> OrderKeys;
396 OrderKeys order_keys;
398 void input_change_handler (IOChange, void *src);
399 void output_change_handler (IOChange, void *src);
401 bool _in_configure_processors;
403 int configure_processors (ProcessorStreams*);
404 int configure_processors_unlocked (ProcessorStreams*);
406 bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);
408 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
411 } // namespace ARDOUR
413 #endif /* __ardour_route_h__ */