2 Copyright (C) 2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "pbd/error.h"
21 #include "pbd/failed_constructor.h"
22 #include "pbd/types_convert.h"
24 #include "ardour/amp.h"
25 #include "ardour/audio_buffer.h"
26 #include "ardour/delayline.h"
27 #include "ardour/internal_return.h"
28 #include "ardour/internal_send.h"
29 #include "ardour/meter.h"
30 #include "ardour/panner_shell.h"
31 #include "ardour/route.h"
32 #include "ardour/session.h"
33 #include "ardour/audioengine.h"
37 namespace ARDOUR { class MuteMaster; class Pannable; }
40 using namespace ARDOUR;
43 PBD::Signal1<void, pframes_t> InternalSend::CycleStart;
45 InternalSend::InternalSend (Session& s,
46 boost::shared_ptr<Pannable> p,
47 boost::shared_ptr<MuteMaster> mm,
48 boost::shared_ptr<Route> sendfrom,
49 boost::shared_ptr<Route> sendto,
52 : Send (s, p, mm, role, ignore_bitslot)
53 , _send_from (sendfrom)
54 , _allow_feedback (false)
57 if (use_target (sendto)) {
58 throw failed_constructor();
64 _send_from->DropReferences.connect_same_thread (source_connection, boost::bind (&InternalSend::send_from_going_away, this));
65 CycleStart.connect_same_thread (*this, boost::bind (&InternalSend::cycle_start, this, _1));
68 InternalSend::~InternalSend ()
71 _send_to->remove_send_from_internal_return (this);
76 InternalSend::init_gain ()
78 if (_role == Listen) {
79 /* send to monitor bus is always at unity */
80 _gain_control->set_value (GAIN_COEFF_UNITY, PBD::Controllable::NoGroup);
82 /* aux sends start at -inf dB */
83 _gain_control->set_value (GAIN_COEFF_ZERO, PBD::Controllable::NoGroup);
88 InternalSend::use_target (boost::shared_ptr<Route> sendto)
91 _send_to->remove_send_from_internal_return (this);
96 _send_to->add_send_to_internal_return (this);
98 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
99 mixbufs.set_count (_send_to->internal_return()->input_streams());
101 _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
103 _send_delay->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
107 set_name (sendto->name());
108 _send_to_id = _send_to->id();
110 target_connections.drop_connections ();
112 _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
113 _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));
114 _send_to->io_changed.connect_same_thread (target_connections, boost::bind (&InternalSend::target_io_changed, this));
120 InternalSend::target_io_changed ()
123 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
124 mixbufs.set_count (_send_to->internal_return()->input_streams());
129 InternalSend::send_from_going_away ()
135 InternalSend::send_to_going_away ()
137 target_connections.drop_connections ();
143 InternalSend::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
145 if ((!_active && !_pending_active) || !_send_to) {
150 // we have to copy the input, because we may alter the buffers with the amp
151 // in-place, which a send must never do.
153 if (_panshell && !_panshell->bypassed() && role() != Listen) {
154 if (mixbufs.count ().n_audio () > 0) {
155 _panshell->run (bufs, mixbufs, start_sample, end_sample, nframes);
158 /* non-audio data will not have been copied by the panner, do it now
159 * if there are more buffers available than send buffers, ignore them,
160 * if there are less, copy the last as IO::copy_to_output does. */
162 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
163 if (*t != DataType::AUDIO) {
164 BufferSet::iterator o = mixbufs.begin(*t);
165 BufferSet::iterator i = bufs.begin(*t);
167 while (i != bufs.end(*t) && o != mixbufs.end(*t)) {
168 o->read_from (*i, nframes);
172 while (o != mixbufs.end(*t)) {
173 o->silence(nframes, 0);
179 if (role() == Listen) {
180 /* We're going to the monitor bus, so discard MIDI data */
182 uint32_t const bufs_audio = bufs.count().get (DataType::AUDIO);
183 uint32_t const mixbufs_audio = mixbufs.count().get (DataType::AUDIO);
185 /* monitor-section has same number of channels as master-bus (on creation).
187 * There is no clear answer what should happen when trying to PFL or AFL
188 * a track that has more channels (bufs_audio from source-track is
189 * larger than mixbufs).
191 * There are two options:
192 * 1: discard additional channels (current)
194 * 2: require the monitor-section to have at least as many channels
195 * as the largest count of any route
197 //assert (mixbufs.available().get (DataType::AUDIO) >= bufs_audio);
199 /* Copy bufs into mixbufs, going round bufs more than once if necessary
200 to ensure that every mixbuf gets some data.
205 for (i = 0; i < mixbufs_audio && j < bufs_audio; ++i) {
206 mixbufs.get_audio(i).read_from (bufs.get_audio(j), nframes);
209 if (j == bufs_audio) {
213 /* in case or MIDI track with 0 audio channels */
214 for (; i < mixbufs_audio; ++i) {
215 mixbufs.get_audio(i).silence (nframes);
219 assert (mixbufs.available() >= bufs.count());
220 mixbufs.read_from (bufs, nframes);
226 gain_t tgain = target_gain ();
228 if (tgain != _current_gain) {
230 /* target gain has changed */
232 _current_gain = Amp::apply_gain (mixbufs, _session.nominal_sample_rate(), nframes, _current_gain, tgain);
234 } else if (tgain == GAIN_COEFF_ZERO) {
236 /* we were quiet last time, and we're still supposed to be quiet.
240 Amp::apply_simple_gain (mixbufs, nframes, GAIN_COEFF_ZERO);
243 } else if (tgain != GAIN_COEFF_UNITY) {
245 /* target gain has not changed, but is not zero or unity */
246 Amp::apply_simple_gain (mixbufs, nframes, tgain);
249 _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
250 _amp->setup_gain_automation (start_sample, end_sample, nframes);
251 _amp->run (mixbufs, start_sample, end_sample, speed, nframes, true);
253 _send_delay->run (mixbufs, start_sample, end_sample, speed, nframes, true);
255 /* consider metering */
258 if (_amp->gain_control()->get_value() == GAIN_COEFF_ZERO) {
261 _meter->run (mixbufs, start_sample, end_sample, speed, nframes, true);
265 _thru_delay->run (bufs, start_sample, end_sample, speed, nframes, true);
267 /* target will pick up our output when it is ready */
270 _active = _pending_active;
274 InternalSend::set_block_size (pframes_t nframes)
277 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), nframes);
284 InternalSend::set_allow_feedback (bool yn)
286 _allow_feedback = yn;
287 _send_from->processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
291 InternalSend::feeds (boost::shared_ptr<Route> other) const
293 if (_role == Listen || !_allow_feedback) {
294 return _send_to == other;
300 InternalSend::state ()
302 XMLNode& node (Send::state ());
304 /* this replaces any existing "type" property */
306 node.set_property ("type", "intsend");
309 node.set_property ("target", _send_to->id());
311 node.set_property ("allow-feedback", _allow_feedback);
317 InternalSend::set_state (const XMLNode& node, int version)
321 Send::set_state (node, version);
323 if (node.get_property ("target", _send_to_id)) {
325 /* if we're loading a session, the target route may not have been
326 create yet. make sure we defer till we are sure that it should
330 if (!IO::connecting_legal) {
331 IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
333 connect_when_legal ();
337 node.get_property (X_("allow-feedback"), _allow_feedback);
343 InternalSend::connect_when_legal ()
345 connect_c.disconnect ();
347 if (_send_to_id == "0") {
348 /* it vanished before we could connect */
352 boost::shared_ptr<Route> sendto;
354 if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
355 error << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endmsg;
356 cerr << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endl;
360 return use_target (sendto);
364 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out)
371 InternalSend::pan_outs () const
373 /* the number of targets for our panner is determined by what we are
374 sending to, if anything.
378 return _send_to->internal_return()->input_streams().n_audio();
381 return 1; /* zero is more accurate, but 1 is probably safer as a way to
387 InternalSend::configure_io (ChanCount in, ChanCount out)
389 bool ret = Send::configure_io (in, out);
390 set_block_size (_session.engine().samples_per_cycle());
395 InternalSend::set_name (const string& str)
397 /* rules for external sends don't apply to us */
398 return IOProcessor::set_name (str);
402 InternalSend::display_name () const
405 return string_compose (X_("%1"), _name);
412 InternalSend::visible () const
422 InternalSend::send_to_property_changed (const PropertyChange& what_changed)
424 if (what_changed.contains (Properties::name)) {
425 set_name (_send_to->name ());
430 InternalSend::set_can_pan (bool yn)
433 _panshell->set_bypassed (!yn);
438 InternalSend::cycle_start (pframes_t /*nframes*/)
440 for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {