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/amp.h"
26 #include "ardour/audioengine.h"
27 #include "ardour/buffer_set.h"
28 #include "ardour/debug.h"
29 #include "ardour/delivery.h"
30 #include "ardour/io.h"
31 #include "ardour/mute_master.h"
32 #include "ardour/pannable.h"
33 #include "ardour/panner_shell.h"
34 #include "ardour/port.h"
35 #include "ardour/session.h"
39 namespace ARDOUR { class Panner; }
43 using namespace ARDOUR;
45 PBD::Signal0<void> Delivery::PannersLegal;
46 bool Delivery::panners_legal = false;
48 /* deliver to an existing IO object */
50 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
51 boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
52 : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
54 , _output_buffers (new BufferSet())
56 , _no_outs_cuz_we_no_monitor (false)
58 , _no_panner_reset (false)
62 if (r & (Delivery::Send|Delivery::Aux)) is_send = true;
63 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable, is_send));
66 _display_to_user = false;
69 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
73 /* deliver to a new IO object */
75 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
76 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name, "", DataType::AUDIO, (r == Send))
78 , _output_buffers (new BufferSet())
80 , _no_outs_cuz_we_no_monitor (false)
82 , _no_panner_reset (false)
86 if (r & (Delivery::Send|Delivery::Aux)) is_send = true;
87 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable, is_send));
90 _display_to_user = false;
93 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
100 DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
102 /* this object should vanish from any signal callback lists
103 that it is on before we get any further. The full qualification
104 of the method name is not necessary, but is here to make it
105 clear that this call is about signals, not data flow connections.
108 ScopedConnectionList::drop_connections ();
110 delete _output_buffers;
114 Delivery::display_name () const
118 return _("main outs");
131 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out)
135 /* the out buffers will be set to point to the port output buffers
136 of our output object.
140 if (_output->n_ports() != ChanCount::ZERO) {
141 /* increase number of output ports if the processor chain requires it */
142 out = ChanCount::max (_output->n_ports(), in);
145 /* not configured yet - we will passthru */
150 fatal << "programming error: this should never be reached" << endmsg;
151 abort(); /*NOTREACHED*/
155 } else if (_role == Insert) {
157 /* the output buffers will be filled with data from the *input* ports
162 if (_input->n_ports() != ChanCount::ZERO) {
163 out = _input->n_ports();
166 /* not configured yet - we will passthru */
171 fatal << "programming error: this should never be reached" << endmsg;
172 abort(); /*NOTREACHED*/
176 fatal << "programming error: this should never be reached" << endmsg;
182 /** Caller must hold process lock */
184 Delivery::configure_io (ChanCount in, ChanCount out)
187 bool r = AudioEngine::instance()->process_lock().trylock();
188 assert (!r && "trylock inside Delivery::configure_io");
191 /* check configuration by comparison with our I/O port configuration, if appropriate.
192 see ::can_support_io_configuration() for comments
198 if (_output->n_ports() != out) {
199 if (_output->n_ports() != ChanCount::ZERO) {
200 _output->ensure_io (out, false, this);
202 /* I/O not yet configured */
207 } else if (_role == Insert) {
210 if (_input->n_ports() != in) {
211 if (_input->n_ports() != ChanCount::ZERO) {
212 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
213 abort(); /*NOTREACHED*/
215 /* I/O not yet configured */
222 if (!Processor::configure_io (in, out)) {
232 Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
236 PortSet& ports (_output->ports());
239 if (_output->n_ports ().get (_output->default_type()) == 0) {
243 if (!_active && !_pending_active) {
244 _output->silence (nframes);
248 /* this setup is not just for our purposes, but for anything that comes after us in the
249 processing pathway that wants to use this->output_buffers() for some reason.
252 // TODO delayline -- latency-compensation
253 output_buffers().get_backend_port_addresses (ports, nframes);
255 // this Delivery processor is not a derived type, and thus we assume
256 // we really can modify the buffers passed in (it is almost certainly
257 // the main output stage of a Route). Contrast with Send::run()
258 // which cannot do this.
260 tgain = target_gain ();
262 if (tgain != _current_gain) {
263 /* target gain has changed */
265 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
266 _current_gain = tgain;
268 } else if (tgain == 0.0) {
270 /* we were quiet last time, and we're still supposed to be quiet.
271 Silence the outputs, and make sure the buffers are quiet too,
274 _output->silence (nframes);
275 if (result_required) {
276 bufs.set_count (output_buffers().count ());
277 Amp::apply_simple_gain (bufs, nframes, 0.0);
281 } else if (tgain != 1.0) {
283 /* target gain has not changed, but is not unity */
284 Amp::apply_simple_gain (bufs, nframes, tgain);
287 if (_panshell && !_panshell->bypassed() && _panshell->panner()) {
289 // Use the panner to distribute audio to output port buffers
291 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
293 // MIDI data will not have been delivered by the panner
295 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
296 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
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));
336 node.add_child_nocopy (_panshell->get_state ());
337 if (_panshell->pannable()) {
338 node.add_child_nocopy (_panshell->pannable()->get_state ());
346 Delivery::set_state (const XMLNode& node, int version)
348 const XMLProperty* prop;
350 if (IOProcessor::set_state (node, version)) {
354 if ((prop = node.property ("role")) != 0) {
355 _role = Role (string_2_enum (prop->value(), _role));
356 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
358 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
361 XMLNode* pan_node = node.child (X_("PannerShell"));
363 if (pan_node && _panshell) {
364 _panshell->set_state (*pan_node, version);
369 XMLNode* pannnode = node.child (X_("Pannable"));
370 if (_panshell && _panshell->panner() && pannnode) {
371 _panshell->pannable()->set_state (*pannnode, version);
380 /* caller must hold process lock */
386 Delivery::pan_outs () const
389 return _output->n_ports().n_audio();
392 return _configured_output.n_audio();
396 Delivery::reset_panner ()
399 if (!_no_panner_reset) {
401 if (_panshell && _role != Insert && _role != Listen) {
402 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
407 panner_legal_c.disconnect ();
408 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
413 Delivery::panners_became_legal ()
415 if (_panshell && _role != Insert) {
416 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
419 panner_legal_c.disconnect ();
423 Delivery::defer_pan_reset ()
425 _no_panner_reset = true;
429 Delivery::allow_pan_reset ()
431 _no_panner_reset = false;
437 Delivery::disable_panners ()
439 panners_legal = false;
444 Delivery::reset_panners ()
446 panners_legal = true;
451 Delivery::flush_buffers (framecnt_t nframes)
453 /* io_lock, not taken: function must be called from Session::process() calltree */
459 PortSet& ports (_output->ports());
461 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
462 i->flush_buffers (nframes);
467 Delivery::transport_stopped (framepos_t now)
469 Processor::transport_stopped (now);
472 _panshell->pannable()->transport_stopped (now);
476 PortSet& ports (_output->ports());
478 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
479 i->transport_stopped ();
485 Delivery::realtime_locate ()
488 PortSet& ports (_output->ports());
490 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
491 i->realtime_locate ();
497 Delivery::target_gain ()
499 /* if we've been requested to deactivate, our target gain is zero */
501 if (!_pending_active) {
505 /* if we've been told not to output because its a monitoring situation and
506 we're not monitoring, then be quiet.
509 if (_no_outs_cuz_we_no_monitor) {
513 MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
517 mp = MuteMaster::Main;
520 mp = MuteMaster::Listen;
526 mp = MuteMaster::PreFader;
528 mp = MuteMaster::PostFader;
533 gain_t desired_gain = _mute_master->mute_gain_at (mp);
535 if (_role == Listen && _session.monitor_out() && !_session.listening()) {
537 /* nobody is soloed, and this delivery is a listen-send to the
538 control/monitor/listen bus, we should be silent since
539 it gets its signal from the master out.
550 Delivery::no_outs_cuz_we_no_monitor (bool yn)
552 _no_outs_cuz_we_no_monitor = yn;
556 Delivery::set_name (const std::string& name)
558 bool ret = IOProcessor::set_name (name);
560 if (ret && _panshell) {
561 ret = _panshell->set_name (name);
567 bool ignore_output_change = false;
570 Delivery::output_changed (IOChange change, void* /*src*/)
572 if (change.type & IOChange::ConfigurationChanged) {
574 _output_buffers->attach_buffers (_output->ports ());
578 boost::shared_ptr<Panner>
579 Delivery::panner () const
582 return _panshell->panner();
584 return boost::shared_ptr<Panner>();