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())
62 , _no_outs_cuz_we_no_monitor (false)
64 , no_panner_reset (false)
68 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
71 _display_to_user = false;
74 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
77 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
80 /* deliver to a new IO object */
82 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
83 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
85 , _output_buffers (new BufferSet())
87 , _no_outs_cuz_we_no_monitor (false)
89 , no_panner_reset (false)
93 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
96 _display_to_user = false;
99 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
102 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
106 Delivery::~Delivery()
108 DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
109 delete _output_buffers;
113 Delivery::display_name () const
117 return _("main outs");
130 Delivery::cycle_start (pframes_t /*nframes*/)
132 _no_outs_cuz_we_no_monitor = false;
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)
238 PortSet& ports (_output->ports());
241 if (_output->n_ports ().get (_output->default_type()) == 0) {
245 if (!_active && !_pending_active) {
246 _output->silence (nframes);
250 /* this setup is not just for our purposes, but for anything that comes after us in the
251 processing pathway that wants to use this->output_buffers() for some reason.
254 output_buffers().get_jack_port_addresses (ports, nframes);
256 // this Delivery processor is not a derived type, and thus we assume
257 // we really can modify the buffers passed in (it is almost certainly
258 // the main output stage of a Route). Contrast with Send::run()
259 // which cannot do this.
261 tgain = target_gain ();
263 if (tgain != _current_gain) {
264 /* target gain has changed */
266 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
267 _current_gain = tgain;
269 } else if (tgain == 0.0) {
271 /* we were quiet last time, and we're still supposed to be quiet.
272 Silence the outputs, and make sure the buffers are quiet too,
275 _output->silence (nframes);
276 if (result_required) {
277 bufs.set_count (output_buffers().count ());
278 Amp::apply_simple_gain (bufs, nframes, 0.0);
282 } else if (tgain != 1.0) {
284 /* target gain has not changed, but is not unity */
285 Amp::apply_simple_gain (bufs, nframes, tgain);
288 if (_panshell && !_panshell->bypassed() && _panshell->panner()) {
290 // Use the panner to distribute audio to output port buffers
292 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
294 // MIDI data will not have been delivered by the panner
296 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
297 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
302 // Do a 1:1 copy of data to output ports
304 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
305 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
308 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
309 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
313 if (result_required) {
314 bufs.read_from (output_buffers (), nframes);
318 _active = _pending_active;
322 Delivery::state (bool full_state)
324 XMLNode& node (IOProcessor::state (full_state));
327 node.add_property("type", "main-outs");
328 } else if (_role & Listen) {
329 node.add_property("type", "listen");
331 node.add_property("type", "delivery");
334 node.add_property("role", enum_2_string(_role));
337 node.add_child_nocopy (_panshell->get_state ());
344 Delivery::set_state (const XMLNode& node, int version)
346 const XMLProperty* prop;
348 if (IOProcessor::set_state (node, version)) {
352 if ((prop = node.property ("role")) != 0) {
353 _role = Role (string_2_enum (prop->value(), _role));
354 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
356 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
359 XMLNode* pan_node = node.child (X_("PannerShell"));
361 if (pan_node && _panshell) {
362 _panshell->set_state (*pan_node, version);
373 /* caller must hold process lock */
379 Delivery::pan_outs () const
382 return _output->n_ports().n_audio();
385 return _configured_output.n_audio();
389 Delivery::reset_panner ()
392 if (!no_panner_reset) {
395 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
398 _panshell->pannable()->set_panner (_panshell->panner());
404 panner_legal_c.disconnect ();
405 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
410 Delivery::panners_became_legal ()
413 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
416 _panshell->pannable()->set_panner (_panshell->panner());
420 panner_legal_c.disconnect ();
425 Delivery::defer_pan_reset ()
427 no_panner_reset = true;
431 Delivery::allow_pan_reset ()
433 no_panner_reset = false;
439 Delivery::disable_panners (void)
441 panners_legal = false;
446 Delivery::reset_panners ()
448 panners_legal = true;
449 return *PannersLegal ();
453 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
455 /* io_lock, not taken: function must be called from Session::process() calltree */
461 PortSet& ports (_output->ports());
463 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
464 i->flush_buffers (nframes, time);
469 Delivery::transport_stopped (framepos_t now)
471 Processor::transport_stopped (now);
474 _panshell->pannable()->transport_stopped (now);
478 PortSet& ports (_output->ports());
480 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
481 i->transport_stopped ();
487 Delivery::realtime_locate ()
490 PortSet& ports (_output->ports());
492 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
493 i->realtime_locate ();
499 Delivery::target_gain ()
501 /* if we've been requested to deactivate, our target gain is zero */
503 if (!_pending_active) {
507 /* if we've been told not to output because its a monitoring situation and
508 we're not monitoring, then be quiet.
511 if (_no_outs_cuz_we_no_monitor) {
515 MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
519 mp = MuteMaster::Main;
522 mp = MuteMaster::Listen;
528 mp = MuteMaster::PreFader;
530 mp = MuteMaster::PostFader;
535 gain_t desired_gain = _mute_master->mute_gain_at (mp);
537 if (_role == Listen && _session.monitor_out() && !_session.listening()) {
539 /* nobody is soloed, and this delivery is a listen-send to the
540 control/monitor/listen bus, we should be silent since
541 it gets its signal from the master out.
552 Delivery::no_outs_cuz_we_no_monitor (bool yn)
554 _no_outs_cuz_we_no_monitor = yn;
558 Delivery::set_name (const std::string& name)
560 bool ret = IOProcessor::set_name (name);
563 ret = _panshell->set_name (name);
569 bool ignore_output_change = false;
572 Delivery::output_changed (IOChange change, void* /*src*/)
574 if (change.type & IOChange::ConfigurationChanged) {
576 _output_buffers->attach_buffers (_output->ports ());
580 boost::shared_ptr<Panner>
581 Delivery::panner () const
584 return _panshell->panner();
586 return boost::shared_ptr<Panner>();