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.
19 #ifndef __ardour_route_h__
20 #define __ardour_route_h__
29 #include <boost/shared_ptr.hpp>
30 #include <boost/weak_ptr.hpp>
32 #include <glibmm/threads.h>
33 #include "pbd/fastlog.h"
34 #include "pbd/xml++.h"
36 #include "pbd/stateful.h"
37 #include "pbd/controllable.h"
38 #include "pbd/destructible.h"
40 #include "ardour/ardour.h"
41 #include "ardour/gain_control.h"
42 #include "ardour/instrument_info.h"
43 #include "ardour/io.h"
44 #include "ardour/io_vector.h"
45 #include "ardour/libardour_visibility.h"
46 #include "ardour/types.h"
47 #include "ardour/monitorable.h"
48 #include "ardour/muteable.h"
49 #include "ardour/mute_master.h"
50 #include "ardour/mute_control.h"
51 #include "ardour/route_group_member.h"
52 #include "ardour/stripable.h"
53 #include "ardour/graphnode.h"
54 #include "ardour/automatable.h"
55 #include "ardour/unknown_processor.h"
56 #include "ardour/soloable.h"
57 #include "ardour/solo_control.h"
58 #include "ardour/solo_safe_control.h"
59 #include "ardour/slavable.h"
61 class RoutePinWindowProxy;
77 class MonitorProcessor;
79 class CapturingProcessor;
82 class SoloIsolateControl;
86 class LIBARDOUR_API Route : public Stripable,
91 public RouteGroupMember
95 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
97 Route (Session&, std::string name, PresentationInfo::Flag flags = PresentationInfo::Flag(0), DataType default_type = DataType::AUDIO);
102 boost::shared_ptr<IO> input() const { return _input; }
103 boost::shared_ptr<IO> output() const { return _output; }
104 IOVector all_inputs () const;
105 IOVector all_outputs () const;
107 ChanCount n_inputs() const { return _input->n_ports(); }
108 ChanCount n_outputs() const { return _output->n_ports(); }
110 bool active() const { return _active; }
111 void set_active (bool yn, void *);
113 static std::string ensure_track_or_route_name(std::string, Session &);
115 std::string comment() { return _comment; }
116 void set_comment (std::string str, void *src);
118 bool set_name (const std::string& str);
119 static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
121 MonitorState monitoring_state () const;
122 virtual MeterState metering_state () const;
124 /* these are the core of the API of a Route. see the protected sections as well */
126 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
127 int declick, bool& need_butler);
129 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
130 bool state_changing);
132 virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
135 virtual bool can_record() { return false; }
137 virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
138 virtual void realtime_handle_transport_stopped () {}
139 virtual void realtime_locate () {}
140 virtual void non_realtime_locate (framepos_t);
141 virtual void set_pending_declick (int);
143 /* end of vfunc-based API */
145 void shift (framepos_t, framecnt_t);
147 void set_trim (gain_t val, PBD::Controllable::GroupControlDisposition);
149 /* controls use set_solo() to modify this route's solo state
152 void clear_all_solo_state ();
154 bool soloed_by_others () const { return _solo_control->soloed_by_others(); }
155 bool soloed_by_others_upstream () const { return _solo_control->soloed_by_others_upstream(); }
156 bool soloed_by_others_downstream () const { return _solo_control->soloed_by_others_downstream(); }
157 bool self_soloed () const { return _solo_control->self_soloed(); }
158 bool soloed () const { return self_soloed () || soloed_by_others (); }
160 void push_solo_upstream (int32_t delta);
161 void push_solo_isolate_upstream (int32_t delta);
162 bool can_solo () const {
163 return !(is_master() || is_monitor() || is_auditioner());
165 bool is_safe () const {
166 return _solo_safe_control->get_value();
168 void enable_monitor_send ();
170 void set_denormal_protection (bool yn);
171 bool denormal_protection() const;
173 void set_meter_point (MeterPoint, bool force = false);
174 bool apply_processor_changes_rt ();
175 void emit_pending_signals ();
176 MeterPoint meter_point() const { return _pending_meter_point; }
178 void set_meter_type (MeterType t) { _meter_type = t; }
179 MeterType meter_type() const { return _meter_type; }
183 boost::shared_ptr<Amp> amp() const { return _amp; }
184 boost::shared_ptr<Amp> trim() const { return _trim; }
185 boost::shared_ptr<PeakMeter> peak_meter() { return _meter; }
186 boost::shared_ptr<const PeakMeter> peak_meter() const { return _meter; }
187 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
188 boost::shared_ptr<DelayLine> delay_line() const { return _delayline; }
190 void flush_processors ();
192 void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
193 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
194 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
195 method (boost::weak_ptr<Processor> (*i));
199 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
200 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
201 ProcessorList::iterator i;
202 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
203 if (i == _processors.end()) {
204 return boost::shared_ptr<Processor> ();
210 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
212 boost::shared_ptr<Processor> nth_plugin (uint32_t n) const;
213 boost::shared_ptr<Processor> nth_send (uint32_t n) const;
215 bool has_io_processor_named (const std::string&);
216 ChanCount max_processor_streams () const { return processor_max_streams; }
218 std::list<std::string> unknown_processors () const;
220 RoutePinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
221 void set_pingmgr_proxy (RoutePinWindowProxy* wp) { _pinmgr_proxy = wp ; }
223 boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const;
225 /* special processors */
227 boost::shared_ptr<InternalSend> monitor_send() const { return _monitor_send; }
228 /** the signal processorat at end of the processing chain which produces output */
229 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
230 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
231 boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
232 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
233 void add_internal_return ();
234 void add_send_to_internal_return (InternalSend *);
235 void remove_send_from_internal_return (InternalSend *);
236 void listen_position_changed ();
237 boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
239 /** A record of the stream configuration at some point in the processor list.
240 * Used to return where and why an processor list configuration request failed.
242 struct ProcessorStreams {
243 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
245 uint32_t index; ///< Index of processor where configuration failed
246 ChanCount count; ///< Input requested of processor
249 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
250 int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
251 int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
252 int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
253 boost::shared_ptr<Processor> before_processor_for_placement (Placement);
254 boost::shared_ptr<Processor> before_processor_for_index (int);
255 bool processors_reorder_needs_configure (const ProcessorList& new_order);
256 /** remove plugin/processor
258 * @param proc processor to remove
259 * @param err error report (index where removal vailed, channel-count why it failed) may be nil
260 * @param need_process_lock if locking is required (set to true, unless called from RT context with lock)
261 * @returns 0 on success
263 int remove_processor (boost::shared_ptr<Processor> proc, ProcessorStreams* err = 0, bool need_process_lock = true);
264 /** replace plugin/processor with another
266 * @param old processor to remove
267 * @param sub processor to substitute the old one with
268 * @param err error report (index where removal vailed, channel-count why it failed) may be nil
269 * @returns 0 on success
271 int replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err = 0);
272 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
273 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
274 void disable_processors (Placement);
275 void disable_processors ();
276 void disable_plugins (Placement);
277 void disable_plugins ();
278 void ab_plugins (bool forward);
279 void clear_processors (Placement);
280 void all_visible_processors_active (bool);
281 void move_instrument_down (bool postfader = false);
283 bool strict_io () const { return _strict_io; }
284 bool set_strict_io (bool);
285 /** reset plugin-insert configuration to default, disable customizations.
287 * This is equivalent to calling
289 * customize_plugin_insert (proc, 0, unused)
292 * @param proc Processor to reset
293 * @returns true if successful
295 bool reset_plugin_insert (boost::shared_ptr<Processor> proc);
296 /** enable custom plugin-insert configuration
297 * @param proc Processor to customize
298 * @param count number of plugin instances to use (if zero, reset to default)
299 * @param outs output port customization
300 * @param sinks input pins for variable-I/O plugins
301 * @returns true if successful
303 bool customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks);
304 bool add_remove_sidechain (boost::shared_ptr<Processor> proc, bool);
305 bool plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs);
307 /* enable sidechain input for a given processor
309 * The sidechain itself is an IO port object with variable number of channels and configured independently.
310 * Adding/removing the port itself however requires reconfiguring the route and is hence
311 * not a plugin operation itself.
313 * @param proc the processor to add sidechain inputs to
314 * @returns true on success
316 bool add_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, true); }
317 /* remove sidechain input from given processor
318 * @param proc the processor to remove the sidechain input from
319 * @returns true on success
321 bool remove_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, false); }
323 framecnt_t set_private_port_latencies (bool playback) const;
324 void set_public_port_latencies (framecnt_t, bool playback) const;
326 framecnt_t update_signal_latency();
327 virtual void set_latency_compensation (framecnt_t);
329 void set_user_latency (framecnt_t);
330 framecnt_t initial_delay() const { return _initial_delay; }
331 framecnt_t signal_latency() const { return _signal_latency; }
333 PBD::Signal0<void> active_changed;
334 PBD::Signal0<void> denormal_protection_changed;
335 PBD::Signal0<void> comment_changed;
337 /** track numbers - assigned by session
338 * nubers > 0 indicate tracks (audio+midi)
339 * nubers < 0 indicate busses
340 * zero is reserved for unnumbered special busses.
342 PBD::Signal0<void> track_number_changed;
343 int64_t track_number() const { return _track_number; }
345 void set_track_number(int64_t tn) {
346 if (tn == _track_number) { return; }
348 track_number_changed();
349 PropertyChanged (ARDOUR::Properties::name);
352 enum PluginSetupOptions {
358 static PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, PluginSetupOptions > PluginSetup;
360 /** the processors have changed; the parameter indicates what changed */
361 PBD::Signal1<void,RouteProcessorChange> processors_changed;
362 PBD::Signal0<void> fan_out; // used to signal the GUI to fan-out (track-creation)
363 PBD::Signal1<void,void*> record_enable_changed;
364 PBD::Signal0<void> processor_latency_changed;
365 /** the metering point has changed */
366 PBD::Signal0<void> meter_change;
367 PBD::Signal0<void> signal_latency_changed;
368 PBD::Signal0<void> initial_delay_changed;
370 /** Emitted with the process lock held */
371 PBD::Signal0<void> io_changed;
375 XMLNode& get_state();
376 virtual int set_state (const XMLNode&, int version);
377 virtual XMLNode& get_template();
379 XMLNode& get_processor_state ();
380 virtual void set_processor_state (const XMLNode&);
382 boost::weak_ptr<Route> weakroute ();
384 int save_as_template (const std::string& path, const std::string& name);
386 PBD::Signal1<void,void*> SelectedChanged;
388 int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
389 void remove_aux_or_listen (boost::shared_ptr<Route>);
392 * return true if this route feeds the first argument via at least one
393 * (arbitrarily long) signal pathway.
395 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
398 * return true if this route feeds the first argument directly, via
399 * either its main outs or a send. This is checked by the actual
400 * connections, rather than by what the graph is currently doing.
402 bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
405 * return true if this route feeds the first argument directly, via
406 * either its main outs or a send, according to the graph that
407 * is currently being processed.
409 bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
411 bool feeds_according_to_graph (boost::shared_ptr<Route>);
414 boost::weak_ptr<Route> r;
417 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
419 , sends_only (sendsonly) {}
422 struct FeedRecordCompare {
423 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
428 typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
430 const FedBy& fed_by() const { return _fed_by; }
431 void clear_fed_by ();
432 bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
434 /* Controls (not all directly owned by the Route) */
436 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
438 boost::shared_ptr<SoloControl> solo_control() const {
439 return _solo_control;
442 boost::shared_ptr<MuteControl> mute_control() const {
443 return _mute_control;
446 bool can_be_muted_by_others () const { return can_solo(); }
447 bool muted () const { return _mute_control->muted(); }
448 bool muted_by_masters () const { return _mute_control->muted_by_masters(); }
449 bool muted_by_self () const { return _mute_control->muted_by_self(); }
450 bool muted_by_others_soloing () const;
452 boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const {
453 return _solo_isolate_control;
456 boost::shared_ptr<SoloSafeControl> solo_safe_control() const {
457 return _solo_safe_control;
460 boost::shared_ptr<MonitorControl> monitoring_control() const {
461 /* tracks override this to provide actual monitoring control;
462 busses have no possible choices except input monitoring.
464 return boost::shared_ptr<MonitorControl> ();
467 /* Route doesn't own these items, but sub-objects that it does own have them
468 and to make UI code a bit simpler, we provide direct access to them
472 boost::shared_ptr<Panner> panner() const; /* may return null */
473 boost::shared_ptr<PannerShell> panner_shell() const;
474 boost::shared_ptr<Pannable> pannable() const;
476 boost::shared_ptr<GainControl> gain_control() const;
477 boost::shared_ptr<GainControl> trim_control() const;
478 boost::shared_ptr<PhaseControl> phase_control() const;
481 Return the first processor that accepts has at least one MIDI input
482 and at least one audio output. In the vast majority of cases, this
483 will be "the instrument". This does not preclude other MIDI->audio
484 processors later in the processing chain, but that would be a
485 special case not covered by this utility function.
487 boost::shared_ptr<Processor> the_instrument() const;
488 InstrumentInfo& instrument_info() { return _instrument_info; }
490 /* "well-known" controls for panning. Any or all of these may return
494 boost::shared_ptr<AutomationControl> pan_azimuth_control() const;
495 boost::shared_ptr<AutomationControl> pan_elevation_control() const;
496 boost::shared_ptr<AutomationControl> pan_width_control() const;
497 boost::shared_ptr<AutomationControl> pan_frontback_control() const;
498 boost::shared_ptr<AutomationControl> pan_lfe_control() const;
500 /* "well-known" controls for an EQ in this route. Any or all may
501 * be null. eq_band_cnt() must return 0 if there is no EQ present.
502 * Passing an @param band value >= eq_band_cnt() will guarantee the
503 * return of a null ptr (or an empty string for eq_band_name()).
505 uint32_t eq_band_cnt () const;
506 std::string eq_band_name (uint32_t) const;
507 boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
508 boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const;
509 boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const;
510 boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const;
511 boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const;
513 //additional HP/LP filters
514 boost::shared_ptr<AutomationControl> filter_freq_controllable (bool hpf) const;
515 boost::shared_ptr<AutomationControl> filter_slope_controllable (bool) const;
516 boost::shared_ptr<AutomationControl> filter_enable_controllable (bool) const;
519 /* "well-known" controls for a compressor in this route. Any or all may
522 boost::shared_ptr<AutomationControl> comp_enable_controllable () const;
523 boost::shared_ptr<AutomationControl> comp_threshold_controllable () const;
524 boost::shared_ptr<AutomationControl> comp_speed_controllable () const;
525 boost::shared_ptr<AutomationControl> comp_mode_controllable () const;
526 boost::shared_ptr<AutomationControl> comp_makeup_controllable () const;
527 boost::shared_ptr<ReadOnlyControl> comp_redux_controllable () const;
529 /* @param mode must be supplied by the comp_mode_controllable(). All other values
530 * result in undefined behaviour
532 std::string comp_mode_name (uint32_t mode) const;
533 /* @param mode - as for comp mode name. This returns the name for the
534 * parameter/control accessed via comp_speed_controllable(), which can
537 std::string comp_speed_name (uint32_t mode) const;
539 /* "well-known" controls for sends to well-known busses in this route. Any or all may
542 * In Mixbus, these are the sends that connect to the mixbusses.
543 * In Ardour, these are user-created sends that connect to user-created
546 boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const;
547 boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
548 /* for the same value of @param n, this returns the name of the send
549 * associated with the pair of controllables returned by the above two methods.
551 std::string send_name (uint32_t n) const;
553 /* well known control that enables/disables sending to the master bus.
555 * In Ardour, this returns null.
556 * In Mixbus, it will return a suitable control, or null depending on
559 boost::shared_ptr<AutomationControl> master_send_enable_controllable () const;
561 void protect_automation ();
563 bool has_external_redirects() const;
565 /* can only be executed by a route for which is_monitor() is true
566 * (i.e. the monitor out)
568 void monitor_run (framepos_t start_frame, framepos_t end_frame,
569 pframes_t nframes, int declick);
571 bool slaved_to (boost::shared_ptr<VCA>) const;
572 bool slaved () const;
575 friend class Session;
577 void catch_up_on_solo_mute_override ();
578 void set_listen (bool);
580 void curve_reallocate ();
581 virtual void set_block_size (pframes_t nframes);
583 virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
585 void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
587 void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick);
589 virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
590 framecnt_t /* nframes */) {}
592 virtual void process_output_buffers (BufferSet& bufs,
593 framepos_t start_frame, framepos_t end_frame,
594 pframes_t nframes, int declick,
595 bool gain_automation_ok);
597 void flush_processor_buffers_locked (framecnt_t nframes);
599 virtual void bounce_process (BufferSet& bufs,
600 framepos_t start_frame, framecnt_t nframes,
601 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
602 bool for_export, bool for_freeze);
604 framecnt_t bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
605 ChanCount bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
607 boost::shared_ptr<IO> _input;
608 boost::shared_ptr<IO> _output;
611 framecnt_t _signal_latency;
612 framecnt_t _signal_latency_at_amp_position;
613 framecnt_t _signal_latency_at_trim_position;
614 framecnt_t _initial_delay;
615 framecnt_t _roll_delay;
617 ProcessorList _processors;
618 mutable Glib::Threads::RWLock _processor_lock;
619 boost::shared_ptr<Delivery> _main_outs;
620 boost::shared_ptr<InternalSend> _monitor_send;
621 boost::shared_ptr<InternalReturn> _intreturn;
622 boost::shared_ptr<MonitorProcessor> _monitor_control;
623 boost::shared_ptr<Pannable> _pannable;
627 EmitMeterChanged = 0x01,
628 EmitMeterVisibilityChange = 0x02,
629 EmitRtProcessorChange = 0x04
632 ProcessorList _pending_processor_order;
633 gint _pending_process_reorder; // atomic
634 gint _pending_signals; // atomic
636 int _pending_declick;
637 MeterPoint _meter_point;
638 MeterPoint _pending_meter_point;
639 MeterType _meter_type;
641 bool _denormal_protection;
643 bool _recordable : 1;
645 bool _declickable : 1;
647 boost::shared_ptr<SoloControl> _solo_control;
648 boost::shared_ptr<MuteControl> _mute_control;
649 boost::shared_ptr<PhaseControl> _phase_control;
650 boost::shared_ptr<SoloIsolateControl> _solo_isolate_control;
651 boost::shared_ptr<SoloSafeControl> _solo_safe_control;
653 std::string _comment;
654 bool _have_internal_generator;
655 DataType _default_type;
658 InstrumentInfo _instrument_info;
660 virtual ChanCount input_streams () const;
662 virtual XMLNode& state(bool);
664 int configure_processors (ProcessorStreams*);
666 void passthru_silence (framepos_t start_frame, framepos_t end_frame,
667 pframes_t nframes, int declick);
669 void silence (framecnt_t);
670 void silence_unlocked (framecnt_t);
672 ChanCount processor_max_streams;
673 ChanCount processor_out_streams;
675 uint32_t pans_required() const;
676 ChanCount n_process_buffers ();
678 virtual void maybe_declick (BufferSet&, framecnt_t, int);
680 boost::shared_ptr<GainControl> _gain_control;
681 boost::shared_ptr<Amp> _amp;
682 boost::shared_ptr<GainControl> _trim_control;
683 boost::shared_ptr<Amp> _trim;
684 boost::shared_ptr<PeakMeter> _meter;
685 boost::shared_ptr<DelayLine> _delayline;
687 boost::shared_ptr<Processor> the_instrument_unlocked() const;
689 SlavableControlList slavables () const;
692 int64_t _track_number;
694 int set_state_2X (const XMLNode&, int);
695 void set_processor_state_2X (XMLNodeList const &, int);
697 void input_change_handler (IOChange, void *src);
698 void output_change_handler (IOChange, void *src);
699 void sidechain_change_handler (IOChange, void *src);
701 void processor_selfdestruct (boost::weak_ptr<Processor>);
702 std::vector<boost::weak_ptr<Processor> > selfdestruct_sequence;
703 Glib::Threads::Mutex selfdestruct_lock;
705 bool input_port_count_changing (ChanCount);
706 bool output_port_count_changing (ChanCount);
708 bool _in_configure_processors;
709 bool _initial_io_setup;
710 bool _in_sidechain_setup;
712 int configure_processors_unlocked (ProcessorStreams*, Glib::Threads::RWLock::WriterLock*);
713 bool set_meter_point_unlocked ();
714 void apply_processor_order (const ProcessorList& new_order);
716 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
717 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
719 bool add_processor_from_xml_2X (const XMLNode&, int);
721 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
723 void set_self_solo (bool yn);
725 void set_processor_positions ();
726 framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
728 void setup_invisible_processors ();
731 void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
733 boost::shared_ptr<CapturingProcessor> _capturing_processor;
735 /** A handy class to keep processor state while we attempt a reconfiguration
738 class ProcessorState {
740 ProcessorState (Route* r)
742 , _processors (r->_processors)
743 , _processor_max_streams (r->processor_max_streams)
747 _route->_processors = _processors;
748 _route->processor_max_streams = _processor_max_streams;
752 /* this should perhaps be a shared_ptr, but ProcessorStates will
753 not hang around long enough for it to matter.
756 ProcessorList _processors;
757 ChanCount _processor_max_streams;
760 friend class ProcessorState;
764 /* no copy construction */
765 Route (Route const &);
767 void maybe_note_meter_position ();
769 /** true if we've made a note of a custom meter position in these variables */
770 bool _custom_meter_position_noted;
771 /** the processor that came after the meter when it was last set to a custom position,
774 boost::weak_ptr<Processor> _processor_after_last_custom_meter;
775 RoutePinWindowProxy *_pinmgr_proxy;
777 void reset_instrument_info ();
779 void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
782 } // namespace ARDOUR
784 #endif /* __ardour_route_h__ */