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 sigc::signal<void,nframes_t> Delivery::CycleStart;
46 sigc::signal<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 , _solo_isolated (false)
61 , no_panner_reset (false)
63 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
64 _display_to_user = false;
67 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
70 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
73 /* deliver to a new IO object */
75 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
76 : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
78 , _output_buffers (new BufferSet())
81 , _no_outs_cuz_we_no_monitor (false)
83 , _solo_isolated (false)
85 , no_panner_reset (false)
87 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
88 _display_to_user = false;
91 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
94 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
97 /* deliver to a new IO object, reconstruct from XML */
99 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
100 : IOProcessor (s, false, true, "reset")
102 , _output_buffers (new BufferSet())
103 , _current_gain (1.0)
105 , _no_outs_cuz_we_no_monitor (false)
107 , _solo_isolated (false)
109 , no_panner_reset (false)
111 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
112 _display_to_user = false;
114 if (set_state (node, Stateful::loading_state_version)) {
115 throw failed_constructor ();
119 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
122 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
125 /* deliver to an existing IO object, reconstruct from XML */
127 Delivery::Delivery (Session& s, boost::shared_ptr<IO> out, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
128 : IOProcessor (s, boost::shared_ptr<IO>(), out, "reset")
130 , _output_buffers (new BufferSet())
131 , _current_gain (1.0)
133 , _no_outs_cuz_we_no_monitor (false)
135 , _solo_isolated (false)
137 , no_panner_reset (false)
139 _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
140 _display_to_user = false;
142 if (set_state (node, Stateful::loading_state_version)) {
143 throw failed_constructor ();
147 _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
150 CycleStart.connect (mem_fun (*this, &Delivery::cycle_start));
154 Delivery::display_name () const
158 return _("main outs");
171 Delivery::cycle_start (nframes_t /*nframes*/)
174 _no_outs_cuz_we_no_monitor = false;
178 Delivery::increment_output_offset (nframes_t n)
184 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
188 /* the out buffers will be set to point to the port output buffers
189 of our output object.
193 if (_output->n_ports() != ChanCount::ZERO) {
194 out = _output->n_ports();
197 /* not configured yet - we will passthru */
202 fatal << "programming error: this should never be reached" << endmsg;
207 } else if (_role == Insert) {
209 /* the output buffers will be filled with data from the *input* ports
214 if (_input->n_ports() != ChanCount::ZERO) {
215 out = _input->n_ports();
218 /* not configured yet - we will passthru */
223 fatal << "programming error: this should never be reached" << endmsg;
228 fatal << "programming error: this should never be reached" << endmsg;
235 Delivery::configure_io (ChanCount in, ChanCount out)
237 /* check configuration by comparison with our I/O port configuration, if appropriate.
238 see ::can_support_io_configuration() for comments
244 if (_output->n_ports() != out) {
245 if (_output->n_ports() != ChanCount::ZERO) {
246 fatal << _name << " programming error: configure_io with nports = " << _output->n_ports() << " called with " << in << " and " << out << " with " << _output->n_ports() << " output ports" << endmsg;
249 /* I/O not yet configured */
254 } else if (_role == Insert) {
257 if (_input->n_ports() != in) {
258 if (_input->n_ports() != ChanCount::ZERO) {
259 fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
262 /* I/O not yet configured */
268 if (!Processor::configure_io (in, out)) {
278 Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
282 PortSet& ports (_output->ports());
285 if (_output->n_ports ().get (_output->default_type()) == 0) {
289 if (!_active && !_pending_active) {
290 _output->silence (nframes);
294 /* this setup is not just for our purposes, but for anything that comes after us in the
295 processing pathway that wants to use this->output_buffers() for some reason.
298 output_buffers().attach_buffers (ports, nframes, _output_offset);
300 // this Delivery processor is not a derived type, and thus we assume
301 // we really can modify the buffers passed in (it is almost certainly
302 // the main output stage of a Route). Contrast with Send::run()
303 // which cannot do this.
305 tgain = target_gain ();
307 if (tgain != _current_gain) {
309 /* target gain has changed */
311 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
312 _current_gain = tgain;
314 } else if (tgain == 0.0) {
316 /* we were quiet last time, and we're still supposed to be quiet.
317 Silence the outputs, and make sure the buffers are quiet too,
320 _output->silence (nframes);
321 Amp::apply_simple_gain (bufs, nframes, 0.0);
324 } else if (tgain != 1.0) {
326 /* target gain has not changed, but is not unity */
327 Amp::apply_simple_gain (bufs, nframes, tgain);
330 if (_panner && _panner->npanners() && !_panner->bypassed()) {
332 // Use the panner to distribute audio to output port buffers
334 _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
337 // Do a 1:1 copy of data to output ports
339 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
340 _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
343 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
344 _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
349 _active = _pending_active;
353 Delivery::state (bool full_state)
355 XMLNode& node (IOProcessor::state (full_state));
358 node.add_property("type", "main-outs");
359 } else if (_role & Listen) {
360 node.add_property("type", "listen");
362 node.add_property("type", "delivery");
365 node.add_property("role", enum_2_string(_role));
366 node.add_child_nocopy (_panner->state (full_state));
372 Delivery::set_state (const XMLNode& node, int version)
374 const XMLProperty* prop;
376 if (IOProcessor::set_state (node, version)) {
380 if ((prop = node.property ("role")) != 0) {
381 _role = Role (string_2_enum (prop->value(), _role));
382 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
384 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
387 XMLNode* pan_node = node.child (X_("Panner"));
390 _panner->set_state (*pan_node, version);
399 Delivery::reset_panner ()
402 if (!no_panner_reset) {
407 ntargets = _output->n_ports().n_audio();
409 ntargets = _configured_output.n_audio();
412 _panner->reset (ntargets, pans_required());
415 panner_legal_c.disconnect ();
416 panner_legal_c = PannersLegal.connect (mem_fun (*this, &Delivery::panners_became_legal));
421 Delivery::panners_became_legal ()
426 ntargets = _output->n_ports().n_audio();
428 ntargets = _configured_output.n_audio();
431 _panner->reset (ntargets, pans_required());
432 _panner->load (); // automation
433 panner_legal_c.disconnect ();
438 Delivery::defer_pan_reset ()
440 no_panner_reset = true;
444 Delivery::allow_pan_reset ()
446 no_panner_reset = false;
452 Delivery::disable_panners (void)
454 panners_legal = false;
459 Delivery::reset_panners ()
461 panners_legal = true;
462 return PannersLegal ();
467 Delivery::start_pan_touch (uint32_t which)
469 if (which < _panner->npanners()) {
470 _panner->pan_control(which)->start_touch();
475 Delivery::end_pan_touch (uint32_t which)
477 if (which < _panner->npanners()) {
478 _panner->pan_control(which)->stop_touch();
484 Delivery::transport_stopped (sframes_t frame)
486 _panner->transport_stopped (frame);
490 Delivery::flush (nframes_t nframes, nframes64_t time)
492 /* io_lock, not taken: function must be called from Session::process() calltree */
494 PortSet& ports (_output->ports());
496 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
497 (*i).flush_buffers (nframes, time, _output_offset);
502 Delivery::transport_stopped ()
504 /* turn off any notes that are on */
506 PortSet& ports (_output->ports());
508 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
509 (*i).transport_stopped ();
514 Delivery::target_gain ()
516 /* if we've been requested to deactivate, our target gain is zero */
518 if (!_pending_active) {
522 /* if we've been told not to output because its a monitoring situation and
523 we're not monitoring, then be quiet.
526 if (_no_outs_cuz_we_no_monitor) {
536 MuteMaster::MutePoint mp;
540 mp = MuteMaster::Main;
543 mp = MuteMaster::Listen;
548 /* XXX FIX ME this is wrong, we need per-delivery muting */
549 mp = MuteMaster::PreFader;
553 if (_solo_isolated) {
555 /* ... but we are isolated from all that nonsense */
557 desired_gain = _mute_master->mute_gain_at (mp);
559 } else if (_session.soloing()) {
561 desired_gain = min (Config->get_solo_mute_gain(), _mute_master->mute_gain_at (mp));
564 desired_gain = _mute_master->mute_gain_at (mp);
572 Delivery::no_outs_cuz_we_no_monitor (bool yn)
574 _no_outs_cuz_we_no_monitor = yn;
578 Delivery::set_name (const std::string& name)
580 bool ret = IOProcessor::set_name (name);
583 ret = _panner->set_name (name);
590 Delivery::output_changed (IOChange change, void* /*src*/)
592 if (change & ARDOUR::ConfigurationChanged) {