2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "libardour-config.h"
29 #include <boost/algorithm/string.hpp>
31 #include "pbd/xml++.h"
32 #include "pbd/enumwriter.h"
33 #include "pbd/memento_command.h"
34 #include "pbd/stacktrace.h"
35 #include "pbd/convert.h"
36 #include "pbd/unwind.h"
38 #include "ardour/amp.h"
39 #include "ardour/audio_buffer.h"
40 #include "ardour/audio_track.h"
41 #include "ardour/audio_port.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/boost_debug.h"
44 #include "ardour/buffer.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/capturing_processor.h"
47 #include "ardour/debug.h"
48 #include "ardour/delivery.h"
49 #include "ardour/gain_control.h"
50 #include "ardour/internal_return.h"
51 #include "ardour/internal_send.h"
52 #include "ardour/meter.h"
53 #include "ardour/delayline.h"
54 #include "ardour/midi_buffer.h"
55 #include "ardour/midi_port.h"
56 #include "ardour/monitor_processor.h"
57 #include "ardour/pannable.h"
58 #include "ardour/panner.h"
59 #include "ardour/panner_shell.h"
60 #include "ardour/parameter_descriptor.h"
61 #include "ardour/phase_control.h"
62 #include "ardour/plugin_insert.h"
63 #include "ardour/port.h"
64 #include "ardour/port_insert.h"
65 #include "ardour/processor.h"
66 #include "ardour/profile.h"
67 #include "ardour/route.h"
68 #include "ardour/route_group.h"
69 #include "ardour/send.h"
70 #include "ardour/session.h"
71 #include "ardour/solo_control.h"
72 #include "ardour/solo_isolate_control.h"
73 #include "ardour/unknown_processor.h"
74 #include "ardour/utils.h"
75 #include "ardour/vca.h"
80 using namespace ARDOUR;
83 PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, Route::PluginSetupOptions > Route::PluginSetup;
85 /** Base class for all routable/mixable objects (tracks and busses) */
86 Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType default_type)
87 : Stripable (sess, name, PresentationInfo (flag))
88 , GraphNode (sess._process_graph)
89 , Muteable (sess, name)
93 , _signal_latency_at_amp_position (0)
94 , _signal_latency_at_trim_position (0)
97 , _pending_process_reorder (0)
98 , _pending_signals (0)
99 , _pending_declick (true)
100 , _meter_point (MeterPostFader)
101 , _pending_meter_point (MeterPostFader)
102 , _meter_type (MeterPeak)
103 , _denormal_protection (false)
106 , _declickable (false)
107 , _have_internal_generator (false)
108 , _default_type (default_type)
110 , _in_configure_processors (false)
111 , _initial_io_setup (false)
112 , _in_sidechain_setup (false)
114 , _custom_meter_position_noted (false)
117 processor_max_streams.reset();
123 /* set default meter type */
125 _meter_type = Config->get_meter_type_master ();
127 else if (dynamic_cast<Track*>(this)) {
128 _meter_type = Config->get_meter_type_track ();
130 _meter_type = Config->get_meter_type_bus ();
133 /* add standard controls */
135 _gain_control.reset (new GainControl (_session, GainAutomation));
136 add_control (_gain_control);
138 _trim_control.reset (new GainControl (_session, TrimAutomation));
139 add_control (_trim_control);
141 _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
142 add_control (_solo_control);
143 _solo_control->Changed.connect_same_thread (*this, boost::bind (&Route::solo_control_changed, this, _1, _2));
145 _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
146 add_control (_mute_control);
148 _phase_control.reset (new PhaseControl (_session, X_("phase")));
149 add_control (_phase_control);
151 _solo_isolate_control.reset (new SoloIsolateControl (_session, X_("solo-iso"), *this, *this));
152 add_control (_solo_isolate_control);
154 _solo_safe_control.reset (new SoloSafeControl (_session, X_("solo-safe")));
155 add_control (_solo_safe_control);
159 if (!(_presentation_info.flags() & PresentationInfo::MonitorOut)) {
160 _pannable.reset (new Pannable (_session));
163 /* input and output objects */
165 _input.reset (new IO (_session, _name, IO::Input, _default_type));
166 _output.reset (new IO (_session, _name, IO::Output, _default_type));
168 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
169 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
171 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
172 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
174 /* add the amp/fader processor.
175 * it should be the first processor to be added on every route.
178 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
179 add_processor (_amp, PostFader);
182 _amp->set_display_name (_("Monitor"));
185 #if 0 // not used - just yet
186 if (!is_master() && !is_monitor() && !is_auditioner()) {
187 _delayline.reset (new DelayLine (_session, _name));
188 add_processor (_delayline, PreFader);
194 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
195 _trim->set_display_to_user (false);
197 if (dynamic_cast<AudioTrack*>(this)) {
198 /* we can't do this in the AudioTrack's constructor
199 * because _trim does not exit then
203 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
208 /* create standard processors: meter, main outs, monitor out;
209 they will be added to _processors by setup_invisible_processors ()
212 _meter.reset (new PeakMeter (_session, _name));
213 _meter->set_owner (this);
214 _meter->set_display_to_user (false);
217 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
218 _main_outs->activate ();
221 /* where we listen to tracks */
222 _intreturn.reset (new InternalReturn (_session));
223 _intreturn->activate ();
225 /* the thing that provides proper control over a control/monitor/listen bus
226 (such as per-channel cut, dim, solo, invert, etc).
228 _monitor_control.reset (new MonitorProcessor (_session));
229 _monitor_control->activate ();
232 if (is_master() || is_monitor() || is_auditioner()) {
233 _mute_master->set_solo_ignore (true);
236 /* now that we have _meter, its safe to connect to this */
239 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
240 configure_processors (0);
248 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
250 /* do this early so that we don't get incoming signals as we are going through destruction
255 /* don't use clear_processors here, as it depends on the session which may
256 be half-destroyed by now
259 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
260 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
261 (*i)->drop_references ();
264 _processors.clear ();
268 Route::ensure_track_or_route_name(string name, Session &session)
270 string newname = name;
272 while (!session.io_name_is_legal (newname)) {
273 newname = bump_name_once (newname, ' ');
280 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
282 // TODO route group, see set_gain()
283 // _trim_control->route_set_value (val);
287 Route::maybe_declick (BufferSet&, framecnt_t, int)
289 /* this is the "bus" implementation and they never declick.
294 /** Process this route for one (sub) cycle (process thread)
296 * @param bufs Scratch buffers to use for the signal path
297 * @param start_frame Initial transport frame
298 * @param end_frame Final transport frame
299 * @param nframes Number of frames to output (to ports)
301 * Note that (end_frame - start_frame) may not be equal to nframes when the
302 * transport speed isn't 1.0 (eg varispeed).
305 Route::process_output_buffers (BufferSet& bufs,
306 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
307 int declick, bool gain_automation_ok)
309 /* Caller must hold process lock */
310 assert (!AudioEngine::instance()->process_lock().trylock());
312 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
314 // can this actually happen? functions calling process_output_buffers()
315 // already take a reader-lock.
316 bufs.silence (nframes, 0);
320 _mute_control->automation_run (start_frame, nframes);
322 /* figure out if we're going to use gain automation */
323 if (gain_automation_ok) {
324 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
325 _amp->setup_gain_automation (
326 start_frame + _signal_latency_at_amp_position,
327 end_frame + _signal_latency_at_amp_position,
330 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
331 _trim->setup_gain_automation (
332 start_frame + _signal_latency_at_trim_position,
333 end_frame + _signal_latency_at_trim_position,
336 _amp->apply_gain_automation (false);
337 _trim->apply_gain_automation (false);
340 /* Tell main outs what to do about monitoring. We do this so that
341 on a transition between monitoring states we get a de-clicking gain
342 change in the _main_outs delivery, if config.get_use_monitor_fades()
345 We override this in the case where we have an internal generator.
347 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
349 _main_outs->no_outs_cuz_we_no_monitor (silence);
351 /* -------------------------------------------------------------------------------------------
352 GLOBAL DECLICK (for transport changes etc.)
353 ----------------------------------------------------------------------------------------- */
355 maybe_declick (bufs, nframes, declick);
356 _pending_declick = 0;
358 /* -------------------------------------------------------------------------------------------
359 DENORMAL CONTROL/PHASE INVERT
360 ----------------------------------------------------------------------------------------- */
362 if (!_phase_control->none()) {
366 if (_denormal_protection || Config->get_denormal_protection()) {
368 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
369 Sample* const sp = i->data();
371 if (_phase_control->inverted (chn)) {
372 for (pframes_t nx = 0; nx < nframes; ++nx) {
377 for (pframes_t nx = 0; nx < nframes; ++nx) {
385 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
386 Sample* const sp = i->data();
388 if (_phase_control->inverted (chn)) {
389 for (pframes_t nx = 0; nx < nframes; ++nx) {
398 if (_denormal_protection || Config->get_denormal_protection()) {
400 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
401 Sample* const sp = i->data();
402 for (pframes_t nx = 0; nx < nframes; ++nx) {
410 /* -------------------------------------------------------------------------------------------
412 ----------------------------------------------------------------------------------------- */
414 /* set this to be true if the meter will already have been ::run() earlier */
415 bool const meter_already_run = metering_state() == MeteringInput;
417 framecnt_t latency = 0;
418 const double speed = _session.transport_speed ();
420 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
422 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
423 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
428 /* if it has any inputs, make sure they match */
429 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
430 if (bufs.count() != (*i)->input_streams()) {
432 DEBUG::Processors, string_compose (
433 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
434 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
441 /* should we NOT run plugins here if the route is inactive?
442 do we catch route != active somewhere higher?
445 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
446 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
448 if (boost::dynamic_pointer_cast<PluginInsert>(*i) != 0) {
449 const framecnt_t longest_session_latency = _initial_delay + _signal_latency;
450 boost::dynamic_pointer_cast<PluginInsert>(*i)->set_sidechain_latency (
451 _initial_delay + latency, longest_session_latency - latency);
454 (*i)->run (bufs, start_frame - latency, end_frame - latency, speed, nframes, *i != _processors.back());
455 bufs.set_count ((*i)->output_streams());
457 if ((*i)->active ()) {
458 latency += (*i)->signal_latency ();
464 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
465 boost::shared_ptr<Processor> endpoint,
466 bool include_endpoint, bool for_export, bool for_freeze)
468 /* If no processing is required, there's no need to go any further. */
469 if (!endpoint && !include_endpoint) {
473 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
474 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
475 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
477 /* trim is always at the top, for bounce no latency compensation is needed */
478 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
479 _trim->setup_gain_automation (start, start + nframes, nframes);
482 const double speed = _session.transport_speed ();
483 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
485 if (!include_endpoint && (*i) == endpoint) {
489 /* if we're *not* exporting, stop processing if we come across a routing processor. */
490 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
493 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
497 /* special case the panner (export outputs)
498 * Ideally we'd only run the panner, not the delivery itself...
499 * but panners need separate input/output buffers and some context
500 * (panshell, panner type, etc). AFAICT there is no ill side effect
501 * of re-using the main delivery when freewheeling/exporting a region.
503 if ((*i) == _main_outs) {
504 assert ((*i)->does_routing());
505 (*i)->run (buffers, start - latency, start - latency + nframes, speed, nframes, true);
506 buffers.set_count ((*i)->output_streams());
509 /* don't run any processors that do routing.
510 * Also don't bother with metering.
512 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
513 (*i)->run (buffers, start - latency, start - latency + nframes, 1.0, nframes, true);
514 buffers.set_count ((*i)->output_streams());
515 latency += (*i)->signal_latency ();
518 if ((*i) == endpoint) {
525 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
526 bool include_endpoint, bool for_export, bool for_freeze) const
528 framecnt_t latency = 0;
529 if (!endpoint && !include_endpoint) {
533 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
534 if (!include_endpoint && (*i) == endpoint) {
537 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
540 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
543 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
544 latency += (*i)->signal_latency ();
546 if ((*i) == endpoint) {
554 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
555 bool include_endpoint, bool for_export, bool for_freeze) const
557 if (!endpoint && !include_endpoint) {
561 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
562 if (!include_endpoint && (*i) == endpoint) {
565 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
568 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
571 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
572 cc = (*i)->output_streams();
574 if ((*i) == endpoint) {
582 Route::n_process_buffers ()
584 return max (_input->n_ports(), processor_max_streams);
588 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
590 assert (is_monitor());
591 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
592 fill_buffers_with_input (bufs, _input, nframes);
593 passthru (bufs, start_frame, end_frame, nframes, declick);
597 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
601 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
603 /* control/monitor bus ignores input ports when something is
604 feeding the listen "stream". data will "arrive" into the
605 route from the intreturn processor element.
608 bufs.silence (nframes, 0);
611 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
612 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
616 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
618 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
620 bufs.set_count (_input->n_ports());
621 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
622 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
626 Route::set_listen (bool yn)
630 _monitor_send->activate ();
632 _monitor_send->deactivate ();
638 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
640 /* nothing to do if we're not using AFL/PFL. But if we are, we need
641 to alter the active state of the monitor send.
644 if (Config->get_solo_control_is_listen_control ()) {
645 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
650 Route::push_solo_isolate_upstream (int32_t delta)
652 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
654 boost::shared_ptr<RouteList> routes = _session.get_routes ();
655 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
657 if ((*i).get() == this || !(*i)->can_solo()) {
662 bool does_feed = feeds (*i, &sends_only);
664 if (does_feed && !sends_only) {
665 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
671 Route::push_solo_upstream (int delta)
673 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
674 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
678 boost::shared_ptr<Route> sr (i->r.lock());
680 sr->solo_control()->mod_solo_by_others_downstream (-delta);
687 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
689 cerr << name << " {" << endl;
690 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
691 p != procs.end(); ++p) {
692 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
698 /** Supposing that we want to insert a Processor at a given Placement, return
699 * the processor to add the new one before (or 0 to add at the end).
701 boost::shared_ptr<Processor>
702 Route::before_processor_for_placement (Placement p)
704 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
706 ProcessorList::iterator loc;
709 /* generic pre-fader: insert immediately before the amp */
710 loc = find (_processors.begin(), _processors.end(), _amp);
712 /* generic post-fader: insert right before the main outs */
713 loc = find (_processors.begin(), _processors.end(), _main_outs);
716 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
719 /** Supposing that we want to insert a Processor at a given index, return
720 * the processor to add the new one before (or 0 to add at the end).
722 boost::shared_ptr<Processor>
723 Route::before_processor_for_index (int index)
726 return boost::shared_ptr<Processor> ();
729 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
731 ProcessorList::iterator i = _processors.begin ();
733 while (i != _processors.end() && j < index) {
734 if ((*i)->display_to_user()) {
741 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
744 /** Add a processor either pre- or post-fader
745 * @return 0 on success, non-0 on failure.
748 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
750 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
754 /** Add a processor to a route such that it ends up with a given index into the visible processors.
755 * @param index Index to add the processor at, or -1 to add at the end of the list.
756 * @return 0 on success, non-0 on failure.
759 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
761 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
764 /** Add a processor to the route.
765 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
766 * @return 0 on success, non-0 on failure.
769 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
771 assert (processor != _meter);
772 assert (processor != _main_outs);
774 DEBUG_TRACE (DEBUG::Processors, string_compose (
775 "%1 adding processor %2\n", name(), processor->name()));
779 pl.push_back (processor);
780 int rv = add_processors (pl, before, err);
786 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
787 processor->activate ();
794 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
796 /* We cannot destruct the processor here (usually RT-thread
797 * with various locks held - in case of sends also io_locks).
798 * Queue for deletion in low-priority thread.
800 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
801 selfdestruct_sequence.push_back (wp);
805 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
807 XMLProperty const * prop;
810 boost::shared_ptr<Processor> processor;
812 /* bit of a hack: get the `placement' property from the <Redirect> tag here
813 so that we can add the processor in the right place (pre/post-fader)
816 XMLNodeList const & children = node.children ();
817 XMLNodeList::const_iterator i = children.begin ();
819 while (i != children.end() && (*i)->name() != X_("Redirect")) {
823 Placement placement = PreFader;
825 if (i != children.end()) {
826 if ((prop = (*i)->property (X_("placement"))) != 0) {
827 placement = Placement (string_2_enum (prop->value(), placement));
831 if (node.name() == "Insert") {
833 if ((prop = node.property ("type")) != 0) {
835 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
836 prop->value() == "lv2" ||
837 prop->value() == "windows-vst" ||
838 prop->value() == "lxvst" ||
839 prop->value() == "audiounit") {
841 if (_session.get_disable_all_loaded_plugins ()) {
842 processor.reset (new UnknownProcessor (_session, node));
844 processor.reset (new PluginInsert (_session));
845 processor->set_owner (this);
850 processor.reset (new PortInsert (_session, _pannable, _mute_master));
855 } else if (node.name() == "Send") {
857 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
858 processor.reset (new Send (_session, sendpan, _mute_master));
862 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
866 if (processor->set_state (node, version)) {
870 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
871 if (i != children.end()) {
872 if ((prop = (*i)->property (X_("active"))) != 0) {
873 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
874 processor->activate();
876 processor->deactivate();
880 return (add_processor (processor, placement, 0, false) == 0);
883 catch (failed_constructor &err) {
884 warning << _("processor could not be created. Ignored.") << endmsg;
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));
894 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
895 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
899 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
901 ProcessorList::iterator loc;
904 loc = find(_processors.begin(), _processors.end(), before);
905 if (loc == _processors.end ()) {
909 /* nothing specified - at end */
910 loc = _processors.end ();
913 if (!AudioEngine::instance()->connected()) {
917 if (others.empty()) {
921 ProcessorList to_skip;
923 // check if there's an instrument to replace or configure
924 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
925 boost::shared_ptr<PluginInsert> pi;
926 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
929 if (!pi->plugin ()->get_info ()->is_instrument ()) {
932 boost::shared_ptr<Processor> instrument = the_instrument ();
933 ChanCount in (DataType::MIDI, 1);
934 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
936 PluginSetupOptions flags = None;
939 in = instrument->input_streams ();
940 out = instrument->output_streams ();
942 if (pi->has_output_presets (in, out)) {
946 pi->set_strict_io (_strict_io);
948 PluginSetupOptions mask = None;
949 if (Config->get_ask_replace_instrument ()) {
952 if (Config->get_ask_setup_instrument ()) {
959 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
960 switch (rv.get_value_or (0)) {
962 to_skip.push_back (*i); // don't add this one;
965 replace_processor (instrument, *i, err);
966 to_skip.push_back (*i);
975 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
976 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
977 ProcessorState pstate (this);
979 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
984 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
985 if (check != to_skip.end()) {
989 boost::shared_ptr<PluginInsert> pi;
991 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
992 pi->set_strict_io (_strict_io);
996 /* Ensure that only one amp is in the list at any time */
997 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
998 if (check != _processors.end()) {
999 if (before == _amp) {
1000 /* Already in position; all is well */
1003 _processors.erase (check);
1008 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1010 _processors.insert (loc, *i);
1011 (*i)->set_owner (this);
1014 if (configure_processors_unlocked (err, &lm)) {
1016 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1021 if ((*i)->active()) {
1022 // why? emit ActiveChanged() ??
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 ()) {
1640 /* ..but at least as many as there are master-inputs */
1641 // XXX this may need special-casing for mixbus (master-outputs)
1642 // and should maybe be a preference anyway ?!
1643 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1649 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1650 configuration.push_back(make_pair(in, out));
1653 // restriction for Monitor Section Processors
1654 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1655 /* do not allow to add/remove channels (for now)
1656 * The Monitor follows the master-bus and has no panner (unpan)
1657 * but do allow processors with midi-in to be added (e.g VSTs with control that
1658 * will remain unconnected)
1660 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration not allowed.\n");
1661 return list<pair<ChanCount, ChanCount> > ();
1663 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1664 // internal sends make no sense, only feedback
1665 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1666 return list<pair<ChanCount, ChanCount> > ();
1668 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1669 /* External Sends can be problematic. one can add/remove ports
1670 * there signal leaves the DAW to external monitors anyway, so there's
1671 * no real use for allowing them here anyway.
1673 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1674 return list<pair<ChanCount, ChanCount> > ();
1676 if (boost::dynamic_pointer_cast<Send> (*p)) {
1678 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1679 return list<pair<ChanCount, ChanCount> > ();
1688 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1689 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1690 DEBUG_TRACE (DEBUG::Processors, "}\n");
1691 return list<pair<ChanCount, ChanCount> > ();
1695 DEBUG_TRACE (DEBUG::Processors, "}\n");
1697 return configuration;
1700 /** Set the input/output configuration of each processor in the processors list.
1701 * Caller must hold process lock.
1702 * Return 0 on success, otherwise configuration is impossible.
1705 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1707 #ifndef PLATFORM_WINDOWS
1708 assert (!AudioEngine::instance()->process_lock().trylock());
1711 if (_in_configure_processors) {
1715 /* put invisible processors where they should be */
1716 setup_invisible_processors ();
1718 _in_configure_processors = true;
1720 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1722 if (configuration.empty ()) {
1723 _in_configure_processors = false;
1728 bool seen_mains_out = false;
1729 processor_out_streams = _input->n_ports();
1730 processor_max_streams.reset();
1732 /* processor configure_io() may result in adding ports
1733 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1735 * with jack2 adding ports results in a graph-order callback,
1736 * which calls Session::resort_routes() and eventually
1737 * Route::direct_feeds_according_to_reality()
1738 * which takes a ReaderLock (_processor_lock).
1740 * so we can't hold a WriterLock here until jack2 threading
1743 * NB. we still hold the process lock
1745 * (ardour's own engines do call graph-order from the
1746 * process-thread and hence do not have this issue; besides
1747 * merely adding ports won't trigger a graph-order, only
1748 * making connections does)
1752 // TODO check for a potential ReaderLock after ReaderLock ??
1753 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1755 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1756 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1758 if (!(*p)->configure_io(c->first, c->second)) {
1759 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1760 _in_configure_processors = false;
1765 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1766 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1768 boost::shared_ptr<IOProcessor> iop;
1769 boost::shared_ptr<PluginInsert> pi;
1770 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1771 /* plugins connected via Split or Hide Match may have more channels.
1772 * route/scratch buffers are needed for all of them
1773 * The configuration may only be a subset (both input and output)
1775 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1777 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1778 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1779 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1783 if (boost::dynamic_pointer_cast<Delivery> (*p)
1784 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1785 /* main delivery will increase port count to match input.
1786 * the Delivery::Main is usually the last processor - followed only by
1789 seen_mains_out = true;
1791 if (!seen_mains_out) {
1792 processor_out_streams = out;
1801 _meter->set_max_channels (processor_max_streams);
1804 /* make sure we have sufficient scratch buffers to cope with the new processor
1807 _session.ensure_buffers (n_process_buffers ());
1809 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1811 _in_configure_processors = false;
1815 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1816 * @param state New active state for those processors.
1819 Route::all_visible_processors_active (bool state)
1821 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1823 if (_processors.empty()) {
1827 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1828 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1831 (*i)->enable (state);
1834 _session.set_dirty ();
1838 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
1840 /* check if re-order requires re-configuration of any processors
1841 * -> compare channel configuration for all processors
1843 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1844 ChanCount c = input_streams ();
1846 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
1848 if (c != (*j)->input_streams()) {
1851 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1854 if ((*i)->input_streams() != c) {
1857 c = (*i)->output_streams();
1869 __attribute__((annotate("realtime")))
1872 Route::apply_processor_order (const ProcessorList& new_order)
1874 /* need to hold processor_lock; either read or write lock
1875 * and the engine process_lock.
1876 * Due to r/w lock ambiguity we can only assert the latter
1878 assert (!AudioEngine::instance()->process_lock().trylock());
1881 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1882 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1883 * processors in the current actual processor list that are hidden. Any visible processors
1884 * in the current list but not in "new_order" will be assumed to be deleted.
1887 /* "as_it_will_be" and "_processors" are lists of shared pointers.
1888 * actual memory usage is small, but insert/erase is not actually rt-safe :(
1889 * (note though that ::processors_reorder_needs_configure() ensured that
1890 * this function will only ever be called from the rt-thread if no processor were removed)
1892 * either way, I can't proove it, but an x-run due to re-order here is less likley
1893 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
1896 ProcessorList as_it_will_be;
1897 ProcessorList::iterator oiter;
1898 ProcessorList::const_iterator niter;
1900 oiter = _processors.begin();
1901 niter = new_order.begin();
1903 while (niter != new_order.end()) {
1905 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1906 then append it to the temp list.
1908 Otherwise, see if the next processor in the old list is in the new list. if not,
1909 its been deleted. If its there, append it to the temp list.
1912 if (oiter == _processors.end()) {
1914 /* no more elements in the old list, so just stick the rest of
1915 the new order onto the temp list.
1918 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1919 while (niter != new_order.end()) {
1926 if (!(*oiter)->display_to_user()) {
1928 as_it_will_be.push_back (*oiter);
1932 /* visible processor: check that its in the new order */
1934 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1935 /* deleted: do nothing, shared_ptr<> will clean up */
1937 /* ignore this one, and add the next item from the new order instead */
1938 as_it_will_be.push_back (*niter);
1943 /* now remove from old order - its taken care of no matter what */
1944 oiter = _processors.erase (oiter);
1948 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1950 /* If the meter is in a custom position, find it and make a rough note of its position */
1951 maybe_note_meter_position ();
1955 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1957 // it a change is already queued, wait for it
1958 // (unless engine is stopped. apply immediately and proceed
1959 while (g_atomic_int_get (&_pending_process_reorder)) {
1960 if (!AudioEngine::instance()->running()) {
1961 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
1962 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1964 apply_processor_order(_pending_processor_order);
1965 setup_invisible_processors ();
1967 g_atomic_int_set (&_pending_process_reorder, 0);
1969 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1970 set_processor_positions ();
1972 // TODO rather use a semaphore or something.
1973 // but since ::reorder_processors() is called
1974 // from the GUI thread, this is fine..
1979 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
1981 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1982 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1983 ProcessorState pstate (this);
1985 apply_processor_order (new_order);
1987 if (configure_processors_unlocked (err, &lm)) {
1995 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1996 set_processor_positions ();
1999 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2000 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2002 // _pending_processor_order is protected by _processor_lock
2003 _pending_processor_order = new_order;
2004 g_atomic_int_set (&_pending_process_reorder, 1);
2011 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2013 boost::shared_ptr<PluginInsert> pi;
2014 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2018 if (pi->has_sidechain () == add) {
2019 return true; // ?? call failed, but result is as expected.
2023 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2024 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2025 if (i == _processors.end ()) {
2031 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2032 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2033 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2035 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2037 if (!pi->add_sidechain ()) {
2041 if (!pi->del_sidechain ()) {
2047 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2052 pi->del_sidechain ();
2054 pi->add_sidechain ();
2055 // TODO restore side-chain's state.
2060 configure_processors_unlocked (0, &lm);
2063 if (pi->has_sidechain ()) {
2064 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2067 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2068 _session.set_dirty ();
2073 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2075 boost::shared_ptr<PluginInsert> pi;
2076 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2081 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2082 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2083 if (i == _processors.end ()) {
2089 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2090 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2092 const ChanCount& old (pi->preset_out ());
2093 if (!pi->set_preset_out (outs)) {
2094 return true; // no change, OK
2097 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2100 pi->set_preset_out (old);
2103 configure_processors_unlocked (0, &lm);
2106 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2107 _session.set_dirty ();
2112 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2115 return customize_plugin_insert (proc, 0, unused, unused);
2119 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2121 boost::shared_ptr<PluginInsert> pi;
2122 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2127 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2128 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2129 if (i == _processors.end ()) {
2135 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2136 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2138 bool old_cust = pi->custom_cfg ();
2139 uint32_t old_cnt = pi->get_count ();
2140 ChanCount old_chan = pi->output_streams ();
2141 ChanCount old_sinks = pi->natural_input_streams ();
2144 pi->set_custom_cfg (false);
2146 pi->set_custom_cfg (true);
2147 pi->set_count (count);
2148 pi->set_outputs (outs);
2149 pi->set_sinks (sinks);
2152 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2156 pi->set_count (old_cnt);
2157 pi->set_sinks (old_sinks);
2158 pi->set_outputs (old_chan);
2159 pi->set_custom_cfg (old_cust);
2163 configure_processors_unlocked (0, &lm);
2166 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2167 _session.set_dirty ();
2172 Route::set_strict_io (const bool enable)
2174 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2176 if (_strict_io != enable) {
2177 _strict_io = enable;
2178 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2179 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2180 boost::shared_ptr<PluginInsert> pi;
2181 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2182 pi->set_strict_io (_strict_io);
2186 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2190 _strict_io = !enable; // restore old value
2191 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2192 boost::shared_ptr<PluginInsert> pi;
2193 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2194 pi->set_strict_io (_strict_io);
2201 configure_processors (0);
2204 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2205 _session.set_dirty ();
2217 Route::get_template()
2219 return state(false);
2223 Route::state(bool full_state)
2226 if (!_session._template_state_dir.empty()) {
2227 assert (!full_state); // only for templates
2228 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2231 XMLNode *node = new XMLNode("Route");
2232 ProcessorList::iterator i;
2235 id().print (buf, sizeof (buf));
2236 node->add_property("id", buf);
2237 node->add_property ("name", _name);
2238 node->add_property("default-type", _default_type.to_string());
2239 node->add_property ("strict-io", _strict_io);
2241 node->add_child_nocopy (_presentation_info.get_state());
2243 node->add_property("active", _active?"yes":"no");
2245 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2246 node->add_property("meter-point", enum_2_string (_meter_point));
2248 node->add_property("meter-type", enum_2_string (_meter_type));
2251 node->add_property("route-group", _route_group->name());
2254 node->add_child_nocopy (_solo_control->get_state ());
2255 node->add_child_nocopy (_solo_isolate_control->get_state ());
2256 node->add_child_nocopy (_solo_safe_control->get_state ());
2258 node->add_child_nocopy (_input->state (full_state));
2259 node->add_child_nocopy (_output->state (full_state));
2260 node->add_child_nocopy (_mute_master->get_state ());
2262 node->add_child_nocopy (_mute_control->get_state ());
2263 node->add_child_nocopy (_phase_control->get_state ());
2266 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2269 if (_comment.length()) {
2270 XMLNode *cmt = node->add_child ("Comment");
2271 cmt->add_content (_comment);
2275 node->add_child_nocopy (_pannable->state (full_state));
2279 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2280 for (i = _processors.begin(); i != _processors.end(); ++i) {
2282 /* template save: do not include internal sends functioning as
2283 aux sends because the chance of the target ID
2284 in the session where this template is used
2287 similarly, do not save listen sends which connect to
2288 the monitor section, because these will always be
2291 boost::shared_ptr<InternalSend> is;
2293 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2294 if (is->role() == Delivery::Listen) {
2299 node->add_child_nocopy((*i)->state (full_state));
2304 node->add_child_copy (*_extra_xml);
2307 if (_custom_meter_position_noted) {
2308 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2310 after->id().print (buf, sizeof (buf));
2311 node->add_property (X_("processor-after-last-custom-meter"), buf);
2315 if (!_session._template_state_dir.empty()) {
2316 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2319 node->add_child_copy (Slavable::get_state());
2325 Route::set_state (const XMLNode& node, int version)
2327 if (version < 3000) {
2328 return set_state_2X (node, version);
2332 XMLNodeConstIterator niter;
2334 XMLProperty const * prop;
2336 if (node.name() != "Route"){
2337 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2341 if ((prop = node.property (X_("name"))) != 0) {
2342 Route::set_name (prop->value());
2346 _initial_io_setup = true;
2348 Stripable::set_state (node, version);
2350 if ((prop = node.property (X_("strict-io"))) != 0) {
2351 _strict_io = string_is_affirmative (prop->value());
2355 _mute_master->set_solo_ignore (true);
2359 /* monitor bus does not get a panner, but if (re)created
2360 via XML, it will already have one by the time we
2361 call ::set_state(). so ... remove it.
2366 /* add all processors (except amp, which is always present) */
2368 nlist = node.children();
2369 XMLNode processor_state (X_("processor_state"));
2371 Stateful::save_extra_xml (node);
2373 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2377 if (child->name() == IO::state_node_name) {
2378 if ((prop = child->property (X_("direction"))) == 0) {
2382 if (prop->value() == "Input") {
2383 _input->set_state (*child, version);
2384 } else if (prop->value() == "Output") {
2385 _output->set_state (*child, version);
2388 } else if (child->name() == X_("Processor")) {
2389 processor_state.add_child_copy (*child);
2390 } else if (child->name() == X_("Pannable")) {
2392 _pannable->set_state (*child, version);
2394 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2396 } else if (child->name() == Controllable::xml_node_name) {
2397 if ((prop = child->property (X_("name"))) == 0) {
2401 if (prop->value() == _gain_control->name()) {
2402 _gain_control->set_state (*child, version);
2403 } else if (prop->value() == _solo_control->name()) {
2404 _solo_control->set_state (*child, version);
2405 } else if (prop->value() == _solo_safe_control->name()) {
2406 _solo_safe_control->set_state (*child, version);
2407 } else if (prop->value() == _solo_isolate_control->name()) {
2408 _solo_isolate_control->set_state (*child, version);
2409 } else if (prop->value() == _solo_control->name()) {
2410 _mute_control->set_state (*child, version);
2412 } else if (child->name() == Slavable::xml_node_name) {
2413 Slavable::set_state (*child, version);
2417 if ((prop = node.property (X_("meter-point"))) != 0) {
2418 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2419 set_meter_point (mp, true);
2421 _meter->set_display_to_user (_meter_point == MeterCustom);
2425 if ((prop = node.property (X_("meter-type"))) != 0) {
2426 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2429 _initial_io_setup = false;
2431 set_processor_state (processor_state);
2433 // this looks up the internal instrument in processors
2434 reset_instrument_info();
2436 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2437 set_denormal_protection (string_is_affirmative (prop->value()));
2440 if ((prop = node.property (X_("active"))) != 0) {
2441 bool yn = string_is_affirmative (prop->value());
2442 set_active (yn, this);
2445 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2446 PBD::ID id (prop->value ());
2447 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2448 ProcessorList::const_iterator i = _processors.begin ();
2449 while (i != _processors.end() && (*i)->id() != id) {
2453 if (i != _processors.end ()) {
2454 _processor_after_last_custom_meter = *i;
2455 _custom_meter_position_noted = true;
2459 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2462 if (child->name() == X_("Comment")) {
2464 /* XXX this is a terrible API design in libxml++ */
2466 XMLNode *cmt = *(child->children().begin());
2467 _comment = cmt->content();
2469 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2470 if (prop->value() == "solo") {
2471 _solo_control->set_state (*child, version);
2472 } else if (prop->value() == "mute") {
2473 _mute_control->set_state (*child, version);
2476 } else if (child->name() == MuteMaster::xml_node_name) {
2477 _mute_master->set_state (*child, version);
2479 } else if (child->name() == Automatable::xml_node_name) {
2480 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2488 Route::set_state_2X (const XMLNode& node, int version)
2492 XMLNodeConstIterator niter;
2494 XMLProperty const * prop;
2496 /* 2X things which still remain to be handled:
2502 if (node.name() != "Route") {
2503 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2507 Stripable::set_state (node, version);
2509 if (is_master() || is_monitor() || is_auditioner()) {
2510 _mute_master->set_solo_ignore (true);
2513 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2514 set_denormal_protection (string_is_affirmative (prop->value()));
2517 if ((prop = node.property (X_("muted"))) != 0) {
2520 bool muted = string_is_affirmative (prop->value());
2526 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2528 if (string_is_affirmative (prop->value())){
2529 mute_point = mute_point + "PreFader";
2534 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2536 if (string_is_affirmative (prop->value())){
2539 mute_point = mute_point + ",";
2542 mute_point = mute_point + "PostFader";
2547 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2549 if (string_is_affirmative (prop->value())){
2552 mute_point = mute_point + ",";
2555 mute_point = mute_point + "Listen";
2560 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2562 if (string_is_affirmative (prop->value())){
2565 mute_point = mute_point + ",";
2568 mute_point = mute_point + "Main";
2572 _mute_master->set_mute_points (mute_point);
2573 _mute_master->set_muted_by_self (true);
2577 if ((prop = node.property (X_("meter-point"))) != 0) {
2578 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2583 nlist = node.children ();
2584 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2588 if (child->name() == IO::state_node_name) {
2590 /* there is a note in IO::set_state_2X() about why we have to call
2594 _input->set_state_2X (*child, version, true);
2595 _output->set_state_2X (*child, version, false);
2597 if ((prop = child->property (X_("name"))) != 0) {
2598 Route::set_name (prop->value ());
2603 if ((prop = child->property (X_("active"))) != 0) {
2604 bool yn = string_is_affirmative (prop->value());
2605 _active = !yn; // force switch
2606 set_active (yn, this);
2609 if ((prop = child->property (X_("gain"))) != 0) {
2612 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2613 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2617 /* Set up Panners in the IO */
2618 XMLNodeList io_nlist = child->children ();
2620 XMLNodeConstIterator io_niter;
2623 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2625 io_child = *io_niter;
2627 if (io_child->name() == X_("Panner")) {
2628 _main_outs->panner_shell()->set_state(*io_child, version);
2629 } else if (io_child->name() == X_("Automation")) {
2630 /* IO's automation is for the fader */
2631 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2637 XMLNodeList redirect_nodes;
2639 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2643 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2644 redirect_nodes.push_back(child);
2649 set_processor_state_2X (redirect_nodes, version);
2651 Stateful::save_extra_xml (node);
2653 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2656 if (child->name() == X_("Comment")) {
2658 /* XXX this is a terrible API design in libxml++ */
2660 XMLNode *cmt = *(child->children().begin());
2661 _comment = cmt->content();
2663 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2664 if (prop->value() == X_("solo")) {
2665 _solo_control->set_state (*child, version);
2666 } else if (prop->value() == X_("mute")) {
2667 _mute_control->set_state (*child, version);
2677 Route::get_processor_state ()
2679 XMLNode* root = new XMLNode (X_("redirects"));
2680 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2681 root->add_child_nocopy ((*i)->state (true));
2688 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2690 /* We don't bother removing existing processors not in nList, as this
2691 method will only be called when creating a Route from scratch, not
2692 for undo purposes. Just put processors in at the appropriate place
2696 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2697 add_processor_from_xml_2X (**i, version);
2702 Route::set_processor_state (const XMLNode& node)
2704 const XMLNodeList &nlist = node.children();
2705 XMLNodeConstIterator niter;
2706 ProcessorList new_order;
2707 bool must_configure = false;
2709 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2711 XMLProperty* prop = (*niter)->property ("type");
2713 if (prop->value() == "amp") {
2714 _amp->set_state (**niter, Stateful::current_state_version);
2715 new_order.push_back (_amp);
2716 } else if (prop->value() == "trim") {
2717 _trim->set_state (**niter, Stateful::current_state_version);
2718 new_order.push_back (_trim);
2719 } else if (prop->value() == "meter") {
2720 _meter->set_state (**niter, Stateful::current_state_version);
2721 new_order.push_back (_meter);
2722 } else if (prop->value() == "delay") {
2724 _delayline->set_state (**niter, Stateful::current_state_version);
2725 new_order.push_back (_delayline);
2727 } else if (prop->value() == "main-outs") {
2728 _main_outs->set_state (**niter, Stateful::current_state_version);
2729 } else if (prop->value() == "intreturn") {
2731 _intreturn.reset (new InternalReturn (_session));
2732 must_configure = true;
2734 _intreturn->set_state (**niter, Stateful::current_state_version);
2735 } else if (is_monitor() && prop->value() == "monitor") {
2736 if (!_monitor_control) {
2737 _monitor_control.reset (new MonitorProcessor (_session));
2738 must_configure = true;
2740 _monitor_control->set_state (**niter, Stateful::current_state_version);
2741 } else if (prop->value() == "capture") {
2742 /* CapturingProcessor should never be restored, it's always
2743 added explicitly when needed */
2745 ProcessorList::iterator o;
2747 for (o = _processors.begin(); o != _processors.end(); ++o) {
2748 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2749 if (id_prop && (*o)->id() == id_prop->value()) {
2750 (*o)->set_state (**niter, Stateful::current_state_version);
2751 new_order.push_back (*o);
2756 // If the processor (*niter) is not on the route then create it
2758 if (o == _processors.end()) {
2760 boost::shared_ptr<Processor> processor;
2762 if (prop->value() == "intsend") {
2764 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2766 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2767 prop->value() == "lv2" ||
2768 prop->value() == "windows-vst" ||
2769 prop->value() == "lxvst" ||
2770 prop->value() == "luaproc" ||
2771 prop->value() == "audiounit") {
2773 if (_session.get_disable_all_loaded_plugins ()) {
2774 processor.reset (new UnknownProcessor (_session, **niter));
2776 processor.reset (new PluginInsert (_session));
2777 processor->set_owner (this);
2779 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2780 pi->set_strict_io (true);
2784 } else if (prop->value() == "port") {
2786 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2788 } else if (prop->value() == "send") {
2790 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2791 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2792 send->SelfDestruct.connect_same_thread (*this,
2793 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2796 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2800 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2801 /* This processor could not be configured. Turn it into a UnknownProcessor */
2802 processor.reset (new UnknownProcessor (_session, **niter));
2805 /* subscribe to Sidechain IO changes */
2806 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2807 if (pi && pi->has_sidechain ()) {
2808 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2811 /* we have to note the monitor send here, otherwise a new one will be created
2812 and the state of this one will be lost.
2814 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2815 if (isend && isend->role() == Delivery::Listen) {
2816 _monitor_send = isend;
2819 /* it doesn't matter if invisible processors are added here, as they
2820 will be sorted out by setup_invisible_processors () shortly.
2823 new_order.push_back (processor);
2824 must_configure = true;
2830 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2831 /* re-assign _processors w/o process-lock.
2832 * if there's an IO-processor present in _processors but
2833 * not in new_order, it will be deleted and ~IO takes
2836 _processors = new_order;
2837 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2839 if (must_configure) {
2840 configure_processors_unlocked (0, &lm);
2843 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2845 (*i)->set_owner (this);
2846 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2848 boost::shared_ptr<PluginInsert> pi;
2850 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2851 if (pi->has_no_inputs ()) {
2852 _have_internal_generator = true;
2859 reset_instrument_info ();
2860 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2861 set_processor_positions ();
2865 Route::curve_reallocate ()
2867 // _gain_automation_curve.finish_resize ();
2868 // _pan_automation_curve.finish_resize ();
2872 Route::silence (framecnt_t nframes)
2874 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2879 silence_unlocked (nframes);
2883 Route::silence_unlocked (framecnt_t nframes)
2885 /* Must be called with the processor lock held */
2887 const framepos_t now = _session.transport_frame ();
2891 _output->silence (nframes);
2893 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2894 boost::shared_ptr<PluginInsert> pi;
2896 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2897 // skip plugins, they don't need anything when we're not active
2901 (*i)->silence (nframes, now);
2904 if (nframes == _session.get_block_size()) {
2911 Route::add_internal_return ()
2914 _intreturn.reset (new InternalReturn (_session));
2915 add_processor (_intreturn, PreFader);
2920 Route::add_send_to_internal_return (InternalSend* send)
2922 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2924 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2925 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2928 return d->add_send (send);
2934 Route::remove_send_from_internal_return (InternalSend* send)
2936 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2938 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2939 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2942 return d->remove_send (send);
2948 Route::enable_monitor_send ()
2950 /* Caller must hold process lock */
2951 assert (!AudioEngine::instance()->process_lock().trylock());
2953 /* master never sends to monitor section via the normal mechanism */
2954 assert (!is_master ());
2955 assert (!is_monitor ());
2957 /* make sure we have one */
2958 if (!_monitor_send) {
2959 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
2960 _monitor_send->set_display_to_user (false);
2964 configure_processors (0);
2967 /** Add an aux send to a route.
2968 * @param route route to send to.
2969 * @param before Processor to insert before, or 0 to insert at the end.
2972 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2974 assert (route != _session.monitor_out ());
2977 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2979 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2981 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2983 if (d && d->target_route() == route) {
2984 /* already listening via the specified IO: do nothing */
2992 boost::shared_ptr<InternalSend> listener;
2995 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2996 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2997 listener.reset (new InternalSend (_session, sendpan, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3000 add_processor (listener, before);
3002 } catch (failed_constructor& err) {
3010 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3012 ProcessorStreams err;
3013 ProcessorList::iterator tmp;
3016 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3018 /* have to do this early because otherwise processor reconfig
3019 * will put _monitor_send back in the list
3022 if (route == _session.monitor_out()) {
3023 _monitor_send.reset ();
3027 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3029 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3031 if (d && d->target_route() == route) {
3033 if (remove_processor (*x, &err, false) > 0) {
3039 /* list could have been demolished while we dropped the lock
3042 if (_session.engine().connected()) {
3043 /* i/o processors cannot be removed if the engine is not running
3044 * so don't live-loop in case the engine is N/A or dies
3054 Route::set_comment (string cmt, void *src)
3058 _session.set_dirty ();
3062 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3064 FeedRecord fr (other, via_sends_only);
3066 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3068 if (!result.second) {
3070 /* already a record for "other" - make sure sends-only information is correct */
3071 if (!via_sends_only && result.first->sends_only) {
3072 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3073 frp->sends_only = false;
3077 return result.second;
3081 Route::clear_fed_by ()
3087 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3089 const FedBy& fed_by (other->fed_by());
3091 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3092 boost::shared_ptr<Route> sr = f->r.lock();
3094 if (sr && (sr.get() == this)) {
3096 if (via_sends_only) {
3097 *via_sends_only = f->sends_only;
3108 Route::all_inputs () const
3110 /* TODO, if this works as expected,
3111 * cache the IOVector and maintain it via
3112 * input_change_handler(), sidechain_change_handler() etc
3115 ios.push_back (_input);
3117 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3118 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3120 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3121 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3124 iop = pi->sidechain();
3127 if (iop != 0 && iop->input()) {
3128 ios.push_back (iop->input());
3135 Route::all_outputs () const
3138 // _output is included via Delivery
3139 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3140 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3141 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3142 if (iop != 0 && iop->output()) {
3143 ios.push_back (iop->output());
3150 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3152 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3153 if (other->all_inputs().fed_by (_output)) {
3154 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3155 if (via_send_only) {
3156 *via_send_only = false;
3162 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3164 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3166 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3167 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3170 iop = pi->sidechain();
3174 boost::shared_ptr<const IO> iop_out = iop->output();
3175 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3176 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3177 if (via_send_only) {
3178 *via_send_only = true;
3182 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3185 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3190 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3195 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3197 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3201 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3203 return _session._current_route_graph.feeds (shared_from_this (), other);
3206 /** Called from the (non-realtime) butler thread when the transport is stopped */
3208 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3210 framepos_t now = _session.transport_frame();
3213 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3215 Automatable::transport_stopped (now);
3217 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3219 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3223 (*i)->transport_stopped (now);
3227 _roll_delay = _initial_delay;
3231 Route::input_change_handler (IOChange change, void * /*src*/)
3233 if ((change.type & IOChange::ConfigurationChanged)) {
3234 /* This is called with the process lock held if change
3235 contains ConfigurationChanged
3237 configure_processors (0);
3238 _phase_control->resize (_input->n_ports().n_audio ());
3239 io_changed (); /* EMIT SIGNAL */
3242 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3245 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3246 if (_input->connected()) {
3247 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3248 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3252 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3253 if (does_feed && !sends_only) {
3254 if ((*i)->soloed()) {
3257 if ((*i)->solo_isolate_control()->solo_isolated()) {
3264 int delta = sbou - _solo_control->soloed_by_others_upstream();
3265 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3268 PBD::warning << string_compose (
3269 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3270 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3275 if (_solo_control->soloed_by_others_upstream()) {
3276 // ignore new connections (they're not propagated)
3278 _solo_control->mod_solo_by_others_upstream (delta);
3282 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3283 // solo-isolate currently only propagates downstream
3285 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3287 //_solo_isolated_by_upstream = ibou;
3290 // Session::route_solo_changed does not propagate indirect solo-changes
3291 // propagate downstream to tracks
3292 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3293 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3297 bool does_feed = feeds (*i, &sends_only);
3298 if (delta <= 0 && does_feed && !sends_only) {
3299 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3302 if (idelta < 0 && does_feed && !sends_only) {
3303 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3310 Route::output_change_handler (IOChange change, void * /*src*/)
3312 if (_initial_io_setup) {
3316 if ((change.type & IOChange::ConfigurationChanged)) {
3317 /* This is called with the process lock held if change
3318 contains ConfigurationChanged
3320 configure_processors (0);
3323 _session.reset_monitor_section();
3326 io_changed (); /* EMIT SIGNAL */
3329 if (_solo_control->soloed_by_others_downstream()) {
3331 /* checking all all downstream routes for
3332 * explicit of implict solo is a rather drastic measure,
3333 * ideally the input_change_handler() of the other route
3334 * would propagate the change to us.
3336 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3337 if (_output->connected()) {
3338 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3339 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3343 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3344 if (does_feed && !sends_only) {
3345 if ((*i)->soloed()) {
3352 int delta = sbod - _solo_control->soloed_by_others_downstream();
3354 // do not allow new connections to change implicit solo (no propagation)
3355 _solo_control->mod_solo_by_others_downstream (delta);
3356 // Session::route_solo_changed() does not propagate indirect solo-changes
3357 // propagate upstream to tracks
3358 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3359 if ((*i).get() == this || !can_solo()) {
3363 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3364 if (delta != 0 && does_feed && !sends_only) {
3365 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3374 Route::sidechain_change_handler (IOChange change, void* src)
3376 if (_initial_io_setup || _in_sidechain_setup) {
3380 input_change_handler (change, src);
3384 Route::pans_required () const
3386 if (n_outputs().n_audio() < 2) {
3390 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3394 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3396 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3402 if (n_outputs().n_total() == 0) {
3406 if (!_active || n_inputs() == ChanCount::ZERO) {
3407 silence_unlocked (nframes);
3411 if (session_state_changing) {
3412 if (_session.transport_speed() != 0.0f) {
3413 /* we're rolling but some state is changing (e.g. our diskstream contents)
3414 so we cannot use them. Be silent till this is over.
3416 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3418 silence_unlocked (nframes);
3421 /* we're really not rolling, so we're either delivery silence or actually
3422 monitoring, both of which are safe to do while session_state_changing is true.
3426 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3428 fill_buffers_with_input (bufs, _input, nframes);
3430 if (_meter_point == MeterInput) {
3431 _meter->run (bufs, start_frame, end_frame, 0.0, nframes, true);
3434 _amp->apply_gain_automation (false);
3435 _trim->apply_gain_automation (false);
3436 passthru (bufs, start_frame, end_frame, nframes, 0);
3438 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3439 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3441 d->flush_buffers (nframes);
3448 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3450 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3455 if (n_outputs().n_total() == 0) {
3459 if (!_active || n_inputs().n_total() == 0) {
3460 silence_unlocked (nframes);
3464 framepos_t unused = 0;
3466 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3472 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3474 fill_buffers_with_input (bufs, _input, nframes);
3476 if (_meter_point == MeterInput) {
3477 _meter->run (bufs, start_frame, end_frame, 1.0, nframes, true);
3480 passthru (bufs, start_frame, end_frame, nframes, declick);
3482 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3483 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3485 d->flush_buffers (nframes);
3492 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3499 Route::flush_processors ()
3501 /* XXX shouldn't really try to take this lock, since
3502 this is called from the RT audio thread.
3505 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3507 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3513 __attribute__((annotate("realtime")))
3516 Route::apply_processor_changes_rt ()
3518 int emissions = EmitNone;
3520 if (_pending_meter_point != _meter_point) {
3521 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3523 /* meters always have buffers for 'processor_max_streams'
3524 * they can be re-positioned without re-allocation */
3525 if (set_meter_point_unlocked()) {
3526 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3528 emissions |= EmitMeterChanged;
3533 bool changed = false;
3535 if (g_atomic_int_get (&_pending_process_reorder)) {
3536 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3538 apply_processor_order (_pending_processor_order);
3539 setup_invisible_processors ();
3541 g_atomic_int_set (&_pending_process_reorder, 0);
3542 emissions |= EmitRtProcessorChange;
3546 set_processor_positions ();
3548 if (emissions != 0) {
3549 g_atomic_int_set (&_pending_signals, emissions);
3552 return (!selfdestruct_sequence.empty ());
3556 Route::emit_pending_signals ()
3558 int sig = g_atomic_int_and (&_pending_signals, 0);
3559 if (sig & EmitMeterChanged) {
3560 _meter->emit_configuration_changed();
3561 meter_change (); /* EMIT SIGNAL */
3562 if (sig & EmitMeterVisibilityChange) {
3563 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3565 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3568 if (sig & EmitRtProcessorChange) {
3569 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3572 /* this would be a job for the butler.
3573 * Conceptually we should not take processe/processor locks here.
3574 * OTOH its more efficient (less overhead for summoning the butler and
3575 * telling her what do do) and signal emission is called
3576 * directly after the process callback, which decreases the chance
3577 * of x-runs when taking the locks.
3579 while (!selfdestruct_sequence.empty ()) {
3580 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3581 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3582 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3583 selfdestruct_sequence.pop_back ();
3586 remove_processor (proc);
3592 Route::set_meter_point (MeterPoint p, bool force)
3594 if (_pending_meter_point == p && !force) {
3598 if (force || !AudioEngine::instance()->running()) {
3599 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3600 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3601 _pending_meter_point = p;
3602 _meter->emit_configuration_changed();
3603 meter_change (); /* EMIT SIGNAL */
3604 if (set_meter_point_unlocked()) {
3605 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3607 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3610 _pending_meter_point = p;
3616 __attribute__((annotate("realtime")))
3619 Route::set_meter_point_unlocked ()
3622 /* Caller must hold process and processor write lock */
3623 assert (!AudioEngine::instance()->process_lock().trylock());
3624 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3625 assert (!lm.locked ());
3628 _meter_point = _pending_meter_point;
3630 bool meter_was_visible_to_user = _meter->display_to_user ();
3632 if (!_custom_meter_position_noted) {
3633 maybe_note_meter_position ();
3636 if (_meter_point != MeterCustom) {
3638 _meter->set_display_to_user (false);
3640 setup_invisible_processors ();
3643 _meter->set_display_to_user (true);
3645 /* If we have a previous position for the custom meter, try to put it there */
3646 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3648 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3649 if (i != _processors.end ()) {
3650 _processors.remove (_meter);
3651 _processors.insert (i, _meter);
3653 } else {// at end, right before the mains_out/panner
3654 _processors.remove (_meter);
3655 ProcessorList::iterator main = _processors.end();
3656 _processors.insert (--main, _meter);
3660 /* Set up the meter for its new position */
3662 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3666 if (loc == _processors.begin()) {
3667 m_in = _input->n_ports();
3669 ProcessorList::iterator before = loc;
3671 m_in = (*before)->output_streams ();
3674 _meter->reflect_inputs (m_in);
3676 /* we do not need to reconfigure the processors, because the meter
3677 (a) is always ready to handle processor_max_streams
3678 (b) is always an N-in/N-out processor, and thus moving
3679 it doesn't require any changes to the other processors.
3682 /* these should really be done after releasing the lock
3683 * but all those signals are subscribed to with gui_thread()
3686 return (_meter->display_to_user() != meter_was_visible_to_user);
3690 Route::listen_position_changed ()
3693 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3694 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3695 ProcessorState pstate (this);
3697 if (configure_processors_unlocked (0, &lm)) {
3698 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3700 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3705 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3706 _session.set_dirty ();
3709 boost::shared_ptr<CapturingProcessor>
3710 Route::add_export_point()
3712 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3713 if (!_capturing_processor) {
3715 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3716 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3718 _capturing_processor.reset (new CapturingProcessor (_session));
3719 _capturing_processor->activate ();
3721 configure_processors_unlocked (0, &lw);
3725 return _capturing_processor;
3729 Route::update_signal_latency ()
3731 framecnt_t l = _output->user_latency();
3732 framecnt_t lamp = 0;
3733 bool before_amp = true;
3734 framecnt_t ltrim = 0;
3735 bool before_trim = true;
3737 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3738 if ((*i)->active ()) {
3739 l += (*i)->signal_latency ();
3744 if ((*i) == _trim) {
3755 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3757 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3758 _signal_latency_at_amp_position = lamp;
3759 _signal_latency_at_trim_position = ltrim;
3761 if (_signal_latency != l) {
3762 _signal_latency = l;
3763 signal_latency_changed (); /* EMIT SIGNAL */
3766 return _signal_latency;
3770 Route::set_user_latency (framecnt_t nframes)
3772 _output->set_user_latency (nframes);
3773 _session.update_latency_compensation ();
3777 Route::set_latency_compensation (framecnt_t longest_session_latency)
3779 framecnt_t old = _initial_delay;
3781 if (_signal_latency < longest_session_latency) {
3782 _initial_delay = longest_session_latency - _signal_latency;
3787 DEBUG_TRACE (DEBUG::Latency, string_compose (
3788 "%1: compensate for maximum latency of %2,"
3789 "given own latency of %3, using initial delay of %4\n",
3790 name(), longest_session_latency, _signal_latency, _initial_delay));
3792 if (_initial_delay != old) {
3793 initial_delay_changed (); /* EMIT SIGNAL */
3796 if (_session.transport_stopped()) {
3797 _roll_delay = _initial_delay;
3802 Route::set_block_size (pframes_t nframes)
3804 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3805 (*i)->set_block_size (nframes);
3808 _session.ensure_buffers (n_process_buffers ());
3812 Route::protect_automation ()
3814 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3815 (*i)->protect_automation();
3818 /** @param declick 1 to set a pending declick fade-in,
3819 * -1 to set a pending declick fade-out
3822 Route::set_pending_declick (int declick)
3825 /* this call is not allowed to turn off a pending declick */
3827 _pending_declick = declick;
3830 _pending_declick = 0;
3834 /** Shift automation forwards from a particular place, thereby inserting time.
3835 * Adds undo commands for any shifts that are performed.
3837 * @param pos Position to start shifting from.
3838 * @param frames Amount to shift forwards by.
3842 Route::shift (framepos_t pos, framecnt_t frames)
3844 /* gain automation */
3846 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3848 XMLNode &before = gc->alist()->get_state ();
3849 gc->alist()->shift (pos, frames);
3850 XMLNode &after = gc->alist()->get_state ();
3851 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3854 /* gain automation */
3856 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3858 XMLNode &before = gc->alist()->get_state ();
3859 gc->alist()->shift (pos, frames);
3860 XMLNode &after = gc->alist()->get_state ();
3861 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3864 // TODO mute automation ??
3866 /* pan automation */
3868 ControlSet::Controls& c (_pannable->controls());
3870 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3871 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3873 boost::shared_ptr<AutomationList> al = pc->alist();
3874 XMLNode& before = al->get_state ();
3875 al->shift (pos, frames);
3876 XMLNode& after = al->get_state ();
3877 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3882 /* redirect automation */
3884 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3885 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3887 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3889 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3890 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3892 boost::shared_ptr<AutomationList> al = ac->alist();
3893 XMLNode &before = al->get_state ();
3894 al->shift (pos, frames);
3895 XMLNode &after = al->get_state ();
3896 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3904 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
3906 boost::shared_ptr<Processor> processor (p.lock ());
3907 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3911 pi->set_state_dir (d);
3915 Route::save_as_template (const string& path, const string& name)
3917 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
3918 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
3920 XMLNode& node (state (false));
3924 IO::set_name_in_state (*node.children().front(), name);
3926 tree.set_root (&node);
3928 /* return zero on success, non-zero otherwise */
3929 return !tree.write (path.c_str());
3934 Route::set_name (const string& str)
3936 if (str == name()) {
3940 string name = Route::ensure_track_or_route_name (str, _session);
3941 SessionObject::set_name (name);
3943 bool ret = (_input->set_name(name) && _output->set_name(name));
3946 /* rename the main outs. Leave other IO processors
3947 * with whatever name they already have, because its
3948 * just fine as it is (it will not contain the route
3949 * name if its a port insert, port send or port return).
3953 if (_main_outs->set_name (name)) {
3954 /* XXX returning false here is stupid because
3955 we already changed the route name.
3965 /** Set the name of a route in an XML description.
3966 * @param node XML <Route> node to set the name in.
3967 * @param name New name.
3970 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
3972 node.add_property (X_("name"), name);
3974 XMLNodeList children = node.children();
3975 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3977 if ((*i)->name() == X_("IO")) {
3979 IO::set_name_in_state (**i, name);
3981 } else if ((*i)->name() == X_("Processor")) {
3983 XMLProperty const * role = (*i)->property (X_("role"));
3984 if (role && role->value() == X_("Main")) {
3985 (*i)->add_property (X_("name"), name);
3988 } else if ((*i)->name() == X_("Diskstream")) {
3990 if (rename_playlist) {
3991 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3993 (*i)->add_property (X_("name"), name);
3999 boost::shared_ptr<Send>
4000 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4002 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4004 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4005 boost::shared_ptr<InternalSend> send;
4007 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4008 if (send->target_route() == target) {
4014 return boost::shared_ptr<Send>();
4018 Route::set_denormal_protection (bool yn)
4020 if (_denormal_protection != yn) {
4021 _denormal_protection = yn;
4022 denormal_protection_changed (); /* EMIT SIGNAL */
4027 Route::denormal_protection () const
4029 return _denormal_protection;
4033 Route::set_active (bool yn, void* src)
4035 if (_session.transport_rolling()) {
4039 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4040 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4044 if (_active != yn) {
4046 _input->set_active (yn);
4047 _output->set_active (yn);
4048 active_changed (); // EMIT SIGNAL
4049 _session.set_dirty ();
4053 boost::shared_ptr<Pannable>
4054 Route::pannable() const
4059 boost::shared_ptr<Panner>
4060 Route::panner() const
4063 return _main_outs->panner_shell()->panner();
4066 boost::shared_ptr<PannerShell>
4067 Route::panner_shell() const
4069 return _main_outs->panner_shell();
4072 boost::shared_ptr<GainControl>
4073 Route::gain_control() const
4075 return _gain_control;
4078 boost::shared_ptr<GainControl>
4079 Route::trim_control() const
4081 return _trim_control;
4084 boost::shared_ptr<PhaseControl>
4085 Route::phase_control() const
4087 return _phase_control;
4090 boost::shared_ptr<AutomationControl>
4091 Route::get_control (const Evoral::Parameter& param)
4093 /* either we own the control or .... */
4095 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4099 /* maybe one of our processors does or ... */
4101 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4102 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4103 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4111 /* nobody does so we'll make a new one */
4113 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4120 boost::shared_ptr<Processor>
4121 Route::nth_plugin (uint32_t n) const
4123 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4124 ProcessorList::const_iterator i;
4126 for (i = _processors.begin(); i != _processors.end(); ++i) {
4127 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4134 return boost::shared_ptr<Processor> ();
4137 boost::shared_ptr<Processor>
4138 Route::nth_send (uint32_t n) const
4140 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4141 ProcessorList::const_iterator i;
4143 for (i = _processors.begin(); i != _processors.end(); ++i) {
4144 if (boost::dynamic_pointer_cast<Send> (*i)) {
4146 if ((*i)->name().find (_("Monitor")) == 0) {
4147 /* send to monitor section is not considered
4148 to be an accessible send.
4159 return boost::shared_ptr<Processor> ();
4163 Route::has_io_processor_named (const string& name)
4165 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4166 ProcessorList::iterator i;
4168 for (i = _processors.begin(); i != _processors.end(); ++i) {
4169 if (boost::dynamic_pointer_cast<Send> (*i) ||
4170 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4171 if ((*i)->name() == name) {
4181 Route::set_processor_positions ()
4183 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4185 bool had_amp = false;
4186 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4187 (*i)->set_pre_fader (!had_amp);
4194 /** Called when there is a proposed change to the input port count */
4196 Route::input_port_count_changing (ChanCount to)
4198 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4200 /* The processors cannot be configured with the new input arrangement, so
4206 /* The change is ok */
4210 /** Called when there is a proposed change to the output port count */
4212 Route::output_port_count_changing (ChanCount to)
4214 if (_strict_io && !_in_configure_processors) {
4217 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4218 if (processor_out_streams.get(*t) > to.get(*t)) {
4222 /* The change is ok */
4227 Route::unknown_processors () const
4231 if (_session.get_disable_all_loaded_plugins ()) {
4232 // Do not list "missing plugins" if they are explicitly disabled
4236 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4237 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4238 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4239 p.push_back ((*i)->name ());
4248 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4250 /* we assume that all our input ports feed all our output ports. its not
4251 universally true, but the alternative is way too corner-case to worry about.
4254 LatencyRange all_connections;
4257 all_connections.min = 0;
4258 all_connections.max = 0;
4260 all_connections.min = ~((pframes_t) 0);
4261 all_connections.max = 0;
4263 /* iterate over all "from" ports and determine the latency range for all of their
4264 connections to the "outside" (outside of this Route).
4267 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4271 p->get_connected_latency_range (range, playback);
4273 all_connections.min = min (all_connections.min, range.min);
4274 all_connections.max = max (all_connections.max, range.max);
4278 /* set the "from" port latencies to the max/min range of all their connections */
4280 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4281 p->set_private_latency_range (all_connections, playback);
4284 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4286 all_connections.min += our_latency;
4287 all_connections.max += our_latency;
4289 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4290 p->set_private_latency_range (all_connections, playback);
4293 return all_connections.max;
4297 Route::set_private_port_latencies (bool playback) const
4299 framecnt_t own_latency = 0;
4301 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4302 OR LATENCY CALLBACK.
4304 This is called (early) from the latency callback. It computes the REAL
4305 latency associated with each port and stores the result as the "private"
4306 latency of the port. A later call to Route::set_public_port_latencies()
4307 sets all ports to the same value to reflect the fact that we do latency
4308 compensation and so all signals are delayed by the same amount as they
4309 flow through ardour.
4312 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4313 if ((*i)->active ()) {
4314 own_latency += (*i)->signal_latency ();
4319 /* playback: propagate latency from "outside the route" to outputs to inputs */
4320 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4322 /* capture: propagate latency from "outside the route" to inputs to outputs */
4323 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4328 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4330 /* this is called to set the JACK-visible port latencies, which take
4331 latency compensation into account.
4340 const PortSet& ports (_input->ports());
4341 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4342 p->set_public_latency_range (range, playback);
4347 const PortSet& ports (_output->ports());
4348 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4349 p->set_public_latency_range (range, playback);
4354 /** Put the invisible processors in the right place in _processors.
4355 * Must be called with a writer lock on _processor_lock held.
4358 __attribute__((annotate("realtime")))
4361 Route::setup_invisible_processors ()
4364 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4365 assert (!lm.locked ());
4369 /* too early to be doing this stuff */
4373 /* we'll build this new list here and then use it
4375 * TODO put the ProcessorList is on the stack for RT-safety.
4378 ProcessorList new_processors;
4380 /* find visible processors */
4382 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4383 if ((*i)->display_to_user ()) {
4384 new_processors.push_back (*i);
4390 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4392 if (amp == new_processors.end ()) {
4393 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4394 new_processors.push_front (_amp);
4395 amp = find (new_processors.begin(), new_processors.end(), _amp);
4398 /* and the processor after the amp */
4400 ProcessorList::iterator after_amp = amp;
4406 switch (_meter_point) {
4408 assert (!_meter->display_to_user ());
4409 new_processors.push_front (_meter);
4412 assert (!_meter->display_to_user ());
4413 new_processors.insert (amp, _meter);
4415 case MeterPostFader:
4416 /* do nothing here */
4419 /* do nothing here */
4422 /* the meter is visible, so we don't touch it here */
4429 assert (_main_outs);
4430 assert (!_main_outs->display_to_user ());
4431 new_processors.push_back (_main_outs);
4433 /* iterator for the main outs */
4435 ProcessorList::iterator main = new_processors.end();
4438 /* OUTPUT METERING */
4440 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4441 assert (!_meter->display_to_user ());
4443 /* add the processor just before or just after the main outs */
4445 ProcessorList::iterator meter_point = main;
4447 if (_meter_point == MeterOutput) {
4450 new_processors.insert (meter_point, _meter);
4455 if (_monitor_send && !is_monitor ()) {
4456 assert (!_monitor_send->display_to_user ());
4457 switch (Config->get_listen_position ()) {
4458 case PreFaderListen:
4459 switch (Config->get_pfl_position ()) {
4460 case PFLFromBeforeProcessors:
4461 new_processors.push_front (_monitor_send);
4463 case PFLFromAfterProcessors:
4464 new_processors.insert (amp, _monitor_send);
4467 _monitor_send->set_can_pan (false);
4469 case AfterFaderListen:
4470 switch (Config->get_afl_position ()) {
4471 case AFLFromBeforeProcessors:
4472 new_processors.insert (after_amp, _monitor_send);
4474 case AFLFromAfterProcessors:
4475 new_processors.insert (new_processors.end(), _monitor_send);
4478 _monitor_send->set_can_pan (true);
4483 #if 0 // not used - just yet
4484 if (!is_master() && !is_monitor() && !is_auditioner()) {
4485 new_processors.push_front (_delayline);
4489 /* MONITOR CONTROL */
4491 if (_monitor_control && is_monitor ()) {
4492 assert (!_monitor_control->display_to_user ());
4493 new_processors.insert (amp, _monitor_control);
4496 /* INTERNAL RETURN */
4498 /* doing this here means that any monitor control will come just after
4503 assert (!_intreturn->display_to_user ());
4504 new_processors.push_front (_intreturn);
4507 if (_trim && _trim->active()) {
4508 assert (!_trim->display_to_user ());
4509 new_processors.push_front (_trim);
4511 /* EXPORT PROCESSOR */
4513 if (_capturing_processor) {
4514 assert (!_capturing_processor->display_to_user ());
4515 new_processors.push_front (_capturing_processor);
4518 _processors = new_processors;
4520 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4521 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4522 (*i)->enable (true);
4526 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4527 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4528 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4535 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4536 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4540 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4541 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4548 /** If the meter point is `Custom', make a note of where the meter is.
4549 * This is so that if the meter point is subsequently set to something else,
4550 * and then back to custom, we can put the meter back where it was last time
4551 * custom was enabled.
4553 * Must be called with the _processor_lock held.
4556 Route::maybe_note_meter_position ()
4558 if (_meter_point != MeterCustom) {
4562 _custom_meter_position_noted = true;
4563 /* custom meter points range from after trim to before panner/main_outs
4564 * this is a limitation by the current processor UI
4566 bool seen_trim = false;
4567 _processor_after_last_custom_meter.reset();
4568 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4569 if ((*i) == _trim) {
4572 if ((*i) == _main_outs) {
4573 _processor_after_last_custom_meter = *i;
4576 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4578 _processor_after_last_custom_meter = _trim;
4580 ProcessorList::iterator j = i;
4582 assert(j != _processors.end ()); // main_outs should be before
4583 _processor_after_last_custom_meter = *j;
4588 assert(_processor_after_last_custom_meter.lock());
4591 boost::shared_ptr<Processor>
4592 Route::processor_by_id (PBD::ID id) const
4594 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4595 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4596 if ((*i)->id() == id) {
4601 return boost::shared_ptr<Processor> ();
4604 /** @return the monitoring state, or in other words what data we are pushing
4605 * into the route (data from the inputs, data from disk or silence)
4608 Route::monitoring_state () const
4610 return MonitoringInput;
4613 /** @return what we should be metering; either the data coming from the input
4614 * IO or the data that is flowing through the route.
4617 Route::metering_state () const
4619 return MeteringRoute;
4623 Route::has_external_redirects () const
4625 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4627 /* ignore inactive processors and obviously ignore the main
4628 * outs since everything has them and we don't care.
4631 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4639 boost::shared_ptr<Processor>
4640 Route::the_instrument () const
4642 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4643 return the_instrument_unlocked ();
4646 boost::shared_ptr<Processor>
4647 Route::the_instrument_unlocked () const
4649 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4650 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4651 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4655 return boost::shared_ptr<Processor>();
4661 Route::non_realtime_locate (framepos_t pos)
4664 _pannable->transport_located (pos);
4667 if (_delayline.get()) {
4668 _delayline.get()->flush();
4672 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4673 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4675 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4676 (*i)->transport_located (pos);
4679 _roll_delay = _initial_delay;
4683 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4690 * We don't currently mix MIDI input together, so we don't need the
4691 * complex logic of the audio case.
4694 n_buffers = bufs.count().n_midi ();
4696 for (i = 0; i < n_buffers; ++i) {
4698 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4699 MidiBuffer& buf (bufs.get_midi (i));
4702 buf.copy (source_port->get_midi_buffer(nframes));
4704 buf.silence (nframes);
4710 n_buffers = bufs.count().n_audio();
4712 size_t n_ports = io->n_ports().n_audio();
4713 float scaling = 1.0f;
4715 if (n_ports > n_buffers) {
4716 scaling = ((float) n_buffers) / n_ports;
4719 for (i = 0; i < n_ports; ++i) {
4721 /* if there are more ports than buffers, map them onto buffers
4722 * in a round-robin fashion
4725 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4726 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4729 if (i < n_buffers) {
4731 /* first time through just copy a channel into
4735 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4737 if (scaling != 1.0f) {
4738 buf.apply_gain (scaling, nframes);
4743 /* on subsequent times around, merge data from
4744 * the port with what is already there
4747 if (scaling != 1.0f) {
4748 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4750 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4755 /* silence any remaining buffers */
4757 for (; i < n_buffers; ++i) {
4758 AudioBuffer& buf (bufs.get_audio (i));
4759 buf.silence (nframes);
4762 /* establish the initial setup of the buffer set, reflecting what was
4763 copied into it. unless, of course, we are the auditioner, in which
4764 case nothing was fed into it from the inputs at all.
4767 if (!is_auditioner()) {
4768 bufs.set_count (io->n_ports());
4772 boost::shared_ptr<AutomationControl>
4773 Route::pan_azimuth_control() const
4776 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4778 return boost::shared_ptr<AutomationControl>();
4780 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4781 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4783 if (!_pannable || !panner()) {
4784 return boost::shared_ptr<AutomationControl>();
4786 return _pannable->pan_azimuth_control;
4790 boost::shared_ptr<AutomationControl>
4791 Route::pan_elevation_control() const
4793 if (Profile->get_mixbus() || !_pannable || !panner()) {
4794 return boost::shared_ptr<AutomationControl>();
4797 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4799 if (c.find (PanElevationAutomation) != c.end()) {
4800 return _pannable->pan_elevation_control;
4802 return boost::shared_ptr<AutomationControl>();
4805 boost::shared_ptr<AutomationControl>
4806 Route::pan_width_control() const
4808 if (Profile->get_mixbus() || !_pannable || !panner()) {
4809 return boost::shared_ptr<AutomationControl>();
4812 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4814 if (c.find (PanWidthAutomation) != c.end()) {
4815 return _pannable->pan_width_control;
4817 return boost::shared_ptr<AutomationControl>();
4820 boost::shared_ptr<AutomationControl>
4821 Route::pan_frontback_control() const
4823 if (Profile->get_mixbus() || !_pannable || !panner()) {
4824 return boost::shared_ptr<AutomationControl>();
4827 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4829 if (c.find (PanFrontBackAutomation) != c.end()) {
4830 return _pannable->pan_frontback_control;
4832 return boost::shared_ptr<AutomationControl>();
4835 boost::shared_ptr<AutomationControl>
4836 Route::pan_lfe_control() const
4838 if (Profile->get_mixbus() || !_pannable || !panner()) {
4839 return boost::shared_ptr<AutomationControl>();
4842 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4844 if (c.find (PanLFEAutomation) != c.end()) {
4845 return _pannable->pan_lfe_control;
4847 return boost::shared_ptr<AutomationControl>();
4852 Route::eq_band_cnt () const
4854 if (Profile->get_mixbus()) {
4857 /* Ardour has no well-known EQ object */
4862 boost::shared_ptr<AutomationControl>
4863 Route::eq_gain_controllable (uint32_t band) const
4866 boost::shared_ptr<PluginInsert> eq = ch_eq();
4869 return boost::shared_ptr<AutomationControl>();
4872 uint32_t port_number;
4875 if (is_master() || mixbus()) {
4882 if (is_master() || mixbus()) {
4889 if (is_master() || mixbus()) {
4896 return boost::shared_ptr<AutomationControl>();
4899 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4901 return boost::shared_ptr<AutomationControl>();
4904 boost::shared_ptr<AutomationControl>
4905 Route::eq_freq_controllable (uint32_t band) const
4909 if (mixbus() || is_master()) {
4910 /* no frequency controls for mixbusses or master */
4911 return boost::shared_ptr<AutomationControl>();
4914 boost::shared_ptr<PluginInsert> eq = ch_eq();
4917 return boost::shared_ptr<AutomationControl>();
4920 uint32_t port_number;
4932 return boost::shared_ptr<AutomationControl>();
4935 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4937 return boost::shared_ptr<AutomationControl>();
4941 boost::shared_ptr<AutomationControl>
4942 Route::eq_q_controllable (uint32_t band) const
4944 return boost::shared_ptr<AutomationControl>();
4947 boost::shared_ptr<AutomationControl>
4948 Route::eq_shape_controllable (uint32_t band) const
4950 return boost::shared_ptr<AutomationControl>();
4953 boost::shared_ptr<AutomationControl>
4954 Route::eq_enable_controllable () const
4957 boost::shared_ptr<PluginInsert> eq = ch_eq();
4960 return boost::shared_ptr<AutomationControl>();
4963 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
4965 return boost::shared_ptr<AutomationControl>();
4969 boost::shared_ptr<AutomationControl>
4970 Route::eq_hpf_controllable () const
4973 boost::shared_ptr<PluginInsert> eq = ch_eq();
4976 return boost::shared_ptr<AutomationControl>();
4979 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
4981 return boost::shared_ptr<AutomationControl>();
4986 Route::eq_band_name (uint32_t band) const
4988 if (Profile->get_mixbus()) {
5004 boost::shared_ptr<AutomationControl>
5005 Route::comp_enable_controllable () const
5008 boost::shared_ptr<PluginInsert> comp = ch_comp();
5011 return boost::shared_ptr<AutomationControl>();
5014 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5016 return boost::shared_ptr<AutomationControl>();
5019 boost::shared_ptr<AutomationControl>
5020 Route::comp_threshold_controllable () const
5023 boost::shared_ptr<PluginInsert> comp = ch_comp();
5026 return boost::shared_ptr<AutomationControl>();
5029 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5032 return boost::shared_ptr<AutomationControl>();
5035 boost::shared_ptr<AutomationControl>
5036 Route::comp_speed_controllable () const
5039 boost::shared_ptr<PluginInsert> comp = ch_comp();
5042 return boost::shared_ptr<AutomationControl>();
5045 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5047 return boost::shared_ptr<AutomationControl>();
5050 boost::shared_ptr<AutomationControl>
5051 Route::comp_mode_controllable () const
5054 boost::shared_ptr<PluginInsert> comp = ch_comp();
5057 return boost::shared_ptr<AutomationControl>();
5060 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5062 return boost::shared_ptr<AutomationControl>();
5065 boost::shared_ptr<AutomationControl>
5066 Route::comp_makeup_controllable () const
5069 boost::shared_ptr<PluginInsert> comp = ch_comp();
5072 return boost::shared_ptr<AutomationControl>();
5075 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5077 return boost::shared_ptr<AutomationControl>();
5080 boost::shared_ptr<AutomationControl>
5081 Route::comp_redux_controllable () const
5084 boost::shared_ptr<PluginInsert> comp = ch_comp();
5087 return boost::shared_ptr<AutomationControl>();
5090 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5092 return boost::shared_ptr<AutomationControl>();
5097 Route::comp_mode_name (uint32_t mode) const
5102 return _("Leveler");
5104 return _("Compressor");
5106 return _("Limiter");
5108 return mixbus() ? _("Sidechain") : _("Limiter");
5118 Route::comp_speed_name (uint32_t mode) const
5136 boost::shared_ptr<AutomationControl>
5137 Route::send_level_controllable (uint32_t n) const
5140 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5142 return boost::shared_ptr<AutomationControl>();
5147 return boost::shared_ptr<AutomationControl>();
5150 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5151 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5153 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5155 return boost::shared_ptr<AutomationControl>();
5157 return s->gain_control ();
5161 boost::shared_ptr<AutomationControl>
5162 Route::send_enable_controllable (uint32_t n) const
5165 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5167 return boost::shared_ptr<AutomationControl>();
5172 return boost::shared_ptr<AutomationControl>();
5175 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5176 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5178 /* although Ardour sends have enable/disable as part of the Processor
5179 API, it is not exposed as a controllable.
5181 XXX: we should fix this.
5183 return boost::shared_ptr<AutomationControl>();
5188 Route::send_name (uint32_t n) const
5194 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5198 boost::shared_ptr<Processor> p = nth_send (n);
5207 boost::shared_ptr<AutomationControl>
5208 Route::master_send_enable_controllable () const
5211 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5213 return boost::shared_ptr<AutomationControl>();
5215 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5217 return boost::shared_ptr<AutomationControl>();
5222 Route::slaved () const
5224 if (!_gain_control) {
5227 /* just test one particular control, not all of them */
5228 return _gain_control->slaved ();
5232 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5234 if (!vca || !_gain_control) {
5238 /* just test one particular control, not all of them */
5240 return _gain_control->slaved_to (vca->gain_control());
5244 Route::muted_by_others_soloing () const
5246 if (!can_be_muted_by_others ()) {
5250 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5254 Route::clear_all_solo_state ()
5256 double v = _solo_safe_control->get_value ();
5258 _solo_control->clear_all_solo_state ();
5261 _solo_safe_control->set_value (v, Controllable::NoGroup);