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 /* now that we have _meter, its safe to connect to this */
235 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
236 configure_processors (0);
244 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
246 /* do this early so that we don't get incoming signals as we are going through destruction
251 /* don't use clear_processors here, as it depends on the session which may
252 be half-destroyed by now
255 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
256 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
257 (*i)->drop_references ();
260 _processors.clear ();
264 Route::ensure_track_or_route_name(string name, Session &session)
266 string newname = name;
268 while (!session.io_name_is_legal (newname)) {
269 newname = bump_name_once (newname, ' ');
276 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
278 // TODO route group, see set_gain()
279 // _trim_control->route_set_value (val);
283 Route::maybe_declick (BufferSet&, framecnt_t, int)
285 /* this is the "bus" implementation and they never declick.
290 /** Process this route for one (sub) cycle (process thread)
292 * @param bufs Scratch buffers to use for the signal path
293 * @param start_frame Initial transport frame
294 * @param end_frame Final transport frame
295 * @param nframes Number of frames to output (to ports)
297 * Note that (end_frame - start_frame) may not be equal to nframes when the
298 * transport speed isn't 1.0 (eg varispeed).
301 Route::process_output_buffers (BufferSet& bufs,
302 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
303 int declick, bool gain_automation_ok)
305 /* Caller must hold process lock */
306 assert (!AudioEngine::instance()->process_lock().trylock());
308 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
310 // can this actually happen? functions calling process_output_buffers()
311 // already take a reader-lock.
312 bufs.silence (nframes, 0);
316 _mute_control->automation_run (start_frame, nframes);
318 /* figure out if we're going to use gain automation */
319 if (gain_automation_ok) {
320 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
321 _amp->setup_gain_automation (
322 start_frame + _signal_latency_at_amp_position,
323 end_frame + _signal_latency_at_amp_position,
326 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
327 _trim->setup_gain_automation (
328 start_frame + _signal_latency_at_trim_position,
329 end_frame + _signal_latency_at_trim_position,
332 _amp->apply_gain_automation (false);
333 _trim->apply_gain_automation (false);
336 /* Tell main outs what to do about monitoring. We do this so that
337 on a transition between monitoring states we get a de-clicking gain
338 change in the _main_outs delivery, if config.get_use_monitor_fades()
341 We override this in the case where we have an internal generator.
343 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
345 _main_outs->no_outs_cuz_we_no_monitor (silence);
347 /* -------------------------------------------------------------------------------------------
348 GLOBAL DECLICK (for transport changes etc.)
349 ----------------------------------------------------------------------------------------- */
351 maybe_declick (bufs, nframes, declick);
352 _pending_declick = 0;
354 /* -------------------------------------------------------------------------------------------
355 DENORMAL CONTROL/PHASE INVERT
356 ----------------------------------------------------------------------------------------- */
358 if (!_phase_control->none()) {
362 if (_denormal_protection || Config->get_denormal_protection()) {
364 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
365 Sample* const sp = i->data();
367 if (_phase_control->inverted (chn)) {
368 for (pframes_t nx = 0; nx < nframes; ++nx) {
373 for (pframes_t nx = 0; nx < nframes; ++nx) {
381 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
382 Sample* const sp = i->data();
384 if (_phase_control->inverted (chn)) {
385 for (pframes_t nx = 0; nx < nframes; ++nx) {
394 if (_denormal_protection || Config->get_denormal_protection()) {
396 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
397 Sample* const sp = i->data();
398 for (pframes_t nx = 0; nx < nframes; ++nx) {
406 /* -------------------------------------------------------------------------------------------
408 ----------------------------------------------------------------------------------------- */
410 /* set this to be true if the meter will already have been ::run() earlier */
411 bool const meter_already_run = metering_state() == MeteringInput;
413 framecnt_t latency = 0;
414 const double speed = _session.transport_speed ();
416 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
418 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
419 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
424 /* if it has any inputs, make sure they match */
425 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
426 if (bufs.count() != (*i)->input_streams()) {
428 DEBUG::Processors, string_compose (
429 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
430 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
437 /* should we NOT run plugins here if the route is inactive?
438 do we catch route != active somewhere higher?
441 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
442 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
444 if (boost::dynamic_pointer_cast<PluginInsert>(*i) != 0) {
445 const framecnt_t longest_session_latency = _initial_delay + _signal_latency;
446 boost::dynamic_pointer_cast<PluginInsert>(*i)->set_sidechain_latency (
447 _initial_delay + latency, longest_session_latency - latency);
450 (*i)->run (bufs, start_frame - latency, end_frame - latency, speed, nframes, *i != _processors.back());
451 bufs.set_count ((*i)->output_streams());
453 if ((*i)->active ()) {
454 latency += (*i)->signal_latency ();
460 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
461 boost::shared_ptr<Processor> endpoint,
462 bool include_endpoint, bool for_export, bool for_freeze)
464 /* If no processing is required, there's no need to go any further. */
465 if (!endpoint && !include_endpoint) {
469 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
470 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
471 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
473 /* trim is always at the top, for bounce no latency compensation is needed */
474 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
475 _trim->setup_gain_automation (start, start + nframes, nframes);
478 const double speed = _session.transport_speed ();
479 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
481 if (!include_endpoint && (*i) == endpoint) {
485 /* if we're *not* exporting, stop processing if we come across a routing processor. */
486 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
489 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
493 /* special case the panner (export outputs)
494 * Ideally we'd only run the panner, not the delivery itself...
495 * but panners need separate input/output buffers and some context
496 * (panshell, panner type, etc). AFAICT there is no ill side effect
497 * of re-using the main delivery when freewheeling/exporting a region.
499 if ((*i) == _main_outs) {
500 assert ((*i)->does_routing());
501 (*i)->run (buffers, start - latency, start - latency + nframes, speed, nframes, true);
502 buffers.set_count ((*i)->output_streams());
505 /* don't run any processors that do routing.
506 * Also don't bother with metering.
508 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
509 (*i)->run (buffers, start - latency, start - latency + nframes, 1.0, nframes, true);
510 buffers.set_count ((*i)->output_streams());
511 latency += (*i)->signal_latency ();
514 if ((*i) == endpoint) {
521 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
522 bool include_endpoint, bool for_export, bool for_freeze) const
524 framecnt_t latency = 0;
525 if (!endpoint && !include_endpoint) {
529 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
530 if (!include_endpoint && (*i) == endpoint) {
533 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
536 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
539 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
540 latency += (*i)->signal_latency ();
542 if ((*i) == endpoint) {
550 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
551 bool include_endpoint, bool for_export, bool for_freeze) const
553 if (!endpoint && !include_endpoint) {
557 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
558 if (!include_endpoint && (*i) == endpoint) {
561 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
564 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
567 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
568 cc = (*i)->output_streams();
570 if ((*i) == endpoint) {
578 Route::n_process_buffers ()
580 return max (_input->n_ports(), processor_max_streams);
584 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
586 assert (is_monitor());
587 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
588 fill_buffers_with_input (bufs, _input, nframes);
589 passthru (bufs, start_frame, end_frame, nframes, declick);
593 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
597 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
599 /* control/monitor bus ignores input ports when something is
600 feeding the listen "stream". data will "arrive" into the
601 route from the intreturn processor element.
604 bufs.silence (nframes, 0);
607 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
608 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
612 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
614 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
616 bufs.set_count (_input->n_ports());
617 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
618 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
622 Route::set_listen (bool yn)
626 _monitor_send->activate ();
628 _monitor_send->deactivate ();
634 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
636 /* nothing to do if we're not using AFL/PFL. But if we are, we need
637 to alter the active state of the monitor send.
640 if (Config->get_solo_control_is_listen_control ()) {
641 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
646 Route::push_solo_isolate_upstream (int32_t delta)
648 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
650 boost::shared_ptr<RouteList> routes = _session.get_routes ();
651 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
653 if ((*i).get() == this || !(*i)->can_solo()) {
658 bool does_feed = feeds (*i, &sends_only);
660 if (does_feed && !sends_only) {
661 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
667 Route::push_solo_upstream (int delta)
669 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
670 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
674 boost::shared_ptr<Route> sr (i->r.lock());
676 sr->solo_control()->mod_solo_by_others_downstream (-delta);
683 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
685 cerr << name << " {" << endl;
686 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
687 p != procs.end(); ++p) {
688 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
694 /** Supposing that we want to insert a Processor at a given Placement, return
695 * the processor to add the new one before (or 0 to add at the end).
697 boost::shared_ptr<Processor>
698 Route::before_processor_for_placement (Placement p)
700 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
702 ProcessorList::iterator loc;
705 /* generic pre-fader: insert immediately before the amp */
706 loc = find (_processors.begin(), _processors.end(), _amp);
708 /* generic post-fader: insert right before the main outs */
709 loc = find (_processors.begin(), _processors.end(), _main_outs);
712 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
715 /** Supposing that we want to insert a Processor at a given index, return
716 * the processor to add the new one before (or 0 to add at the end).
718 boost::shared_ptr<Processor>
719 Route::before_processor_for_index (int index)
722 return boost::shared_ptr<Processor> ();
725 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
727 ProcessorList::iterator i = _processors.begin ();
729 while (i != _processors.end() && j < index) {
730 if ((*i)->display_to_user()) {
737 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
740 /** Add a processor either pre- or post-fader
741 * @return 0 on success, non-0 on failure.
744 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
746 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
750 /** Add a processor to a route such that it ends up with a given index into the visible processors.
751 * @param index Index to add the processor at, or -1 to add at the end of the list.
752 * @return 0 on success, non-0 on failure.
755 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
757 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
760 /** Add a processor to the route.
761 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
762 * @return 0 on success, non-0 on failure.
765 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
767 assert (processor != _meter);
768 assert (processor != _main_outs);
770 DEBUG_TRACE (DEBUG::Processors, string_compose (
771 "%1 adding processor %2\n", name(), processor->name()));
775 pl.push_back (processor);
776 int rv = add_processors (pl, before, err);
782 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
783 processor->activate ();
790 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
792 /* We cannot destruct the processor here (usually RT-thread
793 * with various locks held - in case of sends also io_locks).
794 * Queue for deletion in low-priority thread.
796 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
797 selfdestruct_sequence.push_back (wp);
801 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
803 XMLProperty const * prop;
806 boost::shared_ptr<Processor> processor;
808 /* bit of a hack: get the `placement' property from the <Redirect> tag here
809 so that we can add the processor in the right place (pre/post-fader)
812 XMLNodeList const & children = node.children ();
813 XMLNodeList::const_iterator i = children.begin ();
815 while (i != children.end() && (*i)->name() != X_("Redirect")) {
819 Placement placement = PreFader;
821 if (i != children.end()) {
822 if ((prop = (*i)->property (X_("placement"))) != 0) {
823 placement = Placement (string_2_enum (prop->value(), placement));
827 if (node.name() == "Insert") {
829 if ((prop = node.property ("type")) != 0) {
831 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
832 prop->value() == "lv2" ||
833 prop->value() == "windows-vst" ||
834 prop->value() == "lxvst" ||
835 prop->value() == "audiounit") {
837 if (_session.get_disable_all_loaded_plugins ()) {
838 processor.reset (new UnknownProcessor (_session, node));
840 processor.reset (new PluginInsert (_session));
841 processor->set_owner (this);
846 processor.reset (new PortInsert (_session, _pannable, _mute_master));
851 } else if (node.name() == "Send") {
853 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
854 processor.reset (new Send (_session, sendpan, _mute_master));
858 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
862 if (processor->set_state (node, version)) {
866 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
867 if (i != children.end()) {
868 if ((prop = (*i)->property (X_("active"))) != 0) {
869 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
870 processor->activate();
872 processor->deactivate();
876 return (add_processor (processor, placement, 0, false) == 0);
879 catch (failed_constructor &err) {
880 warning << _("processor could not be created. Ignored.") << endmsg;
886 inline Route::PluginSetupOptions operator|= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
887 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) | static_cast<int> (b));
890 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
891 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
895 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
897 ProcessorList::iterator loc;
900 loc = find(_processors.begin(), _processors.end(), before);
901 if (loc == _processors.end ()) {
905 /* nothing specified - at end */
906 loc = _processors.end ();
909 if (!AudioEngine::instance()->connected()) {
913 if (others.empty()) {
917 ProcessorList to_skip;
919 // check if there's an instrument to replace or configure
920 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
921 boost::shared_ptr<PluginInsert> pi;
922 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
925 if (!pi->plugin ()->get_info ()->is_instrument ()) {
928 boost::shared_ptr<Processor> instrument = the_instrument ();
929 ChanCount in (DataType::MIDI, 1);
930 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
932 PluginSetupOptions flags = None;
935 in = instrument->input_streams ();
936 out = instrument->output_streams ();
938 if (pi->has_output_presets (in, out)) {
942 pi->set_strict_io (_strict_io);
944 PluginSetupOptions mask = None;
945 if (Config->get_ask_replace_instrument ()) {
948 if (Config->get_ask_setup_instrument ()) {
955 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
956 switch (rv.get_value_or (0)) {
958 to_skip.push_back (*i); // don't add this one;
961 replace_processor (instrument, *i, err);
962 to_skip.push_back (*i);
971 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
972 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
973 ProcessorState pstate (this);
975 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
980 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
981 if (check != to_skip.end()) {
985 boost::shared_ptr<PluginInsert> pi;
987 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
988 pi->set_strict_io (_strict_io);
992 /* Ensure that only one amp is in the list at any time */
993 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
994 if (check != _processors.end()) {
995 if (before == _amp) {
996 /* Already in position; all is well */
999 _processors.erase (check);
1004 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1006 _processors.insert (loc, *i);
1007 (*i)->set_owner (this);
1010 if (configure_processors_unlocked (err, &lm)) {
1012 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1017 if (pi && pi->has_sidechain ()) {
1018 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
1021 if ((*i)->active()) {
1022 // emit ActiveChanged() and latency_changed() if needed
1026 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1028 boost::shared_ptr<Send> send;
1029 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1030 send->SelfDestruct.connect_same_thread (*this,
1031 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1035 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1036 boost::shared_ptr<PluginInsert> pi;
1038 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1039 if (pi->has_no_inputs ()) {
1040 _have_internal_generator = true;
1046 _output->set_user_latency (0);
1049 reset_instrument_info ();
1050 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1051 set_processor_positions ();
1057 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1059 if (p == PreFader) {
1060 start = _processors.begin();
1061 end = find(_processors.begin(), _processors.end(), _amp);
1063 start = find(_processors.begin(), _processors.end(), _amp);
1065 end = _processors.end();
1069 /** Turn off all processors with a given placement
1070 * @param p Placement of processors to disable
1073 Route::disable_processors (Placement p)
1075 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1077 ProcessorList::iterator start, end;
1078 placement_range(p, start, end);
1080 for (ProcessorList::iterator i = start; i != end; ++i) {
1081 (*i)->enable (false);
1084 _session.set_dirty ();
1087 /** Turn off all redirects
1090 Route::disable_processors ()
1092 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1094 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1095 (*i)->enable (false);
1098 _session.set_dirty ();
1101 /** Turn off all redirects with a given placement
1102 * @param p Placement of redirects to disable
1105 Route::disable_plugins (Placement p)
1107 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1109 ProcessorList::iterator start, end;
1110 placement_range(p, start, end);
1112 for (ProcessorList::iterator i = start; i != end; ++i) {
1113 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1114 (*i)->enable (false);
1118 _session.set_dirty ();
1121 /** Turn off all plugins
1124 Route::disable_plugins ()
1126 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1128 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1129 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1130 (*i)->enable (false);
1134 _session.set_dirty ();
1139 Route::ab_plugins (bool forward)
1141 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1145 /* forward = turn off all active redirects, and mark them so that the next time
1146 we go the other way, we will revert them
1149 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1150 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1154 if ((*i)->enabled ()) {
1155 (*i)->enable (false);
1156 (*i)->set_next_ab_is_active (true);
1158 (*i)->set_next_ab_is_active (false);
1164 /* backward = if the redirect was marked to go active on the next ab, do so */
1166 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1168 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1172 (*i)->enable ((*i)->get_next_ab_is_active ());
1176 _session.set_dirty ();
1180 /** Remove processors with a given placement.
1181 * @param p Placement of processors to remove.
1184 Route::clear_processors (Placement p)
1186 if (!_session.engine().connected()) {
1190 bool already_deleting = _session.deletion_in_progress();
1191 if (!already_deleting) {
1192 _session.set_deletion_in_progress();
1196 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1197 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1198 ProcessorList new_list;
1199 ProcessorStreams err;
1200 bool seen_amp = false;
1202 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1208 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1210 /* you can't remove these */
1212 new_list.push_back (*i);
1219 new_list.push_back (*i);
1222 (*i)->drop_references ();
1230 (*i)->drop_references ();
1233 new_list.push_back (*i);
1240 _processors = new_list;
1241 configure_processors_unlocked (&err, &lm); // this can't fail
1244 processor_max_streams.reset();
1245 _have_internal_generator = false;
1246 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1247 set_processor_positions ();
1249 reset_instrument_info ();
1251 if (!already_deleting) {
1252 _session.clear_deletion_in_progress();
1257 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1259 // TODO once the export point can be configured properly, do something smarter here
1260 if (processor == _capturing_processor) {
1261 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1262 if (need_process_lock) {
1266 _capturing_processor.reset();
1268 if (need_process_lock) {
1273 /* these can never be removed */
1275 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1279 if (!_session.engine().connected()) {
1283 processor_max_streams.reset();
1286 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1287 if (need_process_lock) {
1291 /* Caller must hold process lock */
1292 assert (!AudioEngine::instance()->process_lock().trylock());
1294 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1296 ProcessorState pstate (this);
1298 ProcessorList::iterator i;
1299 bool removed = false;
1301 for (i = _processors.begin(); i != _processors.end(); ) {
1302 if (*i == processor) {
1304 /* move along, see failure case for configure_processors()
1305 where we may need to reconfigure the processor.
1308 /* stop redirects that send signals to JACK ports
1309 from causing noise as a result of no longer being
1313 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1314 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1318 iop = pi->sidechain();
1325 i = _processors.erase (i);
1333 _output->set_user_latency (0);
1341 if (configure_processors_unlocked (err, &lm)) {
1343 /* we know this will work, because it worked before :) */
1344 configure_processors_unlocked (0, &lm);
1348 _have_internal_generator = false;
1350 for (i = _processors.begin(); i != _processors.end(); ++i) {
1351 boost::shared_ptr<PluginInsert> pi;
1353 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1354 if (pi->has_no_inputs ()) {
1355 _have_internal_generator = true;
1360 if (need_process_lock) {
1365 reset_instrument_info ();
1366 processor->drop_references ();
1367 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1368 set_processor_positions ();
1374 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1376 /* these can never be removed */
1377 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1380 /* and can't be used as substitute, either */
1381 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1385 /* I/Os are out, too */
1386 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1390 /* this function cannot be used to swap/reorder processors */
1391 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1395 if (!AudioEngine::instance()->connected() || !old || !sub) {
1399 /* ensure that sub is not owned by another route */
1400 if (sub->owner ()) {
1405 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1406 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1407 ProcessorState pstate (this);
1409 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1411 ProcessorList::iterator i;
1412 bool replaced = false;
1413 bool enable = old->enabled ();
1415 for (i = _processors.begin(); i != _processors.end(); ) {
1417 i = _processors.erase (i);
1418 _processors.insert (i, sub);
1419 sub->set_owner (this);
1432 boost::shared_ptr<PluginInsert> pi;
1433 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1434 pi->set_strict_io (true);
1438 if (configure_processors_unlocked (err, &lm)) {
1440 configure_processors_unlocked (0, &lm);
1444 _have_internal_generator = false;
1446 for (i = _processors.begin(); i != _processors.end(); ++i) {
1447 boost::shared_ptr<PluginInsert> pi;
1448 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1449 if (pi->has_no_inputs ()) {
1450 _have_internal_generator = true;
1460 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1461 _output->set_user_latency (0);
1464 reset_instrument_info ();
1465 old->drop_references ();
1466 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1467 set_processor_positions ();
1472 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1474 ProcessorList deleted;
1476 if (!_session.engine().connected()) {
1480 processor_max_streams.reset();
1483 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1484 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1485 ProcessorState pstate (this);
1487 ProcessorList::iterator i;
1488 boost::shared_ptr<Processor> processor;
1490 for (i = _processors.begin(); i != _processors.end(); ) {
1494 /* these can never be removed */
1496 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1501 /* see if its in the list of processors to delete */
1503 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1508 /* stop IOProcessors that send to JACK ports
1509 from causing noise as a result of no longer being
1513 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1514 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1517 iop = pi->sidechain();
1524 deleted.push_back (processor);
1525 i = _processors.erase (i);
1528 if (deleted.empty()) {
1529 /* none of those in the requested list were found */
1533 _output->set_user_latency (0);
1535 if (configure_processors_unlocked (err, &lm)) {
1537 /* we know this will work, because it worked before :) */
1538 configure_processors_unlocked (0, &lm);
1543 _have_internal_generator = false;
1545 for (i = _processors.begin(); i != _processors.end(); ++i) {
1546 boost::shared_ptr<PluginInsert> pi;
1548 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1549 if (pi->has_no_inputs ()) {
1550 _have_internal_generator = true;
1557 /* now try to do what we need to so that those that were removed will be deleted */
1559 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1560 (*i)->drop_references ();
1563 reset_instrument_info ();
1564 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1565 set_processor_positions ();
1571 Route::reset_instrument_info ()
1573 boost::shared_ptr<Processor> instr = the_instrument();
1575 _instrument_info.set_internal_instrument (instr);
1579 /** Caller must hold process lock */
1581 Route::configure_processors (ProcessorStreams* err)
1583 #ifndef PLATFORM_WINDOWS
1584 assert (!AudioEngine::instance()->process_lock().trylock());
1587 if (!_in_configure_processors) {
1588 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1589 return configure_processors_unlocked (err, &lm);
1596 Route::input_streams () const
1598 return _input->n_ports ();
1601 list<pair<ChanCount, ChanCount> >
1602 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1604 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1606 return try_configure_processors_unlocked (in, err);
1609 list<pair<ChanCount, ChanCount> >
1610 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1612 // Check each processor in order to see if we can configure as requested
1614 list<pair<ChanCount, ChanCount> > configuration;
1617 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1618 DEBUG_TRACE (DEBUG::Processors, "{\n");
1620 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1622 if ((*p)->can_support_io_configuration(in, out)) {
1624 if (boost::dynamic_pointer_cast<Delivery> (*p)
1625 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1627 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1628 /* with strict I/O the panner + output are forced to
1629 * follow the last processor's output.
1631 * Delivery::can_support_io_configuration() will only add ports,
1632 * but not remove excess ports.
1634 * This works because the delivery only requires
1635 * as many outputs as there are inputs.
1636 * Delivery::configure_io() will do the actual removal
1637 * by calling _output->ensure_io()
1639 if (!is_master() && _session.master_out () && in.n_audio() > 0) {
1640 /* ..but at least as many as there are master-inputs, if
1641 * the delivery is dealing with audio */
1642 // XXX this may need special-casing for mixbus (master-outputs)
1643 // and should maybe be a preference anyway ?!
1644 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1650 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1651 configuration.push_back(make_pair(in, out));
1654 // restriction for Monitor Section Processors
1655 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1656 /* do not allow to add/remove channels (for now)
1657 * The Monitor follows the master-bus and has no panner (unpan)
1658 * but do allow processors with midi-in to be added (e.g VSTs with control that
1659 * will remain unconnected)
1661 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration not allowed.\n");
1662 return list<pair<ChanCount, ChanCount> > ();
1664 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1665 // internal sends make no sense, only feedback
1666 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1667 return list<pair<ChanCount, ChanCount> > ();
1669 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1670 /* External Sends can be problematic. one can add/remove ports
1671 * there signal leaves the DAW to external monitors anyway, so there's
1672 * no real use for allowing them here anyway.
1674 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1675 return list<pair<ChanCount, ChanCount> > ();
1677 if (boost::dynamic_pointer_cast<Send> (*p)) {
1679 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1680 return list<pair<ChanCount, ChanCount> > ();
1689 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1690 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1691 DEBUG_TRACE (DEBUG::Processors, "}\n");
1692 return list<pair<ChanCount, ChanCount> > ();
1696 DEBUG_TRACE (DEBUG::Processors, "}\n");
1698 return configuration;
1701 /** Set the input/output configuration of each processor in the processors list.
1702 * Caller must hold process lock.
1703 * Return 0 on success, otherwise configuration is impossible.
1706 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1708 #ifndef PLATFORM_WINDOWS
1709 assert (!AudioEngine::instance()->process_lock().trylock());
1712 if (_in_configure_processors) {
1716 /* put invisible processors where they should be */
1717 setup_invisible_processors ();
1719 _in_configure_processors = true;
1721 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1723 if (configuration.empty ()) {
1724 _in_configure_processors = false;
1729 bool seen_mains_out = false;
1730 processor_out_streams = _input->n_ports();
1731 processor_max_streams.reset();
1733 /* processor configure_io() may result in adding ports
1734 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1736 * with jack2 adding ports results in a graph-order callback,
1737 * which calls Session::resort_routes() and eventually
1738 * Route::direct_feeds_according_to_reality()
1739 * which takes a ReaderLock (_processor_lock).
1741 * so we can't hold a WriterLock here until jack2 threading
1744 * NB. we still hold the process lock
1746 * (ardour's own engines do call graph-order from the
1747 * process-thread and hence do not have this issue; besides
1748 * merely adding ports won't trigger a graph-order, only
1749 * making connections does)
1753 // TODO check for a potential ReaderLock after ReaderLock ??
1754 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1756 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1757 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1759 if (!(*p)->configure_io(c->first, c->second)) {
1760 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1761 _in_configure_processors = false;
1766 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1767 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1769 boost::shared_ptr<IOProcessor> iop;
1770 boost::shared_ptr<PluginInsert> pi;
1771 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1772 /* plugins connected via Split or Hide Match may have more channels.
1773 * route/scratch buffers are needed for all of them
1774 * The configuration may only be a subset (both input and output)
1776 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1778 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1779 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1780 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1784 if (boost::dynamic_pointer_cast<Delivery> (*p)
1785 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1786 /* main delivery will increase port count to match input.
1787 * the Delivery::Main is usually the last processor - followed only by
1790 seen_mains_out = true;
1792 if (!seen_mains_out) {
1793 processor_out_streams = out;
1802 _meter->set_max_channels (processor_max_streams);
1805 /* make sure we have sufficient scratch buffers to cope with the new processor
1808 _session.ensure_buffers (n_process_buffers ());
1810 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1812 _in_configure_processors = false;
1816 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1817 * @param state New active state for those processors.
1820 Route::all_visible_processors_active (bool state)
1822 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1824 if (_processors.empty()) {
1828 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1829 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1832 (*i)->enable (state);
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 /* monitor bus does not get a panner, but if (re)created
2357 via XML, it will already have one by the time we
2358 call ::set_state(). so ... remove it.
2363 /* add all processors (except amp, which is always present) */
2365 nlist = node.children();
2366 XMLNode processor_state (X_("processor_state"));
2368 Stateful::save_extra_xml (node);
2370 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2374 if (child->name() == IO::state_node_name) {
2375 if ((prop = child->property (X_("direction"))) == 0) {
2379 if (prop->value() == "Input") {
2380 _input->set_state (*child, version);
2381 } else if (prop->value() == "Output") {
2382 _output->set_state (*child, version);
2385 } else if (child->name() == X_("Processor")) {
2386 processor_state.add_child_copy (*child);
2387 } else if (child->name() == X_("Pannable")) {
2389 _pannable->set_state (*child, version);
2391 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2393 } else if (child->name() == Slavable::xml_node_name) {
2394 Slavable::set_state (*child, version);
2398 if ((prop = node.property (X_("meter-point"))) != 0) {
2399 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2400 set_meter_point (mp, true);
2402 _meter->set_display_to_user (_meter_point == MeterCustom);
2406 if ((prop = node.property (X_("meter-type"))) != 0) {
2407 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2410 _initial_io_setup = false;
2412 set_processor_state (processor_state);
2414 // this looks up the internal instrument in processors
2415 reset_instrument_info();
2417 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2418 set_denormal_protection (string_is_affirmative (prop->value()));
2421 if ((prop = node.property (X_("active"))) != 0) {
2422 bool yn = string_is_affirmative (prop->value());
2423 set_active (yn, this);
2426 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2427 PBD::ID id (prop->value ());
2428 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2429 ProcessorList::const_iterator i = _processors.begin ();
2430 while (i != _processors.end() && (*i)->id() != id) {
2434 if (i != _processors.end ()) {
2435 _processor_after_last_custom_meter = *i;
2436 _custom_meter_position_noted = true;
2440 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2443 if (child->name() == X_("Comment")) {
2445 /* XXX this is a terrible API design in libxml++ */
2447 XMLNode *cmt = *(child->children().begin());
2448 _comment = cmt->content();
2450 } else if (child->name() == Controllable::xml_node_name) {
2451 if ((prop = child->property (X_("name"))) == 0) {
2455 if (prop->value() == _gain_control->name()) {
2456 _gain_control->set_state (*child, version);
2457 } else if (prop->value() == _solo_control->name()) {
2458 _solo_control->set_state (*child, version);
2459 } else if (prop->value() == _solo_safe_control->name()) {
2460 _solo_safe_control->set_state (*child, version);
2461 } else if (prop->value() == _solo_isolate_control->name()) {
2462 _solo_isolate_control->set_state (*child, version);
2463 } else if (prop->value() == _mute_control->name()) {
2464 _mute_control->set_state (*child, version);
2465 } else if (prop->value() == _phase_control->name()) {
2466 _phase_control->set_state (*child, version);
2468 } else if (child->name() == MuteMaster::xml_node_name) {
2469 _mute_master->set_state (*child, version);
2471 } else if (child->name() == Automatable::xml_node_name) {
2472 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2480 Route::set_state_2X (const XMLNode& node, int version)
2484 XMLNodeConstIterator niter;
2486 XMLProperty const * prop;
2488 /* 2X things which still remain to be handled:
2494 if (node.name() != "Route") {
2495 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2499 Stripable::set_state (node, version);
2501 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2502 set_denormal_protection (string_is_affirmative (prop->value()));
2505 if ((prop = node.property (X_("muted"))) != 0) {
2508 bool muted = string_is_affirmative (prop->value());
2514 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2516 if (string_is_affirmative (prop->value())){
2517 mute_point = mute_point + "PreFader";
2522 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2524 if (string_is_affirmative (prop->value())){
2527 mute_point = mute_point + ",";
2530 mute_point = mute_point + "PostFader";
2535 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2537 if (string_is_affirmative (prop->value())){
2540 mute_point = mute_point + ",";
2543 mute_point = mute_point + "Listen";
2548 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2550 if (string_is_affirmative (prop->value())){
2553 mute_point = mute_point + ",";
2556 mute_point = mute_point + "Main";
2560 _mute_master->set_mute_points (mute_point);
2561 _mute_master->set_muted_by_self (true);
2565 if ((prop = node.property (X_("meter-point"))) != 0) {
2566 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2571 nlist = node.children ();
2572 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2576 if (child->name() == IO::state_node_name) {
2578 /* there is a note in IO::set_state_2X() about why we have to call
2582 _input->set_state_2X (*child, version, true);
2583 _output->set_state_2X (*child, version, false);
2585 if ((prop = child->property (X_("name"))) != 0) {
2586 Route::set_name (prop->value ());
2591 if ((prop = child->property (X_("active"))) != 0) {
2592 bool yn = string_is_affirmative (prop->value());
2593 _active = !yn; // force switch
2594 set_active (yn, this);
2597 if ((prop = child->property (X_("gain"))) != 0) {
2600 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2601 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2605 /* Set up Panners in the IO */
2606 XMLNodeList io_nlist = child->children ();
2608 XMLNodeConstIterator io_niter;
2611 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2613 io_child = *io_niter;
2615 if (io_child->name() == X_("Panner")) {
2616 _main_outs->panner_shell()->set_state(*io_child, version);
2617 } else if (io_child->name() == X_("Automation")) {
2618 /* IO's automation is for the fader */
2619 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2625 XMLNodeList redirect_nodes;
2627 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2631 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2632 redirect_nodes.push_back(child);
2637 set_processor_state_2X (redirect_nodes, version);
2639 Stateful::save_extra_xml (node);
2641 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2644 if (child->name() == X_("Comment")) {
2646 /* XXX this is a terrible API design in libxml++ */
2648 XMLNode *cmt = *(child->children().begin());
2649 _comment = cmt->content();
2651 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2652 if (prop->value() == X_("solo")) {
2653 _solo_control->set_state (*child, version);
2654 } else if (prop->value() == X_("mute")) {
2655 _mute_control->set_state (*child, version);
2665 Route::get_processor_state ()
2667 XMLNode* root = new XMLNode (X_("redirects"));
2668 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2669 root->add_child_nocopy ((*i)->state (true));
2676 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2678 /* We don't bother removing existing processors not in nList, as this
2679 method will only be called when creating a Route from scratch, not
2680 for undo purposes. Just put processors in at the appropriate place
2684 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2685 add_processor_from_xml_2X (**i, version);
2690 Route::set_processor_state (const XMLNode& node)
2692 const XMLNodeList &nlist = node.children();
2693 XMLNodeConstIterator niter;
2694 ProcessorList new_order;
2695 bool must_configure = false;
2697 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2699 XMLProperty* prop = (*niter)->property ("type");
2701 if (prop->value() == "amp") {
2702 _amp->set_state (**niter, Stateful::current_state_version);
2703 new_order.push_back (_amp);
2704 } else if (prop->value() == "trim") {
2705 _trim->set_state (**niter, Stateful::current_state_version);
2706 new_order.push_back (_trim);
2707 } else if (prop->value() == "meter") {
2708 _meter->set_state (**niter, Stateful::current_state_version);
2709 new_order.push_back (_meter);
2710 } else if (prop->value() == "delay") {
2712 _delayline->set_state (**niter, Stateful::current_state_version);
2713 new_order.push_back (_delayline);
2715 } else if (prop->value() == "main-outs") {
2716 _main_outs->set_state (**niter, Stateful::current_state_version);
2717 } else if (prop->value() == "intreturn") {
2719 _intreturn.reset (new InternalReturn (_session));
2720 must_configure = true;
2722 _intreturn->set_state (**niter, Stateful::current_state_version);
2723 } else if (is_monitor() && prop->value() == "monitor") {
2724 if (!_monitor_control) {
2725 _monitor_control.reset (new MonitorProcessor (_session));
2726 must_configure = true;
2728 _monitor_control->set_state (**niter, Stateful::current_state_version);
2729 } else if (prop->value() == "capture") {
2730 /* CapturingProcessor should never be restored, it's always
2731 added explicitly when needed */
2733 ProcessorList::iterator o;
2735 for (o = _processors.begin(); o != _processors.end(); ++o) {
2736 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2737 if (id_prop && (*o)->id() == id_prop->value()) {
2738 (*o)->set_state (**niter, Stateful::current_state_version);
2739 new_order.push_back (*o);
2744 // If the processor (*niter) is not on the route then create it
2746 if (o == _processors.end()) {
2748 boost::shared_ptr<Processor> processor;
2750 if (prop->value() == "intsend") {
2752 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2754 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2755 prop->value() == "lv2" ||
2756 prop->value() == "windows-vst" ||
2757 prop->value() == "lxvst" ||
2758 prop->value() == "luaproc" ||
2759 prop->value() == "audiounit") {
2761 if (_session.get_disable_all_loaded_plugins ()) {
2762 processor.reset (new UnknownProcessor (_session, **niter));
2764 processor.reset (new PluginInsert (_session));
2765 processor->set_owner (this);
2767 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2768 pi->set_strict_io (true);
2772 } else if (prop->value() == "port") {
2774 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2776 } else if (prop->value() == "send") {
2778 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2779 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2780 send->SelfDestruct.connect_same_thread (*this,
2781 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2784 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2788 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2789 /* This processor could not be configured. Turn it into a UnknownProcessor */
2790 processor.reset (new UnknownProcessor (_session, **niter));
2793 /* subscribe to Sidechain IO changes */
2794 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2795 if (pi && pi->has_sidechain ()) {
2796 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2799 /* we have to note the monitor send here, otherwise a new one will be created
2800 and the state of this one will be lost.
2802 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2803 if (isend && isend->role() == Delivery::Listen) {
2804 _monitor_send = isend;
2807 /* it doesn't matter if invisible processors are added here, as they
2808 will be sorted out by setup_invisible_processors () shortly.
2811 new_order.push_back (processor);
2812 must_configure = true;
2818 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2819 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2820 /* re-assign _processors w/o process-lock.
2821 * if there's an IO-processor present in _processors but
2822 * not in new_order, it will be deleted and ~IO takes
2825 _processors = new_order;
2827 if (must_configure) {
2828 configure_processors_unlocked (0, &lm);
2831 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2833 (*i)->set_owner (this);
2834 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2836 boost::shared_ptr<PluginInsert> pi;
2838 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2839 if (pi->has_no_inputs ()) {
2840 _have_internal_generator = true;
2847 reset_instrument_info ();
2848 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2849 set_processor_positions ();
2853 Route::curve_reallocate ()
2855 // _gain_automation_curve.finish_resize ();
2856 // _pan_automation_curve.finish_resize ();
2860 Route::silence (framecnt_t nframes)
2862 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2867 silence_unlocked (nframes);
2871 Route::silence_unlocked (framecnt_t nframes)
2873 /* Must be called with the processor lock held */
2875 const framepos_t now = _session.transport_frame ();
2879 _output->silence (nframes);
2881 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2882 boost::shared_ptr<PluginInsert> pi;
2884 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2885 // skip plugins, they don't need anything when we're not active
2889 (*i)->silence (nframes, now);
2892 if (nframes == _session.get_block_size()) {
2899 Route::add_internal_return ()
2902 _intreturn.reset (new InternalReturn (_session));
2903 add_processor (_intreturn, PreFader);
2908 Route::add_send_to_internal_return (InternalSend* send)
2910 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2912 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2913 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2916 return d->add_send (send);
2922 Route::remove_send_from_internal_return (InternalSend* send)
2924 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2926 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2927 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2930 return d->remove_send (send);
2936 Route::enable_monitor_send ()
2938 /* Caller must hold process lock */
2939 assert (!AudioEngine::instance()->process_lock().trylock());
2941 /* master never sends to monitor section via the normal mechanism */
2942 assert (!is_master ());
2943 assert (!is_monitor ());
2945 /* make sure we have one */
2946 if (!_monitor_send) {
2947 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
2948 _monitor_send->set_display_to_user (false);
2952 configure_processors (0);
2955 /** Add an aux send to a route.
2956 * @param route route to send to.
2957 * @param before Processor to insert before, or 0 to insert at the end.
2960 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2962 assert (route != _session.monitor_out ());
2965 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2967 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2969 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2971 if (d && d->target_route() == route) {
2972 /* already listening via the specified IO: do nothing */
2980 boost::shared_ptr<InternalSend> listener;
2983 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2984 listener.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
2987 add_processor (listener, before);
2989 } catch (failed_constructor& err) {
2997 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2999 ProcessorStreams err;
3000 ProcessorList::iterator tmp;
3003 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3005 /* have to do this early because otherwise processor reconfig
3006 * will put _monitor_send back in the list
3009 if (route == _session.monitor_out()) {
3010 _monitor_send.reset ();
3014 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3016 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3018 if (d && d->target_route() == route) {
3020 if (remove_processor (*x, &err, false) > 0) {
3026 /* list could have been demolished while we dropped the lock
3029 if (_session.engine().connected()) {
3030 /* i/o processors cannot be removed if the engine is not running
3031 * so don't live-loop in case the engine is N/A or dies
3041 Route::set_comment (string cmt, void *src)
3045 _session.set_dirty ();
3049 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3051 FeedRecord fr (other, via_sends_only);
3053 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3055 if (!result.second) {
3057 /* already a record for "other" - make sure sends-only information is correct */
3058 if (!via_sends_only && result.first->sends_only) {
3059 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3060 frp->sends_only = false;
3064 return result.second;
3068 Route::clear_fed_by ()
3074 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3076 const FedBy& fed_by (other->fed_by());
3078 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3079 boost::shared_ptr<Route> sr = f->r.lock();
3081 if (sr && (sr.get() == this)) {
3083 if (via_sends_only) {
3084 *via_sends_only = f->sends_only;
3095 Route::all_inputs () const
3097 /* TODO, if this works as expected,
3098 * cache the IOVector and maintain it via
3099 * input_change_handler(), sidechain_change_handler() etc
3102 ios.push_back (_input);
3104 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3105 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3107 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3108 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3111 iop = pi->sidechain();
3114 if (iop != 0 && iop->input()) {
3115 ios.push_back (iop->input());
3122 Route::all_outputs () const
3125 // _output is included via Delivery
3126 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3127 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3128 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3129 if (iop != 0 && iop->output()) {
3130 ios.push_back (iop->output());
3137 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3139 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3140 if (other->all_inputs().fed_by (_output)) {
3141 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3142 if (via_send_only) {
3143 *via_send_only = false;
3149 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3151 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3153 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3154 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3157 iop = pi->sidechain();
3161 boost::shared_ptr<const IO> iop_out = iop->output();
3162 if (other.get() == this && iop_out && iop->input() && iop_out->connected_to (iop->input())) {
3163 // TODO this needs a delaylines in the Insert to align connections (!)
3164 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed its own return (%2)\n", iop->name(), other->name()));
3167 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3168 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3169 if (via_send_only) {
3170 *via_send_only = true;
3174 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3177 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3182 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3187 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3189 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3193 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3195 return _session._current_route_graph.feeds (shared_from_this (), other);
3198 /** Called from the (non-realtime) butler thread when the transport is stopped */
3200 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3202 framepos_t now = _session.transport_frame();
3205 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3207 Automatable::transport_stopped (now);
3209 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3211 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3215 (*i)->transport_stopped (now);
3219 _roll_delay = _initial_delay;
3223 Route::input_change_handler (IOChange change, void * /*src*/)
3225 if ((change.type & IOChange::ConfigurationChanged)) {
3226 /* This is called with the process lock held if change
3227 contains ConfigurationChanged
3229 configure_processors (0);
3230 _phase_control->resize (_input->n_ports().n_audio ());
3231 io_changed (); /* EMIT SIGNAL */
3234 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3237 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3238 if (_input->connected()) {
3239 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3240 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3244 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3245 if (does_feed && !sends_only) {
3246 if ((*i)->soloed()) {
3249 if ((*i)->solo_isolate_control()->solo_isolated()) {
3256 int delta = sbou - _solo_control->soloed_by_others_upstream();
3257 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3260 PBD::warning << string_compose (
3261 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3262 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3267 if (_solo_control->soloed_by_others_upstream()) {
3268 // ignore new connections (they're not propagated)
3270 _solo_control->mod_solo_by_others_upstream (delta);
3274 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3275 // solo-isolate currently only propagates downstream
3277 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3279 //_solo_isolated_by_upstream = ibou;
3282 // Session::route_solo_changed does not propagate indirect solo-changes
3283 // propagate downstream to tracks
3284 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3285 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3289 bool does_feed = feeds (*i, &sends_only);
3290 if (delta <= 0 && does_feed && !sends_only) {
3291 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3294 if (idelta < 0 && does_feed && !sends_only) {
3295 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3302 Route::output_change_handler (IOChange change, void * /*src*/)
3304 if (_initial_io_setup) {
3308 if ((change.type & IOChange::ConfigurationChanged)) {
3309 /* This is called with the process lock held if change
3310 contains ConfigurationChanged
3312 configure_processors (0);
3315 _session.reset_monitor_section();
3318 io_changed (); /* EMIT SIGNAL */
3321 if (_solo_control->soloed_by_others_downstream()) {
3323 /* checking all all downstream routes for
3324 * explicit of implict solo is a rather drastic measure,
3325 * ideally the input_change_handler() of the other route
3326 * would propagate the change to us.
3328 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3329 if (_output->connected()) {
3330 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3331 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3335 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3336 if (does_feed && !sends_only) {
3337 if ((*i)->soloed()) {
3344 int delta = sbod - _solo_control->soloed_by_others_downstream();
3346 // do not allow new connections to change implicit solo (no propagation)
3347 _solo_control->mod_solo_by_others_downstream (delta);
3348 // Session::route_solo_changed() does not propagate indirect solo-changes
3349 // propagate upstream to tracks
3350 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3351 if ((*i).get() == this || !can_solo()) {
3355 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3356 if (delta != 0 && does_feed && !sends_only) {
3357 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3366 Route::sidechain_change_handler (IOChange change, void* src)
3368 if (_initial_io_setup || _in_sidechain_setup) {
3372 input_change_handler (change, src);
3376 Route::pans_required () const
3378 if (n_outputs().n_audio() < 2) {
3382 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3386 Route::flush_processor_buffers_locked (framecnt_t nframes)
3388 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3389 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3391 d->flush_buffers (nframes);
3393 boost::shared_ptr<PortInsert> p = boost::dynamic_pointer_cast<PortInsert> (*i);
3395 p->flush_buffers (nframes);
3402 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3404 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3410 if (n_outputs().n_total() == 0) {
3414 if (!_active || n_inputs() == ChanCount::ZERO) {
3415 silence_unlocked (nframes);
3419 if (session_state_changing) {
3420 if (_session.transport_speed() != 0.0f) {
3421 /* we're rolling but some state is changing (e.g. our diskstream contents)
3422 so we cannot use them. Be silent till this is over.
3424 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3426 silence_unlocked (nframes);
3429 /* we're really not rolling, so we're either delivery silence or actually
3430 monitoring, both of which are safe to do while session_state_changing is true.
3434 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3436 fill_buffers_with_input (bufs, _input, nframes);
3438 if (_meter_point == MeterInput) {
3439 _meter->run (bufs, start_frame, end_frame, 0.0, nframes, true);
3442 _amp->apply_gain_automation (false);
3443 _trim->apply_gain_automation (false);
3444 passthru (bufs, start_frame, end_frame, nframes, 0);
3446 flush_processor_buffers_locked (nframes);
3452 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3454 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3459 if (n_outputs().n_total() == 0) {
3463 if (!_active || n_inputs().n_total() == 0) {
3464 silence_unlocked (nframes);
3468 framepos_t unused = 0;
3470 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3476 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3478 fill_buffers_with_input (bufs, _input, nframes);
3480 if (_meter_point == MeterInput) {
3481 _meter->run (bufs, start_frame, end_frame, 1.0, nframes, true);
3484 passthru (bufs, start_frame, end_frame, nframes, declick);
3486 flush_processor_buffers_locked (nframes);
3492 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3495 flush_processor_buffers_locked (nframes);
3500 Route::flush_processors ()
3502 /* XXX shouldn't really try to take this lock, since
3503 this is called from the RT audio thread.
3506 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3508 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3514 __attribute__((annotate("realtime")))
3517 Route::apply_processor_changes_rt ()
3519 int emissions = EmitNone;
3521 if (_pending_meter_point != _meter_point) {
3522 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3524 /* meters always have buffers for 'processor_max_streams'
3525 * they can be re-positioned without re-allocation */
3526 if (set_meter_point_unlocked()) {
3527 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3529 emissions |= EmitMeterChanged;
3534 bool changed = false;
3536 if (g_atomic_int_get (&_pending_process_reorder)) {
3537 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3539 apply_processor_order (_pending_processor_order);
3540 setup_invisible_processors ();
3542 g_atomic_int_set (&_pending_process_reorder, 0);
3543 emissions |= EmitRtProcessorChange;
3547 set_processor_positions ();
3549 if (emissions != 0) {
3550 g_atomic_int_set (&_pending_signals, emissions);
3553 return (!selfdestruct_sequence.empty ());
3557 Route::emit_pending_signals ()
3559 int sig = g_atomic_int_and (&_pending_signals, 0);
3560 if (sig & EmitMeterChanged) {
3561 _meter->emit_configuration_changed();
3562 meter_change (); /* EMIT SIGNAL */
3563 if (sig & EmitMeterVisibilityChange) {
3564 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3566 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3569 if (sig & EmitRtProcessorChange) {
3570 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3573 /* this would be a job for the butler.
3574 * Conceptually we should not take processe/processor locks here.
3575 * OTOH its more efficient (less overhead for summoning the butler and
3576 * telling her what do do) and signal emission is called
3577 * directly after the process callback, which decreases the chance
3578 * of x-runs when taking the locks.
3580 while (!selfdestruct_sequence.empty ()) {
3581 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3582 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3583 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3584 selfdestruct_sequence.pop_back ();
3587 remove_processor (proc);
3593 Route::set_meter_point (MeterPoint p, bool force)
3595 if (_pending_meter_point == p && !force) {
3599 if (force || !AudioEngine::instance()->running()) {
3600 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3601 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3602 _pending_meter_point = p;
3603 _meter->emit_configuration_changed();
3604 meter_change (); /* EMIT SIGNAL */
3605 if (set_meter_point_unlocked()) {
3606 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3608 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3611 _pending_meter_point = p;
3617 __attribute__((annotate("realtime")))
3620 Route::set_meter_point_unlocked ()
3623 /* Caller must hold process and processor write lock */
3624 assert (!AudioEngine::instance()->process_lock().trylock());
3625 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3626 assert (!lm.locked ());
3629 _meter_point = _pending_meter_point;
3631 bool meter_was_visible_to_user = _meter->display_to_user ();
3633 if (!_custom_meter_position_noted) {
3634 maybe_note_meter_position ();
3637 if (_meter_point != MeterCustom) {
3639 _meter->set_display_to_user (false);
3641 setup_invisible_processors ();
3644 _meter->set_display_to_user (true);
3646 /* If we have a previous position for the custom meter, try to put it there */
3647 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3649 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3650 if (i != _processors.end ()) {
3651 _processors.remove (_meter);
3652 _processors.insert (i, _meter);
3654 } else {// at end, right before the mains_out/panner
3655 _processors.remove (_meter);
3656 ProcessorList::iterator main = _processors.end();
3657 _processors.insert (--main, _meter);
3661 /* Set up the meter for its new position */
3663 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3667 if (loc == _processors.begin()) {
3668 m_in = _input->n_ports();
3670 ProcessorList::iterator before = loc;
3672 m_in = (*before)->output_streams ();
3675 _meter->reflect_inputs (m_in);
3677 /* we do not need to reconfigure the processors, because the meter
3678 (a) is always ready to handle processor_max_streams
3679 (b) is always an N-in/N-out processor, and thus moving
3680 it doesn't require any changes to the other processors.
3683 /* these should really be done after releasing the lock
3684 * but all those signals are subscribed to with gui_thread()
3687 return (_meter->display_to_user() != meter_was_visible_to_user);
3691 Route::listen_position_changed ()
3694 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3695 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3696 ProcessorState pstate (this);
3698 if (configure_processors_unlocked (0, &lm)) {
3699 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3701 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3706 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3707 _session.set_dirty ();
3710 boost::shared_ptr<CapturingProcessor>
3711 Route::add_export_point()
3713 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3714 if (!_capturing_processor) {
3716 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3717 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3719 // this aligns all tracks; but not tracks + busses
3720 assert (_session.worst_track_latency () >= _initial_delay);
3721 _capturing_processor.reset (new CapturingProcessor (_session, _session.worst_track_latency () - _initial_delay));
3722 _capturing_processor->activate ();
3724 configure_processors_unlocked (0, &lw);
3728 return _capturing_processor;
3732 Route::update_signal_latency ()
3734 framecnt_t l = _output->user_latency();
3735 framecnt_t lamp = 0;
3736 bool before_amp = true;
3737 framecnt_t ltrim = 0;
3738 bool before_trim = true;
3740 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3741 if ((*i)->active ()) {
3742 l += (*i)->signal_latency ();
3747 if ((*i) == _trim) {
3758 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3760 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3761 _signal_latency_at_amp_position = lamp;
3762 _signal_latency_at_trim_position = ltrim;
3764 if (_signal_latency != l) {
3765 _signal_latency = l;
3766 signal_latency_changed (); /* EMIT SIGNAL */
3769 return _signal_latency;
3773 Route::set_user_latency (framecnt_t nframes)
3775 _output->set_user_latency (nframes);
3776 _session.update_latency_compensation ();
3780 Route::set_latency_compensation (framecnt_t longest_session_latency)
3782 framecnt_t old = _initial_delay;
3784 if (_signal_latency < longest_session_latency) {
3785 _initial_delay = longest_session_latency - _signal_latency;
3790 DEBUG_TRACE (DEBUG::Latency, string_compose (
3791 "%1: compensate for maximum latency of %2,"
3792 "given own latency of %3, using initial delay of %4\n",
3793 name(), longest_session_latency, _signal_latency, _initial_delay));
3795 if (_initial_delay != old) {
3796 initial_delay_changed (); /* EMIT SIGNAL */
3799 if (_session.transport_stopped()) {
3800 _roll_delay = _initial_delay;
3805 Route::set_block_size (pframes_t nframes)
3807 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3808 (*i)->set_block_size (nframes);
3811 _session.ensure_buffers (n_process_buffers ());
3815 Route::protect_automation ()
3817 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3818 (*i)->protect_automation();
3821 /** @param declick 1 to set a pending declick fade-in,
3822 * -1 to set a pending declick fade-out
3825 Route::set_pending_declick (int declick)
3828 /* this call is not allowed to turn off a pending declick */
3830 _pending_declick = declick;
3833 _pending_declick = 0;
3837 /** Shift automation forwards from a particular place, thereby inserting time.
3838 * Adds undo commands for any shifts that are performed.
3840 * @param pos Position to start shifting from.
3841 * @param frames Amount to shift forwards by.
3845 Route::shift (framepos_t pos, framecnt_t frames)
3847 /* gain automation */
3849 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3851 XMLNode &before = gc->alist()->get_state ();
3852 gc->alist()->shift (pos, frames);
3853 XMLNode &after = gc->alist()->get_state ();
3854 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3857 /* gain automation */
3859 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3861 XMLNode &before = gc->alist()->get_state ();
3862 gc->alist()->shift (pos, frames);
3863 XMLNode &after = gc->alist()->get_state ();
3864 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3867 // TODO mute automation ??
3869 /* pan automation */
3871 ControlSet::Controls& c (_pannable->controls());
3873 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3874 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3876 boost::shared_ptr<AutomationList> al = pc->alist();
3877 XMLNode& before = al->get_state ();
3878 al->shift (pos, frames);
3879 XMLNode& after = al->get_state ();
3880 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3885 /* redirect automation */
3887 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3888 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3890 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3892 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3893 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3895 boost::shared_ptr<AutomationList> al = ac->alist();
3896 XMLNode &before = al->get_state ();
3897 al->shift (pos, frames);
3898 XMLNode &after = al->get_state ();
3899 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3907 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
3909 boost::shared_ptr<Processor> processor (p.lock ());
3910 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3914 pi->set_state_dir (d);
3918 Route::save_as_template (const string& path, const string& name)
3920 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
3921 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
3923 XMLNode& node (state (false));
3927 IO::set_name_in_state (*node.children().front(), name);
3929 tree.set_root (&node);
3931 /* return zero on success, non-zero otherwise */
3932 return !tree.write (path.c_str());
3937 Route::set_name (const string& str)
3939 if (str == name()) {
3943 string name = Route::ensure_track_or_route_name (str, _session);
3944 SessionObject::set_name (name);
3946 bool ret = (_input->set_name(name) && _output->set_name(name));
3949 /* rename the main outs. Leave other IO processors
3950 * with whatever name they already have, because its
3951 * just fine as it is (it will not contain the route
3952 * name if its a port insert, port send or port return).
3956 if (_main_outs->set_name (name)) {
3957 /* XXX returning false here is stupid because
3958 we already changed the route name.
3968 /** Set the name of a route in an XML description.
3969 * @param node XML <Route> node to set the name in.
3970 * @param name New name.
3973 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
3975 node.add_property (X_("name"), name);
3977 XMLNodeList children = node.children();
3978 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3980 if ((*i)->name() == X_("IO")) {
3982 IO::set_name_in_state (**i, name);
3984 } else if ((*i)->name() == X_("Processor")) {
3986 XMLProperty const * role = (*i)->property (X_("role"));
3987 if (role && role->value() == X_("Main")) {
3988 (*i)->add_property (X_("name"), name);
3991 } else if ((*i)->name() == X_("Diskstream")) {
3993 if (rename_playlist) {
3994 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3996 (*i)->add_property (X_("name"), name);
4002 boost::shared_ptr<Send>
4003 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4005 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4007 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4008 boost::shared_ptr<InternalSend> send;
4010 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4011 if (send->target_route() == target) {
4017 return boost::shared_ptr<Send>();
4021 Route::set_denormal_protection (bool yn)
4023 if (_denormal_protection != yn) {
4024 _denormal_protection = yn;
4025 denormal_protection_changed (); /* EMIT SIGNAL */
4030 Route::denormal_protection () const
4032 return _denormal_protection;
4036 Route::set_active (bool yn, void* src)
4038 if (_session.transport_rolling()) {
4042 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4043 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4047 if (_active != yn) {
4049 _input->set_active (yn);
4050 _output->set_active (yn);
4051 active_changed (); // EMIT SIGNAL
4052 _session.set_dirty ();
4056 boost::shared_ptr<Pannable>
4057 Route::pannable() const
4062 boost::shared_ptr<Panner>
4063 Route::panner() const
4066 return _main_outs->panner_shell()->panner();
4069 boost::shared_ptr<PannerShell>
4070 Route::panner_shell() const
4072 return _main_outs->panner_shell();
4075 boost::shared_ptr<GainControl>
4076 Route::gain_control() const
4078 return _gain_control;
4081 boost::shared_ptr<GainControl>
4082 Route::trim_control() const
4084 return _trim_control;
4087 boost::shared_ptr<PhaseControl>
4088 Route::phase_control() const
4090 return _phase_control;
4093 boost::shared_ptr<AutomationControl>
4094 Route::get_control (const Evoral::Parameter& param)
4096 /* either we own the control or .... */
4098 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4102 /* maybe one of our processors does or ... */
4104 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4105 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4106 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4114 /* nobody does so we'll make a new one */
4116 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4123 boost::shared_ptr<Processor>
4124 Route::nth_plugin (uint32_t n) const
4126 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4127 ProcessorList::const_iterator i;
4129 for (i = _processors.begin(); i != _processors.end(); ++i) {
4130 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4137 return boost::shared_ptr<Processor> ();
4140 boost::shared_ptr<Processor>
4141 Route::nth_send (uint32_t n) const
4143 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4144 ProcessorList::const_iterator i;
4146 for (i = _processors.begin(); i != _processors.end(); ++i) {
4147 if (boost::dynamic_pointer_cast<Send> (*i)) {
4149 if ((*i)->name().find (_("Monitor")) == 0) {
4150 /* send to monitor section is not considered
4151 to be an accessible send.
4162 return boost::shared_ptr<Processor> ();
4166 Route::has_io_processor_named (const string& name)
4168 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4169 ProcessorList::iterator i;
4171 for (i = _processors.begin(); i != _processors.end(); ++i) {
4172 if (boost::dynamic_pointer_cast<Send> (*i) ||
4173 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4174 if ((*i)->name() == name) {
4184 Route::set_processor_positions ()
4186 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4188 bool had_amp = false;
4189 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4190 (*i)->set_pre_fader (!had_amp);
4197 /** Called when there is a proposed change to the input port count */
4199 Route::input_port_count_changing (ChanCount to)
4201 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4203 /* The processors cannot be configured with the new input arrangement, so
4209 /* The change is ok */
4213 /** Called when there is a proposed change to the output port count */
4215 Route::output_port_count_changing (ChanCount to)
4217 if (_strict_io && !_in_configure_processors) {
4220 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4221 if (processor_out_streams.get(*t) > to.get(*t)) {
4225 /* The change is ok */
4230 Route::unknown_processors () const
4234 if (_session.get_disable_all_loaded_plugins ()) {
4235 // Do not list "missing plugins" if they are explicitly disabled
4239 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4240 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4241 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4242 p.push_back ((*i)->name ());
4251 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4253 /* we assume that all our input ports feed all our output ports. its not
4254 universally true, but the alternative is way too corner-case to worry about.
4257 LatencyRange all_connections;
4260 all_connections.min = 0;
4261 all_connections.max = 0;
4263 all_connections.min = ~((pframes_t) 0);
4264 all_connections.max = 0;
4266 /* iterate over all "from" ports and determine the latency range for all of their
4267 connections to the "outside" (outside of this Route).
4270 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4274 p->get_connected_latency_range (range, playback);
4276 all_connections.min = min (all_connections.min, range.min);
4277 all_connections.max = max (all_connections.max, range.max);
4281 /* set the "from" port latencies to the max/min range of all their connections */
4283 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4284 p->set_private_latency_range (all_connections, playback);
4287 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4289 all_connections.min += our_latency;
4290 all_connections.max += our_latency;
4292 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4293 p->set_private_latency_range (all_connections, playback);
4296 return all_connections.max;
4300 Route::set_private_port_latencies (bool playback) const
4302 framecnt_t own_latency = 0;
4304 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4305 OR LATENCY CALLBACK.
4307 This is called (early) from the latency callback. It computes the REAL
4308 latency associated with each port and stores the result as the "private"
4309 latency of the port. A later call to Route::set_public_port_latencies()
4310 sets all ports to the same value to reflect the fact that we do latency
4311 compensation and so all signals are delayed by the same amount as they
4312 flow through ardour.
4315 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4316 if ((*i)->active ()) {
4317 own_latency += (*i)->signal_latency ();
4322 /* playback: propagate latency from "outside the route" to outputs to inputs */
4323 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4325 /* capture: propagate latency from "outside the route" to inputs to outputs */
4326 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4331 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4333 /* this is called to set the JACK-visible port latencies, which take
4334 latency compensation into account.
4343 const PortSet& ports (_input->ports());
4344 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4345 p->set_public_latency_range (range, playback);
4350 const PortSet& ports (_output->ports());
4351 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4352 p->set_public_latency_range (range, playback);
4357 /** Put the invisible processors in the right place in _processors.
4358 * Must be called with a writer lock on _processor_lock held.
4361 __attribute__((annotate("realtime")))
4364 Route::setup_invisible_processors ()
4367 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4368 assert (!lm.locked ());
4372 /* too early to be doing this stuff */
4376 /* we'll build this new list here and then use it
4378 * TODO put the ProcessorList is on the stack for RT-safety.
4381 ProcessorList new_processors;
4383 /* find visible processors */
4385 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4386 if ((*i)->display_to_user ()) {
4387 new_processors.push_back (*i);
4393 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4395 if (amp == new_processors.end ()) {
4396 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4397 new_processors.push_front (_amp);
4398 amp = find (new_processors.begin(), new_processors.end(), _amp);
4401 /* and the processor after the amp */
4403 ProcessorList::iterator after_amp = amp;
4409 switch (_meter_point) {
4411 assert (!_meter->display_to_user ());
4412 new_processors.push_front (_meter);
4415 assert (!_meter->display_to_user ());
4416 new_processors.insert (amp, _meter);
4418 case MeterPostFader:
4419 /* do nothing here */
4422 /* do nothing here */
4425 /* the meter is visible, so we don't touch it here */
4432 assert (_main_outs);
4433 assert (!_main_outs->display_to_user ());
4434 new_processors.push_back (_main_outs);
4436 /* iterator for the main outs */
4438 ProcessorList::iterator main = new_processors.end();
4441 /* OUTPUT METERING */
4443 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4444 assert (!_meter->display_to_user ());
4446 /* add the processor just before or just after the main outs */
4448 ProcessorList::iterator meter_point = main;
4450 if (_meter_point == MeterOutput) {
4453 new_processors.insert (meter_point, _meter);
4458 if (_monitor_send && !is_monitor ()) {
4459 assert (!_monitor_send->display_to_user ());
4460 switch (Config->get_listen_position ()) {
4461 case PreFaderListen:
4462 switch (Config->get_pfl_position ()) {
4463 case PFLFromBeforeProcessors:
4464 new_processors.push_front (_monitor_send);
4466 case PFLFromAfterProcessors:
4467 new_processors.insert (amp, _monitor_send);
4470 _monitor_send->set_can_pan (false);
4472 case AfterFaderListen:
4473 switch (Config->get_afl_position ()) {
4474 case AFLFromBeforeProcessors:
4475 new_processors.insert (after_amp, _monitor_send);
4477 case AFLFromAfterProcessors:
4478 new_processors.insert (new_processors.end(), _monitor_send);
4481 _monitor_send->set_can_pan (true);
4486 #if 0 // not used - just yet
4487 if (!is_master() && !is_monitor() && !is_auditioner()) {
4488 new_processors.push_front (_delayline);
4492 /* MONITOR CONTROL */
4494 if (_monitor_control && is_monitor ()) {
4495 assert (!_monitor_control->display_to_user ());
4496 new_processors.insert (amp, _monitor_control);
4501 if (_trim && _trim->active()) {
4502 assert (!_trim->display_to_user ());
4503 new_processors.push_front (_trim);
4506 /* INTERNAL RETURN */
4508 /* doing this here means that any monitor control will come after
4509 the return and trim.
4513 assert (!_intreturn->display_to_user ());
4514 new_processors.push_front (_intreturn);
4517 /* EXPORT PROCESSOR */
4519 if (_capturing_processor) {
4520 assert (!_capturing_processor->display_to_user ());
4521 new_processors.push_front (_capturing_processor);
4524 _processors = new_processors;
4526 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4527 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4528 (*i)->enable (true);
4532 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4533 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4534 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4541 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4542 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4546 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4547 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4554 /** If the meter point is `Custom', make a note of where the meter is.
4555 * This is so that if the meter point is subsequently set to something else,
4556 * and then back to custom, we can put the meter back where it was last time
4557 * custom was enabled.
4559 * Must be called with the _processor_lock held.
4562 Route::maybe_note_meter_position ()
4564 if (_meter_point != MeterCustom) {
4568 _custom_meter_position_noted = true;
4569 /* custom meter points range from after trim to before panner/main_outs
4570 * this is a limitation by the current processor UI
4572 bool seen_trim = false;
4573 _processor_after_last_custom_meter.reset();
4574 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4575 if ((*i) == _trim) {
4578 if ((*i) == _main_outs) {
4579 _processor_after_last_custom_meter = *i;
4582 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4584 _processor_after_last_custom_meter = _trim;
4586 ProcessorList::iterator j = i;
4588 assert(j != _processors.end ()); // main_outs should be before
4589 _processor_after_last_custom_meter = *j;
4594 assert(_processor_after_last_custom_meter.lock());
4597 boost::shared_ptr<Processor>
4598 Route::processor_by_id (PBD::ID id) const
4600 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4601 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4602 if ((*i)->id() == id) {
4607 return boost::shared_ptr<Processor> ();
4610 /** @return the monitoring state, or in other words what data we are pushing
4611 * into the route (data from the inputs, data from disk or silence)
4614 Route::monitoring_state () const
4616 return MonitoringInput;
4619 /** @return what we should be metering; either the data coming from the input
4620 * IO or the data that is flowing through the route.
4623 Route::metering_state () const
4625 return MeteringRoute;
4629 Route::has_external_redirects () const
4631 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4633 /* ignore inactive processors and obviously ignore the main
4634 * outs since everything has them and we don't care.
4637 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4645 boost::shared_ptr<Processor>
4646 Route::the_instrument () const
4648 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4649 return the_instrument_unlocked ();
4652 boost::shared_ptr<Processor>
4653 Route::the_instrument_unlocked () const
4655 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4656 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4657 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4661 return boost::shared_ptr<Processor>();
4667 Route::non_realtime_locate (framepos_t pos)
4670 _pannable->transport_located (pos);
4673 if (_delayline.get()) {
4674 _delayline.get()->flush();
4678 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4679 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4681 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4682 (*i)->transport_located (pos);
4685 _roll_delay = _initial_delay;
4689 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4696 * We don't currently mix MIDI input together, so we don't need the
4697 * complex logic of the audio case.
4700 n_buffers = bufs.count().n_midi ();
4702 for (i = 0; i < n_buffers; ++i) {
4704 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4705 MidiBuffer& buf (bufs.get_midi (i));
4708 buf.copy (source_port->get_midi_buffer(nframes));
4710 buf.silence (nframes);
4716 n_buffers = bufs.count().n_audio();
4718 size_t n_ports = io->n_ports().n_audio();
4719 float scaling = 1.0f;
4721 if (n_ports > n_buffers) {
4722 scaling = ((float) n_buffers) / n_ports;
4725 for (i = 0; i < n_ports; ++i) {
4727 /* if there are more ports than buffers, map them onto buffers
4728 * in a round-robin fashion
4731 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4732 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4735 if (i < n_buffers) {
4737 /* first time through just copy a channel into
4741 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4743 if (scaling != 1.0f) {
4744 buf.apply_gain (scaling, nframes);
4749 /* on subsequent times around, merge data from
4750 * the port with what is already there
4753 if (scaling != 1.0f) {
4754 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4756 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4761 /* silence any remaining buffers */
4763 for (; i < n_buffers; ++i) {
4764 AudioBuffer& buf (bufs.get_audio (i));
4765 buf.silence (nframes);
4768 /* establish the initial setup of the buffer set, reflecting what was
4769 copied into it. unless, of course, we are the auditioner, in which
4770 case nothing was fed into it from the inputs at all.
4773 if (!is_auditioner()) {
4774 bufs.set_count (io->n_ports());
4778 boost::shared_ptr<AutomationControl>
4779 Route::pan_azimuth_control() const
4782 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4784 return boost::shared_ptr<AutomationControl>();
4786 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4787 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4789 if (!_pannable || !panner()) {
4790 return boost::shared_ptr<AutomationControl>();
4792 return _pannable->pan_azimuth_control;
4796 boost::shared_ptr<AutomationControl>
4797 Route::pan_elevation_control() const
4799 if (Profile->get_mixbus() || !_pannable || !panner()) {
4800 return boost::shared_ptr<AutomationControl>();
4803 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4805 if (c.find (PanElevationAutomation) != c.end()) {
4806 return _pannable->pan_elevation_control;
4808 return boost::shared_ptr<AutomationControl>();
4811 boost::shared_ptr<AutomationControl>
4812 Route::pan_width_control() const
4814 if (Profile->get_mixbus() || !_pannable || !panner()) {
4815 return boost::shared_ptr<AutomationControl>();
4818 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4820 if (c.find (PanWidthAutomation) != c.end()) {
4821 return _pannable->pan_width_control;
4823 return boost::shared_ptr<AutomationControl>();
4826 boost::shared_ptr<AutomationControl>
4827 Route::pan_frontback_control() const
4829 if (Profile->get_mixbus() || !_pannable || !panner()) {
4830 return boost::shared_ptr<AutomationControl>();
4833 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4835 if (c.find (PanFrontBackAutomation) != c.end()) {
4836 return _pannable->pan_frontback_control;
4838 return boost::shared_ptr<AutomationControl>();
4841 boost::shared_ptr<AutomationControl>
4842 Route::pan_lfe_control() const
4844 if (Profile->get_mixbus() || !_pannable || !panner()) {
4845 return boost::shared_ptr<AutomationControl>();
4848 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4850 if (c.find (PanLFEAutomation) != c.end()) {
4851 return _pannable->pan_lfe_control;
4853 return boost::shared_ptr<AutomationControl>();
4858 Route::eq_band_cnt () const
4860 if (Profile->get_mixbus()) {
4863 /* Ardour has no well-known EQ object */
4868 boost::shared_ptr<AutomationControl>
4869 Route::eq_gain_controllable (uint32_t band) const
4872 boost::shared_ptr<PluginInsert> eq = ch_eq();
4875 return boost::shared_ptr<AutomationControl>();
4878 uint32_t port_number;
4881 if (is_master() || mixbus()) {
4888 if (is_master() || mixbus()) {
4895 if (is_master() || mixbus()) {
4902 return boost::shared_ptr<AutomationControl>();
4905 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4907 return boost::shared_ptr<AutomationControl>();
4910 boost::shared_ptr<AutomationControl>
4911 Route::eq_freq_controllable (uint32_t band) const
4915 if (mixbus() || is_master()) {
4916 /* no frequency controls for mixbusses or master */
4917 return boost::shared_ptr<AutomationControl>();
4920 boost::shared_ptr<PluginInsert> eq = ch_eq();
4923 return boost::shared_ptr<AutomationControl>();
4926 uint32_t port_number;
4938 return boost::shared_ptr<AutomationControl>();
4941 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4943 return boost::shared_ptr<AutomationControl>();
4947 boost::shared_ptr<AutomationControl>
4948 Route::eq_q_controllable (uint32_t band) const
4950 return boost::shared_ptr<AutomationControl>();
4953 boost::shared_ptr<AutomationControl>
4954 Route::eq_shape_controllable (uint32_t band) const
4956 return boost::shared_ptr<AutomationControl>();
4959 boost::shared_ptr<AutomationControl>
4960 Route::eq_enable_controllable () const
4963 boost::shared_ptr<PluginInsert> eq = ch_eq();
4966 return boost::shared_ptr<AutomationControl>();
4969 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
4971 return boost::shared_ptr<AutomationControl>();
4975 boost::shared_ptr<AutomationControl>
4976 Route::eq_hpf_controllable () const
4979 boost::shared_ptr<PluginInsert> eq = ch_eq();
4982 return boost::shared_ptr<AutomationControl>();
4985 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
4987 return boost::shared_ptr<AutomationControl>();
4992 Route::eq_band_name (uint32_t band) const
4994 if (Profile->get_mixbus()) {
5010 boost::shared_ptr<AutomationControl>
5011 Route::comp_enable_controllable () const
5014 boost::shared_ptr<PluginInsert> comp = ch_comp();
5017 return boost::shared_ptr<AutomationControl>();
5020 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5022 return boost::shared_ptr<AutomationControl>();
5025 boost::shared_ptr<AutomationControl>
5026 Route::comp_threshold_controllable () const
5029 boost::shared_ptr<PluginInsert> comp = ch_comp();
5032 return boost::shared_ptr<AutomationControl>();
5035 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5038 return boost::shared_ptr<AutomationControl>();
5041 boost::shared_ptr<AutomationControl>
5042 Route::comp_speed_controllable () const
5045 boost::shared_ptr<PluginInsert> comp = ch_comp();
5048 return boost::shared_ptr<AutomationControl>();
5051 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5053 return boost::shared_ptr<AutomationControl>();
5056 boost::shared_ptr<AutomationControl>
5057 Route::comp_mode_controllable () const
5060 boost::shared_ptr<PluginInsert> comp = ch_comp();
5063 return boost::shared_ptr<AutomationControl>();
5066 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5068 return boost::shared_ptr<AutomationControl>();
5071 boost::shared_ptr<AutomationControl>
5072 Route::comp_makeup_controllable () const
5075 boost::shared_ptr<PluginInsert> comp = ch_comp();
5078 return boost::shared_ptr<AutomationControl>();
5081 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5083 return boost::shared_ptr<AutomationControl>();
5086 boost::shared_ptr<AutomationControl>
5087 Route::comp_redux_controllable () const
5090 boost::shared_ptr<PluginInsert> comp = ch_comp();
5093 return boost::shared_ptr<AutomationControl>();
5096 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5098 return boost::shared_ptr<AutomationControl>();
5103 Route::comp_mode_name (uint32_t mode) const
5108 return _("Leveler");
5110 return _("Compressor");
5112 return _("Limiter");
5114 return mixbus() ? _("Sidechain") : _("Limiter");
5124 Route::comp_speed_name (uint32_t mode) const
5142 boost::shared_ptr<AutomationControl>
5143 Route::send_level_controllable (uint32_t n) const
5146 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5148 return boost::shared_ptr<AutomationControl>();
5153 return boost::shared_ptr<AutomationControl>();
5156 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5157 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5159 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5161 return boost::shared_ptr<AutomationControl>();
5163 return s->gain_control ();
5167 boost::shared_ptr<AutomationControl>
5168 Route::send_enable_controllable (uint32_t n) const
5171 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5173 return boost::shared_ptr<AutomationControl>();
5178 return boost::shared_ptr<AutomationControl>();
5181 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5182 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5184 /* although Ardour sends have enable/disable as part of the Processor
5185 API, it is not exposed as a controllable.
5187 XXX: we should fix this.
5189 return boost::shared_ptr<AutomationControl>();
5194 Route::send_name (uint32_t n) const
5200 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5204 boost::shared_ptr<Processor> p = nth_send (n);
5213 boost::shared_ptr<AutomationControl>
5214 Route::master_send_enable_controllable () const
5217 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5219 return boost::shared_ptr<AutomationControl>();
5221 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5223 return boost::shared_ptr<AutomationControl>();
5228 Route::slaved () const
5230 if (!_gain_control) {
5233 /* just test one particular control, not all of them */
5234 return _gain_control->slaved ();
5238 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5240 if (!vca || !_gain_control) {
5244 /* just test one particular control, not all of them */
5246 return _gain_control->slaved_to (vca->gain_control());
5250 Route::muted_by_others_soloing () const
5252 if (!can_be_muted_by_others ()) {
5256 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5260 Route::clear_all_solo_state ()
5262 double v = _solo_safe_control->get_value ();
5264 _solo_control->clear_all_solo_state ();
5267 _solo_safe_control->set_value (v, Controllable::NoGroup);