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/audio_port.h"
31 #include "ardour/amp.h"
32 #include "ardour/buffer_set.h"
33 #include "ardour/configuration.h"
34 #include "ardour/io.h"
35 #include "ardour/meter.h"
36 #include "ardour/mute_master.h"
37 #include "ardour/panner.h"
38 #include "ardour/panner_shell.h"
39 #include "ardour/pannable.h"
40 #include "ardour/port.h"
41 #include "ardour/session.h"
42 #include "ardour/audioengine.h"
48 using namespace ARDOUR;
50 PBD::Signal1<void, pframes_t> Delivery::CycleStart;
51 PBD::Signal0<int> Delivery::PannersLegal;
52 bool Delivery::panners_legal = false;
54 /* deliver to an existing IO object */
56 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
57 boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
58 : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
60 , _output_buffers (new BufferSet())
63 , _no_outs_cuz_we_no_monitor (false)
65 , no_panner_reset (false)
67 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
68 _display_to_user = false;
71 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
74 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
77 /* deliver to a new IO object */
79 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
80 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
82 , _output_buffers (new BufferSet())
85 , _no_outs_cuz_we_no_monitor (false)
87 , no_panner_reset (false)
89 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
90 _display_to_user = false;
93 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
96 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
100 Delivery::~Delivery()
102 DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
103 delete _output_buffers;
107 Delivery::display_name () const
111 return _("main outs");
124 Delivery::cycle_start (pframes_t /*nframes*/)
127 _no_outs_cuz_we_no_monitor = false;
131 Delivery::increment_output_offset (framecnt_t n)
137 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
141 /* the out buffers will be set to point to the port output buffers
142 of our output object.
146 if (_output->n_ports() != ChanCount::ZERO) {
147 /* increase number of output ports if the processor chain requires it */
148 out = ChanCount::max (_output->n_ports(), in);
151 /* not configured yet - we will passthru */
156 fatal << "programming error: this should never be reached" << endmsg;
161 } else if (_role == Insert) {
163 /* the output buffers will be filled with data from the *input* ports
168 if (_input->n_ports() != ChanCount::ZERO) {
169 out = _input->n_ports();
172 /* not configured yet - we will passthru */
177 fatal << "programming error: this should never be reached" << endmsg;
182 fatal << "programming error: this should never be reached" << endmsg;
188 /** Caller must hold process lock */
190 Delivery::configure_io (ChanCount in, ChanCount out)
192 assert (!AudioEngine::instance()->process_lock().trylock());
194 /* check configuration by comparison with our I/O port configuration, if appropriate.
195 see ::can_support_io_configuration() for comments
201 if (_output->n_ports() != out) {
202 if (_output->n_ports() != ChanCount::ZERO) {
203 _output->ensure_io (out, false, this);
205 /* I/O not yet configured */
210 } else if (_role == Insert) {
213 if (_input->n_ports() != in) {
214 if (_input->n_ports() != ChanCount::ZERO) {
215 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
218 /* I/O not yet configured */
225 if (!Processor::configure_io (in, out)) {
235 Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
237 boost::shared_ptr<Panner> panner;
241 PortSet& ports (_output->ports());
244 if (_output->n_ports ().get (_output->default_type()) == 0) {
248 if (!_active && !_pending_active) {
249 _output->silence (nframes);
253 /* this setup is not just for our purposes, but for anything that comes after us in the
254 processing pathway that wants to use this->output_buffers() for some reason.
257 output_buffers().get_jack_port_addresses (ports, nframes);
259 // this Delivery processor is not a derived type, and thus we assume
260 // we really can modify the buffers passed in (it is almost certainly
261 // the main output stage of a Route). Contrast with Send::run()
262 // which cannot do this.
264 tgain = target_gain ();
266 if (tgain != _current_gain) {
267 /* target gain has changed */
269 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
270 _current_gain = tgain;
272 } else if (tgain == 0.0) {
274 /* we were quiet last time, and we're still supposed to be quiet.
275 Silence the outputs, and make sure the buffers are quiet too,
278 _output->silence (nframes);
279 if (result_required) {
280 Amp::apply_simple_gain (bufs, nframes, 0.0);
284 } else if (tgain != 1.0) {
286 /* target gain has not changed, but is not unity */
287 Amp::apply_simple_gain (bufs, nframes, tgain);
290 panner = _panshell->panner();
292 if (panner && !panner->bypassed()) {
294 // Use the panner to distribute audio to output port buffers
296 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
301 // Do a 1:1 copy of data to output ports
303 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
304 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
307 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
308 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
312 if (result_required) {
313 bufs.read_from (output_buffers (), nframes);
317 _active = _pending_active;
321 Delivery::state (bool full_state)
323 XMLNode& node (IOProcessor::state (full_state));
326 node.add_property("type", "main-outs");
327 } else if (_role & Listen) {
328 node.add_property("type", "listen");
330 node.add_property("type", "delivery");
333 node.add_property("role", enum_2_string(_role));
334 node.add_child_nocopy (_panshell->state (full_state));
340 Delivery::set_state (const XMLNode& node, int version)
342 const XMLProperty* prop;
344 if (IOProcessor::set_state (node, version)) {
348 if ((prop = node.property ("role")) != 0) {
349 _role = Role (string_2_enum (prop->value(), _role));
350 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
352 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
355 XMLNode* pan_node = node.child (X_("Panner"));
358 _panshell->set_state (*pan_node, version);
367 Delivery::reset_panner ()
369 if (_role == Listen) {
370 /* monitor out gets no panner */
375 if (!no_panner_reset) {
380 ntargets = _output->n_ports().n_audio();
382 ntargets = _configured_output.n_audio();
385 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
388 _panshell->pannable()->set_panner (_panshell->panner());
393 panner_legal_c.disconnect ();
394 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
399 Delivery::panners_became_legal ()
404 ntargets = _output->n_ports().n_audio();
406 ntargets = _configured_output.n_audio();
409 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
412 _panshell->pannable()->set_panner (_panshell->panner());
415 panner_legal_c.disconnect ();
420 Delivery::defer_pan_reset ()
422 no_panner_reset = true;
426 Delivery::allow_pan_reset ()
428 no_panner_reset = false;
434 Delivery::disable_panners (void)
436 panners_legal = false;
441 Delivery::reset_panners ()
443 panners_legal = true;
444 return *PannersLegal ();
448 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
450 /* io_lock, not taken: function must be called from Session::process() calltree */
452 PortSet& ports (_output->ports());
454 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
455 (*i).flush_buffers (nframes, time);
460 Delivery::transport_stopped (framepos_t now)
462 Processor::transport_stopped (now);
463 _panshell->pannable()->transport_stopped (now);
466 PortSet& ports (_output->ports());
468 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
469 (*i).transport_stopped ();
475 Delivery::target_gain ()
477 /* if we've been requested to deactivate, our target gain is zero */
479 if (!_pending_active) {
483 /* if we've been told not to output because its a monitoring situation and
484 we're not monitoring, then be quiet.
487 if (_no_outs_cuz_we_no_monitor) {
491 MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
495 mp = MuteMaster::Main;
498 mp = MuteMaster::Listen;
504 mp = MuteMaster::PreFader;
506 mp = MuteMaster::PostFader;
511 gain_t desired_gain = _mute_master->mute_gain_at (mp);
513 if (_role == Listen && _session.monitor_out() && !_session.listening()) {
515 /* nobody is soloed, and this delivery is a listen-send to the
516 control/monitor/listen bus, we should be silent since
517 it gets its signal from the master out.
528 Delivery::no_outs_cuz_we_no_monitor (bool yn)
530 _no_outs_cuz_we_no_monitor = yn;
534 Delivery::set_name (const std::string& name)
536 bool ret = IOProcessor::set_name (name);
539 ret = _panshell->set_name (name);
546 Delivery::output_changed (IOChange change, void* /*src*/)
548 if (change.type & IOChange::ConfigurationChanged) {
550 _output_buffers->attach_buffers (_output->ports ());
554 boost::shared_ptr<Panner>
555 Delivery::panner () const
557 return _panshell->panner();