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/delivery.h"
26 #include "ardour/audio_buffer.h"
27 #include "ardour/amp.h"
28 #include "ardour/buffer_set.h"
29 #include "ardour/configuration.h"
30 #include "ardour/io.h"
31 #include "ardour/meter.h"
32 #include "ardour/mute_master.h"
33 #include "ardour/panner.h"
34 #include "ardour/port.h"
35 #include "ardour/session.h"
41 using namespace ARDOUR;
43 sigc::signal<void,nframes_t> Delivery::CycleStart;
44 sigc::signal<int> Delivery::PannersLegal;
45 bool Delivery::panners_legal = false;
47 /* deliver to an existing IO object */
49 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
50 : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
52 , _output_buffers (new BufferSet())
55 , _no_outs_cuz_we_no_monitor (false)
57 , _solo_isolated (false)
59 , no_panner_reset (false)
62 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
65 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
68 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
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 , _solo_isolated (false)
83 , no_panner_reset (false)
85 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
88 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
91 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
94 /* deliver to a new IO object, reconstruct from XML */
96 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
97 : IOProcessor (s, false, true, "reset")
99 , _output_buffers (new BufferSet())
100 , _current_gain (1.0)
102 , _no_outs_cuz_we_no_monitor (false)
104 , _solo_isolated (false)
106 , no_panner_reset (false)
108 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
110 if (set_state (node)) {
111 throw failed_constructor ();
115 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
118 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
121 /* deliver to an existing IO object, reconstruct from XML */
123 Delivery::Delivery (Session& s, boost::shared_ptr<IO> out, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
124 : IOProcessor (s, boost::shared_ptr<IO>(), out, "reset")
126 , _output_buffers (new BufferSet())
127 , _current_gain (1.0)
129 , _no_outs_cuz_we_no_monitor (false)
131 , _solo_isolated (false)
133 , no_panner_reset (false)
135 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
137 if (set_state (node)) {
138 throw failed_constructor ();
142 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
145 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
149 Delivery::display_name () const
153 return _("main outs");
166 Delivery::cycle_start (nframes_t /*nframes*/)
169 _no_outs_cuz_we_no_monitor = false;
173 Delivery::increment_output_offset (nframes_t n)
179 Delivery::visible () const
185 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
189 /* the out buffers will be set to point to the port output buffers
190 of our output object.
194 if (_output->n_ports() != ChanCount::ZERO) {
195 out = _output->n_ports();
198 /* not configured yet - we will passthru */
203 fatal << "programming error: this should never be reached" << endmsg;
208 } else if (_role == Insert) {
210 /* the output buffers will be filled with data from the *input* ports
215 if (_input->n_ports() != ChanCount::ZERO) {
216 out = _input->n_ports();
219 /* not configured yet - we will passthru */
224 fatal << "programming error: this should never be reached" << endmsg;
229 fatal << "programming error: this should never be reached" << endmsg;
236 Delivery::configure_io (ChanCount in, ChanCount out)
238 /* check configuration by comparison with our I/O port configuration, if appropriate.
239 see ::can_support_io_configuration() for comments
245 if (_output->n_ports() != out) {
246 if (_output->n_ports() != ChanCount::ZERO) {
247 fatal << _name << " programming error: configure_io with nports = " << _output->n_ports() << " called with " << in << " and " << out << " with " << _output->n_ports() << " output ports" << endmsg;
250 /* I/O not yet configured */
255 } else if (_role == Insert) {
258 if (_input->n_ports() != in) {
259 if (_input->n_ports() != ChanCount::ZERO) {
260 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
263 /* I/O not yet configured */
269 if (!Processor::configure_io (in, out)) {
279 Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
283 PortSet& ports (_output->ports());
286 if (_output->n_ports ().get (_output->default_type()) == 0) {
290 if (!_active && !_pending_active) {
291 _output->silence (nframes);
295 /* this setup is not just for our purposes, but for anything that comes after us in the
296 processing pathway that wants to use this->output_buffers() for some reason.
299 output_buffers().attach_buffers (ports, nframes, _output_offset);
301 // this Delivery processor is not a derived type, and thus we assume
302 // we really can modify the buffers passed in (it is almost certainly
303 // the main output stage of a Route). Contrast with Send::run()
304 // which cannot do this.
306 tgain = target_gain ();
308 if (tgain != _current_gain) {
310 /* target gain has changed */
312 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
313 _current_gain = tgain;
315 } else if (tgain == 0.0) {
317 /* we were quiet last time, and we're still supposed to be quiet.
318 Silence the outputs, and make sure the buffers are quiet too,
321 _output->silence (nframes);
322 Amp::apply_simple_gain (bufs, nframes, 0.0);
325 } else if (tgain != 1.0) {
327 /* target gain has not changed, but is not unity */
328 Amp::apply_simple_gain (bufs, nframes, tgain);
331 if (_panner && _panner->npanners() && !_panner->bypassed()) {
333 // Use the panner to distribute audio to output port buffers
335 _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
338 // Do a 1:1 copy of data to output ports
340 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
341 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
344 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
345 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
350 _active = _pending_active;
354 Delivery::state (bool full_state)
356 XMLNode& node (IOProcessor::state (full_state));
359 node.add_property("type", "main-outs");
360 } else if (_role & Listen) {
361 node.add_property("type", "listen");
363 node.add_property("type", "delivery");
366 node.add_property("role", enum_2_string(_role));
367 node.add_child_nocopy (_panner->state (full_state));
373 Delivery::set_state (const XMLNode& node)
375 const XMLProperty* prop;
377 if (IOProcessor::set_state (node)) {
381 if ((prop = node.property ("role")) != 0) {
382 _role = Role (string_2_enum (prop->value(), _role));
383 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
385 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
388 XMLNode* pan_node = node.child (X_("Panner"));
391 _panner->set_state (*pan_node);
400 Delivery::reset_panner ()
403 if (!no_panner_reset) {
408 ntargets = _output->n_ports().n_audio();
410 ntargets = _configured_output.n_audio();
413 _panner->reset (ntargets, pans_required());
416 panner_legal_c.disconnect ();
417 panner_legal_c = PannersLegal.connect (mem_fun (*this, &Delivery::panners_became_legal));
422 Delivery::panners_became_legal ()
427 ntargets = _output->n_ports().n_audio();
429 ntargets = _configured_output.n_audio();
432 _panner->reset (ntargets, pans_required());
433 _panner->load (); // automation
434 panner_legal_c.disconnect ();
439 Delivery::defer_pan_reset ()
441 no_panner_reset = true;
445 Delivery::allow_pan_reset ()
447 no_panner_reset = false;
453 Delivery::disable_panners (void)
455 panners_legal = false;
460 Delivery::reset_panners ()
462 panners_legal = true;
463 return PannersLegal ();
468 Delivery::start_pan_touch (uint32_t which)
470 if (which < _panner->npanners()) {
471 _panner->pan_control(which)->start_touch();
476 Delivery::end_pan_touch (uint32_t which)
478 if (which < _panner->npanners()) {
479 _panner->pan_control(which)->stop_touch();
485 Delivery::transport_stopped (sframes_t frame)
487 _panner->transport_stopped (frame);
491 Delivery::flush (nframes_t nframes)
493 /* io_lock, not taken: function must be called from Session::process() calltree */
495 PortSet& ports (_output->ports());
497 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
498 (*i).flush_buffers (nframes, _output_offset);
503 Delivery::target_gain ()
505 /* if we've been requested to deactivate, our target gain is zero */
507 if (!_pending_active) {
511 /* if we've been told not to output because its a monitoring situation and
512 we're not monitoring, then be quiet.
515 if (_no_outs_cuz_we_no_monitor) {
525 MuteMaster::MutePoint mp;
529 mp = MuteMaster::Main;
532 mp = MuteMaster::Listen;
537 /* XXX FIX ME this is wrong, we need per-delivery muting */
538 mp = MuteMaster::PreFader;
542 if (_solo_isolated) {
544 /* ... but we are isolated from all that nonsense */
546 desired_gain = _mute_master->mute_gain_at (mp);
548 } else if (_session.soloing()) {
550 desired_gain = min (Config->get_solo_mute_gain(), _mute_master->mute_gain_at (mp));
553 desired_gain = _mute_master->mute_gain_at (mp);
561 Delivery::no_outs_cuz_we_no_monitor (bool yn)
563 _no_outs_cuz_we_no_monitor = yn;
567 Delivery::set_name (const std::string& name)
569 bool ret = IOProcessor::set_name (name);
572 ret = _panner->set_name (name);
579 Delivery::output_changed (IOChange change, void* /*src*/)
581 if (change & ARDOUR::ConfigurationChanged) {