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