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>
32 #include <boost/dynamic_bitset.hpp>
34 #include <glibmm/thread.h>
35 #include "pbd/fastlog.h"
36 #include "pbd/xml++.h"
38 #include "pbd/stateful.h"
39 #include "pbd/controllable.h"
40 #include "pbd/destructible.h"
42 #include "ardour/ardour.h"
43 #include "ardour/io.h"
44 #include "ardour/types.h"
45 #include "ardour/mute_master.h"
46 #include "ardour/route_group_member.h"
47 #include "ardour/graphnode.h"
48 #include "ardour/automatable.h"
49 #include "ardour/unknown_processor.h"
61 class MonitorProcessor;
63 class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode
67 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
75 Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
80 boost::shared_ptr<IO> input() const { return _input; }
81 boost::shared_ptr<IO> output() const { return _output; }
83 ChanCount n_inputs() const { return _input->n_ports(); }
84 ChanCount n_outputs() const { return _output->n_ports(); }
86 bool active() const { return _active; }
87 void set_active (bool yn, void *);
89 static std::string ensure_track_or_route_name(std::string, Session &);
91 std::string comment() { return _comment; }
92 void set_comment (std::string str, void *src);
94 bool set_name (const std::string& str);
96 int32_t order_key (std::string const &) const;
97 void set_order_key (std::string const &, int32_t);
99 bool is_hidden() const { return _flags & Hidden; }
100 bool is_master() const { return _flags & MasterOut; }
101 bool is_monitor() const { return _flags & MonitorOut; }
103 /* these are the core of the API of a Route. see the protected sections as well */
105 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
106 int declick, bool can_record, bool rec_monitors_input, bool& need_butler);
108 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
109 bool state_changing, bool can_record, bool rec_monitors_input);
111 virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
112 bool can_record, bool rec_monitors_input, bool& need_butler);
114 virtual void toggle_monitor_input ();
115 virtual bool can_record() { return false; }
117 virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
118 virtual bool record_enabled() const { return false; }
119 virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
120 virtual void realtime_handle_transport_stopped () {}
121 virtual void set_pending_declick (int);
123 /* end of vfunc-based API */
125 void shift (framepos_t, framepos_t);
127 void set_gain (gain_t val, void *src);
128 void inc_gain (gain_t delta, void *src);
130 void set_mute_points (MuteMaster::MutePoint);
131 MuteMaster::MutePoint mute_points () const;
134 void set_mute (bool yn, void* src);
136 /* controls use set_solo() to modify this route's solo state
139 void set_solo (bool yn, void *src);
140 bool soloed () const { return self_soloed () || soloed_by_others (); }
142 bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
143 bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
144 bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
145 bool self_soloed () const { return _self_solo; }
147 void set_solo_isolated (bool yn, void *src);
148 bool solo_isolated() const;
150 void set_solo_safe (bool yn, void *src);
151 bool solo_safe() const;
153 void set_listen (bool yn, void* src);
154 bool listening () const;
156 void set_phase_invert (uint32_t, bool yn);
157 void set_phase_invert (boost::dynamic_bitset<>);
158 bool phase_invert (uint32_t) const;
159 boost::dynamic_bitset<> phase_invert () const;
161 void set_denormal_protection (bool yn);
162 bool denormal_protection() const;
164 void set_meter_point (MeterPoint, bool force = false);
165 void infer_meter_point () const;
166 MeterPoint meter_point() const { return _meter_point; }
171 boost::shared_ptr<Amp> amp() const { return _amp; }
172 PeakMeter& peak_meter() { return *_meter.get(); }
173 const PeakMeter& peak_meter() const { return *_meter.get(); }
174 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
176 void flush_processors ();
178 void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
179 Glib::RWLock::ReaderLock lm (_processor_lock);
180 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
181 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
184 method (boost::weak_ptr<Processor> (*i));
188 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
189 Glib::RWLock::ReaderLock lm (_processor_lock);
190 ProcessorList::iterator i;
191 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
192 if (i == _processors.end()) {
193 return boost::shared_ptr<Processor> ();
199 boost::shared_ptr<Processor> nth_plugin (uint32_t n);
200 boost::shared_ptr<Processor> nth_send (uint32_t n);
202 bool processor_is_prefader (boost::shared_ptr<Processor> p);
204 bool has_io_processor_named (const std::string&);
205 ChanCount max_processor_streams () const { return processor_max_streams; }
207 std::list<std::string> unknown_processors () const;
209 /* special processors */
211 boost::shared_ptr<Delivery> monitor_send() const { return _monitor_send; }
212 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
213 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
214 boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
215 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
216 void add_internal_return ();
217 BufferSet* get_return_buffer () const;
218 void release_return_buffer () const;
219 void put_monitor_send_at (Placement);
221 /** A record of the stream configuration at some point in the processor list.
222 * Used to return where and why an processor list configuration request failed.
224 struct ProcessorStreams {
225 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
227 uint32_t index; ///< Index of processor where configuration failed
228 ChanCount count; ///< Input requested of processor
231 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
232 int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0, bool activation_allowed = true);
233 int add_processors (const ProcessorList&, boost::shared_ptr<Processor> before, ProcessorStreams* err = 0);
234 int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
235 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
236 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
237 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
238 void disable_processors (Placement);
239 void disable_processors ();
240 void disable_plugins (Placement);
241 void disable_plugins ();
242 void ab_plugins (bool forward);
243 void clear_processors (Placement);
244 void all_processors_flip();
245 void all_processors_active (Placement, bool state);
247 virtual framecnt_t update_total_latency();
248 void set_latency_delay (framecnt_t);
249 void set_user_latency (framecnt_t);
250 framecnt_t initial_delay() const { return _initial_delay; }
252 PBD::Signal0<void> active_changed;
253 PBD::Signal0<void> phase_invert_changed;
254 PBD::Signal0<void> denormal_protection_changed;
255 PBD::Signal1<void,void*> listen_changed;
256 PBD::Signal2<void,bool,void*> solo_changed;
257 PBD::Signal1<void,void*> solo_safe_changed;
258 PBD::Signal1<void,void*> solo_isolated_changed;
259 PBD::Signal1<void,void*> comment_changed;
260 PBD::Signal1<void,void*> mute_changed;
261 PBD::Signal0<void> mute_points_changed;
263 /** the processors have changed; the parameter indicates what changed */
264 PBD::Signal1<void,RouteProcessorChange> processors_changed;
265 PBD::Signal1<void,void*> record_enable_changed;
266 /** the metering point has changed */
267 PBD::Signal0<void> meter_change;
268 PBD::Signal0<void> signal_latency_changed;
269 PBD::Signal0<void> initial_delay_changed;
270 PBD::Signal0<void> order_key_changed;
272 /** Emitted with the process lock held */
273 PBD::Signal0<void> io_changed;
275 /* gui's call this for their own purposes. */
277 PBD::Signal2<void,std::string,void*> gui_changed;
281 XMLNode& get_state();
282 int set_state (const XMLNode&, int version);
283 virtual XMLNode& get_template();
285 XMLNode& get_processor_state ();
286 virtual void set_processor_state (const XMLNode&);
288 int save_as_template (const std::string& path, const std::string& name);
290 PBD::Signal1<void,void*> SelectedChanged;
292 int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
293 void drop_listen (boost::shared_ptr<Route>);
296 * return true if this route feeds the first argument via at least one
297 * (arbitrarily long) signal pathway.
299 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
302 * return true if this route feeds the first argument directly, via
303 * either its main outs or a send.
305 bool direct_feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
308 boost::weak_ptr<Route> r;
311 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
313 , sends_only (sendsonly) {}
316 struct FeedRecordCompare {
317 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
322 typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
324 const FedBy& fed_by() const { return _fed_by; }
325 void clear_fed_by ();
326 bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
327 bool not_fed() const { return _fed_by.empty(); }
329 /* Controls (not all directly owned by the Route */
331 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
333 struct SoloControllable : public AutomationControl {
334 SoloControllable (std::string name, Route&);
335 void set_value (double);
336 double get_value (void) const;
341 struct MuteControllable : public AutomationControl {
342 MuteControllable (std::string name, Route&);
343 void set_value (double);
344 double get_value (void) const;
349 boost::shared_ptr<AutomationControl> solo_control() const {
350 return _solo_control;
353 boost::shared_ptr<AutomationControl> mute_control() const {
354 return _mute_control;
357 boost::shared_ptr<MuteMaster> mute_master() const {
361 /* Route doesn't own these items, but sub-objects that it does own have them
362 and to make UI code a bit simpler, we provide direct access to them
366 boost::shared_ptr<Panner> panner() const;
367 boost::shared_ptr<AutomationControl> gain_control() const;
369 void automation_snapshot (framepos_t now, bool force=false);
370 void protect_automation ();
372 void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
373 uint32_t remote_control_id () const;
375 /* for things concerned about *this* route's RID */
377 PBD::Signal0<void> RemoteControlIDChanged;
379 /* for things concerned about any route's RID changes */
381 static PBD::Signal0<void> RemoteControlIDChange;
383 void sync_order_keys (std::string const &);
384 static PBD::Signal1<void,std::string const &> SyncOrderKeys;
387 friend class Session;
389 void catch_up_on_solo_mute_override ();
390 void mod_solo_by_others_upstream (int32_t);
391 void mod_solo_by_others_downstream (int32_t);
392 bool has_external_redirects() const;
393 void curve_reallocate ();
394 void just_meter_input (framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
395 virtual void set_block_size (pframes_t nframes);
398 framecnt_t check_initial_delay (framecnt_t, framecnt_t&);
400 void passthru (framepos_t start_frame, framepos_t end_frame,
401 pframes_t nframes, int declick);
403 virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
404 framecnt_t /* nframes */) {}
406 virtual void process_output_buffers (BufferSet& bufs,
407 framepos_t start_frame, framepos_t end_frame,
408 pframes_t nframes, bool with_processors, int declick,
409 bool gain_automation_ok);
411 boost::shared_ptr<IO> _input;
412 boost::shared_ptr<IO> _output;
415 framecnt_t _initial_delay;
416 framecnt_t _roll_delay;
418 ProcessorList _processors;
419 mutable Glib::RWLock _processor_lock;
420 boost::shared_ptr<Delivery> _main_outs;
421 boost::shared_ptr<Delivery> _monitor_send;
422 boost::shared_ptr<InternalReturn> _intreturn;
423 boost::shared_ptr<MonitorProcessor> _monitor_control;
426 int _pending_declick;
427 MeterPoint _meter_point;
428 boost::dynamic_bitset<> _phase_invert;
430 uint32_t _soloed_by_others_upstream;
431 uint32_t _soloed_by_others_downstream;
432 uint32_t _solo_isolated;
434 bool _denormal_protection;
436 bool _recordable : 1;
438 bool _declickable : 1;
440 boost::shared_ptr<SoloControllable> _solo_control;
441 boost::shared_ptr<MuteControllable> _mute_control;
442 boost::shared_ptr<MuteMaster> _mute_master;
444 std::string _comment;
445 bool _have_internal_generator;
447 DataType _default_type;
450 ChanCount input_streams () const;
453 virtual XMLNode& state(bool);
455 int configure_processors (ProcessorStreams*);
457 void passthru_silence (framepos_t start_frame, framepos_t end_frame,
458 pframes_t nframes, int declick);
460 void silence (framecnt_t);
461 void silence_unlocked (framecnt_t);
463 ChanCount processor_max_streams;
464 uint32_t _remote_control_id;
466 uint32_t pans_required() const;
467 ChanCount n_process_buffers ();
469 virtual int _set_state (const XMLNode&, int, bool call_base);
471 boost::shared_ptr<Amp> _amp;
472 boost::shared_ptr<PeakMeter> _meter;
475 int _set_state_2X (const XMLNode&, int);
476 void set_processor_state_2X (XMLNodeList const &, int);
478 static uint32_t order_key_cnt;
480 typedef std::map<std::string, long> OrderKeys;
481 OrderKeys order_keys;
483 void input_change_handler (IOChange, void *src);
484 void output_change_handler (IOChange, void *src);
486 bool input_port_count_changing (ChanCount);
488 bool _in_configure_processors;
490 int configure_processors_unlocked (ProcessorStreams*);
491 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
492 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
494 bool add_processor_from_xml_2X (const XMLNode&, int);
496 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
498 void set_self_solo (bool yn);
499 void set_mute_master_solo ();
501 void set_processor_positions ();
504 } // namespace ARDOUR
506 #endif /* __ardour_route_h__ */