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;
910 if (g_atomic_int_get (&_pending_process_reorder)) {
911 /* we need to flush any pending re-order changes */
912 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
913 apply_processor_changes_rt ();
917 loc = find(_processors.begin(), _processors.end(), before);
918 if (loc == _processors.end ()) {
922 /* nothing specified - at end */
923 loc = _processors.end ();
926 if (!AudioEngine::instance()->connected()) {
930 if (others.empty()) {
934 ProcessorList to_skip;
936 // check if there's an instrument to replace or configure
937 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
938 boost::shared_ptr<PluginInsert> pi;
939 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
942 if (!pi->plugin ()->get_info ()->is_instrument ()) {
945 boost::shared_ptr<Processor> instrument = the_instrument ();
946 ChanCount in (DataType::MIDI, 1);
947 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
949 PluginSetupOptions flags = None;
952 in = instrument->input_streams ();
953 out = instrument->output_streams ();
955 if (pi->has_output_presets (in, out)) {
959 pi->set_strict_io (_strict_io);
961 PluginSetupOptions mask = None;
962 if (Config->get_ask_replace_instrument ()) {
965 if (Config->get_ask_setup_instrument ()) {
972 boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags); /* EMIT SIGNAL */
973 int mode = rv.get_value_or (0);
976 to_skip.push_back (*i); // don't add this one;
979 replace_processor (instrument, *i, err);
980 to_skip.push_back (*i);
985 if ((mode & 5) == 4) {
992 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
993 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
994 ProcessorState pstate (this);
996 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1001 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
1002 if (check != to_skip.end()) {
1006 boost::shared_ptr<PluginInsert> pi;
1008 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1009 pi->set_strict_io (_strict_io);
1013 /* Ensure that only one amp is in the list at any time */
1014 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
1015 if (check != _processors.end()) {
1016 if (before == _amp) {
1017 /* Already in position; all is well */
1020 _processors.erase (check);
1025 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1027 _processors.insert (loc, *i);
1028 (*i)->set_owner (this);
1031 if (configure_processors_unlocked (err, &lm)) {
1033 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1038 if (pi && pi->has_sidechain ()) {
1039 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
1042 if ((*i)->active()) {
1043 // emit ActiveChanged() and latency_changed() if needed
1047 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1049 boost::shared_ptr<Send> send;
1050 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1051 send->SelfDestruct.connect_same_thread (*this,
1052 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1056 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1057 boost::shared_ptr<PluginInsert> pi;
1059 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1060 if (pi->has_no_inputs ()) {
1061 _have_internal_generator = true;
1067 _output->set_user_latency (0);
1070 reset_instrument_info ();
1071 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1072 set_processor_positions ();
1074 if (fanout && fanout->configured ()
1075 && fanout->output_streams().n_audio() > 2
1076 && boost::dynamic_pointer_cast<PluginInsert> (the_instrument ()) == fanout) {
1077 fan_out (); /* EMIT SIGNAL */
1083 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1085 if (p == PreFader) {
1086 start = _processors.begin();
1087 end = find(_processors.begin(), _processors.end(), _amp);
1089 start = find(_processors.begin(), _processors.end(), _amp);
1091 end = _processors.end();
1095 /** Turn off all processors with a given placement
1096 * @param p Placement of processors to disable
1099 Route::disable_processors (Placement p)
1101 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1103 ProcessorList::iterator start, end;
1104 placement_range(p, start, end);
1106 for (ProcessorList::iterator i = start; i != end; ++i) {
1107 (*i)->enable (false);
1110 _session.set_dirty ();
1113 /** Turn off all redirects
1116 Route::disable_processors ()
1118 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1120 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1121 (*i)->enable (false);
1124 _session.set_dirty ();
1127 /** Turn off all redirects with a given placement
1128 * @param p Placement of redirects to disable
1131 Route::disable_plugins (Placement p)
1133 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1135 ProcessorList::iterator start, end;
1136 placement_range(p, start, end);
1138 for (ProcessorList::iterator i = start; i != end; ++i) {
1139 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1140 (*i)->enable (false);
1144 _session.set_dirty ();
1147 /** Turn off all plugins
1150 Route::disable_plugins ()
1152 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1154 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1155 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1156 (*i)->enable (false);
1160 _session.set_dirty ();
1165 Route::ab_plugins (bool forward)
1167 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1171 /* forward = turn off all active redirects, and mark them so that the next time
1172 we go the other way, we will revert them
1175 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1176 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1179 if (!(*i)->display_to_user ()) {
1183 if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
1188 if ((*i)->enabled ()) {
1189 (*i)->enable (false);
1190 (*i)->set_next_ab_is_active (true);
1192 (*i)->set_next_ab_is_active (false);
1198 /* backward = if the redirect was marked to go active on the next ab, do so */
1200 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1201 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1204 if (!(*i)->display_to_user ()) {
1208 if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
1213 (*i)->enable ((*i)->get_next_ab_is_active ());
1217 _session.set_dirty ();
1221 /** Remove processors with a given placement.
1222 * @param p Placement of processors to remove.
1225 Route::clear_processors (Placement p)
1227 if (!_session.engine().connected()) {
1231 bool already_deleting = _session.deletion_in_progress();
1232 if (!already_deleting) {
1233 _session.set_deletion_in_progress();
1237 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1238 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1239 ProcessorList new_list;
1240 ProcessorStreams err;
1241 bool seen_amp = false;
1243 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1249 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1251 /* you can't remove these */
1253 new_list.push_back (*i);
1260 new_list.push_back (*i);
1263 (*i)->drop_references ();
1271 (*i)->drop_references ();
1274 new_list.push_back (*i);
1281 _processors = new_list;
1282 configure_processors_unlocked (&err, &lm); // this can't fail
1285 processor_max_streams.reset();
1286 _have_internal_generator = false;
1287 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1288 set_processor_positions ();
1290 reset_instrument_info ();
1292 if (!already_deleting) {
1293 _session.clear_deletion_in_progress();
1298 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1300 // TODO once the export point can be configured properly, do something smarter here
1301 if (processor == _capturing_processor) {
1302 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1303 if (need_process_lock) {
1307 _capturing_processor.reset();
1309 if (need_process_lock) {
1314 /* these can never be removed */
1316 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1320 if (!_session.engine().connected()) {
1324 processor_max_streams.reset();
1327 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1328 if (need_process_lock) {
1332 /* Caller must hold process lock */
1333 assert (!AudioEngine::instance()->process_lock().trylock());
1335 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1337 ProcessorState pstate (this);
1339 ProcessorList::iterator i;
1340 bool removed = false;
1342 for (i = _processors.begin(); i != _processors.end(); ) {
1343 if (*i == processor) {
1345 /* move along, see failure case for configure_processors()
1346 where we may need to reconfigure the processor.
1349 /* stop redirects that send signals to JACK ports
1350 from causing noise as a result of no longer being
1354 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1355 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1359 iop = pi->sidechain();
1366 i = _processors.erase (i);
1374 _output->set_user_latency (0);
1382 if (configure_processors_unlocked (err, &lm)) {
1384 /* we know this will work, because it worked before :) */
1385 configure_processors_unlocked (0, &lm);
1389 _have_internal_generator = false;
1391 for (i = _processors.begin(); i != _processors.end(); ++i) {
1392 boost::shared_ptr<PluginInsert> pi;
1394 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1395 if (pi->has_no_inputs ()) {
1396 _have_internal_generator = true;
1401 if (need_process_lock) {
1406 reset_instrument_info ();
1407 processor->drop_references ();
1408 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1409 set_processor_positions ();
1415 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1417 /* these can never be removed */
1418 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1421 /* and can't be used as substitute, either */
1422 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1426 /* I/Os are out, too */
1427 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1431 /* this function cannot be used to swap/reorder processors */
1432 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1436 if (!AudioEngine::instance()->connected() || !old || !sub) {
1440 /* ensure that sub is not owned by another route */
1441 if (sub->owner ()) {
1446 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1447 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1448 ProcessorState pstate (this);
1450 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1452 ProcessorList::iterator i;
1453 bool replaced = false;
1454 bool enable = old->enabled ();
1456 for (i = _processors.begin(); i != _processors.end(); ) {
1458 i = _processors.erase (i);
1459 _processors.insert (i, sub);
1460 sub->set_owner (this);
1473 boost::shared_ptr<PluginInsert> pi;
1474 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1475 pi->set_strict_io (true);
1479 if (configure_processors_unlocked (err, &lm)) {
1481 configure_processors_unlocked (0, &lm);
1485 _have_internal_generator = false;
1487 for (i = _processors.begin(); i != _processors.end(); ++i) {
1488 boost::shared_ptr<PluginInsert> pi;
1489 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1490 if (pi->has_no_inputs ()) {
1491 _have_internal_generator = true;
1501 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1502 _output->set_user_latency (0);
1505 reset_instrument_info ();
1506 old->drop_references ();
1507 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1508 set_processor_positions ();
1513 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1515 ProcessorList deleted;
1517 if (!_session.engine().connected()) {
1521 processor_max_streams.reset();
1524 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1525 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1526 ProcessorState pstate (this);
1528 ProcessorList::iterator i;
1529 boost::shared_ptr<Processor> processor;
1531 for (i = _processors.begin(); i != _processors.end(); ) {
1535 /* these can never be removed */
1537 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1542 /* see if its in the list of processors to delete */
1544 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1549 /* stop IOProcessors that send to JACK ports
1550 from causing noise as a result of no longer being
1554 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1555 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1558 iop = pi->sidechain();
1565 deleted.push_back (processor);
1566 i = _processors.erase (i);
1569 if (deleted.empty()) {
1570 /* none of those in the requested list were found */
1574 _output->set_user_latency (0);
1576 if (configure_processors_unlocked (err, &lm)) {
1578 /* we know this will work, because it worked before :) */
1579 configure_processors_unlocked (0, &lm);
1584 _have_internal_generator = false;
1586 for (i = _processors.begin(); i != _processors.end(); ++i) {
1587 boost::shared_ptr<PluginInsert> pi;
1589 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1590 if (pi->has_no_inputs ()) {
1591 _have_internal_generator = true;
1598 /* now try to do what we need to so that those that were removed will be deleted */
1600 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1601 (*i)->drop_references ();
1604 reset_instrument_info ();
1605 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1606 set_processor_positions ();
1612 Route::reset_instrument_info ()
1614 boost::shared_ptr<Processor> instr = the_instrument();
1616 _instrument_info.set_internal_instrument (instr);
1620 /** Caller must hold process lock */
1622 Route::configure_processors (ProcessorStreams* err)
1624 #ifndef PLATFORM_WINDOWS
1625 assert (!AudioEngine::instance()->process_lock().trylock());
1628 if (!_in_configure_processors) {
1629 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1630 return configure_processors_unlocked (err, &lm);
1637 Route::input_streams () const
1639 return _input->n_ports ();
1642 list<pair<ChanCount, ChanCount> >
1643 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1645 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1647 return try_configure_processors_unlocked (in, err);
1650 list<pair<ChanCount, ChanCount> >
1651 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1653 // Check each processor in order to see if we can configure as requested
1655 list<pair<ChanCount, ChanCount> > configuration;
1658 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1659 DEBUG_TRACE (DEBUG::Processors, "{\n");
1661 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1663 if ((*p)->can_support_io_configuration(in, out)) {
1665 if (boost::dynamic_pointer_cast<Delivery> (*p)
1666 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1668 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1669 /* with strict I/O the panner + output are forced to
1670 * follow the last processor's output.
1672 * Delivery::can_support_io_configuration() will only add ports,
1673 * but not remove excess ports.
1675 * This works because the delivery only requires
1676 * as many outputs as there are inputs.
1677 * Delivery::configure_io() will do the actual removal
1678 * by calling _output->ensure_io()
1680 if (!is_master() && _session.master_out () && in.n_audio() > 0) {
1681 /* ..but at least as many as there are master-inputs, if
1682 * the delivery is dealing with audio */
1683 // XXX this may need special-casing for mixbus (master-outputs)
1684 // and should maybe be a preference anyway ?!
1685 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1691 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1692 configuration.push_back(make_pair(in, out));
1695 // restriction for Monitor Section Processors
1696 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1697 /* Note: The Monitor follows the master-bus and has no panner.
1699 * The general idea is to only allow plugins that retain the channel-count
1700 * and plugins with MIDI in (e.g VSTs with control that will remain unconnected).
1701 * Then again 5.1 in, monitor stereo is a valid use-case.
1703 * and worse: we only refuse adding plugins *here*.
1705 * 1) stereo-master, stereo-mon, add a stereo-plugin, OK
1706 * 2) change master-bus, add a channel
1707 * 2a) monitor-secion follows
1708 * 3) monitor processors fail to re-reconfigure (stereo plugin)
1709 * 4) re-load session, monitor-processor remains unconfigured, crash.
1711 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration change.\n");
1713 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1714 // internal sends make no sense, only feedback
1715 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1716 return list<pair<ChanCount, ChanCount> > ();
1718 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1719 /* External Sends can be problematic. one can add/remove ports
1720 * there signal leaves the DAW to external monitors anyway, so there's
1721 * no real use for allowing them here anyway.
1723 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1724 return list<pair<ChanCount, ChanCount> > ();
1726 if (boost::dynamic_pointer_cast<Send> (*p)) {
1728 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1729 return list<pair<ChanCount, ChanCount> > ();
1738 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1739 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1740 DEBUG_TRACE (DEBUG::Processors, "}\n");
1741 return list<pair<ChanCount, ChanCount> > ();
1745 DEBUG_TRACE (DEBUG::Processors, "}\n");
1747 return configuration;
1750 /** Set the input/output configuration of each processor in the processors list.
1751 * Caller must hold process lock.
1752 * Return 0 on success, otherwise configuration is impossible.
1755 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1757 #ifndef PLATFORM_WINDOWS
1758 assert (!AudioEngine::instance()->process_lock().trylock());
1761 if (_in_configure_processors) {
1765 /* put invisible processors where they should be */
1766 setup_invisible_processors ();
1768 _in_configure_processors = true;
1770 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1772 if (configuration.empty ()) {
1773 _in_configure_processors = false;
1778 bool seen_mains_out = false;
1779 processor_out_streams = _input->n_ports();
1780 processor_max_streams.reset();
1782 /* processor configure_io() may result in adding ports
1783 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1785 * with jack2 adding ports results in a graph-order callback,
1786 * which calls Session::resort_routes() and eventually
1787 * Route::direct_feeds_according_to_reality()
1788 * which takes a ReaderLock (_processor_lock).
1790 * so we can't hold a WriterLock here until jack2 threading
1793 * NB. we still hold the process lock
1795 * (ardour's own engines do call graph-order from the
1796 * process-thread and hence do not have this issue; besides
1797 * merely adding ports won't trigger a graph-order, only
1798 * making connections does)
1802 // TODO check for a potential ReaderLock after ReaderLock ??
1803 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1805 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1806 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1808 if (!(*p)->configure_io(c->first, c->second)) {
1809 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1810 _in_configure_processors = false;
1815 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1816 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1818 boost::shared_ptr<IOProcessor> iop;
1819 boost::shared_ptr<PluginInsert> pi;
1820 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1821 /* plugins connected via Split or Hide Match may have more channels.
1822 * route/scratch buffers are needed for all of them
1823 * The configuration may only be a subset (both input and output)
1825 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1827 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1828 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1829 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1833 if (boost::dynamic_pointer_cast<Delivery> (*p)
1834 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1835 /* main delivery will increase port count to match input.
1836 * the Delivery::Main is usually the last processor - followed only by
1839 seen_mains_out = true;
1841 if (!seen_mains_out) {
1842 processor_out_streams = out;
1851 _meter->set_max_channels (processor_max_streams);
1854 /* make sure we have sufficient scratch buffers to cope with the new processor
1857 _session.ensure_buffers (n_process_buffers ());
1859 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1861 _in_configure_processors = false;
1865 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1866 * @param state New active state for those processors.
1869 Route::all_visible_processors_active (bool state)
1871 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1873 if (_processors.empty()) {
1877 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1878 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1882 boost::shared_ptr<PluginInsert> pi;
1883 if (0 != (pi = boost::dynamic_pointer_cast<PluginInsert>(*i))) {
1884 if (pi->is_channelstrip ()) {
1889 (*i)->enable (state);
1892 _session.set_dirty ();
1896 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
1898 /* check if re-order requires re-configuration of any processors
1899 * -> compare channel configuration for all processors
1901 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1902 ChanCount c = input_streams ();
1904 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
1906 if (c != (*j)->input_streams()) {
1909 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1912 if ((*i)->input_streams() != c) {
1915 c = (*i)->output_streams();
1927 __attribute__((annotate("realtime")))
1930 Route::apply_processor_order (const ProcessorList& new_order)
1932 /* need to hold processor_lock; either read or write lock
1933 * and the engine process_lock.
1934 * Due to r/w lock ambiguity we can only assert the latter
1936 assert (!AudioEngine::instance()->process_lock().trylock());
1939 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1940 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1941 * processors in the current actual processor list that are hidden. Any visible processors
1942 * in the current list but not in "new_order" will be assumed to be deleted.
1945 /* "as_it_will_be" and "_processors" are lists of shared pointers.
1946 * actual memory usage is small, but insert/erase is not actually rt-safe :(
1947 * (note though that ::processors_reorder_needs_configure() ensured that
1948 * this function will only ever be called from the rt-thread if no processor were removed)
1950 * either way, I can't proove it, but an x-run due to re-order here is less likley
1951 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
1954 ProcessorList as_it_will_be;
1955 ProcessorList::iterator oiter;
1956 ProcessorList::const_iterator niter;
1958 oiter = _processors.begin();
1959 niter = new_order.begin();
1961 while (niter != new_order.end()) {
1963 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1964 then append it to the temp list.
1966 Otherwise, see if the next processor in the old list is in the new list. if not,
1967 its been deleted. If its there, append it to the temp list.
1970 if (oiter == _processors.end()) {
1972 /* no more elements in the old list, so just stick the rest of
1973 the new order onto the temp list.
1976 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1977 while (niter != new_order.end()) {
1984 if (!(*oiter)->display_to_user()) {
1986 as_it_will_be.push_back (*oiter);
1990 /* visible processor: check that its in the new order */
1992 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1993 /* deleted: do nothing, shared_ptr<> will clean up */
1995 /* ignore this one, and add the next item from the new order instead */
1996 as_it_will_be.push_back (*niter);
2001 /* now remove from old order - its taken care of no matter what */
2002 oiter = _processors.erase (oiter);
2006 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
2008 /* If the meter is in a custom position, find it and make a rough note of its position */
2009 maybe_note_meter_position ();
2013 Route::move_instrument_down (bool postfader)
2015 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2016 ProcessorList new_order;
2017 boost::shared_ptr<Processor> instrument;
2018 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2019 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
2020 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
2022 } else if (instrument && *i == _amp) {
2024 new_order.push_back (*i);
2025 new_order.push_back (instrument);
2027 new_order.push_back (instrument);
2028 new_order.push_back (*i);
2031 new_order.push_back (*i);
2038 reorder_processors (new_order, 0);
2042 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
2044 // it a change is already queued, wait for it
2045 // (unless engine is stopped. apply immediately and proceed
2046 while (g_atomic_int_get (&_pending_process_reorder)) {
2047 if (!AudioEngine::instance()->running()) {
2048 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
2049 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2051 apply_processor_order(_pending_processor_order);
2052 setup_invisible_processors ();
2054 g_atomic_int_set (&_pending_process_reorder, 0);
2056 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2057 set_processor_positions ();
2059 // TODO rather use a semaphore or something.
2060 // but since ::reorder_processors() is called
2061 // from the GUI thread, this is fine..
2066 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
2068 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2069 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2070 ProcessorState pstate (this);
2072 apply_processor_order (new_order);
2074 if (configure_processors_unlocked (err, &lm)) {
2082 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2083 set_processor_positions ();
2086 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2087 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2089 // _pending_processor_order is protected by _processor_lock
2090 _pending_processor_order = new_order;
2091 g_atomic_int_set (&_pending_process_reorder, 1);
2098 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2100 boost::shared_ptr<PluginInsert> pi;
2101 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2105 if (pi->has_sidechain () == add) {
2106 return true; // ?? call failed, but result is as expected.
2110 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2111 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2112 if (i == _processors.end ()) {
2118 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2119 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2120 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2122 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2124 if (!pi->add_sidechain ()) {
2128 if (!pi->del_sidechain ()) {
2134 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2139 pi->del_sidechain ();
2141 pi->add_sidechain ();
2142 // TODO restore side-chain's state.
2147 configure_processors_unlocked (0, &lm);
2150 if (pi->has_sidechain ()) {
2151 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2154 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2155 _session.set_dirty ();
2160 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2162 boost::shared_ptr<PluginInsert> pi;
2163 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2168 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2169 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2170 if (i == _processors.end ()) {
2176 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2177 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2179 const ChanCount& old (pi->preset_out ());
2180 if (!pi->set_preset_out (outs)) {
2181 return true; // no change, OK
2184 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2187 pi->set_preset_out (old);
2190 configure_processors_unlocked (0, &lm);
2193 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2194 _session.set_dirty ();
2199 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2202 return customize_plugin_insert (proc, 0, unused, unused);
2206 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2208 boost::shared_ptr<PluginInsert> pi;
2209 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2214 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2215 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2216 if (i == _processors.end ()) {
2222 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2223 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2225 bool old_cust = pi->custom_cfg ();
2226 uint32_t old_cnt = pi->get_count ();
2227 ChanCount old_chan = pi->output_streams ();
2228 ChanCount old_sinks = pi->natural_input_streams ();
2231 pi->set_custom_cfg (false);
2233 pi->set_custom_cfg (true);
2234 pi->set_count (count);
2235 pi->set_outputs (outs);
2236 pi->set_sinks (sinks);
2239 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2243 pi->set_count (old_cnt);
2244 pi->set_sinks (old_sinks);
2245 pi->set_outputs (old_chan);
2246 pi->set_custom_cfg (old_cust);
2250 configure_processors_unlocked (0, &lm);
2253 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2254 _session.set_dirty ();
2259 Route::set_strict_io (const bool enable)
2261 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2263 if (_strict_io != enable) {
2264 _strict_io = enable;
2265 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2266 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2267 boost::shared_ptr<PluginInsert> pi;
2268 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2269 pi->set_strict_io (_strict_io);
2273 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2277 _strict_io = !enable; // restore old value
2278 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2279 boost::shared_ptr<PluginInsert> pi;
2280 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2281 pi->set_strict_io (_strict_io);
2288 configure_processors (0);
2291 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2292 _session.set_dirty ();
2304 Route::get_template()
2306 return state(false);
2310 Route::state(bool full_state)
2313 if (!_session._template_state_dir.empty()) {
2314 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2317 XMLNode *node = new XMLNode("Route");
2318 ProcessorList::iterator i;
2321 id().print (buf, sizeof (buf));
2322 node->add_property("id", buf);
2323 node->add_property ("name", _name);
2324 node->add_property("default-type", _default_type.to_string());
2325 node->add_property ("strict-io", _strict_io);
2327 node->add_child_nocopy (_presentation_info.get_state());
2329 node->add_property("active", _active?"yes":"no");
2331 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2332 node->add_property("meter-point", enum_2_string (_meter_point));
2334 node->add_property("meter-type", enum_2_string (_meter_type));
2337 node->add_property("route-group", _route_group->name());
2340 node->add_child_nocopy (_solo_control->get_state ());
2341 node->add_child_nocopy (_solo_isolate_control->get_state ());
2342 node->add_child_nocopy (_solo_safe_control->get_state ());
2344 node->add_child_nocopy (_input->state (full_state));
2345 node->add_child_nocopy (_output->state (full_state));
2346 node->add_child_nocopy (_mute_master->get_state ());
2348 node->add_child_nocopy (_mute_control->get_state ());
2349 node->add_child_nocopy (_phase_control->get_state ());
2352 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2355 if (_comment.length()) {
2356 XMLNode *cmt = node->add_child ("Comment");
2357 cmt->add_content (_comment);
2361 node->add_child_nocopy (_pannable->state (full_state));
2365 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2366 for (i = _processors.begin(); i != _processors.end(); ++i) {
2368 /* template save: do not include internal sends functioning as
2369 aux sends because the chance of the target ID
2370 in the session where this template is used
2373 similarly, do not save listen sends which connect to
2374 the monitor section, because these will always be
2377 boost::shared_ptr<InternalSend> is;
2379 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2380 if (is->role() == Delivery::Listen) {
2385 node->add_child_nocopy((*i)->state (full_state));
2390 node->add_child_copy (*_extra_xml);
2393 if (_custom_meter_position_noted) {
2394 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2396 after->id().print (buf, sizeof (buf));
2397 node->add_property (X_("processor-after-last-custom-meter"), buf);
2401 if (!_session._template_state_dir.empty()) {
2402 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2405 node->add_child_copy (Slavable::get_state());
2411 Route::set_state (const XMLNode& node, int version)
2413 if (version < 3000) {
2414 return set_state_2X (node, version);
2418 XMLNodeConstIterator niter;
2420 XMLProperty const * prop;
2422 if (node.name() != "Route"){
2423 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2427 if ((prop = node.property (X_("name"))) != 0) {
2428 Route::set_name (prop->value());
2432 _initial_io_setup = true;
2434 Stripable::set_state (node, version);
2436 if ((prop = node.property (X_("strict-io"))) != 0) {
2437 _strict_io = string_is_affirmative (prop->value());
2441 /* monitor bus does not get a panner, but if (re)created
2442 via XML, it will already have one by the time we
2443 call ::set_state(). so ... remove it.
2448 /* add all processors (except amp, which is always present) */
2450 nlist = node.children();
2451 XMLNode processor_state (X_("processor_state"));
2453 Stateful::save_extra_xml (node);
2455 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2459 if (child->name() == IO::state_node_name) {
2460 if ((prop = child->property (X_("direction"))) == 0) {
2464 if (prop->value() == "Input") {
2465 _input->set_state (*child, version);
2466 } else if (prop->value() == "Output") {
2467 _output->set_state (*child, version);
2470 } else if (child->name() == X_("Processor")) {
2471 processor_state.add_child_copy (*child);
2472 } else if (child->name() == X_("Pannable")) {
2474 _pannable->set_state (*child, version);
2476 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2478 } else if (child->name() == Slavable::xml_node_name) {
2479 Slavable::set_state (*child, version);
2483 if ((prop = node.property (X_("meter-point"))) != 0) {
2484 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2485 set_meter_point (mp, true);
2487 _meter->set_display_to_user (_meter_point == MeterCustom);
2491 if ((prop = node.property (X_("meter-type"))) != 0) {
2492 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2495 _initial_io_setup = false;
2497 set_processor_state (processor_state);
2499 // this looks up the internal instrument in processors
2500 reset_instrument_info();
2502 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2503 set_denormal_protection (string_is_affirmative (prop->value()));
2506 /* convert old 3001 state */
2507 if ((prop = node.property (X_("phase-invert"))) != 0) {
2508 _phase_control->set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2511 if ((prop = node.property (X_("active"))) != 0) {
2512 bool yn = string_is_affirmative (prop->value());
2513 set_active (yn, this);
2516 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2517 PBD::ID id (prop->value ());
2518 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2519 ProcessorList::const_iterator i = _processors.begin ();
2520 while (i != _processors.end() && (*i)->id() != id) {
2524 if (i != _processors.end ()) {
2525 _processor_after_last_custom_meter = *i;
2526 _custom_meter_position_noted = true;
2530 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2533 if (child->name() == X_("Comment")) {
2535 /* XXX this is a terrible API design in libxml++ */
2537 XMLNode *cmt = *(child->children().begin());
2538 _comment = cmt->content();
2540 } else if (child->name() == Controllable::xml_node_name) {
2541 if ((prop = child->property (X_("name"))) == 0) {
2545 if (prop->value() == _gain_control->name()) {
2546 _gain_control->set_state (*child, version);
2547 } else if (prop->value() == _solo_control->name()) {
2548 _solo_control->set_state (*child, version);
2549 } else if (prop->value() == _solo_safe_control->name()) {
2550 _solo_safe_control->set_state (*child, version);
2551 } else if (prop->value() == _solo_isolate_control->name()) {
2552 _solo_isolate_control->set_state (*child, version);
2553 } else if (prop->value() == _mute_control->name()) {
2554 _mute_control->set_state (*child, version);
2555 } else if (prop->value() == _phase_control->name()) {
2556 _phase_control->set_state (*child, version);
2558 Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
2559 if (p.type () >= MidiCCAutomation && p.type () < MidiSystemExclusiveAutomation) {
2560 boost::shared_ptr<AutomationControl> ac = automation_control (p, true);
2562 ac->set_state (*child, version);
2566 } else if (child->name() == MuteMaster::xml_node_name) {
2567 _mute_master->set_state (*child, version);
2569 } else if (child->name() == Automatable::xml_node_name) {
2570 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2578 Route::set_state_2X (const XMLNode& node, int version)
2582 XMLNodeConstIterator niter;
2584 XMLProperty const * prop;
2586 /* 2X things which still remain to be handled:
2592 if (node.name() != "Route") {
2593 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2597 Stripable::set_state (node, version);
2599 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2600 set_denormal_protection (string_is_affirmative (prop->value()));
2603 if ((prop = node.property (X_("muted"))) != 0) {
2606 bool muted = string_is_affirmative (prop->value());
2612 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2614 if (string_is_affirmative (prop->value())){
2615 mute_point = mute_point + "PreFader";
2620 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2622 if (string_is_affirmative (prop->value())){
2625 mute_point = mute_point + ",";
2628 mute_point = mute_point + "PostFader";
2633 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2635 if (string_is_affirmative (prop->value())){
2638 mute_point = mute_point + ",";
2641 mute_point = mute_point + "Listen";
2646 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2648 if (string_is_affirmative (prop->value())){
2651 mute_point = mute_point + ",";
2654 mute_point = mute_point + "Main";
2658 _mute_master->set_mute_points (mute_point);
2659 _mute_master->set_muted_by_self (true);
2663 if ((prop = node.property (X_("meter-point"))) != 0) {
2664 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2669 nlist = node.children ();
2670 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2674 if (child->name() == IO::state_node_name) {
2676 /* there is a note in IO::set_state_2X() about why we have to call
2680 _input->set_state_2X (*child, version, true);
2681 _output->set_state_2X (*child, version, false);
2683 if ((prop = child->property (X_("name"))) != 0) {
2684 Route::set_name (prop->value ());
2689 if ((prop = child->property (X_("active"))) != 0) {
2690 bool yn = string_is_affirmative (prop->value());
2691 _active = !yn; // force switch
2692 set_active (yn, this);
2695 if ((prop = child->property (X_("gain"))) != 0) {
2698 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2699 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2703 /* Set up Panners in the IO */
2704 XMLNodeList io_nlist = child->children ();
2706 XMLNodeConstIterator io_niter;
2709 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2711 io_child = *io_niter;
2713 if (io_child->name() == X_("Panner")) {
2714 _main_outs->panner_shell()->set_state(*io_child, version);
2715 } else if (io_child->name() == X_("Automation")) {
2716 /* IO's automation is for the fader */
2717 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2723 XMLNodeList redirect_nodes;
2725 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2729 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2730 redirect_nodes.push_back(child);
2735 set_processor_state_2X (redirect_nodes, version);
2737 Stateful::save_extra_xml (node);
2739 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2742 if (child->name() == X_("Comment")) {
2744 /* XXX this is a terrible API design in libxml++ */
2746 XMLNode *cmt = *(child->children().begin());
2747 _comment = cmt->content();
2749 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2750 if (prop->value() == X_("solo")) {
2751 _solo_control->set_state (*child, version);
2752 } else if (prop->value() == X_("mute")) {
2753 _mute_control->set_state (*child, version);
2763 Route::get_processor_state ()
2765 XMLNode* root = new XMLNode (X_("redirects"));
2766 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2767 root->add_child_nocopy ((*i)->state (true));
2774 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2776 /* We don't bother removing existing processors not in nList, as this
2777 method will only be called when creating a Route from scratch, not
2778 for undo purposes. Just put processors in at the appropriate place
2782 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2783 add_processor_from_xml_2X (**i, version);
2788 Route::set_processor_state (const XMLNode& node)
2790 const XMLNodeList &nlist = node.children();
2791 XMLNodeConstIterator niter;
2792 ProcessorList new_order;
2793 bool must_configure = false;
2795 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2797 XMLProperty* prop = (*niter)->property ("type");
2799 if (prop->value() == "amp") {
2800 _amp->set_state (**niter, Stateful::current_state_version);
2801 new_order.push_back (_amp);
2802 } else if (prop->value() == "trim") {
2803 _trim->set_state (**niter, Stateful::current_state_version);
2804 new_order.push_back (_trim);
2805 } else if (prop->value() == "meter") {
2806 _meter->set_state (**niter, Stateful::current_state_version);
2807 new_order.push_back (_meter);
2808 } else if (prop->value() == "delay") {
2810 _delayline->set_state (**niter, Stateful::current_state_version);
2811 new_order.push_back (_delayline);
2813 } else if (prop->value() == "main-outs") {
2814 _main_outs->set_state (**niter, Stateful::current_state_version);
2815 } else if (prop->value() == "intreturn") {
2817 _intreturn.reset (new InternalReturn (_session));
2818 must_configure = true;
2820 _intreturn->set_state (**niter, Stateful::current_state_version);
2821 } else if (is_monitor() && prop->value() == "monitor") {
2822 if (!_monitor_control) {
2823 _monitor_control.reset (new MonitorProcessor (_session));
2824 must_configure = true;
2826 _monitor_control->set_state (**niter, Stateful::current_state_version);
2827 } else if (prop->value() == "capture") {
2828 /* CapturingProcessor should never be restored, it's always
2829 added explicitly when needed */
2831 ProcessorList::iterator o;
2833 for (o = _processors.begin(); o != _processors.end(); ++o) {
2834 XMLProperty const * id_prop = (*niter)->property(X_("id"));
2835 if (id_prop && (*o)->id() == id_prop->value()) {
2836 (*o)->set_state (**niter, Stateful::current_state_version);
2837 new_order.push_back (*o);
2842 // If the processor (*niter) is not on the route then create it
2844 if (o == _processors.end()) {
2846 boost::shared_ptr<Processor> processor;
2848 if (prop->value() == "intsend") {
2850 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2852 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2853 prop->value() == "lv2" ||
2854 prop->value() == "windows-vst" ||
2855 prop->value() == "mac-vst" ||
2856 prop->value() == "lxvst" ||
2857 prop->value() == "luaproc" ||
2858 prop->value() == "audiounit") {
2860 if (_session.get_disable_all_loaded_plugins ()) {
2861 processor.reset (new UnknownProcessor (_session, **niter));
2863 processor.reset (new PluginInsert (_session));
2864 processor->set_owner (this);
2866 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
2867 pi->set_strict_io (true);
2871 } else if (prop->value() == "port") {
2873 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2875 } else if (prop->value() == "send") {
2877 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2878 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2879 send->SelfDestruct.connect_same_thread (*this,
2880 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
2883 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2887 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2888 /* This processor could not be configured. Turn it into a UnknownProcessor */
2889 processor.reset (new UnknownProcessor (_session, **niter));
2892 /* subscribe to Sidechain IO changes */
2893 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2894 if (pi && pi->has_sidechain ()) {
2895 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2898 /* we have to note the monitor send here, otherwise a new one will be created
2899 and the state of this one will be lost.
2901 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2902 if (isend && isend->role() == Delivery::Listen) {
2903 _monitor_send = isend;
2906 /* it doesn't matter if invisible processors are added here, as they
2907 will be sorted out by setup_invisible_processors () shortly.
2910 new_order.push_back (processor);
2911 must_configure = true;
2917 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2918 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2919 /* re-assign _processors w/o process-lock.
2920 * if there's an IO-processor present in _processors but
2921 * not in new_order, it will be deleted and ~IO takes
2924 _processors = new_order;
2926 if (must_configure) {
2927 configure_processors_unlocked (0, &lm);
2930 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2932 (*i)->set_owner (this);
2933 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2935 boost::shared_ptr<PluginInsert> pi;
2937 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2938 if (pi->has_no_inputs ()) {
2939 _have_internal_generator = true;
2946 reset_instrument_info ();
2947 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2948 set_processor_positions ();
2952 Route::curve_reallocate ()
2954 // _gain_automation_curve.finish_resize ();
2955 // _pan_automation_curve.finish_resize ();
2959 Route::silence (framecnt_t nframes)
2961 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2966 silence_unlocked (nframes);
2970 Route::silence_unlocked (framecnt_t nframes)
2972 /* Must be called with the processor lock held */
2974 const framepos_t now = _session.transport_frame ();
2978 _output->silence (nframes);
2980 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2981 boost::shared_ptr<PluginInsert> pi;
2983 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2984 // skip plugins, they don't need anything when we're not active
2988 (*i)->silence (nframes, now);
2991 if (nframes == _session.get_block_size()) {
2998 Route::add_internal_return ()
3001 _intreturn.reset (new InternalReturn (_session));
3002 add_processor (_intreturn, PreFader);
3007 Route::add_send_to_internal_return (InternalSend* send)
3009 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3011 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3012 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3015 return d->add_send (send);
3021 Route::remove_send_from_internal_return (InternalSend* send)
3023 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3025 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3026 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3029 return d->remove_send (send);
3035 Route::enable_monitor_send ()
3037 /* Caller must hold process lock */
3038 assert (!AudioEngine::instance()->process_lock().trylock());
3040 /* master never sends to monitor section via the normal mechanism */
3041 assert (!is_master ());
3042 assert (!is_monitor ());
3044 /* make sure we have one */
3045 if (!_monitor_send) {
3046 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
3047 _monitor_send->set_display_to_user (false);
3051 configure_processors (0);
3054 /** Add an aux send to a route.
3055 * @param route route to send to.
3056 * @param before Processor to insert before, or 0 to insert at the end.
3059 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
3061 assert (route != _session.monitor_out ());
3064 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3066 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3068 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
3070 if (d && d->target_route() == route) {
3071 /* already listening via the specified IO: do nothing */
3079 boost::shared_ptr<InternalSend> listener;
3082 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3083 listener.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3086 add_processor (listener, before);
3088 } catch (failed_constructor& err) {
3096 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3098 ProcessorStreams err;
3099 ProcessorList::iterator tmp;
3102 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3104 /* have to do this early because otherwise processor reconfig
3105 * will put _monitor_send back in the list
3108 if (route == _session.monitor_out()) {
3109 _monitor_send.reset ();
3113 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3115 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3117 if (d && d->target_route() == route) {
3119 if (remove_processor (*x, &err, false) > 0) {
3125 /* list could have been demolished while we dropped the lock
3128 if (_session.engine().connected()) {
3129 /* i/o processors cannot be removed if the engine is not running
3130 * so don't live-loop in case the engine is N/A or dies
3140 Route::set_comment (string cmt, void *src)
3144 _session.set_dirty ();
3148 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3150 FeedRecord fr (other, via_sends_only);
3152 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3154 if (!result.second) {
3156 /* already a record for "other" - make sure sends-only information is correct */
3157 if (!via_sends_only && result.first->sends_only) {
3158 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3159 frp->sends_only = false;
3163 return result.second;
3167 Route::clear_fed_by ()
3173 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3175 const FedBy& fed_by (other->fed_by());
3177 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3178 boost::shared_ptr<Route> sr = f->r.lock();
3180 if (sr && (sr.get() == this)) {
3182 if (via_sends_only) {
3183 *via_sends_only = f->sends_only;
3194 Route::all_inputs () const
3196 /* TODO, if this works as expected,
3197 * cache the IOVector and maintain it via
3198 * input_change_handler(), sidechain_change_handler() etc
3201 ios.push_back (_input);
3203 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3204 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3206 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3207 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3210 iop = pi->sidechain();
3213 if (iop != 0 && iop->input()) {
3214 ios.push_back (iop->input());
3221 Route::all_outputs () const
3224 // _output is included via Delivery
3225 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3226 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3227 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3228 if (iop != 0 && iop->output()) {
3229 ios.push_back (iop->output());
3236 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3238 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3239 if (other->all_inputs().fed_by (_output)) {
3240 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3241 if (via_send_only) {
3242 *via_send_only = false;
3248 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3250 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3252 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3253 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3256 iop = pi->sidechain();
3260 boost::shared_ptr<const IO> iop_out = iop->output();
3261 if (other.get() == this && iop_out && iop->input() && iop_out->connected_to (iop->input())) {
3262 // TODO this needs a delaylines in the Insert to align connections (!)
3263 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed its own return (%2)\n", iop->name(), other->name()));
3266 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3267 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3268 if (via_send_only) {
3269 *via_send_only = true;
3273 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3276 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3281 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3286 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3288 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3292 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3294 return _session._current_route_graph.feeds (shared_from_this (), other);
3297 /** Called from the (non-realtime) butler thread when the transport is stopped */
3299 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3301 framepos_t now = _session.transport_frame();
3304 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3306 Automatable::transport_stopped (now);
3308 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3310 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3314 (*i)->transport_stopped (now);
3318 _roll_delay = _initial_delay;
3322 Route::input_change_handler (IOChange change, void * /*src*/)
3324 if ((change.type & IOChange::ConfigurationChanged)) {
3325 /* This is called with the process lock held if change
3326 contains ConfigurationChanged
3328 configure_processors (0);
3329 _phase_control->resize (_input->n_ports().n_audio ());
3330 io_changed (); /* EMIT SIGNAL */
3333 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3336 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3337 if (_input->connected()) {
3338 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3339 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3343 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3344 if (does_feed && !sends_only) {
3345 if ((*i)->soloed()) {
3348 if ((*i)->solo_isolate_control()->solo_isolated()) {
3355 int delta = sbou - _solo_control->soloed_by_others_upstream();
3356 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3359 PBD::warning << string_compose (
3360 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3361 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3366 if (_solo_control->soloed_by_others_upstream()) {
3367 // ignore new connections (they're not propagated)
3369 _solo_control->mod_solo_by_others_upstream (delta);
3373 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3374 // solo-isolate currently only propagates downstream
3376 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3378 //_solo_isolated_by_upstream = ibou;
3381 // Session::route_solo_changed does not propagate indirect solo-changes
3382 // propagate downstream to tracks
3383 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3384 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3388 bool does_feed = feeds (*i, &sends_only);
3389 if (delta <= 0 && does_feed && !sends_only) {
3390 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3393 if (idelta < 0 && does_feed && !sends_only) {
3394 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3401 Route::output_change_handler (IOChange change, void * /*src*/)
3403 if (_initial_io_setup) {
3407 if ((change.type & IOChange::ConfigurationChanged)) {
3408 /* This is called with the process lock held if change
3409 contains ConfigurationChanged
3411 configure_processors (0);
3414 _session.reset_monitor_section();
3417 io_changed (); /* EMIT SIGNAL */
3420 if ((change.type & IOChange::ConnectionsChanged)) {
3422 /* do this ONLY if connections have changed. Configuration
3423 * changes do not, by themselves alter solo upstream or
3424 * downstream status.
3427 if (_solo_control->soloed_by_others_downstream()) {
3429 /* checking all all downstream routes for
3430 * explicit of implict solo is a rather drastic measure,
3431 * ideally the input_change_handler() of the other route
3432 * would propagate the change to us.
3434 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3435 if (_output->connected()) {
3436 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3437 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3441 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3442 if (does_feed && !sends_only) {
3443 if ((*i)->soloed()) {
3451 int delta = sbod - _solo_control->soloed_by_others_downstream();
3453 // do not allow new connections to change implicit solo (no propagation)
3454 _solo_control->mod_solo_by_others_downstream (delta);
3455 // Session::route_solo_changed() does not propagate indirect solo-changes
3456 // propagate upstream to tracks
3457 boost::shared_ptr<Route> shared_this = shared_from_this();
3458 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3459 if ((*i).get() == this || !can_solo()) {
3463 bool does_feed = (*i)->feeds (shared_this, &sends_only);
3464 if (delta != 0 && does_feed && !sends_only) {
3465 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3475 Route::sidechain_change_handler (IOChange change, void* src)
3477 if (_initial_io_setup || _in_sidechain_setup) {
3481 input_change_handler (change, src);
3485 Route::pans_required () const
3487 if (n_outputs().n_audio() < 2) {
3491 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3495 Route::flush_processor_buffers_locked (framecnt_t nframes)
3497 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3498 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3500 d->flush_buffers (nframes);
3502 boost::shared_ptr<PortInsert> p = boost::dynamic_pointer_cast<PortInsert> (*i);
3504 p->flush_buffers (nframes);
3511 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3513 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3519 if (n_outputs().n_total() == 0) {
3523 if (!_active || n_inputs() == ChanCount::ZERO) {
3524 silence_unlocked (nframes);
3528 if (session_state_changing) {
3529 if (_session.transport_speed() != 0.0f) {
3530 /* we're rolling but some state is changing (e.g. our diskstream contents)
3531 so we cannot use them. Be silent till this is over.
3533 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3535 silence_unlocked (nframes);
3538 /* we're really not rolling, so we're either delivery silence or actually
3539 monitoring, both of which are safe to do while session_state_changing is true.
3543 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3545 fill_buffers_with_input (bufs, _input, nframes);
3547 if (_meter_point == MeterInput) {
3548 _meter->run (bufs, start_frame, end_frame, 0.0, nframes, true);
3551 _amp->apply_gain_automation (false);
3552 _trim->apply_gain_automation (false);
3553 passthru (bufs, start_frame, end_frame, nframes, 0);
3555 flush_processor_buffers_locked (nframes);
3561 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3563 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3568 if (n_outputs().n_total() == 0) {
3572 if (!_active || n_inputs().n_total() == 0) {
3573 silence_unlocked (nframes);
3577 framepos_t unused = 0;
3579 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3585 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3587 fill_buffers_with_input (bufs, _input, nframes);
3589 if (_meter_point == MeterInput) {
3590 _meter->run (bufs, start_frame, end_frame, 1.0, nframes, true);
3593 passthru (bufs, start_frame, end_frame, nframes, declick);
3595 flush_processor_buffers_locked (nframes);
3601 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3604 flush_processor_buffers_locked (nframes);
3609 Route::flush_processors ()
3611 /* XXX shouldn't really try to take this lock, since
3612 this is called from the RT audio thread.
3615 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3617 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3623 __attribute__((annotate("realtime")))
3626 Route::apply_processor_changes_rt ()
3628 int emissions = EmitNone;
3630 if (_pending_meter_point != _meter_point) {
3631 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3633 /* meters always have buffers for 'processor_max_streams'
3634 * they can be re-positioned without re-allocation */
3635 if (set_meter_point_unlocked()) {
3636 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3638 emissions |= EmitMeterChanged;
3643 bool changed = false;
3645 if (g_atomic_int_get (&_pending_process_reorder)) {
3646 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3648 apply_processor_order (_pending_processor_order);
3649 setup_invisible_processors ();
3651 g_atomic_int_set (&_pending_process_reorder, 0);
3652 emissions |= EmitRtProcessorChange;
3656 set_processor_positions ();
3658 if (emissions != 0) {
3659 g_atomic_int_set (&_pending_signals, emissions);
3662 return (!selfdestruct_sequence.empty ());
3666 Route::emit_pending_signals ()
3668 int sig = g_atomic_int_and (&_pending_signals, 0);
3669 if (sig & EmitMeterChanged) {
3670 _meter->emit_configuration_changed();
3671 meter_change (); /* EMIT SIGNAL */
3672 if (sig & EmitMeterVisibilityChange) {
3673 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3675 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3678 if (sig & EmitRtProcessorChange) {
3679 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3682 /* this would be a job for the butler.
3683 * Conceptually we should not take processe/processor locks here.
3684 * OTOH its more efficient (less overhead for summoning the butler and
3685 * telling her what do do) and signal emission is called
3686 * directly after the process callback, which decreases the chance
3687 * of x-runs when taking the locks.
3689 while (!selfdestruct_sequence.empty ()) {
3690 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3691 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3692 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3693 selfdestruct_sequence.pop_back ();
3696 remove_processor (proc);
3702 Route::set_meter_point (MeterPoint p, bool force)
3704 if (_pending_meter_point == p && !force) {
3708 if (force || !AudioEngine::instance()->running()) {
3709 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3710 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3711 _pending_meter_point = p;
3712 _meter->emit_configuration_changed();
3713 meter_change (); /* EMIT SIGNAL */
3714 if (set_meter_point_unlocked()) {
3715 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3717 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3720 _pending_meter_point = p;
3726 __attribute__((annotate("realtime")))
3729 Route::set_meter_point_unlocked ()
3732 /* Caller must hold process and processor write lock */
3733 assert (!AudioEngine::instance()->process_lock().trylock());
3734 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3735 assert (!lm.locked ());
3738 _meter_point = _pending_meter_point;
3740 bool meter_was_visible_to_user = _meter->display_to_user ();
3742 if (!_custom_meter_position_noted) {
3743 maybe_note_meter_position ();
3746 if (_meter_point != MeterCustom) {
3748 _meter->set_display_to_user (false);
3750 setup_invisible_processors ();
3753 _meter->set_display_to_user (true);
3755 /* If we have a previous position for the custom meter, try to put it there */
3756 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3758 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3759 if (i != _processors.end ()) {
3760 _processors.remove (_meter);
3761 _processors.insert (i, _meter);
3763 } else {// at end, right before the mains_out/panner
3764 _processors.remove (_meter);
3765 ProcessorList::iterator main = _processors.end();
3766 _processors.insert (--main, _meter);
3770 /* Set up the meter for its new position */
3772 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3776 if (loc == _processors.begin()) {
3777 m_in = _input->n_ports();
3779 ProcessorList::iterator before = loc;
3781 m_in = (*before)->output_streams ();
3784 _meter->reflect_inputs (m_in);
3786 /* we do not need to reconfigure the processors, because the meter
3787 (a) is always ready to handle processor_max_streams
3788 (b) is always an N-in/N-out processor, and thus moving
3789 it doesn't require any changes to the other processors.
3792 /* these should really be done after releasing the lock
3793 * but all those signals are subscribed to with gui_thread()
3796 return (_meter->display_to_user() != meter_was_visible_to_user);
3800 Route::listen_position_changed ()
3803 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3804 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3805 ProcessorState pstate (this);
3807 if (configure_processors_unlocked (0, &lm)) {
3808 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3810 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
3815 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3816 _session.set_dirty ();
3819 boost::shared_ptr<CapturingProcessor>
3820 Route::add_export_point()
3822 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3823 if (!_capturing_processor) {
3825 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3826 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3828 // this aligns all tracks; but not tracks + busses
3829 assert (_session.worst_track_latency () >= _initial_delay);
3830 _capturing_processor.reset (new CapturingProcessor (_session, _session.worst_track_latency () - _initial_delay));
3831 _capturing_processor->activate ();
3833 configure_processors_unlocked (0, &lw);
3837 return _capturing_processor;
3841 Route::update_signal_latency ()
3843 framecnt_t l = _output->user_latency();
3844 framecnt_t lamp = 0;
3845 bool before_amp = true;
3846 framecnt_t ltrim = 0;
3847 bool before_trim = true;
3849 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3850 if ((*i)->active ()) {
3851 l += (*i)->signal_latency ();
3856 if ((*i) == _trim) {
3867 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3869 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3870 _signal_latency_at_amp_position = lamp;
3871 _signal_latency_at_trim_position = ltrim;
3873 if (_signal_latency != l) {
3874 _signal_latency = l;
3875 signal_latency_changed (); /* EMIT SIGNAL */
3878 return _signal_latency;
3882 Route::set_user_latency (framecnt_t nframes)
3884 _output->set_user_latency (nframes);
3885 _session.update_latency_compensation ();
3889 Route::set_latency_compensation (framecnt_t longest_session_latency)
3891 framecnt_t old = _initial_delay;
3893 if (_signal_latency < longest_session_latency) {
3894 _initial_delay = longest_session_latency - _signal_latency;
3899 DEBUG_TRACE (DEBUG::Latency, string_compose (
3900 "%1: compensate for maximum latency of %2,"
3901 "given own latency of %3, using initial delay of %4\n",
3902 name(), longest_session_latency, _signal_latency, _initial_delay));
3904 if (_initial_delay != old) {
3905 initial_delay_changed (); /* EMIT SIGNAL */
3908 if (_session.transport_stopped()) {
3909 _roll_delay = _initial_delay;
3914 Route::set_block_size (pframes_t nframes)
3916 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3917 (*i)->set_block_size (nframes);
3920 _session.ensure_buffers (n_process_buffers ());
3924 Route::protect_automation ()
3926 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3927 (*i)->protect_automation();
3930 /** @param declick 1 to set a pending declick fade-in,
3931 * -1 to set a pending declick fade-out
3934 Route::set_pending_declick (int declick)
3937 /* this call is not allowed to turn off a pending declick */
3939 _pending_declick = declick;
3942 _pending_declick = 0;
3946 /** Shift automation forwards from a particular place, thereby inserting time.
3947 * Adds undo commands for any shifts that are performed.
3949 * @param pos Position to start shifting from.
3950 * @param frames Amount to shift forwards by.
3954 Route::shift (framepos_t pos, framecnt_t frames)
3956 /* gain automation */
3958 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3960 XMLNode &before = gc->alist()->get_state ();
3961 gc->alist()->shift (pos, frames);
3962 XMLNode &after = gc->alist()->get_state ();
3963 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3966 /* gain automation */
3968 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
3970 XMLNode &before = gc->alist()->get_state ();
3971 gc->alist()->shift (pos, frames);
3972 XMLNode &after = gc->alist()->get_state ();
3973 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3976 // TODO mute automation ??
3978 /* pan automation */
3980 ControlSet::Controls& c (_pannable->controls());
3982 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3983 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3985 boost::shared_ptr<AutomationList> al = pc->alist();
3986 XMLNode& before = al->get_state ();
3987 al->shift (pos, frames);
3988 XMLNode& after = al->get_state ();
3989 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3994 /* redirect automation */
3996 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3997 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3999 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
4001 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
4002 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
4004 boost::shared_ptr<AutomationList> al = ac->alist();
4005 XMLNode &before = al->get_state ();
4006 al->shift (pos, frames);
4007 XMLNode &after = al->get_state ();
4008 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4016 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
4018 boost::shared_ptr<Processor> processor (p.lock ());
4019 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
4023 pi->set_state_dir (d);
4027 Route::save_as_template (const string& path, const string& name)
4029 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
4030 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
4032 XMLNode& node (state (false));
4036 IO::set_name_in_state (*node.children().front(), name);
4038 tree.set_root (&node);
4040 /* return zero on success, non-zero otherwise */
4041 return !tree.write (path.c_str());
4046 Route::set_name (const string& str)
4052 if (str == name()) {
4056 string name = Route::ensure_track_or_route_name (str, _session);
4057 SessionObject::set_name (name);
4059 bool ret = (_input->set_name(name) && _output->set_name(name));
4062 /* rename the main outs. Leave other IO processors
4063 * with whatever name they already have, because its
4064 * just fine as it is (it will not contain the route
4065 * name if its a port insert, port send or port return).
4069 if (_main_outs->set_name (name)) {
4070 /* XXX returning false here is stupid because
4071 we already changed the route name.
4081 /** Set the name of a route in an XML description.
4082 * @param node XML <Route> node to set the name in.
4083 * @param name New name.
4086 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
4088 node.add_property (X_("name"), name);
4090 XMLNodeList children = node.children();
4091 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
4093 if ((*i)->name() == X_("IO")) {
4095 IO::set_name_in_state (**i, name);
4097 } else if ((*i)->name() == X_("Processor")) {
4099 XMLProperty const * role = (*i)->property (X_("role"));
4100 if (role && role->value() == X_("Main")) {
4101 (*i)->add_property (X_("name"), name);
4104 } else if ((*i)->name() == X_("Diskstream")) {
4106 if (rename_playlist) {
4107 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
4109 (*i)->add_property (X_("name"), name);
4115 boost::shared_ptr<Send>
4116 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4118 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4120 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4121 boost::shared_ptr<InternalSend> send;
4123 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4124 if (send->target_route() == target) {
4130 return boost::shared_ptr<Send>();
4134 Route::set_denormal_protection (bool yn)
4136 if (_denormal_protection != yn) {
4137 _denormal_protection = yn;
4138 denormal_protection_changed (); /* EMIT SIGNAL */
4143 Route::denormal_protection () const
4145 return _denormal_protection;
4149 Route::set_active (bool yn, void* src)
4151 if (_session.transport_rolling()) {
4155 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4156 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4160 if (_active != yn) {
4162 _input->set_active (yn);
4163 _output->set_active (yn);
4164 active_changed (); // EMIT SIGNAL
4165 _session.set_dirty ();
4169 boost::shared_ptr<Pannable>
4170 Route::pannable() const
4175 boost::shared_ptr<Panner>
4176 Route::panner() const
4179 return _main_outs->panner_shell()->panner();
4182 boost::shared_ptr<PannerShell>
4183 Route::panner_shell() const
4185 return _main_outs->panner_shell();
4188 boost::shared_ptr<GainControl>
4189 Route::gain_control() const
4191 return _gain_control;
4194 boost::shared_ptr<GainControl>
4195 Route::trim_control() const
4197 return _trim_control;
4200 boost::shared_ptr<PhaseControl>
4201 Route::phase_control() const
4203 return _phase_control;
4206 boost::shared_ptr<AutomationControl>
4207 Route::get_control (const Evoral::Parameter& param)
4209 /* either we own the control or .... */
4211 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4215 /* maybe one of our processors does or ... */
4217 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4218 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4219 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4227 /* nobody does so we'll make a new one */
4229 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4236 boost::shared_ptr<Processor>
4237 Route::nth_plugin (uint32_t n) const
4239 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4240 ProcessorList::const_iterator i;
4242 for (i = _processors.begin(); i != _processors.end(); ++i) {
4243 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4250 return boost::shared_ptr<Processor> ();
4253 boost::shared_ptr<Processor>
4254 Route::nth_send (uint32_t n) const
4256 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4257 ProcessorList::const_iterator i;
4259 for (i = _processors.begin(); i != _processors.end(); ++i) {
4260 if (boost::dynamic_pointer_cast<Send> (*i)) {
4262 if ((*i)->name().find (_("Monitor")) == 0) {
4263 /* send to monitor section is not considered
4264 to be an accessible send.
4275 return boost::shared_ptr<Processor> ();
4279 Route::has_io_processor_named (const string& name)
4281 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4282 ProcessorList::iterator i;
4284 for (i = _processors.begin(); i != _processors.end(); ++i) {
4285 if (boost::dynamic_pointer_cast<Send> (*i) ||
4286 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4287 if ((*i)->name() == name) {
4297 Route::set_processor_positions ()
4299 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4301 bool had_amp = false;
4302 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4303 (*i)->set_pre_fader (!had_amp);
4310 /** Called when there is a proposed change to the input port count */
4312 Route::input_port_count_changing (ChanCount to)
4314 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4316 /* The processors cannot be configured with the new input arrangement, so
4322 /* The change is ok */
4326 /** Called when there is a proposed change to the output port count */
4328 Route::output_port_count_changing (ChanCount to)
4330 if (_strict_io && !_in_configure_processors) {
4333 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4334 if (processor_out_streams.get(*t) > to.get(*t)) {
4338 /* The change is ok */
4343 Route::unknown_processors () const
4347 if (_session.get_disable_all_loaded_plugins ()) {
4348 // Do not list "missing plugins" if they are explicitly disabled
4352 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4353 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4354 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4355 p.push_back ((*i)->name ());
4364 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4366 /* we assume that all our input ports feed all our output ports. its not
4367 universally true, but the alternative is way too corner-case to worry about.
4370 LatencyRange all_connections;
4373 all_connections.min = 0;
4374 all_connections.max = 0;
4376 all_connections.min = ~((pframes_t) 0);
4377 all_connections.max = 0;
4379 /* iterate over all "from" ports and determine the latency range for all of their
4380 connections to the "outside" (outside of this Route).
4383 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4387 p->get_connected_latency_range (range, playback);
4389 all_connections.min = min (all_connections.min, range.min);
4390 all_connections.max = max (all_connections.max, range.max);
4394 /* set the "from" port latencies to the max/min range of all their connections */
4396 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4397 p->set_private_latency_range (all_connections, playback);
4400 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4402 all_connections.min += our_latency;
4403 all_connections.max += our_latency;
4405 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4406 p->set_private_latency_range (all_connections, playback);
4409 return all_connections.max;
4413 Route::set_private_port_latencies (bool playback) const
4415 framecnt_t own_latency = 0;
4417 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4418 OR LATENCY CALLBACK.
4420 This is called (early) from the latency callback. It computes the REAL
4421 latency associated with each port and stores the result as the "private"
4422 latency of the port. A later call to Route::set_public_port_latencies()
4423 sets all ports to the same value to reflect the fact that we do latency
4424 compensation and so all signals are delayed by the same amount as they
4425 flow through ardour.
4428 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4429 if ((*i)->active ()) {
4430 own_latency += (*i)->signal_latency ();
4435 /* playback: propagate latency from "outside the route" to outputs to inputs */
4436 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4438 /* capture: propagate latency from "outside the route" to inputs to outputs */
4439 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4444 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4446 /* this is called to set the JACK-visible port latencies, which take
4447 latency compensation into account.
4456 const PortSet& ports (_input->ports());
4457 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4458 p->set_public_latency_range (range, playback);
4463 const PortSet& ports (_output->ports());
4464 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4465 p->set_public_latency_range (range, playback);
4470 /** Put the invisible processors in the right place in _processors.
4471 * Must be called with a writer lock on _processor_lock held.
4474 __attribute__((annotate("realtime")))
4477 Route::setup_invisible_processors ()
4480 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4481 assert (!lm.locked ());
4485 /* too early to be doing this stuff */
4489 /* we'll build this new list here and then use it
4491 * TODO put the ProcessorList is on the stack for RT-safety.
4494 ProcessorList new_processors;
4496 /* find visible processors */
4498 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4499 if ((*i)->display_to_user ()) {
4500 new_processors.push_back (*i);
4506 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4508 if (amp == new_processors.end ()) {
4509 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4510 new_processors.push_front (_amp);
4511 amp = find (new_processors.begin(), new_processors.end(), _amp);
4514 /* and the processor after the amp */
4516 ProcessorList::iterator after_amp = amp;
4522 switch (_meter_point) {
4524 assert (!_meter->display_to_user ());
4525 new_processors.push_front (_meter);
4528 assert (!_meter->display_to_user ());
4529 new_processors.insert (amp, _meter);
4531 case MeterPostFader:
4532 /* do nothing here */
4535 /* do nothing here */
4538 /* the meter is visible, so we don't touch it here */
4545 assert (_main_outs);
4546 assert (!_main_outs->display_to_user ());
4547 new_processors.push_back (_main_outs);
4549 /* iterator for the main outs */
4551 ProcessorList::iterator main = new_processors.end();
4554 /* OUTPUT METERING */
4556 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4557 assert (!_meter->display_to_user ());
4559 /* add the processor just before or just after the main outs */
4561 ProcessorList::iterator meter_point = main;
4563 if (_meter_point == MeterOutput) {
4566 new_processors.insert (meter_point, _meter);
4571 if (_monitor_send && !is_monitor ()) {
4572 assert (!_monitor_send->display_to_user ());
4573 switch (Config->get_listen_position ()) {
4574 case PreFaderListen:
4575 switch (Config->get_pfl_position ()) {
4576 case PFLFromBeforeProcessors:
4577 new_processors.push_front (_monitor_send);
4579 case PFLFromAfterProcessors:
4580 new_processors.insert (amp, _monitor_send);
4583 _monitor_send->set_can_pan (false);
4585 case AfterFaderListen:
4586 switch (Config->get_afl_position ()) {
4587 case AFLFromBeforeProcessors:
4588 new_processors.insert (after_amp, _monitor_send);
4590 case AFLFromAfterProcessors:
4591 new_processors.insert (new_processors.end(), _monitor_send);
4594 _monitor_send->set_can_pan (true);
4599 #if 0 // not used - just yet
4600 if (!is_master() && !is_monitor() && !is_auditioner()) {
4601 new_processors.push_front (_delayline);
4605 /* MONITOR CONTROL */
4607 if (_monitor_control && is_monitor ()) {
4608 assert (!_monitor_control->display_to_user ());
4609 new_processors.insert (amp, _monitor_control);
4614 if (_trim && _trim->active()) {
4615 assert (!_trim->display_to_user ());
4616 new_processors.push_front (_trim);
4619 /* INTERNAL RETURN */
4621 /* doing this here means that any monitor control will come after
4622 the return and trim.
4626 assert (!_intreturn->display_to_user ());
4627 new_processors.push_front (_intreturn);
4630 /* EXPORT PROCESSOR */
4632 if (_capturing_processor) {
4633 assert (!_capturing_processor->display_to_user ());
4634 new_processors.push_front (_capturing_processor);
4637 _processors = new_processors;
4639 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4640 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4641 (*i)->enable (true);
4645 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4646 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4647 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4654 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4655 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4659 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4660 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4667 /** If the meter point is `Custom', make a note of where the meter is.
4668 * This is so that if the meter point is subsequently set to something else,
4669 * and then back to custom, we can put the meter back where it was last time
4670 * custom was enabled.
4672 * Must be called with the _processor_lock held.
4675 Route::maybe_note_meter_position ()
4677 if (_meter_point != MeterCustom) {
4681 _custom_meter_position_noted = true;
4682 /* custom meter points range from after trim to before panner/main_outs
4683 * this is a limitation by the current processor UI
4685 bool seen_trim = false;
4686 _processor_after_last_custom_meter.reset();
4687 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4688 if ((*i) == _trim) {
4691 if ((*i) == _main_outs) {
4692 _processor_after_last_custom_meter = *i;
4695 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4697 _processor_after_last_custom_meter = _trim;
4699 ProcessorList::iterator j = i;
4701 assert(j != _processors.end ()); // main_outs should be before
4702 _processor_after_last_custom_meter = *j;
4707 assert(_processor_after_last_custom_meter.lock());
4710 boost::shared_ptr<Processor>
4711 Route::processor_by_id (PBD::ID id) const
4713 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4714 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4715 if ((*i)->id() == id) {
4720 return boost::shared_ptr<Processor> ();
4723 /** @return the monitoring state, or in other words what data we are pushing
4724 * into the route (data from the inputs, data from disk or silence)
4727 Route::monitoring_state () const
4729 return MonitoringInput;
4732 /** @return what we should be metering; either the data coming from the input
4733 * IO or the data that is flowing through the route.
4736 Route::metering_state () const
4738 return MeteringRoute;
4742 Route::has_external_redirects () const
4744 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4746 /* ignore inactive processors and obviously ignore the main
4747 * outs since everything has them and we don't care.
4750 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4758 boost::shared_ptr<Processor>
4759 Route::the_instrument () const
4761 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4762 return the_instrument_unlocked ();
4765 boost::shared_ptr<Processor>
4766 Route::the_instrument_unlocked () const
4768 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4769 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
4770 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
4774 return boost::shared_ptr<Processor>();
4780 Route::non_realtime_locate (framepos_t pos)
4783 _pannable->transport_located (pos);
4786 if (_delayline.get()) {
4787 _delayline.get()->flush();
4791 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4792 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4794 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4795 (*i)->transport_located (pos);
4798 _roll_delay = _initial_delay;
4802 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4809 * We don't currently mix MIDI input together, so we don't need the
4810 * complex logic of the audio case.
4813 n_buffers = bufs.count().n_midi ();
4815 for (i = 0; i < n_buffers; ++i) {
4817 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4818 MidiBuffer& buf (bufs.get_midi (i));
4821 buf.copy (source_port->get_midi_buffer(nframes));
4823 buf.silence (nframes);
4829 n_buffers = bufs.count().n_audio();
4831 size_t n_ports = io->n_ports().n_audio();
4832 float scaling = 1.0f;
4834 if (n_ports > n_buffers) {
4835 scaling = ((float) n_buffers) / n_ports;
4838 for (i = 0; i < n_ports; ++i) {
4840 /* if there are more ports than buffers, map them onto buffers
4841 * in a round-robin fashion
4844 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4845 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4848 if (i < n_buffers) {
4850 /* first time through just copy a channel into
4854 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4856 if (scaling != 1.0f) {
4857 buf.apply_gain (scaling, nframes);
4862 /* on subsequent times around, merge data from
4863 * the port with what is already there
4866 if (scaling != 1.0f) {
4867 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4869 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4874 /* silence any remaining buffers */
4876 for (; i < n_buffers; ++i) {
4877 AudioBuffer& buf (bufs.get_audio (i));
4878 buf.silence (nframes);
4881 /* establish the initial setup of the buffer set, reflecting what was
4882 copied into it. unless, of course, we are the auditioner, in which
4883 case nothing was fed into it from the inputs at all.
4886 if (!is_auditioner()) {
4887 bufs.set_count (io->n_ports());
4891 boost::shared_ptr<AutomationControl>
4892 Route::pan_azimuth_control() const
4895 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
4897 return boost::shared_ptr<AutomationControl>();
4899 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
4900 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
4902 if (!_pannable || !panner()) {
4903 return boost::shared_ptr<AutomationControl>();
4905 return _pannable->pan_azimuth_control;
4909 boost::shared_ptr<AutomationControl>
4910 Route::pan_elevation_control() const
4912 if (Profile->get_mixbus() || !_pannable || !panner()) {
4913 return boost::shared_ptr<AutomationControl>();
4916 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4918 if (c.find (PanElevationAutomation) != c.end()) {
4919 return _pannable->pan_elevation_control;
4921 return boost::shared_ptr<AutomationControl>();
4924 boost::shared_ptr<AutomationControl>
4925 Route::pan_width_control() const
4927 if (Profile->get_mixbus() || !_pannable || !panner()) {
4928 return boost::shared_ptr<AutomationControl>();
4931 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4933 if (c.find (PanWidthAutomation) != c.end()) {
4934 return _pannable->pan_width_control;
4936 return boost::shared_ptr<AutomationControl>();
4939 boost::shared_ptr<AutomationControl>
4940 Route::pan_frontback_control() const
4942 if (Profile->get_mixbus() || !_pannable || !panner()) {
4943 return boost::shared_ptr<AutomationControl>();
4946 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4948 if (c.find (PanFrontBackAutomation) != c.end()) {
4949 return _pannable->pan_frontback_control;
4951 return boost::shared_ptr<AutomationControl>();
4954 boost::shared_ptr<AutomationControl>
4955 Route::pan_lfe_control() const
4957 if (Profile->get_mixbus() || !_pannable || !panner()) {
4958 return boost::shared_ptr<AutomationControl>();
4961 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
4963 if (c.find (PanLFEAutomation) != c.end()) {
4964 return _pannable->pan_lfe_control;
4966 return boost::shared_ptr<AutomationControl>();
4971 Route::eq_band_cnt () const
4973 if (Profile->get_mixbus()) {
4975 if (is_master() || mixbus()) {
4984 /* Ardour has no well-known EQ object */
4989 boost::shared_ptr<AutomationControl>
4990 Route::eq_gain_controllable (uint32_t band) const
4993 boost::shared_ptr<PluginInsert> eq = ch_eq();
4996 return boost::shared_ptr<AutomationControl>();
4999 uint32_t port_number;
5000 if (is_master() || mixbus()) {
5002 case 0: port_number = 4; break;
5003 case 1: port_number = 3; break;
5004 case 2: port_number = 2; break;
5006 return boost::shared_ptr<AutomationControl>();
5011 case 0: port_number = 14; break;
5012 case 1: port_number = 12; break;
5013 case 2: port_number = 10; break;
5014 case 3: port_number = 8; break;
5016 return boost::shared_ptr<AutomationControl>();
5020 case 0: port_number = 8; break;
5021 case 1: port_number = 6; break;
5022 case 2: port_number = 4; break;
5024 return boost::shared_ptr<AutomationControl>();
5029 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5031 return boost::shared_ptr<AutomationControl>();
5034 boost::shared_ptr<AutomationControl>
5035 Route::eq_freq_controllable (uint32_t band) const
5038 if (mixbus() || is_master()) {
5039 /* no frequency controls for mixbusses or master */
5040 return boost::shared_ptr<AutomationControl>();
5043 boost::shared_ptr<PluginInsert> eq = ch_eq();
5046 return boost::shared_ptr<AutomationControl>();
5049 uint32_t port_number;
5052 case 0: port_number = 13; break;
5053 case 1: port_number = 11; break;
5054 case 2: port_number = 9; break;
5055 case 3: port_number = 7; break;
5057 return boost::shared_ptr<AutomationControl>();
5061 case 0: port_number = 7; break;
5062 case 1: port_number = 5; break;
5063 case 2: port_number = 3; break;
5065 return boost::shared_ptr<AutomationControl>();
5069 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5071 return boost::shared_ptr<AutomationControl>();
5075 boost::shared_ptr<AutomationControl>
5076 Route::eq_q_controllable (uint32_t band) const
5078 return boost::shared_ptr<AutomationControl>();
5081 boost::shared_ptr<AutomationControl>
5082 Route::eq_shape_controllable (uint32_t band) const
5084 return boost::shared_ptr<AutomationControl>();
5087 boost::shared_ptr<AutomationControl>
5088 Route::eq_enable_controllable () const
5091 boost::shared_ptr<PluginInsert> eq = ch_eq();
5094 return boost::shared_ptr<AutomationControl>();
5097 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5099 return boost::shared_ptr<AutomationControl>();
5103 boost::shared_ptr<AutomationControl>
5104 Route::eq_hpf_controllable () const
5107 boost::shared_ptr<PluginInsert> eq = ch_eq();
5109 if (is_master() || mixbus() || !eq) {
5110 return boost::shared_ptr<AutomationControl>();
5113 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5115 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5119 return boost::shared_ptr<AutomationControl>();
5124 Route::eq_band_name (uint32_t band) const
5127 if (is_master() || mixbus()) {
5129 if (Profile->get_mixbus()) {
5131 case 0: return _("lo");
5132 case 1: return _("mid");
5133 case 2: return _("hi");
5134 default: return string();
5142 case 0: return _("lo");
5143 case 1: return _("lo mid");
5144 case 2: return _("hi mid");
5145 case 3: return _("hi");
5146 default: return string();
5152 boost::shared_ptr<AutomationControl>
5153 Route::comp_enable_controllable () const
5156 boost::shared_ptr<PluginInsert> comp = ch_comp();
5159 return boost::shared_ptr<AutomationControl>();
5162 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5164 return boost::shared_ptr<AutomationControl>();
5167 boost::shared_ptr<AutomationControl>
5168 Route::comp_threshold_controllable () const
5171 boost::shared_ptr<PluginInsert> comp = ch_comp();
5174 return boost::shared_ptr<AutomationControl>();
5177 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5180 return boost::shared_ptr<AutomationControl>();
5183 boost::shared_ptr<AutomationControl>
5184 Route::comp_speed_controllable () const
5187 boost::shared_ptr<PluginInsert> comp = ch_comp();
5190 return boost::shared_ptr<AutomationControl>();
5193 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5195 return boost::shared_ptr<AutomationControl>();
5198 boost::shared_ptr<AutomationControl>
5199 Route::comp_mode_controllable () const
5202 boost::shared_ptr<PluginInsert> comp = ch_comp();
5205 return boost::shared_ptr<AutomationControl>();
5208 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5210 return boost::shared_ptr<AutomationControl>();
5213 boost::shared_ptr<AutomationControl>
5214 Route::comp_makeup_controllable () const
5217 boost::shared_ptr<PluginInsert> comp = ch_comp();
5220 return boost::shared_ptr<AutomationControl>();
5223 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5225 return boost::shared_ptr<AutomationControl>();
5228 boost::shared_ptr<ReadOnlyControl>
5229 Route::comp_redux_controllable () const
5232 boost::shared_ptr<PluginInsert> comp = ch_comp();
5235 return boost::shared_ptr<ReadOnlyControl>();
5238 return comp->control_output (2);
5240 return comp->control_output (6);
5244 return boost::shared_ptr<ReadOnlyControl>();
5249 Route::comp_mode_name (uint32_t mode) const
5254 return _("Leveler");
5256 return _("Compressor");
5258 return _("Limiter");
5260 return mixbus() ? _("Sidechain") : _("Limiter");
5270 Route::comp_speed_name (uint32_t mode) const
5288 boost::shared_ptr<AutomationControl>
5289 Route::send_level_controllable (uint32_t n) const
5292 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5294 return boost::shared_ptr<AutomationControl>();
5299 return boost::shared_ptr<AutomationControl>();
5302 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5303 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5305 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5307 return boost::shared_ptr<AutomationControl>();
5309 return s->gain_control ();
5313 boost::shared_ptr<AutomationControl>
5314 Route::send_enable_controllable (uint32_t n) const
5317 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5319 return boost::shared_ptr<AutomationControl>();
5324 return boost::shared_ptr<AutomationControl>();
5327 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5328 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5330 /* although Ardour sends have enable/disable as part of the Processor
5331 API, it is not exposed as a controllable.
5333 XXX: we should fix this.
5335 return boost::shared_ptr<AutomationControl>();
5340 Route::send_name (uint32_t n) const
5346 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5350 boost::shared_ptr<Processor> p = nth_send (n);
5359 boost::shared_ptr<AutomationControl>
5360 Route::master_send_enable_controllable () const
5363 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5365 return boost::shared_ptr<AutomationControl>();
5367 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5369 return boost::shared_ptr<AutomationControl>();
5374 Route::slaved () const
5376 if (!_gain_control) {
5379 /* just test one particular control, not all of them */
5380 return _gain_control->slaved ();
5384 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5386 if (!vca || !_gain_control) {
5390 /* just test one particular control, not all of them */
5392 return _gain_control->slaved_to (vca->gain_control());
5396 Route::muted_by_others_soloing () const
5398 if (!can_be_muted_by_others ()) {
5402 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5406 Route::clear_all_solo_state ()
5408 _solo_control->clear_all_solo_state ();