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/internal_return.h"
27 #include "ardour/internal_send.h"
28 #include "ardour/meter.h"
29 #include "ardour/panner_shell.h"
30 #include "ardour/route.h"
31 #include "ardour/session.h"
32 #include "ardour/audioengine.h"
36 namespace ARDOUR { class MuteMaster; class Pannable; }
39 using namespace ARDOUR;
42 PBD::Signal1<void, pframes_t> InternalSend::CycleStart;
44 InternalSend::InternalSend (Session& s,
45 boost::shared_ptr<Pannable> p,
46 boost::shared_ptr<MuteMaster> mm,
47 boost::shared_ptr<Route> sendfrom,
48 boost::shared_ptr<Route> sendto,
51 : Send (s, p, mm, role, ignore_bitslot)
52 , _send_from (sendfrom)
53 , _allow_feedback (false)
56 if (use_target (sendto)) {
57 throw failed_constructor();
63 _send_from->DropReferences.connect_same_thread (source_connection, boost::bind (&InternalSend::send_from_going_away, this));
64 CycleStart.connect_same_thread (*this, boost::bind (&InternalSend::cycle_start, this, _1));
67 InternalSend::~InternalSend ()
70 _send_to->remove_send_from_internal_return (this);
75 InternalSend::init_gain ()
77 if (_role == Listen) {
78 /* send to monitor bus is always at unity */
79 _gain_control->set_value (GAIN_COEFF_UNITY, PBD::Controllable::NoGroup);
81 /* aux sends start at -inf dB */
82 _gain_control->set_value (GAIN_COEFF_ZERO, PBD::Controllable::NoGroup);
87 InternalSend::use_target (boost::shared_ptr<Route> sendto)
90 _send_to->remove_send_from_internal_return (this);
95 _send_to->add_send_to_internal_return (this);
97 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
98 mixbufs.set_count (_send_to->internal_return()->input_streams());
100 _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
103 _delayline->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
108 set_name (sendto->name());
109 _send_to_id = _send_to->id();
111 target_connections.drop_connections ();
113 _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
114 _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));
115 _send_to->io_changed.connect_same_thread (target_connections, boost::bind (&InternalSend::target_io_changed, this));
121 InternalSend::target_io_changed ()
124 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
125 mixbufs.set_count (_send_to->internal_return()->input_streams());
130 InternalSend::send_from_going_away ()
136 InternalSend::send_to_going_away ()
138 target_connections.drop_connections ();
144 InternalSend::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool)
146 if ((!_active && !_pending_active) || !_send_to) {
151 // we have to copy the input, because we may alter the buffers with the amp
152 // in-place, which a send must never do.
154 if (_panshell && !_panshell->bypassed() && role() != Listen) {
155 if (mixbufs.count ().n_audio () > 0) {
156 _panshell->run (bufs, mixbufs, start_frame, end_frame, nframes);
159 /* non-audio data will not have been copied by the panner, do it now
160 * if there are more buffers available than send buffers, ignore them,
161 * if there are less, copy the last as IO::copy_to_output does. */
163 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
164 if (*t != DataType::AUDIO) {
165 BufferSet::iterator o = mixbufs.begin(*t);
166 BufferSet::iterator i = bufs.begin(*t);
168 while (i != bufs.end(*t) && o != mixbufs.end(*t)) {
169 o->read_from (*i, nframes);
173 while (o != mixbufs.end(*t)) {
174 o->silence(nframes, 0);
180 if (role() == Listen) {
181 /* We're going to the monitor bus, so discard MIDI data */
183 uint32_t const bufs_audio = bufs.count().get (DataType::AUDIO);
184 uint32_t const mixbufs_audio = mixbufs.count().get (DataType::AUDIO);
186 /* monitor-section has same number of channels as master-bus (on creation).
188 * There is no clear answer what should happen when trying to PFL or AFL
189 * a track that has more channels (bufs_audio from source-track is
190 * larger than mixbufs).
192 * There are two options:
193 * 1: discard additional channels (current)
195 * 2: require the monitor-section to have at least as many channels
196 * as the largest count of any route
198 //assert (mixbufs.available().get (DataType::AUDIO) >= bufs_audio);
200 /* Copy bufs into mixbufs, going round bufs more than once if necessary
201 to ensure that every mixbuf gets some data.
206 for (i = 0; i < mixbufs_audio && j < bufs_audio; ++i) {
207 mixbufs.get_audio(i).read_from (bufs.get_audio(j), nframes);
210 if (j == bufs_audio) {
214 /* in case or MIDI track with 0 audio channels */
215 for (; i < mixbufs_audio; ++i) {
216 mixbufs.get_audio(i).silence (nframes);
220 assert (mixbufs.available() >= bufs.count());
221 mixbufs.read_from (bufs, nframes);
227 gain_t tgain = target_gain ();
229 if (tgain != _current_gain) {
231 /* target gain has changed */
233 _current_gain = Amp::apply_gain (mixbufs, _session.nominal_frame_rate(), nframes, _current_gain, tgain);
235 } else if (tgain == GAIN_COEFF_ZERO) {
237 /* we were quiet last time, and we're still supposed to be quiet.
241 Amp::apply_simple_gain (mixbufs, nframes, GAIN_COEFF_ZERO);
244 } else if (tgain != GAIN_COEFF_UNITY) {
246 /* target gain has not changed, but is not zero or unity */
247 Amp::apply_simple_gain (mixbufs, nframes, tgain);
250 _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
251 _amp->setup_gain_automation (start_frame, end_frame, nframes);
252 _amp->run (mixbufs, start_frame, end_frame, speed, nframes, true);
254 _delayline->run (mixbufs, start_frame, end_frame, speed, nframes, true);
256 /* consider metering */
259 if (_amp->gain_control()->get_value() == GAIN_COEFF_ZERO) {
262 _meter->run (mixbufs, start_frame, end_frame, speed, nframes, true);
266 /* target will pick up our output when it is ready */
269 _active = _pending_active;
273 InternalSend::set_block_size (pframes_t nframes)
276 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), nframes);
283 InternalSend::set_allow_feedback (bool yn)
285 _allow_feedback = yn;
286 _send_from->processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
290 InternalSend::feeds (boost::shared_ptr<Route> other) const
292 if (_role == Listen || !_allow_feedback) {
293 return _send_to == other;
299 InternalSend::state (bool full)
301 XMLNode& node (Send::state (full));
303 /* this replaces any existing "type" property */
305 node.set_property ("type", "intsend");
308 node.set_property ("target", _send_to->id());
310 node.set_property ("allow-feedback", _allow_feedback);
316 InternalSend::get_state()
322 InternalSend::set_state (const XMLNode& node, int version)
326 Send::set_state (node, version);
328 if (node.get_property ("target", _send_to_id)) {
330 /* if we're loading a session, the target route may not have been
331 create yet. make sure we defer till we are sure that it should
335 if (!IO::connecting_legal) {
336 IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
338 connect_when_legal ();
342 node.get_property (X_("allow-feedback"), _allow_feedback);
348 InternalSend::connect_when_legal ()
350 connect_c.disconnect ();
352 if (_send_to_id == "0") {
353 /* it vanished before we could connect */
357 boost::shared_ptr<Route> sendto;
359 if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
360 error << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endmsg;
361 cerr << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endl;
365 return use_target (sendto);
369 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out)
376 InternalSend::pan_outs () const
378 /* the number of targets for our panner is determined by what we are
379 sending to, if anything.
383 return _send_to->internal_return()->input_streams().n_audio();
386 return 1; /* zero is more accurate, but 1 is probably safer as a way to
392 InternalSend::configure_io (ChanCount in, ChanCount out)
394 bool ret = Send::configure_io (in, out);
395 set_block_size (_session.engine().samples_per_cycle());
400 InternalSend::set_name (const string& str)
402 /* rules for external sends don't apply to us */
403 return IOProcessor::set_name (str);
407 InternalSend::display_name () const
410 return string_compose (X_("%1"), _name);
417 InternalSend::visible () const
427 InternalSend::send_to_property_changed (const PropertyChange& what_changed)
429 if (what_changed.contains (Properties::name)) {
430 set_name (_send_to->name ());
435 InternalSend::set_can_pan (bool yn)
438 _panshell->set_bypassed (!yn);
443 InternalSend::cycle_start (pframes_t /*nframes*/)
445 for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {