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/event_type_map.h"
50 #include "ardour/gain_control.h"
51 #include "ardour/internal_return.h"
52 #include "ardour/internal_send.h"
53 #include "ardour/meter.h"
54 #include "ardour/delayline.h"
55 #include "ardour/midi_buffer.h"
56 #include "ardour/midi_port.h"
57 #include "ardour/monitor_processor.h"
58 #include "ardour/pannable.h"
59 #include "ardour/panner.h"
60 #include "ardour/panner_shell.h"
61 #include "ardour/parameter_descriptor.h"
62 #include "ardour/phase_control.h"
63 #include "ardour/plugin_insert.h"
64 #include "ardour/port.h"
65 #include "ardour/port_insert.h"
66 #include "ardour/processor.h"
67 #include "ardour/profile.h"
68 #include "ardour/route.h"
69 #include "ardour/route_group.h"
70 #include "ardour/send.h"
71 #include "ardour/session.h"
72 #include "ardour/solo_control.h"
73 #include "ardour/solo_isolate_control.h"
74 #include "ardour/unknown_processor.h"
75 #include "ardour/utils.h"
76 #include "ardour/vca.h"
81 using namespace ARDOUR;
84 PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, Route::PluginSetupOptions > Route::PluginSetup;
86 /** Base class for all routable/mixable objects (tracks and busses) */
87 Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType default_type)
88 : Stripable (sess, name, PresentationInfo (flag))
89 , GraphNode (sess._process_graph)
90 , Muteable (sess, name)
94 , _signal_latency_at_amp_position (0)
95 , _signal_latency_at_trim_position (0)
98 , _pending_process_reorder (0)
99 , _pending_signals (0)
100 , _pending_declick (true)
101 , _meter_point (MeterPostFader)
102 , _pending_meter_point (MeterPostFader)
103 , _meter_type (MeterPeak)
104 , _denormal_protection (false)
107 , _declickable (false)
108 , _have_internal_generator (false)
109 , _default_type (default_type)
111 , _in_configure_processors (false)
112 , _initial_io_setup (false)
113 , _in_sidechain_setup (false)
115 , _custom_meter_position_noted (false)
118 processor_max_streams.reset();
121 boost::weak_ptr<Route>
122 Route::weakroute () {
123 return boost::weak_ptr<Route> (shared_from_this ());
129 /* set default meter type */
131 _meter_type = Config->get_meter_type_master ();
133 else if (dynamic_cast<Track*>(this)) {
134 _meter_type = Config->get_meter_type_track ();
136 _meter_type = Config->get_meter_type_bus ();
139 /* add standard controls */
141 _gain_control.reset (new GainControl (_session, GainAutomation));
142 add_control (_gain_control);
144 _trim_control.reset (new GainControl (_session, TrimAutomation));
145 add_control (_trim_control);
147 _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
148 add_control (_solo_control);
149 _solo_control->Changed.connect_same_thread (*this, boost::bind (&Route::solo_control_changed, this, _1, _2));
151 _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
152 add_control (_mute_control);
154 _phase_control.reset (new PhaseControl (_session, X_("phase")));
155 add_control (_phase_control);
157 _solo_isolate_control.reset (new SoloIsolateControl (_session, X_("solo-iso"), *this, *this));
158 add_control (_solo_isolate_control);
160 _solo_safe_control.reset (new SoloSafeControl (_session, X_("solo-safe")));
161 add_control (_solo_safe_control);
165 if (!(_presentation_info.flags() & PresentationInfo::MonitorOut)) {
166 _pannable.reset (new Pannable (_session));
169 /* input and output objects */
171 _input.reset (new IO (_session, _name, IO::Input, _default_type));
172 _output.reset (new IO (_session, _name, IO::Output, _default_type));
174 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
175 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
177 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
178 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
180 /* add the amp/fader processor.
181 * it should be the first processor to be added on every route.
184 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
185 add_processor (_amp, PostFader);
188 _amp->set_display_name (_("Monitor"));
191 #if 0 // not used - just yet
192 if (!is_master() && !is_monitor() && !is_auditioner()) {
193 _delayline.reset (new DelayLine (_session, _name));
194 add_processor (_delayline, PreFader);
200 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
201 _trim->set_display_to_user (false);
203 if (dynamic_cast<AudioTrack*>(this)) {
204 /* we can't do this in the AudioTrack's constructor
205 * because _trim does not exit then
209 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
214 /* create standard processors: meter, main outs, monitor out;
215 they will be added to _processors by setup_invisible_processors ()
218 _meter.reset (new PeakMeter (_session, _name));
219 _meter->set_owner (this);
220 _meter->set_display_to_user (false);
223 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
224 _main_outs->activate ();
227 /* where we listen to tracks */
228 _intreturn.reset (new InternalReturn (_session));
229 _intreturn->activate ();
231 /* the thing that provides proper control over a control/monitor/listen bus
232 (such as per-channel cut, dim, solo, invert, etc).
234 _monitor_control.reset (new MonitorProcessor (_session));
235 _monitor_control->activate ();
238 /* now that we have _meter, its safe to connect to this */
241 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
242 configure_processors (0);
250 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
252 /* do this early so that we don't get incoming signals as we are going through destruction
257 /* don't use clear_processors here, as it depends on the session which may
258 be half-destroyed by now
261 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
262 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
263 (*i)->drop_references ();
266 _processors.clear ();
270 Route::ensure_track_or_route_name(string name, Session &session)
272 string newname = name;
274 while (!session.io_name_is_legal (newname)) {
275 newname = bump_name_once (newname, ' ');
282 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
284 // TODO route group, see set_gain()
285 // _trim_control->route_set_value (val);
289 Route::maybe_declick (BufferSet&, framecnt_t, int)
291 /* this is the "bus" implementation and they never declick.
296 /** Process this route for one (sub) cycle (process thread)
298 * @param bufs Scratch buffers to use for the signal path
299 * @param start_frame Initial transport frame
300 * @param end_frame Final transport frame
301 * @param nframes Number of frames to output (to ports)
303 * Note that (end_frame - start_frame) may not be equal to nframes when the
304 * transport speed isn't 1.0 (eg varispeed).
307 Route::process_output_buffers (BufferSet& bufs,
308 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
309 int declick, bool gain_automation_ok)
311 /* Caller must hold process lock */
312 assert (!AudioEngine::instance()->process_lock().trylock());
314 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
316 // can this actually happen? functions calling process_output_buffers()
317 // already take a reader-lock.
318 bufs.silence (nframes, 0);
322 _mute_control->automation_run (start_frame, nframes);
324 /* figure out if we're going to use gain automation */
325 if (gain_automation_ok) {
326 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
327 _amp->setup_gain_automation (
328 start_frame + _signal_latency_at_amp_position,
329 end_frame + _signal_latency_at_amp_position,
332 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
333 _trim->setup_gain_automation (
334 start_frame + _signal_latency_at_trim_position,
335 end_frame + _signal_latency_at_trim_position,
338 _amp->apply_gain_automation (false);
339 _trim->apply_gain_automation (false);
342 /* Tell main outs what to do about monitoring. We do this so that
343 on a transition between monitoring states we get a de-clicking gain
344 change in the _main_outs delivery, if config.get_use_monitor_fades()
347 We override this in the case where we have an internal generator.
349 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
351 _main_outs->no_outs_cuz_we_no_monitor (silence);
353 /* -------------------------------------------------------------------------------------------
354 GLOBAL DECLICK (for transport changes etc.)
355 ----------------------------------------------------------------------------------------- */
357 maybe_declick (bufs, nframes, declick);
358 _pending_declick = 0;
360 /* -------------------------------------------------------------------------------------------
361 DENORMAL CONTROL/PHASE INVERT
362 ----------------------------------------------------------------------------------------- */
364 if (!_phase_control->none()) {
368 if (_denormal_protection || Config->get_denormal_protection()) {
370 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
371 Sample* const sp = i->data();
373 if (_phase_control->inverted (chn)) {
374 for (pframes_t nx = 0; nx < nframes; ++nx) {
379 for (pframes_t nx = 0; nx < nframes; ++nx) {
387 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
388 Sample* const sp = i->data();
390 if (_phase_control->inverted (chn)) {
391 for (pframes_t nx = 0; nx < nframes; ++nx) {
400 if (_denormal_protection || Config->get_denormal_protection()) {
402 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
403 Sample* const sp = i->data();
404 for (pframes_t nx = 0; nx < nframes; ++nx) {
412 /* -------------------------------------------------------------------------------------------
414 ----------------------------------------------------------------------------------------- */
416 /* set this to be true if the meter will already have been ::run() earlier */
417 bool const meter_already_run = metering_state() == MeteringInput;
419 framecnt_t latency = 0;
420 const double speed = _session.transport_speed ();
422 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
424 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
425 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
430 /* if it has any inputs, make sure they match */
431 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
432 if (bufs.count() != (*i)->input_streams()) {
434 DEBUG::Processors, string_compose (
435 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
436 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
443 /* should we NOT run plugins here if the route is inactive?
444 do we catch route != active somewhere higher?
447 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
448 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
450 if (boost::dynamic_pointer_cast<PluginInsert>(*i) != 0) {
451 const framecnt_t longest_session_latency = _initial_delay + _signal_latency;
452 boost::dynamic_pointer_cast<PluginInsert>(*i)->set_sidechain_latency (
453 _initial_delay + latency, longest_session_latency - latency);
456 (*i)->run (bufs, start_frame - latency, end_frame - latency, speed, nframes, *i != _processors.back());
457 bufs.set_count ((*i)->output_streams());
459 if ((*i)->active ()) {
460 latency += (*i)->signal_latency ();
466 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
467 boost::shared_ptr<Processor> endpoint,
468 bool include_endpoint, bool for_export, bool for_freeze)
470 /* If no processing is required, there's no need to go any further. */
471 if (!endpoint && !include_endpoint) {
475 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
476 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
477 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
479 /* trim is always at the top, for bounce no latency compensation is needed */
480 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
481 _trim->setup_gain_automation (start, start + nframes, nframes);
484 const double speed = _session.transport_speed ();
485 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
487 if (!include_endpoint && (*i) == endpoint) {
491 /* if we're *not* exporting, stop processing if we come across a routing processor. */
492 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
495 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
499 /* special case the panner (export outputs)
500 * Ideally we'd only run the panner, not the delivery itself...
501 * but panners need separate input/output buffers and some context
502 * (panshell, panner type, etc). AFAICT there is no ill side effect
503 * of re-using the main delivery when freewheeling/exporting a region.
505 if ((*i) == _main_outs) {
506 assert ((*i)->does_routing());
507 (*i)->run (buffers, start - latency, start - latency + nframes, speed, nframes, true);
508 buffers.set_count ((*i)->output_streams());
511 /* don't run any processors that do routing.
512 * Also don't bother with metering.
514 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
515 (*i)->run (buffers, start - latency, start - latency + nframes, 1.0, nframes, true);
516 buffers.set_count ((*i)->output_streams());
517 latency += (*i)->signal_latency ();
520 if ((*i) == endpoint) {
527 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
528 bool include_endpoint, bool for_export, bool for_freeze) const
530 framecnt_t latency = 0;
531 if (!endpoint && !include_endpoint) {
535 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
536 if (!include_endpoint && (*i) == endpoint) {
539 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
542 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
545 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
546 latency += (*i)->signal_latency ();
548 if ((*i) == endpoint) {
556 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
557 bool include_endpoint, bool for_export, bool for_freeze) const
559 if (!endpoint && !include_endpoint) {
563 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
564 if (!include_endpoint && (*i) == endpoint) {
567 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
570 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
573 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
574 cc = (*i)->output_streams();
576 if ((*i) == endpoint) {
584 Route::n_process_buffers ()
586 return max (_input->n_ports(), processor_max_streams);
590 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
592 assert (is_monitor());
593 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
594 fill_buffers_with_input (bufs, _input, nframes);
595 passthru (bufs, start_frame, end_frame, nframes, declick);
599 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
603 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
605 /* control/monitor bus ignores input ports when something is
606 feeding the listen "stream". data will "arrive" into the
607 route from the intreturn processor element.
610 bufs.silence (nframes, 0);
613 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
614 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
618 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
620 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
622 bufs.set_count (_input->n_ports());
623 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
624 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
628 Route::set_listen (bool yn)
631 if (_monitor_send->active() == yn) {
635 _monitor_send->activate ();
637 _monitor_send->deactivate ();
643 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
645 /* nothing to do if we're not using AFL/PFL. But if we are, we need
646 to alter the active state of the monitor send.
649 if (Config->get_solo_control_is_listen_control ()) {
650 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
655 Route::push_solo_isolate_upstream (int32_t delta)
657 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
659 boost::shared_ptr<RouteList> routes = _session.get_routes ();
660 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
662 if ((*i).get() == this || !(*i)->can_solo()) {
667 bool does_feed = feeds (*i, &sends_only);
669 if (does_feed && !sends_only) {
670 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
676 Route::push_solo_upstream (int delta)
678 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
679 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
683 boost::shared_ptr<Route> sr (i->r.lock());
685 sr->solo_control()->mod_solo_by_others_downstream (-delta);
692 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
694 cerr << name << " {" << endl;
695 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
696 p != procs.end(); ++p) {
697 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
703 /** Supposing that we want to insert a Processor at a given Placement, return
704 * the processor to add the new one before (or 0 to add at the end).
706 boost::shared_ptr<Processor>
707 Route::before_processor_for_placement (Placement p)
709 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
711 ProcessorList::iterator loc;
714 /* generic pre-fader: insert immediately before the amp */
715 loc = find (_processors.begin(), _processors.end(), _amp);
717 /* generic post-fader: insert right before the main outs */
718 loc = find (_processors.begin(), _processors.end(), _main_outs);
721 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
724 /** Supposing that we want to insert a Processor at a given index, return
725 * the processor to add the new one before (or 0 to add at the end).
727 boost::shared_ptr<Processor>
728 Route::before_processor_for_index (int index)
731 return boost::shared_ptr<Processor> ();
734 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
736 ProcessorList::iterator i = _processors.begin ();
738 while (i != _processors.end() && j < index) {
739 if ((*i)->display_to_user()) {
746 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
749 /** Add a processor either pre- or post-fader
750 * @return 0 on success, non-0 on failure.
753 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
755 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
759 /** Add a processor to a route such that it ends up with a given index into the visible processors.
760 * @param index Index to add the processor at, or -1 to add at the end of the list.
761 * @return 0 on success, non-0 on failure.
764 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
766 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
769 /** Add a processor to the route.
770 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
771 * @return 0 on success, non-0 on failure.
774 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
776 assert (processor != _meter);
777 assert (processor != _main_outs);
779 DEBUG_TRACE (DEBUG::Processors, string_compose (
780 "%1 adding processor %2\n", name(), processor->name()));
784 pl.push_back (processor);
785 int rv = add_processors (pl, before, err);
791 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
792 processor->activate ();
799 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
801 /* We cannot destruct the processor here (usually RT-thread
802 * with various locks held - in case of sends also io_locks).
803 * Queue for deletion in low-priority thread.
805 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
806 selfdestruct_sequence.push_back (wp);
810 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
812 XMLProperty const * prop;
815 boost::shared_ptr<Processor> processor;
817 /* bit of a hack: get the `placement' property from the <Redirect> tag here
818 so that we can add the processor in the right place (pre/post-fader)
821 XMLNodeList const & children = node.children ();
822 XMLNodeList::const_iterator i = children.begin ();
824 while (i != children.end() && (*i)->name() != X_("Redirect")) {
828 Placement placement = PreFader;
830 if (i != children.end()) {
831 if ((prop = (*i)->property (X_("placement"))) != 0) {
832 placement = Placement (string_2_enum (prop->value(), placement));
836 if (node.name() == "Insert") {
838 if ((prop = node.property ("type")) != 0) {
840 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
841 prop->value() == "lv2" ||
842 prop->value() == "windows-vst" ||
843 prop->value() == "mac-vst" ||
844 prop->value() == "lxvst" ||
845 prop->value() == "audiounit") {
847 if (_session.get_disable_all_loaded_plugins ()) {
848 processor.reset (new UnknownProcessor (_session, node));
850 processor.reset (new PluginInsert (_session));
851 processor->set_owner (this);
856 processor.reset (new PortInsert (_session, _pannable, _mute_master));
861 } else if (node.name() == "Send") {
863 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
864 processor.reset (new Send (_session, sendpan, _mute_master));
868 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
872 if (processor->set_state (node, version)) {
876 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
877 if (i != children.end()) {
878 if ((prop = (*i)->property (X_("active"))) != 0) {
879 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
880 processor->activate();
882 processor->deactivate();
886 return (add_processor (processor, placement, 0, false) == 0);
889 catch (failed_constructor &err) {
890 warning << _("processor could not be created. Ignored.") << endmsg;
896 inline Route::PluginSetupOptions operator|= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
897 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) | static_cast<int> (b));
900 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
901 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
905 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
907 ProcessorList::iterator loc;
908 boost::shared_ptr <PluginInsert> fanout;
911 loc = find(_processors.begin(), _processors.end(), before);
912 if (loc == _processors.end ()) {
916 /* nothing specified - at end */
917 loc = _processors.end ();
920 if (!AudioEngine::instance()->connected()) {
924 if (others.empty()) {
928 ProcessorList to_skip;
930 // check if there's an instrument to replace or configure
931 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
932 boost::shared_ptr<PluginInsert> pi;
933 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
936 if (!pi->plugin ()->get_info ()->is_instrument ()) {
939 boost::shared_ptr<Processor> instrument = the_instrument ();
940 ChanCount in (DataType::MIDI, 1);
941 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
943 PluginSetupOptions flags = None;
946 in = instrument->input_streams ();
947 out = instrument->output_streams ();
949 if (pi->has_output_presets (in, out)) {
953 pi->set_strict_io (_strict_io);
955 PluginSetupOptions mask = None;
956 if (Config->get_ask_replace_instrument ()) {
959 if (Config->get_ask_setup_instrument ()) {
966 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
967 int mode = rv.get_value_or (0);
970 to_skip.push_back (*i); // don't add this one;
973 replace_processor (instrument, *i, err);
974 to_skip.push_back (*i);
979 if ((mode & 5) == 4) {
986 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
987 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
988 ProcessorState pstate (this);
990 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
995 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
996 if (check != to_skip.end()) {
1000 boost::shared_ptr<PluginInsert> pi;
1002 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1003 pi->set_strict_io (_strict_io);
1007 /* Ensure that only one amp is in the list at any time */
1008 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
1009 if (check != _processors.end()) {
1010 if (before == _amp) {
1011 /* Already in position; all is well */
1014 _processors.erase (check);
1019 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1021 _processors.insert (loc, *i);
1022 (*i)->set_owner (this);
1025 if (configure_processors_unlocked (err, &lm)) {
1027 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1032 if (pi && pi->has_sidechain ()) {
1033 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
1036 if ((*i)->active()) {
1037 // emit ActiveChanged() and latency_changed() if needed
1041 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1043 boost::shared_ptr<Send> send;
1044 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1045 send->SelfDestruct.connect_same_thread (*this,
1046 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1050 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1051 boost::shared_ptr<PluginInsert> pi;
1053 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1054 if (pi->has_no_inputs ()) {
1055 _have_internal_generator = true;
1061 _output->set_user_latency (0);
1064 reset_instrument_info ();
1065 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1066 set_processor_positions ();
1068 if (fanout && fanout->configured ()
1069 && fanout->output_streams().n_audio() > 2
1070 && boost::dynamic_pointer_cast<PluginInsert> (the_instrument ()) == fanout) {
1071 fan_out (); /* EMIT SIGNAL */
1077 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1079 if (p == PreFader) {
1080 start = _processors.begin();
1081 end = find(_processors.begin(), _processors.end(), _amp);
1083 start = find(_processors.begin(), _processors.end(), _amp);
1085 end = _processors.end();
1089 /** Turn off all processors with a given placement
1090 * @param p Placement of processors to disable
1093 Route::disable_processors (Placement p)
1095 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1097 ProcessorList::iterator start, end;
1098 placement_range(p, start, end);
1100 for (ProcessorList::iterator i = start; i != end; ++i) {
1101 (*i)->enable (false);
1104 _session.set_dirty ();
1107 /** Turn off all redirects
1110 Route::disable_processors ()
1112 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1114 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1115 (*i)->enable (false);
1118 _session.set_dirty ();
1121 /** Turn off all redirects with a given placement
1122 * @param p Placement of redirects to disable
1125 Route::disable_plugins (Placement p)
1127 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1129 ProcessorList::iterator start, end;
1130 placement_range(p, start, end);
1132 for (ProcessorList::iterator i = start; i != end; ++i) {
1133 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1134 (*i)->enable (false);
1138 _session.set_dirty ();
1141 /** Turn off all plugins
1144 Route::disable_plugins ()
1146 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1148 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1149 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1150 (*i)->enable (false);
1154 _session.set_dirty ();
1159 Route::ab_plugins (bool forward)
1161 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1165 /* forward = turn off all active redirects, and mark them so that the next time
1166 we go the other way, we will revert them
1169 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1170 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1174 if ((*i)->enabled ()) {
1175 (*i)->enable (false);
1176 (*i)->set_next_ab_is_active (true);
1178 (*i)->set_next_ab_is_active (false);
1184 /* backward = if the redirect was marked to go active on the next ab, do so */
1186 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1188 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1192 (*i)->enable ((*i)->get_next_ab_is_active ());
1196 _session.set_dirty ();
1200 /** Remove processors with a given placement.
1201 * @param p Placement of processors to remove.
1204 Route::clear_processors (Placement p)
1206 if (!_session.engine().connected()) {
1210 bool already_deleting = _session.deletion_in_progress();
1211 if (!already_deleting) {
1212 _session.set_deletion_in_progress();
1216 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1217 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1218 ProcessorList new_list;
1219 ProcessorStreams err;
1220 bool seen_amp = false;
1222 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1228 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1230 /* you can't remove these */
1232 new_list.push_back (*i);
1239 new_list.push_back (*i);
1242 (*i)->drop_references ();
1250 (*i)->drop_references ();
1253 new_list.push_back (*i);
1260 _processors = new_list;
1261 configure_processors_unlocked (&err, &lm); // this can't fail
1264 processor_max_streams.reset();
1265 _have_internal_generator = false;
1266 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1267 set_processor_positions ();
1269 reset_instrument_info ();
1271 if (!already_deleting) {
1272 _session.clear_deletion_in_progress();
1277 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1279 // TODO once the export point can be configured properly, do something smarter here
1280 if (processor == _capturing_processor) {
1281 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1282 if (need_process_lock) {
1286 _capturing_processor.reset();
1288 if (need_process_lock) {
1293 /* these can never be removed */
1295 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1299 if (!_session.engine().connected()) {
1303 processor_max_streams.reset();
1306 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1307 if (need_process_lock) {
1311 /* Caller must hold process lock */
1312 assert (!AudioEngine::instance()->process_lock().trylock());
1314 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1316 ProcessorState pstate (this);
1318 ProcessorList::iterator i;
1319 bool removed = false;
1321 for (i = _processors.begin(); i != _processors.end(); ) {
1322 if (*i == processor) {
1324 /* move along, see failure case for configure_processors()
1325 where we may need to reconfigure the processor.
1328 /* stop redirects that send signals to JACK ports
1329 from causing noise as a result of no longer being
1333 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1334 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1338 iop = pi->sidechain();
1345 i = _processors.erase (i);
1353 _output->set_user_latency (0);
1361 if (configure_processors_unlocked (err, &lm)) {
1363 /* we know this will work, because it worked before :) */
1364 configure_processors_unlocked (0, &lm);
1368 _have_internal_generator = false;
1370 for (i = _processors.begin(); i != _processors.end(); ++i) {
1371 boost::shared_ptr<PluginInsert> pi;
1373 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1374 if (pi->has_no_inputs ()) {
1375 _have_internal_generator = true;
1380 if (need_process_lock) {
1385 reset_instrument_info ();
1386 processor->drop_references ();
1387 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1388 set_processor_positions ();
1394 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1396 /* these can never be removed */
1397 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1400 /* and can't be used as substitute, either */
1401 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1405 /* I/Os are out, too */
1406 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1410 /* this function cannot be used to swap/reorder processors */
1411 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1415 if (!AudioEngine::instance()->connected() || !old || !sub) {
1419 /* ensure that sub is not owned by another route */
1420 if (sub->owner ()) {
1425 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1426 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1427 ProcessorState pstate (this);
1429 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1431 ProcessorList::iterator i;
1432 bool replaced = false;
1433 bool enable = old->enabled ();
1435 for (i = _processors.begin(); i != _processors.end(); ) {
1437 i = _processors.erase (i);
1438 _processors.insert (i, sub);
1439 sub->set_owner (this);
1452 boost::shared_ptr<PluginInsert> pi;
1453 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1454 pi->set_strict_io (true);
1458 if (configure_processors_unlocked (err, &lm)) {
1460 configure_processors_unlocked (0, &lm);
1464 _have_internal_generator = false;
1466 for (i = _processors.begin(); i != _processors.end(); ++i) {
1467 boost::shared_ptr<PluginInsert> pi;
1468 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1469 if (pi->has_no_inputs ()) {
1470 _have_internal_generator = true;
1480 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1481 _output->set_user_latency (0);
1484 reset_instrument_info ();
1485 old->drop_references ();
1486 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1487 set_processor_positions ();
1492 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1494 ProcessorList deleted;
1496 if (!_session.engine().connected()) {
1500 processor_max_streams.reset();
1503 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1504 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1505 ProcessorState pstate (this);
1507 ProcessorList::iterator i;
1508 boost::shared_ptr<Processor> processor;
1510 for (i = _processors.begin(); i != _processors.end(); ) {
1514 /* these can never be removed */
1516 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1521 /* see if its in the list of processors to delete */
1523 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1528 /* stop IOProcessors that send to JACK ports
1529 from causing noise as a result of no longer being
1533 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1534 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1537 iop = pi->sidechain();
1544 deleted.push_back (processor);
1545 i = _processors.erase (i);
1548 if (deleted.empty()) {
1549 /* none of those in the requested list were found */
1553 _output->set_user_latency (0);
1555 if (configure_processors_unlocked (err, &lm)) {
1557 /* we know this will work, because it worked before :) */
1558 configure_processors_unlocked (0, &lm);
1563 _have_internal_generator = false;
1565 for (i = _processors.begin(); i != _processors.end(); ++i) {
1566 boost::shared_ptr<PluginInsert> pi;
1568 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1569 if (pi->has_no_inputs ()) {
1570 _have_internal_generator = true;
1577 /* now try to do what we need to so that those that were removed will be deleted */
1579 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1580 (*i)->drop_references ();
1583 reset_instrument_info ();
1584 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1585 set_processor_positions ();
1591 Route::reset_instrument_info ()
1593 boost::shared_ptr<Processor> instr = the_instrument();
1595 _instrument_info.set_internal_instrument (instr);
1599 /** Caller must hold process lock */
1601 Route::configure_processors (ProcessorStreams* err)
1603 #ifndef PLATFORM_WINDOWS
1604 assert (!AudioEngine::instance()->process_lock().trylock());
1607 if (!_in_configure_processors) {
1608 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1609 return configure_processors_unlocked (err, &lm);
1616 Route::input_streams () const
1618 return _input->n_ports ();
1621 list<pair<ChanCount, ChanCount> >
1622 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1624 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1626 return try_configure_processors_unlocked (in, err);
1629 list<pair<ChanCount, ChanCount> >
1630 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1632 // Check each processor in order to see if we can configure as requested
1634 list<pair<ChanCount, ChanCount> > configuration;
1637 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1638 DEBUG_TRACE (DEBUG::Processors, "{\n");
1640 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1642 if ((*p)->can_support_io_configuration(in, out)) {
1644 if (boost::dynamic_pointer_cast<Delivery> (*p)
1645 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1647 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1648 /* with strict I/O the panner + output are forced to
1649 * follow the last processor's output.
1651 * Delivery::can_support_io_configuration() will only add ports,
1652 * but not remove excess ports.
1654 * This works because the delivery only requires
1655 * as many outputs as there are inputs.
1656 * Delivery::configure_io() will do the actual removal
1657 * by calling _output->ensure_io()
1659 if (!is_master() && _session.master_out () && in.n_audio() > 0) {
1660 /* ..but at least as many as there are master-inputs, if
1661 * the delivery is dealing with audio */
1662 // XXX this may need special-casing for mixbus (master-outputs)
1663 // and should maybe be a preference anyway ?!
1664 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1670 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1671 configuration.push_back(make_pair(in, out));
1674 // restriction for Monitor Section Processors
1675 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1676 /* Note: The Monitor follows the master-bus and has no panner.
1678 * The general idea is to only allow plugins that retain the channel-count
1679 * and plugins with MIDI in (e.g VSTs with control that will remain unconnected).
1680 * Then again 5.1 in, monitor stereo is a valid use-case.
1682 * and worse: we only refuse adding plugins *here*.
1684 * 1) stereo-master, stereo-mon, add a stereo-plugin, OK
1685 * 2) change master-bus, add a channel
1686 * 2a) monitor-secion follows
1687 * 3) monitor processors fail to re-reconfigure (stereo plugin)
1688 * 4) re-load session, monitor-processor remains unconfigured, crash.
1690 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration change.\n");
1692 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1693 // internal sends make no sense, only feedback
1694 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1695 return list<pair<ChanCount, ChanCount> > ();
1697 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1698 /* External Sends can be problematic. one can add/remove ports
1699 * there signal leaves the DAW to external monitors anyway, so there's
1700 * no real use for allowing them here anyway.
1702 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1703 return list<pair<ChanCount, ChanCount> > ();
1705 if (boost::dynamic_pointer_cast<Send> (*p)) {
1707 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1708 return list<pair<ChanCount, ChanCount> > ();
1717 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1718 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1719 DEBUG_TRACE (DEBUG::Processors, "}\n");
1720 return list<pair<ChanCount, ChanCount> > ();
1724 DEBUG_TRACE (DEBUG::Processors, "}\n");
1726 return configuration;
1729 /** Set the input/output configuration of each processor in the processors list.
1730 * Caller must hold process lock.
1731 * Return 0 on success, otherwise configuration is impossible.
1734 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1736 #ifndef PLATFORM_WINDOWS
1737 assert (!AudioEngine::instance()->process_lock().trylock());
1740 if (_in_configure_processors) {
1744 /* put invisible processors where they should be */
1745 setup_invisible_processors ();
1747 _in_configure_processors = true;
1749 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1751 if (configuration.empty ()) {
1752 _in_configure_processors = false;
1757 bool seen_mains_out = false;
1758 processor_out_streams = _input->n_ports();
1759 processor_max_streams.reset();
1761 /* processor configure_io() may result in adding ports
1762 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1764 * with jack2 adding ports results in a graph-order callback,
1765 * which calls Session::resort_routes() and eventually
1766 * Route::direct_feeds_according_to_reality()
1767 * which takes a ReaderLock (_processor_lock).
1769 * so we can't hold a WriterLock here until jack2 threading
1772 * NB. we still hold the process lock
1774 * (ardour's own engines do call graph-order from the
1775 * process-thread and hence do not have this issue; besides
1776 * merely adding ports won't trigger a graph-order, only
1777 * making connections does)
1781 // TODO check for a potential ReaderLock after ReaderLock ??
1782 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1784 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1785 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1787 if (!(*p)->configure_io(c->first, c->second)) {
1788 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1789 _in_configure_processors = false;
1794 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1795 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1797 boost::shared_ptr<IOProcessor> iop;
1798 boost::shared_ptr<PluginInsert> pi;
1799 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1800 /* plugins connected via Split or Hide Match may have more channels.
1801 * route/scratch buffers are needed for all of them
1802 * The configuration may only be a subset (both input and output)
1804 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1806 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1807 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1808 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1812 if (boost::dynamic_pointer_cast<Delivery> (*p)
1813 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1814 /* main delivery will increase port count to match input.
1815 * the Delivery::Main is usually the last processor - followed only by
1818 seen_mains_out = true;
1820 if (!seen_mains_out) {
1821 processor_out_streams = out;
1830 _meter->set_max_channels (processor_max_streams);
1833 /* make sure we have sufficient scratch buffers to cope with the new processor
1836 _session.ensure_buffers (n_process_buffers ());
1838 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1840 _in_configure_processors = false;
1844 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1845 * @param state New active state for those processors.
1848 Route::all_visible_processors_active (bool state)
1850 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1852 if (_processors.empty()) {
1856 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1857 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1860 (*i)->enable (state);
1863 _session.set_dirty ();
1867 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
1869 /* check if re-order requires re-configuration of any processors
1870 * -> compare channel configuration for all processors
1872 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1873 ChanCount c = input_streams ();
1875 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
1877 if (c != (*j)->input_streams()) {
1880 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1883 if ((*i)->input_streams() != c) {
1886 c = (*i)->output_streams();
1898 __attribute__((annotate("realtime")))
1901 Route::apply_processor_order (const ProcessorList& new_order)
1903 /* need to hold processor_lock; either read or write lock
1904 * and the engine process_lock.
1905 * Due to r/w lock ambiguity we can only assert the latter
1907 assert (!AudioEngine::instance()->process_lock().trylock());
1910 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1911 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1912 * processors in the current actual processor list that are hidden. Any visible processors
1913 * in the current list but not in "new_order" will be assumed to be deleted.
1916 /* "as_it_will_be" and "_processors" are lists of shared pointers.
1917 * actual memory usage is small, but insert/erase is not actually rt-safe :(
1918 * (note though that ::processors_reorder_needs_configure() ensured that
1919 * this function will only ever be called from the rt-thread if no processor were removed)
1921 * either way, I can't proove it, but an x-run due to re-order here is less likley
1922 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
1925 ProcessorList as_it_will_be;
1926 ProcessorList::iterator oiter;
1927 ProcessorList::const_iterator niter;
1929 oiter = _processors.begin();
1930 niter = new_order.begin();
1932 while (niter != new_order.end()) {
1934 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1935 then append it to the temp list.
1937 Otherwise, see if the next processor in the old list is in the new list. if not,
1938 its been deleted. If its there, append it to the temp list.
1941 if (oiter == _processors.end()) {
1943 /* no more elements in the old list, so just stick the rest of
1944 the new order onto the temp list.
1947 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1948 while (niter != new_order.end()) {
1955 if (!(*oiter)->display_to_user()) {
1957 as_it_will_be.push_back (*oiter);
1961 /* visible processor: check that its in the new order */
1963 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1964 /* deleted: do nothing, shared_ptr<> will clean up */
1966 /* ignore this one, and add the next item from the new order instead */
1967 as_it_will_be.push_back (*niter);
1972 /* now remove from old order - its taken care of no matter what */
1973 oiter = _processors.erase (oiter);
1977 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1979 /* If the meter is in a custom position, find it and make a rough note of its position */
1980 maybe_note_meter_position ();
1984 Route::move_instrument_down (bool postfader)
1986 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1987 ProcessorList new_order;
1988 boost::shared_ptr<Processor> instrument;
1989 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1990 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1991 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
1993 } else if (instrument && *i == _amp) {
1995 new_order.push_back (*i);
1996 new_order.push_back (instrument);
1998 new_order.push_back (instrument);
1999 new_order.push_back (*i);
2002 new_order.push_back (*i);
2009 reorder_processors (new_order, 0);
2013 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
2015 // it a change is already queued, wait for it
2016 // (unless engine is stopped. apply immediately and proceed
2017 while (g_atomic_int_get (&_pending_process_reorder)) {
2018 if (!AudioEngine::instance()->running()) {
2019 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
2020 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2022 apply_processor_order(_pending_processor_order);
2023 setup_invisible_processors ();
2025 g_atomic_int_set (&_pending_process_reorder, 0);
2027 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2028 set_processor_positions ();
2030 // TODO rather use a semaphore or something.
2031 // but since ::reorder_processors() is called
2032 // from the GUI thread, this is fine..
2037 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
2039 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2040 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2041 ProcessorState pstate (this);
2043 apply_processor_order (new_order);
2045 if (configure_processors_unlocked (err, &lm)) {
2053 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2054 set_processor_positions ();
2057 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2058 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2060 // _pending_processor_order is protected by _processor_lock
2061 _pending_processor_order = new_order;
2062 g_atomic_int_set (&_pending_process_reorder, 1);
2069 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2071 boost::shared_ptr<PluginInsert> pi;
2072 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2076 if (pi->has_sidechain () == add) {
2077 return true; // ?? call failed, but result is as expected.
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 ()); // take before Writerlock to avoid deadlock
2090 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2091 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2093 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2095 if (!pi->add_sidechain ()) {
2099 if (!pi->del_sidechain ()) {
2105 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2110 pi->del_sidechain ();
2112 pi->add_sidechain ();
2113 // TODO restore side-chain's state.
2118 configure_processors_unlocked (0, &lm);
2121 if (pi->has_sidechain ()) {
2122 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2125 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2126 _session.set_dirty ();
2131 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2133 boost::shared_ptr<PluginInsert> pi;
2134 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2139 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2140 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2141 if (i == _processors.end ()) {
2147 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2148 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2150 const ChanCount& old (pi->preset_out ());
2151 if (!pi->set_preset_out (outs)) {
2152 return true; // no change, OK
2155 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2158 pi->set_preset_out (old);
2161 configure_processors_unlocked (0, &lm);
2164 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2165 _session.set_dirty ();
2170 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2173 return customize_plugin_insert (proc, 0, unused, unused);
2177 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2179 boost::shared_ptr<PluginInsert> pi;
2180 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2185 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2186 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2187 if (i == _processors.end ()) {
2193 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2194 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2196 bool old_cust = pi->custom_cfg ();
2197 uint32_t old_cnt = pi->get_count ();
2198 ChanCount old_chan = pi->output_streams ();
2199 ChanCount old_sinks = pi->natural_input_streams ();
2202 pi->set_custom_cfg (false);
2204 pi->set_custom_cfg (true);
2205 pi->set_count (count);
2206 pi->set_outputs (outs);
2207 pi->set_sinks (sinks);
2210 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2214 pi->set_count (old_cnt);
2215 pi->set_sinks (old_sinks);
2216 pi->set_outputs (old_chan);
2217 pi->set_custom_cfg (old_cust);
2221 configure_processors_unlocked (0, &lm);
2224 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2225 _session.set_dirty ();
2230 Route::set_strict_io (const bool enable)
2232 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2234 if (_strict_io != enable) {
2235 _strict_io = enable;
2236 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2237 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2238 boost::shared_ptr<PluginInsert> pi;
2239 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2240 pi->set_strict_io (_strict_io);
2244 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2248 _strict_io = !enable; // restore old value
2249 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2250 boost::shared_ptr<PluginInsert> pi;
2251 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2252 pi->set_strict_io (_strict_io);
2259 configure_processors (0);
2262 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2263 _session.set_dirty ();
2275 Route::get_template()
2277 return state(false);
2281 Route::state(bool full_state)
2284 if (!_session._template_state_dir.empty()) {
2285 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2288 XMLNode *node = new XMLNode("Route");
2289 ProcessorList::iterator i;
2292 id().print (buf, sizeof (buf));
2293 node->add_property("id", buf);
2294 node->add_property ("name", _name);
2295 node->add_property("default-type", _default_type.to_string());
2296 node->add_property ("strict-io", _strict_io);
2298 node->add_child_nocopy (_presentation_info.get_state());
2300 node->add_property("active", _active?"yes":"no");
2302 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2303 node->add_property("meter-point", enum_2_string (_meter_point));
2305 node->add_property("meter-type", enum_2_string (_meter_type));
2308 node->add_property("route-group", _route_group->name());
2311 node->add_child_nocopy (_solo_control->get_state ());
2312 node->add_child_nocopy (_solo_isolate_control->get_state ());
2313 node->add_child_nocopy (_solo_safe_control->get_state ());
2315 node->add_child_nocopy (_input->state (full_state));
2316 node->add_child_nocopy (_output->state (full_state));
2317 node->add_child_nocopy (_mute_master->get_state ());
2319 node->add_child_nocopy (_mute_control->get_state ());
2320 node->add_child_nocopy (_phase_control->get_state ());
2323 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2326 if (_comment.length()) {
2327 XMLNode *cmt = node->add_child ("Comment");
2328 cmt->add_content (_comment);
2332 node->add_child_nocopy (_pannable->state (full_state));
2336 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2337 for (i = _processors.begin(); i != _processors.end(); ++i) {
2339 /* template save: do not include internal sends functioning as
2340 aux sends because the chance of the target ID
2341 in the session where this template is used
2344 similarly, do not save listen sends which connect to
2345 the monitor section, because these will always be
2348 boost::shared_ptr<InternalSend> is;
2350 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2351 if (is->role() == Delivery::Listen) {
2356 node->add_child_nocopy((*i)->state (full_state));
2361 node->add_child_copy (*_extra_xml);
2364 if (_custom_meter_position_noted) {
2365 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2367 after->id().print (buf, sizeof (buf));
2368 node->add_property (X_("processor-after-last-custom-meter"), buf);
2372 if (!_session._template_state_dir.empty()) {
2373 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2376 node->add_child_copy (Slavable::get_state());
2382 Route::set_state (const XMLNode& node, int version)
2384 if (version < 3000) {
2385 return set_state_2X (node, version);
2389 XMLNodeConstIterator niter;
2391 XMLProperty const * prop;
2393 if (node.name() != "Route"){
2394 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2398 if ((prop = node.property (X_("name"))) != 0) {
2399 Route::set_name (prop->value());
2403 _initial_io_setup = true;
2405 Stripable::set_state (node, version);
2407 if ((prop = node.property (X_("strict-io"))) != 0) {
2408 _strict_io = string_is_affirmative (prop->value());
2412 /* monitor bus does not get a panner, but if (re)created
2413 via XML, it will already have one by the time we
2414 call ::set_state(). so ... remove it.
2419 /* add all processors (except amp, which is always present) */
2421 nlist = node.children();
2422 XMLNode processor_state (X_("processor_state"));
2424 Stateful::save_extra_xml (node);
2426 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2430 if (child->name() == IO::state_node_name) {
2431 if ((prop = child->property (X_("direction"))) == 0) {
2435 if (prop->value() == "Input") {
2436 _input->set_state (*child, version);
2437 } else if (prop->value() == "Output") {
2438 _output->set_state (*child, version);
2441 } else if (child->name() == X_("Processor")) {
2442 processor_state.add_child_copy (*child);
2443 } else if (child->name() == X_("Pannable")) {
2445 _pannable->set_state (*child, version);
2447 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2449 } else if (child->name() == Slavable::xml_node_name) {
2450 Slavable::set_state (*child, version);
2454 if ((prop = node.property (X_("meter-point"))) != 0) {
2455 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2456 set_meter_point (mp, true);
2458 _meter->set_display_to_user (_meter_point == MeterCustom);
2462 if ((prop = node.property (X_("meter-type"))) != 0) {
2463 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2466 _initial_io_setup = false;
2468 set_processor_state (processor_state);
2470 // this looks up the internal instrument in processors
2471 reset_instrument_info();
2473 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2474 set_denormal_protection (string_is_affirmative (prop->value()));
2477 if ((prop = node.property (X_("active"))) != 0) {
2478 bool yn = string_is_affirmative (prop->value());
2479 set_active (yn, this);
2482 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2483 PBD::ID id (prop->value ());
2484 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2485 ProcessorList::const_iterator i = _processors.begin ();
2486 while (i != _processors.end() && (*i)->id() != id) {
2490 if (i != _processors.end ()) {
2491 _processor_after_last_custom_meter = *i;
2492 _custom_meter_position_noted = true;
2496 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2499 if (child->name() == X_("Comment")) {
2501 /* XXX this is a terrible API design in libxml++ */
2503 XMLNode *cmt = *(child->children().begin());
2504 _comment = cmt->content();
2506 } else if (child->name() == Controllable::xml_node_name) {
2507 if ((prop = child->property (X_("name"))) == 0) {
2511 if (prop->value() == _gain_control->name()) {
2512 _gain_control->set_state (*child, version);
2513 } else if (prop->value() == _solo_control->name()) {
2514 _solo_control->set_state (*child, version);
2515 } else if (prop->value() == _solo_safe_control->name()) {
2516 _solo_safe_control->set_state (*child, version);
2517 } else if (prop->value() == _solo_isolate_control->name()) {
2518 _solo_isolate_control->set_state (*child, version);
2519 } else if (prop->value() == _mute_control->name()) {
2520 _mute_control->set_state (*child, version);
2521 } else if (prop->value() == _phase_control->name()) {
2522 _phase_control->set_state (*child, version);
2524 Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
2525 if (p.type () >= MidiCCAutomation && p.type () < MidiSystemExclusiveAutomation) {
2526 boost::shared_ptr<AutomationControl> ac = automation_control (p, true);
2528 ac->set_state (*child, version);
2532 } else if (child->name() == MuteMaster::xml_node_name) {
2533 _mute_master->set_state (*child, version);
2535 } else if (child->name() == Automatable::xml_node_name) {
2536 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2544 Route::set_state_2X (const XMLNode& node, int version)
2548 XMLNodeConstIterator niter;
2550 XMLProperty const * prop;
2552 /* 2X things which still remain to be handled:
2558 if (node.name() != "Route") {
2559 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2563 Stripable::set_state (node, version);
2565 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2566 set_denormal_protection (string_is_affirmative (prop->value()));
2569 if ((prop = node.property (X_("muted"))) != 0) {
2572 bool muted = string_is_affirmative (prop->value());
2578 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2580 if (string_is_affirmative (prop->value())){
2581 mute_point = mute_point + "PreFader";
2586 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2588 if (string_is_affirmative (prop->value())){
2591 mute_point = mute_point + ",";
2594 mute_point = mute_point + "PostFader";
2599 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2601 if (string_is_affirmative (prop->value())){
2604 mute_point = mute_point + ",";
2607 mute_point = mute_point + "Listen";
2612 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2614 if (string_is_affirmative (prop->value())){
2617 mute_point = mute_point + ",";
2620 mute_point = mute_point + "Main";
2624 _mute_master->set_mute_points (mute_point);
2625 _mute_master->set_muted_by_self (true);
2629 if ((prop = node.property (X_("meter-point"))) != 0) {
2630 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2635 nlist = node.children ();
2636 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2640 if (child->name() == IO::state_node_name) {
2642 /* there is a note in IO::set_state_2X() about why we have to call
2646 _input->set_state_2X (*child, version, true);
2647 _output->set_state_2X (*child, version, false);
2649 if ((prop = child->property (X_("name"))) != 0) {
2650 Route::set_name (prop->value ());
2655 if ((prop = child->property (X_("active"))) != 0) {
2656 bool yn = string_is_affirmative (prop->value());
2657 _active = !yn; // force switch
2658 set_active (yn, this);
2661 if ((prop = child->property (X_("gain"))) != 0) {
2664 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2665 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2669 /* Set up Panners in the IO */
2670 XMLNodeList io_nlist = child->children ();
2672 XMLNodeConstIterator io_niter;
2675 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2677 io_child = *io_niter;
2679 if (io_child->name() == X_("Panner")) {
2680 _main_outs->panner_shell()->set_state(*io_child, version);
2681 } else if (io_child->name() == X_("Automation")) {
2682 /* IO's automation is for the fader */
2683 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2689 XMLNodeList redirect_nodes;
2691 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2695 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2696 redirect_nodes.push_back(child);
2701 set_processor_state_2X (redirect_nodes, version);
2703 Stateful::save_extra_xml (node);
2705 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2708 if (child->name() == X_("Comment")) {
2710 /* XXX this is a terrible API design in libxml++ */
2712 XMLNode *cmt = *(child->children().begin());
2713 _comment = cmt->content();
2715 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2716 if (prop->value() == X_("solo")) {
2717 _solo_control->set_state (*child, version);
2718 } else if (prop->value() == X_("mute")) {
2719 _mute_control->set_state (*child, version);
2729 Route::get_processor_state ()
2731 XMLNode* root = new XMLNode (X_("redirects"));
2732 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2733 root->add_child_nocopy ((*i)->state (true));
2740 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2742 /* We don't bother removing existing processors not in nList, as this
2743 method will only be called when creating a Route from scratch, not
2744 for undo purposes. Just put processors in at the appropriate place
2748 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2749 add_processor_from_xml_2X (**i, version);
2754 Route::set_processor_state (const XMLNode& node)
2756 const XMLNodeList &nlist = node.children();
2757 XMLNodeConstIterator niter;
2758 ProcessorList new_order;
2759 bool must_configure = false;
2761 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2763 XMLProperty* prop = (*niter)->property ("type");
2765 if (prop->value() == "amp") {
2766 _amp->set_state (**niter, Stateful::current_state_version);
2767 new_order.push_back (_amp);
2768 } else if (prop->value() == "trim") {
2769 _trim->set_state (**niter, Stateful::current_state_version);
2770 new_order.push_back (_trim);
2771 } else if (prop->value() == "meter") {
2772 _meter->set_state (**niter, Stateful::current_state_version);
2773 new_order.push_back (_meter);
2774 } else if (prop->value() == "delay") {
2776 _delayline->set_state (**niter, Stateful::current_state_version);
2777 new_order.push_back (_delayline);
2779 } else if (prop->value() == "main-outs") {
2780 _main_outs->set_state (**niter, Stateful::current_state_version);
2781 } else if (prop->value() == "intreturn") {
2783 _intreturn.reset (new InternalReturn (_session));
2784 must_configure = true;
2786 _intreturn->set_state (**niter, Stateful::current_state_version);
2787 } else if (is_monitor() && prop->value() == "monitor") {
2788 if (!_monitor_control) {
2789 _monitor_control.reset (new MonitorProcessor (_session));
2790 must_configure = true;
2792 _monitor_control->set_state (**niter, Stateful::current_state_version);
2793 } else if (prop->value() == "capture") {
2794 /* CapturingProcessor should never be restored, it's always
2795 added explicitly when needed */
2797 ProcessorList::iterator o;
2799 for (o = _processors.begin(); o != _processors.end(); ++o) {
2800 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2801 if (id_prop && (*o)->id() == id_prop->value()) {
2802 (*o)->set_state (**niter, Stateful::current_state_version);
2803 new_order.push_back (*o);
2808 // If the processor (*niter) is not on the route then create it
2810 if (o == _processors.end()) {
2812 boost::shared_ptr<Processor> processor;
2814 if (prop->value() == "intsend") {
2816 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2818 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2819 prop->value() == "lv2" ||
2820 prop->value() == "windows-vst" ||
2821 prop->value() == "mac-vst" ||
2822 prop->value() == "lxvst" ||
2823 prop->value() == "luaproc" ||
2824 prop->value() == "audiounit") {
2826 if (_session.get_disable_all_loaded_plugins ()) {
2827 processor.reset (new UnknownProcessor (_session, **niter));
2829 processor.reset (new PluginInsert (_session));
2830 processor->set_owner (this);
2832 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2833 pi->set_strict_io (true);
2837 } else if (prop->value() == "port") {
2839 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2841 } else if (prop->value() == "send") {
2843 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2844 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2845 send->SelfDestruct.connect_same_thread (*this,
2846 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2849 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2853 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2854 /* This processor could not be configured. Turn it into a UnknownProcessor */
2855 processor.reset (new UnknownProcessor (_session, **niter));
2858 /* subscribe to Sidechain IO changes */
2859 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2860 if (pi && pi->has_sidechain ()) {
2861 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2864 /* we have to note the monitor send here, otherwise a new one will be created
2865 and the state of this one will be lost.
2867 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2868 if (isend && isend->role() == Delivery::Listen) {
2869 _monitor_send = isend;
2872 /* it doesn't matter if invisible processors are added here, as they
2873 will be sorted out by setup_invisible_processors () shortly.
2876 new_order.push_back (processor);
2877 must_configure = true;
2883 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2884 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2885 /* re-assign _processors w/o process-lock.
2886 * if there's an IO-processor present in _processors but
2887 * not in new_order, it will be deleted and ~IO takes
2890 _processors = new_order;
2892 if (must_configure) {
2893 configure_processors_unlocked (0, &lm);
2896 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2898 (*i)->set_owner (this);
2899 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2901 boost::shared_ptr<PluginInsert> pi;
2903 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2904 if (pi->has_no_inputs ()) {
2905 _have_internal_generator = true;
2912 reset_instrument_info ();
2913 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2914 set_processor_positions ();
2918 Route::curve_reallocate ()
2920 // _gain_automation_curve.finish_resize ();
2921 // _pan_automation_curve.finish_resize ();
2925 Route::silence (framecnt_t nframes)
2927 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2932 silence_unlocked (nframes);
2936 Route::silence_unlocked (framecnt_t nframes)
2938 /* Must be called with the processor lock held */
2940 const framepos_t now = _session.transport_frame ();
2944 _output->silence (nframes);
2946 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2947 boost::shared_ptr<PluginInsert> pi;
2949 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2950 // skip plugins, they don't need anything when we're not active
2954 (*i)->silence (nframes, now);
2957 if (nframes == _session.get_block_size()) {
2964 Route::add_internal_return ()
2967 _intreturn.reset (new InternalReturn (_session));
2968 add_processor (_intreturn, PreFader);
2973 Route::add_send_to_internal_return (InternalSend* send)
2975 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2977 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2978 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2981 return d->add_send (send);
2987 Route::remove_send_from_internal_return (InternalSend* send)
2989 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2991 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2992 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2995 return d->remove_send (send);
3001 Route::enable_monitor_send ()
3003 /* Caller must hold process lock */
3004 assert (!AudioEngine::instance()->process_lock().trylock());
3006 /* master never sends to monitor section via the normal mechanism */
3007 assert (!is_master ());
3008 assert (!is_monitor ());
3010 /* make sure we have one */
3011 if (!_monitor_send) {
3012 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
3013 _monitor_send->set_display_to_user (false);
3017 configure_processors (0);
3020 /** Add an aux send to a route.
3021 * @param route route to send to.
3022 * @param before Processor to insert before, or 0 to insert at the end.
3025 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
3027 assert (route != _session.monitor_out ());
3030 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3032 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3034 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
3036 if (d && d->target_route() == route) {
3037 /* already listening via the specified IO: do nothing */
3045 boost::shared_ptr<InternalSend> listener;
3048 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3049 listener.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3052 add_processor (listener, before);
3054 } catch (failed_constructor& err) {
3062 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3064 ProcessorStreams err;
3065 ProcessorList::iterator tmp;
3068 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3070 /* have to do this early because otherwise processor reconfig
3071 * will put _monitor_send back in the list
3074 if (route == _session.monitor_out()) {
3075 _monitor_send.reset ();
3079 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3081 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3083 if (d && d->target_route() == route) {
3085 if (remove_processor (*x, &err, false) > 0) {
3091 /* list could have been demolished while we dropped the lock
3094 if (_session.engine().connected()) {
3095 /* i/o processors cannot be removed if the engine is not running
3096 * so don't live-loop in case the engine is N/A or dies
3106 Route::set_comment (string cmt, void *src)
3110 _session.set_dirty ();
3114 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3116 FeedRecord fr (other, via_sends_only);
3118 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3120 if (!result.second) {
3122 /* already a record for "other" - make sure sends-only information is correct */
3123 if (!via_sends_only && result.first->sends_only) {
3124 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3125 frp->sends_only = false;
3129 return result.second;
3133 Route::clear_fed_by ()
3139 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3141 const FedBy& fed_by (other->fed_by());
3143 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3144 boost::shared_ptr<Route> sr = f->r.lock();
3146 if (sr && (sr.get() == this)) {
3148 if (via_sends_only) {
3149 *via_sends_only = f->sends_only;
3160 Route::all_inputs () const
3162 /* TODO, if this works as expected,
3163 * cache the IOVector and maintain it via
3164 * input_change_handler(), sidechain_change_handler() etc
3167 ios.push_back (_input);
3169 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3170 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3172 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3173 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3176 iop = pi->sidechain();
3179 if (iop != 0 && iop->input()) {
3180 ios.push_back (iop->input());
3187 Route::all_outputs () const
3190 // _output is included via Delivery
3191 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3192 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3193 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3194 if (iop != 0 && iop->output()) {
3195 ios.push_back (iop->output());
3202 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3204 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3205 if (other->all_inputs().fed_by (_output)) {
3206 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3207 if (via_send_only) {
3208 *via_send_only = false;
3214 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3216 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3218 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3219 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3222 iop = pi->sidechain();
3226 boost::shared_ptr<const IO> iop_out = iop->output();
3227 if (other.get() == this && iop_out && iop->input() && iop_out->connected_to (iop->input())) {
3228 // TODO this needs a delaylines in the Insert to align connections (!)
3229 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed its own return (%2)\n", iop->name(), other->name()));
3232 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3233 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3234 if (via_send_only) {
3235 *via_send_only = true;
3239 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3242 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3247 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3252 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3254 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3258 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3260 return _session._current_route_graph.feeds (shared_from_this (), other);
3263 /** Called from the (non-realtime) butler thread when the transport is stopped */
3265 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3267 framepos_t now = _session.transport_frame();
3270 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3272 Automatable::transport_stopped (now);
3274 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3276 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3280 (*i)->transport_stopped (now);
3284 _roll_delay = _initial_delay;
3288 Route::input_change_handler (IOChange change, void * /*src*/)
3290 if ((change.type & IOChange::ConfigurationChanged)) {
3291 /* This is called with the process lock held if change
3292 contains ConfigurationChanged
3294 configure_processors (0);
3295 _phase_control->resize (_input->n_ports().n_audio ());
3296 io_changed (); /* EMIT SIGNAL */
3299 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3302 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3303 if (_input->connected()) {
3304 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3305 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3309 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3310 if (does_feed && !sends_only) {
3311 if ((*i)->soloed()) {
3314 if ((*i)->solo_isolate_control()->solo_isolated()) {
3321 int delta = sbou - _solo_control->soloed_by_others_upstream();
3322 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3325 PBD::warning << string_compose (
3326 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3327 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3332 if (_solo_control->soloed_by_others_upstream()) {
3333 // ignore new connections (they're not propagated)
3335 _solo_control->mod_solo_by_others_upstream (delta);
3339 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3340 // solo-isolate currently only propagates downstream
3342 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3344 //_solo_isolated_by_upstream = ibou;
3347 // Session::route_solo_changed does not propagate indirect solo-changes
3348 // propagate downstream to tracks
3349 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3350 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3354 bool does_feed = feeds (*i, &sends_only);
3355 if (delta <= 0 && does_feed && !sends_only) {
3356 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3359 if (idelta < 0 && does_feed && !sends_only) {
3360 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3367 Route::output_change_handler (IOChange change, void * /*src*/)
3369 if (_initial_io_setup) {
3373 if ((change.type & IOChange::ConfigurationChanged)) {
3374 /* This is called with the process lock held if change
3375 contains ConfigurationChanged
3377 configure_processors (0);
3380 _session.reset_monitor_section();
3383 io_changed (); /* EMIT SIGNAL */
3386 if ((change.type & IOChange::ConnectionsChanged)) {
3388 /* do this ONLY if connections have changed. Configuration
3389 * changes do not, by themselves alter solo upstream or
3390 * downstream status.
3393 if (_solo_control->soloed_by_others_downstream()) {
3395 /* checking all all downstream routes for
3396 * explicit of implict solo is a rather drastic measure,
3397 * ideally the input_change_handler() of the other route
3398 * would propagate the change to us.
3400 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3401 if (_output->connected()) {
3402 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3403 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3407 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3408 if (does_feed && !sends_only) {
3409 if ((*i)->soloed()) {
3417 cerr << "computed sbod = " << sbod << endl;
3419 int delta = sbod - _solo_control->soloed_by_others_downstream();
3421 // do not allow new connections to change implicit solo (no propagation)
3422 _solo_control->mod_solo_by_others_downstream (delta);
3423 // Session::route_solo_changed() does not propagate indirect solo-changes
3424 // propagate upstream to tracks
3425 boost::shared_ptr<Route> shared_this = shared_from_this();
3426 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3427 if ((*i).get() == this || !can_solo()) {
3431 bool does_feed = (*i)->feeds (shared_this, &sends_only);
3432 if (delta != 0 && does_feed && !sends_only) {
3433 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3443 Route::sidechain_change_handler (IOChange change, void* src)
3445 if (_initial_io_setup || _in_sidechain_setup) {
3449 input_change_handler (change, src);
3453 Route::pans_required () const
3455 if (n_outputs().n_audio() < 2) {
3459 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3463 Route::flush_processor_buffers_locked (framecnt_t nframes)
3465 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3466 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3468 d->flush_buffers (nframes);
3470 boost::shared_ptr<PortInsert> p = boost::dynamic_pointer_cast<PortInsert> (*i);
3472 p->flush_buffers (nframes);
3479 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3481 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3487 if (n_outputs().n_total() == 0) {
3491 if (!_active || n_inputs() == ChanCount::ZERO) {
3492 silence_unlocked (nframes);
3496 if (session_state_changing) {
3497 if (_session.transport_speed() != 0.0f) {
3498 /* we're rolling but some state is changing (e.g. our diskstream contents)
3499 so we cannot use them. Be silent till this is over.
3501 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3503 silence_unlocked (nframes);
3506 /* we're really not rolling, so we're either delivery silence or actually
3507 monitoring, both of which are safe to do while session_state_changing is true.
3511 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3513 fill_buffers_with_input (bufs, _input, nframes);
3515 if (_meter_point == MeterInput) {
3516 _meter->run (bufs, start_frame, end_frame, 0.0, nframes, true);
3519 _amp->apply_gain_automation (false);
3520 _trim->apply_gain_automation (false);
3521 passthru (bufs, start_frame, end_frame, nframes, 0);
3523 flush_processor_buffers_locked (nframes);
3529 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3531 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3536 if (n_outputs().n_total() == 0) {
3540 if (!_active || n_inputs().n_total() == 0) {
3541 silence_unlocked (nframes);
3545 framepos_t unused = 0;
3547 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3553 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3555 fill_buffers_with_input (bufs, _input, nframes);
3557 if (_meter_point == MeterInput) {
3558 _meter->run (bufs, start_frame, end_frame, 1.0, nframes, true);
3561 passthru (bufs, start_frame, end_frame, nframes, declick);
3563 flush_processor_buffers_locked (nframes);
3569 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3572 flush_processor_buffers_locked (nframes);
3577 Route::flush_processors ()
3579 /* XXX shouldn't really try to take this lock, since
3580 this is called from the RT audio thread.
3583 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3585 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3591 __attribute__((annotate("realtime")))
3594 Route::apply_processor_changes_rt ()
3596 int emissions = EmitNone;
3598 if (_pending_meter_point != _meter_point) {
3599 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3601 /* meters always have buffers for 'processor_max_streams'
3602 * they can be re-positioned without re-allocation */
3603 if (set_meter_point_unlocked()) {
3604 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3606 emissions |= EmitMeterChanged;
3611 bool changed = false;
3613 if (g_atomic_int_get (&_pending_process_reorder)) {
3614 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3616 apply_processor_order (_pending_processor_order);
3617 setup_invisible_processors ();
3619 g_atomic_int_set (&_pending_process_reorder, 0);
3620 emissions |= EmitRtProcessorChange;
3624 set_processor_positions ();
3626 if (emissions != 0) {
3627 g_atomic_int_set (&_pending_signals, emissions);
3630 return (!selfdestruct_sequence.empty ());
3634 Route::emit_pending_signals ()
3636 int sig = g_atomic_int_and (&_pending_signals, 0);
3637 if (sig & EmitMeterChanged) {
3638 _meter->emit_configuration_changed();
3639 meter_change (); /* EMIT SIGNAL */
3640 if (sig & EmitMeterVisibilityChange) {
3641 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3643 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3646 if (sig & EmitRtProcessorChange) {
3647 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3650 /* this would be a job for the butler.
3651 * Conceptually we should not take processe/processor locks here.
3652 * OTOH its more efficient (less overhead for summoning the butler and
3653 * telling her what do do) and signal emission is called
3654 * directly after the process callback, which decreases the chance
3655 * of x-runs when taking the locks.
3657 while (!selfdestruct_sequence.empty ()) {
3658 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3659 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3660 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3661 selfdestruct_sequence.pop_back ();
3664 remove_processor (proc);
3670 Route::set_meter_point (MeterPoint p, bool force)
3672 if (_pending_meter_point == p && !force) {
3676 if (force || !AudioEngine::instance()->running()) {
3677 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3678 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3679 _pending_meter_point = p;
3680 _meter->emit_configuration_changed();
3681 meter_change (); /* EMIT SIGNAL */
3682 if (set_meter_point_unlocked()) {
3683 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3685 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3688 _pending_meter_point = p;
3694 __attribute__((annotate("realtime")))
3697 Route::set_meter_point_unlocked ()
3700 /* Caller must hold process and processor write lock */
3701 assert (!AudioEngine::instance()->process_lock().trylock());
3702 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3703 assert (!lm.locked ());
3706 _meter_point = _pending_meter_point;
3708 bool meter_was_visible_to_user = _meter->display_to_user ();
3710 if (!_custom_meter_position_noted) {
3711 maybe_note_meter_position ();
3714 if (_meter_point != MeterCustom) {
3716 _meter->set_display_to_user (false);
3718 setup_invisible_processors ();
3721 _meter->set_display_to_user (true);
3723 /* If we have a previous position for the custom meter, try to put it there */
3724 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3726 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3727 if (i != _processors.end ()) {
3728 _processors.remove (_meter);
3729 _processors.insert (i, _meter);
3731 } else {// at end, right before the mains_out/panner
3732 _processors.remove (_meter);
3733 ProcessorList::iterator main = _processors.end();
3734 _processors.insert (--main, _meter);
3738 /* Set up the meter for its new position */
3740 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3744 if (loc == _processors.begin()) {
3745 m_in = _input->n_ports();
3747 ProcessorList::iterator before = loc;
3749 m_in = (*before)->output_streams ();
3752 _meter->reflect_inputs (m_in);
3754 /* we do not need to reconfigure the processors, because the meter
3755 (a) is always ready to handle processor_max_streams
3756 (b) is always an N-in/N-out processor, and thus moving
3757 it doesn't require any changes to the other processors.
3760 /* these should really be done after releasing the lock
3761 * but all those signals are subscribed to with gui_thread()
3764 return (_meter->display_to_user() != meter_was_visible_to_user);
3768 Route::listen_position_changed ()
3771 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3772 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3773 ProcessorState pstate (this);
3775 if (configure_processors_unlocked (0, &lm)) {
3776 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3778 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3783 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3784 _session.set_dirty ();
3787 boost::shared_ptr<CapturingProcessor>
3788 Route::add_export_point()
3790 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3791 if (!_capturing_processor) {
3793 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3794 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3796 // this aligns all tracks; but not tracks + busses
3797 assert (_session.worst_track_latency () >= _initial_delay);
3798 _capturing_processor.reset (new CapturingProcessor (_session, _session.worst_track_latency () - _initial_delay));
3799 _capturing_processor->activate ();
3801 configure_processors_unlocked (0, &lw);
3805 return _capturing_processor;
3809 Route::update_signal_latency ()
3811 framecnt_t l = _output->user_latency();
3812 framecnt_t lamp = 0;
3813 bool before_amp = true;
3814 framecnt_t ltrim = 0;
3815 bool before_trim = true;
3817 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3818 if ((*i)->active ()) {
3819 l += (*i)->signal_latency ();
3824 if ((*i) == _trim) {
3835 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3837 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3838 _signal_latency_at_amp_position = lamp;
3839 _signal_latency_at_trim_position = ltrim;
3841 if (_signal_latency != l) {
3842 _signal_latency = l;
3843 signal_latency_changed (); /* EMIT SIGNAL */
3846 return _signal_latency;
3850 Route::set_user_latency (framecnt_t nframes)
3852 _output->set_user_latency (nframes);
3853 _session.update_latency_compensation ();
3857 Route::set_latency_compensation (framecnt_t longest_session_latency)
3859 framecnt_t old = _initial_delay;
3861 if (_signal_latency < longest_session_latency) {
3862 _initial_delay = longest_session_latency - _signal_latency;
3867 DEBUG_TRACE (DEBUG::Latency, string_compose (
3868 "%1: compensate for maximum latency of %2,"
3869 "given own latency of %3, using initial delay of %4\n",
3870 name(), longest_session_latency, _signal_latency, _initial_delay));
3872 if (_initial_delay != old) {
3873 initial_delay_changed (); /* EMIT SIGNAL */
3876 if (_session.transport_stopped()) {
3877 _roll_delay = _initial_delay;
3882 Route::set_block_size (pframes_t nframes)
3884 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3885 (*i)->set_block_size (nframes);
3888 _session.ensure_buffers (n_process_buffers ());
3892 Route::protect_automation ()
3894 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3895 (*i)->protect_automation();
3898 /** @param declick 1 to set a pending declick fade-in,
3899 * -1 to set a pending declick fade-out
3902 Route::set_pending_declick (int declick)
3905 /* this call is not allowed to turn off a pending declick */
3907 _pending_declick = declick;
3910 _pending_declick = 0;
3914 /** Shift automation forwards from a particular place, thereby inserting time.
3915 * Adds undo commands for any shifts that are performed.
3917 * @param pos Position to start shifting from.
3918 * @param frames Amount to shift forwards by.
3922 Route::shift (framepos_t pos, framecnt_t frames)
3924 /* gain automation */
3926 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3928 XMLNode &before = gc->alist()->get_state ();
3929 gc->alist()->shift (pos, frames);
3930 XMLNode &after = gc->alist()->get_state ();
3931 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3934 /* gain automation */
3936 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3938 XMLNode &before = gc->alist()->get_state ();
3939 gc->alist()->shift (pos, frames);
3940 XMLNode &after = gc->alist()->get_state ();
3941 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3944 // TODO mute automation ??
3946 /* pan automation */
3948 ControlSet::Controls& c (_pannable->controls());
3950 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3951 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3953 boost::shared_ptr<AutomationList> al = pc->alist();
3954 XMLNode& before = al->get_state ();
3955 al->shift (pos, frames);
3956 XMLNode& after = al->get_state ();
3957 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3962 /* redirect automation */
3964 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3965 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3967 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3969 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3970 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3972 boost::shared_ptr<AutomationList> al = ac->alist();
3973 XMLNode &before = al->get_state ();
3974 al->shift (pos, frames);
3975 XMLNode &after = al->get_state ();
3976 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3984 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
3986 boost::shared_ptr<Processor> processor (p.lock ());
3987 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3991 pi->set_state_dir (d);
3995 Route::save_as_template (const string& path, const string& name)
3997 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
3998 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
4000 XMLNode& node (state (false));
4004 IO::set_name_in_state (*node.children().front(), name);
4006 tree.set_root (&node);
4008 /* return zero on success, non-zero otherwise */
4009 return !tree.write (path.c_str());
4014 Route::set_name (const string& str)
4016 if (str == name()) {
4020 string name = Route::ensure_track_or_route_name (str, _session);
4021 SessionObject::set_name (name);
4023 bool ret = (_input->set_name(name) && _output->set_name(name));
4026 /* rename the main outs. Leave other IO processors
4027 * with whatever name they already have, because its
4028 * just fine as it is (it will not contain the route
4029 * name if its a port insert, port send or port return).
4033 if (_main_outs->set_name (name)) {
4034 /* XXX returning false here is stupid because
4035 we already changed the route name.
4045 /** Set the name of a route in an XML description.
4046 * @param node XML <Route> node to set the name in.
4047 * @param name New name.
4050 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
4052 node.add_property (X_("name"), name);
4054 XMLNodeList children = node.children();
4055 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
4057 if ((*i)->name() == X_("IO")) {
4059 IO::set_name_in_state (**i, name);
4061 } else if ((*i)->name() == X_("Processor")) {
4063 XMLProperty const * role = (*i)->property (X_("role"));
4064 if (role && role->value() == X_("Main")) {
4065 (*i)->add_property (X_("name"), name);
4068 } else if ((*i)->name() == X_("Diskstream")) {
4070 if (rename_playlist) {
4071 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
4073 (*i)->add_property (X_("name"), name);
4079 boost::shared_ptr<Send>
4080 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4082 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4084 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4085 boost::shared_ptr<InternalSend> send;
4087 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4088 if (send->target_route() == target) {
4094 return boost::shared_ptr<Send>();
4098 Route::set_denormal_protection (bool yn)
4100 if (_denormal_protection != yn) {
4101 _denormal_protection = yn;
4102 denormal_protection_changed (); /* EMIT SIGNAL */
4107 Route::denormal_protection () const
4109 return _denormal_protection;
4113 Route::set_active (bool yn, void* src)
4115 if (_session.transport_rolling()) {
4119 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4120 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4124 if (_active != yn) {
4126 _input->set_active (yn);
4127 _output->set_active (yn);
4128 active_changed (); // EMIT SIGNAL
4129 _session.set_dirty ();
4133 boost::shared_ptr<Pannable>
4134 Route::pannable() const
4139 boost::shared_ptr<Panner>
4140 Route::panner() const
4143 return _main_outs->panner_shell()->panner();
4146 boost::shared_ptr<PannerShell>
4147 Route::panner_shell() const
4149 return _main_outs->panner_shell();
4152 boost::shared_ptr<GainControl>
4153 Route::gain_control() const
4155 return _gain_control;
4158 boost::shared_ptr<GainControl>
4159 Route::trim_control() const
4161 return _trim_control;
4164 boost::shared_ptr<PhaseControl>
4165 Route::phase_control() const
4167 return _phase_control;
4170 boost::shared_ptr<AutomationControl>
4171 Route::get_control (const Evoral::Parameter& param)
4173 /* either we own the control or .... */
4175 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4179 /* maybe one of our processors does or ... */
4181 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4182 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4183 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4191 /* nobody does so we'll make a new one */
4193 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4200 boost::shared_ptr<Processor>
4201 Route::nth_plugin (uint32_t n) const
4203 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4204 ProcessorList::const_iterator i;
4206 for (i = _processors.begin(); i != _processors.end(); ++i) {
4207 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4214 return boost::shared_ptr<Processor> ();
4217 boost::shared_ptr<Processor>
4218 Route::nth_send (uint32_t n) const
4220 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4221 ProcessorList::const_iterator i;
4223 for (i = _processors.begin(); i != _processors.end(); ++i) {
4224 if (boost::dynamic_pointer_cast<Send> (*i)) {
4226 if ((*i)->name().find (_("Monitor")) == 0) {
4227 /* send to monitor section is not considered
4228 to be an accessible send.
4239 return boost::shared_ptr<Processor> ();
4243 Route::has_io_processor_named (const string& name)
4245 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4246 ProcessorList::iterator i;
4248 for (i = _processors.begin(); i != _processors.end(); ++i) {
4249 if (boost::dynamic_pointer_cast<Send> (*i) ||
4250 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4251 if ((*i)->name() == name) {
4261 Route::set_processor_positions ()
4263 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4265 bool had_amp = false;
4266 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4267 (*i)->set_pre_fader (!had_amp);
4274 /** Called when there is a proposed change to the input port count */
4276 Route::input_port_count_changing (ChanCount to)
4278 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4280 /* The processors cannot be configured with the new input arrangement, so
4286 /* The change is ok */
4290 /** Called when there is a proposed change to the output port count */
4292 Route::output_port_count_changing (ChanCount to)
4294 if (_strict_io && !_in_configure_processors) {
4297 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4298 if (processor_out_streams.get(*t) > to.get(*t)) {
4302 /* The change is ok */
4307 Route::unknown_processors () const
4311 if (_session.get_disable_all_loaded_plugins ()) {
4312 // Do not list "missing plugins" if they are explicitly disabled
4316 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4317 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4318 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4319 p.push_back ((*i)->name ());
4328 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4330 /* we assume that all our input ports feed all our output ports. its not
4331 universally true, but the alternative is way too corner-case to worry about.
4334 LatencyRange all_connections;
4337 all_connections.min = 0;
4338 all_connections.max = 0;
4340 all_connections.min = ~((pframes_t) 0);
4341 all_connections.max = 0;
4343 /* iterate over all "from" ports and determine the latency range for all of their
4344 connections to the "outside" (outside of this Route).
4347 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4351 p->get_connected_latency_range (range, playback);
4353 all_connections.min = min (all_connections.min, range.min);
4354 all_connections.max = max (all_connections.max, range.max);
4358 /* set the "from" port latencies to the max/min range of all their connections */
4360 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4361 p->set_private_latency_range (all_connections, playback);
4364 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4366 all_connections.min += our_latency;
4367 all_connections.max += our_latency;
4369 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4370 p->set_private_latency_range (all_connections, playback);
4373 return all_connections.max;
4377 Route::set_private_port_latencies (bool playback) const
4379 framecnt_t own_latency = 0;
4381 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4382 OR LATENCY CALLBACK.
4384 This is called (early) from the latency callback. It computes the REAL
4385 latency associated with each port and stores the result as the "private"
4386 latency of the port. A later call to Route::set_public_port_latencies()
4387 sets all ports to the same value to reflect the fact that we do latency
4388 compensation and so all signals are delayed by the same amount as they
4389 flow through ardour.
4392 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4393 if ((*i)->active ()) {
4394 own_latency += (*i)->signal_latency ();
4399 /* playback: propagate latency from "outside the route" to outputs to inputs */
4400 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4402 /* capture: propagate latency from "outside the route" to inputs to outputs */
4403 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4408 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4410 /* this is called to set the JACK-visible port latencies, which take
4411 latency compensation into account.
4420 const PortSet& ports (_input->ports());
4421 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4422 p->set_public_latency_range (range, playback);
4427 const PortSet& ports (_output->ports());
4428 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4429 p->set_public_latency_range (range, playback);
4434 /** Put the invisible processors in the right place in _processors.
4435 * Must be called with a writer lock on _processor_lock held.
4438 __attribute__((annotate("realtime")))
4441 Route::setup_invisible_processors ()
4444 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4445 assert (!lm.locked ());
4449 /* too early to be doing this stuff */
4453 /* we'll build this new list here and then use it
4455 * TODO put the ProcessorList is on the stack for RT-safety.
4458 ProcessorList new_processors;
4460 /* find visible processors */
4462 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4463 if ((*i)->display_to_user ()) {
4464 new_processors.push_back (*i);
4470 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4472 if (amp == new_processors.end ()) {
4473 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4474 new_processors.push_front (_amp);
4475 amp = find (new_processors.begin(), new_processors.end(), _amp);
4478 /* and the processor after the amp */
4480 ProcessorList::iterator after_amp = amp;
4486 switch (_meter_point) {
4488 assert (!_meter->display_to_user ());
4489 new_processors.push_front (_meter);
4492 assert (!_meter->display_to_user ());
4493 new_processors.insert (amp, _meter);
4495 case MeterPostFader:
4496 /* do nothing here */
4499 /* do nothing here */
4502 /* the meter is visible, so we don't touch it here */
4509 assert (_main_outs);
4510 assert (!_main_outs->display_to_user ());
4511 new_processors.push_back (_main_outs);
4513 /* iterator for the main outs */
4515 ProcessorList::iterator main = new_processors.end();
4518 /* OUTPUT METERING */
4520 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4521 assert (!_meter->display_to_user ());
4523 /* add the processor just before or just after the main outs */
4525 ProcessorList::iterator meter_point = main;
4527 if (_meter_point == MeterOutput) {
4530 new_processors.insert (meter_point, _meter);
4535 if (_monitor_send && !is_monitor ()) {
4536 assert (!_monitor_send->display_to_user ());
4537 switch (Config->get_listen_position ()) {
4538 case PreFaderListen:
4539 switch (Config->get_pfl_position ()) {
4540 case PFLFromBeforeProcessors:
4541 new_processors.push_front (_monitor_send);
4543 case PFLFromAfterProcessors:
4544 new_processors.insert (amp, _monitor_send);
4547 _monitor_send->set_can_pan (false);
4549 case AfterFaderListen:
4550 switch (Config->get_afl_position ()) {
4551 case AFLFromBeforeProcessors:
4552 new_processors.insert (after_amp, _monitor_send);
4554 case AFLFromAfterProcessors:
4555 new_processors.insert (new_processors.end(), _monitor_send);
4558 _monitor_send->set_can_pan (true);
4563 #if 0 // not used - just yet
4564 if (!is_master() && !is_monitor() && !is_auditioner()) {
4565 new_processors.push_front (_delayline);
4569 /* MONITOR CONTROL */
4571 if (_monitor_control && is_monitor ()) {
4572 assert (!_monitor_control->display_to_user ());
4573 new_processors.insert (amp, _monitor_control);
4578 if (_trim && _trim->active()) {
4579 assert (!_trim->display_to_user ());
4580 new_processors.push_front (_trim);
4583 /* INTERNAL RETURN */
4585 /* doing this here means that any monitor control will come after
4586 the return and trim.
4590 assert (!_intreturn->display_to_user ());
4591 new_processors.push_front (_intreturn);
4594 /* EXPORT PROCESSOR */
4596 if (_capturing_processor) {
4597 assert (!_capturing_processor->display_to_user ());
4598 new_processors.push_front (_capturing_processor);
4601 _processors = new_processors;
4603 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4604 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4605 (*i)->enable (true);
4609 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4610 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4611 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4618 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4619 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4623 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4624 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4631 /** If the meter point is `Custom', make a note of where the meter is.
4632 * This is so that if the meter point is subsequently set to something else,
4633 * and then back to custom, we can put the meter back where it was last time
4634 * custom was enabled.
4636 * Must be called with the _processor_lock held.
4639 Route::maybe_note_meter_position ()
4641 if (_meter_point != MeterCustom) {
4645 _custom_meter_position_noted = true;
4646 /* custom meter points range from after trim to before panner/main_outs
4647 * this is a limitation by the current processor UI
4649 bool seen_trim = false;
4650 _processor_after_last_custom_meter.reset();
4651 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4652 if ((*i) == _trim) {
4655 if ((*i) == _main_outs) {
4656 _processor_after_last_custom_meter = *i;
4659 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4661 _processor_after_last_custom_meter = _trim;
4663 ProcessorList::iterator j = i;
4665 assert(j != _processors.end ()); // main_outs should be before
4666 _processor_after_last_custom_meter = *j;
4671 assert(_processor_after_last_custom_meter.lock());
4674 boost::shared_ptr<Processor>
4675 Route::processor_by_id (PBD::ID id) const
4677 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4678 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4679 if ((*i)->id() == id) {
4684 return boost::shared_ptr<Processor> ();
4687 /** @return the monitoring state, or in other words what data we are pushing
4688 * into the route (data from the inputs, data from disk or silence)
4691 Route::monitoring_state () const
4693 return MonitoringInput;
4696 /** @return what we should be metering; either the data coming from the input
4697 * IO or the data that is flowing through the route.
4700 Route::metering_state () const
4702 return MeteringRoute;
4706 Route::has_external_redirects () const
4708 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4710 /* ignore inactive processors and obviously ignore the main
4711 * outs since everything has them and we don't care.
4714 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4722 boost::shared_ptr<Processor>
4723 Route::the_instrument () const
4725 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4726 return the_instrument_unlocked ();
4729 boost::shared_ptr<Processor>
4730 Route::the_instrument_unlocked () const
4732 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4733 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4734 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4738 return boost::shared_ptr<Processor>();
4744 Route::non_realtime_locate (framepos_t pos)
4747 _pannable->transport_located (pos);
4750 if (_delayline.get()) {
4751 _delayline.get()->flush();
4755 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4756 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4758 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4759 (*i)->transport_located (pos);
4762 _roll_delay = _initial_delay;
4766 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4773 * We don't currently mix MIDI input together, so we don't need the
4774 * complex logic of the audio case.
4777 n_buffers = bufs.count().n_midi ();
4779 for (i = 0; i < n_buffers; ++i) {
4781 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4782 MidiBuffer& buf (bufs.get_midi (i));
4785 buf.copy (source_port->get_midi_buffer(nframes));
4787 buf.silence (nframes);
4793 n_buffers = bufs.count().n_audio();
4795 size_t n_ports = io->n_ports().n_audio();
4796 float scaling = 1.0f;
4798 if (n_ports > n_buffers) {
4799 scaling = ((float) n_buffers) / n_ports;
4802 for (i = 0; i < n_ports; ++i) {
4804 /* if there are more ports than buffers, map them onto buffers
4805 * in a round-robin fashion
4808 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4809 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4812 if (i < n_buffers) {
4814 /* first time through just copy a channel into
4818 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4820 if (scaling != 1.0f) {
4821 buf.apply_gain (scaling, nframes);
4826 /* on subsequent times around, merge data from
4827 * the port with what is already there
4830 if (scaling != 1.0f) {
4831 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4833 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4838 /* silence any remaining buffers */
4840 for (; i < n_buffers; ++i) {
4841 AudioBuffer& buf (bufs.get_audio (i));
4842 buf.silence (nframes);
4845 /* establish the initial setup of the buffer set, reflecting what was
4846 copied into it. unless, of course, we are the auditioner, in which
4847 case nothing was fed into it from the inputs at all.
4850 if (!is_auditioner()) {
4851 bufs.set_count (io->n_ports());
4855 boost::shared_ptr<AutomationControl>
4856 Route::pan_azimuth_control() const
4859 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4861 return boost::shared_ptr<AutomationControl>();
4863 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4864 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4866 if (!_pannable || !panner()) {
4867 return boost::shared_ptr<AutomationControl>();
4869 return _pannable->pan_azimuth_control;
4873 boost::shared_ptr<AutomationControl>
4874 Route::pan_elevation_control() const
4876 if (Profile->get_mixbus() || !_pannable || !panner()) {
4877 return boost::shared_ptr<AutomationControl>();
4880 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4882 if (c.find (PanElevationAutomation) != c.end()) {
4883 return _pannable->pan_elevation_control;
4885 return boost::shared_ptr<AutomationControl>();
4888 boost::shared_ptr<AutomationControl>
4889 Route::pan_width_control() const
4891 if (Profile->get_mixbus() || !_pannable || !panner()) {
4892 return boost::shared_ptr<AutomationControl>();
4895 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4897 if (c.find (PanWidthAutomation) != c.end()) {
4898 return _pannable->pan_width_control;
4900 return boost::shared_ptr<AutomationControl>();
4903 boost::shared_ptr<AutomationControl>
4904 Route::pan_frontback_control() const
4906 if (Profile->get_mixbus() || !_pannable || !panner()) {
4907 return boost::shared_ptr<AutomationControl>();
4910 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4912 if (c.find (PanFrontBackAutomation) != c.end()) {
4913 return _pannable->pan_frontback_control;
4915 return boost::shared_ptr<AutomationControl>();
4918 boost::shared_ptr<AutomationControl>
4919 Route::pan_lfe_control() const
4921 if (Profile->get_mixbus() || !_pannable || !panner()) {
4922 return boost::shared_ptr<AutomationControl>();
4925 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4927 if (c.find (PanLFEAutomation) != c.end()) {
4928 return _pannable->pan_lfe_control;
4930 return boost::shared_ptr<AutomationControl>();
4935 Route::eq_band_cnt () const
4937 if (Profile->get_mixbus()) {
4940 /* Ardour has no well-known EQ object */
4945 boost::shared_ptr<AutomationControl>
4946 Route::eq_gain_controllable (uint32_t band) const
4949 boost::shared_ptr<PluginInsert> eq = ch_eq();
4952 return boost::shared_ptr<AutomationControl>();
4955 uint32_t port_number;
4958 if (is_master() || mixbus()) {
4965 if (is_master() || mixbus()) {
4972 if (is_master() || mixbus()) {
4979 return boost::shared_ptr<AutomationControl>();
4982 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
4984 return boost::shared_ptr<AutomationControl>();
4987 boost::shared_ptr<AutomationControl>
4988 Route::eq_freq_controllable (uint32_t band) const
4992 if (mixbus() || is_master()) {
4993 /* no frequency controls for mixbusses or master */
4994 return boost::shared_ptr<AutomationControl>();
4997 boost::shared_ptr<PluginInsert> eq = ch_eq();
5000 return boost::shared_ptr<AutomationControl>();
5003 uint32_t port_number;
5015 return boost::shared_ptr<AutomationControl>();
5018 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5020 return boost::shared_ptr<AutomationControl>();
5024 boost::shared_ptr<AutomationControl>
5025 Route::eq_q_controllable (uint32_t band) const
5027 return boost::shared_ptr<AutomationControl>();
5030 boost::shared_ptr<AutomationControl>
5031 Route::eq_shape_controllable (uint32_t band) const
5033 return boost::shared_ptr<AutomationControl>();
5036 boost::shared_ptr<AutomationControl>
5037 Route::eq_enable_controllable () const
5040 boost::shared_ptr<PluginInsert> eq = ch_eq();
5043 return boost::shared_ptr<AutomationControl>();
5046 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5048 return boost::shared_ptr<AutomationControl>();
5052 boost::shared_ptr<AutomationControl>
5053 Route::eq_hpf_controllable () const
5056 boost::shared_ptr<PluginInsert> eq = ch_eq();
5059 return boost::shared_ptr<AutomationControl>();
5062 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5064 return boost::shared_ptr<AutomationControl>();
5069 Route::eq_band_name (uint32_t band) const
5071 if (Profile->get_mixbus()) {
5087 boost::shared_ptr<AutomationControl>
5088 Route::comp_enable_controllable () const
5091 boost::shared_ptr<PluginInsert> comp = ch_comp();
5094 return boost::shared_ptr<AutomationControl>();
5097 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5099 return boost::shared_ptr<AutomationControl>();
5102 boost::shared_ptr<AutomationControl>
5103 Route::comp_threshold_controllable () const
5106 boost::shared_ptr<PluginInsert> comp = ch_comp();
5109 return boost::shared_ptr<AutomationControl>();
5112 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5115 return boost::shared_ptr<AutomationControl>();
5118 boost::shared_ptr<AutomationControl>
5119 Route::comp_speed_controllable () const
5122 boost::shared_ptr<PluginInsert> comp = ch_comp();
5125 return boost::shared_ptr<AutomationControl>();
5128 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5130 return boost::shared_ptr<AutomationControl>();
5133 boost::shared_ptr<AutomationControl>
5134 Route::comp_mode_controllable () const
5137 boost::shared_ptr<PluginInsert> comp = ch_comp();
5140 return boost::shared_ptr<AutomationControl>();
5143 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5145 return boost::shared_ptr<AutomationControl>();
5148 boost::shared_ptr<AutomationControl>
5149 Route::comp_makeup_controllable () const
5152 boost::shared_ptr<PluginInsert> comp = ch_comp();
5155 return boost::shared_ptr<AutomationControl>();
5158 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5160 return boost::shared_ptr<AutomationControl>();
5163 boost::shared_ptr<AutomationControl>
5164 Route::comp_redux_controllable () const
5167 boost::shared_ptr<PluginInsert> comp = ch_comp();
5170 return boost::shared_ptr<AutomationControl>();
5173 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5175 return boost::shared_ptr<AutomationControl>();
5180 Route::comp_mode_name (uint32_t mode) const
5185 return _("Leveler");
5187 return _("Compressor");
5189 return _("Limiter");
5191 return mixbus() ? _("Sidechain") : _("Limiter");
5201 Route::comp_speed_name (uint32_t mode) const
5219 boost::shared_ptr<AutomationControl>
5220 Route::send_level_controllable (uint32_t n) const
5223 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5225 return boost::shared_ptr<AutomationControl>();
5230 return boost::shared_ptr<AutomationControl>();
5233 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5234 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5236 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5238 return boost::shared_ptr<AutomationControl>();
5240 return s->gain_control ();
5244 boost::shared_ptr<AutomationControl>
5245 Route::send_enable_controllable (uint32_t n) const
5248 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5250 return boost::shared_ptr<AutomationControl>();
5255 return boost::shared_ptr<AutomationControl>();
5258 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5259 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5261 /* although Ardour sends have enable/disable as part of the Processor
5262 API, it is not exposed as a controllable.
5264 XXX: we should fix this.
5266 return boost::shared_ptr<AutomationControl>();
5271 Route::send_name (uint32_t n) const
5277 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5281 boost::shared_ptr<Processor> p = nth_send (n);
5290 boost::shared_ptr<AutomationControl>
5291 Route::master_send_enable_controllable () const
5294 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5296 return boost::shared_ptr<AutomationControl>();
5298 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5300 return boost::shared_ptr<AutomationControl>();
5305 Route::slaved () const
5307 if (!_gain_control) {
5310 /* just test one particular control, not all of them */
5311 return _gain_control->slaved ();
5315 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5317 if (!vca || !_gain_control) {
5321 /* just test one particular control, not all of them */
5323 return _gain_control->slaved_to (vca->gain_control());
5327 Route::muted_by_others_soloing () const
5329 if (!can_be_muted_by_others ()) {
5333 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5337 Route::clear_all_solo_state ()
5339 _solo_control->clear_all_solo_state ();