2 Copyright (C) 2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2 of the License, or (at your option)
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include "pbd/enumwriter.h"
23 #include "pbd/convert.h"
25 #include "ardour/midi_buffer.h"
27 #include "ardour/debug.h"
28 #include "ardour/delivery.h"
29 #include "ardour/audio_buffer.h"
30 #include "ardour/amp.h"
31 #include "ardour/buffer_set.h"
32 #include "ardour/configuration.h"
33 #include "ardour/io.h"
34 #include "ardour/meter.h"
35 #include "ardour/mute_master.h"
36 #include "ardour/panner.h"
37 #include "ardour/panner_shell.h"
38 #include "ardour/pannable.h"
39 #include "ardour/port.h"
40 #include "ardour/session.h"
41 #include "ardour/audioengine.h"
47 using namespace ARDOUR;
49 PBD::Signal1<void, pframes_t> Delivery::CycleStart;
50 PBD::Signal0<int> Delivery::PannersLegal;
51 bool Delivery::panners_legal = false;
53 /* deliver to an existing IO object */
55 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
56 boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
57 : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
59 , _output_buffers (new BufferSet())
62 , _no_outs_cuz_we_no_monitor (false)
64 , no_panner_reset (false)
66 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
67 _display_to_user = false;
70 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
73 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
76 /* deliver to a new IO object */
78 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
79 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
81 , _output_buffers (new BufferSet())
84 , _no_outs_cuz_we_no_monitor (false)
86 , no_panner_reset (false)
88 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
89 _display_to_user = false;
92 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
95 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
101 DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
102 delete _output_buffers;
106 Delivery::display_name () const
110 return _("main outs");
123 Delivery::cycle_start (pframes_t /*nframes*/)
126 _no_outs_cuz_we_no_monitor = false;
130 Delivery::increment_output_offset (framecnt_t n)
136 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
140 /* the out buffers will be set to point to the port output buffers
141 of our output object.
145 if (_output->n_ports() != ChanCount::ZERO) {
146 /* increase number of output ports if the processor chain requires it */
147 out = ChanCount::max (_output->n_ports(), in);
150 /* not configured yet - we will passthru */
155 fatal << "programming error: this should never be reached" << endmsg;
160 } else if (_role == Insert) {
162 /* the output buffers will be filled with data from the *input* ports
167 if (_input->n_ports() != ChanCount::ZERO) {
168 out = _input->n_ports();
171 /* not configured yet - we will passthru */
176 fatal << "programming error: this should never be reached" << endmsg;
181 fatal << "programming error: this should never be reached" << endmsg;
187 /** Caller must hold process lock */
189 Delivery::configure_io (ChanCount in, ChanCount out)
191 assert (!AudioEngine::instance()->process_lock().trylock());
193 /* check configuration by comparison with our I/O port configuration, if appropriate.
194 see ::can_support_io_configuration() for comments
200 if (_output->n_ports() != out) {
201 if (_output->n_ports() != ChanCount::ZERO) {
202 _output->ensure_io (out, false, this);
204 /* I/O not yet configured */
209 } else if (_role == Insert) {
212 if (_input->n_ports() != in) {
213 if (_input->n_ports() != ChanCount::ZERO) {
214 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
217 /* I/O not yet configured */
224 if (!Processor::configure_io (in, out)) {
234 Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
236 boost::shared_ptr<Panner> panner;
240 PortSet& ports (_output->ports());
243 if (_output->n_ports ().get (_output->default_type()) == 0) {
247 if (!_active && !_pending_active) {
248 _output->silence (nframes);
252 /* this setup is not just for our purposes, but for anything that comes after us in the
253 processing pathway that wants to use this->output_buffers() for some reason.
256 output_buffers().get_jack_port_addresses (ports, nframes, _output_offset);
258 // this Delivery processor is not a derived type, and thus we assume
259 // we really can modify the buffers passed in (it is almost certainly
260 // the main output stage of a Route). Contrast with Send::run()
261 // which cannot do this.
263 tgain = target_gain ();
265 if (tgain != _current_gain) {
266 /* target gain has changed */
268 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
269 _current_gain = tgain;
271 } else if (tgain == 0.0) {
273 /* we were quiet last time, and we're still supposed to be quiet.
274 Silence the outputs, and make sure the buffers are quiet too,
277 _output->silence (nframes);
278 if (result_required) {
279 Amp::apply_simple_gain (bufs, nframes, 0.0);
283 } else if (tgain != 1.0) {
285 /* target gain has not changed, but is not unity */
286 Amp::apply_simple_gain (bufs, nframes, tgain);
289 panner = _panshell->panner();
291 if (panner && !panner->bypassed()) {
293 // Use the panner to distribute audio to output port buffers
295 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
300 // Do a 1:1 copy of data to output ports
302 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
303 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
306 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
307 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
311 if (result_required) {
312 bufs.read_from (output_buffers (), nframes);
316 _active = _pending_active;
320 Delivery::state (bool full_state)
322 XMLNode& node (IOProcessor::state (full_state));
325 node.add_property("type", "main-outs");
326 } else if (_role & Listen) {
327 node.add_property("type", "listen");
329 node.add_property("type", "delivery");
332 node.add_property("role", enum_2_string(_role));
333 node.add_child_nocopy (_panshell->state (full_state));
339 Delivery::set_state (const XMLNode& node, int version)
341 const XMLProperty* prop;
343 if (IOProcessor::set_state (node, version)) {
347 if ((prop = node.property ("role")) != 0) {
348 _role = Role (string_2_enum (prop->value(), _role));
349 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
351 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
354 XMLNode* pan_node = node.child (X_("Panner"));
357 _panshell->set_state (*pan_node, version);
366 Delivery::reset_panner ()
368 if (_role == Listen) {
369 /* monitor out gets no panner */
374 if (!no_panner_reset) {
379 ntargets = _output->n_ports().n_audio();
381 ntargets = _configured_output.n_audio();
384 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
387 _panshell->pannable()->set_panner (_panshell->panner());
392 panner_legal_c.disconnect ();
393 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
398 Delivery::panners_became_legal ()
403 ntargets = _output->n_ports().n_audio();
405 ntargets = _configured_output.n_audio();
408 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
411 _panshell->pannable()->set_panner (_panshell->panner());
414 panner_legal_c.disconnect ();
419 Delivery::defer_pan_reset ()
421 no_panner_reset = true;
425 Delivery::allow_pan_reset ()
427 no_panner_reset = false;
433 Delivery::disable_panners (void)
435 panners_legal = false;
440 Delivery::reset_panners ()
442 panners_legal = true;
443 return *PannersLegal ();
447 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
449 /* io_lock, not taken: function must be called from Session::process() calltree */
451 PortSet& ports (_output->ports());
453 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
454 (*i).flush_buffers (nframes, time, _output_offset);
459 Delivery::transport_stopped (framepos_t now)
461 Processor::transport_stopped (now);
462 _panshell->pannable()->transport_stopped (now);
465 PortSet& ports (_output->ports());
467 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
468 (*i).transport_stopped ();
474 Delivery::target_gain ()
476 /* if we've been requested to deactivate, our target gain is zero */
478 if (!_pending_active) {
482 /* if we've been told not to output because its a monitoring situation and
483 we're not monitoring, then be quiet.
486 if (_no_outs_cuz_we_no_monitor) {
490 MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
494 mp = MuteMaster::Main;
497 mp = MuteMaster::Listen;
503 mp = MuteMaster::PreFader;
505 mp = MuteMaster::PostFader;
510 gain_t desired_gain = _mute_master->mute_gain_at (mp);
512 if (_role == Listen && _session.monitor_out() && !_session.listening()) {
514 /* nobody is soloed, and this delivery is a listen-send to the
515 control/monitor/listen bus, we should be silent since
516 it gets its signal from the master out.
527 Delivery::no_outs_cuz_we_no_monitor (bool yn)
529 _no_outs_cuz_we_no_monitor = yn;
533 Delivery::set_name (const std::string& name)
535 bool ret = IOProcessor::set_name (name);
538 ret = _panshell->set_name (name);
545 Delivery::output_changed (IOChange change, void* /*src*/)
547 if (change.type & IOChange::ConfigurationChanged) {
549 _output_buffers->attach_buffers (_output->ports ());
553 boost::shared_ptr<Panner>
554 Delivery::panner () const
556 return _panshell->panner();