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/delivery.h"
28 #include "ardour/audio_buffer.h"
29 #include "ardour/amp.h"
30 #include "ardour/buffer_set.h"
31 #include "ardour/configuration.h"
32 #include "ardour/io.h"
33 #include "ardour/meter.h"
34 #include "ardour/mute_master.h"
35 #include "ardour/panner.h"
36 #include "ardour/port.h"
37 #include "ardour/session.h"
43 using namespace ARDOUR;
45 PBD::Signal1<void,nframes_t> Delivery::CycleStart;
46 PBD::Signal0<int> Delivery::PannersLegal;
47 bool Delivery::panners_legal = false;
49 /* deliver to an existing IO object */
51 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, 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())
57 , _no_outs_cuz_we_no_monitor (false)
59 , no_panner_reset (false)
61 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
62 _display_to_user = false;
65 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
68 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
71 /* deliver to a new IO object */
73 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
74 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
76 , _output_buffers (new BufferSet())
79 , _no_outs_cuz_we_no_monitor (false)
81 , no_panner_reset (false)
83 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
84 _display_to_user = false;
87 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
90 CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
96 delete _output_buffers;
100 Delivery::display_name () const
104 return _("main outs");
117 Delivery::cycle_start (nframes_t /*nframes*/)
120 _no_outs_cuz_we_no_monitor = false;
124 Delivery::increment_output_offset (nframes_t n)
130 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
134 /* the out buffers will be set to point to the port output buffers
135 of our output object.
139 if (_output->n_ports() != ChanCount::ZERO) {
140 /* increase number of output ports if the processor chain requires it */
141 out = ChanCount::max (_output->n_ports(), in);
144 /* not configured yet - we will passthru */
149 fatal << "programming error: this should never be reached" << endmsg;
154 } else if (_role == Insert) {
156 /* the output buffers will be filled with data from the *input* ports
161 if (_input->n_ports() != ChanCount::ZERO) {
162 out = _input->n_ports();
165 /* not configured yet - we will passthru */
170 fatal << "programming error: this should never be reached" << endmsg;
175 fatal << "programming error: this should never be reached" << endmsg;
182 Delivery::configure_io (ChanCount in, ChanCount out)
184 /* check configuration by comparison with our I/O port configuration, if appropriate.
185 see ::can_support_io_configuration() for comments
191 if (_output->n_ports() != out) {
192 if (_output->n_ports() != ChanCount::ZERO) {
193 _output->ensure_io (out, false, this);
195 /* I/O not yet configured */
200 } else if (_role == Insert) {
203 if (_input->n_ports() != in) {
204 if (_input->n_ports() != ChanCount::ZERO) {
205 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
208 /* I/O not yet configured */
215 if (!Processor::configure_io (in, out)) {
225 Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, nframes_t nframes, bool result_required)
229 PortSet& ports (_output->ports());
232 if (_output->n_ports ().get (_output->default_type()) == 0) {
236 if (!_active && !_pending_active) {
237 _output->silence (nframes);
241 /* this setup is not just for our purposes, but for anything that comes after us in the
242 processing pathway that wants to use this->output_buffers() for some reason.
245 output_buffers().attach_buffers (ports, nframes, _output_offset);
247 // this Delivery processor is not a derived type, and thus we assume
248 // we really can modify the buffers passed in (it is almost certainly
249 // the main output stage of a Route). Contrast with Send::run()
250 // which cannot do this.
252 tgain = target_gain ();
254 if (tgain != _current_gain) {
255 /* target gain has changed */
257 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
258 _current_gain = tgain;
260 } else if (tgain == 0.0) {
262 /* we were quiet last time, and we're still supposed to be quiet.
263 Silence the outputs, and make sure the buffers are quiet too,
266 _output->silence (nframes);
267 if (result_required) {
268 Amp::apply_simple_gain (bufs, nframes, 0.0);
272 } else if (tgain != 1.0) {
274 /* target gain has not changed, but is not unity */
275 Amp::apply_simple_gain (bufs, nframes, tgain);
278 if (_panner && _panner->npanners() && !_panner->bypassed()) {
280 // Use the panner to distribute audio to output port buffers
282 _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
284 if (result_required) {
285 bufs.read_from (output_buffers (), nframes);
290 // Do a 1:1 copy of data to output ports
292 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
293 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
296 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
297 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
304 _active = _pending_active;
308 Delivery::state (bool full_state)
310 XMLNode& node (IOProcessor::state (full_state));
313 node.add_property("type", "main-outs");
314 } else if (_role & Listen) {
315 node.add_property("type", "listen");
317 node.add_property("type", "delivery");
320 node.add_property("role", enum_2_string(_role));
321 node.add_child_nocopy (_panner->state (full_state));
327 Delivery::set_state (const XMLNode& node, int version)
329 const XMLProperty* prop;
331 if (IOProcessor::set_state (node, version)) {
335 if ((prop = node.property ("role")) != 0) {
336 _role = Role (string_2_enum (prop->value(), _role));
337 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
339 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
342 XMLNode* pan_node = node.child (X_("Panner"));
345 _panner->set_state (*pan_node, version);
354 Delivery::reset_panner ()
357 if (!no_panner_reset) {
362 ntargets = _output->n_ports().n_audio();
364 ntargets = _configured_output.n_audio();
367 _panner->reset (ntargets, pans_required());
370 panner_legal_c.disconnect ();
371 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
376 Delivery::panners_became_legal ()
381 ntargets = _output->n_ports().n_audio();
383 ntargets = _configured_output.n_audio();
386 _panner->reset (ntargets, pans_required());
387 _panner->load (); // automation
388 panner_legal_c.disconnect ();
393 Delivery::defer_pan_reset ()
395 no_panner_reset = true;
399 Delivery::allow_pan_reset ()
401 no_panner_reset = false;
407 Delivery::disable_panners (void)
409 panners_legal = false;
414 Delivery::reset_panners ()
416 panners_legal = true;
417 return *PannersLegal ();
422 Delivery::start_pan_touch (uint32_t which, double when)
424 if (which < _panner->npanners()) {
425 _panner->pan_control(which)->start_touch(when);
430 Delivery::end_pan_touch (uint32_t which, bool mark, double when)
432 if (which < _panner->npanners()) {
433 _panner->pan_control(which)->stop_touch(mark, when);
440 Delivery::flush_buffers (nframes_t nframes, nframes64_t time)
442 /* io_lock, not taken: function must be called from Session::process() calltree */
444 PortSet& ports (_output->ports());
446 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
447 (*i).flush_buffers (nframes, time, _output_offset);
452 Delivery::transport_stopped (framepos_t now)
454 Processor::transport_stopped (now);
456 _panner->transport_stopped (now);
459 PortSet& ports (_output->ports());
461 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
462 (*i).transport_stopped ();
468 Delivery::target_gain ()
470 /* if we've been requested to deactivate, our target gain is zero */
472 if (!_pending_active) {
476 /* if we've been told not to output because its a monitoring situation and
477 we're not monitoring, then be quiet.
480 if (_no_outs_cuz_we_no_monitor) {
484 MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
488 mp = MuteMaster::Main;
491 mp = MuteMaster::Listen;
497 mp = MuteMaster::PreFader;
499 mp = MuteMaster::PostFader;
504 gain_t desired_gain = _mute_master->mute_gain_at (mp);
506 if (_role == Listen && _session.monitor_out() && !_session.listening()) {
508 /* nobody is soloed, and this delivery is a listen-send to the
509 control/monitor/listen bus, we should be silent since
510 it gets its signal from the master out.
521 Delivery::no_outs_cuz_we_no_monitor (bool yn)
523 _no_outs_cuz_we_no_monitor = yn;
527 Delivery::set_name (const std::string& name)
529 bool ret = IOProcessor::set_name (name);
532 ret = _panner->set_name (name);
539 Delivery::output_changed (IOChange change, void* /*src*/)
541 if (change.type & IOChange::ConfigurationChanged) {