libs/ardour/return.cc

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include <algorithm>
  21
  22 #include "pbd/xml++.h"
  23
  24 #include "ardour/amp.h"
  25 #include "ardour/audio_port.h"
  26 #include "ardour/buffer_set.h"
  27 #include "ardour/io.h"
  28 #include "ardour/meter.h"
  29 #include "ardour/panner.h"
  30 #include "ardour/port.h"
  31 #include "ardour/return.h"
  32 #include "ardour/session.h"
  33
  34 #include "i18n.h"
  35
  36 using namespace ARDOUR;
  37 using namespace PBD;
  38
  39 Return::Return (Session& s, bool internal)
  40         : IOProcessor (s, (internal ? false : true), false,
  41                        string_compose (_("return %1"), (_bitslot = s.next_return_id()) + 1))
  42         , _metering (false)
  43 {
  44         /* never muted */
  45
  46         _amp.reset (new Amp (_session, boost::shared_ptr<MuteMaster>()));
  47         _meter.reset (new PeakMeter (_session));
  48 }
  49
  50 Return::~Return ()
  51 {
  52         _session.unmark_return_id (_bitslot);
  53 }
  54
  55 XMLNode&
  56 Return::get_state(void)
  57 {
  58         return state (true);
  59 }
  60
  61 XMLNode&
  62 Return::state(bool full)
  63 {
  64         XMLNode& node = IOProcessor::state(full);
  65         char buf[32];
  66         node.add_property ("type", "return");
  67         snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
  68         node.add_property ("bitslot", buf);
  69
  70         return node;
  71 }
  72
  73 int
  74 Return::set_state (const XMLNode& node, int version)
  75 {
  76         XMLNodeList nlist = node.children();
  77         XMLNodeIterator niter;
  78         const XMLProperty* prop;
  79         const XMLNode* insert_node = &node;
  80
  81         /* Return has regular IO automation (gain, pan) */
  82
  83         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
  84                 if ((*niter)->name() == "IOProcessor") {
  85                         insert_node = *niter;
  86                 } else if ((*niter)->name() == X_("Automation")) {
  87                         // _io->set_automation_state (*(*niter), Evoral::Parameter(GainAutomation));
  88                 }
  89         }
  90
  91         IOProcessor::set_state (*insert_node, version);
  92
  93         if ((prop = node.property ("bitslot")) == 0) {
  94                 _bitslot = _session.next_return_id();
  95         } else {
  96                 _session.unmark_return_id (_bitslot);
  97                 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
  98                 _session.mark_return_id (_bitslot);
  99         }
 100
 101         return 0;
 102 }
 103
 104 void
 105 Return::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool)
 106 {
 107         if ((!_active && !_pending_active) || _input->n_ports() == ChanCount::ZERO) {
 108                 return;
 109         }
 110
 111         _input->collect_input (bufs, nframes, _configured_input);
 112         bufs.set_count(_configured_output);
 113
 114         // Can't automate gain for sends or returns yet because we need different buffers
 115         // so that we don't overwrite the main automation data for the route amp
 116         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 117         _amp->run (bufs, start_frame, end_frame, nframes, true);
 118
 119         if (_metering) {
 120                 if (_amp->gain_control()->get_value() == 0) {
 121                         _meter->reset();
 122                 } else {
 123                         _meter->run (bufs, start_frame, end_frame, nframes, true);
 124                 }
 125         }
 126
 127         _active = _pending_active;
 128 }
 129
 130 bool
 131 Return::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 132 {
 133         out = in + _input->n_ports();
 134         return true;
 135 }
 136
 137 bool
 138 Return::configure_io (ChanCount in, ChanCount out)
 139 {
 140         if (out != in + _input->n_ports()) {
 141                 return false;
 142         }
 143
 144         // Ensure there are enough buffers (since we add some)
 145         if (_session.get_scratch_buffers(in).count() < out) {
 146                 Glib::Mutex::Lock em (_session.engine().process_lock());
 147                 IO::PortCountChanged(out);
 148         }
 149
 150         Processor::configure_io(in, out);
 151
 152         return true;
 153 }
 154
 155 /** Set up the XML description of a return so that its name is unique.
 156  *  @param state XML return state.
 157  *  @param session Session.
 158  */
 159 void
 160 Return::make_unique (XMLNode &state, Session &session)
 161 {
 162         uint32_t const bitslot = session.next_return_id() + 1;
 163
 164         char buf[32];
 165         snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
 166         state.property("bitslot")->set_value (buf);
 167
 168         std::string const name = string_compose (_("return %1"), bitslot);
 169
 170         state.property("name")->set_value (name);
 171
 172         XMLNode* io = state.child ("IO");
 173         if (io) {
 174                 io->property("name")->set_value (name);
 175         }
 176 }
 177
 178