2 Copyright (C) 2000 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.
21 #include "libardour-config.h"
29 #include <boost/algorithm/string.hpp>
31 #include "pbd/xml++.h"
32 #include "pbd/enumwriter.h"
33 #include "pbd/memento_command.h"
34 #include "pbd/stacktrace.h"
35 #include "pbd/convert.h"
36 #include "pbd/unwind.h"
38 #include "ardour/amp.h"
39 #include "ardour/audio_buffer.h"
40 #include "ardour/audio_track.h"
41 #include "ardour/audio_port.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/boost_debug.h"
44 #include "ardour/buffer.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/capturing_processor.h"
47 #include "ardour/debug.h"
48 #include "ardour/delivery.h"
49 #include "ardour/gain_control.h"
50 #include "ardour/internal_return.h"
51 #include "ardour/internal_send.h"
52 #include "ardour/meter.h"
53 #include "ardour/delayline.h"
54 #include "ardour/midi_buffer.h"
55 #include "ardour/midi_port.h"
56 #include "ardour/monitor_processor.h"
57 #include "ardour/pannable.h"
58 #include "ardour/panner.h"
59 #include "ardour/panner_shell.h"
60 #include "ardour/parameter_descriptor.h"
61 #include "ardour/phase_control.h"
62 #include "ardour/plugin_insert.h"
63 #include "ardour/port.h"
64 #include "ardour/port_insert.h"
65 #include "ardour/processor.h"
66 #include "ardour/profile.h"
67 #include "ardour/route.h"
68 #include "ardour/route_group.h"
69 #include "ardour/send.h"
70 #include "ardour/session.h"
71 #include "ardour/solo_control.h"
72 #include "ardour/solo_isolate_control.h"
73 #include "ardour/unknown_processor.h"
74 #include "ardour/utils.h"
75 #include "ardour/vca.h"
80 using namespace ARDOUR;
83 PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, Route::PluginSetupOptions > Route::PluginSetup;
85 /** Base class for all routable/mixable objects (tracks and busses) */
86 Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType default_type)
87 : Stripable (sess, name, PresentationInfo (flag))
88 , GraphNode (sess._process_graph)
89 , Muteable (sess, name)
93 , _signal_latency_at_amp_position (0)
94 , _signal_latency_at_trim_position (0)
97 , _pending_process_reorder (0)
98 , _pending_signals (0)
99 , _pending_declick (true)
100 , _meter_point (MeterPostFader)
101 , _pending_meter_point (MeterPostFader)
102 , _meter_type (MeterPeak)
103 , _denormal_protection (false)
106 , _declickable (false)
107 , _have_internal_generator (false)
108 , _default_type (default_type)
110 , _in_configure_processors (false)
111 , _initial_io_setup (false)
112 , _in_sidechain_setup (false)
114 , _custom_meter_position_noted (false)
117 processor_max_streams.reset();
120 boost::weak_ptr<Route>
121 Route::weakroute () {
122 return boost::weak_ptr<Route> (shared_from_this ());
128 /* set default meter type */
130 _meter_type = Config->get_meter_type_master ();
132 else if (dynamic_cast<Track*>(this)) {
133 _meter_type = Config->get_meter_type_track ();
135 _meter_type = Config->get_meter_type_bus ();
138 /* add standard controls */
140 _gain_control.reset (new GainControl (_session, GainAutomation));
141 add_control (_gain_control);
143 _trim_control.reset (new GainControl (_session, TrimAutomation));
144 add_control (_trim_control);
146 _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
147 add_control (_solo_control);
148 _solo_control->Changed.connect_same_thread (*this, boost::bind (&Route::solo_control_changed, this, _1, _2));
150 _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
151 add_control (_mute_control);
153 _phase_control.reset (new PhaseControl (_session, X_("phase")));
154 add_control (_phase_control);
156 _solo_isolate_control.reset (new SoloIsolateControl (_session, X_("solo-iso"), *this, *this));
157 add_control (_solo_isolate_control);
159 _solo_safe_control.reset (new SoloSafeControl (_session, X_("solo-safe")));
160 add_control (_solo_safe_control);
164 if (!(_presentation_info.flags() & PresentationInfo::MonitorOut)) {
165 _pannable.reset (new Pannable (_session));
168 /* input and output objects */
170 _input.reset (new IO (_session, _name, IO::Input, _default_type));
171 _output.reset (new IO (_session, _name, IO::Output, _default_type));
173 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
174 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
176 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
177 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
179 /* add the amp/fader processor.
180 * it should be the first processor to be added on every route.
183 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
184 add_processor (_amp, PostFader);
187 _amp->set_display_name (_("Monitor"));
190 #if 0 // not used - just yet
191 if (!is_master() && !is_monitor() && !is_auditioner()) {
192 _delayline.reset (new DelayLine (_session, _name));
193 add_processor (_delayline, PreFader);
199 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
200 _trim->set_display_to_user (false);
202 if (dynamic_cast<AudioTrack*>(this)) {
203 /* we can't do this in the AudioTrack's constructor
204 * because _trim does not exit then
208 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
213 /* create standard processors: meter, main outs, monitor out;
214 they will be added to _processors by setup_invisible_processors ()
217 _meter.reset (new PeakMeter (_session, _name));
218 _meter->set_owner (this);
219 _meter->set_display_to_user (false);
222 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
223 _main_outs->activate ();
226 /* where we listen to tracks */
227 _intreturn.reset (new InternalReturn (_session));
228 _intreturn->activate ();
230 /* the thing that provides proper control over a control/monitor/listen bus
231 (such as per-channel cut, dim, solo, invert, etc).
233 _monitor_control.reset (new MonitorProcessor (_session));
234 _monitor_control->activate ();
237 /* now that we have _meter, its safe to connect to this */
240 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
241 configure_processors (0);
249 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
251 /* do this early so that we don't get incoming signals as we are going through destruction
256 /* don't use clear_processors here, as it depends on the session which may
257 be half-destroyed by now
260 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
261 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
262 (*i)->drop_references ();
265 _processors.clear ();
269 Route::ensure_track_or_route_name(string name, Session &session)
271 string newname = name;
273 while (!session.io_name_is_legal (newname)) {
274 newname = bump_name_once (newname, ' ');
281 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
283 // TODO route group, see set_gain()
284 // _trim_control->route_set_value (val);
288 Route::maybe_declick (BufferSet&, framecnt_t, int)
290 /* this is the "bus" implementation and they never declick.
295 /** Process this route for one (sub) cycle (process thread)
297 * @param bufs Scratch buffers to use for the signal path
298 * @param start_frame Initial transport frame
299 * @param end_frame Final transport frame
300 * @param nframes Number of frames to output (to ports)
302 * Note that (end_frame - start_frame) may not be equal to nframes when the
303 * transport speed isn't 1.0 (eg varispeed).
306 Route::process_output_buffers (BufferSet& bufs,
307 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
308 int declick, bool gain_automation_ok)
310 /* Caller must hold process lock */
311 assert (!AudioEngine::instance()->process_lock().trylock());
313 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
315 // can this actually happen? functions calling process_output_buffers()
316 // already take a reader-lock.
317 bufs.silence (nframes, 0);
321 _mute_control->automation_run (start_frame, nframes);
323 /* figure out if we're going to use gain automation */
324 if (gain_automation_ok) {
325 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
326 _amp->setup_gain_automation (
327 start_frame + _signal_latency_at_amp_position,
328 end_frame + _signal_latency_at_amp_position,
331 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
332 _trim->setup_gain_automation (
333 start_frame + _signal_latency_at_trim_position,
334 end_frame + _signal_latency_at_trim_position,
337 _amp->apply_gain_automation (false);
338 _trim->apply_gain_automation (false);
341 /* Tell main outs what to do about monitoring. We do this so that
342 on a transition between monitoring states we get a de-clicking gain
343 change in the _main_outs delivery, if config.get_use_monitor_fades()
346 We override this in the case where we have an internal generator.
348 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
350 _main_outs->no_outs_cuz_we_no_monitor (silence);
352 /* -------------------------------------------------------------------------------------------
353 GLOBAL DECLICK (for transport changes etc.)
354 ----------------------------------------------------------------------------------------- */
356 maybe_declick (bufs, nframes, declick);
357 _pending_declick = 0;
359 /* -------------------------------------------------------------------------------------------
360 DENORMAL CONTROL/PHASE INVERT
361 ----------------------------------------------------------------------------------------- */
363 if (!_phase_control->none()) {
367 if (_denormal_protection || Config->get_denormal_protection()) {
369 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
370 Sample* const sp = i->data();
372 if (_phase_control->inverted (chn)) {
373 for (pframes_t nx = 0; nx < nframes; ++nx) {
378 for (pframes_t nx = 0; nx < nframes; ++nx) {
386 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
387 Sample* const sp = i->data();
389 if (_phase_control->inverted (chn)) {
390 for (pframes_t nx = 0; nx < nframes; ++nx) {
399 if (_denormal_protection || Config->get_denormal_protection()) {
401 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
402 Sample* const sp = i->data();
403 for (pframes_t nx = 0; nx < nframes; ++nx) {
411 /* -------------------------------------------------------------------------------------------
413 ----------------------------------------------------------------------------------------- */
415 /* set this to be true if the meter will already have been ::run() earlier */
416 bool const meter_already_run = metering_state() == MeteringInput;
418 framecnt_t latency = 0;
419 const double speed = _session.transport_speed ();
421 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
423 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
424 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
429 /* if it has any inputs, make sure they match */
430 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
431 if (bufs.count() != (*i)->input_streams()) {
433 DEBUG::Processors, string_compose (
434 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
435 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
442 /* should we NOT run plugins here if the route is inactive?
443 do we catch route != active somewhere higher?
446 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
447 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
449 if (boost::dynamic_pointer_cast<PluginInsert>(*i) != 0) {
450 const framecnt_t longest_session_latency = _initial_delay + _signal_latency;
451 boost::dynamic_pointer_cast<PluginInsert>(*i)->set_sidechain_latency (
452 _initial_delay + latency, longest_session_latency - latency);
455 (*i)->run (bufs, start_frame - latency, end_frame - latency, speed, nframes, *i != _processors.back());
456 bufs.set_count ((*i)->output_streams());
458 if ((*i)->active ()) {
459 latency += (*i)->signal_latency ();
465 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
466 boost::shared_ptr<Processor> endpoint,
467 bool include_endpoint, bool for_export, bool for_freeze)
469 /* If no processing is required, there's no need to go any further. */
470 if (!endpoint && !include_endpoint) {
474 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
475 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
476 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
478 /* trim is always at the top, for bounce no latency compensation is needed */
479 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
480 _trim->setup_gain_automation (start, start + nframes, nframes);
483 const double speed = _session.transport_speed ();
484 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
486 if (!include_endpoint && (*i) == endpoint) {
490 /* if we're *not* exporting, stop processing if we come across a routing processor. */
491 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
494 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
498 /* special case the panner (export outputs)
499 * Ideally we'd only run the panner, not the delivery itself...
500 * but panners need separate input/output buffers and some context
501 * (panshell, panner type, etc). AFAICT there is no ill side effect
502 * of re-using the main delivery when freewheeling/exporting a region.
504 if ((*i) == _main_outs) {
505 assert ((*i)->does_routing());
506 (*i)->run (buffers, start - latency, start - latency + nframes, speed, nframes, true);
507 buffers.set_count ((*i)->output_streams());
510 /* don't run any processors that do routing.
511 * Also don't bother with metering.
513 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
514 (*i)->run (buffers, start - latency, start - latency + nframes, 1.0, nframes, true);
515 buffers.set_count ((*i)->output_streams());
516 latency += (*i)->signal_latency ();
519 if ((*i) == endpoint) {
526 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
527 bool include_endpoint, bool for_export, bool for_freeze) const
529 framecnt_t latency = 0;
530 if (!endpoint && !include_endpoint) {
534 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
535 if (!include_endpoint && (*i) == endpoint) {
538 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
541 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
544 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
545 latency += (*i)->signal_latency ();
547 if ((*i) == endpoint) {
555 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
556 bool include_endpoint, bool for_export, bool for_freeze) const
558 if (!endpoint && !include_endpoint) {
562 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
563 if (!include_endpoint && (*i) == endpoint) {
566 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
569 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
572 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
573 cc = (*i)->output_streams();
575 if ((*i) == endpoint) {
583 Route::n_process_buffers ()
585 return max (_input->n_ports(), processor_max_streams);
589 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
591 assert (is_monitor());
592 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
593 fill_buffers_with_input (bufs, _input, nframes);
594 passthru (bufs, start_frame, end_frame, nframes, declick);
598 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
602 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
604 /* control/monitor bus ignores input ports when something is
605 feeding the listen "stream". data will "arrive" into the
606 route from the intreturn processor element.
609 bufs.silence (nframes, 0);
612 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
613 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
617 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
619 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
621 bufs.set_count (_input->n_ports());
622 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
623 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
627 Route::set_listen (bool yn)
630 if (_monitor_send->active() == yn) {
634 _monitor_send->activate ();
636 _monitor_send->deactivate ();
642 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
644 /* nothing to do if we're not using AFL/PFL. But if we are, we need
645 to alter the active state of the monitor send.
648 if (Config->get_solo_control_is_listen_control ()) {
649 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
654 Route::push_solo_isolate_upstream (int32_t delta)
656 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
658 boost::shared_ptr<RouteList> routes = _session.get_routes ();
659 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
661 if ((*i).get() == this || !(*i)->can_solo()) {
666 bool does_feed = feeds (*i, &sends_only);
668 if (does_feed && !sends_only) {
669 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
675 Route::push_solo_upstream (int delta)
677 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
678 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
682 boost::shared_ptr<Route> sr (i->r.lock());
684 sr->solo_control()->mod_solo_by_others_downstream (-delta);
691 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
693 cerr << name << " {" << endl;
694 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
695 p != procs.end(); ++p) {
696 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
702 /** Supposing that we want to insert a Processor at a given Placement, return
703 * the processor to add the new one before (or 0 to add at the end).
705 boost::shared_ptr<Processor>
706 Route::before_processor_for_placement (Placement p)
708 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
710 ProcessorList::iterator loc;
713 /* generic pre-fader: insert immediately before the amp */
714 loc = find (_processors.begin(), _processors.end(), _amp);
716 /* generic post-fader: insert right before the main outs */
717 loc = find (_processors.begin(), _processors.end(), _main_outs);
720 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
723 /** Supposing that we want to insert a Processor at a given index, return
724 * the processor to add the new one before (or 0 to add at the end).
726 boost::shared_ptr<Processor>
727 Route::before_processor_for_index (int index)
730 return boost::shared_ptr<Processor> ();
733 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
735 ProcessorList::iterator i = _processors.begin ();
737 while (i != _processors.end() && j < index) {
738 if ((*i)->display_to_user()) {
745 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
748 /** Add a processor either pre- or post-fader
749 * @return 0 on success, non-0 on failure.
752 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
754 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
758 /** Add a processor to a route such that it ends up with a given index into the visible processors.
759 * @param index Index to add the processor at, or -1 to add at the end of the list.
760 * @return 0 on success, non-0 on failure.
763 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
765 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
768 /** Add a processor to the route.
769 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
770 * @return 0 on success, non-0 on failure.
773 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
775 assert (processor != _meter);
776 assert (processor != _main_outs);
778 DEBUG_TRACE (DEBUG::Processors, string_compose (
779 "%1 adding processor %2\n", name(), processor->name()));
783 pl.push_back (processor);
784 int rv = add_processors (pl, before, err);
790 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
791 processor->activate ();
798 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
800 /* We cannot destruct the processor here (usually RT-thread
801 * with various locks held - in case of sends also io_locks).
802 * Queue for deletion in low-priority thread.
804 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
805 selfdestruct_sequence.push_back (wp);
809 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
811 XMLProperty const * prop;
814 boost::shared_ptr<Processor> processor;
816 /* bit of a hack: get the `placement' property from the <Redirect> tag here
817 so that we can add the processor in the right place (pre/post-fader)
820 XMLNodeList const & children = node.children ();
821 XMLNodeList::const_iterator i = children.begin ();
823 while (i != children.end() && (*i)->name() != X_("Redirect")) {
827 Placement placement = PreFader;
829 if (i != children.end()) {
830 if ((prop = (*i)->property (X_("placement"))) != 0) {
831 placement = Placement (string_2_enum (prop->value(), placement));
835 if (node.name() == "Insert") {
837 if ((prop = node.property ("type")) != 0) {
839 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
840 prop->value() == "lv2" ||
841 prop->value() == "windows-vst" ||
842 prop->value() == "mac-vst" ||
843 prop->value() == "lxvst" ||
844 prop->value() == "audiounit") {
846 if (_session.get_disable_all_loaded_plugins ()) {
847 processor.reset (new UnknownProcessor (_session, node));
849 processor.reset (new PluginInsert (_session));
850 processor->set_owner (this);
855 processor.reset (new PortInsert (_session, _pannable, _mute_master));
860 } else if (node.name() == "Send") {
862 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
863 processor.reset (new Send (_session, sendpan, _mute_master));
867 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
871 if (processor->set_state (node, version)) {
875 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
876 if (i != children.end()) {
877 if ((prop = (*i)->property (X_("active"))) != 0) {
878 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
879 processor->activate();
881 processor->deactivate();
885 return (add_processor (processor, placement, 0, false) == 0);
888 catch (failed_constructor &err) {
889 warning << _("processor could not be created. Ignored.") << endmsg;
895 inline Route::PluginSetupOptions operator|= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
896 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) | static_cast<int> (b));
899 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
900 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
904 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
906 ProcessorList::iterator loc;
909 loc = find(_processors.begin(), _processors.end(), before);
910 if (loc == _processors.end ()) {
914 /* nothing specified - at end */
915 loc = _processors.end ();
918 if (!AudioEngine::instance()->connected()) {
922 if (others.empty()) {
926 ProcessorList to_skip;
928 // check if there's an instrument to replace or configure
929 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
930 boost::shared_ptr<PluginInsert> pi;
931 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
934 if (!pi->plugin ()->get_info ()->is_instrument ()) {
937 boost::shared_ptr<Processor> instrument = the_instrument ();
938 ChanCount in (DataType::MIDI, 1);
939 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
941 PluginSetupOptions flags = None;
944 in = instrument->input_streams ();
945 out = instrument->output_streams ();
947 if (pi->has_output_presets (in, out)) {
951 pi->set_strict_io (_strict_io);
953 PluginSetupOptions mask = None;
954 if (Config->get_ask_replace_instrument ()) {
957 if (Config->get_ask_setup_instrument ()) {
964 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
965 switch (rv.get_value_or (0)) {
967 to_skip.push_back (*i); // don't add this one;
970 replace_processor (instrument, *i, err);
971 to_skip.push_back (*i);
980 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
981 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
982 ProcessorState pstate (this);
984 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
989 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
990 if (check != to_skip.end()) {
994 boost::shared_ptr<PluginInsert> pi;
996 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
997 pi->set_strict_io (_strict_io);
1001 /* Ensure that only one amp is in the list at any time */
1002 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
1003 if (check != _processors.end()) {
1004 if (before == _amp) {
1005 /* Already in position; all is well */
1008 _processors.erase (check);
1013 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1015 _processors.insert (loc, *i);
1016 (*i)->set_owner (this);
1019 if (configure_processors_unlocked (err, &lm)) {
1021 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1026 if (pi && pi->has_sidechain ()) {
1027 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
1030 if ((*i)->active()) {
1031 // emit ActiveChanged() and latency_changed() if needed
1035 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1037 boost::shared_ptr<Send> send;
1038 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1039 send->SelfDestruct.connect_same_thread (*this,
1040 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1044 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1045 boost::shared_ptr<PluginInsert> pi;
1047 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1048 if (pi->has_no_inputs ()) {
1049 _have_internal_generator = true;
1055 _output->set_user_latency (0);
1058 reset_instrument_info ();
1059 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1060 set_processor_positions ();
1066 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1068 if (p == PreFader) {
1069 start = _processors.begin();
1070 end = find(_processors.begin(), _processors.end(), _amp);
1072 start = find(_processors.begin(), _processors.end(), _amp);
1074 end = _processors.end();
1078 /** Turn off all processors with a given placement
1079 * @param p Placement of processors to disable
1082 Route::disable_processors (Placement p)
1084 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1086 ProcessorList::iterator start, end;
1087 placement_range(p, start, end);
1089 for (ProcessorList::iterator i = start; i != end; ++i) {
1090 (*i)->enable (false);
1093 _session.set_dirty ();
1096 /** Turn off all redirects
1099 Route::disable_processors ()
1101 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1103 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1104 (*i)->enable (false);
1107 _session.set_dirty ();
1110 /** Turn off all redirects with a given placement
1111 * @param p Placement of redirects to disable
1114 Route::disable_plugins (Placement p)
1116 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1118 ProcessorList::iterator start, end;
1119 placement_range(p, start, end);
1121 for (ProcessorList::iterator i = start; i != end; ++i) {
1122 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1123 (*i)->enable (false);
1127 _session.set_dirty ();
1130 /** Turn off all plugins
1133 Route::disable_plugins ()
1135 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1137 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1138 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1139 (*i)->enable (false);
1143 _session.set_dirty ();
1148 Route::ab_plugins (bool forward)
1150 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1154 /* forward = turn off all active redirects, and mark them so that the next time
1155 we go the other way, we will revert them
1158 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1159 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1163 if ((*i)->enabled ()) {
1164 (*i)->enable (false);
1165 (*i)->set_next_ab_is_active (true);
1167 (*i)->set_next_ab_is_active (false);
1173 /* backward = if the redirect was marked to go active on the next ab, do so */
1175 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1177 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1181 (*i)->enable ((*i)->get_next_ab_is_active ());
1185 _session.set_dirty ();
1189 /** Remove processors with a given placement.
1190 * @param p Placement of processors to remove.
1193 Route::clear_processors (Placement p)
1195 if (!_session.engine().connected()) {
1199 bool already_deleting = _session.deletion_in_progress();
1200 if (!already_deleting) {
1201 _session.set_deletion_in_progress();
1205 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1206 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1207 ProcessorList new_list;
1208 ProcessorStreams err;
1209 bool seen_amp = false;
1211 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1217 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1219 /* you can't remove these */
1221 new_list.push_back (*i);
1228 new_list.push_back (*i);
1231 (*i)->drop_references ();
1239 (*i)->drop_references ();
1242 new_list.push_back (*i);
1249 _processors = new_list;
1250 configure_processors_unlocked (&err, &lm); // this can't fail
1253 processor_max_streams.reset();
1254 _have_internal_generator = false;
1255 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1256 set_processor_positions ();
1258 reset_instrument_info ();
1260 if (!already_deleting) {
1261 _session.clear_deletion_in_progress();
1266 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1268 // TODO once the export point can be configured properly, do something smarter here
1269 if (processor == _capturing_processor) {
1270 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1271 if (need_process_lock) {
1275 _capturing_processor.reset();
1277 if (need_process_lock) {
1282 /* these can never be removed */
1284 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1288 if (!_session.engine().connected()) {
1292 processor_max_streams.reset();
1295 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1296 if (need_process_lock) {
1300 /* Caller must hold process lock */
1301 assert (!AudioEngine::instance()->process_lock().trylock());
1303 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1305 ProcessorState pstate (this);
1307 ProcessorList::iterator i;
1308 bool removed = false;
1310 for (i = _processors.begin(); i != _processors.end(); ) {
1311 if (*i == processor) {
1313 /* move along, see failure case for configure_processors()
1314 where we may need to reconfigure the processor.
1317 /* stop redirects that send signals to JACK ports
1318 from causing noise as a result of no longer being
1322 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1323 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1327 iop = pi->sidechain();
1334 i = _processors.erase (i);
1342 _output->set_user_latency (0);
1350 if (configure_processors_unlocked (err, &lm)) {
1352 /* we know this will work, because it worked before :) */
1353 configure_processors_unlocked (0, &lm);
1357 _have_internal_generator = false;
1359 for (i = _processors.begin(); i != _processors.end(); ++i) {
1360 boost::shared_ptr<PluginInsert> pi;
1362 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1363 if (pi->has_no_inputs ()) {
1364 _have_internal_generator = true;
1369 if (need_process_lock) {
1374 reset_instrument_info ();
1375 processor->drop_references ();
1376 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1377 set_processor_positions ();
1383 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1385 /* these can never be removed */
1386 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1389 /* and can't be used as substitute, either */
1390 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1394 /* I/Os are out, too */
1395 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1399 /* this function cannot be used to swap/reorder processors */
1400 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1404 if (!AudioEngine::instance()->connected() || !old || !sub) {
1408 /* ensure that sub is not owned by another route */
1409 if (sub->owner ()) {
1414 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1415 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1416 ProcessorState pstate (this);
1418 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1420 ProcessorList::iterator i;
1421 bool replaced = false;
1422 bool enable = old->enabled ();
1424 for (i = _processors.begin(); i != _processors.end(); ) {
1426 i = _processors.erase (i);
1427 _processors.insert (i, sub);
1428 sub->set_owner (this);
1441 boost::shared_ptr<PluginInsert> pi;
1442 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1443 pi->set_strict_io (true);
1447 if (configure_processors_unlocked (err, &lm)) {
1449 configure_processors_unlocked (0, &lm);
1453 _have_internal_generator = false;
1455 for (i = _processors.begin(); i != _processors.end(); ++i) {
1456 boost::shared_ptr<PluginInsert> pi;
1457 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1458 if (pi->has_no_inputs ()) {
1459 _have_internal_generator = true;
1469 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1470 _output->set_user_latency (0);
1473 reset_instrument_info ();
1474 old->drop_references ();
1475 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1476 set_processor_positions ();
1481 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1483 ProcessorList deleted;
1485 if (!_session.engine().connected()) {
1489 processor_max_streams.reset();
1492 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1493 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1494 ProcessorState pstate (this);
1496 ProcessorList::iterator i;
1497 boost::shared_ptr<Processor> processor;
1499 for (i = _processors.begin(); i != _processors.end(); ) {
1503 /* these can never be removed */
1505 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1510 /* see if its in the list of processors to delete */
1512 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1517 /* stop IOProcessors that send to JACK ports
1518 from causing noise as a result of no longer being
1522 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1523 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1526 iop = pi->sidechain();
1533 deleted.push_back (processor);
1534 i = _processors.erase (i);
1537 if (deleted.empty()) {
1538 /* none of those in the requested list were found */
1542 _output->set_user_latency (0);
1544 if (configure_processors_unlocked (err, &lm)) {
1546 /* we know this will work, because it worked before :) */
1547 configure_processors_unlocked (0, &lm);
1552 _have_internal_generator = false;
1554 for (i = _processors.begin(); i != _processors.end(); ++i) {
1555 boost::shared_ptr<PluginInsert> pi;
1557 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1558 if (pi->has_no_inputs ()) {
1559 _have_internal_generator = true;
1566 /* now try to do what we need to so that those that were removed will be deleted */
1568 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1569 (*i)->drop_references ();
1572 reset_instrument_info ();
1573 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1574 set_processor_positions ();
1580 Route::reset_instrument_info ()
1582 boost::shared_ptr<Processor> instr = the_instrument();
1584 _instrument_info.set_internal_instrument (instr);
1588 /** Caller must hold process lock */
1590 Route::configure_processors (ProcessorStreams* err)
1592 #ifndef PLATFORM_WINDOWS
1593 assert (!AudioEngine::instance()->process_lock().trylock());
1596 if (!_in_configure_processors) {
1597 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1598 return configure_processors_unlocked (err, &lm);
1605 Route::input_streams () const
1607 return _input->n_ports ();
1610 list<pair<ChanCount, ChanCount> >
1611 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1613 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1615 return try_configure_processors_unlocked (in, err);
1618 list<pair<ChanCount, ChanCount> >
1619 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1621 // Check each processor in order to see if we can configure as requested
1623 list<pair<ChanCount, ChanCount> > configuration;
1626 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1627 DEBUG_TRACE (DEBUG::Processors, "{\n");
1629 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1631 if ((*p)->can_support_io_configuration(in, out)) {
1633 if (boost::dynamic_pointer_cast<Delivery> (*p)
1634 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1636 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1637 /* with strict I/O the panner + output are forced to
1638 * follow the last processor's output.
1640 * Delivery::can_support_io_configuration() will only add ports,
1641 * but not remove excess ports.
1643 * This works because the delivery only requires
1644 * as many outputs as there are inputs.
1645 * Delivery::configure_io() will do the actual removal
1646 * by calling _output->ensure_io()
1648 if (!is_master() && _session.master_out () && in.n_audio() > 0) {
1649 /* ..but at least as many as there are master-inputs, if
1650 * the delivery is dealing with audio */
1651 // XXX this may need special-casing for mixbus (master-outputs)
1652 // and should maybe be a preference anyway ?!
1653 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1659 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1660 configuration.push_back(make_pair(in, out));
1663 // restriction for Monitor Section Processors
1664 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1665 /* do not allow to add/remove channels (for now)
1666 * The Monitor follows the master-bus and has no panner (unpan)
1667 * but do allow processors with midi-in to be added (e.g VSTs with control that
1668 * will remain unconnected)
1670 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration not allowed.\n");
1671 return list<pair<ChanCount, ChanCount> > ();
1673 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1674 // internal sends make no sense, only feedback
1675 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1676 return list<pair<ChanCount, ChanCount> > ();
1678 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1679 /* External Sends can be problematic. one can add/remove ports
1680 * there signal leaves the DAW to external monitors anyway, so there's
1681 * no real use for allowing them here anyway.
1683 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1684 return list<pair<ChanCount, ChanCount> > ();
1686 if (boost::dynamic_pointer_cast<Send> (*p)) {
1688 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1689 return list<pair<ChanCount, ChanCount> > ();
1698 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1699 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1700 DEBUG_TRACE (DEBUG::Processors, "}\n");
1701 return list<pair<ChanCount, ChanCount> > ();
1705 DEBUG_TRACE (DEBUG::Processors, "}\n");
1707 return configuration;
1710 /** Set the input/output configuration of each processor in the processors list.
1711 * Caller must hold process lock.
1712 * Return 0 on success, otherwise configuration is impossible.
1715 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1717 #ifndef PLATFORM_WINDOWS
1718 assert (!AudioEngine::instance()->process_lock().trylock());
1721 if (_in_configure_processors) {
1725 /* put invisible processors where they should be */
1726 setup_invisible_processors ();
1728 _in_configure_processors = true;
1730 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1732 if (configuration.empty ()) {
1733 _in_configure_processors = false;
1738 bool seen_mains_out = false;
1739 processor_out_streams = _input->n_ports();
1740 processor_max_streams.reset();
1742 /* processor configure_io() may result in adding ports
1743 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1745 * with jack2 adding ports results in a graph-order callback,
1746 * which calls Session::resort_routes() and eventually
1747 * Route::direct_feeds_according_to_reality()
1748 * which takes a ReaderLock (_processor_lock).
1750 * so we can't hold a WriterLock here until jack2 threading
1753 * NB. we still hold the process lock
1755 * (ardour's own engines do call graph-order from the
1756 * process-thread and hence do not have this issue; besides
1757 * merely adding ports won't trigger a graph-order, only
1758 * making connections does)
1762 // TODO check for a potential ReaderLock after ReaderLock ??
1763 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1765 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1766 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1768 if (!(*p)->configure_io(c->first, c->second)) {
1769 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1770 _in_configure_processors = false;
1775 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1776 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1778 boost::shared_ptr<IOProcessor> iop;
1779 boost::shared_ptr<PluginInsert> pi;
1780 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1781 /* plugins connected via Split or Hide Match may have more channels.
1782 * route/scratch buffers are needed for all of them
1783 * The configuration may only be a subset (both input and output)
1785 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1787 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1788 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1789 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1793 if (boost::dynamic_pointer_cast<Delivery> (*p)
1794 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1795 /* main delivery will increase port count to match input.
1796 * the Delivery::Main is usually the last processor - followed only by
1799 seen_mains_out = true;
1801 if (!seen_mains_out) {
1802 processor_out_streams = out;
1811 _meter->set_max_channels (processor_max_streams);
1814 /* make sure we have sufficient scratch buffers to cope with the new processor
1817 _session.ensure_buffers (n_process_buffers ());
1819 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1821 _in_configure_processors = false;
1825 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1826 * @param state New active state for those processors.
1829 Route::all_visible_processors_active (bool state)
1831 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1833 if (_processors.empty()) {
1837 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1838 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1841 (*i)->enable (state);
1844 _session.set_dirty ();
1848 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
1850 /* check if re-order requires re-configuration of any processors
1851 * -> compare channel configuration for all processors
1853 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1854 ChanCount c = input_streams ();
1856 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
1858 if (c != (*j)->input_streams()) {
1861 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1864 if ((*i)->input_streams() != c) {
1867 c = (*i)->output_streams();
1879 __attribute__((annotate("realtime")))
1882 Route::apply_processor_order (const ProcessorList& new_order)
1884 /* need to hold processor_lock; either read or write lock
1885 * and the engine process_lock.
1886 * Due to r/w lock ambiguity we can only assert the latter
1888 assert (!AudioEngine::instance()->process_lock().trylock());
1891 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1892 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1893 * processors in the current actual processor list that are hidden. Any visible processors
1894 * in the current list but not in "new_order" will be assumed to be deleted.
1897 /* "as_it_will_be" and "_processors" are lists of shared pointers.
1898 * actual memory usage is small, but insert/erase is not actually rt-safe :(
1899 * (note though that ::processors_reorder_needs_configure() ensured that
1900 * this function will only ever be called from the rt-thread if no processor were removed)
1902 * either way, I can't proove it, but an x-run due to re-order here is less likley
1903 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
1906 ProcessorList as_it_will_be;
1907 ProcessorList::iterator oiter;
1908 ProcessorList::const_iterator niter;
1910 oiter = _processors.begin();
1911 niter = new_order.begin();
1913 while (niter != new_order.end()) {
1915 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1916 then append it to the temp list.
1918 Otherwise, see if the next processor in the old list is in the new list. if not,
1919 its been deleted. If its there, append it to the temp list.
1922 if (oiter == _processors.end()) {
1924 /* no more elements in the old list, so just stick the rest of
1925 the new order onto the temp list.
1928 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1929 while (niter != new_order.end()) {
1936 if (!(*oiter)->display_to_user()) {
1938 as_it_will_be.push_back (*oiter);
1942 /* visible processor: check that its in the new order */
1944 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1945 /* deleted: do nothing, shared_ptr<> will clean up */
1947 /* ignore this one, and add the next item from the new order instead */
1948 as_it_will_be.push_back (*niter);
1953 /* now remove from old order - its taken care of no matter what */
1954 oiter = _processors.erase (oiter);
1958 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1960 /* If the meter is in a custom position, find it and make a rough note of its position */
1961 maybe_note_meter_position ();
1965 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1967 // it a change is already queued, wait for it
1968 // (unless engine is stopped. apply immediately and proceed
1969 while (g_atomic_int_get (&_pending_process_reorder)) {
1970 if (!AudioEngine::instance()->running()) {
1971 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
1972 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1974 apply_processor_order(_pending_processor_order);
1975 setup_invisible_processors ();
1977 g_atomic_int_set (&_pending_process_reorder, 0);
1979 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1980 set_processor_positions ();
1982 // TODO rather use a semaphore or something.
1983 // but since ::reorder_processors() is called
1984 // from the GUI thread, this is fine..
1989 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
1991 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1992 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1993 ProcessorState pstate (this);
1995 apply_processor_order (new_order);
1997 if (configure_processors_unlocked (err, &lm)) {
2005 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2006 set_processor_positions ();
2009 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2010 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2012 // _pending_processor_order is protected by _processor_lock
2013 _pending_processor_order = new_order;
2014 g_atomic_int_set (&_pending_process_reorder, 1);
2021 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2023 boost::shared_ptr<PluginInsert> pi;
2024 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2028 if (pi->has_sidechain () == add) {
2029 return true; // ?? call failed, but result is as expected.
2033 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2034 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2035 if (i == _processors.end ()) {
2041 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2042 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2043 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2045 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2047 if (!pi->add_sidechain ()) {
2051 if (!pi->del_sidechain ()) {
2057 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2062 pi->del_sidechain ();
2064 pi->add_sidechain ();
2065 // TODO restore side-chain's state.
2070 configure_processors_unlocked (0, &lm);
2073 if (pi->has_sidechain ()) {
2074 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2077 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2078 _session.set_dirty ();
2083 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2085 boost::shared_ptr<PluginInsert> pi;
2086 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2091 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2092 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2093 if (i == _processors.end ()) {
2099 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2100 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2102 const ChanCount& old (pi->preset_out ());
2103 if (!pi->set_preset_out (outs)) {
2104 return true; // no change, OK
2107 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2110 pi->set_preset_out (old);
2113 configure_processors_unlocked (0, &lm);
2116 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2117 _session.set_dirty ();
2122 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2125 return customize_plugin_insert (proc, 0, unused, unused);
2129 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2131 boost::shared_ptr<PluginInsert> pi;
2132 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2137 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2138 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2139 if (i == _processors.end ()) {
2145 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2146 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2148 bool old_cust = pi->custom_cfg ();
2149 uint32_t old_cnt = pi->get_count ();
2150 ChanCount old_chan = pi->output_streams ();
2151 ChanCount old_sinks = pi->natural_input_streams ();
2154 pi->set_custom_cfg (false);
2156 pi->set_custom_cfg (true);
2157 pi->set_count (count);
2158 pi->set_outputs (outs);
2159 pi->set_sinks (sinks);
2162 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2166 pi->set_count (old_cnt);
2167 pi->set_sinks (old_sinks);
2168 pi->set_outputs (old_chan);
2169 pi->set_custom_cfg (old_cust);
2173 configure_processors_unlocked (0, &lm);
2176 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2177 _session.set_dirty ();
2182 Route::set_strict_io (const bool enable)
2184 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2186 if (_strict_io != enable) {
2187 _strict_io = enable;
2188 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2189 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2190 boost::shared_ptr<PluginInsert> pi;
2191 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2192 pi->set_strict_io (_strict_io);
2196 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2200 _strict_io = !enable; // restore old value
2201 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2202 boost::shared_ptr<PluginInsert> pi;
2203 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2204 pi->set_strict_io (_strict_io);
2211 configure_processors (0);
2214 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2215 _session.set_dirty ();
2227 Route::get_template()
2229 return state(false);
2233 Route::state(bool full_state)
2236 if (!_session._template_state_dir.empty()) {
2237 assert (!full_state); // only for templates
2238 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2241 XMLNode *node = new XMLNode("Route");
2242 ProcessorList::iterator i;
2245 id().print (buf, sizeof (buf));
2246 node->add_property("id", buf);
2247 node->add_property ("name", _name);
2248 node->add_property("default-type", _default_type.to_string());
2249 node->add_property ("strict-io", _strict_io);
2251 node->add_child_nocopy (_presentation_info.get_state());
2253 node->add_property("active", _active?"yes":"no");
2255 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2256 node->add_property("meter-point", enum_2_string (_meter_point));
2258 node->add_property("meter-type", enum_2_string (_meter_type));
2261 node->add_property("route-group", _route_group->name());
2264 node->add_child_nocopy (_solo_control->get_state ());
2265 node->add_child_nocopy (_solo_isolate_control->get_state ());
2266 node->add_child_nocopy (_solo_safe_control->get_state ());
2268 node->add_child_nocopy (_input->state (full_state));
2269 node->add_child_nocopy (_output->state (full_state));
2270 node->add_child_nocopy (_mute_master->get_state ());
2272 node->add_child_nocopy (_mute_control->get_state ());
2273 node->add_child_nocopy (_phase_control->get_state ());
2276 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2279 if (_comment.length()) {
2280 XMLNode *cmt = node->add_child ("Comment");
2281 cmt->add_content (_comment);
2285 node->add_child_nocopy (_pannable->state (full_state));
2289 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2290 for (i = _processors.begin(); i != _processors.end(); ++i) {
2292 /* template save: do not include internal sends functioning as
2293 aux sends because the chance of the target ID
2294 in the session where this template is used
2297 similarly, do not save listen sends which connect to
2298 the monitor section, because these will always be
2301 boost::shared_ptr<InternalSend> is;
2303 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2304 if (is->role() == Delivery::Listen) {
2309 node->add_child_nocopy((*i)->state (full_state));
2314 node->add_child_copy (*_extra_xml);
2317 if (_custom_meter_position_noted) {
2318 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2320 after->id().print (buf, sizeof (buf));
2321 node->add_property (X_("processor-after-last-custom-meter"), buf);
2325 if (!_session._template_state_dir.empty()) {
2326 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2329 node->add_child_copy (Slavable::get_state());
2335 Route::set_state (const XMLNode& node, int version)
2337 if (version < 3000) {
2338 return set_state_2X (node, version);
2342 XMLNodeConstIterator niter;
2344 XMLProperty const * prop;
2346 if (node.name() != "Route"){
2347 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2351 if ((prop = node.property (X_("name"))) != 0) {
2352 Route::set_name (prop->value());
2356 _initial_io_setup = true;
2358 Stripable::set_state (node, version);
2360 if ((prop = node.property (X_("strict-io"))) != 0) {
2361 _strict_io = string_is_affirmative (prop->value());
2365 /* monitor bus does not get a panner, but if (re)created
2366 via XML, it will already have one by the time we
2367 call ::set_state(). so ... remove it.
2372 /* add all processors (except amp, which is always present) */
2374 nlist = node.children();
2375 XMLNode processor_state (X_("processor_state"));
2377 Stateful::save_extra_xml (node);
2379 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2383 if (child->name() == IO::state_node_name) {
2384 if ((prop = child->property (X_("direction"))) == 0) {
2388 if (prop->value() == "Input") {
2389 _input->set_state (*child, version);
2390 } else if (prop->value() == "Output") {
2391 _output->set_state (*child, version);
2394 } else if (child->name() == X_("Processor")) {
2395 processor_state.add_child_copy (*child);
2396 } else if (child->name() == X_("Pannable")) {
2398 _pannable->set_state (*child, version);
2400 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2402 } else if (child->name() == Slavable::xml_node_name) {
2403 Slavable::set_state (*child, version);
2407 if ((prop = node.property (X_("meter-point"))) != 0) {
2408 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2409 set_meter_point (mp, true);
2411 _meter->set_display_to_user (_meter_point == MeterCustom);
2415 if ((prop = node.property (X_("meter-type"))) != 0) {
2416 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2419 _initial_io_setup = false;
2421 set_processor_state (processor_state);
2423 // this looks up the internal instrument in processors
2424 reset_instrument_info();
2426 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2427 set_denormal_protection (string_is_affirmative (prop->value()));
2430 if ((prop = node.property (X_("active"))) != 0) {
2431 bool yn = string_is_affirmative (prop->value());
2432 set_active (yn, this);
2435 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2436 PBD::ID id (prop->value ());
2437 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2438 ProcessorList::const_iterator i = _processors.begin ();
2439 while (i != _processors.end() && (*i)->id() != id) {
2443 if (i != _processors.end ()) {
2444 _processor_after_last_custom_meter = *i;
2445 _custom_meter_position_noted = true;
2449 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2452 if (child->name() == X_("Comment")) {
2454 /* XXX this is a terrible API design in libxml++ */
2456 XMLNode *cmt = *(child->children().begin());
2457 _comment = cmt->content();
2459 } else if (child->name() == Controllable::xml_node_name) {
2460 if ((prop = child->property (X_("name"))) == 0) {
2464 if (prop->value() == _gain_control->name()) {
2465 _gain_control->set_state (*child, version);
2466 } else if (prop->value() == _solo_control->name()) {
2467 _solo_control->set_state (*child, version);
2468 } else if (prop->value() == _solo_safe_control->name()) {
2469 _solo_safe_control->set_state (*child, version);
2470 } else if (prop->value() == _solo_isolate_control->name()) {
2471 _solo_isolate_control->set_state (*child, version);
2472 } else if (prop->value() == _mute_control->name()) {
2473 _mute_control->set_state (*child, version);
2474 } else if (prop->value() == _phase_control->name()) {
2475 _phase_control->set_state (*child, version);
2477 } else if (child->name() == MuteMaster::xml_node_name) {
2478 _mute_master->set_state (*child, version);
2480 } else if (child->name() == Automatable::xml_node_name) {
2481 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2489 Route::set_state_2X (const XMLNode& node, int version)
2493 XMLNodeConstIterator niter;
2495 XMLProperty const * prop;
2497 /* 2X things which still remain to be handled:
2503 if (node.name() != "Route") {
2504 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2508 Stripable::set_state (node, version);
2510 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2511 set_denormal_protection (string_is_affirmative (prop->value()));
2514 if ((prop = node.property (X_("muted"))) != 0) {
2517 bool muted = string_is_affirmative (prop->value());
2523 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2525 if (string_is_affirmative (prop->value())){
2526 mute_point = mute_point + "PreFader";
2531 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2533 if (string_is_affirmative (prop->value())){
2536 mute_point = mute_point + ",";
2539 mute_point = mute_point + "PostFader";
2544 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2546 if (string_is_affirmative (prop->value())){
2549 mute_point = mute_point + ",";
2552 mute_point = mute_point + "Listen";
2557 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2559 if (string_is_affirmative (prop->value())){
2562 mute_point = mute_point + ",";
2565 mute_point = mute_point + "Main";
2569 _mute_master->set_mute_points (mute_point);
2570 _mute_master->set_muted_by_self (true);
2574 if ((prop = node.property (X_("meter-point"))) != 0) {
2575 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2580 nlist = node.children ();
2581 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2585 if (child->name() == IO::state_node_name) {
2587 /* there is a note in IO::set_state_2X() about why we have to call
2591 _input->set_state_2X (*child, version, true);
2592 _output->set_state_2X (*child, version, false);
2594 if ((prop = child->property (X_("name"))) != 0) {
2595 Route::set_name (prop->value ());
2600 if ((prop = child->property (X_("active"))) != 0) {
2601 bool yn = string_is_affirmative (prop->value());
2602 _active = !yn; // force switch
2603 set_active (yn, this);
2606 if ((prop = child->property (X_("gain"))) != 0) {
2609 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2610 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2614 /* Set up Panners in the IO */
2615 XMLNodeList io_nlist = child->children ();
2617 XMLNodeConstIterator io_niter;
2620 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2622 io_child = *io_niter;
2624 if (io_child->name() == X_("Panner")) {
2625 _main_outs->panner_shell()->set_state(*io_child, version);
2626 } else if (io_child->name() == X_("Automation")) {
2627 /* IO's automation is for the fader */
2628 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2634 XMLNodeList redirect_nodes;
2636 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2640 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2641 redirect_nodes.push_back(child);
2646 set_processor_state_2X (redirect_nodes, version);
2648 Stateful::save_extra_xml (node);
2650 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2653 if (child->name() == X_("Comment")) {
2655 /* XXX this is a terrible API design in libxml++ */
2657 XMLNode *cmt = *(child->children().begin());
2658 _comment = cmt->content();
2660 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2661 if (prop->value() == X_("solo")) {
2662 _solo_control->set_state (*child, version);
2663 } else if (prop->value() == X_("mute")) {
2664 _mute_control->set_state (*child, version);
2674 Route::get_processor_state ()
2676 XMLNode* root = new XMLNode (X_("redirects"));
2677 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2678 root->add_child_nocopy ((*i)->state (true));
2685 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2687 /* We don't bother removing existing processors not in nList, as this
2688 method will only be called when creating a Route from scratch, not
2689 for undo purposes. Just put processors in at the appropriate place
2693 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2694 add_processor_from_xml_2X (**i, version);
2699 Route::set_processor_state (const XMLNode& node)
2701 const XMLNodeList &nlist = node.children();
2702 XMLNodeConstIterator niter;
2703 ProcessorList new_order;
2704 bool must_configure = false;
2706 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2708 XMLProperty* prop = (*niter)->property ("type");
2710 if (prop->value() == "amp") {
2711 _amp->set_state (**niter, Stateful::current_state_version);
2712 new_order.push_back (_amp);
2713 } else if (prop->value() == "trim") {
2714 _trim->set_state (**niter, Stateful::current_state_version);
2715 new_order.push_back (_trim);
2716 } else if (prop->value() == "meter") {
2717 _meter->set_state (**niter, Stateful::current_state_version);
2718 new_order.push_back (_meter);
2719 } else if (prop->value() == "delay") {
2721 _delayline->set_state (**niter, Stateful::current_state_version);
2722 new_order.push_back (_delayline);
2724 } else if (prop->value() == "main-outs") {
2725 _main_outs->set_state (**niter, Stateful::current_state_version);
2726 } else if (prop->value() == "intreturn") {
2728 _intreturn.reset (new InternalReturn (_session));
2729 must_configure = true;
2731 _intreturn->set_state (**niter, Stateful::current_state_version);
2732 } else if (is_monitor() && prop->value() == "monitor") {
2733 if (!_monitor_control) {
2734 _monitor_control.reset (new MonitorProcessor (_session));
2735 must_configure = true;
2737 _monitor_control->set_state (**niter, Stateful::current_state_version);
2738 } else if (prop->value() == "capture") {
2739 /* CapturingProcessor should never be restored, it's always
2740 added explicitly when needed */
2742 ProcessorList::iterator o;
2744 for (o = _processors.begin(); o != _processors.end(); ++o) {
2745 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2746 if (id_prop && (*o)->id() == id_prop->value()) {
2747 (*o)->set_state (**niter, Stateful::current_state_version);
2748 new_order.push_back (*o);
2753 // If the processor (*niter) is not on the route then create it
2755 if (o == _processors.end()) {
2757 boost::shared_ptr<Processor> processor;
2759 if (prop->value() == "intsend") {
2761 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2763 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2764 prop->value() == "lv2" ||
2765 prop->value() == "windows-vst" ||
2766 prop->value() == "mac-vst" ||
2767 prop->value() == "lxvst" ||
2768 prop->value() == "luaproc" ||
2769 prop->value() == "audiounit") {
2771 if (_session.get_disable_all_loaded_plugins ()) {
2772 processor.reset (new UnknownProcessor (_session, **niter));
2774 processor.reset (new PluginInsert (_session));
2775 processor->set_owner (this);
2777 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2778 pi->set_strict_io (true);
2782 } else if (prop->value() == "port") {
2784 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2786 } else if (prop->value() == "send") {
2788 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2789 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2790 send->SelfDestruct.connect_same_thread (*this,
2791 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2794 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2798 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2799 /* This processor could not be configured. Turn it into a UnknownProcessor */
2800 processor.reset (new UnknownProcessor (_session, **niter));
2803 /* subscribe to Sidechain IO changes */
2804 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2805 if (pi && pi->has_sidechain ()) {
2806 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2809 /* we have to note the monitor send here, otherwise a new one will be created
2810 and the state of this one will be lost.
2812 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2813 if (isend && isend->role() == Delivery::Listen) {
2814 _monitor_send = isend;
2817 /* it doesn't matter if invisible processors are added here, as they
2818 will be sorted out by setup_invisible_processors () shortly.
2821 new_order.push_back (processor);
2822 must_configure = true;
2828 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2829 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2830 /* re-assign _processors w/o process-lock.
2831 * if there's an IO-processor present in _processors but
2832 * not in new_order, it will be deleted and ~IO takes
2835 _processors = new_order;
2837 if (must_configure) {
2838 configure_processors_unlocked (0, &lm);
2841 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2843 (*i)->set_owner (this);
2844 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2846 boost::shared_ptr<PluginInsert> pi;
2848 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2849 if (pi->has_no_inputs ()) {
2850 _have_internal_generator = true;
2857 reset_instrument_info ();
2858 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2859 set_processor_positions ();
2863 Route::curve_reallocate ()
2865 // _gain_automation_curve.finish_resize ();
2866 // _pan_automation_curve.finish_resize ();
2870 Route::silence (framecnt_t nframes)
2872 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2877 silence_unlocked (nframes);
2881 Route::silence_unlocked (framecnt_t nframes)
2883 /* Must be called with the processor lock held */
2885 const framepos_t now = _session.transport_frame ();
2889 _output->silence (nframes);
2891 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2892 boost::shared_ptr<PluginInsert> pi;
2894 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2895 // skip plugins, they don't need anything when we're not active
2899 (*i)->silence (nframes, now);
2902 if (nframes == _session.get_block_size()) {
2909 Route::add_internal_return ()
2912 _intreturn.reset (new InternalReturn (_session));
2913 add_processor (_intreturn, PreFader);
2918 Route::add_send_to_internal_return (InternalSend* send)
2920 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2922 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2923 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2926 return d->add_send (send);
2932 Route::remove_send_from_internal_return (InternalSend* send)
2934 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2936 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2937 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2940 return d->remove_send (send);
2946 Route::enable_monitor_send ()
2948 /* Caller must hold process lock */
2949 assert (!AudioEngine::instance()->process_lock().trylock());
2951 /* master never sends to monitor section via the normal mechanism */
2952 assert (!is_master ());
2953 assert (!is_monitor ());
2955 /* make sure we have one */
2956 if (!_monitor_send) {
2957 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
2958 _monitor_send->set_display_to_user (false);
2962 configure_processors (0);
2965 /** Add an aux send to a route.
2966 * @param route route to send to.
2967 * @param before Processor to insert before, or 0 to insert at the end.
2970 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2972 assert (route != _session.monitor_out ());
2975 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2977 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2979 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2981 if (d && d->target_route() == route) {
2982 /* already listening via the specified IO: do nothing */
2990 boost::shared_ptr<InternalSend> listener;
2993 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2994 listener.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
2997 add_processor (listener, before);
2999 } catch (failed_constructor& err) {
3007 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3009 ProcessorStreams err;
3010 ProcessorList::iterator tmp;
3013 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3015 /* have to do this early because otherwise processor reconfig
3016 * will put _monitor_send back in the list
3019 if (route == _session.monitor_out()) {
3020 _monitor_send.reset ();
3024 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3026 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3028 if (d && d->target_route() == route) {
3030 if (remove_processor (*x, &err, false) > 0) {
3036 /* list could have been demolished while we dropped the lock
3039 if (_session.engine().connected()) {
3040 /* i/o processors cannot be removed if the engine is not running
3041 * so don't live-loop in case the engine is N/A or dies
3051 Route::set_comment (string cmt, void *src)
3055 _session.set_dirty ();
3059 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3061 FeedRecord fr (other, via_sends_only);
3063 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3065 if (!result.second) {
3067 /* already a record for "other" - make sure sends-only information is correct */
3068 if (!via_sends_only && result.first->sends_only) {
3069 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3070 frp->sends_only = false;
3074 return result.second;
3078 Route::clear_fed_by ()
3084 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3086 const FedBy& fed_by (other->fed_by());
3088 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3089 boost::shared_ptr<Route> sr = f->r.lock();
3091 if (sr && (sr.get() == this)) {
3093 if (via_sends_only) {
3094 *via_sends_only = f->sends_only;
3105 Route::all_inputs () const
3107 /* TODO, if this works as expected,
3108 * cache the IOVector and maintain it via
3109 * input_change_handler(), sidechain_change_handler() etc
3112 ios.push_back (_input);
3114 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3115 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3117 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3118 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3121 iop = pi->sidechain();
3124 if (iop != 0 && iop->input()) {
3125 ios.push_back (iop->input());
3132 Route::all_outputs () const
3135 // _output is included via Delivery
3136 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3137 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3138 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3139 if (iop != 0 && iop->output()) {
3140 ios.push_back (iop->output());
3147 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3149 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3150 if (other->all_inputs().fed_by (_output)) {
3151 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3152 if (via_send_only) {
3153 *via_send_only = false;
3159 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3161 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3163 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3164 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3167 iop = pi->sidechain();
3171 boost::shared_ptr<const IO> iop_out = iop->output();
3172 if (other.get() == this && iop_out && iop->input() && iop_out->connected_to (iop->input())) {
3173 // TODO this needs a delaylines in the Insert to align connections (!)
3174 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed its own return (%2)\n", iop->name(), other->name()));
3177 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3178 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3179 if (via_send_only) {
3180 *via_send_only = true;
3184 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3187 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3192 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3197 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3199 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3203 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3205 return _session._current_route_graph.feeds (shared_from_this (), other);
3208 /** Called from the (non-realtime) butler thread when the transport is stopped */
3210 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3212 framepos_t now = _session.transport_frame();
3215 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3217 Automatable::transport_stopped (now);
3219 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3221 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3225 (*i)->transport_stopped (now);
3229 _roll_delay = _initial_delay;
3233 Route::input_change_handler (IOChange change, void * /*src*/)
3235 if ((change.type & IOChange::ConfigurationChanged)) {
3236 /* This is called with the process lock held if change
3237 contains ConfigurationChanged
3239 configure_processors (0);
3240 _phase_control->resize (_input->n_ports().n_audio ());
3241 io_changed (); /* EMIT SIGNAL */
3244 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3247 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3248 if (_input->connected()) {
3249 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3250 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3254 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3255 if (does_feed && !sends_only) {
3256 if ((*i)->soloed()) {
3259 if ((*i)->solo_isolate_control()->solo_isolated()) {
3266 int delta = sbou - _solo_control->soloed_by_others_upstream();
3267 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3270 PBD::warning << string_compose (
3271 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3272 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3277 if (_solo_control->soloed_by_others_upstream()) {
3278 // ignore new connections (they're not propagated)
3280 _solo_control->mod_solo_by_others_upstream (delta);
3284 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3285 // solo-isolate currently only propagates downstream
3287 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3289 //_solo_isolated_by_upstream = ibou;
3292 // Session::route_solo_changed does not propagate indirect solo-changes
3293 // propagate downstream to tracks
3294 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3295 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3299 bool does_feed = feeds (*i, &sends_only);
3300 if (delta <= 0 && does_feed && !sends_only) {
3301 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3304 if (idelta < 0 && does_feed && !sends_only) {
3305 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3312 Route::output_change_handler (IOChange change, void * /*src*/)
3314 if (_initial_io_setup) {
3318 if ((change.type & IOChange::ConfigurationChanged)) {
3319 /* This is called with the process lock held if change
3320 contains ConfigurationChanged
3322 configure_processors (0);
3325 _session.reset_monitor_section();
3328 io_changed (); /* EMIT SIGNAL */
3331 if (_solo_control->soloed_by_others_downstream()) {
3333 /* checking all all downstream routes for
3334 * explicit of implict solo is a rather drastic measure,
3335 * ideally the input_change_handler() of the other route
3336 * would propagate the change to us.
3338 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3339 if (_output->connected()) {
3340 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3341 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3345 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3346 if (does_feed && !sends_only) {
3347 if ((*i)->soloed()) {
3354 int delta = sbod - _solo_control->soloed_by_others_downstream();
3356 // do not allow new connections to change implicit solo (no propagation)
3357 _solo_control->mod_solo_by_others_downstream (delta);
3358 // Session::route_solo_changed() does not propagate indirect solo-changes
3359 // propagate upstream to tracks
3360 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3361 if ((*i).get() == this || !can_solo()) {
3365 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3366 if (delta != 0 && does_feed && !sends_only) {
3367 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3376 Route::sidechain_change_handler (IOChange change, void* src)
3378 if (_initial_io_setup || _in_sidechain_setup) {
3382 input_change_handler (change, src);
3386 Route::pans_required () const
3388 if (n_outputs().n_audio() < 2) {
3392 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3396 Route::flush_processor_buffers_locked (framecnt_t nframes)
3398 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3399 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3401 d->flush_buffers (nframes);
3403 boost::shared_ptr<PortInsert> p = boost::dynamic_pointer_cast<PortInsert> (*i);
3405 p->flush_buffers (nframes);
3412 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3414 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3420 if (n_outputs().n_total() == 0) {
3424 if (!_active || n_inputs() == ChanCount::ZERO) {
3425 silence_unlocked (nframes);
3429 if (session_state_changing) {
3430 if (_session.transport_speed() != 0.0f) {
3431 /* we're rolling but some state is changing (e.g. our diskstream contents)
3432 so we cannot use them. Be silent till this is over.
3434 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3436 silence_unlocked (nframes);
3439 /* we're really not rolling, so we're either delivery silence or actually
3440 monitoring, both of which are safe to do while session_state_changing is true.
3444 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3446 fill_buffers_with_input (bufs, _input, nframes);
3448 if (_meter_point == MeterInput) {
3449 _meter->run (bufs, start_frame, end_frame, 0.0, nframes, true);
3452 _amp->apply_gain_automation (false);
3453 _trim->apply_gain_automation (false);
3454 passthru (bufs, start_frame, end_frame, nframes, 0);
3456 flush_processor_buffers_locked (nframes);
3462 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3464 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3469 if (n_outputs().n_total() == 0) {
3473 if (!_active || n_inputs().n_total() == 0) {
3474 silence_unlocked (nframes);
3478 framepos_t unused = 0;
3480 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3486 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3488 fill_buffers_with_input (bufs, _input, nframes);
3490 if (_meter_point == MeterInput) {
3491 _meter->run (bufs, start_frame, end_frame, 1.0, nframes, true);
3494 passthru (bufs, start_frame, end_frame, nframes, declick);
3496 flush_processor_buffers_locked (nframes);
3502 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3505 flush_processor_buffers_locked (nframes);
3510 Route::flush_processors ()
3512 /* XXX shouldn't really try to take this lock, since
3513 this is called from the RT audio thread.
3516 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3518 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3524 __attribute__((annotate("realtime")))
3527 Route::apply_processor_changes_rt ()
3529 int emissions = EmitNone;
3531 if (_pending_meter_point != _meter_point) {
3532 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3534 /* meters always have buffers for 'processor_max_streams'
3535 * they can be re-positioned without re-allocation */
3536 if (set_meter_point_unlocked()) {
3537 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3539 emissions |= EmitMeterChanged;
3544 bool changed = false;
3546 if (g_atomic_int_get (&_pending_process_reorder)) {
3547 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3549 apply_processor_order (_pending_processor_order);
3550 setup_invisible_processors ();
3552 g_atomic_int_set (&_pending_process_reorder, 0);
3553 emissions |= EmitRtProcessorChange;
3557 set_processor_positions ();
3559 if (emissions != 0) {
3560 g_atomic_int_set (&_pending_signals, emissions);
3563 return (!selfdestruct_sequence.empty ());
3567 Route::emit_pending_signals ()
3569 int sig = g_atomic_int_and (&_pending_signals, 0);
3570 if (sig & EmitMeterChanged) {
3571 _meter->emit_configuration_changed();
3572 meter_change (); /* EMIT SIGNAL */
3573 if (sig & EmitMeterVisibilityChange) {
3574 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3576 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3579 if (sig & EmitRtProcessorChange) {
3580 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3583 /* this would be a job for the butler.
3584 * Conceptually we should not take processe/processor locks here.
3585 * OTOH its more efficient (less overhead for summoning the butler and
3586 * telling her what do do) and signal emission is called
3587 * directly after the process callback, which decreases the chance
3588 * of x-runs when taking the locks.
3590 while (!selfdestruct_sequence.empty ()) {
3591 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3592 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3593 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3594 selfdestruct_sequence.pop_back ();
3597 remove_processor (proc);
3603 Route::set_meter_point (MeterPoint p, bool force)
3605 if (_pending_meter_point == p && !force) {
3609 if (force || !AudioEngine::instance()->running()) {
3610 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3611 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3612 _pending_meter_point = p;
3613 _meter->emit_configuration_changed();
3614 meter_change (); /* EMIT SIGNAL */
3615 if (set_meter_point_unlocked()) {
3616 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3618 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3621 _pending_meter_point = p;
3627 __attribute__((annotate("realtime")))
3630 Route::set_meter_point_unlocked ()
3633 /* Caller must hold process and processor write lock */
3634 assert (!AudioEngine::instance()->process_lock().trylock());
3635 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3636 assert (!lm.locked ());
3639 _meter_point = _pending_meter_point;
3641 bool meter_was_visible_to_user = _meter->display_to_user ();
3643 if (!_custom_meter_position_noted) {
3644 maybe_note_meter_position ();
3647 if (_meter_point != MeterCustom) {
3649 _meter->set_display_to_user (false);
3651 setup_invisible_processors ();
3654 _meter->set_display_to_user (true);
3656 /* If we have a previous position for the custom meter, try to put it there */
3657 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3659 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3660 if (i != _processors.end ()) {
3661 _processors.remove (_meter);
3662 _processors.insert (i, _meter);
3664 } else {// at end, right before the mains_out/panner
3665 _processors.remove (_meter);
3666 ProcessorList::iterator main = _processors.end();
3667 _processors.insert (--main, _meter);
3671 /* Set up the meter for its new position */
3673 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3677 if (loc == _processors.begin()) {
3678 m_in = _input->n_ports();
3680 ProcessorList::iterator before = loc;
3682 m_in = (*before)->output_streams ();
3685 _meter->reflect_inputs (m_in);
3687 /* we do not need to reconfigure the processors, because the meter
3688 (a) is always ready to handle processor_max_streams
3689 (b) is always an N-in/N-out processor, and thus moving
3690 it doesn't require any changes to the other processors.
3693 /* these should really be done after releasing the lock
3694 * but all those signals are subscribed to with gui_thread()
3697 return (_meter->display_to_user() != meter_was_visible_to_user);
3701 Route::listen_position_changed ()
3704 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3705 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3706 ProcessorState pstate (this);
3708 if (configure_processors_unlocked (0, &lm)) {
3709 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3711 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3716 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3717 _session.set_dirty ();
3720 boost::shared_ptr<CapturingProcessor>
3721 Route::add_export_point()
3723 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3724 if (!_capturing_processor) {
3726 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3727 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3729 // this aligns all tracks; but not tracks + busses
3730 assert (_session.worst_track_latency () >= _initial_delay);
3731 _capturing_processor.reset (new CapturingProcessor (_session, _session.worst_track_latency () - _initial_delay));
3732 _capturing_processor->activate ();
3734 configure_processors_unlocked (0, &lw);
3738 return _capturing_processor;
3742 Route::update_signal_latency ()
3744 framecnt_t l = _output->user_latency();
3745 framecnt_t lamp = 0;
3746 bool before_amp = true;
3747 framecnt_t ltrim = 0;
3748 bool before_trim = true;
3750 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3751 if ((*i)->active ()) {
3752 l += (*i)->signal_latency ();
3757 if ((*i) == _trim) {
3768 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3770 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3771 _signal_latency_at_amp_position = lamp;
3772 _signal_latency_at_trim_position = ltrim;
3774 if (_signal_latency != l) {
3775 _signal_latency = l;
3776 signal_latency_changed (); /* EMIT SIGNAL */
3779 return _signal_latency;
3783 Route::set_user_latency (framecnt_t nframes)
3785 _output->set_user_latency (nframes);
3786 _session.update_latency_compensation ();
3790 Route::set_latency_compensation (framecnt_t longest_session_latency)
3792 framecnt_t old = _initial_delay;
3794 if (_signal_latency < longest_session_latency) {
3795 _initial_delay = longest_session_latency - _signal_latency;
3800 DEBUG_TRACE (DEBUG::Latency, string_compose (
3801 "%1: compensate for maximum latency of %2,"
3802 "given own latency of %3, using initial delay of %4\n",
3803 name(), longest_session_latency, _signal_latency, _initial_delay));
3805 if (_initial_delay != old) {
3806 initial_delay_changed (); /* EMIT SIGNAL */
3809 if (_session.transport_stopped()) {
3810 _roll_delay = _initial_delay;
3815 Route::set_block_size (pframes_t nframes)
3817 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3818 (*i)->set_block_size (nframes);
3821 _session.ensure_buffers (n_process_buffers ());
3825 Route::protect_automation ()
3827 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3828 (*i)->protect_automation();
3831 /** @param declick 1 to set a pending declick fade-in,
3832 * -1 to set a pending declick fade-out
3835 Route::set_pending_declick (int declick)
3838 /* this call is not allowed to turn off a pending declick */
3840 _pending_declick = declick;
3843 _pending_declick = 0;
3847 /** Shift automation forwards from a particular place, thereby inserting time.
3848 * Adds undo commands for any shifts that are performed.
3850 * @param pos Position to start shifting from.
3851 * @param frames Amount to shift forwards by.
3855 Route::shift (framepos_t pos, framecnt_t frames)
3857 /* gain automation */
3859 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3861 XMLNode &before = gc->alist()->get_state ();
3862 gc->alist()->shift (pos, frames);
3863 XMLNode &after = gc->alist()->get_state ();
3864 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3867 /* gain automation */
3869 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3871 XMLNode &before = gc->alist()->get_state ();
3872 gc->alist()->shift (pos, frames);
3873 XMLNode &after = gc->alist()->get_state ();
3874 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3877 // TODO mute automation ??
3879 /* pan automation */
3881 ControlSet::Controls& c (_pannable->controls());
3883 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3884 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3886 boost::shared_ptr<AutomationList> al = pc->alist();
3887 XMLNode& before = al->get_state ();
3888 al->shift (pos, frames);
3889 XMLNode& after = al->get_state ();
3890 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3895 /* redirect automation */
3897 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3898 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3900 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3902 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3903 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3905 boost::shared_ptr<AutomationList> al = ac->alist();
3906 XMLNode &before = al->get_state ();
3907 al->shift (pos, frames);
3908 XMLNode &after = al->get_state ();
3909 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3917 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
3919 boost::shared_ptr<Processor> processor (p.lock ());
3920 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3924 pi->set_state_dir (d);
3928 Route::save_as_template (const string& path, const string& name)
3930 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
3931 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
3933 XMLNode& node (state (false));
3937 IO::set_name_in_state (*node.children().front(), name);
3939 tree.set_root (&node);
3941 /* return zero on success, non-zero otherwise */
3942 return !tree.write (path.c_str());
3947 Route::set_name (const string& str)
3949 if (str == name()) {
3953 string name = Route::ensure_track_or_route_name (str, _session);
3954 SessionObject::set_name (name);
3956 bool ret = (_input->set_name(name) && _output->set_name(name));
3959 /* rename the main outs. Leave other IO processors
3960 * with whatever name they already have, because its
3961 * just fine as it is (it will not contain the route
3962 * name if its a port insert, port send or port return).
3966 if (_main_outs->set_name (name)) {
3967 /* XXX returning false here is stupid because
3968 we already changed the route name.
3978 /** Set the name of a route in an XML description.
3979 * @param node XML <Route> node to set the name in.
3980 * @param name New name.
3983 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
3985 node.add_property (X_("name"), name);
3987 XMLNodeList children = node.children();
3988 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3990 if ((*i)->name() == X_("IO")) {
3992 IO::set_name_in_state (**i, name);
3994 } else if ((*i)->name() == X_("Processor")) {
3996 XMLProperty const * role = (*i)->property (X_("role"));
3997 if (role && role->value() == X_("Main")) {
3998 (*i)->add_property (X_("name"), name);
4001 } else if ((*i)->name() == X_("Diskstream")) {
4003 if (rename_playlist) {
4004 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
4006 (*i)->add_property (X_("name"), name);
4012 boost::shared_ptr<Send>
4013 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4015 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4017 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4018 boost::shared_ptr<InternalSend> send;
4020 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4021 if (send->target_route() == target) {
4027 return boost::shared_ptr<Send>();
4031 Route::set_denormal_protection (bool yn)
4033 if (_denormal_protection != yn) {
4034 _denormal_protection = yn;
4035 denormal_protection_changed (); /* EMIT SIGNAL */
4040 Route::denormal_protection () const
4042 return _denormal_protection;
4046 Route::set_active (bool yn, void* src)
4048 if (_session.transport_rolling()) {
4052 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4053 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4057 if (_active != yn) {
4059 _input->set_active (yn);
4060 _output->set_active (yn);
4061 active_changed (); // EMIT SIGNAL
4062 _session.set_dirty ();
4066 boost::shared_ptr<Pannable>
4067 Route::pannable() const
4072 boost::shared_ptr<Panner>
4073 Route::panner() const
4076 return _main_outs->panner_shell()->panner();
4079 boost::shared_ptr<PannerShell>
4080 Route::panner_shell() const
4082 return _main_outs->panner_shell();
4085 boost::shared_ptr<GainControl>
4086 Route::gain_control() const
4088 return _gain_control;
4091 boost::shared_ptr<GainControl>
4092 Route::trim_control() const
4094 return _trim_control;
4097 boost::shared_ptr<PhaseControl>
4098 Route::phase_control() const
4100 return _phase_control;
4103 boost::shared_ptr<AutomationControl>
4104 Route::get_control (const Evoral::Parameter& param)
4106 /* either we own the control or .... */
4108 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4112 /* maybe one of our processors does or ... */
4114 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4115 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4116 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4124 /* nobody does so we'll make a new one */
4126 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4133 boost::shared_ptr<Processor>
4134 Route::nth_plugin (uint32_t n) const
4136 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4137 ProcessorList::const_iterator i;
4139 for (i = _processors.begin(); i != _processors.end(); ++i) {
4140 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4147 return boost::shared_ptr<Processor> ();
4150 boost::shared_ptr<Processor>
4151 Route::nth_send (uint32_t n) const
4153 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4154 ProcessorList::const_iterator i;
4156 for (i = _processors.begin(); i != _processors.end(); ++i) {
4157 if (boost::dynamic_pointer_cast<Send> (*i)) {
4159 if ((*i)->name().find (_("Monitor")) == 0) {
4160 /* send to monitor section is not considered
4161 to be an accessible send.
4172 return boost::shared_ptr<Processor> ();
4176 Route::has_io_processor_named (const string& name)
4178 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4179 ProcessorList::iterator i;
4181 for (i = _processors.begin(); i != _processors.end(); ++i) {
4182 if (boost::dynamic_pointer_cast<Send> (*i) ||
4183 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4184 if ((*i)->name() == name) {
4194 Route::set_processor_positions ()
4196 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4198 bool had_amp = false;
4199 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4200 (*i)->set_pre_fader (!had_amp);
4207 /** Called when there is a proposed change to the input port count */
4209 Route::input_port_count_changing (ChanCount to)
4211 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4213 /* The processors cannot be configured with the new input arrangement, so
4219 /* The change is ok */
4223 /** Called when there is a proposed change to the output port count */
4225 Route::output_port_count_changing (ChanCount to)
4227 if (_strict_io && !_in_configure_processors) {
4230 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4231 if (processor_out_streams.get(*t) > to.get(*t)) {
4235 /* The change is ok */
4240 Route::unknown_processors () const
4244 if (_session.get_disable_all_loaded_plugins ()) {
4245 // Do not list "missing plugins" if they are explicitly disabled
4249 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4250 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4251 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4252 p.push_back ((*i)->name ());
4261 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4263 /* we assume that all our input ports feed all our output ports. its not
4264 universally true, but the alternative is way too corner-case to worry about.
4267 LatencyRange all_connections;
4270 all_connections.min = 0;
4271 all_connections.max = 0;
4273 all_connections.min = ~((pframes_t) 0);
4274 all_connections.max = 0;
4276 /* iterate over all "from" ports and determine the latency range for all of their
4277 connections to the "outside" (outside of this Route).
4280 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4284 p->get_connected_latency_range (range, playback);
4286 all_connections.min = min (all_connections.min, range.min);
4287 all_connections.max = max (all_connections.max, range.max);
4291 /* set the "from" port latencies to the max/min range of all their connections */
4293 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4294 p->set_private_latency_range (all_connections, playback);
4297 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4299 all_connections.min += our_latency;
4300 all_connections.max += our_latency;
4302 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4303 p->set_private_latency_range (all_connections, playback);
4306 return all_connections.max;
4310 Route::set_private_port_latencies (bool playback) const
4312 framecnt_t own_latency = 0;
4314 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4315 OR LATENCY CALLBACK.
4317 This is called (early) from the latency callback. It computes the REAL
4318 latency associated with each port and stores the result as the "private"
4319 latency of the port. A later call to Route::set_public_port_latencies()
4320 sets all ports to the same value to reflect the fact that we do latency
4321 compensation and so all signals are delayed by the same amount as they
4322 flow through ardour.
4325 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4326 if ((*i)->active ()) {
4327 own_latency += (*i)->signal_latency ();
4332 /* playback: propagate latency from "outside the route" to outputs to inputs */
4333 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4335 /* capture: propagate latency from "outside the route" to inputs to outputs */
4336 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4341 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4343 /* this is called to set the JACK-visible port latencies, which take
4344 latency compensation into account.
4353 const PortSet& ports (_input->ports());
4354 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4355 p->set_public_latency_range (range, playback);
4360 const PortSet& ports (_output->ports());
4361 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4362 p->set_public_latency_range (range, playback);
4367 /** Put the invisible processors in the right place in _processors.
4368 * Must be called with a writer lock on _processor_lock held.
4371 __attribute__((annotate("realtime")))
4374 Route::setup_invisible_processors ()
4377 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4378 assert (!lm.locked ());
4382 /* too early to be doing this stuff */
4386 /* we'll build this new list here and then use it
4388 * TODO put the ProcessorList is on the stack for RT-safety.
4391 ProcessorList new_processors;
4393 /* find visible processors */
4395 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4396 if ((*i)->display_to_user ()) {
4397 new_processors.push_back (*i);
4403 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4405 if (amp == new_processors.end ()) {
4406 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4407 new_processors.push_front (_amp);
4408 amp = find (new_processors.begin(), new_processors.end(), _amp);
4411 /* and the processor after the amp */
4413 ProcessorList::iterator after_amp = amp;
4419 switch (_meter_point) {
4421 assert (!_meter->display_to_user ());
4422 new_processors.push_front (_meter);
4425 assert (!_meter->display_to_user ());
4426 new_processors.insert (amp, _meter);
4428 case MeterPostFader:
4429 /* do nothing here */
4432 /* do nothing here */
4435 /* the meter is visible, so we don't touch it here */
4442 assert (_main_outs);
4443 assert (!_main_outs->display_to_user ());
4444 new_processors.push_back (_main_outs);
4446 /* iterator for the main outs */
4448 ProcessorList::iterator main = new_processors.end();
4451 /* OUTPUT METERING */
4453 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4454 assert (!_meter->display_to_user ());
4456 /* add the processor just before or just after the main outs */
4458 ProcessorList::iterator meter_point = main;
4460 if (_meter_point == MeterOutput) {
4463 new_processors.insert (meter_point, _meter);
4468 if (_monitor_send && !is_monitor ()) {
4469 assert (!_monitor_send->display_to_user ());
4470 switch (Config->get_listen_position ()) {
4471 case PreFaderListen:
4472 switch (Config->get_pfl_position ()) {
4473 case PFLFromBeforeProcessors:
4474 new_processors.push_front (_monitor_send);
4476 case PFLFromAfterProcessors:
4477 new_processors.insert (amp, _monitor_send);
4480 _monitor_send->set_can_pan (false);
4482 case AfterFaderListen:
4483 switch (Config->get_afl_position ()) {
4484 case AFLFromBeforeProcessors:
4485 new_processors.insert (after_amp, _monitor_send);
4487 case AFLFromAfterProcessors:
4488 new_processors.insert (new_processors.end(), _monitor_send);
4491 _monitor_send->set_can_pan (true);
4496 #if 0 // not used - just yet
4497 if (!is_master() && !is_monitor() && !is_auditioner()) {
4498 new_processors.push_front (_delayline);
4502 /* MONITOR CONTROL */
4504 if (_monitor_control && is_monitor ()) {
4505 assert (!_monitor_control->display_to_user ());
4506 new_processors.insert (amp, _monitor_control);
4511 if (_trim && _trim->active()) {
4512 assert (!_trim->display_to_user ());
4513 new_processors.push_front (_trim);
4516 /* INTERNAL RETURN */
4518 /* doing this here means that any monitor control will come after
4519 the return and trim.
4523 assert (!_intreturn->display_to_user ());
4524 new_processors.push_front (_intreturn);
4527 /* EXPORT PROCESSOR */
4529 if (_capturing_processor) {
4530 assert (!_capturing_processor->display_to_user ());
4531 new_processors.push_front (_capturing_processor);
4534 _processors = new_processors;
4536 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4537 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4538 (*i)->enable (true);
4542 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4543 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4544 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4551 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4552 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4556 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4557 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4564 /** If the meter point is `Custom', make a note of where the meter is.
4565 * This is so that if the meter point is subsequently set to something else,
4566 * and then back to custom, we can put the meter back where it was last time
4567 * custom was enabled.
4569 * Must be called with the _processor_lock held.
4572 Route::maybe_note_meter_position ()
4574 if (_meter_point != MeterCustom) {
4578 _custom_meter_position_noted = true;
4579 /* custom meter points range from after trim to before panner/main_outs
4580 * this is a limitation by the current processor UI
4582 bool seen_trim = false;
4583 _processor_after_last_custom_meter.reset();
4584 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4585 if ((*i) == _trim) {
4588 if ((*i) == _main_outs) {
4589 _processor_after_last_custom_meter = *i;
4592 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4594 _processor_after_last_custom_meter = _trim;
4596 ProcessorList::iterator j = i;
4598 assert(j != _processors.end ()); // main_outs should be before
4599 _processor_after_last_custom_meter = *j;
4604 assert(_processor_after_last_custom_meter.lock());
4607 boost::shared_ptr<Processor>
4608 Route::processor_by_id (PBD::ID id) const
4610 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4611 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4612 if ((*i)->id() == id) {
4617 return boost::shared_ptr<Processor> ();
4620 /** @return the monitoring state, or in other words what data we are pushing
4621 * into the route (data from the inputs, data from disk or silence)
4624 Route::monitoring_state () const
4626 return MonitoringInput;
4629 /** @return what we should be metering; either the data coming from the input
4630 * IO or the data that is flowing through the route.
4633 Route::metering_state () const
4635 return MeteringRoute;
4639 Route::has_external_redirects () const
4641 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4643 /* ignore inactive processors and obviously ignore the main
4644 * outs since everything has them and we don't care.
4647 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4655 boost::shared_ptr<Processor>
4656 Route::the_instrument () const
4658 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4659 return the_instrument_unlocked ();
4662 boost::shared_ptr<Processor>
4663 Route::the_instrument_unlocked () const
4665 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4666 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4667 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4671 return boost::shared_ptr<Processor>();
4677 Route::non_realtime_locate (framepos_t pos)
4680 _pannable->transport_located (pos);
4683 if (_delayline.get()) {
4684 _delayline.get()->flush();
4688 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4689 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4691 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4692 (*i)->transport_located (pos);
4695 _roll_delay = _initial_delay;
4699 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4706 * We don't currently mix MIDI input together, so we don't need the
4707 * complex logic of the audio case.
4710 n_buffers = bufs.count().n_midi ();
4712 for (i = 0; i < n_buffers; ++i) {
4714 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4715 MidiBuffer& buf (bufs.get_midi (i));
4718 buf.copy (source_port->get_midi_buffer(nframes));
4720 buf.silence (nframes);
4726 n_buffers = bufs.count().n_audio();
4728 size_t n_ports = io->n_ports().n_audio();
4729 float scaling = 1.0f;
4731 if (n_ports > n_buffers) {
4732 scaling = ((float) n_buffers) / n_ports;
4735 for (i = 0; i < n_ports; ++i) {
4737 /* if there are more ports than buffers, map them onto buffers
4738 * in a round-robin fashion
4741 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4742 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4745 if (i < n_buffers) {
4747 /* first time through just copy a channel into
4751 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4753 if (scaling != 1.0f) {
4754 buf.apply_gain (scaling, nframes);
4759 /* on subsequent times around, merge data from
4760 * the port with what is already there
4763 if (scaling != 1.0f) {
4764 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4766 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4771 /* silence any remaining buffers */
4773 for (; i < n_buffers; ++i) {
4774 AudioBuffer& buf (bufs.get_audio (i));
4775 buf.silence (nframes);
4778 /* establish the initial setup of the buffer set, reflecting what was
4779 copied into it. unless, of course, we are the auditioner, in which
4780 case nothing was fed into it from the inputs at all.
4783 if (!is_auditioner()) {
4784 bufs.set_count (io->n_ports());
4788 boost::shared_ptr<AutomationControl>
4789 Route::pan_azimuth_control() const
4792 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4794 return boost::shared_ptr<AutomationControl>();
4796 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4797 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4799 if (!_pannable || !panner()) {
4800 return boost::shared_ptr<AutomationControl>();
4802 return _pannable->pan_azimuth_control;
4806 boost::shared_ptr<AutomationControl>
4807 Route::pan_elevation_control() const
4809 if (Profile->get_mixbus() || !_pannable || !panner()) {
4810 return boost::shared_ptr<AutomationControl>();
4813 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4815 if (c.find (PanElevationAutomation) != c.end()) {
4816 return _pannable->pan_elevation_control;
4818 return boost::shared_ptr<AutomationControl>();
4821 boost::shared_ptr<AutomationControl>
4822 Route::pan_width_control() const
4824 if (Profile->get_mixbus() || !_pannable || !panner()) {
4825 return boost::shared_ptr<AutomationControl>();
4828 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4830 if (c.find (PanWidthAutomation) != c.end()) {
4831 return _pannable->pan_width_control;
4833 return boost::shared_ptr<AutomationControl>();
4836 boost::shared_ptr<AutomationControl>
4837 Route::pan_frontback_control() const
4839 if (Profile->get_mixbus() || !_pannable || !panner()) {
4840 return boost::shared_ptr<AutomationControl>();
4843 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4845 if (c.find (PanFrontBackAutomation) != c.end()) {
4846 return _pannable->pan_frontback_control;
4848 return boost::shared_ptr<AutomationControl>();
4851 boost::shared_ptr<AutomationControl>
4852 Route::pan_lfe_control() const
4854 if (Profile->get_mixbus() || !_pannable || !panner()) {
4855 return boost::shared_ptr<AutomationControl>();
4858 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4860 if (c.find (PanLFEAutomation) != c.end()) {
4861 return _pannable->pan_lfe_control;
4863 return boost::shared_ptr<AutomationControl>();
4868 Route::eq_band_cnt () const
4870 if (Profile->get_mixbus()) {
4873 /* Ardour has no well-known EQ object */
4878 boost::shared_ptr<AutomationControl>
4879 Route::eq_gain_controllable (uint32_t band) const
4882 boost::shared_ptr<PluginInsert> eq = ch_eq();
4885 return boost::shared_ptr<AutomationControl>();
4888 uint32_t port_number;
4891 if (is_master() || mixbus()) {
4898 if (is_master() || mixbus()) {
4905 if (is_master() || mixbus()) {
4912 return boost::shared_ptr<AutomationControl>();
4915 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4917 return boost::shared_ptr<AutomationControl>();
4920 boost::shared_ptr<AutomationControl>
4921 Route::eq_freq_controllable (uint32_t band) const
4925 if (mixbus() || is_master()) {
4926 /* no frequency controls for mixbusses or master */
4927 return boost::shared_ptr<AutomationControl>();
4930 boost::shared_ptr<PluginInsert> eq = ch_eq();
4933 return boost::shared_ptr<AutomationControl>();
4936 uint32_t port_number;
4948 return boost::shared_ptr<AutomationControl>();
4951 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4953 return boost::shared_ptr<AutomationControl>();
4957 boost::shared_ptr<AutomationControl>
4958 Route::eq_q_controllable (uint32_t band) const
4960 return boost::shared_ptr<AutomationControl>();
4963 boost::shared_ptr<AutomationControl>
4964 Route::eq_shape_controllable (uint32_t band) const
4966 return boost::shared_ptr<AutomationControl>();
4969 boost::shared_ptr<AutomationControl>
4970 Route::eq_enable_controllable () const
4973 boost::shared_ptr<PluginInsert> eq = ch_eq();
4976 return boost::shared_ptr<AutomationControl>();
4979 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
4981 return boost::shared_ptr<AutomationControl>();
4985 boost::shared_ptr<AutomationControl>
4986 Route::eq_hpf_controllable () const
4989 boost::shared_ptr<PluginInsert> eq = ch_eq();
4992 return boost::shared_ptr<AutomationControl>();
4995 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
4997 return boost::shared_ptr<AutomationControl>();
5002 Route::eq_band_name (uint32_t band) const
5004 if (Profile->get_mixbus()) {
5020 boost::shared_ptr<AutomationControl>
5021 Route::comp_enable_controllable () const
5024 boost::shared_ptr<PluginInsert> comp = ch_comp();
5027 return boost::shared_ptr<AutomationControl>();
5030 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5032 return boost::shared_ptr<AutomationControl>();
5035 boost::shared_ptr<AutomationControl>
5036 Route::comp_threshold_controllable () const
5039 boost::shared_ptr<PluginInsert> comp = ch_comp();
5042 return boost::shared_ptr<AutomationControl>();
5045 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5048 return boost::shared_ptr<AutomationControl>();
5051 boost::shared_ptr<AutomationControl>
5052 Route::comp_speed_controllable () const
5055 boost::shared_ptr<PluginInsert> comp = ch_comp();
5058 return boost::shared_ptr<AutomationControl>();
5061 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5063 return boost::shared_ptr<AutomationControl>();
5066 boost::shared_ptr<AutomationControl>
5067 Route::comp_mode_controllable () const
5070 boost::shared_ptr<PluginInsert> comp = ch_comp();
5073 return boost::shared_ptr<AutomationControl>();
5076 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5078 return boost::shared_ptr<AutomationControl>();
5081 boost::shared_ptr<AutomationControl>
5082 Route::comp_makeup_controllable () const
5085 boost::shared_ptr<PluginInsert> comp = ch_comp();
5088 return boost::shared_ptr<AutomationControl>();
5091 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5093 return boost::shared_ptr<AutomationControl>();
5096 boost::shared_ptr<AutomationControl>
5097 Route::comp_redux_controllable () const
5100 boost::shared_ptr<PluginInsert> comp = ch_comp();
5103 return boost::shared_ptr<AutomationControl>();
5106 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5108 return boost::shared_ptr<AutomationControl>();
5113 Route::comp_mode_name (uint32_t mode) const
5118 return _("Leveler");
5120 return _("Compressor");
5122 return _("Limiter");
5124 return mixbus() ? _("Sidechain") : _("Limiter");
5134 Route::comp_speed_name (uint32_t mode) const
5152 boost::shared_ptr<AutomationControl>
5153 Route::send_level_controllable (uint32_t n) const
5156 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5158 return boost::shared_ptr<AutomationControl>();
5163 return boost::shared_ptr<AutomationControl>();
5166 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5167 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5169 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5171 return boost::shared_ptr<AutomationControl>();
5173 return s->gain_control ();
5177 boost::shared_ptr<AutomationControl>
5178 Route::send_enable_controllable (uint32_t n) const
5181 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5183 return boost::shared_ptr<AutomationControl>();
5188 return boost::shared_ptr<AutomationControl>();
5191 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5192 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5194 /* although Ardour sends have enable/disable as part of the Processor
5195 API, it is not exposed as a controllable.
5197 XXX: we should fix this.
5199 return boost::shared_ptr<AutomationControl>();
5204 Route::send_name (uint32_t n) const
5210 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5214 boost::shared_ptr<Processor> p = nth_send (n);
5223 boost::shared_ptr<AutomationControl>
5224 Route::master_send_enable_controllable () const
5227 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5229 return boost::shared_ptr<AutomationControl>();
5231 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5233 return boost::shared_ptr<AutomationControl>();
5238 Route::slaved () const
5240 if (!_gain_control) {
5243 /* just test one particular control, not all of them */
5244 return _gain_control->slaved ();
5248 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5250 if (!vca || !_gain_control) {
5254 /* just test one particular control, not all of them */
5256 return _gain_control->slaved_to (vca->gain_control());
5260 Route::muted_by_others_soloing () const
5262 if (!can_be_muted_by_others ()) {
5266 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5270 Route::clear_all_solo_state ()
5272 double v = _solo_safe_control->get_value ();
5274 _solo_control->clear_all_solo_state ();
5277 _solo_safe_control->set_value (v, Controllable::NoGroup);