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();
123 /* set default meter type */
125 _meter_type = Config->get_meter_type_master ();
127 else if (dynamic_cast<Track*>(this)) {
128 _meter_type = Config->get_meter_type_track ();
130 _meter_type = Config->get_meter_type_bus ();
133 /* add standard controls */
135 _gain_control.reset (new GainControl (_session, GainAutomation));
136 add_control (_gain_control);
138 _trim_control.reset (new GainControl (_session, TrimAutomation));
139 add_control (_trim_control);
141 _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
142 add_control (_solo_control);
143 _solo_control->Changed.connect_same_thread (*this, boost::bind (&Route::solo_control_changed, this, _1, _2));
145 _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
146 add_control (_mute_control);
148 _phase_control.reset (new PhaseControl (_session, X_("phase")));
149 add_control (_phase_control);
151 _solo_isolate_control.reset (new SoloIsolateControl (_session, X_("solo-iso"), *this, *this));
152 add_control (_solo_isolate_control);
154 _solo_safe_control.reset (new SoloSafeControl (_session, X_("solo-safe")));
155 add_control (_solo_safe_control);
159 if (!(_presentation_info.flags() & PresentationInfo::MonitorOut)) {
160 _pannable.reset (new Pannable (_session));
163 /* input and output objects */
165 _input.reset (new IO (_session, _name, IO::Input, _default_type));
166 _output.reset (new IO (_session, _name, IO::Output, _default_type));
168 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
169 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
171 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
172 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
174 /* add the amp/fader processor.
175 * it should be the first processor to be added on every route.
178 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
179 add_processor (_amp, PostFader);
182 _amp->set_display_name (_("Monitor"));
185 #if 0 // not used - just yet
186 if (!is_master() && !is_monitor() && !is_auditioner()) {
187 _delayline.reset (new DelayLine (_session, _name));
188 add_processor (_delayline, PreFader);
194 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
195 _trim->set_display_to_user (false);
197 if (dynamic_cast<AudioTrack*>(this)) {
198 /* we can't do this in the AudioTrack's constructor
199 * because _trim does not exit then
203 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
208 /* create standard processors: meter, main outs, monitor out;
209 they will be added to _processors by setup_invisible_processors ()
212 _meter.reset (new PeakMeter (_session, _name));
213 _meter->set_owner (this);
214 _meter->set_display_to_user (false);
217 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
218 _main_outs->activate ();
221 /* where we listen to tracks */
222 _intreturn.reset (new InternalReturn (_session));
223 _intreturn->activate ();
225 /* the thing that provides proper control over a control/monitor/listen bus
226 (such as per-channel cut, dim, solo, invert, etc).
228 _monitor_control.reset (new MonitorProcessor (_session));
229 _monitor_control->activate ();
232 if (is_master() || is_monitor() || is_auditioner()) {
233 _mute_master->set_solo_ignore (true);
236 /* now that we have _meter, its safe to connect to this */
239 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
240 configure_processors (0);
248 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
250 /* do this early so that we don't get incoming signals as we are going through destruction
255 /* don't use clear_processors here, as it depends on the session which may
256 be half-destroyed by now
259 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
260 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
261 (*i)->drop_references ();
264 _processors.clear ();
268 Route::ensure_track_or_route_name(string name, Session &session)
270 string newname = name;
272 while (!session.io_name_is_legal (newname)) {
273 newname = bump_name_once (newname, ' ');
280 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
282 // TODO route group, see set_gain()
283 // _trim_control->route_set_value (val);
287 Route::maybe_declick (BufferSet&, framecnt_t, int)
289 /* this is the "bus" implementation and they never declick.
294 /** Process this route for one (sub) cycle (process thread)
296 * @param bufs Scratch buffers to use for the signal path
297 * @param start_frame Initial transport frame
298 * @param end_frame Final transport frame
299 * @param nframes Number of frames to output (to ports)
301 * Note that (end_frame - start_frame) may not be equal to nframes when the
302 * transport speed isn't 1.0 (eg varispeed).
305 Route::process_output_buffers (BufferSet& bufs,
306 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
307 int declick, bool gain_automation_ok)
309 /* Caller must hold process lock */
310 assert (!AudioEngine::instance()->process_lock().trylock());
312 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
314 // can this actually happen? functions calling process_output_buffers()
315 // already take a reader-lock.
316 bufs.silence (nframes, 0);
320 _mute_control->automation_run (start_frame, nframes);
322 /* figure out if we're going to use gain automation */
323 if (gain_automation_ok) {
324 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
325 _amp->setup_gain_automation (
326 start_frame + _signal_latency_at_amp_position,
327 end_frame + _signal_latency_at_amp_position,
330 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
331 _trim->setup_gain_automation (
332 start_frame + _signal_latency_at_trim_position,
333 end_frame + _signal_latency_at_trim_position,
336 _amp->apply_gain_automation (false);
337 _trim->apply_gain_automation (false);
340 /* Tell main outs what to do about monitoring. We do this so that
341 on a transition between monitoring states we get a de-clicking gain
342 change in the _main_outs delivery, if config.get_use_monitor_fades()
345 We override this in the case where we have an internal generator.
347 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
349 _main_outs->no_outs_cuz_we_no_monitor (silence);
351 /* -------------------------------------------------------------------------------------------
352 GLOBAL DECLICK (for transport changes etc.)
353 ----------------------------------------------------------------------------------------- */
355 maybe_declick (bufs, nframes, declick);
356 _pending_declick = 0;
358 /* -------------------------------------------------------------------------------------------
359 DENORMAL CONTROL/PHASE INVERT
360 ----------------------------------------------------------------------------------------- */
362 if (!_phase_control->none()) {
366 if (_denormal_protection || Config->get_denormal_protection()) {
368 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
369 Sample* const sp = i->data();
371 if (_phase_control->inverted (chn)) {
372 for (pframes_t nx = 0; nx < nframes; ++nx) {
377 for (pframes_t nx = 0; nx < nframes; ++nx) {
385 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
386 Sample* const sp = i->data();
388 if (_phase_control->inverted (chn)) {
389 for (pframes_t nx = 0; nx < nframes; ++nx) {
398 if (_denormal_protection || Config->get_denormal_protection()) {
400 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
401 Sample* const sp = i->data();
402 for (pframes_t nx = 0; nx < nframes; ++nx) {
410 /* -------------------------------------------------------------------------------------------
412 ----------------------------------------------------------------------------------------- */
414 /* set this to be true if the meter will already have been ::run() earlier */
415 bool const meter_already_run = metering_state() == MeteringInput;
417 framecnt_t latency = 0;
419 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
421 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
422 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
427 /* if it has any inputs, make sure they match */
428 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
429 if (bufs.count() != (*i)->input_streams()) {
431 DEBUG::Processors, string_compose (
432 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
433 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
440 /* should we NOT run plugins here if the route is inactive?
441 do we catch route != active somewhere higher?
444 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
445 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
448 (*i)->run (bufs, start_frame - latency, end_frame - latency, nframes, *i != _processors.back());
449 bufs.set_count ((*i)->output_streams());
451 if ((*i)->active ()) {
452 latency += (*i)->signal_latency ();
458 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
459 boost::shared_ptr<Processor> endpoint,
460 bool include_endpoint, bool for_export, bool for_freeze)
462 /* If no processing is required, there's no need to go any further. */
463 if (!endpoint && !include_endpoint) {
467 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
468 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
469 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
471 /* trim is always at the top, for bounce no latency compensation is needed */
472 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
473 _trim->setup_gain_automation (start, start + nframes, nframes);
476 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
478 if (!include_endpoint && (*i) == endpoint) {
482 /* if we're *not* exporting, stop processing if we come across a routing processor. */
483 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
486 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
490 /* special case the panner (export outputs)
491 * Ideally we'd only run the panner, not the delivery itself...
492 * but panners need separate input/output buffers and some context
493 * (panshell, panner type, etc). AFAICT there is no ill side effect
494 * of re-using the main delivery when freewheeling/exporting a region.
496 if ((*i) == _main_outs) {
497 assert ((*i)->does_routing());
498 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
499 buffers.set_count ((*i)->output_streams());
502 /* don't run any processors that do routing.
503 * Also don't bother with metering.
505 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
506 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
507 buffers.set_count ((*i)->output_streams());
508 latency += (*i)->signal_latency ();
511 if ((*i) == endpoint) {
518 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
519 bool include_endpoint, bool for_export, bool for_freeze) const
521 framecnt_t latency = 0;
522 if (!endpoint && !include_endpoint) {
526 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
527 if (!include_endpoint && (*i) == endpoint) {
530 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
533 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
536 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
537 latency += (*i)->signal_latency ();
539 if ((*i) == endpoint) {
547 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
548 bool include_endpoint, bool for_export, bool for_freeze) const
550 if (!endpoint && !include_endpoint) {
554 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
555 if (!include_endpoint && (*i) == endpoint) {
558 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
561 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
564 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
565 cc = (*i)->output_streams();
567 if ((*i) == endpoint) {
575 Route::n_process_buffers ()
577 return max (_input->n_ports(), processor_max_streams);
581 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
583 assert (is_monitor());
584 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
585 fill_buffers_with_input (bufs, _input, nframes);
586 passthru (bufs, start_frame, end_frame, nframes, declick);
590 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
594 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
596 /* control/monitor bus ignores input ports when something is
597 feeding the listen "stream". data will "arrive" into the
598 route from the intreturn processor element.
601 bufs.silence (nframes, 0);
604 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
605 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
609 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
611 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
613 bufs.set_count (_input->n_ports());
614 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
615 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
619 Route::set_listen (bool yn)
623 _monitor_send->activate ();
625 _monitor_send->deactivate ();
631 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
633 /* nothing to do if we're not using AFL/PFL. But if we are, we need
634 to alter the active state of the monitor send.
637 if (Config->get_solo_control_is_listen_control ()) {
638 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
643 Route::push_solo_isolate_upstream (int32_t delta)
645 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
647 boost::shared_ptr<RouteList> routes = _session.get_routes ();
648 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
650 if ((*i).get() == this || !(*i)->can_solo()) {
655 bool does_feed = feeds (*i, &sends_only);
657 if (does_feed && !sends_only) {
658 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
664 Route::push_solo_upstream (int delta)
666 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
667 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
671 boost::shared_ptr<Route> sr (i->r.lock());
673 sr->solo_control()->mod_solo_by_others_downstream (-delta);
680 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
682 cerr << name << " {" << endl;
683 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
684 p != procs.end(); ++p) {
685 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
691 /** Supposing that we want to insert a Processor at a given Placement, return
692 * the processor to add the new one before (or 0 to add at the end).
694 boost::shared_ptr<Processor>
695 Route::before_processor_for_placement (Placement p)
697 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
699 ProcessorList::iterator loc;
702 /* generic pre-fader: insert immediately before the amp */
703 loc = find (_processors.begin(), _processors.end(), _amp);
705 /* generic post-fader: insert right before the main outs */
706 loc = find (_processors.begin(), _processors.end(), _main_outs);
709 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
712 /** Supposing that we want to insert a Processor at a given index, return
713 * the processor to add the new one before (or 0 to add at the end).
715 boost::shared_ptr<Processor>
716 Route::before_processor_for_index (int index)
719 return boost::shared_ptr<Processor> ();
722 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
724 ProcessorList::iterator i = _processors.begin ();
726 while (i != _processors.end() && j < index) {
727 if ((*i)->display_to_user()) {
734 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
737 /** Add a processor either pre- or post-fader
738 * @return 0 on success, non-0 on failure.
741 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
743 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
747 /** Add a processor to a route such that it ends up with a given index into the visible processors.
748 * @param index Index to add the processor at, or -1 to add at the end of the list.
749 * @return 0 on success, non-0 on failure.
752 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
754 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
757 /** Add a processor to the route.
758 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
759 * @return 0 on success, non-0 on failure.
762 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
764 assert (processor != _meter);
765 assert (processor != _main_outs);
767 DEBUG_TRACE (DEBUG::Processors, string_compose (
768 "%1 adding processor %2\n", name(), processor->name()));
772 pl.push_back (processor);
773 int rv = add_processors (pl, before, err);
779 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
780 processor->activate ();
787 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
789 /* We cannot destruct the processor here (usually RT-thread
790 * with various locks held - in case of sends also io_locks).
791 * Queue for deletion in low-priority thread.
793 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
794 selfdestruct_sequence.push_back (wp);
798 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
800 XMLProperty const * prop;
803 boost::shared_ptr<Processor> processor;
805 /* bit of a hack: get the `placement' property from the <Redirect> tag here
806 so that we can add the processor in the right place (pre/post-fader)
809 XMLNodeList const & children = node.children ();
810 XMLNodeList::const_iterator i = children.begin ();
812 while (i != children.end() && (*i)->name() != X_("Redirect")) {
816 Placement placement = PreFader;
818 if (i != children.end()) {
819 if ((prop = (*i)->property (X_("placement"))) != 0) {
820 placement = Placement (string_2_enum (prop->value(), placement));
824 if (node.name() == "Insert") {
826 if ((prop = node.property ("type")) != 0) {
828 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
829 prop->value() == "lv2" ||
830 prop->value() == "windows-vst" ||
831 prop->value() == "lxvst" ||
832 prop->value() == "audiounit") {
834 if (_session.get_disable_all_loaded_plugins ()) {
835 processor.reset (new UnknownProcessor (_session, node));
837 processor.reset (new PluginInsert (_session));
838 processor->set_owner (this);
843 processor.reset (new PortInsert (_session, _pannable, _mute_master));
848 } else if (node.name() == "Send") {
850 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
851 processor.reset (new Send (_session, sendpan, _mute_master));
855 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
859 if (processor->set_state (node, version)) {
863 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
864 if (i != children.end()) {
865 if ((prop = (*i)->property (X_("active"))) != 0) {
866 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
867 processor->activate();
869 processor->deactivate();
873 return (add_processor (processor, placement, 0, false) == 0);
876 catch (failed_constructor &err) {
877 warning << _("processor could not be created. Ignored.") << endmsg;
883 inline Route::PluginSetupOptions operator|= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
884 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) | static_cast<int> (b));
887 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
888 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
892 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
894 ProcessorList::iterator loc;
897 loc = find(_processors.begin(), _processors.end(), before);
898 if (loc == _processors.end ()) {
902 /* nothing specified - at end */
903 loc = _processors.end ();
906 if (!AudioEngine::instance()->connected()) {
910 if (others.empty()) {
914 ProcessorList to_skip;
916 // check if there's an instrument to replace or configure
917 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
918 boost::shared_ptr<PluginInsert> pi;
919 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
922 if (!pi->plugin ()->get_info ()->is_instrument ()) {
925 boost::shared_ptr<Processor> instrument = the_instrument ();
926 ChanCount in (DataType::MIDI, 1);
927 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
929 PluginSetupOptions flags = None;
932 in = instrument->input_streams ();
933 out = instrument->output_streams ();
935 if (pi->has_output_presets (in, out)) {
939 pi->set_strict_io (_strict_io);
941 PluginSetupOptions mask = None;
942 if (Config->get_ask_replace_instrument ()) {
945 if (Config->get_ask_setup_instrument ()) {
952 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
953 switch (rv.get_value_or (0)) {
955 to_skip.push_back (*i); // don't add this one;
958 replace_processor (instrument, *i, err);
959 to_skip.push_back (*i);
968 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
969 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
970 ProcessorState pstate (this);
972 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
977 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
978 if (check != to_skip.end()) {
982 boost::shared_ptr<PluginInsert> pi;
984 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
985 pi->set_strict_io (_strict_io);
989 /* Ensure that only one amp is in the list at any time */
990 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
991 if (check != _processors.end()) {
992 if (before == _amp) {
993 /* Already in position; all is well */
996 _processors.erase (check);
1001 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1003 _processors.insert (loc, *i);
1004 (*i)->set_owner (this);
1007 if (configure_processors_unlocked (err, &lm)) {
1009 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1014 if ((*i)->active()) {
1018 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1020 boost::shared_ptr<Send> send;
1021 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1022 send->SelfDestruct.connect_same_thread (*this,
1023 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1027 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1028 boost::shared_ptr<PluginInsert> pi;
1030 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1031 if (pi->has_no_inputs ()) {
1032 _have_internal_generator = true;
1038 _output->set_user_latency (0);
1041 reset_instrument_info ();
1042 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1043 set_processor_positions ();
1049 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1051 if (p == PreFader) {
1052 start = _processors.begin();
1053 end = find(_processors.begin(), _processors.end(), _amp);
1055 start = find(_processors.begin(), _processors.end(), _amp);
1057 end = _processors.end();
1061 /** Turn off all processors with a given placement
1062 * @param p Placement of processors to disable
1065 Route::disable_processors (Placement p)
1067 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1069 ProcessorList::iterator start, end;
1070 placement_range(p, start, end);
1072 for (ProcessorList::iterator i = start; i != end; ++i) {
1073 (*i)->deactivate ();
1076 _session.set_dirty ();
1079 /** Turn off all redirects
1082 Route::disable_processors ()
1084 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1086 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1087 (*i)->deactivate ();
1090 _session.set_dirty ();
1093 /** Turn off all redirects with a given placement
1094 * @param p Placement of redirects to disable
1097 Route::disable_plugins (Placement p)
1099 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1101 ProcessorList::iterator start, end;
1102 placement_range(p, start, end);
1104 for (ProcessorList::iterator i = start; i != end; ++i) {
1105 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1106 (*i)->deactivate ();
1110 _session.set_dirty ();
1113 /** Turn off all plugins
1116 Route::disable_plugins ()
1118 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1120 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1121 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1122 (*i)->deactivate ();
1126 _session.set_dirty ();
1131 Route::ab_plugins (bool forward)
1133 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1137 /* forward = turn off all active redirects, and mark them so that the next time
1138 we go the other way, we will revert them
1141 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1142 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1146 if ((*i)->active()) {
1147 (*i)->deactivate ();
1148 (*i)->set_next_ab_is_active (true);
1150 (*i)->set_next_ab_is_active (false);
1156 /* backward = if the redirect was marked to go active on the next ab, do so */
1158 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1160 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1164 if ((*i)->get_next_ab_is_active()) {
1167 (*i)->deactivate ();
1172 _session.set_dirty ();
1176 /** Remove processors with a given placement.
1177 * @param p Placement of processors to remove.
1180 Route::clear_processors (Placement p)
1182 if (!_session.engine().connected()) {
1186 bool already_deleting = _session.deletion_in_progress();
1187 if (!already_deleting) {
1188 _session.set_deletion_in_progress();
1192 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1193 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1194 ProcessorList new_list;
1195 ProcessorStreams err;
1196 bool seen_amp = false;
1198 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1204 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1206 /* you can't remove these */
1208 new_list.push_back (*i);
1215 new_list.push_back (*i);
1218 (*i)->drop_references ();
1226 (*i)->drop_references ();
1229 new_list.push_back (*i);
1236 _processors = new_list;
1237 configure_processors_unlocked (&err, &lm); // this can't fail
1240 processor_max_streams.reset();
1241 _have_internal_generator = false;
1242 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1243 set_processor_positions ();
1245 reset_instrument_info ();
1247 if (!already_deleting) {
1248 _session.clear_deletion_in_progress();
1253 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1255 // TODO once the export point can be configured properly, do something smarter here
1256 if (processor == _capturing_processor) {
1257 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1258 if (need_process_lock) {
1262 _capturing_processor.reset();
1264 if (need_process_lock) {
1269 /* these can never be removed */
1271 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1275 if (!_session.engine().connected()) {
1279 processor_max_streams.reset();
1282 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1283 if (need_process_lock) {
1287 /* Caller must hold process lock */
1288 assert (!AudioEngine::instance()->process_lock().trylock());
1290 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1292 ProcessorState pstate (this);
1294 ProcessorList::iterator i;
1295 bool removed = false;
1297 for (i = _processors.begin(); i != _processors.end(); ) {
1298 if (*i == processor) {
1300 /* move along, see failure case for configure_processors()
1301 where we may need to reconfigure the processor.
1304 /* stop redirects that send signals to JACK ports
1305 from causing noise as a result of no longer being
1309 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1310 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1314 iop = pi->sidechain();
1321 i = _processors.erase (i);
1329 _output->set_user_latency (0);
1337 if (configure_processors_unlocked (err, &lm)) {
1339 /* we know this will work, because it worked before :) */
1340 configure_processors_unlocked (0, &lm);
1344 _have_internal_generator = false;
1346 for (i = _processors.begin(); i != _processors.end(); ++i) {
1347 boost::shared_ptr<PluginInsert> pi;
1349 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1350 if (pi->has_no_inputs ()) {
1351 _have_internal_generator = true;
1356 if (need_process_lock) {
1361 reset_instrument_info ();
1362 processor->drop_references ();
1363 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1364 set_processor_positions ();
1370 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1372 /* these can never be removed */
1373 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1376 /* and can't be used as substitute, either */
1377 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1381 /* I/Os are out, too */
1382 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1386 /* this function cannot be used to swap/reorder processors */
1387 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1391 if (!AudioEngine::instance()->connected() || !old || !sub) {
1395 /* ensure that sub is not owned by another route */
1396 if (sub->owner ()) {
1401 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1402 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1403 ProcessorState pstate (this);
1405 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1407 ProcessorList::iterator i;
1408 bool replaced = false;
1409 bool enable = old->active ();
1411 for (i = _processors.begin(); i != _processors.end(); ) {
1413 i = _processors.erase (i);
1414 _processors.insert (i, sub);
1415 sub->set_owner (this);
1428 boost::shared_ptr<PluginInsert> pi;
1429 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1430 pi->set_strict_io (true);
1434 if (configure_processors_unlocked (err, &lm)) {
1436 configure_processors_unlocked (0, &lm);
1440 _have_internal_generator = false;
1442 for (i = _processors.begin(); i != _processors.end(); ++i) {
1443 boost::shared_ptr<PluginInsert> pi;
1444 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1445 if (pi->has_no_inputs ()) {
1446 _have_internal_generator = true;
1456 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1457 _output->set_user_latency (0);
1460 reset_instrument_info ();
1461 old->drop_references ();
1462 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1463 set_processor_positions ();
1468 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1470 ProcessorList deleted;
1472 if (!_session.engine().connected()) {
1476 processor_max_streams.reset();
1479 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1480 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1481 ProcessorState pstate (this);
1483 ProcessorList::iterator i;
1484 boost::shared_ptr<Processor> processor;
1486 for (i = _processors.begin(); i != _processors.end(); ) {
1490 /* these can never be removed */
1492 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1497 /* see if its in the list of processors to delete */
1499 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1504 /* stop IOProcessors that send to JACK ports
1505 from causing noise as a result of no longer being
1509 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1510 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1513 iop = pi->sidechain();
1520 deleted.push_back (processor);
1521 i = _processors.erase (i);
1524 if (deleted.empty()) {
1525 /* none of those in the requested list were found */
1529 _output->set_user_latency (0);
1531 if (configure_processors_unlocked (err, &lm)) {
1533 /* we know this will work, because it worked before :) */
1534 configure_processors_unlocked (0, &lm);
1539 _have_internal_generator = false;
1541 for (i = _processors.begin(); i != _processors.end(); ++i) {
1542 boost::shared_ptr<PluginInsert> pi;
1544 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1545 if (pi->has_no_inputs ()) {
1546 _have_internal_generator = true;
1553 /* now try to do what we need to so that those that were removed will be deleted */
1555 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1556 (*i)->drop_references ();
1559 reset_instrument_info ();
1560 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1561 set_processor_positions ();
1567 Route::reset_instrument_info ()
1569 boost::shared_ptr<Processor> instr = the_instrument();
1571 _instrument_info.set_internal_instrument (instr);
1575 /** Caller must hold process lock */
1577 Route::configure_processors (ProcessorStreams* err)
1579 #ifndef PLATFORM_WINDOWS
1580 assert (!AudioEngine::instance()->process_lock().trylock());
1583 if (!_in_configure_processors) {
1584 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1585 return configure_processors_unlocked (err, &lm);
1592 Route::input_streams () const
1594 return _input->n_ports ();
1597 list<pair<ChanCount, ChanCount> >
1598 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1600 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1602 return try_configure_processors_unlocked (in, err);
1605 list<pair<ChanCount, ChanCount> >
1606 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1608 // Check each processor in order to see if we can configure as requested
1610 list<pair<ChanCount, ChanCount> > configuration;
1613 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1614 DEBUG_TRACE (DEBUG::Processors, "{\n");
1616 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1618 if ((*p)->can_support_io_configuration(in, out)) {
1620 if (boost::dynamic_pointer_cast<Delivery> (*p)
1621 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1623 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1624 /* with strict I/O the panner + output are forced to
1625 * follow the last processor's output.
1627 * Delivery::can_support_io_configuration() will only add ports,
1628 * but not remove excess ports.
1630 * This works because the delivery only requires
1631 * as many outputs as there are inputs.
1632 * Delivery::configure_io() will do the actual removal
1633 * by calling _output->ensure_io()
1635 if (!is_master() && _session.master_out ()) {
1636 /* ..but at least as many as there are master-inputs */
1637 // XXX this may need special-casing for mixbus (master-outputs)
1638 // and should maybe be a preference anyway ?!
1639 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1645 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1646 configuration.push_back(make_pair(in, out));
1649 // restriction for Monitor Section Processors
1650 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1651 /* do not allow to add/remove channels (for now)
1652 * The Monitor follows the master-bus and has no panner (unpan)
1653 * but do allow processors with midi-in to be added (e.g VSTs with control that
1654 * will remain unconnected)
1656 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration not allowed.\n");
1657 return list<pair<ChanCount, ChanCount> > ();
1659 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1660 // internal sends make no sense, only feedback
1661 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1662 return list<pair<ChanCount, ChanCount> > ();
1664 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1665 /* External Sends can be problematic. one can add/remove ports
1666 * there signal leaves the DAW to external monitors anyway, so there's
1667 * no real use for allowing them here anyway.
1669 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1670 return list<pair<ChanCount, ChanCount> > ();
1672 if (boost::dynamic_pointer_cast<Send> (*p)) {
1674 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1675 return list<pair<ChanCount, ChanCount> > ();
1684 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1685 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1686 DEBUG_TRACE (DEBUG::Processors, "}\n");
1687 return list<pair<ChanCount, ChanCount> > ();
1691 DEBUG_TRACE (DEBUG::Processors, "}\n");
1693 return configuration;
1696 /** Set the input/output configuration of each processor in the processors list.
1697 * Caller must hold process lock.
1698 * Return 0 on success, otherwise configuration is impossible.
1701 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1703 #ifndef PLATFORM_WINDOWS
1704 assert (!AudioEngine::instance()->process_lock().trylock());
1707 if (_in_configure_processors) {
1711 /* put invisible processors where they should be */
1712 setup_invisible_processors ();
1714 _in_configure_processors = true;
1716 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1718 if (configuration.empty ()) {
1719 _in_configure_processors = false;
1724 bool seen_mains_out = false;
1725 processor_out_streams = _input->n_ports();
1726 processor_max_streams.reset();
1728 /* processor configure_io() may result in adding ports
1729 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1731 * with jack2 adding ports results in a graph-order callback,
1732 * which calls Session::resort_routes() and eventually
1733 * Route::direct_feeds_according_to_reality()
1734 * which takes a ReaderLock (_processor_lock).
1736 * so we can't hold a WriterLock here until jack2 threading
1739 * NB. we still hold the process lock
1741 * (ardour's own engines do call graph-order from the
1742 * process-thread and hence do not have this issue; besides
1743 * merely adding ports won't trigger a graph-order, only
1744 * making connections does)
1748 // TODO check for a potential ReaderLock after ReaderLock ??
1749 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1751 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1752 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1754 if (!(*p)->configure_io(c->first, c->second)) {
1755 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1756 _in_configure_processors = false;
1761 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1762 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1764 boost::shared_ptr<IOProcessor> iop;
1765 boost::shared_ptr<PluginInsert> pi;
1766 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1767 /* plugins connected via Split or Hide Match may have more channels.
1768 * route/scratch buffers are needed for all of them
1769 * The configuration may only be a subset (both input and output)
1771 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1773 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1774 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1775 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1779 if (boost::dynamic_pointer_cast<Delivery> (*p)
1780 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1781 /* main delivery will increase port count to match input.
1782 * the Delivery::Main is usually the last processor - followed only by
1785 seen_mains_out = true;
1787 if (!seen_mains_out) {
1788 processor_out_streams = out;
1797 _meter->set_max_channels (processor_max_streams);
1800 /* make sure we have sufficient scratch buffers to cope with the new processor
1803 _session.ensure_buffers (n_process_buffers ());
1805 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1807 _in_configure_processors = false;
1811 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1812 * @param state New active state for those processors.
1815 Route::all_visible_processors_active (bool state)
1817 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1819 if (_processors.empty()) {
1823 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1824 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1831 (*i)->deactivate ();
1835 _session.set_dirty ();
1839 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
1841 /* check if re-order requires re-configuration of any processors
1842 * -> compare channel configuration for all processors
1844 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1845 ChanCount c = input_streams ();
1847 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
1849 if (c != (*j)->input_streams()) {
1852 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1855 if ((*i)->input_streams() != c) {
1858 c = (*i)->output_streams();
1870 __attribute__((annotate("realtime")))
1873 Route::apply_processor_order (const ProcessorList& new_order)
1875 /* need to hold processor_lock; either read or write lock
1876 * and the engine process_lock.
1877 * Due to r/w lock ambiguity we can only assert the latter
1879 assert (!AudioEngine::instance()->process_lock().trylock());
1882 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1883 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1884 * processors in the current actual processor list that are hidden. Any visible processors
1885 * in the current list but not in "new_order" will be assumed to be deleted.
1888 /* "as_it_will_be" and "_processors" are lists of shared pointers.
1889 * actual memory usage is small, but insert/erase is not actually rt-safe :(
1890 * (note though that ::processors_reorder_needs_configure() ensured that
1891 * this function will only ever be called from the rt-thread if no processor were removed)
1893 * either way, I can't proove it, but an x-run due to re-order here is less likley
1894 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
1897 ProcessorList as_it_will_be;
1898 ProcessorList::iterator oiter;
1899 ProcessorList::const_iterator niter;
1901 oiter = _processors.begin();
1902 niter = new_order.begin();
1904 while (niter != new_order.end()) {
1906 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1907 then append it to the temp list.
1909 Otherwise, see if the next processor in the old list is in the new list. if not,
1910 its been deleted. If its there, append it to the temp list.
1913 if (oiter == _processors.end()) {
1915 /* no more elements in the old list, so just stick the rest of
1916 the new order onto the temp list.
1919 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1920 while (niter != new_order.end()) {
1927 if (!(*oiter)->display_to_user()) {
1929 as_it_will_be.push_back (*oiter);
1933 /* visible processor: check that its in the new order */
1935 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1936 /* deleted: do nothing, shared_ptr<> will clean up */
1938 /* ignore this one, and add the next item from the new order instead */
1939 as_it_will_be.push_back (*niter);
1944 /* now remove from old order - its taken care of no matter what */
1945 oiter = _processors.erase (oiter);
1949 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1951 /* If the meter is in a custom position, find it and make a rough note of its position */
1952 maybe_note_meter_position ();
1956 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1958 // it a change is already queued, wait for it
1959 // (unless engine is stopped. apply immediately and proceed
1960 while (g_atomic_int_get (&_pending_process_reorder)) {
1961 if (!AudioEngine::instance()->running()) {
1962 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
1963 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1965 apply_processor_order(_pending_processor_order);
1966 setup_invisible_processors ();
1968 g_atomic_int_set (&_pending_process_reorder, 0);
1970 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1971 set_processor_positions ();
1973 // TODO rather use a semaphore or something.
1974 // but since ::reorder_processors() is called
1975 // from the GUI thread, this is fine..
1980 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
1982 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1983 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1984 ProcessorState pstate (this);
1986 apply_processor_order (new_order);
1988 if (configure_processors_unlocked (err, &lm)) {
1996 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1997 set_processor_positions ();
2000 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2001 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2003 // _pending_processor_order is protected by _processor_lock
2004 _pending_processor_order = new_order;
2005 g_atomic_int_set (&_pending_process_reorder, 1);
2012 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2014 boost::shared_ptr<PluginInsert> pi;
2015 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2019 if (pi->has_sidechain () == add) {
2020 return true; // ?? call failed, but result is as expected.
2024 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2025 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2026 if (i == _processors.end ()) {
2032 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2033 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2034 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2036 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2038 if (!pi->add_sidechain ()) {
2042 if (!pi->del_sidechain ()) {
2048 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2053 pi->del_sidechain ();
2055 pi->add_sidechain ();
2056 // TODO restore side-chain's state.
2061 configure_processors_unlocked (0, &lm);
2064 if (pi->has_sidechain ()) {
2065 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2068 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2069 _session.set_dirty ();
2074 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2076 boost::shared_ptr<PluginInsert> pi;
2077 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2082 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2083 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2084 if (i == _processors.end ()) {
2090 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2091 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2093 const ChanCount& old (pi->preset_out ());
2094 if (!pi->set_preset_out (outs)) {
2095 return true; // no change, OK
2098 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2101 pi->set_preset_out (old);
2104 configure_processors_unlocked (0, &lm);
2107 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2108 _session.set_dirty ();
2113 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2116 return customize_plugin_insert (proc, 0, unused, unused);
2120 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2122 boost::shared_ptr<PluginInsert> pi;
2123 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2128 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2129 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2130 if (i == _processors.end ()) {
2136 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2137 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2139 bool old_cust = pi->custom_cfg ();
2140 uint32_t old_cnt = pi->get_count ();
2141 ChanCount old_chan = pi->output_streams ();
2142 ChanCount old_sinks = pi->natural_input_streams ();
2145 pi->set_custom_cfg (false);
2147 pi->set_custom_cfg (true);
2148 pi->set_count (count);
2149 pi->set_outputs (outs);
2150 pi->set_sinks (sinks);
2153 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2157 pi->set_count (old_cnt);
2158 pi->set_sinks (old_sinks);
2159 pi->set_outputs (old_chan);
2160 pi->set_custom_cfg (old_cust);
2164 configure_processors_unlocked (0, &lm);
2167 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2168 _session.set_dirty ();
2173 Route::set_strict_io (const bool enable)
2175 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2177 if (_strict_io != enable) {
2178 _strict_io = enable;
2179 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2180 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2181 boost::shared_ptr<PluginInsert> pi;
2182 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2183 pi->set_strict_io (_strict_io);
2187 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2191 _strict_io = !enable; // restore old value
2192 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2193 boost::shared_ptr<PluginInsert> pi;
2194 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2195 pi->set_strict_io (_strict_io);
2202 configure_processors (0);
2205 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2206 _session.set_dirty ();
2218 Route::get_template()
2220 return state(false);
2224 Route::state(bool full_state)
2227 if (!_session._template_state_dir.empty()) {
2228 assert (!full_state); // only for templates
2229 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2232 XMLNode *node = new XMLNode("Route");
2233 ProcessorList::iterator i;
2236 id().print (buf, sizeof (buf));
2237 node->add_property("id", buf);
2238 node->add_property ("name", _name);
2239 node->add_property("default-type", _default_type.to_string());
2240 node->add_property ("strict-io", _strict_io);
2242 node->add_child_nocopy (_presentation_info.get_state());
2244 node->add_property("active", _active?"yes":"no");
2246 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2247 node->add_property("meter-point", enum_2_string (_meter_point));
2249 node->add_property("meter-type", enum_2_string (_meter_type));
2252 node->add_property("route-group", _route_group->name());
2255 node->add_child_nocopy (_solo_control->get_state ());
2256 node->add_child_nocopy (_solo_isolate_control->get_state ());
2257 node->add_child_nocopy (_solo_safe_control->get_state ());
2259 node->add_child_nocopy (_input->state (full_state));
2260 node->add_child_nocopy (_output->state (full_state));
2261 node->add_child_nocopy (_mute_master->get_state ());
2263 node->add_child_nocopy (_mute_control->get_state ());
2264 node->add_child_nocopy (_phase_control->get_state ());
2267 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2270 if (_comment.length()) {
2271 XMLNode *cmt = node->add_child ("Comment");
2272 cmt->add_content (_comment);
2276 node->add_child_nocopy (_pannable->state (full_state));
2280 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2281 for (i = _processors.begin(); i != _processors.end(); ++i) {
2283 /* template save: do not include internal sends functioning as
2284 aux sends because the chance of the target ID
2285 in the session where this template is used
2288 similarly, do not save listen sends which connect to
2289 the monitor section, because these will always be
2292 boost::shared_ptr<InternalSend> is;
2294 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2295 if (is->role() == Delivery::Listen) {
2300 node->add_child_nocopy((*i)->state (full_state));
2305 node->add_child_copy (*_extra_xml);
2308 if (_custom_meter_position_noted) {
2309 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2311 after->id().print (buf, sizeof (buf));
2312 node->add_property (X_("processor-after-last-custom-meter"), buf);
2316 if (!_session._template_state_dir.empty()) {
2317 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2320 node->add_child_copy (Slavable::get_state());
2326 Route::set_state (const XMLNode& node, int version)
2328 if (version < 3000) {
2329 return set_state_2X (node, version);
2333 XMLNodeConstIterator niter;
2335 XMLProperty const * prop;
2337 if (node.name() != "Route"){
2338 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2342 if ((prop = node.property (X_("name"))) != 0) {
2343 Route::set_name (prop->value());
2347 _initial_io_setup = true;
2349 Stripable::set_state (node, version);
2351 if ((prop = node.property (X_("strict-io"))) != 0) {
2352 _strict_io = string_is_affirmative (prop->value());
2356 _mute_master->set_solo_ignore (true);
2360 /* monitor bus does not get a panner, but if (re)created
2361 via XML, it will already have one by the time we
2362 call ::set_state(). so ... remove it.
2367 /* add all processors (except amp, which is always present) */
2369 nlist = node.children();
2370 XMLNode processor_state (X_("processor_state"));
2372 Stateful::save_extra_xml (node);
2374 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2378 if (child->name() == IO::state_node_name) {
2379 if ((prop = child->property (X_("direction"))) == 0) {
2383 if (prop->value() == "Input") {
2384 _input->set_state (*child, version);
2385 } else if (prop->value() == "Output") {
2386 _output->set_state (*child, version);
2389 } else if (child->name() == X_("Processor")) {
2390 processor_state.add_child_copy (*child);
2391 } else if (child->name() == X_("Pannable")) {
2393 _pannable->set_state (*child, version);
2395 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2397 } else if (child->name() == Controllable::xml_node_name) {
2398 if ((prop = child->property (X_("name"))) == 0) {
2402 if (prop->value() == _gain_control->name()) {
2403 _gain_control->set_state (*child, version);
2404 } else if (prop->value() == _solo_control->name()) {
2405 _solo_control->set_state (*child, version);
2406 } else if (prop->value() == _solo_safe_control->name()) {
2407 _solo_safe_control->set_state (*child, version);
2408 } else if (prop->value() == _solo_isolate_control->name()) {
2409 _solo_isolate_control->set_state (*child, version);
2410 } else if (prop->value() == _solo_control->name()) {
2411 _mute_control->set_state (*child, version);
2413 } else if (child->name() == Slavable::xml_node_name) {
2414 Slavable::set_state (*child, version);
2418 if ((prop = node.property (X_("meter-point"))) != 0) {
2419 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2420 set_meter_point (mp, true);
2422 _meter->set_display_to_user (_meter_point == MeterCustom);
2426 if ((prop = node.property (X_("meter-type"))) != 0) {
2427 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2430 _initial_io_setup = false;
2432 set_processor_state (processor_state);
2434 // this looks up the internal instrument in processors
2435 reset_instrument_info();
2437 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2438 set_denormal_protection (string_is_affirmative (prop->value()));
2441 if ((prop = node.property (X_("active"))) != 0) {
2442 bool yn = string_is_affirmative (prop->value());
2443 set_active (yn, this);
2446 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2447 PBD::ID id (prop->value ());
2448 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2449 ProcessorList::const_iterator i = _processors.begin ();
2450 while (i != _processors.end() && (*i)->id() != id) {
2454 if (i != _processors.end ()) {
2455 _processor_after_last_custom_meter = *i;
2456 _custom_meter_position_noted = true;
2460 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2463 if (child->name() == X_("Comment")) {
2465 /* XXX this is a terrible API design in libxml++ */
2467 XMLNode *cmt = *(child->children().begin());
2468 _comment = cmt->content();
2470 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2471 if (prop->value() == "solo") {
2472 _solo_control->set_state (*child, version);
2473 } else if (prop->value() == "mute") {
2474 _mute_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 (is_master() || is_monitor() || is_auditioner()) {
2511 _mute_master->set_solo_ignore (true);
2514 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2515 set_denormal_protection (string_is_affirmative (prop->value()));
2518 if ((prop = node.property (X_("muted"))) != 0) {
2521 bool muted = string_is_affirmative (prop->value());
2527 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2529 if (string_is_affirmative (prop->value())){
2530 mute_point = mute_point + "PreFader";
2535 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2537 if (string_is_affirmative (prop->value())){
2540 mute_point = mute_point + ",";
2543 mute_point = mute_point + "PostFader";
2548 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2550 if (string_is_affirmative (prop->value())){
2553 mute_point = mute_point + ",";
2556 mute_point = mute_point + "Listen";
2561 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2563 if (string_is_affirmative (prop->value())){
2566 mute_point = mute_point + ",";
2569 mute_point = mute_point + "Main";
2573 _mute_master->set_mute_points (mute_point);
2574 _mute_master->set_muted_by_self (true);
2578 if ((prop = node.property (X_("meter-point"))) != 0) {
2579 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2584 nlist = node.children ();
2585 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2589 if (child->name() == IO::state_node_name) {
2591 /* there is a note in IO::set_state_2X() about why we have to call
2595 _input->set_state_2X (*child, version, true);
2596 _output->set_state_2X (*child, version, false);
2598 if ((prop = child->property (X_("name"))) != 0) {
2599 Route::set_name (prop->value ());
2604 if ((prop = child->property (X_("active"))) != 0) {
2605 bool yn = string_is_affirmative (prop->value());
2606 _active = !yn; // force switch
2607 set_active (yn, this);
2610 if ((prop = child->property (X_("gain"))) != 0) {
2613 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2614 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2618 /* Set up Panners in the IO */
2619 XMLNodeList io_nlist = child->children ();
2621 XMLNodeConstIterator io_niter;
2624 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2626 io_child = *io_niter;
2628 if (io_child->name() == X_("Panner")) {
2629 _main_outs->panner_shell()->set_state(*io_child, version);
2630 } else if (io_child->name() == X_("Automation")) {
2631 /* IO's automation is for the fader */
2632 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2638 XMLNodeList redirect_nodes;
2640 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2644 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2645 redirect_nodes.push_back(child);
2650 set_processor_state_2X (redirect_nodes, version);
2652 Stateful::save_extra_xml (node);
2654 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2657 if (child->name() == X_("Comment")) {
2659 /* XXX this is a terrible API design in libxml++ */
2661 XMLNode *cmt = *(child->children().begin());
2662 _comment = cmt->content();
2664 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2665 if (prop->value() == X_("solo")) {
2666 _solo_control->set_state (*child, version);
2667 } else if (prop->value() == X_("mute")) {
2668 _mute_control->set_state (*child, version);
2678 Route::get_processor_state ()
2680 XMLNode* root = new XMLNode (X_("redirects"));
2681 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2682 root->add_child_nocopy ((*i)->state (true));
2689 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2691 /* We don't bother removing existing processors not in nList, as this
2692 method will only be called when creating a Route from scratch, not
2693 for undo purposes. Just put processors in at the appropriate place
2697 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2698 add_processor_from_xml_2X (**i, version);
2703 Route::set_processor_state (const XMLNode& node)
2705 const XMLNodeList &nlist = node.children();
2706 XMLNodeConstIterator niter;
2707 ProcessorList new_order;
2708 bool must_configure = false;
2710 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2712 XMLProperty* prop = (*niter)->property ("type");
2714 if (prop->value() == "amp") {
2715 _amp->set_state (**niter, Stateful::current_state_version);
2716 new_order.push_back (_amp);
2717 } else if (prop->value() == "trim") {
2718 _trim->set_state (**niter, Stateful::current_state_version);
2719 new_order.push_back (_trim);
2720 } else if (prop->value() == "meter") {
2721 _meter->set_state (**niter, Stateful::current_state_version);
2722 new_order.push_back (_meter);
2723 } else if (prop->value() == "delay") {
2725 _delayline->set_state (**niter, Stateful::current_state_version);
2726 new_order.push_back (_delayline);
2728 } else if (prop->value() == "main-outs") {
2729 _main_outs->set_state (**niter, Stateful::current_state_version);
2730 } else if (prop->value() == "intreturn") {
2732 _intreturn.reset (new InternalReturn (_session));
2733 must_configure = true;
2735 _intreturn->set_state (**niter, Stateful::current_state_version);
2736 } else if (is_monitor() && prop->value() == "monitor") {
2737 if (!_monitor_control) {
2738 _monitor_control.reset (new MonitorProcessor (_session));
2739 must_configure = true;
2741 _monitor_control->set_state (**niter, Stateful::current_state_version);
2742 } else if (prop->value() == "capture") {
2743 /* CapturingProcessor should never be restored, it's always
2744 added explicitly when needed */
2746 ProcessorList::iterator o;
2748 for (o = _processors.begin(); o != _processors.end(); ++o) {
2749 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2750 if (id_prop && (*o)->id() == id_prop->value()) {
2751 (*o)->set_state (**niter, Stateful::current_state_version);
2752 new_order.push_back (*o);
2757 // If the processor (*niter) is not on the route then create it
2759 if (o == _processors.end()) {
2761 boost::shared_ptr<Processor> processor;
2763 if (prop->value() == "intsend") {
2765 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2767 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2768 prop->value() == "lv2" ||
2769 prop->value() == "windows-vst" ||
2770 prop->value() == "lxvst" ||
2771 prop->value() == "luaproc" ||
2772 prop->value() == "audiounit") {
2774 if (_session.get_disable_all_loaded_plugins ()) {
2775 processor.reset (new UnknownProcessor (_session, **niter));
2777 processor.reset (new PluginInsert (_session));
2778 processor->set_owner (this);
2780 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2781 pi->set_strict_io (true);
2785 } else if (prop->value() == "port") {
2787 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2789 } else if (prop->value() == "send") {
2791 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2792 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2793 send->SelfDestruct.connect_same_thread (*this,
2794 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2797 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2801 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2802 /* This processor could not be configured. Turn it into a UnknownProcessor */
2803 processor.reset (new UnknownProcessor (_session, **niter));
2806 /* subscribe to Sidechain IO changes */
2807 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2808 if (pi && pi->has_sidechain ()) {
2809 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2812 /* we have to note the monitor send here, otherwise a new one will be created
2813 and the state of this one will be lost.
2815 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2816 if (isend && isend->role() == Delivery::Listen) {
2817 _monitor_send = isend;
2820 /* it doesn't matter if invisible processors are added here, as they
2821 will be sorted out by setup_invisible_processors () shortly.
2824 new_order.push_back (processor);
2825 must_configure = true;
2831 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2832 /* re-assign _processors w/o process-lock.
2833 * if there's an IO-processor present in _processors but
2834 * not in new_order, it will be deleted and ~IO takes
2837 _processors = new_order;
2838 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2840 if (must_configure) {
2841 configure_processors_unlocked (0, &lm);
2844 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2846 (*i)->set_owner (this);
2847 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2849 boost::shared_ptr<PluginInsert> pi;
2851 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2852 if (pi->has_no_inputs ()) {
2853 _have_internal_generator = true;
2860 reset_instrument_info ();
2861 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2862 set_processor_positions ();
2866 Route::curve_reallocate ()
2868 // _gain_automation_curve.finish_resize ();
2869 // _pan_automation_curve.finish_resize ();
2873 Route::silence (framecnt_t nframes)
2875 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2880 silence_unlocked (nframes);
2884 Route::silence_unlocked (framecnt_t nframes)
2886 /* Must be called with the processor lock held */
2890 _output->silence (nframes);
2892 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2893 boost::shared_ptr<PluginInsert> pi;
2895 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2896 // skip plugins, they don't need anything when we're not active
2900 (*i)->silence (nframes);
2903 if (nframes == _session.get_block_size()) {
2910 Route::add_internal_return ()
2913 _intreturn.reset (new InternalReturn (_session));
2914 add_processor (_intreturn, PreFader);
2919 Route::add_send_to_internal_return (InternalSend* send)
2921 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2923 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2924 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2927 return d->add_send (send);
2933 Route::remove_send_from_internal_return (InternalSend* send)
2935 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2937 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2938 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2941 return d->remove_send (send);
2947 Route::enable_monitor_send ()
2949 /* Caller must hold process lock */
2950 assert (!AudioEngine::instance()->process_lock().trylock());
2952 /* master never sends to monitor section via the normal mechanism */
2953 assert (!is_master ());
2954 assert (!is_monitor ());
2956 /* make sure we have one */
2957 if (!_monitor_send) {
2958 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
2959 _monitor_send->set_display_to_user (false);
2963 configure_processors (0);
2966 /** Add an aux send to a route.
2967 * @param route route to send to.
2968 * @param before Processor to insert before, or 0 to insert at the end.
2971 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2973 assert (route != _session.monitor_out ());
2976 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2978 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2980 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2982 if (d && d->target_route() == route) {
2983 /* already listening via the specified IO: do nothing */
2991 boost::shared_ptr<InternalSend> listener;
2994 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2995 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2996 listener.reset (new InternalSend (_session, sendpan, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
2999 add_processor (listener, before);
3001 } catch (failed_constructor& err) {
3009 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3011 ProcessorStreams err;
3012 ProcessorList::iterator tmp;
3015 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3017 /* have to do this early because otherwise processor reconfig
3018 * will put _monitor_send back in the list
3021 if (route == _session.monitor_out()) {
3022 _monitor_send.reset ();
3026 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3028 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3030 if (d && d->target_route() == route) {
3032 if (remove_processor (*x, &err, false) > 0) {
3038 /* list could have been demolished while we dropped the lock
3041 if (_session.engine().connected()) {
3042 /* i/o processors cannot be removed if the engine is not running
3043 * so don't live-loop in case the engine is N/A or dies
3053 Route::set_comment (string cmt, void *src)
3057 _session.set_dirty ();
3061 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3063 FeedRecord fr (other, via_sends_only);
3065 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3067 if (!result.second) {
3069 /* already a record for "other" - make sure sends-only information is correct */
3070 if (!via_sends_only && result.first->sends_only) {
3071 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3072 frp->sends_only = false;
3076 return result.second;
3080 Route::clear_fed_by ()
3086 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3088 const FedBy& fed_by (other->fed_by());
3090 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3091 boost::shared_ptr<Route> sr = f->r.lock();
3093 if (sr && (sr.get() == this)) {
3095 if (via_sends_only) {
3096 *via_sends_only = f->sends_only;
3107 Route::all_inputs () const
3109 /* TODO, if this works as expected,
3110 * cache the IOVector and maintain it via
3111 * input_change_handler(), sidechain_change_handler() etc
3114 ios.push_back (_input);
3116 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3117 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3119 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3120 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3123 iop = pi->sidechain();
3126 if (iop != 0 && iop->input()) {
3127 ios.push_back (iop->input());
3134 Route::all_outputs () const
3137 // _output is included via Delivery
3138 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3139 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3140 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3141 if (iop != 0 && iop->output()) {
3142 ios.push_back (iop->output());
3149 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3151 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3152 if (other->all_inputs().fed_by (_output)) {
3153 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3154 if (via_send_only) {
3155 *via_send_only = false;
3161 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3163 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3165 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3166 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3169 iop = pi->sidechain();
3173 boost::shared_ptr<const IO> iop_out = iop->output();
3174 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3175 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3176 if (via_send_only) {
3177 *via_send_only = true;
3181 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3184 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3189 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3194 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3196 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3200 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3202 return _session._current_route_graph.feeds (shared_from_this (), other);
3205 /** Called from the (non-realtime) butler thread when the transport is stopped */
3207 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3209 framepos_t now = _session.transport_frame();
3212 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3214 Automatable::transport_stopped (now);
3216 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3218 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3222 (*i)->transport_stopped (now);
3226 _roll_delay = _initial_delay;
3230 Route::input_change_handler (IOChange change, void * /*src*/)
3232 if ((change.type & IOChange::ConfigurationChanged)) {
3233 /* This is called with the process lock held if change
3234 contains ConfigurationChanged
3236 configure_processors (0);
3237 _phase_control->resize (_input->n_ports().n_audio ());
3238 io_changed (); /* EMIT SIGNAL */
3241 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3244 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3245 if (_input->connected()) {
3246 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3247 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3251 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3252 if (does_feed && !sends_only) {
3253 if ((*i)->soloed()) {
3256 if ((*i)->solo_isolate_control()->solo_isolated()) {
3263 int delta = sbou - _solo_control->soloed_by_others_upstream();
3264 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3267 PBD::warning << string_compose (
3268 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3269 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3274 if (_solo_control->soloed_by_others_upstream()) {
3275 // ignore new connections (they're not propagated)
3277 _solo_control->mod_solo_by_others_upstream (delta);
3281 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3282 // solo-isolate currently only propagates downstream
3284 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3286 //_solo_isolated_by_upstream = ibou;
3289 // Session::route_solo_changed does not propagate indirect solo-changes
3290 // propagate downstream to tracks
3291 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3292 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3296 bool does_feed = feeds (*i, &sends_only);
3297 if (delta <= 0 && does_feed && !sends_only) {
3298 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3301 if (idelta < 0 && does_feed && !sends_only) {
3302 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3309 Route::output_change_handler (IOChange change, void * /*src*/)
3311 if (_initial_io_setup) {
3315 if ((change.type & IOChange::ConfigurationChanged)) {
3316 /* This is called with the process lock held if change
3317 contains ConfigurationChanged
3319 configure_processors (0);
3322 _session.reset_monitor_section();
3325 io_changed (); /* EMIT SIGNAL */
3328 if (_solo_control->soloed_by_others_downstream()) {
3330 /* checking all all downstream routes for
3331 * explicit of implict solo is a rather drastic measure,
3332 * ideally the input_change_handler() of the other route
3333 * would propagate the change to us.
3335 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3336 if (_output->connected()) {
3337 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3338 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3342 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3343 if (does_feed && !sends_only) {
3344 if ((*i)->soloed()) {
3351 int delta = sbod - _solo_control->soloed_by_others_downstream();
3353 // do not allow new connections to change implicit solo (no propagation)
3354 _solo_control->mod_solo_by_others_downstream (delta);
3355 // Session::route_solo_changed() does not propagate indirect solo-changes
3356 // propagate upstream to tracks
3357 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3358 if ((*i).get() == this || !can_solo()) {
3362 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3363 if (delta != 0 && does_feed && !sends_only) {
3364 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3373 Route::sidechain_change_handler (IOChange change, void* src)
3375 if (_initial_io_setup || _in_sidechain_setup) {
3379 input_change_handler (change, src);
3383 Route::pans_required () const
3385 if (n_outputs().n_audio() < 2) {
3389 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3393 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3395 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3401 if (n_outputs().n_total() == 0) {
3405 if (!_active || n_inputs() == ChanCount::ZERO) {
3406 silence_unlocked (nframes);
3410 if (session_state_changing) {
3411 if (_session.transport_speed() != 0.0f) {
3412 /* we're rolling but some state is changing (e.g. our diskstream contents)
3413 so we cannot use them. Be silent till this is over.
3415 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3417 silence_unlocked (nframes);
3420 /* we're really not rolling, so we're either delivery silence or actually
3421 monitoring, both of which are safe to do while session_state_changing is true.
3425 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3427 fill_buffers_with_input (bufs, _input, nframes);
3429 if (_meter_point == MeterInput) {
3430 _meter->run (bufs, start_frame, end_frame, nframes, true);
3433 _amp->apply_gain_automation (false);
3434 _trim->apply_gain_automation (false);
3435 passthru (bufs, start_frame, end_frame, nframes, 0);
3441 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3443 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3448 if (n_outputs().n_total() == 0) {
3452 if (!_active || n_inputs().n_total() == 0) {
3453 silence_unlocked (nframes);
3457 framepos_t unused = 0;
3459 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3465 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3467 fill_buffers_with_input (bufs, _input, nframes);
3469 if (_meter_point == MeterInput) {
3470 _meter->run (bufs, start_frame, end_frame, nframes, true);
3473 passthru (bufs, start_frame, end_frame, nframes, declick);
3479 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3486 Route::flush_processors ()
3488 /* XXX shouldn't really try to take this lock, since
3489 this is called from the RT audio thread.
3492 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3494 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3500 __attribute__((annotate("realtime")))
3503 Route::apply_processor_changes_rt ()
3505 int emissions = EmitNone;
3507 if (_pending_meter_point != _meter_point) {
3508 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3510 /* meters always have buffers for 'processor_max_streams'
3511 * they can be re-positioned without re-allocation */
3512 if (set_meter_point_unlocked()) {
3513 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3515 emissions |= EmitMeterChanged;
3520 bool changed = false;
3522 if (g_atomic_int_get (&_pending_process_reorder)) {
3523 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3525 apply_processor_order (_pending_processor_order);
3526 setup_invisible_processors ();
3528 g_atomic_int_set (&_pending_process_reorder, 0);
3529 emissions |= EmitRtProcessorChange;
3533 set_processor_positions ();
3535 if (emissions != 0) {
3536 g_atomic_int_set (&_pending_signals, emissions);
3539 return (!selfdestruct_sequence.empty ());
3543 Route::emit_pending_signals ()
3545 int sig = g_atomic_int_and (&_pending_signals, 0);
3546 if (sig & EmitMeterChanged) {
3547 _meter->emit_configuration_changed();
3548 meter_change (); /* EMIT SIGNAL */
3549 if (sig & EmitMeterVisibilityChange) {
3550 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3552 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3555 if (sig & EmitRtProcessorChange) {
3556 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3559 /* this would be a job for the butler.
3560 * Conceptually we should not take processe/processor locks here.
3561 * OTOH its more efficient (less overhead for summoning the butler and
3562 * telling her what do do) and signal emission is called
3563 * directly after the process callback, which decreases the chance
3564 * of x-runs when taking the locks.
3566 while (!selfdestruct_sequence.empty ()) {
3567 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3568 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3569 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3570 selfdestruct_sequence.pop_back ();
3573 remove_processor (proc);
3579 Route::set_meter_point (MeterPoint p, bool force)
3581 if (_pending_meter_point == p && !force) {
3585 if (force || !AudioEngine::instance()->running()) {
3586 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3587 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3588 _pending_meter_point = p;
3589 _meter->emit_configuration_changed();
3590 meter_change (); /* EMIT SIGNAL */
3591 if (set_meter_point_unlocked()) {
3592 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3594 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3597 _pending_meter_point = p;
3603 __attribute__((annotate("realtime")))
3606 Route::set_meter_point_unlocked ()
3609 /* Caller must hold process and processor write lock */
3610 assert (!AudioEngine::instance()->process_lock().trylock());
3611 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3612 assert (!lm.locked ());
3615 _meter_point = _pending_meter_point;
3617 bool meter_was_visible_to_user = _meter->display_to_user ();
3619 if (!_custom_meter_position_noted) {
3620 maybe_note_meter_position ();
3623 if (_meter_point != MeterCustom) {
3625 _meter->set_display_to_user (false);
3627 setup_invisible_processors ();
3630 _meter->set_display_to_user (true);
3632 /* If we have a previous position for the custom meter, try to put it there */
3633 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3635 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3636 if (i != _processors.end ()) {
3637 _processors.remove (_meter);
3638 _processors.insert (i, _meter);
3640 } else {// at end, right before the mains_out/panner
3641 _processors.remove (_meter);
3642 ProcessorList::iterator main = _processors.end();
3643 _processors.insert (--main, _meter);
3647 /* Set up the meter for its new position */
3649 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3653 if (loc == _processors.begin()) {
3654 m_in = _input->n_ports();
3656 ProcessorList::iterator before = loc;
3658 m_in = (*before)->output_streams ();
3661 _meter->reflect_inputs (m_in);
3663 /* we do not need to reconfigure the processors, because the meter
3664 (a) is always ready to handle processor_max_streams
3665 (b) is always an N-in/N-out processor, and thus moving
3666 it doesn't require any changes to the other processors.
3669 /* these should really be done after releasing the lock
3670 * but all those signals are subscribed to with gui_thread()
3673 return (_meter->display_to_user() != meter_was_visible_to_user);
3677 Route::listen_position_changed ()
3680 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3681 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3682 ProcessorState pstate (this);
3684 if (configure_processors_unlocked (0, &lm)) {
3685 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3687 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3692 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3693 _session.set_dirty ();
3696 boost::shared_ptr<CapturingProcessor>
3697 Route::add_export_point()
3699 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3700 if (!_capturing_processor) {
3702 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3703 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3705 _capturing_processor.reset (new CapturingProcessor (_session));
3706 _capturing_processor->activate ();
3708 configure_processors_unlocked (0, &lw);
3712 return _capturing_processor;
3716 Route::update_signal_latency ()
3718 framecnt_t l = _output->user_latency();
3719 framecnt_t lamp = 0;
3720 bool before_amp = true;
3721 framecnt_t ltrim = 0;
3722 bool before_trim = true;
3724 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3725 if ((*i)->active ()) {
3726 l += (*i)->signal_latency ();
3731 if ((*i) == _trim) {
3742 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3744 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3745 _signal_latency_at_amp_position = lamp;
3746 _signal_latency_at_trim_position = ltrim;
3748 if (_signal_latency != l) {
3749 _signal_latency = l;
3750 signal_latency_changed (); /* EMIT SIGNAL */
3753 return _signal_latency;
3757 Route::set_user_latency (framecnt_t nframes)
3759 _output->set_user_latency (nframes);
3760 _session.update_latency_compensation ();
3764 Route::set_latency_compensation (framecnt_t longest_session_latency)
3766 framecnt_t old = _initial_delay;
3768 if (_signal_latency < longest_session_latency) {
3769 _initial_delay = longest_session_latency - _signal_latency;
3774 DEBUG_TRACE (DEBUG::Latency, string_compose (
3775 "%1: compensate for maximum latency of %2,"
3776 "given own latency of %3, using initial delay of %4\n",
3777 name(), longest_session_latency, _signal_latency, _initial_delay));
3779 if (_initial_delay != old) {
3780 initial_delay_changed (); /* EMIT SIGNAL */
3783 if (_session.transport_stopped()) {
3784 _roll_delay = _initial_delay;
3789 Route::set_block_size (pframes_t nframes)
3791 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3792 (*i)->set_block_size (nframes);
3795 _session.ensure_buffers (n_process_buffers ());
3799 Route::protect_automation ()
3801 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3802 (*i)->protect_automation();
3805 /** @param declick 1 to set a pending declick fade-in,
3806 * -1 to set a pending declick fade-out
3809 Route::set_pending_declick (int declick)
3812 /* this call is not allowed to turn off a pending declick */
3814 _pending_declick = declick;
3817 _pending_declick = 0;
3821 /** Shift automation forwards from a particular place, thereby inserting time.
3822 * Adds undo commands for any shifts that are performed.
3824 * @param pos Position to start shifting from.
3825 * @param frames Amount to shift forwards by.
3829 Route::shift (framepos_t pos, framecnt_t frames)
3831 /* gain automation */
3833 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3835 XMLNode &before = gc->alist()->get_state ();
3836 gc->alist()->shift (pos, frames);
3837 XMLNode &after = gc->alist()->get_state ();
3838 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3841 /* gain automation */
3843 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3845 XMLNode &before = gc->alist()->get_state ();
3846 gc->alist()->shift (pos, frames);
3847 XMLNode &after = gc->alist()->get_state ();
3848 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3851 // TODO mute automation ??
3853 /* pan automation */
3855 ControlSet::Controls& c (_pannable->controls());
3857 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3858 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3860 boost::shared_ptr<AutomationList> al = pc->alist();
3861 XMLNode& before = al->get_state ();
3862 al->shift (pos, frames);
3863 XMLNode& after = al->get_state ();
3864 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3869 /* redirect automation */
3871 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3872 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3874 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3876 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3877 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3879 boost::shared_ptr<AutomationList> al = ac->alist();
3880 XMLNode &before = al->get_state ();
3881 al->shift (pos, frames);
3882 XMLNode &after = al->get_state ();
3883 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3891 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
3893 boost::shared_ptr<Processor> processor (p.lock ());
3894 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3898 pi->set_state_dir (d);
3902 Route::save_as_template (const string& path, const string& name)
3904 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
3905 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
3907 XMLNode& node (state (false));
3911 IO::set_name_in_state (*node.children().front(), name);
3913 tree.set_root (&node);
3915 /* return zero on success, non-zero otherwise */
3916 return !tree.write (path.c_str());
3921 Route::set_name (const string& str)
3923 if (str == name()) {
3927 string name = Route::ensure_track_or_route_name (str, _session);
3928 SessionObject::set_name (name);
3930 bool ret = (_input->set_name(name) && _output->set_name(name));
3933 /* rename the main outs. Leave other IO processors
3934 * with whatever name they already have, because its
3935 * just fine as it is (it will not contain the route
3936 * name if its a port insert, port send or port return).
3940 if (_main_outs->set_name (name)) {
3941 /* XXX returning false here is stupid because
3942 we already changed the route name.
3952 /** Set the name of a route in an XML description.
3953 * @param node XML <Route> node to set the name in.
3954 * @param name New name.
3957 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
3959 node.add_property (X_("name"), name);
3961 XMLNodeList children = node.children();
3962 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3964 if ((*i)->name() == X_("IO")) {
3966 IO::set_name_in_state (**i, name);
3968 } else if ((*i)->name() == X_("Processor")) {
3970 XMLProperty const * role = (*i)->property (X_("role"));
3971 if (role && role->value() == X_("Main")) {
3972 (*i)->add_property (X_("name"), name);
3975 } else if ((*i)->name() == X_("Diskstream")) {
3977 if (rename_playlist) {
3978 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3980 (*i)->add_property (X_("name"), name);
3986 boost::shared_ptr<Send>
3987 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3989 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3991 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3992 boost::shared_ptr<InternalSend> send;
3994 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3995 if (send->target_route() == target) {
4001 return boost::shared_ptr<Send>();
4005 Route::set_denormal_protection (bool yn)
4007 if (_denormal_protection != yn) {
4008 _denormal_protection = yn;
4009 denormal_protection_changed (); /* EMIT SIGNAL */
4014 Route::denormal_protection () const
4016 return _denormal_protection;
4020 Route::set_active (bool yn, void* src)
4022 if (_session.transport_rolling()) {
4026 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4027 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4031 if (_active != yn) {
4033 _input->set_active (yn);
4034 _output->set_active (yn);
4035 active_changed (); // EMIT SIGNAL
4036 _session.set_dirty ();
4040 boost::shared_ptr<Pannable>
4041 Route::pannable() const
4046 boost::shared_ptr<Panner>
4047 Route::panner() const
4050 return _main_outs->panner_shell()->panner();
4053 boost::shared_ptr<PannerShell>
4054 Route::panner_shell() const
4056 return _main_outs->panner_shell();
4059 boost::shared_ptr<GainControl>
4060 Route::gain_control() const
4062 return _gain_control;
4065 boost::shared_ptr<GainControl>
4066 Route::trim_control() const
4068 return _trim_control;
4071 boost::shared_ptr<PhaseControl>
4072 Route::phase_control() const
4074 return _phase_control;
4077 boost::shared_ptr<AutomationControl>
4078 Route::get_control (const Evoral::Parameter& param)
4080 /* either we own the control or .... */
4082 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4086 /* maybe one of our processors does or ... */
4088 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4089 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4090 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4098 /* nobody does so we'll make a new one */
4100 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4107 boost::shared_ptr<Processor>
4108 Route::nth_plugin (uint32_t n) const
4110 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4111 ProcessorList::const_iterator i;
4113 for (i = _processors.begin(); i != _processors.end(); ++i) {
4114 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4121 return boost::shared_ptr<Processor> ();
4124 boost::shared_ptr<Processor>
4125 Route::nth_send (uint32_t n) const
4127 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4128 ProcessorList::const_iterator i;
4130 for (i = _processors.begin(); i != _processors.end(); ++i) {
4131 if (boost::dynamic_pointer_cast<Send> (*i)) {
4133 if ((*i)->name().find (_("Monitor")) == 0) {
4134 /* send to monitor section is not considered
4135 to be an accessible send.
4146 return boost::shared_ptr<Processor> ();
4150 Route::has_io_processor_named (const string& name)
4152 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4153 ProcessorList::iterator i;
4155 for (i = _processors.begin(); i != _processors.end(); ++i) {
4156 if (boost::dynamic_pointer_cast<Send> (*i) ||
4157 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4158 if ((*i)->name() == name) {
4168 Route::set_processor_positions ()
4170 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4172 bool had_amp = false;
4173 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4174 (*i)->set_pre_fader (!had_amp);
4181 /** Called when there is a proposed change to the input port count */
4183 Route::input_port_count_changing (ChanCount to)
4185 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4187 /* The processors cannot be configured with the new input arrangement, so
4193 /* The change is ok */
4197 /** Called when there is a proposed change to the output port count */
4199 Route::output_port_count_changing (ChanCount to)
4201 if (_strict_io && !_in_configure_processors) {
4204 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4205 if (processor_out_streams.get(*t) > to.get(*t)) {
4209 /* The change is ok */
4214 Route::unknown_processors () const
4218 if (_session.get_disable_all_loaded_plugins ()) {
4219 // Do not list "missing plugins" if they are explicitly disabled
4223 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4224 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4225 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4226 p.push_back ((*i)->name ());
4235 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4237 /* we assume that all our input ports feed all our output ports. its not
4238 universally true, but the alternative is way too corner-case to worry about.
4241 LatencyRange all_connections;
4244 all_connections.min = 0;
4245 all_connections.max = 0;
4247 all_connections.min = ~((pframes_t) 0);
4248 all_connections.max = 0;
4250 /* iterate over all "from" ports and determine the latency range for all of their
4251 connections to the "outside" (outside of this Route).
4254 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4258 p->get_connected_latency_range (range, playback);
4260 all_connections.min = min (all_connections.min, range.min);
4261 all_connections.max = max (all_connections.max, range.max);
4265 /* set the "from" port latencies to the max/min range of all their connections */
4267 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4268 p->set_private_latency_range (all_connections, playback);
4271 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4273 all_connections.min += our_latency;
4274 all_connections.max += our_latency;
4276 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4277 p->set_private_latency_range (all_connections, playback);
4280 return all_connections.max;
4284 Route::set_private_port_latencies (bool playback) const
4286 framecnt_t own_latency = 0;
4288 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4289 OR LATENCY CALLBACK.
4291 This is called (early) from the latency callback. It computes the REAL
4292 latency associated with each port and stores the result as the "private"
4293 latency of the port. A later call to Route::set_public_port_latencies()
4294 sets all ports to the same value to reflect the fact that we do latency
4295 compensation and so all signals are delayed by the same amount as they
4296 flow through ardour.
4299 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4300 if ((*i)->active ()) {
4301 own_latency += (*i)->signal_latency ();
4306 /* playback: propagate latency from "outside the route" to outputs to inputs */
4307 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4309 /* capture: propagate latency from "outside the route" to inputs to outputs */
4310 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4315 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4317 /* this is called to set the JACK-visible port latencies, which take
4318 latency compensation into account.
4327 const PortSet& ports (_input->ports());
4328 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4329 p->set_public_latency_range (range, playback);
4334 const PortSet& ports (_output->ports());
4335 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4336 p->set_public_latency_range (range, playback);
4341 /** Put the invisible processors in the right place in _processors.
4342 * Must be called with a writer lock on _processor_lock held.
4345 __attribute__((annotate("realtime")))
4348 Route::setup_invisible_processors ()
4351 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4352 assert (!lm.locked ());
4356 /* too early to be doing this stuff */
4360 /* we'll build this new list here and then use it
4362 * TODO put the ProcessorList is on the stack for RT-safety.
4365 ProcessorList new_processors;
4367 /* find visible processors */
4369 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4370 if ((*i)->display_to_user ()) {
4371 new_processors.push_back (*i);
4377 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4379 if (amp == new_processors.end ()) {
4380 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4381 new_processors.push_front (_amp);
4382 amp = find (new_processors.begin(), new_processors.end(), _amp);
4385 /* and the processor after the amp */
4387 ProcessorList::iterator after_amp = amp;
4393 switch (_meter_point) {
4395 assert (!_meter->display_to_user ());
4396 new_processors.push_front (_meter);
4399 assert (!_meter->display_to_user ());
4400 new_processors.insert (amp, _meter);
4402 case MeterPostFader:
4403 /* do nothing here */
4406 /* do nothing here */
4409 /* the meter is visible, so we don't touch it here */
4416 assert (_main_outs);
4417 assert (!_main_outs->display_to_user ());
4418 new_processors.push_back (_main_outs);
4420 /* iterator for the main outs */
4422 ProcessorList::iterator main = new_processors.end();
4425 /* OUTPUT METERING */
4427 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4428 assert (!_meter->display_to_user ());
4430 /* add the processor just before or just after the main outs */
4432 ProcessorList::iterator meter_point = main;
4434 if (_meter_point == MeterOutput) {
4437 new_processors.insert (meter_point, _meter);
4442 if (_monitor_send && !is_monitor ()) {
4443 assert (!_monitor_send->display_to_user ());
4444 switch (Config->get_listen_position ()) {
4445 case PreFaderListen:
4446 switch (Config->get_pfl_position ()) {
4447 case PFLFromBeforeProcessors:
4448 new_processors.push_front (_monitor_send);
4450 case PFLFromAfterProcessors:
4451 new_processors.insert (amp, _monitor_send);
4454 _monitor_send->set_can_pan (false);
4456 case AfterFaderListen:
4457 switch (Config->get_afl_position ()) {
4458 case AFLFromBeforeProcessors:
4459 new_processors.insert (after_amp, _monitor_send);
4461 case AFLFromAfterProcessors:
4462 new_processors.insert (new_processors.end(), _monitor_send);
4465 _monitor_send->set_can_pan (true);
4470 #if 0 // not used - just yet
4471 if (!is_master() && !is_monitor() && !is_auditioner()) {
4472 new_processors.push_front (_delayline);
4476 /* MONITOR CONTROL */
4478 if (_monitor_control && is_monitor ()) {
4479 assert (!_monitor_control->display_to_user ());
4480 new_processors.insert (amp, _monitor_control);
4483 /* INTERNAL RETURN */
4485 /* doing this here means that any monitor control will come just after
4490 assert (!_intreturn->display_to_user ());
4491 new_processors.push_front (_intreturn);
4494 if (_trim && _trim->active()) {
4495 assert (!_trim->display_to_user ());
4496 new_processors.push_front (_trim);
4498 /* EXPORT PROCESSOR */
4500 if (_capturing_processor) {
4501 assert (!_capturing_processor->display_to_user ());
4502 new_processors.push_front (_capturing_processor);
4505 _processors = new_processors;
4507 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4508 if (!(*i)->display_to_user () && !(*i)->active () && (*i) != _monitor_send) {
4513 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4514 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4515 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4522 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4523 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4527 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4528 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4535 /** If the meter point is `Custom', make a note of where the meter is.
4536 * This is so that if the meter point is subsequently set to something else,
4537 * and then back to custom, we can put the meter back where it was last time
4538 * custom was enabled.
4540 * Must be called with the _processor_lock held.
4543 Route::maybe_note_meter_position ()
4545 if (_meter_point != MeterCustom) {
4549 _custom_meter_position_noted = true;
4550 /* custom meter points range from after trim to before panner/main_outs
4551 * this is a limitation by the current processor UI
4553 bool seen_trim = false;
4554 _processor_after_last_custom_meter.reset();
4555 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4556 if ((*i) == _trim) {
4559 if ((*i) == _main_outs) {
4560 _processor_after_last_custom_meter = *i;
4563 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4565 _processor_after_last_custom_meter = _trim;
4567 ProcessorList::iterator j = i;
4569 assert(j != _processors.end ()); // main_outs should be before
4570 _processor_after_last_custom_meter = *j;
4575 assert(_processor_after_last_custom_meter.lock());
4578 boost::shared_ptr<Processor>
4579 Route::processor_by_id (PBD::ID id) const
4581 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4582 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4583 if ((*i)->id() == id) {
4588 return boost::shared_ptr<Processor> ();
4591 /** @return the monitoring state, or in other words what data we are pushing
4592 * into the route (data from the inputs, data from disk or silence)
4595 Route::monitoring_state () const
4597 return MonitoringInput;
4600 /** @return what we should be metering; either the data coming from the input
4601 * IO or the data that is flowing through the route.
4604 Route::metering_state () const
4606 return MeteringRoute;
4610 Route::has_external_redirects () const
4612 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4614 /* ignore inactive processors and obviously ignore the main
4615 * outs since everything has them and we don't care.
4618 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4626 boost::shared_ptr<Processor>
4627 Route::the_instrument () const
4629 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4630 return the_instrument_unlocked ();
4633 boost::shared_ptr<Processor>
4634 Route::the_instrument_unlocked () const
4636 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4637 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4638 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4642 return boost::shared_ptr<Processor>();
4648 Route::non_realtime_locate (framepos_t pos)
4651 _pannable->transport_located (pos);
4654 if (_delayline.get()) {
4655 _delayline.get()->flush();
4659 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4660 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4662 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4663 (*i)->transport_located (pos);
4666 _roll_delay = _initial_delay;
4670 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4677 * We don't currently mix MIDI input together, so we don't need the
4678 * complex logic of the audio case.
4681 n_buffers = bufs.count().n_midi ();
4683 for (i = 0; i < n_buffers; ++i) {
4685 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4686 MidiBuffer& buf (bufs.get_midi (i));
4689 buf.copy (source_port->get_midi_buffer(nframes));
4691 buf.silence (nframes);
4697 n_buffers = bufs.count().n_audio();
4699 size_t n_ports = io->n_ports().n_audio();
4700 float scaling = 1.0f;
4702 if (n_ports > n_buffers) {
4703 scaling = ((float) n_buffers) / n_ports;
4706 for (i = 0; i < n_ports; ++i) {
4708 /* if there are more ports than buffers, map them onto buffers
4709 * in a round-robin fashion
4712 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4713 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4716 if (i < n_buffers) {
4718 /* first time through just copy a channel into
4722 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4724 if (scaling != 1.0f) {
4725 buf.apply_gain (scaling, nframes);
4730 /* on subsequent times around, merge data from
4731 * the port with what is already there
4734 if (scaling != 1.0f) {
4735 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4737 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4742 /* silence any remaining buffers */
4744 for (; i < n_buffers; ++i) {
4745 AudioBuffer& buf (bufs.get_audio (i));
4746 buf.silence (nframes);
4749 /* establish the initial setup of the buffer set, reflecting what was
4750 copied into it. unless, of course, we are the auditioner, in which
4751 case nothing was fed into it from the inputs at all.
4754 if (!is_auditioner()) {
4755 bufs.set_count (io->n_ports());
4759 boost::shared_ptr<AutomationControl>
4760 Route::pan_azimuth_control() const
4763 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4765 return boost::shared_ptr<AutomationControl>();
4767 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4768 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4770 if (!_pannable || !panner()) {
4771 return boost::shared_ptr<AutomationControl>();
4773 return _pannable->pan_azimuth_control;
4777 boost::shared_ptr<AutomationControl>
4778 Route::pan_elevation_control() const
4780 if (Profile->get_mixbus() || !_pannable || !panner()) {
4781 return boost::shared_ptr<AutomationControl>();
4784 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4786 if (c.find (PanElevationAutomation) != c.end()) {
4787 return _pannable->pan_elevation_control;
4789 return boost::shared_ptr<AutomationControl>();
4792 boost::shared_ptr<AutomationControl>
4793 Route::pan_width_control() const
4795 if (Profile->get_mixbus() || !_pannable || !panner()) {
4796 return boost::shared_ptr<AutomationControl>();
4799 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4801 if (c.find (PanWidthAutomation) != c.end()) {
4802 return _pannable->pan_width_control;
4804 return boost::shared_ptr<AutomationControl>();
4807 boost::shared_ptr<AutomationControl>
4808 Route::pan_frontback_control() const
4810 if (Profile->get_mixbus() || !_pannable || !panner()) {
4811 return boost::shared_ptr<AutomationControl>();
4814 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4816 if (c.find (PanFrontBackAutomation) != c.end()) {
4817 return _pannable->pan_frontback_control;
4819 return boost::shared_ptr<AutomationControl>();
4822 boost::shared_ptr<AutomationControl>
4823 Route::pan_lfe_control() const
4825 if (Profile->get_mixbus() || !_pannable || !panner()) {
4826 return boost::shared_ptr<AutomationControl>();
4829 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4831 if (c.find (PanLFEAutomation) != c.end()) {
4832 return _pannable->pan_lfe_control;
4834 return boost::shared_ptr<AutomationControl>();
4839 Route::eq_band_cnt () const
4841 if (Profile->get_mixbus()) {
4844 /* Ardour has no well-known EQ object */
4849 boost::shared_ptr<AutomationControl>
4850 Route::eq_gain_controllable (uint32_t band) const
4853 boost::shared_ptr<PluginInsert> eq = ch_eq();
4856 return boost::shared_ptr<AutomationControl>();
4859 uint32_t port_number;
4862 if (is_master() || mixbus()) {
4869 if (is_master() || mixbus()) {
4876 if (is_master() || mixbus()) {
4883 return boost::shared_ptr<AutomationControl>();
4886 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4888 return boost::shared_ptr<AutomationControl>();
4891 boost::shared_ptr<AutomationControl>
4892 Route::eq_freq_controllable (uint32_t band) const
4896 if (mixbus() || is_master()) {
4897 /* no frequency controls for mixbusses or master */
4898 return boost::shared_ptr<AutomationControl>();
4901 boost::shared_ptr<PluginInsert> eq = ch_eq();
4904 return boost::shared_ptr<AutomationControl>();
4907 uint32_t port_number;
4919 return boost::shared_ptr<AutomationControl>();
4922 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4924 return boost::shared_ptr<AutomationControl>();
4928 boost::shared_ptr<AutomationControl>
4929 Route::eq_q_controllable (uint32_t band) const
4931 return boost::shared_ptr<AutomationControl>();
4934 boost::shared_ptr<AutomationControl>
4935 Route::eq_shape_controllable (uint32_t band) const
4937 return boost::shared_ptr<AutomationControl>();
4940 boost::shared_ptr<AutomationControl>
4941 Route::eq_enable_controllable () const
4944 boost::shared_ptr<PluginInsert> eq = ch_eq();
4947 return boost::shared_ptr<AutomationControl>();
4950 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
4952 return boost::shared_ptr<AutomationControl>();
4956 boost::shared_ptr<AutomationControl>
4957 Route::eq_hpf_controllable () const
4960 boost::shared_ptr<PluginInsert> eq = ch_eq();
4963 return boost::shared_ptr<AutomationControl>();
4966 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
4968 return boost::shared_ptr<AutomationControl>();
4973 Route::eq_band_name (uint32_t band) const
4975 if (Profile->get_mixbus()) {
4991 boost::shared_ptr<AutomationControl>
4992 Route::comp_enable_controllable () const
4995 boost::shared_ptr<PluginInsert> comp = ch_comp();
4998 return boost::shared_ptr<AutomationControl>();
5001 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5003 return boost::shared_ptr<AutomationControl>();
5006 boost::shared_ptr<AutomationControl>
5007 Route::comp_threshold_controllable () const
5010 boost::shared_ptr<PluginInsert> comp = ch_comp();
5013 return boost::shared_ptr<AutomationControl>();
5016 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5019 return boost::shared_ptr<AutomationControl>();
5022 boost::shared_ptr<AutomationControl>
5023 Route::comp_speed_controllable () const
5026 boost::shared_ptr<PluginInsert> comp = ch_comp();
5029 return boost::shared_ptr<AutomationControl>();
5032 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5034 return boost::shared_ptr<AutomationControl>();
5037 boost::shared_ptr<AutomationControl>
5038 Route::comp_mode_controllable () const
5041 boost::shared_ptr<PluginInsert> comp = ch_comp();
5044 return boost::shared_ptr<AutomationControl>();
5047 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5049 return boost::shared_ptr<AutomationControl>();
5052 boost::shared_ptr<AutomationControl>
5053 Route::comp_makeup_controllable () const
5056 boost::shared_ptr<PluginInsert> comp = ch_comp();
5059 return boost::shared_ptr<AutomationControl>();
5062 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5064 return boost::shared_ptr<AutomationControl>();
5067 boost::shared_ptr<AutomationControl>
5068 Route::comp_redux_controllable () const
5071 boost::shared_ptr<PluginInsert> comp = ch_comp();
5074 return boost::shared_ptr<AutomationControl>();
5077 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5079 return boost::shared_ptr<AutomationControl>();
5084 Route::comp_mode_name (uint32_t mode) const
5089 return _("Leveler");
5091 return _("Compressor");
5093 return _("Limiter");
5095 return mixbus() ? _("Sidechain") : _("Limiter");
5105 Route::comp_speed_name (uint32_t mode) const
5123 boost::shared_ptr<AutomationControl>
5124 Route::send_level_controllable (uint32_t n) const
5127 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5129 return boost::shared_ptr<AutomationControl>();
5134 return boost::shared_ptr<AutomationControl>();
5137 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5138 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5140 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5142 return boost::shared_ptr<AutomationControl>();
5144 return s->gain_control ();
5148 boost::shared_ptr<AutomationControl>
5149 Route::send_enable_controllable (uint32_t n) const
5152 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5154 return boost::shared_ptr<AutomationControl>();
5159 return boost::shared_ptr<AutomationControl>();
5162 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5163 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5165 /* although Ardour sends have enable/disable as part of the Processor
5166 API, it is not exposed as a controllable.
5168 XXX: we should fix this.
5170 return boost::shared_ptr<AutomationControl>();
5175 Route::send_name (uint32_t n) const
5181 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5185 boost::shared_ptr<Processor> p = nth_send (n);
5194 boost::shared_ptr<AutomationControl>
5195 Route::master_send_enable_controllable () const
5198 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5200 return boost::shared_ptr<AutomationControl>();
5202 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5204 return boost::shared_ptr<AutomationControl>();
5209 Route::slaved () const
5211 if (!_gain_control) {
5214 /* just test one particular control, not all of them */
5215 return _gain_control->slaved ();
5219 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5221 if (!vca || !_gain_control) {
5225 /* just test one particular control, not all of them */
5227 return _gain_control->slaved_to (vca->gain_control());
5231 Route::muted_by_others_soloing () const
5233 if (!can_be_muted_by_others ()) {
5237 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5241 Route::clear_all_solo_state ()
5243 double v = _solo_safe_control->get_value ();
5245 _solo_control->clear_all_solo_state ();
5248 _solo_safe_control->set_value (v, Controllable::NoGroup);