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/locale_guard.h"
34 #include "pbd/memento_command.h"
35 #include "pbd/stacktrace.h"
36 #include "pbd/types_convert.h"
37 #include "pbd/unwind.h"
39 #include "ardour/amp.h"
40 #include "ardour/audio_buffer.h"
41 #include "ardour/audio_track.h"
42 #include "ardour/audio_port.h"
43 #include "ardour/audioengine.h"
44 #include "ardour/boost_debug.h"
45 #include "ardour/buffer.h"
46 #include "ardour/buffer_set.h"
47 #include "ardour/capturing_processor.h"
48 #include "ardour/debug.h"
49 #include "ardour/delivery.h"
50 #include "ardour/disk_reader.h"
51 #include "ardour/disk_writer.h"
52 #include "ardour/event_type_map.h"
53 #include "ardour/gain_control.h"
54 #include "ardour/internal_return.h"
55 #include "ardour/internal_send.h"
56 #include "ardour/meter.h"
57 #include "ardour/delayline.h"
58 #include "ardour/midi_buffer.h"
59 #include "ardour/midi_port.h"
60 #include "ardour/monitor_control.h"
61 #include "ardour/monitor_processor.h"
62 #include "ardour/pannable.h"
63 #include "ardour/panner.h"
64 #include "ardour/panner_shell.h"
65 #include "ardour/parameter_descriptor.h"
66 #include "ardour/phase_control.h"
67 #include "ardour/plugin_insert.h"
68 #include "ardour/port.h"
69 #include "ardour/port_insert.h"
70 #include "ardour/processor.h"
71 #include "ardour/profile.h"
72 #include "ardour/route.h"
73 #include "ardour/route_group.h"
74 #include "ardour/send.h"
75 #include "ardour/session.h"
76 #include "ardour/solo_control.h"
77 #include "ardour/solo_isolate_control.h"
78 #include "ardour/types_convert.h"
79 #include "ardour/unknown_processor.h"
80 #include "ardour/utils.h"
81 #include "ardour/vca.h"
86 using namespace ARDOUR;
89 PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, Route::PluginSetupOptions > Route::PluginSetup;
91 /** Base class for all routable/mixable objects (tracks and busses) */
92 Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType default_type)
93 : Stripable (sess, name, PresentationInfo (flag))
94 , GraphNode (sess._process_graph)
95 , Muteable (sess, name)
98 , _disk_io_point (DiskIOPreFader)
99 , _pending_process_reorder (0)
100 , _pending_signals (0)
101 , _pending_declick (true)
102 , _meter_point (MeterPostFader)
103 , _pending_meter_point (MeterPostFader)
104 , _meter_type (MeterPeak)
105 , _denormal_protection (false)
108 , _declickable (false)
109 , _have_internal_generator (false)
110 , _default_type (default_type)
113 , _in_configure_processors (false)
114 , _initial_io_setup (false)
115 , _in_sidechain_setup (false)
116 , _custom_meter_position_noted (false)
118 , _patch_selector_dialog (0)
120 processor_max_streams.reset();
123 boost::weak_ptr<Route>
124 Route::weakroute () {
125 return boost::weak_ptr<Route> (boost::dynamic_pointer_cast<Route> (shared_from_this ()));
131 /* set default meter type */
133 _meter_type = Config->get_meter_type_master ();
135 else if (dynamic_cast<Track*>(this)) {
136 _meter_type = Config->get_meter_type_track ();
138 _meter_type = Config->get_meter_type_bus ();
141 /* add standard controls */
143 _gain_control.reset (new GainControl (_session, GainAutomation));
144 _trim_control.reset (new GainControl (_session, TrimAutomation));
145 /* While the route has-a gain-control for consistency with Stripable and VCA
146 * ownership is handed over to the Amp Processor which manages the
147 * state of the Control and AutomationList as part of its
148 * Automatable API. -- Don't call add_control () here.
151 _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
152 add_control (_solo_control);
153 _solo_control->Changed.connect_same_thread (*this, boost::bind (&Route::solo_control_changed, this, _1, _2));
155 _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
156 add_control (_mute_control);
158 _phase_control.reset (new PhaseControl (_session, X_("phase")));
159 add_control (_phase_control);
161 _solo_isolate_control.reset (new SoloIsolateControl (_session, X_("solo-iso"), *this, *this));
162 add_control (_solo_isolate_control);
164 _solo_safe_control.reset (new SoloSafeControl (_session, X_("solo-safe")));
165 add_control (_solo_safe_control);
169 if (!(_presentation_info.flags() & PresentationInfo::MonitorOut)) {
170 _pannable.reset (new Pannable (_session));
173 /* input and output objects */
175 _input.reset (new IO (_session, _name, IO::Input, _default_type));
176 _output.reset (new IO (_session, _name, IO::Output, _default_type));
178 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
179 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
181 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
182 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
184 /* add the amp/fader processor.
185 * it should be the first processor to be added on every route.
188 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
189 add_processor (_amp, PostFader);
192 _amp->set_display_name (_("Monitor"));
195 if (!is_master() && !is_monitor() && !is_auditioner()) {
196 _delayline.reset (new DelayLine (_session, name ()));
201 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
202 _trim->set_display_to_user (false);
204 if (dynamic_cast<AudioTrack*>(this)) {
205 /* we can't do this in the AudioTrack's constructor
206 * because _trim does not exit then
210 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
215 /* create standard processors: meter, main outs, monitor out;
216 they will be added to _processors by setup_invisible_processors ()
219 _meter.reset (new PeakMeter (_session, _name));
220 _meter->set_owner (this);
221 _meter->set_display_to_user (false);
224 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
225 _main_outs->activate ();
228 /* where we listen to tracks */
229 _intreturn.reset (new InternalReturn (_session));
230 _intreturn->activate ();
232 /* the thing that provides proper control over a control/monitor/listen bus
233 (such as per-channel cut, dim, solo, invert, etc).
235 _monitor_control.reset (new MonitorProcessor (_session));
236 _monitor_control->activate ();
239 /* now that we have _meter, its safe to connect to this */
242 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
243 configure_processors (0);
251 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
253 /* do this early so that we don't get incoming signals as we are going through destruction
258 /* don't use clear_processors here, as it depends on the session which may
259 be half-destroyed by now
262 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
263 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
264 (*i)->drop_references ();
267 _processors.clear ();
271 Route::ensure_track_or_route_name(string name, Session &session)
273 string newname = name;
275 while (!session.io_name_is_legal (newname)) {
276 newname = bump_name_once (newname, ' ');
283 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
285 // TODO route group, see set_gain()
286 // _trim_control->route_set_value (val);
290 Route::maybe_declick (BufferSet&, samplecnt_t, int)
292 /* this is the "bus" implementation and they never declick.
297 /** Process this route for one (sub) cycle (process thread)
299 * @param bufs Scratch buffers to use for the signal path
300 * @param start_sample Initial transport sample
301 * @param end_sample Final transport sample
302 * @param nframes Number of samples to output (to ports)
304 * Note that (end_sample - start_sample) may not be equal to nframes when the
305 * transport speed isn't 1.0 (eg varispeed).
308 Route::process_output_buffers (BufferSet& bufs,
309 samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes,
310 int declick, bool gain_automation_ok, bool run_disk_reader)
312 /* Caller must hold process lock */
313 assert (!AudioEngine::instance()->process_lock().trylock());
315 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
317 // can this actually happen?
318 // Places that need a WriterLock on (_processor_lock) must also take the process-lock.
319 bufs.silence (nframes, 0);
320 assert (0); // ...one way to find out.
324 /* We should offset the route-owned ctrls by the given latency, however
325 * this only affects Mute. Other route-owned controls (solo, polarity..)
326 * are not automatable.
328 * Mute has its own issues since there's not a single mute-point,
331 automation_run (start_sample, nframes);
333 /* figure out if we're going to use gain automation */
334 if (gain_automation_ok) {
335 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
336 _amp->setup_gain_automation (
337 start_sample + _amp->output_latency (),
338 end_sample + _amp->output_latency (),
341 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
342 _trim->setup_gain_automation (
343 start_sample + _trim->output_latency (),
344 end_sample + _trim->output_latency (),
348 /* We align the playhead to output. The user hears what the clock says:
349 * When the playhead/clock says 1:00:00:00 the user will hear the audio sample
350 * at 1:00:00:00. sample_start will be [sample at] 1:00:00:00
352 * e.g. clock says Time T = 0, sample_start = 0
353 * Disk-read(play) -> latent-plugin (+10) -> fader-automation -> output (+5)
354 * -> total playback latency "disk -> out" is 15.
355 * -> at Time T= -15, the disk-reader reads sample T=0.
356 * By the Time T=0 is reached (dt=15 later) that sample is audible.
359 start_sample += _signal_latency;
360 end_sample += _signal_latency;
362 start_sample += _output->latency ();
363 end_sample += _output->latency ();
365 const double speed = (is_auditioner() ? 1.0 : _session.transport_speed ());
367 /* Note: during intial pre-roll 'start_sample' as passed as argument can be negative.
368 * Functions calling process_output_buffers() will set "run_disk_reader"
369 * to false if the pre-roll count-down is larger than playback_latency ().
371 * playback_latency() is guarnteed to be <= _signal_latency + _output->latency ()
373 assert (!_disk_reader || !run_disk_reader || start_sample >= 0);
375 /* however the disk-writer may need to pick up output from other tracks
376 * during pre-roll (in particular if this route has latent effects after the disk).
378 * e.g. track 1 play -> latency A --port--> track2 capture -> latency B ---> out
379 * total pre-roll = A + B.
381 * Note the disk-writer has built-in overlap detection (it's safe to run it early)
384 bool run_disk_writer = false;
385 if (_disk_writer && speed != 0) {
386 samplecnt_t latency_preroll = _session.remaining_latency_preroll ();
387 run_disk_writer = latency_preroll < nframes + (_signal_latency + _output->latency ());
388 if (end_sample - _disk_writer->input_latency () < _session.transport_sample ()) {
389 run_disk_writer = true;
393 /* Tell main outs what to do about monitoring. We do this so that
394 * on a transition between monitoring states we get a de-clicking gain
395 * change in the _main_outs delivery, if config.get_use_monitor_fades()
398 * We override this in the case where we have an internal generator.
400 * FIXME: when punching in/out this also depends on latency compensated time
401 * for this route. monitoring_state() does not currently handle that correctly,.
403 * Also during remaining_latency_preroll, transport_rolling () is false, but
404 * we may need to monitor disk instead.
406 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
408 _main_outs->no_outs_cuz_we_no_monitor (silence);
410 /* -------------------------------------------------------------------------------------------
411 GLOBAL DECLICK (for transport changes etc.)
412 ----------------------------------------------------------------------------------------- */
414 // XXX not latency compensated. calls Amp::declick, but there may be
415 // plugins between disk and Fader.
416 maybe_declick (bufs, nframes, declick);
417 _pending_declick = 0;
419 /* -------------------------------------------------------------------------------------------
420 DENORMAL CONTROL/PHASE INVERT
421 ----------------------------------------------------------------------------------------- */
423 /* TODO phase-control should become a processor, or rather a Stub-processor:
424 * a point in the chain which calls a special-cased private Route method.
425 * _phase_control is route-owned and dynamic.)
426 * and we should rename it to polarity.
428 * denormals: we'll need to protect silent inputs as well as silent disk
429 * (when not monitoring input). Or simply drop that feature.
431 if (!_phase_control->none()) {
435 if (_denormal_protection || Config->get_denormal_protection()) {
437 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
438 Sample* const sp = i->data();
440 if (_phase_control->inverted (chn)) {
441 for (pframes_t nx = 0; nx < nframes; ++nx) {
446 for (pframes_t nx = 0; nx < nframes; ++nx) {
454 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
455 Sample* const sp = i->data();
457 if (_phase_control->inverted (chn)) {
458 for (pframes_t nx = 0; nx < nframes; ++nx) {
467 if (_denormal_protection || Config->get_denormal_protection()) {
469 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
470 Sample* const sp = i->data();
471 for (pframes_t nx = 0; nx < nframes; ++nx) {
479 /* -------------------------------------------------------------------------------------------
481 ----------------------------------------------------------------------------------------- */
483 /* set this to be true if the meter will already have been ::run() earlier */
484 bool const meter_already_run = metering_state() == MeteringInput;
486 samplecnt_t latency = 0;
488 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
490 /* TODO check for split cycles here.
492 * start_frame, end_frame is adjusted by latency and may
496 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
497 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
502 /* if it has any inputs, make sure they match */
503 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
504 if (bufs.count() != (*i)->input_streams()) {
506 DEBUG::Processors, string_compose (
507 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
508 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
515 if (boost::dynamic_pointer_cast<PluginInsert>(*i) != 0) {
516 /* set potential sidechain ports, capture and playback latency.
517 * This effectively sets jack port latency which should include
518 * up/downstream latencies.
520 * However, the value is not used by Ardour (2017-09-20) and calling
521 * IO::latency() is expensive, so we punt.
524 * input()->latenct + latency,
526 * output->latency() + _signal_latency - latency
528 * Also see note below, _signal_latency may be smaller than latency
529 * if a plugin's latency increases while it's running.
531 const samplecnt_t playback_latency = std::max ((samplecnt_t)0, _signal_latency - latency);
532 boost::dynamic_pointer_cast<PluginInsert>(*i)->set_sidechain_latency (
533 /* input->latency() + */ latency, /* output->latency() + */ playback_latency);
536 double pspeed = speed;
537 if ((!run_disk_reader && (*i) == _disk_reader) || (!run_disk_writer && (*i) == _disk_writer)) {
538 /* run with speed 0, no-roll */
542 (*i)->run (bufs, start_sample - latency, end_sample - latency, pspeed, nframes, *i != _processors.back());
543 bufs.set_count ((*i)->output_streams());
545 /* Note: plugin latency may change. While the plugin does inform the session via
546 * processor_latency_changed(). But the session may not yet have gotten around to
547 * update the actual worste-case and update this track's _signal_latency.
549 * So there can be cases where adding up all latencies may not equal _signal_latency.
551 if ((*i)->active ()) {
552 latency += (*i)->signal_latency ();
555 if ((*i) == _delayline) {
556 latency += _delayline->get_delay ();
563 Route::bounce_process (BufferSet& buffers, samplepos_t start, samplecnt_t nframes,
564 boost::shared_ptr<Processor> endpoint,
565 bool include_endpoint, bool for_export, bool for_freeze)
567 /* If no processing is required, there's no need to go any further. */
568 if (!endpoint && !include_endpoint) {
572 samplecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
573 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
574 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
576 /* trim is always at the top, for bounce no latency compensation is needed */
577 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
578 _trim->setup_gain_automation (start, start + nframes, nframes);
581 const double speed = _session.transport_speed ();
582 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
584 if (!include_endpoint && (*i) == endpoint) {
588 /* if we're *not* exporting, stop processing if we come across a routing processor. */
589 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
592 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
596 /* special case the panner (export outputs)
597 * Ideally we'd only run the panner, not the delivery itself...
598 * but panners need separate input/output buffers and some context
599 * (panshell, panner type, etc). AFAICT there is no ill side effect
600 * of re-using the main delivery when freewheeling/exporting a region.
602 if ((*i) == _main_outs) {
603 assert ((*i)->does_routing());
604 (*i)->run (buffers, start - latency, start - latency + nframes, speed, nframes, true);
605 buffers.set_count ((*i)->output_streams());
608 /* don't run any processors that do routing.
609 * Also don't bother with metering.
611 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
612 (*i)->run (buffers, start - latency, start - latency + nframes, 1.0, nframes, true);
613 buffers.set_count ((*i)->output_streams());
614 latency += (*i)->signal_latency ();
617 if ((*i) == endpoint) {
624 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
625 bool include_endpoint, bool for_export, bool for_freeze) const
627 samplecnt_t latency = 0;
628 if (!endpoint && !include_endpoint) {
632 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
633 if (!include_endpoint && (*i) == endpoint) {
636 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
639 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
642 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
643 latency += (*i)->signal_latency ();
645 if ((*i) == endpoint) {
653 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
654 bool include_endpoint, bool for_export, bool for_freeze) const
656 if (!endpoint && !include_endpoint) {
660 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
661 if (!include_endpoint && (*i) == endpoint) {
664 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
667 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
670 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
671 cc = (*i)->output_streams();
673 if ((*i) == endpoint) {
681 Route::n_process_buffers ()
683 return max (_input->n_ports(), processor_max_streams);
687 Route::monitor_run (samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick)
689 assert (is_monitor());
690 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
691 fill_buffers_with_input (bufs, _input, nframes);
692 passthru (bufs, start_sample, end_sample, nframes, declick, true, false);
696 Route::passthru (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick, bool gain_automation_ok, bool run_disk_reader)
700 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
702 /* control/monitor bus ignores input ports when something is
703 feeding the listen "stream". data will "arrive" into the
704 route from the intreturn processor element.
707 bufs.silence (nframes, 0);
710 /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
712 write_out_of_band_data (bufs, start_sample, end_sample, nframes);
714 /* run processor chain */
716 process_output_buffers (bufs, start_sample, end_sample, nframes, declick, gain_automation_ok, run_disk_reader);
720 Route::passthru_silence (samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick)
722 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
724 bufs.set_count (_input->n_ports());
725 write_out_of_band_data (bufs, start_sample, end_sample, nframes);
726 process_output_buffers (bufs, start_sample, end_sample, nframes, declick, false, false);
730 Route::set_listen (bool yn)
733 if (_monitor_send->active() == yn) {
737 _monitor_send->activate ();
739 _monitor_send->deactivate ();
745 Route::solo_control_changed (bool, Controllable::GroupControlDisposition)
747 /* nothing to do if we're not using AFL/PFL. But if we are, we need
748 to alter the active state of the monitor send.
751 if (Config->get_solo_control_is_listen_control ()) {
752 set_listen (_solo_control->self_soloed() || _solo_control->get_masters_value());
757 Route::push_solo_isolate_upstream (int32_t delta)
759 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
761 boost::shared_ptr<RouteList> routes = _session.get_routes ();
762 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
764 if ((*i).get() == this || !(*i)->can_solo()) {
769 bool does_feed = feeds (*i, &sends_only);
771 if (does_feed && !sends_only) {
772 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (delta);
778 Route::push_solo_upstream (int delta)
780 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
781 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
785 boost::shared_ptr<Route> sr (i->r.lock());
787 sr->solo_control()->mod_solo_by_others_downstream (-delta);
794 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
796 cerr << name << " {" << endl;
797 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
798 p != procs.end(); ++p) {
799 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
805 /** Supposing that we want to insert a Processor at a given Placement, return
806 * the processor to add the new one before (or 0 to add at the end).
808 boost::shared_ptr<Processor>
809 Route::before_processor_for_placement (Placement p)
811 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
813 ProcessorList::iterator loc;
816 /* generic pre-fader: insert immediately before the amp */
817 loc = find (_processors.begin(), _processors.end(), _amp);
819 /* generic post-fader: insert right before the main outs */
820 loc = find (_processors.begin(), _processors.end(), _main_outs);
823 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
826 /** Supposing that we want to insert a Processor at a given index, return
827 * the processor to add the new one before (or 0 to add at the end).
829 boost::shared_ptr<Processor>
830 Route::before_processor_for_index (int index)
833 return boost::shared_ptr<Processor> ();
836 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
838 ProcessorList::iterator i = _processors.begin ();
840 while (i != _processors.end() && j < index) {
841 if ((*i)->display_to_user()) {
848 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
851 /** Add a processor either pre- or post-fader
852 * @return 0 on success, non-0 on failure.
855 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
857 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
861 /** Add a processor to a route such that it ends up with a given index into the visible processors.
862 * @param index Index to add the processor at, or -1 to add at the end of the list.
863 * @return 0 on success, non-0 on failure.
866 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
868 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
871 /** Add a processor to the route.
872 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
873 * @return 0 on success, non-0 on failure.
876 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
878 assert (processor != _meter);
879 assert (processor != _main_outs);
881 DEBUG_TRACE (DEBUG::Processors, string_compose (
882 "%1 adding processor %2\n", name(), processor->name()));
886 pl.push_back (processor);
887 int rv = add_processors (pl, before, err);
893 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
894 processor->activate ();
901 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
903 /* We cannot destruct the processor here (usually RT-thread
904 * with various locks held - in case of sends also io_locks).
905 * Queue for deletion in low-priority thread.
907 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
908 selfdestruct_sequence.push_back (wp);
912 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
914 XMLProperty const * prop;
917 boost::shared_ptr<Processor> processor;
919 /* bit of a hack: get the `placement' property from the <Redirect> tag here
920 so that we can add the processor in the right place (pre/post-fader)
923 XMLNodeList const & children = node.children ();
924 XMLNodeList::const_iterator i = children.begin ();
926 while (i != children.end() && (*i)->name() != X_("Redirect")) {
930 Placement placement = PreFader;
932 if (i != children.end()) {
933 if ((prop = (*i)->property (X_("placement"))) != 0) {
934 placement = Placement (string_2_enum (prop->value(), placement));
938 if (node.name() == "Insert") {
940 if ((prop = node.property ("type")) != 0) {
942 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
943 prop->value() == "lv2" ||
944 prop->value() == "windows-vst" ||
945 prop->value() == "mac-vst" ||
946 prop->value() == "lxvst" ||
947 prop->value() == "audiounit") {
949 if (_session.get_disable_all_loaded_plugins ()) {
950 processor.reset (new UnknownProcessor (_session, node));
952 processor.reset (new PluginInsert (_session));
953 processor->set_owner (this);
958 processor.reset (new PortInsert (_session, _pannable, _mute_master));
963 } else if (node.name() == "Send") {
965 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
966 processor.reset (new Send (_session, sendpan, _mute_master));
970 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
974 if (processor->set_state (node, version)) {
978 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
979 if (i != children.end()) {
980 if ((prop = (*i)->property (X_("active"))) != 0) {
981 if ( string_to<bool> (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
982 processor->activate();
984 processor->deactivate();
988 return (add_processor (processor, placement, 0, false) == 0);
991 catch (failed_constructor &err) {
992 warning << _("processor could not be created. Ignored.") << endmsg;
998 inline Route::PluginSetupOptions operator|= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
999 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) | static_cast<int> (b));
1002 inline Route::PluginSetupOptions operator&= (Route::PluginSetupOptions& a, const Route::PluginSetupOptions& b) {
1003 return a = static_cast<Route::PluginSetupOptions> (static_cast <int>(a) & static_cast<int> (b));
1007 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1009 ProcessorList::iterator loc;
1010 boost::shared_ptr <PluginInsert> fanout;
1012 if (g_atomic_int_get (&_pending_process_reorder)) {
1013 /* we need to flush any pending re-order changes */
1014 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1015 apply_processor_changes_rt ();
1019 loc = find(_processors.begin(), _processors.end(), before);
1020 if (loc == _processors.end ()) {
1024 /* nothing specified - at end */
1025 loc = _processors.end ();
1028 if (others.empty()) {
1032 ProcessorList to_skip;
1034 // check if there's an instrument to replace or configure
1035 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1036 boost::shared_ptr<PluginInsert> pi;
1037 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) == 0) {
1040 if (!pi->plugin ()->get_info ()->is_instrument ()) {
1043 boost::shared_ptr<Processor> instrument = the_instrument ();
1044 ChanCount in (DataType::MIDI, 1);
1045 ChanCount out (DataType::AUDIO, 2); // XXX route's out?!
1047 PluginSetupOptions flags = None;
1049 flags |= CanReplace;
1050 in = instrument->input_streams ();
1051 out = instrument->output_streams ();
1053 if (pi->has_output_presets (in, out)) {
1057 pi->set_strict_io (_strict_io);
1059 PluginSetupOptions mask = None;
1060 if (Config->get_ask_replace_instrument ()) {
1063 if (Config->get_ask_setup_instrument ()) {
1069 if (flags != None) {
1070 boost::optional<int> rv = PluginSetup (boost::dynamic_pointer_cast<Route>(shared_from_this ()), pi, flags); /* EMIT SIGNAL */
1071 int mode = rv.get_value_or (0);
1074 to_skip.push_back (*i); // don't add this one;
1077 replace_processor (instrument, *i, err);
1078 to_skip.push_back (*i);
1083 if ((mode & 5) == 4) {
1090 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1091 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1092 ProcessorState pstate (this);
1094 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1099 ProcessorList::iterator check = find (to_skip.begin(), to_skip.end(), *i);
1100 if (check != to_skip.end()) {
1104 boost::shared_ptr<PluginInsert> pi;
1106 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1107 pi->set_strict_io (_strict_io);
1111 /* Ensure that only one amp is in the list at any time */
1112 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), *i);
1113 if (check != _processors.end()) {
1114 if (before == _amp) {
1115 /* Already in position; all is well */
1118 _processors.erase (check);
1123 assert (find (_processors.begin(), _processors.end(), *i) == _processors.end ());
1125 _processors.insert (loc, *i);
1126 (*i)->set_owner (this);
1129 if (configure_processors_unlocked (err, &lm)) {
1131 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1136 if (pi && pi->has_sidechain ()) {
1137 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
1140 if ((*i)->active()) {
1141 // emit ActiveChanged() and latency_changed() if needed
1145 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1147 boost::shared_ptr<Send> send;
1148 if ((send = boost::dynamic_pointer_cast<Send> (*i))) {
1149 send->SelfDestruct.connect_same_thread (*this,
1150 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (*i)));
1154 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1155 boost::shared_ptr<PluginInsert> pi;
1157 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1158 if (pi->has_no_inputs ()) {
1159 _have_internal_generator = true;
1165 _output->set_user_latency (0);
1168 reset_instrument_info ();
1169 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1170 set_processor_positions ();
1172 if (fanout && fanout->configured ()
1173 && fanout->output_streams().n_audio() > 2
1174 && boost::dynamic_pointer_cast<PluginInsert> (the_instrument ()) == fanout) {
1175 fan_out (); /* EMIT SIGNAL */
1181 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1183 if (p == PreFader) {
1184 start = _processors.begin();
1185 end = find(_processors.begin(), _processors.end(), _amp);
1187 start = find(_processors.begin(), _processors.end(), _amp);
1189 end = _processors.end();
1193 /** Turn off all processors with a given placement
1194 * @param p Placement of processors to disable
1197 Route::disable_processors (Placement p)
1199 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1201 ProcessorList::iterator start, end;
1202 placement_range(p, start, end);
1204 for (ProcessorList::iterator i = start; i != end; ++i) {
1205 (*i)->enable (false);
1208 _session.set_dirty ();
1211 /** Turn off all redirects
1214 Route::disable_processors ()
1216 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1218 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1219 (*i)->enable (false);
1222 _session.set_dirty ();
1225 /** Turn off all redirects with a given placement
1226 * @param p Placement of redirects to disable
1229 Route::disable_plugins (Placement p)
1231 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1233 ProcessorList::iterator start, end;
1234 placement_range(p, start, end);
1236 for (ProcessorList::iterator i = start; i != end; ++i) {
1237 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1238 (*i)->enable (false);
1242 _session.set_dirty ();
1245 /** Turn off all plugins
1248 Route::disable_plugins ()
1250 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1252 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1253 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1254 (*i)->enable (false);
1258 _session.set_dirty ();
1263 Route::ab_plugins (bool forward)
1265 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1269 /* forward = turn off all active redirects, and mark them so that the next time
1270 we go the other way, we will revert them
1273 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1274 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1277 if (!(*i)->display_to_user ()) {
1281 if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
1286 if ((*i)->enabled ()) {
1287 (*i)->enable (false);
1288 (*i)->set_next_ab_is_active (true);
1290 (*i)->set_next_ab_is_active (false);
1296 /* backward = if the redirect was marked to go active on the next ab, do so */
1298 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1299 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1302 if (!(*i)->display_to_user ()) {
1306 if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
1311 (*i)->enable ((*i)->get_next_ab_is_active ());
1315 _session.set_dirty ();
1319 /** Remove processors with a given placement.
1320 * @param p Placement of processors to remove.
1323 Route::clear_processors (Placement p)
1325 if (!_session.engine().connected()) {
1329 bool already_deleting = _session.deletion_in_progress();
1330 if (!already_deleting) {
1331 _session.set_deletion_in_progress();
1334 ProcessorList old_list = _processors;
1336 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1337 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1338 ProcessorList new_list;
1339 ProcessorStreams err;
1340 bool seen_amp = false;
1342 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1348 if (is_internal_processor (*i)) {
1350 /* you can't remove these */
1352 new_list.push_back (*i);
1359 new_list.push_back (*i);
1362 (*i)->drop_references ();
1370 (*i)->drop_references ();
1373 new_list.push_back (*i);
1380 _processors = new_list;
1381 configure_processors_unlocked (&err, &lm); // this can't fail
1383 /* drop references w/o process-lock (I/O procs may re-take it in ~IO() */
1386 processor_max_streams.reset();
1387 _have_internal_generator = false;
1388 reset_instrument_info ();
1389 set_processor_positions ();
1391 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1393 if (!already_deleting) {
1394 _session.clear_deletion_in_progress();
1399 Route::is_internal_processor (boost::shared_ptr<Processor> p) const
1401 if (p == _amp || p == _meter || p == _main_outs || p == _delayline || p == _trim) {
1408 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1410 // TODO once the export point can be configured properly, do something smarter here
1411 if (processor == _capturing_processor) {
1412 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1413 if (need_process_lock) {
1417 _capturing_processor.reset();
1419 if (need_process_lock) {
1424 /* these can never be removed */
1426 if (is_internal_processor (processor)) {
1430 if (!_session.engine().connected()) {
1434 processor_max_streams.reset();
1437 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1438 if (need_process_lock) {
1442 /* Caller must hold process lock */
1443 assert (!AudioEngine::instance()->process_lock().trylock());
1445 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1447 ProcessorState pstate (this);
1449 ProcessorList::iterator i;
1450 bool removed = false;
1452 for (i = _processors.begin(); i != _processors.end(); ) {
1453 if (*i == processor) {
1455 /* move along, see failure case for configure_processors()
1456 where we may need to reconfigure the processor.
1459 /* stop redirects that send signals to JACK ports
1460 from causing noise as a result of no longer being
1464 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1465 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1469 iop = pi->sidechain();
1476 i = _processors.erase (i);
1484 _output->set_user_latency (0);
1492 if (configure_processors_unlocked (err, &lm)) {
1494 /* we know this will work, because it worked before :) */
1495 configure_processors_unlocked (0, &lm);
1499 _have_internal_generator = false;
1501 for (i = _processors.begin(); i != _processors.end(); ++i) {
1502 boost::shared_ptr<PluginInsert> pi;
1504 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1505 if (pi->has_no_inputs ()) {
1506 _have_internal_generator = true;
1511 if (need_process_lock) {
1516 reset_instrument_info ();
1517 processor->drop_references ();
1518 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1519 set_processor_positions ();
1525 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1527 /* these can never be removed */
1528 if (is_internal_processor (old)) {
1531 /* and can't be used as substitute, either */
1532 if (is_internal_processor (sub)) {
1536 /* I/Os are out, too */
1537 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1541 /* this function cannot be used to swap/reorder processors */
1542 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1546 if (!AudioEngine::instance()->connected() || !old || !sub) {
1550 /* ensure that sub is not owned by another route */
1551 if (sub->owner ()) {
1556 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1557 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1558 ProcessorState pstate (this);
1560 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1562 ProcessorList::iterator i;
1563 bool replaced = false;
1564 bool enable = old->enabled ();
1566 for (i = _processors.begin(); i != _processors.end(); ) {
1568 i = _processors.erase (i);
1569 _processors.insert (i, sub);
1570 sub->set_owner (this);
1583 boost::shared_ptr<PluginInsert> pi;
1584 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1585 pi->set_strict_io (true);
1589 if (configure_processors_unlocked (err, &lm)) {
1591 configure_processors_unlocked (0, &lm);
1595 _have_internal_generator = false;
1597 for (i = _processors.begin(); i != _processors.end(); ++i) {
1598 boost::shared_ptr<PluginInsert> pi;
1599 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1600 if (pi->has_no_inputs ()) {
1601 _have_internal_generator = true;
1611 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1612 _output->set_user_latency (0);
1615 reset_instrument_info ();
1616 old->drop_references ();
1617 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1618 set_processor_positions ();
1623 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1625 ProcessorList deleted;
1627 if (!_session.engine().connected()) {
1631 processor_max_streams.reset();
1634 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1635 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1636 ProcessorState pstate (this);
1638 ProcessorList::iterator i;
1639 boost::shared_ptr<Processor> processor;
1641 for (i = _processors.begin(); i != _processors.end(); ) {
1645 /* these can never be removed */
1647 if (is_internal_processor (processor)) {
1652 /* see if its in the list of processors to delete */
1654 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1659 /* stop IOProcessors that send to JACK ports
1660 from causing noise as a result of no longer being
1664 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1665 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1668 iop = pi->sidechain();
1675 deleted.push_back (processor);
1676 i = _processors.erase (i);
1679 if (deleted.empty()) {
1680 /* none of those in the requested list were found */
1684 _output->set_user_latency (0);
1686 if (configure_processors_unlocked (err, &lm)) {
1688 /* we know this will work, because it worked before :) */
1689 configure_processors_unlocked (0, &lm);
1694 _have_internal_generator = false;
1696 for (i = _processors.begin(); i != _processors.end(); ++i) {
1697 boost::shared_ptr<PluginInsert> pi;
1699 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1700 if (pi->has_no_inputs ()) {
1701 _have_internal_generator = true;
1708 /* now try to do what we need to so that those that were removed will be deleted */
1710 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1711 (*i)->drop_references ();
1714 reset_instrument_info ();
1715 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1716 set_processor_positions ();
1722 Route::reset_instrument_info ()
1724 boost::shared_ptr<Processor> instr = the_instrument();
1726 _instrument_info.set_internal_instrument (instr);
1730 /** Caller must hold process lock */
1732 Route::configure_processors (ProcessorStreams* err)
1734 #ifndef PLATFORM_WINDOWS
1735 assert (!AudioEngine::instance()->process_lock().trylock());
1738 if (!_in_configure_processors) {
1739 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1740 return configure_processors_unlocked (err, &lm);
1747 Route::input_streams () const
1749 return _input->n_ports ();
1752 list<pair<ChanCount, ChanCount> >
1753 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1755 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1757 return try_configure_processors_unlocked (in, err);
1760 list<pair<ChanCount, ChanCount> >
1761 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1763 // Check each processor in order to see if we can configure as requested
1765 list<pair<ChanCount, ChanCount> > configuration;
1768 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1769 DEBUG_TRACE (DEBUG::Processors, "{\n");
1771 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1773 if ((*p)->can_support_io_configuration(in, out)) {
1775 if (boost::dynamic_pointer_cast<Delivery> (*p)
1776 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
1778 && (is_monitor() || _strict_io || Profile->get_mixbus ())) {
1779 /* with strict I/O the panner + output are forced to
1780 * follow the last processor's output.
1782 * Delivery::can_support_io_configuration() will only add ports,
1783 * but not remove excess ports.
1785 * This works because the delivery only requires
1786 * as many outputs as there are inputs.
1787 * Delivery::configure_io() will do the actual removal
1788 * by calling _output->ensure_io()
1790 if (!is_master() && _session.master_out () && in.n_audio() > 0) {
1791 /* ..but at least as many as there are master-inputs, if
1792 * the delivery is dealing with audio */
1793 // XXX this may need special-casing for mixbus (master-outputs)
1794 // and should maybe be a preference anyway ?!
1795 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
1801 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1802 configuration.push_back(make_pair(in, out));
1805 // restriction for Monitor Section Processors
1806 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
1807 /* Note: The Monitor follows the master-bus and has no panner.
1809 * The general idea is to only allow plugins that retain the channel-count
1810 * and plugins with MIDI in (e.g VSTs with control that will remain unconnected).
1811 * Then again 5.1 in, monitor stereo is a valid use-case.
1813 * and worse: we only refuse adding plugins *here*.
1815 * 1) stereo-master, stereo-mon, add a stereo-plugin, OK
1816 * 2) change master-bus, add a channel
1817 * 2a) monitor-secion follows
1818 * 3) monitor processors fail to re-reconfigure (stereo plugin)
1819 * 4) re-load session, monitor-processor remains unconfigured, crash.
1821 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration change.\n");
1823 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
1824 // internal sends make no sense, only feedback
1825 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1826 return list<pair<ChanCount, ChanCount> > ();
1828 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
1829 /* External Sends can be problematic. one can add/remove ports
1830 * there signal leaves the DAW to external monitors anyway, so there's
1831 * no real use for allowing them here anyway.
1833 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
1834 return list<pair<ChanCount, ChanCount> > ();
1836 if (boost::dynamic_pointer_cast<Send> (*p)) {
1838 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
1839 return list<pair<ChanCount, ChanCount> > ();
1848 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1849 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1850 DEBUG_TRACE (DEBUG::Processors, "}\n");
1851 return list<pair<ChanCount, ChanCount> > ();
1855 DEBUG_TRACE (DEBUG::Processors, "}\n");
1857 return configuration;
1860 /** Set the input/output configuration of each processor in the processors list.
1861 * Caller must hold process lock.
1862 * Return 0 on success, otherwise configuration is impossible.
1865 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
1867 #ifndef PLATFORM_WINDOWS
1868 assert (!AudioEngine::instance()->process_lock().trylock());
1871 if (_in_configure_processors) {
1875 /* put invisible processors where they should be */
1876 setup_invisible_processors ();
1878 _in_configure_processors = true;
1880 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1882 if (configuration.empty ()) {
1883 _in_configure_processors = false;
1888 bool seen_mains_out = false;
1889 processor_out_streams = _input->n_ports();
1890 processor_max_streams.reset();
1892 /* processor configure_io() may result in adding ports
1893 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
1895 * with jack2 adding ports results in a graph-order callback,
1896 * which calls Session::resort_routes() and eventually
1897 * Route::direct_feeds_according_to_reality()
1898 * which takes a ReaderLock (_processor_lock).
1900 * so we can't hold a WriterLock here until jack2 threading
1903 * NB. we still hold the process lock
1905 * (ardour's own engines do call graph-order from the
1906 * process-thread and hence do not have this issue; besides
1907 * merely adding ports won't trigger a graph-order, only
1908 * making connections does)
1912 // TODO check for a potential ReaderLock after ReaderLock ??
1913 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
1915 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1916 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1918 if (!(*p)->configure_io(c->first, c->second)) {
1919 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
1920 _in_configure_processors = false;
1926 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1927 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1929 boost::shared_ptr<IOProcessor> iop;
1930 boost::shared_ptr<PluginInsert> pi;
1931 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
1932 /* plugins connected via Split or Hide Match may have more channels.
1933 * route/scratch buffers are needed for all of them
1934 * The configuration may only be a subset (both input and output)
1936 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
1938 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
1939 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
1940 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
1944 if (boost::dynamic_pointer_cast<Delivery> (*p)
1945 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1946 /* main delivery will increase port count to match input.
1947 * the Delivery::Main is usually the last processor - followed only by
1950 seen_mains_out = true;
1952 if (!seen_mains_out) {
1953 processor_out_streams = out;
1962 _meter->set_max_channels (processor_max_streams);
1965 /* make sure we have sufficient scratch buffers to cope with the new processor
1968 _session.ensure_buffers (n_process_buffers ());
1970 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1972 _in_configure_processors = false;
1976 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1977 * @param state New active state for those processors.
1980 Route::all_visible_processors_active (bool state)
1982 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1984 if (_processors.empty()) {
1988 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1989 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1993 boost::shared_ptr<PluginInsert> pi;
1994 if (0 != (pi = boost::dynamic_pointer_cast<PluginInsert>(*i))) {
1995 if (pi->is_channelstrip ()) {
2000 (*i)->enable (state);
2003 _session.set_dirty ();
2007 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
2009 /* check if re-order requires re-configuration of any processors
2010 * -> compare channel configuration for all processors
2012 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2013 ChanCount c = input_streams ();
2015 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
2017 if (c != (*j)->input_streams()) {
2020 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2023 if ((*i)->input_streams() != c) {
2026 c = (*i)->output_streams();
2038 __attribute__((annotate("realtime")))
2041 Route::apply_processor_order (const ProcessorList& new_order)
2043 /* need to hold processor_lock; either read or write lock
2044 * and the engine process_lock.
2045 * Due to r/w lock ambiguity we can only assert the latter
2047 assert (!AudioEngine::instance()->process_lock().trylock());
2050 /* "new_order" is an ordered list of processors to be positioned according to "placement".
2051 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
2052 * processors in the current actual processor list that are hidden. Any visible processors
2053 * in the current list but not in "new_order" will be assumed to be deleted.
2056 /* "as_it_will_be" and "_processors" are lists of shared pointers.
2057 * actual memory usage is small, but insert/erase is not actually rt-safe :(
2058 * (note though that ::processors_reorder_needs_configure() ensured that
2059 * this function will only ever be called from the rt-thread if no processor were removed)
2061 * either way, I can't proove it, but an x-run due to re-order here is less likley
2062 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
2065 ProcessorList as_it_will_be;
2066 ProcessorList::iterator oiter;
2067 ProcessorList::const_iterator niter;
2069 oiter = _processors.begin();
2070 niter = new_order.begin();
2072 while (niter != new_order.end()) {
2074 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
2075 then append it to the temp list.
2077 Otherwise, see if the next processor in the old list is in the new list. if not,
2078 its been deleted. If its there, append it to the temp list.
2081 if (oiter == _processors.end()) {
2083 /* no more elements in the old list, so just stick the rest of
2084 the new order onto the temp list.
2087 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
2088 while (niter != new_order.end()) {
2095 if (!(*oiter)->display_to_user()) {
2097 as_it_will_be.push_back (*oiter);
2101 /* visible processor: check that its in the new order */
2103 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
2104 /* deleted: do nothing, shared_ptr<> will clean up */
2106 /* ignore this one, and add the next item from the new order instead */
2107 as_it_will_be.push_back (*niter);
2112 /* now remove from old order - its taken care of no matter what */
2113 oiter = _processors.erase (oiter);
2117 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
2119 /* If the meter is in a custom position, find it and make a rough note of its position */
2120 maybe_note_meter_position ();
2124 Route::move_instrument_down (bool postfader)
2126 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2127 ProcessorList new_order;
2128 boost::shared_ptr<Processor> instrument;
2129 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2130 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
2131 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
2133 } else if (instrument && *i == _amp) {
2135 new_order.push_back (*i);
2136 new_order.push_back (instrument);
2138 new_order.push_back (instrument);
2139 new_order.push_back (*i);
2142 new_order.push_back (*i);
2149 reorder_processors (new_order, 0);
2153 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
2155 // it a change is already queued, wait for it
2156 // (unless engine is stopped. apply immediately and proceed
2157 while (g_atomic_int_get (&_pending_process_reorder)) {
2158 if (!AudioEngine::instance()->running()) {
2159 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
2160 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2162 apply_processor_order(_pending_processor_order);
2163 setup_invisible_processors ();
2165 g_atomic_int_set (&_pending_process_reorder, 0);
2167 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2168 set_processor_positions ();
2170 // TODO rather use a semaphore or something.
2171 // but since ::reorder_processors() is called
2172 // from the GUI thread, this is fine..
2177 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
2179 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2180 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2181 ProcessorState pstate (this);
2183 apply_processor_order (new_order);
2185 if (configure_processors_unlocked (err, &lm)) {
2193 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2194 set_processor_positions ();
2197 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2198 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2200 // _pending_processor_order is protected by _processor_lock
2201 _pending_processor_order = new_order;
2202 g_atomic_int_set (&_pending_process_reorder, 1);
2205 /* update processor input/output latency
2206 * (total signal_latency does not change)
2208 update_signal_latency (true);
2214 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2216 boost::shared_ptr<PluginInsert> pi;
2217 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2221 if (pi->has_sidechain () == add) {
2222 return true; // ?? call failed, but result is as expected.
2226 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2227 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2228 if (i == _processors.end ()) {
2234 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2235 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2236 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2238 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2240 if (!pi->add_sidechain ()) {
2244 if (!pi->del_sidechain ()) {
2250 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2255 pi->del_sidechain ();
2257 pi->add_sidechain ();
2258 // TODO restore side-chain's state.
2263 configure_processors_unlocked (0, &lm);
2266 if (pi->has_sidechain ()) {
2267 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2270 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2271 _session.set_dirty ();
2276 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2278 boost::shared_ptr<PluginInsert> pi;
2279 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2284 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2285 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2286 if (i == _processors.end ()) {
2292 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2293 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2295 const ChanCount& old (pi->preset_out ());
2296 if (!pi->set_preset_out (outs)) {
2297 return true; // no change, OK
2300 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2303 pi->set_preset_out (old);
2306 configure_processors_unlocked (0, &lm);
2309 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2310 _session.set_dirty ();
2315 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2318 return customize_plugin_insert (proc, 0, unused, unused);
2322 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2324 boost::shared_ptr<PluginInsert> pi;
2325 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2330 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2331 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2332 if (i == _processors.end ()) {
2338 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2339 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2341 bool old_cust = pi->custom_cfg ();
2342 uint32_t old_cnt = pi->get_count ();
2343 ChanCount old_chan = pi->output_streams ();
2344 ChanCount old_sinks = pi->natural_input_streams ();
2347 pi->set_custom_cfg (false);
2349 pi->set_custom_cfg (true);
2350 pi->set_count (count);
2351 pi->set_outputs (outs);
2352 pi->set_sinks (sinks);
2355 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2359 pi->set_count (old_cnt);
2360 pi->set_sinks (old_sinks);
2361 pi->set_outputs (old_chan);
2362 pi->set_custom_cfg (old_cust);
2366 configure_processors_unlocked (0, &lm);
2369 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2370 _session.set_dirty ();
2375 Route::set_strict_io (const bool enable)
2377 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2379 if (_strict_io != enable) {
2380 _strict_io = enable;
2381 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2382 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2383 boost::shared_ptr<PluginInsert> pi;
2384 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2385 pi->set_strict_io (_strict_io);
2389 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2393 _strict_io = !enable; // restore old value
2394 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2395 boost::shared_ptr<PluginInsert> pi;
2396 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2397 pi->set_strict_io (_strict_io);
2404 configure_processors (0);
2407 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2408 _session.set_dirty ();
2420 Route::get_template()
2422 return state(false);
2426 Route::state(bool full_state)
2428 if (!_session._template_state_dir.empty()) {
2429 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2432 XMLNode *node = new XMLNode("Route");
2433 ProcessorList::iterator i;
2435 node->set_property (X_("id"), id ());
2436 node->set_property (X_("name"), name());
2437 node->set_property (X_("default-type"), _default_type);
2438 node->set_property (X_("strict-io"), _strict_io);
2440 node->add_child_nocopy (_presentation_info.get_state());
2442 node->set_property (X_("active"), _active);
2443 node->set_property (X_("denormal-protection"), _denormal_protection);
2444 node->set_property (X_("meter-point"), _meter_point);
2445 node->set_property (X_("disk-io-point"), _disk_io_point);
2447 node->set_property (X_("meter-type"), _meter_type);
2450 node->set_property (X_("route-group"), _route_group->name());
2453 node->add_child_nocopy (_solo_control->get_state ());
2454 node->add_child_nocopy (_solo_isolate_control->get_state ());
2455 node->add_child_nocopy (_solo_safe_control->get_state ());
2457 node->add_child_nocopy (_input->state (full_state));
2458 node->add_child_nocopy (_output->state (full_state));
2459 node->add_child_nocopy (_mute_master->get_state ());
2461 node->add_child_nocopy (_mute_control->get_state ());
2462 node->add_child_nocopy (_phase_control->get_state ());
2465 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2468 if (_comment.length()) {
2469 XMLNode *cmt = node->add_child ("Comment");
2470 cmt->add_content (_comment);
2474 node->add_child_nocopy (_pannable->state (full_state));
2478 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2479 for (i = _processors.begin(); i != _processors.end(); ++i) {
2480 if (*i == _delayline) {
2484 /* template save: do not include internal sends functioning as
2485 aux sends because the chance of the target ID
2486 in the session where this template is used
2489 similarly, do not save listen sends which connect to
2490 the monitor section, because these will always be
2493 boost::shared_ptr<InternalSend> is;
2495 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2496 if (is->role() == Delivery::Listen) {
2501 node->add_child_nocopy((*i)->state (full_state));
2506 node->add_child_copy (*_extra_xml);
2509 if (_custom_meter_position_noted) {
2510 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2512 node->set_property (X_("processor-after-last-custom-meter"), after->id());
2516 if (!_session._template_state_dir.empty()) {
2517 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2520 node->add_child_copy (Slavable::get_state());
2526 Route::set_state (const XMLNode& node, int version)
2528 if (version < 3000) {
2529 return set_state_2X (node, version);
2533 XMLNodeConstIterator niter;
2536 if (node.name() != "Route"){
2537 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2541 std::string route_name;
2542 if (node.get_property (X_("name"), route_name)) {
2543 Route::set_name (route_name);
2547 _initial_io_setup = true;
2549 Stripable::set_state (node, version);
2551 node.get_property (X_("strict-io"), _strict_io);
2554 /* monitor bus does not get a panner, but if (re)created
2555 via XML, it will already have one by the time we
2556 call ::set_state(). so ... remove it.
2561 /* add all processors (except amp, which is always present) */
2563 nlist = node.children();
2564 XMLNode processor_state (X_("processor_state"));
2566 Stateful::save_extra_xml (node);
2568 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2572 if (child->name() == IO::state_node_name) {
2573 std::string direction;
2574 if (!child->get_property (X_("direction"), direction)) {
2578 if (direction == "Input") {
2579 _input->set_state (*child, version);
2580 } else if (direction == "Output") {
2581 _output->set_state (*child, version);
2584 } else if (child->name() == X_("Processor")) {
2585 processor_state.add_child_copy (*child);
2586 } else if (child->name() == X_("Pannable")) {
2588 _pannable->set_state (*child, version);
2590 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2592 } else if (child->name() == Slavable::xml_node_name) {
2593 Slavable::set_state (*child, version);
2598 if (node.get_property (X_("meter-point"), mp)) {
2599 set_meter_point (mp, true);
2601 _meter->set_display_to_user (_meter_point == MeterCustom);
2606 if (node.get_property (X_("disk-io-point"), diop)) {
2608 _disk_writer->set_display_to_user (diop == DiskIOCustom);
2611 _disk_reader->set_display_to_user (diop == DiskIOCustom);
2613 set_disk_io_point (diop);
2616 node.get_property (X_("meter-type"), _meter_type);
2618 _initial_io_setup = false;
2620 set_processor_state (processor_state);
2622 // this looks up the internal instrument in processors
2623 reset_instrument_info();
2625 bool denormal_protection;
2626 if (node.get_property (X_("denormal-protection"), denormal_protection)) {
2627 set_denormal_protection (denormal_protection);
2630 /* convert old 3001 state */
2631 std::string phase_invert_str;
2632 if (node.get_property (X_("phase-invert"), phase_invert_str)) {
2633 _phase_control->set_phase_invert (boost::dynamic_bitset<> (phase_invert_str));
2637 if (node.get_property (X_("active"), is_active)) {
2638 set_active (is_active, this);
2641 std::string id_string;
2642 if (node.get_property (X_("processor-after-last-custom-meter"), id_string)) {
2643 PBD::ID id (id_string);
2644 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2645 ProcessorList::const_iterator i = _processors.begin ();
2646 while (i != _processors.end() && (*i)->id() != id) {
2650 if (i != _processors.end ()) {
2651 _processor_after_last_custom_meter = *i;
2652 _custom_meter_position_noted = true;
2656 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2659 if (child->name() == X_("Comment")) {
2661 /* XXX this is a terrible API design in libxml++ */
2663 XMLNode *cmt = *(child->children().begin());
2664 _comment = cmt->content();
2666 } else if (child->name() == Controllable::xml_node_name) {
2667 std::string control_name;
2668 if (!child->get_property (X_("name"), control_name)) {
2672 if (control_name == _solo_control->name()) {
2673 _solo_control->set_state (*child, version);
2674 } else if (control_name == _solo_safe_control->name()) {
2675 _solo_safe_control->set_state (*child, version);
2676 } else if (control_name == _solo_isolate_control->name()) {
2677 _solo_isolate_control->set_state (*child, version);
2678 } else if (control_name == _mute_control->name()) {
2679 _mute_control->set_state (*child, version);
2680 } else if (control_name == _phase_control->name()) {
2681 _phase_control->set_state (*child, version);
2683 Evoral::Parameter p = EventTypeMap::instance().from_symbol (control_name);
2684 if (p.type () >= MidiCCAutomation && p.type () < MidiSystemExclusiveAutomation) {
2685 boost::shared_ptr<AutomationControl> ac = automation_control (p, true);
2687 ac->set_state (*child, version);
2691 } else if (child->name() == MuteMaster::xml_node_name) {
2692 _mute_master->set_state (*child, version);
2694 } else if (child->name() == Automatable::xml_node_name) {
2695 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2700 _delayline->set_name (name ());
2707 Route::set_state_2X (const XMLNode& node, int version)
2711 XMLNodeConstIterator niter;
2713 XMLProperty const * prop;
2715 /* 2X things which still remain to be handled:
2721 if (node.name() != "Route") {
2722 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2726 Stripable::set_state (node, version);
2728 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2729 set_denormal_protection (string_to<bool> (prop->value()));
2732 if ((prop = node.property (X_("muted"))) != 0) {
2735 bool muted = string_to<bool> (prop->value());
2741 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2743 if (string_to<bool> (prop->value())){
2744 mute_point = mute_point + "PreFader";
2749 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2751 if (string_to<bool> (prop->value())){
2754 mute_point = mute_point + ",";
2757 mute_point = mute_point + "PostFader";
2762 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2764 if (string_to<bool> (prop->value())){
2767 mute_point = mute_point + ",";
2770 mute_point = mute_point + "Listen";
2775 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2777 if (string_to<bool> (prop->value())){
2780 mute_point = mute_point + ",";
2783 mute_point = mute_point + "Main";
2787 _mute_master->set_mute_points (mute_point);
2788 _mute_master->set_muted_by_self (true);
2792 if ((prop = node.property (X_("meter-point"))) != 0) {
2793 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2798 nlist = node.children ();
2799 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2803 if (child->name() == IO::state_node_name) {
2805 /* there is a note in IO::set_state_2X() about why we have to call
2809 _input->set_state_2X (*child, version, true);
2810 _output->set_state_2X (*child, version, false);
2812 if ((prop = child->property (X_("name"))) != 0) {
2813 Route::set_name (prop->value ());
2818 if ((prop = child->property (X_("active"))) != 0) {
2819 bool yn = string_to<bool> (prop->value());
2820 _active = !yn; // force switch
2821 set_active (yn, this);
2824 if ((prop = child->property (X_("gain"))) != 0) {
2827 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2828 _amp->gain_control()->set_value (val, Controllable::NoGroup);
2832 /* Set up Panners in the IO */
2833 XMLNodeList io_nlist = child->children ();
2835 XMLNodeConstIterator io_niter;
2838 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2840 io_child = *io_niter;
2842 if (io_child->name() == X_("Panner")) {
2843 _main_outs->panner_shell()->set_state(*io_child, version);
2844 } else if (io_child->name() == X_("Automation")) {
2845 /* IO's automation is for the fader */
2846 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2852 XMLNodeList redirect_nodes;
2854 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2858 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2859 redirect_nodes.push_back(child);
2864 set_processor_state_2X (redirect_nodes, version);
2866 Stateful::save_extra_xml (node);
2868 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2871 if (child->name() == X_("Comment")) {
2873 /* XXX this is a terrible API design in libxml++ */
2875 XMLNode *cmt = *(child->children().begin());
2876 _comment = cmt->content();
2878 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2879 if (prop->value() == X_("solo")) {
2880 _solo_control->set_state (*child, version);
2881 } else if (prop->value() == X_("mute")) {
2882 _mute_control->set_state (*child, version);
2892 Route::get_processor_state ()
2894 XMLNode* root = new XMLNode (X_("redirects"));
2895 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2896 root->add_child_nocopy ((*i)->state (true));
2903 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2905 /* We don't bother removing existing processors not in nList, as this
2906 method will only be called when creating a Route from scratch, not
2907 for undo purposes. Just put processors in at the appropriate place
2911 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2912 add_processor_from_xml_2X (**i, version);
2917 Route::set_processor_state (const XMLNode& node)
2919 const XMLNodeList &nlist = node.children();
2920 XMLNodeConstIterator niter;
2921 ProcessorList new_order;
2922 bool must_configure = false;
2924 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2926 XMLProperty* prop = (*niter)->property ("type");
2928 if (prop->value() == "amp") {
2929 _amp->set_state (**niter, Stateful::current_state_version);
2930 new_order.push_back (_amp);
2931 } else if (prop->value() == "trim") {
2932 _trim->set_state (**niter, Stateful::current_state_version);
2933 new_order.push_back (_trim);
2934 } else if (prop->value() == "meter") {
2935 _meter->set_state (**niter, Stateful::current_state_version);
2936 new_order.push_back (_meter);
2937 } else if (prop->value() == "delay") {
2939 } else if (prop->value() == "main-outs") {
2940 _main_outs->set_state (**niter, Stateful::current_state_version);
2941 } else if (prop->value() == "intreturn") {
2943 _intreturn.reset (new InternalReturn (_session));
2944 must_configure = true;
2946 _intreturn->set_state (**niter, Stateful::current_state_version);
2947 } else if (is_monitor() && prop->value() == "monitor") {
2948 if (!_monitor_control) {
2949 _monitor_control.reset (new MonitorProcessor (_session));
2950 must_configure = true;
2952 _monitor_control->set_state (**niter, Stateful::current_state_version);
2953 } else if (prop->value() == "capture") {
2954 /* CapturingProcessor should never be restored, it's always
2955 added explicitly when needed */
2956 } else if (prop->value() == "diskreader" && _disk_reader) {
2957 _disk_reader->set_state (**niter, Stateful::current_state_version);
2958 new_order.push_back (_disk_reader);
2959 } else if (prop->value() == "diskwriter" && _disk_writer) {
2960 _disk_writer->set_state (**niter, Stateful::current_state_version);
2961 new_order.push_back (_disk_writer);
2963 set_processor_state (**niter, prop, new_order, must_configure);
2967 ProcessorList old_list = _processors; // keep a copy
2969 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2970 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2971 /* re-assign _processors w/o process-lock.
2972 * if there's an IO-processor present in _processors but
2973 * not in new_order, it will be deleted and ~IO takes
2976 _processors = new_order;
2978 if (must_configure) {
2979 configure_processors_unlocked (0, &lm);
2982 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2984 (*i)->set_owner (this);
2985 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2987 boost::shared_ptr<PluginInsert> pi;
2989 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2990 if (pi->has_no_inputs ()) {
2991 _have_internal_generator = true;
2997 /* drop references w/o process-lock (I/O procs may re-take it in ~IO() */
3000 reset_instrument_info ();
3001 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3002 set_processor_positions ();
3006 Route::set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure)
3008 ProcessorList::iterator o;
3010 for (o = _processors.begin(); o != _processors.end(); ++o) {
3011 XMLProperty const * id_prop = node.property(X_("id"));
3012 if (id_prop && (*o)->id() == id_prop->value()) {
3013 (*o)->set_state (node, Stateful::current_state_version);
3014 new_order.push_back (*o);
3019 // If the processor (node) is not on the route then create it
3021 if (o == _processors.end()) {
3023 boost::shared_ptr<Processor> processor;
3025 if (prop->value() == "intsend") {
3027 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
3029 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
3030 prop->value() == "lv2" ||
3031 prop->value() == "windows-vst" ||
3032 prop->value() == "mac-vst" ||
3033 prop->value() == "lxvst" ||
3034 prop->value() == "luaproc" ||
3035 prop->value() == "audiounit") {
3037 if (_session.get_disable_all_loaded_plugins ()) {
3038 processor.reset (new UnknownProcessor (_session, node));
3040 processor.reset (new PluginInsert (_session));
3041 processor->set_owner (this);
3043 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
3044 pi->set_strict_io (true);
3048 } else if (prop->value() == "port") {
3050 processor.reset (new PortInsert (_session, _pannable, _mute_master));
3052 } else if (prop->value() == "send") {
3054 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
3055 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3056 send->SelfDestruct.connect_same_thread (*this,
3057 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
3063 if (processor->set_state (node, Stateful::current_state_version) != 0) {
3064 /* This processor could not be configured. Turn it into a UnknownProcessor */
3065 processor.reset (new UnknownProcessor (_session, node));
3068 /* subscribe to Sidechain IO changes */
3069 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3070 if (pi && pi->has_sidechain ()) {
3071 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
3074 /* we have to note the monitor send here, otherwise a new one will be created
3075 and the state of this one will be lost.
3077 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
3078 if (isend && isend->role() == Delivery::Listen) {
3079 _monitor_send = isend;
3082 /* it doesn't matter if invisible processors are added here, as they
3083 will be sorted out by setup_invisible_processors () shortly.
3086 new_order.push_back (processor);
3087 must_configure = true;
3093 Route::curve_reallocate ()
3095 // _gain_automation_curve.finish_resize ();
3096 // _pan_automation_curve.finish_resize ();
3100 Route::silence (samplecnt_t nframes)
3102 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3107 silence_unlocked (nframes);
3111 Route::silence_unlocked (samplecnt_t nframes)
3113 /* Must be called with the processor lock held */
3115 const samplepos_t now = _session.transport_sample ();
3119 _output->silence (nframes);
3121 // update owned automated controllables
3122 automation_run (now, nframes);
3124 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3125 boost::shared_ptr<PluginInsert> pi;
3127 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
3128 /* evaluate automated automation controls */
3129 pi->automation_run (now, nframes);
3130 /* skip plugins, they don't need anything when we're not active */
3134 (*i)->silence (nframes, now);
3137 if (nframes == _session.get_block_size()) {
3144 Route::add_internal_return ()
3147 _intreturn.reset (new InternalReturn (_session));
3148 add_processor (_intreturn, PreFader);
3153 Route::add_send_to_internal_return (InternalSend* send)
3155 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3157 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3158 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3161 return d->add_send (send);
3167 Route::remove_send_from_internal_return (InternalSend* send)
3169 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3171 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3172 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3175 return d->remove_send (send);
3181 Route::enable_monitor_send ()
3183 /* Caller must hold process lock */
3184 assert (!AudioEngine::instance()->process_lock().trylock());
3186 /* master never sends to monitor section via the normal mechanism */
3187 assert (!is_master ());
3188 assert (!is_monitor ());
3190 /* make sure we have one */
3191 if (!_monitor_send) {
3192 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
3193 _monitor_send->set_display_to_user (false);
3197 configure_processors (0);
3200 /** Add an aux send to a route.
3201 * @param route route to send to.
3202 * @param before Processor to insert before, or 0 to insert at the end.
3205 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
3207 assert (route != _session.monitor_out ());
3210 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3212 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3214 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
3216 if (d && d->target_route() == route) {
3217 /* already listening via the specified IO: do nothing */
3225 boost::shared_ptr<InternalSend> listener;
3228 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3229 listener.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3232 add_processor (listener, before);
3234 } catch (failed_constructor& err) {
3242 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3244 ProcessorStreams err;
3245 ProcessorList::iterator tmp;
3248 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3250 /* have to do this early because otherwise processor reconfig
3251 * will put _monitor_send back in the list
3254 if (route == _session.monitor_out()) {
3255 _monitor_send.reset ();
3259 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3261 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3263 if (d && d->target_route() == route) {
3265 if (remove_processor (*x, &err, false) > 0) {
3271 /* list could have been demolished while we dropped the lock
3274 if (_session.engine().connected()) {
3275 /* i/o processors cannot be removed if the engine is not running
3276 * so don't live-loop in case the engine is N/A or dies
3286 Route::set_comment (string cmt, void *src)
3290 _session.set_dirty ();
3294 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3296 FeedRecord fr (other, via_sends_only);
3298 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3300 if (!result.second) {
3302 /* already a record for "other" - make sure sends-only information is correct */
3303 if (!via_sends_only && result.first->sends_only) {
3304 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3305 frp->sends_only = false;
3309 return result.second;
3313 Route::clear_fed_by ()
3319 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3321 const FedBy& fed_by (other->fed_by());
3323 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3324 boost::shared_ptr<Route> sr = f->r.lock();
3326 if (sr && (sr.get() == this)) {
3328 if (via_sends_only) {
3329 *via_sends_only = f->sends_only;
3340 Route::all_inputs () const
3342 /* TODO, if this works as expected,
3343 * cache the IOVector and maintain it via
3344 * input_change_handler(), sidechain_change_handler() etc
3347 ios.push_back (_input);
3349 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3350 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3352 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3353 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3356 iop = pi->sidechain();
3359 if (iop != 0 && iop->input()) {
3360 ios.push_back (iop->input());
3367 Route::all_outputs () const
3370 // _output is included via Delivery
3371 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3372 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3373 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3374 if (iop != 0 && iop->output()) {
3375 ios.push_back (iop->output());
3382 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3384 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3385 if (other->all_inputs().fed_by (_output)) {
3386 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3387 if (via_send_only) {
3388 *via_send_only = false;
3394 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3396 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3398 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3399 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3402 iop = pi->sidechain();
3406 boost::shared_ptr<const IO> iop_out = iop->output();
3407 if (other.get() == this && iop_out && iop->input() && iop_out->connected_to (iop->input())) {
3408 // TODO this needs a delaylines in the Insert to align connections (!)
3409 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed its own return (%2)\n", iop->name(), other->name()));
3412 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3413 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3414 if (via_send_only) {
3415 *via_send_only = true;
3419 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3422 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3427 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3432 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3434 return _session._current_route_graph.has (boost::dynamic_pointer_cast<Route> (shared_from_this ()), other, via_send_only);
3438 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3440 return _session._current_route_graph.feeds (boost::dynamic_pointer_cast<Route> (shared_from_this ()), other);
3443 /** Called from the (non-realtime) butler thread when the transport is stopped */
3445 Route::non_realtime_transport_stop (samplepos_t now, bool flush)
3447 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3449 Automatable::non_realtime_transport_stop (now, flush);
3451 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3453 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && flush)) {
3457 (*i)->non_realtime_transport_stop (now, flush);
3462 Route::input_change_handler (IOChange change, void * /*src*/)
3464 if ((change.type & IOChange::ConfigurationChanged)) {
3465 /* This is called with the process lock held if change
3466 contains ConfigurationChanged
3468 configure_processors (0);
3469 _phase_control->resize (_input->n_ports().n_audio ());
3470 io_changed (); /* EMIT SIGNAL */
3473 if (_solo_control->soloed_by_others_upstream() || _solo_isolate_control->solo_isolated_by_upstream()) {
3476 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3477 if (_input->connected()) {
3478 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3479 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3483 bool does_feed = (*i)->direct_feeds_according_to_reality (boost::dynamic_pointer_cast<Route> (shared_from_this()), &sends_only);
3484 if (does_feed && !sends_only) {
3485 if ((*i)->soloed()) {
3488 if ((*i)->solo_isolate_control()->solo_isolated()) {
3495 int delta = sbou - _solo_control->soloed_by_others_upstream();
3496 int idelta = ibou - _solo_isolate_control->solo_isolated_by_upstream();
3499 PBD::warning << string_compose (
3500 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3501 _name, ibou, _solo_isolate_control->solo_isolated_by_upstream(), idelta)
3506 if (_solo_control->soloed_by_others_upstream()) {
3507 // ignore new connections (they're not propagated)
3509 _solo_control->mod_solo_by_others_upstream (delta);
3513 if (_solo_isolate_control->solo_isolated_by_upstream()) {
3514 // solo-isolate currently only propagates downstream
3516 _solo_isolate_control->mod_solo_isolated_by_upstream (1);
3518 //_solo_isolated_by_upstream = ibou;
3521 // Session::route_solo_changed does not propagate indirect solo-changes
3522 // propagate downstream to tracks
3523 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3524 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3528 bool does_feed = feeds (*i, &sends_only);
3529 if (delta <= 0 && does_feed && !sends_only) {
3530 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3533 if (idelta < 0 && does_feed && !sends_only) {
3534 (*i)->solo_isolate_control()->mod_solo_isolated_by_upstream (-1);
3541 Route::output_change_handler (IOChange change, void * /*src*/)
3543 if (_initial_io_setup) {
3547 if ((change.type & IOChange::ConfigurationChanged)) {
3548 /* This is called with the process lock held if change
3549 contains ConfigurationChanged
3551 configure_processors (0);
3554 _session.reset_monitor_section();
3557 io_changed (); /* EMIT SIGNAL */
3560 if ((change.type & IOChange::ConnectionsChanged)) {
3562 /* do this ONLY if connections have changed. Configuration
3563 * changes do not, by themselves alter solo upstream or
3564 * downstream status.
3567 if (_solo_control->soloed_by_others_downstream()) {
3569 /* checking all all downstream routes for
3570 * explicit of implict solo is a rather drastic measure,
3571 * ideally the input_change_handler() of the other route
3572 * would propagate the change to us.
3574 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3575 if (_output->connected()) {
3576 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3577 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3581 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3582 if (does_feed && !sends_only) {
3583 if ((*i)->soloed()) {
3591 int delta = sbod - _solo_control->soloed_by_others_downstream();
3593 // do not allow new connections to change implicit solo (no propagation)
3594 _solo_control->mod_solo_by_others_downstream (delta);
3595 // Session::route_solo_changed() does not propagate indirect solo-changes
3596 // propagate upstream to tracks
3597 boost::shared_ptr<Route> shared_this = boost::dynamic_pointer_cast<Route> (shared_from_this());
3598 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3599 if ((*i).get() == this || !can_solo()) {
3603 bool does_feed = (*i)->feeds (shared_this, &sends_only);
3604 if (delta != 0 && does_feed && !sends_only) {
3605 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3615 Route::sidechain_change_handler (IOChange change, void* src)
3617 if (_initial_io_setup || _in_sidechain_setup) {
3621 input_change_handler (change, src);
3625 Route::pans_required () const
3627 if (n_outputs().n_audio() < 2) {
3631 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3635 Route::flush_processor_buffers_locked (samplecnt_t nframes)
3637 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3638 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
3640 d->flush_buffers (nframes);
3642 boost::shared_ptr<PortInsert> p = boost::dynamic_pointer_cast<PortInsert> (*i);
3644 p->flush_buffers (nframes);
3651 Route::no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool session_state_changing)
3653 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3660 silence_unlocked (nframes);
3664 if (session_state_changing) {
3665 if (_session.transport_speed() != 0.0f) {
3666 /* we're rolling but some state is changing (e.g. our diskstream contents)
3667 so we cannot use them. Be silent till this is over.
3669 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3671 silence_unlocked (nframes);
3674 /* we're really not rolling, so we're either delivery silence or actually
3675 monitoring, both of which are safe to do while session_state_changing is true.
3679 no_roll_unlocked (nframes, start_sample, end_sample);
3685 Route::no_roll_unlocked (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample)
3687 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3689 fill_buffers_with_input (bufs, _input, nframes);
3691 /* filter captured data before meter sees it */
3692 filter_input (bufs);
3694 if (_meter_point == MeterInput) {
3695 _meter->run (bufs, start_sample, end_sample, 0.0, nframes, true);
3698 passthru (bufs, start_sample, end_sample, nframes, 0, true, false);
3700 flush_processor_buffers_locked (nframes);
3704 Route::playback_latency (bool incl_downstream) const
3708 rv = _disk_reader->output_latency ();
3710 rv = _signal_latency;
3712 if (incl_downstream) {
3713 rv += _output->connected_latency (true);
3715 rv += _output->latency ();
3721 Route::latency_preroll (pframes_t nframes, samplepos_t& start_sample, samplepos_t& end_sample)
3723 samplecnt_t latency_preroll = _session.remaining_latency_preroll ();
3724 if (latency_preroll == 0) {
3727 if (!_disk_reader) {
3728 start_sample -= latency_preroll;
3729 end_sample -= latency_preroll;
3733 if (latency_preroll > playback_latency ()) {
3734 no_roll_unlocked (nframes, start_sample - latency_preroll, end_sample - latency_preroll);
3738 start_sample -= latency_preroll;
3739 end_sample -= latency_preroll;
3744 Route::roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, int declick, bool& need_butler)
3746 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3753 silence_unlocked (nframes);
3754 if (_meter_point == MeterInput && ((_monitoring_control->monitoring_choice() & MonitorInput) || (!_disk_writer || _disk_writer->record_enabled()))) {
3759 if ((nframes = latency_preroll (nframes, start_sample, end_sample)) == 0) {
3765 BufferSet& bufs = _session.get_route_buffers (n_process_buffers ());
3767 fill_buffers_with_input (bufs, _input, nframes);
3769 /* filter captured data before meter sees it */
3770 filter_input (bufs);
3772 if (_meter_point == MeterInput &&
3773 ((_monitoring_control->monitoring_choice() & MonitorInput) || (_disk_writer && _disk_writer->record_enabled()))) {
3774 _meter->run (bufs, start_sample, end_sample, 1.0 /*speed()*/, nframes, true);
3777 passthru (bufs, start_sample, end_sample, nframes, declick, (!_disk_writer || !_disk_writer->record_enabled()) && _session.transport_rolling(), true);
3779 if ((_disk_reader && _disk_reader->need_butler()) || (_disk_writer && _disk_writer->need_butler())) {
3783 flush_processor_buffers_locked (nframes);
3789 Route::silent_roll (pframes_t nframes, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, bool& /* need_butler */)
3792 flush_processor_buffers_locked (nframes);
3797 Route::flush_processors ()
3799 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3801 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3807 __attribute__((annotate("realtime")))
3810 Route::apply_processor_changes_rt ()
3812 int emissions = EmitNone;
3814 if (_pending_meter_point != _meter_point) {
3815 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3817 /* meters always have buffers for 'processor_max_streams'
3818 * they can be re-positioned without re-allocation */
3819 if (set_meter_point_unlocked()) {
3820 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3822 emissions |= EmitMeterChanged;
3827 bool changed = false;
3829 if (g_atomic_int_get (&_pending_process_reorder)) {
3830 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3832 apply_processor_order (_pending_processor_order);
3833 setup_invisible_processors ();
3835 g_atomic_int_set (&_pending_process_reorder, 0);
3836 emissions |= EmitRtProcessorChange;
3840 set_processor_positions ();
3841 /* update processor input/output latency
3842 * (total signal_latency does not change)
3844 update_signal_latency (true);
3846 if (emissions != 0) {
3847 g_atomic_int_set (&_pending_signals, emissions);
3850 return (!selfdestruct_sequence.empty ());
3854 Route::emit_pending_signals ()
3856 int sig = g_atomic_int_and (&_pending_signals, 0);
3857 if (sig & EmitMeterChanged) {
3858 _meter->emit_configuration_changed();
3859 meter_change (); /* EMIT SIGNAL */
3860 if (sig & EmitMeterVisibilityChange) {
3861 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3863 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3866 if (sig & EmitRtProcessorChange) {
3867 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3870 /* this would be a job for the butler.
3871 * Conceptually we should not take processe/processor locks here.
3872 * OTOH its more efficient (less overhead for summoning the butler and
3873 * telling her what do do) and signal emission is called
3874 * directly after the process callback, which decreases the chance
3875 * of x-runs when taking the locks.
3877 while (!selfdestruct_sequence.empty ()) {
3878 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
3879 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
3880 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
3881 selfdestruct_sequence.pop_back ();
3884 remove_processor (proc);
3890 Route::set_meter_point (MeterPoint p, bool force)
3892 if (_pending_meter_point == p && !force) {
3896 if (force || !AudioEngine::instance()->running()) {
3897 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3898 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3899 _pending_meter_point = p;
3900 _meter->emit_configuration_changed();
3901 meter_change (); /* EMIT SIGNAL */
3902 if (set_meter_point_unlocked()) {
3903 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3905 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3908 _pending_meter_point = p;
3914 __attribute__((annotate("realtime")))
3917 Route::set_meter_point_unlocked ()
3920 /* Caller must hold process and processor write lock */
3921 assert (!AudioEngine::instance()->process_lock().trylock());
3922 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3923 assert (!lm.locked ());
3926 _meter_point = _pending_meter_point;
3928 bool meter_was_visible_to_user = _meter->display_to_user ();
3930 if (!_custom_meter_position_noted) {
3931 maybe_note_meter_position ();
3934 if (_meter_point != MeterCustom) {
3936 _meter->set_display_to_user (false);
3938 setup_invisible_processors ();
3941 _meter->set_display_to_user (true);
3943 /* If we have a previous position for the custom meter, try to put it there */
3944 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3946 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3947 if (i != _processors.end ()) {
3948 _processors.remove (_meter);
3949 _processors.insert (i, _meter);
3951 } else {// at end, right before the mains_out/panner
3952 _processors.remove (_meter);
3953 ProcessorList::iterator main = _processors.end();
3954 _processors.insert (--main, _meter);
3958 /* Set up the meter for its new position */
3960 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3964 if (loc == _processors.begin()) {
3965 m_in = _input->n_ports();
3967 ProcessorList::iterator before = loc;
3969 m_in = (*before)->output_streams ();
3972 _meter->reflect_inputs (m_in);
3974 /* we do not need to reconfigure the processors, because the meter
3975 (a) is always ready to handle processor_max_streams
3976 (b) is always an N-in/N-out processor, and thus moving
3977 it doesn't require any changes to the other processors.
3980 /* these should really be done after releasing the lock
3981 * but all those signals are subscribed to with gui_thread()
3984 return (_meter->display_to_user() != meter_was_visible_to_user);
3988 Route::listen_position_changed ()
3991 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3992 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3993 ProcessorState pstate (this);
3995 if (configure_processors_unlocked (0, &lm)) {
3996 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3998 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
4003 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
4004 _session.set_dirty ();
4007 boost::shared_ptr<CapturingProcessor>
4008 Route::add_export_point()
4010 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4011 if (!_capturing_processor) {
4013 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4014 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
4016 /* Align all tracks for stem-export w/o processing.
4017 * Compensate for all plugins between the this route's disk-reader
4018 * and the common final downstream output (ie alignment point for playback).
4020 _capturing_processor.reset (new CapturingProcessor (_session, playback_latency (true)));
4021 configure_processors_unlocked (0, &lw);
4022 _capturing_processor->activate ();
4025 return _capturing_processor;
4029 Route::update_signal_latency (bool apply_to_delayline)
4031 // TODO: bail out if !active() and set/assume _signal_latency = 0,
4032 // here or in Session::* ? -> also zero send latencies,
4033 // and make sure that re-enabling a route updates things again...
4035 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4037 samplecnt_t l_in = 0;
4038 samplecnt_t l_out = _output->user_latency();
4039 for (ProcessorList::reverse_iterator i = _processors.rbegin(); i != _processors.rend(); ++i) {
4040 if (boost::shared_ptr<Send> snd = boost::dynamic_pointer_cast<Send> (*i)) {
4041 snd->set_delay_in (l_out + _output->latency());
4043 (*i)->set_output_latency (l_out);
4044 if ((*i)->active ()) {
4045 l_out += (*i)->signal_latency ();
4049 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l_out));
4051 _signal_latency = l_out;
4053 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4054 (*i)->set_input_latency (l_in);
4055 (*i)->set_playback_offset (_signal_latency + _output->latency ());
4056 (*i)->set_capture_offset (_input->latency ());
4057 if ((*i)->active ()) {
4058 l_in += (*i)->signal_latency ();
4064 if (apply_to_delayline) {
4065 /* see also Session::post_playback_latency() */
4066 apply_latency_compensation ();
4069 if (_signal_latency != l_out) {
4070 signal_latency_changed (); /* EMIT SIGNAL */
4073 return _signal_latency;
4077 Route::set_user_latency (samplecnt_t nframes)
4079 _output->set_user_latency (nframes);
4080 _session.update_latency_compensation ();
4084 Route::apply_latency_compensation ()
4087 samplecnt_t old = _delayline->get_delay ();
4089 samplecnt_t play_lat_in = _input->connected_latency (true);
4090 samplecnt_t play_lat_out = _output->connected_latency (true);
4091 samplecnt_t latcomp = play_lat_in - play_lat_out - _signal_latency;
4094 samplecnt_t capt_lat_in = _input->connected_latency (false);
4095 samplecnt_t capt_lat_out = _output->connected_latency (false);
4096 samplecnt_t latcomp_capt = capt_lat_out - capt_lat_in - _signal_latency;
4098 cout << "ROUTE " << name() << " delay for " << latcomp << " (c: " << latcomp_capt << ")" << endl;
4101 _delayline->set_delay (latcomp > 0 ? latcomp : 0);
4103 if (old != _delayline->get_delay ()) {
4104 signal_latency_updated (); /* EMIT SIGNAL */
4110 Route::set_block_size (pframes_t nframes)
4112 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4113 (*i)->set_block_size (nframes);
4116 _session.ensure_buffers (n_process_buffers ());
4120 Route::protect_automation ()
4122 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
4123 (*i)->protect_automation();
4126 /** @param declick 1 to set a pending declick fade-in,
4127 * -1 to set a pending declick fade-out
4130 Route::set_pending_declick (int declick)
4133 /* this call is not allowed to turn off a pending declick */
4135 _pending_declick = declick;
4138 _pending_declick = 0;
4142 /** Shift automation forwards from a particular place, thereby inserting time.
4143 * Adds undo commands for any shifts that are performed.
4145 * @param pos Position to start shifting from.
4146 * @param samples Amount to shift forwards by.
4150 Route::shift (samplepos_t pos, samplecnt_t samples)
4152 /* gain automation */
4154 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
4156 XMLNode &before = gc->alist()->get_state ();
4157 gc->alist()->shift (pos, samples);
4158 XMLNode &after = gc->alist()->get_state ();
4159 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4162 /* gain automation */
4164 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
4166 XMLNode &before = gc->alist()->get_state ();
4167 gc->alist()->shift (pos, samples);
4168 XMLNode &after = gc->alist()->get_state ();
4169 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4172 // TODO mute automation ??
4174 /* pan automation */
4176 ControlSet::Controls& c (_pannable->controls());
4178 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
4179 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
4181 boost::shared_ptr<AutomationList> al = pc->alist();
4182 XMLNode& before = al->get_state ();
4183 al->shift (pos, samples);
4184 XMLNode& after = al->get_state ();
4185 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4190 /* redirect automation */
4192 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4193 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
4195 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
4197 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
4198 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
4200 boost::shared_ptr<AutomationList> al = ac->alist();
4201 XMLNode &before = al->get_state ();
4202 al->shift (pos, samples);
4203 XMLNode &after = al->get_state ();
4204 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4212 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
4214 boost::shared_ptr<Processor> processor (p.lock ());
4215 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
4219 pi->set_state_dir (d);
4223 Route::save_as_template (const string& path, const string& name, const string& description)
4225 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
4226 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
4228 XMLNode& node (state (false));
4229 node.set_property (X_("name"), name);
4231 node.remove_nodes (X_("description"));
4232 if (!description.empty()) {
4233 XMLNode* desc = new XMLNode(X_("description"));
4234 XMLNode* desc_cont = new XMLNode(X_("content"), description);
4235 desc->add_child_nocopy (*desc_cont);
4237 node.add_child_nocopy (*desc);
4242 IO::set_name_in_state (*node.children().front(), name);
4244 tree.set_root (&node);
4246 /* return zero on success, non-zero otherwise */
4247 return !tree.write (path.c_str());
4252 Route::set_name (const string& str)
4258 if (str == name()) {
4262 string name = Route::ensure_track_or_route_name (str, _session);
4263 SessionObject::set_name (name);
4265 bool ret = (_input->set_name(name) && _output->set_name(name));
4268 /* rename the main outs. Leave other IO processors
4269 * with whatever name they already have, because its
4270 * just fine as it is (it will not contain the route
4271 * name if its a port insert, port send or port return).
4275 if (_main_outs->set_name (name)) {
4276 /* XXX returning false here is stupid because
4277 we already changed the route name.
4287 /** Set the name of a route in an XML description.
4288 * @param node XML <Route> node to set the name in.
4289 * @param name New name.
4292 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
4294 node.set_property (X_("name"), name);
4296 XMLNodeList children = node.children();
4297 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
4299 if ((*i)->name() == X_("IO")) {
4301 IO::set_name_in_state (**i, name);
4303 } else if ((*i)->name() == X_("Processor")) {
4306 if ((*i)->get_property (X_("role"), str) && str == X_("Main")) {
4307 (*i)->set_property (X_("name"), name);
4310 } else if ((*i)->name() == X_("Diskstream")) {
4312 if (rename_playlist) {
4313 (*i)->set_property (X_("playlist"), name + ".1");
4315 (*i)->set_property (X_("name"), name);
4321 boost::shared_ptr<Send>
4322 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4324 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4326 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4327 boost::shared_ptr<InternalSend> send;
4329 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4330 if (send->target_route() == target) {
4336 return boost::shared_ptr<Send>();
4340 Route::set_denormal_protection (bool yn)
4342 if (_denormal_protection != yn) {
4343 _denormal_protection = yn;
4344 denormal_protection_changed (); /* EMIT SIGNAL */
4349 Route::denormal_protection () const
4351 return _denormal_protection;
4355 Route::set_active (bool yn, void* src)
4357 if (_session.transport_rolling()) {
4361 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4362 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4366 if (_active != yn) {
4368 _input->set_active (yn);
4369 _output->set_active (yn);
4370 flush_processors ();
4371 active_changed (); // EMIT SIGNAL
4372 _session.set_dirty ();
4376 boost::shared_ptr<Pannable>
4377 Route::pannable() const
4382 boost::shared_ptr<Panner>
4383 Route::panner() const
4386 return _main_outs->panner_shell()->panner();
4389 boost::shared_ptr<PannerShell>
4390 Route::panner_shell() const
4392 return _main_outs->panner_shell();
4395 boost::shared_ptr<GainControl>
4396 Route::gain_control() const
4398 return _gain_control;
4401 boost::shared_ptr<GainControl>
4402 Route::trim_control() const
4404 return _trim_control;
4407 boost::shared_ptr<PhaseControl>
4408 Route::phase_control() const
4410 return _phase_control;
4413 boost::shared_ptr<AutomationControl>
4414 Route::get_control (const Evoral::Parameter& param)
4416 /* either we own the control or .... */
4418 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4422 /* maybe one of our processors does or ... */
4424 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4425 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4426 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4434 /* nobody does so we'll make a new one */
4436 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4443 boost::shared_ptr<Processor>
4444 Route::nth_plugin (uint32_t n) const
4446 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4447 ProcessorList::const_iterator i;
4449 for (i = _processors.begin(); i != _processors.end(); ++i) {
4450 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4457 return boost::shared_ptr<Processor> ();
4460 boost::shared_ptr<Processor>
4461 Route::nth_send (uint32_t n) const
4463 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4464 ProcessorList::const_iterator i;
4466 for (i = _processors.begin(); i != _processors.end(); ++i) {
4467 if (boost::dynamic_pointer_cast<Send> (*i)) {
4469 if ((*i)->name().find (_("Monitor")) == 0) {
4470 /* send to monitor section is not considered
4471 to be an accessible send.
4482 return boost::shared_ptr<Processor> ();
4486 Route::has_io_processor_named (const string& name)
4488 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4489 ProcessorList::iterator i;
4491 for (i = _processors.begin(); i != _processors.end(); ++i) {
4492 if (boost::dynamic_pointer_cast<Send> (*i) ||
4493 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4494 if ((*i)->name() == name) {
4504 Route::set_processor_positions ()
4506 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4508 bool had_amp = false;
4509 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4510 (*i)->set_pre_fader (!had_amp);
4517 /** Called when there is a proposed change to the input port count */
4519 Route::input_port_count_changing (ChanCount to)
4521 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4523 /* The processors cannot be configured with the new input arrangement, so
4529 /* The change is ok */
4533 /** Called when there is a proposed change to the output port count */
4535 Route::output_port_count_changing (ChanCount to)
4537 if (_strict_io && !_in_configure_processors) {
4540 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4541 if (processor_out_streams.get(*t) > to.get(*t)) {
4545 /* The change is ok */
4550 Route::unknown_processors () const
4554 if (_session.get_disable_all_loaded_plugins ()) {
4555 // Do not list "missing plugins" if they are explicitly disabled
4559 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4560 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4561 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4562 p.push_back ((*i)->name ());
4571 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, samplecnt_t our_latency) const
4573 /* we assume that all our input ports feed all our output ports. its not
4574 universally true, but the alternative is way too corner-case to worry about.
4577 LatencyRange all_connections;
4580 all_connections.min = 0;
4581 all_connections.max = 0;
4583 all_connections.min = ~((pframes_t) 0);
4584 all_connections.max = 0;
4586 /* iterate over all "from" ports and determine the latency range for all of their
4587 connections to the "outside" (outside of this Route).
4590 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4594 p->get_connected_latency_range (range, playback);
4596 all_connections.min = min (all_connections.min, range.min);
4597 all_connections.max = max (all_connections.max, range.max);
4601 /* set the "from" port latencies to the max/min range of all their connections */
4603 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4604 p->set_private_latency_range (all_connections, playback);
4607 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4609 all_connections.min += our_latency;
4610 all_connections.max += our_latency;
4612 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4613 p->set_private_latency_range (all_connections, playback);
4616 return all_connections.max;
4620 Route::set_private_port_latencies (bool playback) const
4622 samplecnt_t own_latency = 0;
4624 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4625 OR LATENCY CALLBACK.
4627 This is called (early) from the latency callback. It computes the REAL
4628 latency associated with each port and stores the result as the "private"
4629 latency of the port. A later call to Route::set_public_port_latencies()
4630 sets all ports to the same value to reflect the fact that we do latency
4631 compensation and so all signals are delayed by the same amount as they
4632 flow through ardour.
4635 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4636 if ((*i)->active ()) {
4637 own_latency += (*i)->signal_latency ();
4642 /* playback: propagate latency from "outside the route" to outputs to inputs */
4643 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4645 /* capture: propagate latency from "outside the route" to inputs to outputs */
4646 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4651 Route::set_public_port_latencies (samplecnt_t value, bool playback) const
4653 /* this is called to set the JACK-visible port latencies, which take
4654 latency compensation into account.
4663 const PortSet& ports (_input->ports());
4664 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4665 p->set_public_latency_range (range, playback);
4670 const PortSet& ports (_output->ports());
4671 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4672 p->set_public_latency_range (range, playback);
4677 /** Put the invisible processors in the right place in _processors.
4678 * Must be called with a writer lock on _processor_lock held.
4681 __attribute__((annotate("realtime")))
4684 Route::setup_invisible_processors ()
4687 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4688 assert (!lm.locked ());
4692 /* too early to be doing this stuff */
4696 /* we'll build this new list here and then use it
4698 * TODO put the ProcessorList is on the stack for RT-safety.
4701 ProcessorList new_processors;
4702 ProcessorList::iterator dr;
4703 ProcessorList::iterator dw;
4705 /* find visible processors */
4707 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4708 if ((*i)->display_to_user ()) {
4709 new_processors.push_back (*i);
4715 ProcessorList::iterator amp = find (new_processors.begin(), new_processors.end(), _amp);
4717 if (amp == new_processors.end ()) {
4718 error << string_compose (_("Amp/Fader on Route '%1' went AWOL. Re-added."), name()) << endmsg;
4719 new_processors.push_front (_amp);
4720 amp = find (new_processors.begin(), new_processors.end(), _amp);
4723 /* and the processor after the amp */
4725 ProcessorList::iterator after_amp = amp;
4731 switch (_meter_point) {
4733 assert (!_meter->display_to_user ());
4734 new_processors.push_front (_meter);
4737 assert (!_meter->display_to_user ());
4738 new_processors.insert (amp, _meter);
4740 case MeterPostFader:
4741 /* do nothing here */
4744 /* do nothing here */
4747 /* the meter is visible, so we don't touch it here */
4754 assert (_main_outs);
4755 assert (!_main_outs->display_to_user ());
4756 new_processors.push_back (_main_outs);
4758 /* iterator for the main outs */
4760 ProcessorList::iterator main = new_processors.end();
4763 /* OUTPUT METERING */
4765 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4766 assert (!_meter->display_to_user ());
4768 /* add the processor just before or just after the main outs */
4770 ProcessorList::iterator meter_point = main;
4772 if (_meter_point == MeterOutput) {
4775 new_processors.insert (meter_point, _meter);
4780 if (_monitor_send && !is_monitor ()) {
4781 assert (!_monitor_send->display_to_user ());
4782 switch (Config->get_listen_position ()) {
4783 case PreFaderListen:
4784 switch (Config->get_pfl_position ()) {
4785 case PFLFromBeforeProcessors:
4786 new_processors.push_front (_monitor_send);
4788 case PFLFromAfterProcessors:
4789 new_processors.insert (amp, _monitor_send);
4792 _monitor_send->set_can_pan (false);
4794 case AfterFaderListen:
4795 switch (Config->get_afl_position ()) {
4796 case AFLFromBeforeProcessors:
4797 new_processors.insert (after_amp, _monitor_send);
4799 case AFLFromAfterProcessors:
4800 new_processors.insert (new_processors.end(), _monitor_send);
4803 _monitor_send->set_can_pan (true);
4808 /* MONITOR CONTROL */
4810 if (_monitor_control && is_monitor ()) {
4811 assert (!_monitor_control->display_to_user ());
4812 new_processors.insert (amp, _monitor_control);
4817 ProcessorList::iterator trim = new_processors.end();
4819 if (_trim->active()) {
4820 assert (!_trim->display_to_user ());
4821 new_processors.push_front (_trim);
4822 trim = new_processors.begin();
4825 /* INTERNAL RETURN */
4827 /* doing this here means that any monitor control will come after
4828 the return and trim.
4832 assert (!_intreturn->display_to_user ());
4833 new_processors.push_front (_intreturn);
4836 /* DISK READER & WRITER (for Track objects) */
4838 if (_disk_reader || _disk_writer) {
4839 switch (_disk_io_point) {
4840 case DiskIOPreFader:
4841 if (trim != new_processors.end()) {
4842 /* insert BEFORE TRIM */
4844 new_processors.insert (trim, _disk_writer);
4847 new_processors.insert (trim, _disk_reader);
4851 new_processors.push_front (_disk_writer);
4854 new_processors.push_front (_disk_reader);
4858 case DiskIOPostFader:
4859 /* insert BEFORE main outs */
4861 new_processors.insert (main, _disk_writer);
4864 new_processors.insert (main, _disk_reader);
4868 /* reader and writer are visible under this condition, so they
4869 * are not invisible and thus not handled here.
4875 /* ensure dist-writer is before disk-reader */
4876 if (_disk_reader && _disk_writer) {
4877 ProcessorList::iterator reader_pos = find (new_processors.begin(), new_processors.end(), _disk_reader);
4878 ProcessorList::iterator writer_pos = find (new_processors.begin(), new_processors.end(), _disk_writer);
4879 assert (reader_pos != new_processors.end ());
4880 assert (writer_pos != new_processors.end ());
4881 if (std::distance (new_processors.begin(), reader_pos) < std::distance (new_processors.begin(), writer_pos)) {
4882 new_processors.erase (reader_pos);
4883 assert (writer_pos == find (new_processors.begin(), new_processors.end(), _disk_writer));
4884 new_processors.insert (++writer_pos, _disk_reader);
4889 /* EXPORT PROCESSOR */
4890 if (_capturing_processor) {
4891 assert (!_capturing_processor->display_to_user ());
4892 ProcessorList::iterator reader_pos = find (new_processors.begin(), new_processors.end(), _disk_reader);
4893 if (reader_pos != new_processors.end()) {
4894 /* insert after disk-reader */
4895 new_processors.insert (++reader_pos, _capturing_processor);
4897 new_processors.push_front (_capturing_processor);
4901 if (!is_master() && !is_monitor() && !is_auditioner()) {
4902 ProcessorList::iterator reader_pos = find (new_processors.begin(), new_processors.end(), _disk_reader);
4903 if (reader_pos != new_processors.end()) {
4904 /* insert before disk-reader */
4905 new_processors.insert (reader_pos, _delayline);
4907 new_processors.push_front (_delayline);
4911 _processors = new_processors;
4913 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4914 if (!(*i)->display_to_user () && !(*i)->enabled () && (*i) != _monitor_send) {
4915 (*i)->enable (true);
4919 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4920 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4921 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4928 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4929 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4933 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4934 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4941 /** If the meter point is `Custom', make a note of where the meter is.
4942 * This is so that if the meter point is subsequently set to something else,
4943 * and then back to custom, we can put the meter back where it was last time
4944 * custom was enabled.
4946 * Must be called with the _processor_lock held.
4949 Route::maybe_note_meter_position ()
4951 if (_meter_point != MeterCustom) {
4955 _custom_meter_position_noted = true;
4956 /* custom meter points range from after trim to before panner/main_outs
4957 * this is a limitation by the current processor UI
4959 bool seen_trim = false;
4960 _processor_after_last_custom_meter.reset();
4961 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4962 if ((*i) == _trim) {
4965 if ((*i) == _main_outs) {
4966 _processor_after_last_custom_meter = *i;
4969 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4971 _processor_after_last_custom_meter = _trim;
4973 ProcessorList::iterator j = i;
4975 assert(j != _processors.end ()); // main_outs should be before
4976 _processor_after_last_custom_meter = *j;
4981 assert(_processor_after_last_custom_meter.lock());
4984 boost::shared_ptr<Processor>
4985 Route::processor_by_id (PBD::ID id) const
4987 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4988 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4989 if ((*i)->id() == id) {
4994 return boost::shared_ptr<Processor> ();
4997 /** @return what we should be metering; either the data coming from the input
4998 * IO or the data that is flowing through the route.
5001 Route::metering_state () const
5003 return MeteringRoute;
5007 Route::has_external_redirects () const
5009 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5011 /* ignore inactive processors and obviously ignore the main
5012 * outs since everything has them and we don't care.
5015 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
5023 boost::shared_ptr<Processor>
5024 Route::the_instrument () const
5026 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5027 return the_instrument_unlocked ();
5030 boost::shared_ptr<Processor>
5031 Route::the_instrument_unlocked () const
5033 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5034 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
5035 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
5039 return boost::shared_ptr<Processor>();
5045 Route::non_realtime_locate (samplepos_t pos)
5047 Automatable::non_realtime_locate (pos);
5050 _pannable->non_realtime_locate (pos);
5053 #if 0 // XXX mayhaps clear delayline here (and at stop?)
5055 _delayline->flush ();
5060 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
5061 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5063 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5064 (*i)->non_realtime_locate (pos);
5070 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
5077 * We don't currently mix MIDI input together, so we don't need the
5078 * complex logic of the audio case.
5081 n_buffers = bufs.count().n_midi ();
5083 for (i = 0; i < n_buffers; ++i) {
5085 boost::shared_ptr<MidiPort> source_port = io->midi (i);
5086 MidiBuffer& buf (bufs.get_midi (i));
5089 buf.copy (source_port->get_midi_buffer(nframes));
5091 buf.silence (nframes);
5097 n_buffers = bufs.count().n_audio();
5099 size_t n_ports = io->n_ports().n_audio();
5100 float scaling = 1.0f;
5102 if (n_ports > n_buffers) {
5103 scaling = ((float) n_buffers) / n_ports;
5106 for (i = 0; i < n_ports; ++i) {
5108 /* if there are more ports than buffers, map them onto buffers
5109 * in a round-robin fashion
5112 boost::shared_ptr<AudioPort> source_port = io->audio (i);
5113 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
5115 if (i < n_buffers) {
5117 /* first time through just copy a channel into
5121 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
5123 if (scaling != 1.0f) {
5124 buf.apply_gain (scaling, nframes);
5129 /* on subsequent times around, merge data from
5130 * the port with what is already there
5133 if (scaling != 1.0f) {
5134 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
5136 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
5141 /* silence any remaining buffers */
5143 for (; i < n_buffers; ++i) {
5144 AudioBuffer& buf (bufs.get_audio (i));
5145 buf.silence (nframes);
5148 /* establish the initial setup of the buffer set, reflecting what was
5149 copied into it. unless, of course, we are the auditioner, in which
5150 case nothing was fed into it from the inputs at all.
5153 if (!is_auditioner()) {
5154 bufs.set_count (io->n_ports());
5158 boost::shared_ptr<AutomationControl>
5159 Route::pan_azimuth_control() const
5162 # undef MIXBUS_PORTS_H
5163 # include "../../gtk2_ardour/mixbus_ports.h"
5164 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5166 return boost::shared_ptr<AutomationControl>();
5168 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
5170 if (!_pannable || !panner()) {
5171 return boost::shared_ptr<AutomationControl>();
5173 return _pannable->pan_azimuth_control;
5177 boost::shared_ptr<AutomationControl>
5178 Route::pan_elevation_control() const
5180 if (Profile->get_mixbus() || !_pannable || !panner()) {
5181 return boost::shared_ptr<AutomationControl>();
5184 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5186 if (c.find (PanElevationAutomation) != c.end()) {
5187 return _pannable->pan_elevation_control;
5189 return boost::shared_ptr<AutomationControl>();
5192 boost::shared_ptr<AutomationControl>
5193 Route::pan_width_control() const
5196 if (mixbus() && _ch_pre) {
5198 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(_ch_pre->control(Evoral::Parameter(PluginAutomation, 0, 5)));
5201 if (Profile->get_mixbus() || !_pannable || !panner()) {
5202 return boost::shared_ptr<AutomationControl>();
5205 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5207 if (c.find (PanWidthAutomation) != c.end()) {
5208 return _pannable->pan_width_control;
5210 return boost::shared_ptr<AutomationControl>();
5213 boost::shared_ptr<AutomationControl>
5214 Route::pan_frontback_control() const
5216 if (Profile->get_mixbus() || !_pannable || !panner()) {
5217 return boost::shared_ptr<AutomationControl>();
5220 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5222 if (c.find (PanFrontBackAutomation) != c.end()) {
5223 return _pannable->pan_frontback_control;
5225 return boost::shared_ptr<AutomationControl>();
5228 boost::shared_ptr<AutomationControl>
5229 Route::pan_lfe_control() const
5231 if (Profile->get_mixbus() || !_pannable || !panner()) {
5232 return boost::shared_ptr<AutomationControl>();
5235 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5237 if (c.find (PanLFEAutomation) != c.end()) {
5238 return _pannable->pan_lfe_control;
5240 return boost::shared_ptr<AutomationControl>();
5245 Route::eq_band_cnt () const
5247 if (Profile->get_mixbus()) {
5249 if (is_master() || mixbus()) {
5258 /* Ardour has no well-known EQ object */
5263 boost::shared_ptr<AutomationControl>
5264 Route::eq_gain_controllable (uint32_t band) const
5267 boost::shared_ptr<PluginInsert> eq = ch_eq();
5270 return boost::shared_ptr<AutomationControl>();
5273 uint32_t port_number;
5274 if (is_master() || mixbus()) {
5276 case 0: port_number = 4; break;
5277 case 1: port_number = 3; break;
5278 case 2: port_number = 2; break;
5280 return boost::shared_ptr<AutomationControl>();
5285 case 0: port_number = 14; break;
5286 case 1: port_number = 12; break;
5287 case 2: port_number = 10; break;
5288 case 3: port_number = 8; break;
5290 return boost::shared_ptr<AutomationControl>();
5294 case 0: port_number = 8; break;
5295 case 1: port_number = 6; break;
5296 case 2: port_number = 4; break;
5298 return boost::shared_ptr<AutomationControl>();
5303 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5305 return boost::shared_ptr<AutomationControl>();
5308 boost::shared_ptr<AutomationControl>
5309 Route::eq_freq_controllable (uint32_t band) const
5312 if (mixbus() || is_master()) {
5313 /* no frequency controls for mixbusses or master */
5314 return boost::shared_ptr<AutomationControl>();
5317 boost::shared_ptr<PluginInsert> eq = ch_eq();
5320 return boost::shared_ptr<AutomationControl>();
5323 uint32_t port_number;
5326 case 0: port_number = 13; break; // lo
5327 case 1: port_number = 11; break; // lo mid
5328 case 2: port_number = 9; break; // hi mid
5329 case 3: port_number = 7; break; // hi
5331 return boost::shared_ptr<AutomationControl>();
5335 case 0: port_number = 7; break;
5336 case 1: port_number = 5; break;
5337 case 2: port_number = 3; break;
5339 return boost::shared_ptr<AutomationControl>();
5343 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5345 return boost::shared_ptr<AutomationControl>();
5349 boost::shared_ptr<AutomationControl>
5350 Route::eq_q_controllable (uint32_t band) const
5352 return boost::shared_ptr<AutomationControl>();
5355 boost::shared_ptr<AutomationControl>
5356 Route::eq_shape_controllable (uint32_t band) const
5359 boost::shared_ptr<PluginInsert> eq = ch_eq();
5360 if (is_master() || mixbus() || !eq) {
5361 return boost::shared_ptr<AutomationControl>();
5365 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4))); // lo bell
5368 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3))); // hi bell
5374 return boost::shared_ptr<AutomationControl>();
5377 boost::shared_ptr<AutomationControl>
5378 Route::eq_enable_controllable () const
5381 boost::shared_ptr<PluginInsert> eq = ch_eq();
5384 return boost::shared_ptr<AutomationControl>();
5387 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5389 return boost::shared_ptr<AutomationControl>();
5393 boost::shared_ptr<AutomationControl>
5394 Route::filter_freq_controllable (bool hpf) const
5397 boost::shared_ptr<PluginInsert> eq = ch_eq();
5399 if (is_master() || mixbus() || !eq) {
5400 return boost::shared_ptr<AutomationControl>();
5404 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5))); // HPF freq
5406 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5410 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6))); // LPF freq
5412 return boost::shared_ptr<AutomationControl>();
5417 return boost::shared_ptr<AutomationControl>();
5421 boost::shared_ptr<AutomationControl>
5422 Route::filter_slope_controllable (bool) const
5424 return boost::shared_ptr<AutomationControl>();
5427 boost::shared_ptr<AutomationControl>
5428 Route::filter_enable_controllable (bool) const
5431 boost::shared_ptr<PluginInsert> eq = ch_eq();
5433 if (is_master() || mixbus() || !eq) {
5434 return boost::shared_ptr<AutomationControl>();
5437 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5439 return boost::shared_ptr<AutomationControl>();
5444 Route::eq_band_name (uint32_t band) const
5447 if (is_master() || mixbus()) {
5449 if (Profile->get_mixbus()) {
5451 case 0: return _("lo");
5452 case 1: return _("mid");
5453 case 2: return _("hi");
5454 default: return string();
5462 case 0: return _("lo");
5463 case 1: return _("lo mid");
5464 case 2: return _("hi mid");
5465 case 3: return _("hi");
5466 default: return string();
5472 boost::shared_ptr<AutomationControl>
5473 Route::comp_enable_controllable () const
5476 boost::shared_ptr<PluginInsert> comp = ch_comp();
5479 return boost::shared_ptr<AutomationControl>();
5482 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5484 return boost::shared_ptr<AutomationControl>();
5487 boost::shared_ptr<AutomationControl>
5488 Route::comp_threshold_controllable () const
5491 boost::shared_ptr<PluginInsert> comp = ch_comp();
5494 return boost::shared_ptr<AutomationControl>();
5497 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5500 return boost::shared_ptr<AutomationControl>();
5503 boost::shared_ptr<AutomationControl>
5504 Route::comp_speed_controllable () const
5507 boost::shared_ptr<PluginInsert> comp = ch_comp();
5510 return boost::shared_ptr<AutomationControl>();
5513 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5515 return boost::shared_ptr<AutomationControl>();
5518 boost::shared_ptr<AutomationControl>
5519 Route::comp_mode_controllable () const
5522 boost::shared_ptr<PluginInsert> comp = ch_comp();
5525 return boost::shared_ptr<AutomationControl>();
5528 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5530 return boost::shared_ptr<AutomationControl>();
5533 boost::shared_ptr<AutomationControl>
5534 Route::comp_makeup_controllable () const
5537 boost::shared_ptr<PluginInsert> comp = ch_comp();
5540 return boost::shared_ptr<AutomationControl>();
5543 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5545 return boost::shared_ptr<AutomationControl>();
5548 boost::shared_ptr<ReadOnlyControl>
5549 Route::comp_redux_controllable () const
5552 boost::shared_ptr<PluginInsert> comp = ch_comp();
5555 return boost::shared_ptr<ReadOnlyControl>();
5558 return comp->control_output (2);
5560 return comp->control_output (6);
5564 return boost::shared_ptr<ReadOnlyControl>();
5569 Route::comp_mode_name (uint32_t mode) const
5574 return _("Leveler");
5576 return _("Compressor");
5578 return _("Limiter");
5580 return mixbus() ? _("Sidechain") : _("Limiter");
5590 Route::comp_speed_name (uint32_t mode) const
5608 boost::shared_ptr<AutomationControl>
5609 Route::send_level_controllable (uint32_t n) const
5612 # undef MIXBUS_PORTS_H
5613 # include "../../gtk2_ardour/mixbus_ports.h"
5614 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5615 if (plug && !mixbus()) {
5616 uint32_t port_id = 0;
5618 case 0: port_id = port_channel_post_aux1_level; break;
5619 case 1: port_id = port_channel_post_aux2_level; break;
5620 case 2: port_id = port_channel_post_aux3_level; break;
5621 case 3: port_id = port_channel_post_aux4_level; break;
5622 case 4: port_id = port_channel_post_aux5_level; break;
5623 case 5: port_id = port_channel_post_aux6_level; break;
5624 case 6: port_id = port_channel_post_aux7_level; break;
5625 case 7: port_id = port_channel_post_aux8_level; break;
5627 case 8: port_id = port_channel_post_aux9_level; break;
5628 case 9: port_id = port_channel_post_aux10_level; break;
5629 case 10: port_id = port_channel_post_aux11_level; break;
5630 case 11: port_id = port_channel_post_aux12_level; break;
5637 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5648 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5650 return boost::shared_ptr<AutomationControl>();
5652 return s->gain_control ();
5655 boost::shared_ptr<AutomationControl>
5656 Route::send_enable_controllable (uint32_t n) const
5659 # undef MIXBUS_PORTS_H
5660 # include "../../gtk2_ardour/mixbus_ports.h"
5661 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5662 if (plug && !mixbus()) {
5663 uint32_t port_id = 0;
5665 case 0: port_id = port_channel_post_aux1_asgn; break;
5666 case 1: port_id = port_channel_post_aux2_asgn; break;
5667 case 2: port_id = port_channel_post_aux3_asgn; break;
5668 case 3: port_id = port_channel_post_aux4_asgn; break;
5669 case 4: port_id = port_channel_post_aux5_asgn; break;
5670 case 5: port_id = port_channel_post_aux6_asgn; break;
5671 case 6: port_id = port_channel_post_aux7_asgn; break;
5672 case 7: port_id = port_channel_post_aux8_asgn; break;
5674 case 8: port_id = port_channel_post_aux9_asgn; break;
5675 case 9: port_id = port_channel_post_aux10_asgn; break;
5676 case 10: port_id = port_channel_post_aux11_asgn; break;
5677 case 11: port_id = port_channel_post_aux12_asgn; break;
5684 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5695 /* although Ardour sends have enable/disable as part of the Processor
5696 * API, it is not exposed as a controllable.
5698 * XXX: we should fix this (make it click-free, automatable enable-control)
5700 return boost::shared_ptr<AutomationControl>();
5704 Route::send_name (uint32_t n) const
5707 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5708 if (plug && !mixbus()) {
5711 return _session.get_mixbus (n)->name();
5716 return _session.get_mixbus (n)->name();
5722 boost::shared_ptr<Processor> p = nth_send (n);
5730 boost::shared_ptr<AutomationControl>
5731 Route::master_send_enable_controllable () const
5734 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5736 return boost::shared_ptr<AutomationControl>();
5738 # undef MIXBUS_PORTS_H
5739 # include "../../gtk2_ardour/mixbus_ports.h"
5740 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5742 return boost::shared_ptr<AutomationControl>();
5747 Route::slaved () const
5749 if (!_gain_control) {
5752 /* just test one particular control, not all of them */
5753 return _gain_control->slaved ();
5757 Route::slaved_to (boost::shared_ptr<VCA> vca) const
5759 if (!vca || !_gain_control) {
5763 /* just test one particular control, not all of them */
5765 return _gain_control->slaved_to (vca->gain_control());
5769 Route::muted_by_others_soloing () const
5771 if (!can_be_muted_by_others ()) {
5775 return _session.soloing() && !_solo_control->soloed() && !_solo_isolate_control->solo_isolated();
5779 Route::clear_all_solo_state ()
5781 _solo_control->clear_all_solo_state ();
5784 boost::shared_ptr<AutomationControl>
5785 Route::automation_control_recurse (PBD::ID const & id) const
5787 boost::shared_ptr<AutomationControl> ac = Automatable::automation_control (id);
5793 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5795 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5796 if ((ac = (*i)->automation_control (id))) {
5801 return boost::shared_ptr<AutomationControl> ();
5805 Route::slavables () const
5807 SlavableControlList rv;
5808 rv.push_back (_gain_control);
5809 rv.push_back (_mute_control);
5810 rv.push_back (_solo_control);
5815 Route::set_disk_io_point (DiskIOPoint diop)
5817 bool display = false;
5819 cerr << "set disk io to " << enum_2_string (diop) << endl;
5830 _disk_writer->set_display_to_user (display);
5834 _disk_reader->set_display_to_user (display);
5837 const bool changed = (diop != _disk_io_point);
5839 _disk_io_point = diop;
5842 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
5843 configure_processors (0);
5846 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
5849 #ifdef USE_TRACKS_CODE_FEATURES
5851 /* This is the Tracks version of Track::monitoring_state().
5853 * Ardour developers: try to flag or fix issues if parts of the libardour API
5854 * change in ways that invalidate this
5858 Route::monitoring_state () const
5860 /* Explicit requests */
5862 if (_monitoring != MonitorInput) {
5863 return MonitoringInput;
5866 if (_monitoring & MonitorDisk) {
5867 return MonitoringDisk;
5870 /* This is an implementation of the truth table in doc/monitor_modes.pdf;
5871 I don't think it's ever going to be too pretty too look at.
5874 // GZ: NOT USED IN TRACKS
5875 //bool const auto_input = _session.config.get_auto_input ();
5876 //bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
5877 //bool const tape_machine_mode = Config->get_tape_machine_mode ();
5879 bool const roll = _session.transport_rolling ();
5880 bool const track_rec = _diskstream->record_enabled ();
5881 bool session_rec = _session.actively_recording ();
5885 if (!session_rec && roll) {
5886 return MonitoringDisk;
5888 return MonitoringInput;
5894 return MonitoringDisk;
5898 return MonitoringSilence;
5903 /* This is the Ardour/Mixbus version of Track::monitoring_state().
5905 * Tracks developers: do NOT modify this method under any circumstances.
5909 Route::monitoring_state () const
5911 if (!_disk_reader) {
5912 return MonitoringInput;
5915 /* Explicit requests */
5916 MonitorChoice m (_monitoring_control->monitoring_choice());
5918 if (m != MonitorAuto) {
5920 MonitorState ms ((MonitorState) 0);
5922 if (m & MonitorInput) {
5923 ms = MonitoringInput;
5926 if (m & MonitorDisk) {
5927 ms = MonitorState (ms | MonitoringDisk);
5933 switch (_session.config.get_session_monitoring ()) {
5935 return MonitoringDisk;
5938 return MonitoringInput;
5944 /* This is an implementation of the truth table in doc/monitor_modes.pdf;
5945 I don't think it's ever going to be too pretty too look at.
5948 bool const roll = _session.transport_rolling ();
5949 bool const track_rec = _disk_writer->record_enabled ();
5950 bool const auto_input = _session.config.get_auto_input ();
5951 bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
5952 bool const tape_machine_mode = Config->get_tape_machine_mode ();
5955 /* I suspect that just use actively_recording() is good enough all the
5956 * time, but just to keep the semantics the same as they were before
5957 * sept 26th 2012, we differentiate between the cases where punch is
5958 * enabled and those where it is not.
5960 * rg: sept 30 2017: Above is not the case: punch-in/out location is
5961 * global session playhead position.
5962 * When this method is called from process_output_buffers() we need
5963 * to use delay-compensated route's process-position.
5965 * NB. Disk reader/writer may also be offset by a same amount of time.
5967 * Also keep in mind that _session.transport_rolling() is false during
5968 * pre-roll but the disk already produces output.
5973 if (_session.config.get_punch_in() || _session.config.get_punch_out()) {
5974 session_rec = _session.actively_recording ();
5976 session_rec = _session.get_record_enabled();
5981 if (!session_rec && roll && auto_input) {
5982 return MonitoringDisk;
5984 return software_monitor ? MonitoringInput : MonitoringSilence;
5989 if (tape_machine_mode) {
5991 return MonitoringDisk;
5995 if (!roll && auto_input) {
5996 return software_monitor ? MonitoringInput : MonitoringSilence;
5998 return MonitoringDisk;
6004 abort(); /* NOTREACHED */
6005 return MonitoringSilence;