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, bool group_override = false);
162 bool soloed () const { return self_soloed () || soloed_by_others (); }
163 void clear_all_solo_state ();
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, bool group_override = false);
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 method (boost::weak_ptr<Processor> (*i));
214 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
215 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
216 ProcessorList::iterator i;
217 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
218 if (i == _processors.end()) {
219 return boost::shared_ptr<Processor> ();
225 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
227 boost::shared_ptr<Processor> nth_plugin (uint32_t n);
228 boost::shared_ptr<Processor> nth_send (uint32_t n);
230 bool has_io_processor_named (const std::string&);
231 ChanCount max_processor_streams () const { return processor_max_streams; }
233 std::list<std::string> unknown_processors () const;
235 /* special processors */
237 boost::shared_ptr<InternalSend> monitor_send() const { return _monitor_send; }
238 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
239 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
240 boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
241 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
242 void add_internal_return ();
243 void add_send_to_internal_return (InternalSend *);
244 void remove_send_from_internal_return (InternalSend *);
245 void listen_position_changed ();
246 boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
248 /** A record of the stream configuration at some point in the processor list.
249 * Used to return where and why an processor list configuration request failed.
251 struct ProcessorStreams {
252 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
254 uint32_t index; ///< Index of processor where configuration failed
255 ChanCount count; ///< Input requested of processor
258 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
259 int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
260 int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
261 int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
262 boost::shared_ptr<Processor> before_processor_for_placement (Placement);
263 boost::shared_ptr<Processor> before_processor_for_index (int);
264 bool processors_reorder_needs_configure (const ProcessorList& new_order);
265 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
266 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
267 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
268 void disable_processors (Placement);
269 void disable_processors ();
270 void disable_plugins (Placement);
271 void disable_plugins ();
272 void ab_plugins (bool forward);
273 void clear_processors (Placement);
274 void all_visible_processors_active (bool);
276 framecnt_t set_private_port_latencies (bool playback) const;
277 void set_public_port_latencies (framecnt_t, bool playback) const;
279 framecnt_t update_signal_latency();
280 virtual void set_latency_compensation (framecnt_t);
282 void set_user_latency (framecnt_t);
283 framecnt_t initial_delay() const { return _initial_delay; }
284 framecnt_t signal_latency() const { return _signal_latency; }
286 PBD::Signal0<void> active_changed;
287 PBD::Signal0<void> phase_invert_changed;
288 PBD::Signal0<void> denormal_protection_changed;
289 PBD::Signal2<void,void*,bool> listen_changed;
290 PBD::Signal3<void,bool,void*,bool> solo_changed;
291 PBD::Signal1<void,void*> solo_safe_changed;
292 PBD::Signal1<void,void*> solo_isolated_changed;
293 PBD::Signal1<void,void*> comment_changed;
294 PBD::Signal1<void,void*> mute_changed;
295 PBD::Signal0<void> mute_points_changed;
297 /** track numbers - assigned by session
298 * nubers > 0 indicate tracks (audio+midi)
299 * nubers < 0 indicate busses
300 * zero is reserved for unnumbered special busses.
302 PBD::Signal0<void> track_number_changed;
303 int64_t track_number() const { return _track_number; }
305 void set_track_number(int64_t tn) {
306 if (tn == _track_number) { return; }
308 track_number_changed();
309 PropertyChanged (ARDOUR::Properties::name);
312 /** the processors have changed; the parameter indicates what changed */
313 PBD::Signal1<void,RouteProcessorChange> processors_changed;
314 PBD::Signal1<void,void*> record_enable_changed;
315 /** the metering point has changed */
316 PBD::Signal0<void> meter_change;
317 PBD::Signal0<void> signal_latency_changed;
318 PBD::Signal0<void> initial_delay_changed;
320 /** Emitted with the process lock held */
321 PBD::Signal0<void> io_changed;
323 /* gui's call this for their own purposes. */
325 PBD::Signal2<void,std::string,void*> gui_changed;
329 XMLNode& get_state();
330 virtual int set_state (const XMLNode&, int version);
331 virtual XMLNode& get_template();
333 XMLNode& get_processor_state ();
334 virtual void set_processor_state (const XMLNode&);
336 int save_as_template (const std::string& path, const std::string& name);
338 PBD::Signal1<void,void*> SelectedChanged;
340 int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
341 void remove_aux_or_listen (boost::shared_ptr<Route>);
344 * return true if this route feeds the first argument via at least one
345 * (arbitrarily long) signal pathway.
347 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
350 * return true if this route feeds the first argument directly, via
351 * either its main outs or a send. This is checked by the actual
352 * connections, rather than by what the graph is currently doing.
354 bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
357 * return true if this route feeds the first argument directly, via
358 * either its main outs or a send, according to the graph that
359 * is currently being processed.
361 bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
364 boost::weak_ptr<Route> r;
367 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
369 , sends_only (sendsonly) {}
372 struct FeedRecordCompare {
373 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
378 typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
380 const FedBy& fed_by() const { return _fed_by; }
381 void clear_fed_by ();
382 bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
384 /* Controls (not all directly owned by the Route */
386 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
388 class SoloControllable : public AutomationControl {
390 SoloControllable (std::string name, boost::shared_ptr<Route>);
391 void set_value (double);
392 double get_value () const;
395 boost::weak_ptr<Route> _route;
398 struct MuteControllable : public AutomationControl {
400 MuteControllable (std::string name, boost::shared_ptr<Route>);
401 void set_value (double);
402 double get_value () const;
404 /* Pretend to change value, but do not affect actual route mute. */
405 void set_superficial_value(bool muted);
408 boost::weak_ptr<Route> _route;
411 boost::shared_ptr<SoloControllable> solo_control() const {
412 return _solo_control;
415 boost::shared_ptr<MuteControllable> mute_control() const {
416 return _mute_control;
419 boost::shared_ptr<MuteMaster> mute_master() const {
423 /* Route doesn't own these items, but sub-objects that it does own have them
424 and to make UI code a bit simpler, we provide direct access to them
428 boost::shared_ptr<Panner> panner() const; /* may return null */
429 boost::shared_ptr<PannerShell> panner_shell() const;
430 boost::shared_ptr<AutomationControl> gain_control() const;
431 boost::shared_ptr<Pannable> pannable() const;
432 boost::shared_ptr<AutomationControl> trim_control() const;
435 Return the first processor that accepts has at least one MIDI input
436 and at least one audio output. In the vast majority of cases, this
437 will be "the instrument". This does not preclude other MIDI->audio
438 processors later in the processing chain, but that would be a
439 special case not covered by this utility function.
441 boost::shared_ptr<Processor> the_instrument() const;
442 InstrumentInfo& instrument_info() { return _instrument_info; }
444 void protect_automation ();
447 /* These numbers are taken from MIDI Machine Control,
448 which can only control up to 317 tracks without
449 doing sysex segmentation.
451 MasterBusRemoteControlID = 318,
452 MonitorBusRemoteControlID = 319,
455 void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
456 uint32_t remote_control_id () const;
457 void set_remote_control_id_explicit (uint32_t order_key);
459 /* for things concerned about *this* route's RID */
461 PBD::Signal0<void> RemoteControlIDChanged;
463 /* for things concerned about *any* route's RID changes */
465 static PBD::Signal0<void> RemoteControlIDChange;
466 static PBD::Signal0<void> SyncOrderKeys;
468 bool has_external_redirects() const;
470 /* can only be executed by a route for which is_monitor() is true
471 (i.e. the monitor out)
473 void monitor_run (framepos_t start_frame, framepos_t end_frame,
474 pframes_t nframes, int declick);
477 friend class Session;
479 void catch_up_on_solo_mute_override ();
480 void mod_solo_by_others_upstream (int32_t);
481 void mod_solo_by_others_downstream (int32_t);
482 void curve_reallocate ();
483 virtual void set_block_size (pframes_t nframes);
486 virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
488 void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
490 void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
491 pframes_t nframes, int declick);
493 virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
494 framecnt_t /* nframes */) {}
496 virtual void process_output_buffers (BufferSet& bufs,
497 framepos_t start_frame, framepos_t end_frame,
498 pframes_t nframes, int declick,
499 bool gain_automation_ok);
501 virtual void bounce_process (BufferSet& bufs,
502 framepos_t start_frame, framecnt_t nframes,
503 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
504 bool for_export, bool for_freeze);
506 framecnt_t bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
507 ChanCount bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
509 boost::shared_ptr<IO> _input;
510 boost::shared_ptr<IO> _output;
513 framecnt_t _signal_latency;
514 framecnt_t _signal_latency_at_amp_position;
515 framecnt_t _signal_latency_at_trim_position;
516 framecnt_t _initial_delay;
517 framecnt_t _roll_delay;
519 ProcessorList _processors;
520 mutable Glib::Threads::RWLock _processor_lock;
521 boost::shared_ptr<Delivery> _main_outs;
522 boost::shared_ptr<InternalSend> _monitor_send;
523 boost::shared_ptr<InternalReturn> _intreturn;
524 boost::shared_ptr<MonitorProcessor> _monitor_control;
525 boost::shared_ptr<Pannable> _pannable;
529 EmitMeterChanged = 0x01,
530 EmitMeterVisibilityChange = 0x02,
531 EmitRtProcessorChange = 0x04
534 ProcessorList _pending_processor_order;
535 gint _pending_process_reorder; // atomic
536 gint _pending_signals; // atomic
539 int _pending_declick;
540 MeterPoint _meter_point;
541 MeterPoint _pending_meter_point;
542 MeterType _meter_type;
543 boost::dynamic_bitset<> _phase_invert;
545 uint32_t _soloed_by_others_upstream;
546 uint32_t _soloed_by_others_downstream;
548 uint32_t _solo_isolated_by_upstream;
550 void mod_solo_isolated_by_upstream (bool, void*);
552 bool _denormal_protection;
554 bool _recordable : 1;
556 bool _declickable : 1;
558 boost::shared_ptr<SoloControllable> _solo_control;
559 boost::shared_ptr<MuteControllable> _mute_control;
560 boost::shared_ptr<MuteMaster> _mute_master;
562 virtual void act_on_mute () {}
564 std::string _comment;
565 bool _have_internal_generator;
567 DataType _default_type;
570 InstrumentInfo _instrument_info;
572 virtual ChanCount input_streams () const;
575 virtual XMLNode& state(bool);
577 int configure_processors (ProcessorStreams*);
579 void passthru_silence (framepos_t start_frame, framepos_t end_frame,
580 pframes_t nframes, int declick);
582 void silence (framecnt_t);
583 void silence_unlocked (framecnt_t);
585 ChanCount processor_max_streams;
586 ChanCount processor_out_streams;
588 uint32_t pans_required() const;
589 ChanCount n_process_buffers ();
591 virtual void maybe_declick (BufferSet&, framecnt_t, int);
593 boost::shared_ptr<Amp> _amp;
594 boost::shared_ptr<Amp> _trim;
595 boost::shared_ptr<PeakMeter> _meter;
596 boost::shared_ptr<DelayLine> _delayline;
598 boost::shared_ptr<Processor> the_instrument_unlocked() const;
601 int set_state_2X (const XMLNode&, int);
602 void set_processor_state_2X (XMLNodeList const &, int);
606 uint32_t _remote_control_id;
608 int64_t _track_number;
610 void input_change_handler (IOChange, void *src);
611 void output_change_handler (IOChange, void *src);
613 bool input_port_count_changing (ChanCount);
614 bool output_port_count_changing (ChanCount);
616 bool _in_configure_processors;
617 bool _initial_io_setup;
619 int configure_processors_unlocked (ProcessorStreams*);
620 bool set_meter_point_unlocked ();
621 void apply_processor_order (const ProcessorList& new_order);
623 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
624 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
626 bool add_processor_from_xml_2X (const XMLNode&, int);
628 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
630 void set_self_solo (bool yn);
631 void set_mute_master_solo ();
633 void set_processor_positions ();
634 framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
636 void setup_invisible_processors ();
639 boost::shared_ptr<CapturingProcessor> _capturing_processor;
641 /** A handy class to keep processor state while we attempt a reconfiguration
644 class ProcessorState {
646 ProcessorState (Route* r)
648 , _processors (r->_processors)
649 , _processor_max_streams (r->processor_max_streams)
653 _route->_processors = _processors;
654 _route->processor_max_streams = _processor_max_streams;
658 /* this should perhaps be a shared_ptr, but ProcessorStates will
659 not hang around long enough for it to matter.
662 ProcessorList _processors;
663 ChanCount _processor_max_streams;
666 friend class ProcessorState;
668 /* no copy construction */
669 Route (Route const &);
671 void maybe_note_meter_position ();
673 /** true if we've made a note of a custom meter position in these variables */
674 bool _custom_meter_position_noted;
675 /** the processor that came after the meter when it was last set to a custom position,
678 boost::weak_ptr<Processor> _processor_after_last_custom_meter;
680 void reset_instrument_info ();
682 void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
685 } // namespace ARDOUR
687 #endif /* __ardour_route_h__ */