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>
33 #include <boost/enable_shared_from_this.hpp>
35 #include <glibmm/threads.h>
36 #include "pbd/fastlog.h"
37 #include "pbd/xml++.h"
39 #include "pbd/stateful.h"
40 #include "pbd/controllable.h"
41 #include "pbd/destructible.h"
43 #include "ardour/ardour.h"
44 #include "ardour/instrument_info.h"
45 #include "ardour/io.h"
46 #include "ardour/libardour_visibility.h"
47 #include "ardour/types.h"
48 #include "ardour/mute_master.h"
49 #include "ardour/route_group_member.h"
50 #include "ardour/graphnode.h"
51 #include "ardour/automatable.h"
52 #include "ardour/unknown_processor.h"
67 class MonitorProcessor;
69 class CapturingProcessor;
72 class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
76 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
84 Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
89 boost::shared_ptr<IO> input() const { return _input; }
90 boost::shared_ptr<IO> output() const { return _output; }
92 ChanCount n_inputs() const { return _input->n_ports(); }
93 ChanCount n_outputs() const { return _output->n_ports(); }
95 bool active() const { return _active; }
96 void set_active (bool yn, void *);
98 static std::string ensure_track_or_route_name(std::string, Session &);
100 std::string comment() { return _comment; }
101 void set_comment (std::string str, void *src);
103 bool set_name (const std::string& str);
104 static void set_name_in_state (XMLNode &, const std::string &);
106 uint32_t order_key () const;
107 bool has_order_key () const;
108 void set_order_key (uint32_t);
110 bool is_auditioner() const { return _flags & Auditioner; }
111 bool is_master() const { return _flags & MasterOut; }
112 bool is_monitor() const { return _flags & MonitorOut; }
114 virtual MonitorState monitoring_state () const;
115 virtual MeterState metering_state () const;
117 /* these are the core of the API of a Route. see the protected sections as well */
119 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
120 int declick, bool& need_butler);
122 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
123 bool state_changing);
125 virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
128 virtual bool can_record() { return false; }
130 virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
131 virtual bool record_enabled() const { return false; }
132 virtual void set_record_safe (bool yn, void *src) {}
133 virtual bool record_safe () const {return false; }
134 virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
135 virtual void realtime_handle_transport_stopped () {}
136 virtual void realtime_locate () {}
137 virtual void non_realtime_locate (framepos_t);
138 virtual void set_pending_declick (int);
140 /* end of vfunc-based API */
142 void shift (framepos_t, framecnt_t);
144 void set_gain (gain_t val, void *src);
145 void inc_gain (gain_t delta, void *src);
147 void set_trim (gain_t val, void *src);
148 void inc_trim (gain_t delta, void *src);
150 void set_mute_points (MuteMaster::MutePoint);
151 MuteMaster::MutePoint mute_points () const;
154 void set_mute (bool yn, void* src);
156 bool muted_by_others() const;
158 /* controls use set_solo() to modify this route's solo state
161 void set_solo (bool yn, void *src);
162 bool soloed () const { return self_soloed () || soloed_by_others (); }
163 void cancel_solo_after_disconnect (bool upstream);
165 bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
166 bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
167 bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
168 bool self_soloed () const { return _self_solo; }
170 void set_solo_isolated (bool yn, void *src);
171 bool solo_isolated() const;
173 void set_solo_safe (bool yn, void *src);
174 bool solo_safe() const;
176 void set_listen (bool yn, void* src);
177 bool listening_via_monitor () const;
178 void enable_monitor_send ();
180 void set_phase_invert (uint32_t, bool yn);
181 void set_phase_invert (boost::dynamic_bitset<>);
182 bool phase_invert (uint32_t) const;
183 boost::dynamic_bitset<> phase_invert () const;
185 void set_denormal_protection (bool yn);
186 bool denormal_protection() const;
188 void set_meter_point (MeterPoint, bool force = false);
189 bool apply_processor_changes_rt ();
190 void emit_pending_signals ();
191 MeterPoint meter_point() const { return _pending_meter_point; }
193 void set_meter_type (MeterType t) { _meter_type = t; }
194 MeterType meter_type() const { return _meter_type; }
198 boost::shared_ptr<Amp> amp() const { return _amp; }
199 boost::shared_ptr<Amp> trim() const { return _trim; }
200 PeakMeter& peak_meter() { return *_meter.get(); }
201 const PeakMeter& peak_meter() const { return *_meter.get(); }
202 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
203 boost::shared_ptr<DelayLine> delay_line() const { return _delayline; }
205 void flush_processors ();
207 void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
208 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
209 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
210 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
213 method (boost::weak_ptr<Processor> (*i));
217 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
218 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
219 ProcessorList::iterator i;
220 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
221 if (i == _processors.end()) {
222 return boost::shared_ptr<Processor> ();
228 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
230 boost::shared_ptr<Processor> nth_plugin (uint32_t n);
231 boost::shared_ptr<Processor> nth_send (uint32_t n);
233 bool has_io_processor_named (const std::string&);
234 ChanCount max_processor_streams () const { return processor_max_streams; }
236 std::list<std::string> unknown_processors () const;
238 /* special processors */
240 boost::shared_ptr<InternalSend> monitor_send() const { return _monitor_send; }
241 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
242 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
243 boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
244 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
245 void add_internal_return ();
246 void add_send_to_internal_return (InternalSend *);
247 void remove_send_from_internal_return (InternalSend *);
248 void listen_position_changed ();
249 boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
251 /** A record of the stream configuration at some point in the processor list.
252 * Used to return where and why an processor list configuration request failed.
254 struct ProcessorStreams {
255 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
257 uint32_t index; ///< Index of processor where configuration failed
258 ChanCount count; ///< Input requested of processor
261 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
262 int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
263 int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
264 int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
265 boost::shared_ptr<Processor> before_processor_for_placement (Placement);
266 boost::shared_ptr<Processor> before_processor_for_index (int);
267 bool processors_reorder_needs_configure (const ProcessorList& new_order);
268 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
269 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
270 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
271 void disable_processors (Placement);
272 void disable_processors ();
273 void disable_plugins (Placement);
274 void disable_plugins ();
275 void ab_plugins (bool forward);
276 void clear_processors (Placement);
277 void all_visible_processors_active (bool);
279 framecnt_t set_private_port_latencies (bool playback) const;
280 void set_public_port_latencies (framecnt_t, bool playback) const;
282 framecnt_t update_signal_latency();
283 virtual void set_latency_compensation (framecnt_t);
285 void set_user_latency (framecnt_t);
286 framecnt_t initial_delay() const { return _initial_delay; }
287 framecnt_t signal_latency() const { return _signal_latency; }
289 PBD::Signal0<void> active_changed;
290 PBD::Signal0<void> phase_invert_changed;
291 PBD::Signal0<void> denormal_protection_changed;
292 PBD::Signal1<void,void*> listen_changed;
293 PBD::Signal2<void,bool,void*> solo_changed;
294 PBD::Signal1<void,void*> solo_safe_changed;
295 PBD::Signal1<void,void*> solo_isolated_changed;
296 PBD::Signal1<void,void*> comment_changed;
297 PBD::Signal1<void,void*> mute_changed;
298 PBD::Signal0<void> mute_points_changed;
300 /** track numbers - assigned by session
301 * nubers > 0 indicate tracks (audio+midi)
302 * nubers < 0 indicate busses
303 * zero is reserved for unnumbered special busses.
305 PBD::Signal0<void> track_number_changed;
306 int64_t track_number() const { return _track_number; }
308 void set_track_number(int64_t tn) {
309 if (tn == _track_number) { return; }
311 track_number_changed();
312 PropertyChanged (ARDOUR::Properties::name);
315 /** the processors have changed; the parameter indicates what changed */
316 PBD::Signal1<void,RouteProcessorChange> processors_changed;
317 PBD::Signal1<void,void*> record_enable_changed;
318 /** the metering point has changed */
319 PBD::Signal0<void> meter_change;
320 PBD::Signal0<void> signal_latency_changed;
321 PBD::Signal0<void> initial_delay_changed;
323 /** Emitted with the process lock held */
324 PBD::Signal0<void> io_changed;
326 /* gui's call this for their own purposes. */
328 PBD::Signal2<void,std::string,void*> gui_changed;
332 XMLNode& get_state();
333 virtual int set_state (const XMLNode&, int version);
334 virtual XMLNode& get_template();
336 XMLNode& get_processor_state ();
337 virtual void set_processor_state (const XMLNode&);
339 int save_as_template (const std::string& path, const std::string& name);
341 PBD::Signal1<void,void*> SelectedChanged;
343 int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
344 void remove_aux_or_listen (boost::shared_ptr<Route>);
347 * return true if this route feeds the first argument via at least one
348 * (arbitrarily long) signal pathway.
350 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
353 * return true if this route feeds the first argument directly, via
354 * either its main outs or a send. This is checked by the actual
355 * connections, rather than by what the graph is currently doing.
357 bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
360 * return true if this route feeds the first argument directly, via
361 * either its main outs or a send, according to the graph that
362 * is currently being processed.
364 bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
367 boost::weak_ptr<Route> r;
370 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
372 , sends_only (sendsonly) {}
375 struct FeedRecordCompare {
376 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
381 typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
383 const FedBy& fed_by() const { return _fed_by; }
384 void clear_fed_by ();
385 bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
387 /* Controls (not all directly owned by the Route */
389 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
391 class SoloControllable : public AutomationControl {
393 SoloControllable (std::string name, boost::shared_ptr<Route>);
394 void set_value (double);
395 double get_value () const;
398 boost::weak_ptr<Route> _route;
401 struct MuteControllable : public AutomationControl {
403 MuteControllable (std::string name, boost::shared_ptr<Route>);
404 void set_value (double);
405 double get_value () const;
407 /* Pretend to change value, but do not affect actual route mute. */
408 void set_superficial_value(bool muted);
411 boost::weak_ptr<Route> _route;
414 boost::shared_ptr<SoloControllable> solo_control() const {
415 return _solo_control;
418 boost::shared_ptr<MuteControllable> mute_control() const {
419 return _mute_control;
422 boost::shared_ptr<MuteMaster> mute_master() const {
426 /* Route doesn't own these items, but sub-objects that it does own have them
427 and to make UI code a bit simpler, we provide direct access to them
431 boost::shared_ptr<Panner> panner() const; /* may return null */
432 boost::shared_ptr<PannerShell> panner_shell() const;
433 boost::shared_ptr<AutomationControl> gain_control() const;
434 boost::shared_ptr<Pannable> pannable() const;
437 Return the first processor that accepts has at least one MIDI input
438 and at least one audio output. In the vast majority of cases, this
439 will be "the instrument". This does not preclude other MIDI->audio
440 processors later in the processing chain, but that would be a
441 special case not covered by this utility function.
443 boost::shared_ptr<Processor> the_instrument() const;
444 InstrumentInfo& instrument_info() { return _instrument_info; }
446 void protect_automation ();
449 /* These numbers are taken from MIDI Machine Control,
450 which can only control up to 317 tracks without
451 doing sysex segmentation.
453 MasterBusRemoteControlID = 318,
454 MonitorBusRemoteControlID = 319,
457 void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
458 uint32_t remote_control_id () const;
459 void set_remote_control_id_explicit (uint32_t order_key);
461 /* for things concerned about *this* route's RID */
463 PBD::Signal0<void> RemoteControlIDChanged;
465 /* for things concerned about *any* route's RID changes */
467 static PBD::Signal0<void> RemoteControlIDChange;
468 static PBD::Signal0<void> SyncOrderKeys;
470 bool has_external_redirects() const;
472 /* can only be executed by a route for which is_monitor() is true
473 (i.e. the monitor out)
475 void monitor_run (framepos_t start_frame, framepos_t end_frame,
476 pframes_t nframes, int declick);
479 friend class Session;
481 void catch_up_on_solo_mute_override ();
482 void mod_solo_by_others_upstream (int32_t);
483 void mod_solo_by_others_downstream (int32_t);
484 void curve_reallocate ();
485 virtual void set_block_size (pframes_t nframes);
488 virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
490 void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
492 void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
493 pframes_t nframes, int declick);
495 virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
496 framecnt_t /* nframes */) {}
498 virtual void process_output_buffers (BufferSet& bufs,
499 framepos_t start_frame, framepos_t end_frame,
500 pframes_t nframes, int declick,
501 bool gain_automation_ok);
503 virtual void bounce_process (BufferSet& bufs,
504 framepos_t start_frame, framecnt_t nframes,
505 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
506 bool for_export, bool for_freeze);
508 framecnt_t bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
509 ChanCount bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
511 boost::shared_ptr<IO> _input;
512 boost::shared_ptr<IO> _output;
515 framecnt_t _signal_latency;
516 framecnt_t _signal_latency_at_amp_position;
517 framecnt_t _signal_latency_at_trim_position;
518 framecnt_t _initial_delay;
519 framecnt_t _roll_delay;
521 ProcessorList _processors;
522 mutable Glib::Threads::RWLock _processor_lock;
523 boost::shared_ptr<Delivery> _main_outs;
524 boost::shared_ptr<InternalSend> _monitor_send;
525 boost::shared_ptr<InternalReturn> _intreturn;
526 boost::shared_ptr<MonitorProcessor> _monitor_control;
527 boost::shared_ptr<Pannable> _pannable;
531 EmitMeterChanged = 0x01,
532 EmitMeterVisibilityChange = 0x02,
533 EmitRtProcessorChange = 0x04
536 ProcessorList _pending_processor_order;
537 gint _pending_process_reorder; // atomic
538 gint _pending_signals; // atomic
541 int _pending_declick;
542 MeterPoint _meter_point;
543 MeterPoint _pending_meter_point;
544 MeterType _meter_type;
545 boost::dynamic_bitset<> _phase_invert;
547 uint32_t _soloed_by_others_upstream;
548 uint32_t _soloed_by_others_downstream;
550 uint32_t _solo_isolated_by_upstream;
552 void mod_solo_isolated_by_upstream (bool, void*);
554 bool _denormal_protection;
556 bool _recordable : 1;
558 bool _declickable : 1;
560 boost::shared_ptr<SoloControllable> _solo_control;
561 boost::shared_ptr<MuteControllable> _mute_control;
562 boost::shared_ptr<MuteMaster> _mute_master;
564 virtual void act_on_mute () {}
566 std::string _comment;
567 bool _have_internal_generator;
569 DataType _default_type;
572 InstrumentInfo _instrument_info;
574 virtual ChanCount input_streams () const;
577 virtual XMLNode& state(bool);
579 int configure_processors (ProcessorStreams*);
581 void passthru_silence (framepos_t start_frame, framepos_t end_frame,
582 pframes_t nframes, int declick);
584 void silence (framecnt_t);
585 void silence_unlocked (framecnt_t);
587 ChanCount processor_max_streams;
588 ChanCount processor_out_streams;
590 uint32_t pans_required() const;
591 ChanCount n_process_buffers ();
593 virtual void maybe_declick (BufferSet&, framecnt_t, int);
595 boost::shared_ptr<Amp> _amp;
596 boost::shared_ptr<Amp> _trim;
597 boost::shared_ptr<PeakMeter> _meter;
598 boost::shared_ptr<DelayLine> _delayline;
600 boost::shared_ptr<Processor> the_instrument_unlocked() const;
603 int set_state_2X (const XMLNode&, int);
604 void set_processor_state_2X (XMLNodeList const &, int);
608 uint32_t _remote_control_id;
610 int64_t _track_number;
612 void input_change_handler (IOChange, void *src);
613 void output_change_handler (IOChange, void *src);
615 bool input_port_count_changing (ChanCount);
616 bool output_port_count_changing (ChanCount);
618 bool _in_configure_processors;
619 bool _initial_io_setup;
621 int configure_processors_unlocked (ProcessorStreams*);
622 bool set_meter_point_unlocked ();
623 void apply_processor_order (const ProcessorList& new_order);
625 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
626 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
628 bool add_processor_from_xml_2X (const XMLNode&, int);
630 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
632 void set_self_solo (bool yn);
633 void set_mute_master_solo ();
635 void set_processor_positions ();
636 framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
638 void setup_invisible_processors ();
641 boost::shared_ptr<CapturingProcessor> _capturing_processor;
643 /** A handy class to keep processor state while we attempt a reconfiguration
646 class ProcessorState {
648 ProcessorState (Route* r)
650 , _processors (r->_processors)
651 , _processor_max_streams (r->processor_max_streams)
655 _route->_processors = _processors;
656 _route->processor_max_streams = _processor_max_streams;
660 /* this should perhaps be a shared_ptr, but ProcessorStates will
661 not hang around long enough for it to matter.
664 ProcessorList _processors;
665 ChanCount _processor_max_streams;
668 friend class ProcessorState;
670 /* no copy construction */
671 Route (Route const &);
673 void maybe_note_meter_position ();
675 /** true if we've made a note of a custom meter position in these variables */
676 bool _custom_meter_position_noted;
677 /** the processor that came after the meter when it was last set to a custom position,
680 boost::weak_ptr<Processor> _processor_after_last_custom_meter;
682 void reset_instrument_info ();
684 void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
687 } // namespace ARDOUR
689 #endif /* __ardour_route_h__ */