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"
23 #include "ardour/amp.h"
24 #include "ardour/audio_buffer.h"
25 #include "ardour/internal_return.h"
26 #include "ardour/internal_send.h"
27 #include "ardour/meter.h"
28 #include "ardour/panner.h"
29 #include "ardour/panner_shell.h"
30 #include "ardour/route.h"
31 #include "ardour/session.h"
32 #include "ardour/audioengine.h"
37 using namespace ARDOUR;
40 PBD::Signal1<void, pframes_t> InternalSend::CycleStart;
42 InternalSend::InternalSend (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, boost::shared_ptr<Route> sendto, Delivery::Role role)
43 : Send (s, p, mm, role)
46 if (use_target (sendto)) {
47 throw failed_constructor();
53 CycleStart.connect_same_thread (*this, boost::bind (&InternalSend::cycle_start, this, _1));
56 InternalSend::~InternalSend ()
59 _send_to->remove_send_from_internal_return (this);
64 InternalSend::init_gain ()
66 if (_role == Listen) {
67 /* send to monitor bus is always at unity */
68 _amp->set_gain (1.0, this);
70 /* aux sends start at -inf dB */
71 _amp->set_gain (0, this);
76 InternalSend::use_target (boost::shared_ptr<Route> sendto)
79 _send_to->remove_send_from_internal_return (this);
84 _send_to->add_send_to_internal_return (this);
86 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
87 mixbufs.set_count (_send_to->internal_return()->input_streams());
91 set_name (sendto->name());
92 _send_to_id = _send_to->id();
94 target_connections.drop_connections ();
96 _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
97 _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));;
103 InternalSend::send_to_going_away ()
105 target_connections.drop_connections ();
111 InternalSend::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
113 if ((!_active && !_pending_active) || !_send_to) {
118 // we have to copy the input, because we may alter the buffers with the amp
119 // in-place, which a send must never do.
121 if (_panshell && !_panshell->bypassed()) {
122 _panshell->run (bufs, mixbufs, start_frame, end_frame, nframes);
124 if (role() == Listen) {
125 /* We're going to the monitor bus, so discard MIDI data */
127 uint32_t const bufs_audio = bufs.count().get (DataType::AUDIO);
128 uint32_t const mixbufs_audio = mixbufs.count().get (DataType::AUDIO);
130 assert (mixbufs.available().get (DataType::AUDIO) >= bufs_audio);
132 /* Copy bufs into mixbufs, going round bufs more than once if necessary
133 to ensure that every mixbuf gets some data.
137 for (uint32_t i = 0; i < mixbufs_audio; ++i) {
138 mixbufs.get_audio(i).read_from (bufs.get_audio(j), nframes);
141 if (j == bufs_audio) {
147 assert (mixbufs.available() >= bufs.count());
148 mixbufs.read_from (bufs, nframes);
154 gain_t tgain = target_gain ();
156 if (tgain != _current_gain) {
158 /* target gain has changed */
160 Amp::apply_gain (mixbufs, nframes, _current_gain, tgain);
161 _current_gain = tgain;
163 } else if (tgain == 0.0) {
165 /* we were quiet last time, and we're still supposed to be quiet.
169 Amp::apply_simple_gain (mixbufs, nframes, 0.0);
172 } else if (tgain != 1.0) {
174 /* target gain has not changed, but is not zero or unity */
175 Amp::apply_simple_gain (mixbufs, nframes, tgain);
178 // Can't automate gain for sends or returns yet because we need different buffers
179 // so that we don't overwrite the main automation data for the route amp
180 // _amp->setup_gain_automation (start_frame, end_frame, nframes);
182 _amp->run (mixbufs, start_frame, end_frame, nframes, true);
184 /* consider metering */
187 if (_amp->gain_control()->get_value() == 0) {
190 _meter->run (mixbufs, start_frame, end_frame, nframes, true);
194 /* target will pick up our output when it is ready */
197 _active = _pending_active;
201 InternalSend::set_block_size (pframes_t nframes)
204 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), nframes);
211 InternalSend::feeds (boost::shared_ptr<Route> other) const
213 return _send_to == other;
217 InternalSend::state (bool full)
219 XMLNode& node (Send::state (full));
221 /* this replaces any existing "type" property */
223 node.add_property ("type", "intsend");
226 node.add_property ("target", _send_to->id().to_s());
233 InternalSend::get_state()
239 InternalSend::set_state (const XMLNode& node, int version)
241 const XMLProperty* prop;
245 Send::set_state (node, version);
247 if ((prop = node.property ("target")) != 0) {
249 _send_to_id = prop->value();
251 /* if we're loading a session, the target route may not have been
252 create yet. make sure we defer till we are sure that it should
256 if (!IO::connecting_legal) {
257 IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
259 connect_when_legal ();
267 InternalSend::connect_when_legal ()
269 connect_c.disconnect ();
271 if (_send_to_id == "0") {
272 /* it vanished before we could connect */
276 boost::shared_ptr<Route> sendto;
278 if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
279 error << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endmsg;
280 cerr << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endl;
284 return use_target (sendto);
288 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
295 InternalSend::pan_outs () const
297 /* the number of targets for our panner is determined by what we are
298 sending to, if anything.
302 return _send_to->internal_return()->input_streams().n_audio();
305 return 1; /* zero is more accurate, but 1 is probably safer as a way to
311 InternalSend::configure_io (ChanCount in, ChanCount out)
313 bool ret = Send::configure_io (in, out);
314 set_block_size (_session.engine().frames_per_cycle());
319 InternalSend::set_name (const string& str)
321 /* rules for external sends don't apply to us */
322 return IOProcessor::set_name (str);
326 InternalSend::display_name () const
329 return string_compose (X_("%1"), _name);
336 InternalSend::visible () const
346 InternalSend::send_to_property_changed (const PropertyChange& what_changed)
348 if (what_changed.contains (Properties::name)) {
349 set_name (_send_to->name ());
354 InternalSend::set_can_pan (bool yn)
357 _panshell->set_bypassed (!yn);
362 InternalSend::cycle_start (pframes_t nframes)
364 for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {