libs/ardour/send.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/send.h>
  25 #include <ardour/session.h>
  26 #include <ardour/port.h>
  27 #include <ardour/audio_port.h>
  28 #include <ardour/buffer_set.h>
  29 #include <ardour/meter.h>
  30 #include "i18n.h"
  31
  32 using namespace ARDOUR;
  33 using namespace PBD;
  34
  35 Send::Send (Session& s, Placement p)
  36         : IOProcessor (s, string_compose (_("send %1"), (bitslot = s.next_send_id()) + 1), p)
  37 {
  38         _metering = false;
  39         ProcessorCreated (this); /* EMIT SIGNAL */
  40 }
  41
  42 Send::Send (Session& s, const XMLNode& node)
  43         : IOProcessor (s,  "send", PreFader)
  44 {
  45         _metering = false;
  46
  47         if (set_state (node)) {
  48                 throw failed_constructor();
  49         }
  50
  51         ProcessorCreated (this); /* EMIT SIGNAL */
  52 }
  53
  54 Send::Send (const Send& other)
  55         : IOProcessor (other._session, string_compose (_("send %1"), (bitslot = other._session.next_send_id()) + 1), other.placement())
  56 {
  57         _metering = false;
  58         ProcessorCreated (this); /* EMIT SIGNAL */
  59 }
  60
  61 Send::~Send ()
  62 {
  63         GoingAway ();
  64 }
  65
  66 XMLNode&
  67 Send::get_state(void)
  68 {
  69         return state (true);
  70 }
  71
  72 XMLNode&
  73 Send::state(bool full)
  74 {
  75         XMLNode& node = IOProcessor::state(full);
  76         char buf[32];
  77         node.add_property ("type", "send");
  78         snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
  79         node.add_property ("bitslot", buf);
  80
  81         return node;
  82 }
  83
  84 int
  85 Send::set_state(const XMLNode& node)
  86 {
  87         XMLNodeList nlist = node.children();
  88         XMLNodeIterator niter;
  89         const XMLProperty* prop;
  90
  91         if ((prop = node.property ("bitslot")) == 0) {
  92                 bitslot = _session.next_send_id();
  93         } else {
  94                 sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
  95                 _session.mark_send_id (bitslot);
  96         }
  97
  98         const XMLNode* insert_node = &node;
  99
 100         /* Send has regular IO automation (gain, pan) */
 101
 102         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 103                 if ((*niter)->name() == "IOProcessor") {
 104                         insert_node = *niter;
 105                 } else if ((*niter)->name() == X_("Automation")) {
 106                         _io->set_automation_state (*(*niter), Evoral::Parameter(GainAutomation));
 107                 }
 108         }
 109
 110         IOProcessor::set_state (*insert_node);
 111
 112         return 0;
 113 }
 114
 115 void
 116 Send::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
 117 {
 118         if (active()) {
 119
 120                 // we have to copy the input, because IO::deliver_output may alter the buffers
 121                 // in-place, which a send must never do.
 122
 123                 BufferSet& sendbufs = _session.get_mix_buffers(bufs.count());
 124
 125                 sendbufs.read_from(bufs, nframes);
 126                 assert(sendbufs.count() == bufs.count());
 127
 128                 _io->deliver_output (sendbufs, start_frame, end_frame, nframes, offset);
 129
 130                 if (_metering) {
 131                         if (_io->_gain == 0) {
 132                                 _io->_meter->reset();
 133                         } else {
 134                                 _io->_meter->run_in_place(_io->output_buffers(), start_frame, end_frame, nframes, offset);
 135                         }
 136                 }
 137
 138         } else {
 139                 _io->silence (nframes, offset);
 140
 141                 if (_metering) {
 142                         _io->_meter->reset();
 143                 }
 144         }
 145 }
 146
 147 void
 148 Send::set_metering (bool yn)
 149 {
 150         _metering = yn;
 151
 152         if (!_metering) {
 153                 /* XXX possible thread hazard here */
 154                 _io->peak_meter().reset();
 155         }
 156 }
 157
 158 bool
 159 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out_is_ignored) const
 160 {
 161         if (_io->input_maximum() == ChanCount::INFINITE && _io->output_maximum() == ChanCount::INFINITE) {
 162
 163                 /* not configured yet */
 164
 165                 return 1; /* we can support anything the first time we're asked */
 166
 167         } else {
 168
 169                 /* the "input" config for a port insert corresponds to how
 170                    many output ports it will have.
 171                 */
 172
 173                 if (_io->output_maximum() == in) {
 174                         return 1;
 175                 }
 176         }
 177
 178         return -1;
 179 }
 180
 181 bool
 182 Send::configure_io (ChanCount in, ChanCount out)
 183 {
 184         /* we're transparent no matter what.  fight the power. */
 185
 186         if (out != in) {
 187                 return false;
 188         }
 189
 190         _io->set_output_maximum (in);
 191         _io->set_output_minimum (in);
 192         _io->set_input_maximum (ChanCount::ZERO);
 193         _io->set_input_minimum (ChanCount::ZERO);
 194
 195         if (_io->ensure_io (ChanCount::ZERO, in, false, this) != 0) {
 196                 return false;
 197         }
 198
 199         Processor::configure_io(in, out);
 200         _io->reset_panner();
 201
 202         return true;
 203 }
 204
 205 ChanCount
 206 Send::output_streams() const
 207 {
 208         // this method reflects the idea that from the perspective of the Route's ProcessorList,
 209         // a send is just a passthrough. that doesn't match what the Send actually does with its
 210         // data, but since what it does is invisible to the Route, it appears to be a passthrough.
 211
 212         return _configured_input;
 213 }
 214
 215 ChanCount
 216 Send::input_streams() const
 217 {
 218         return _configured_input;
 219 }
 220
 221
 222 void
 223 Send::expect_inputs (const ChanCount& expected)
 224 {
 225         if (expected != expected_inputs) {
 226                 expected_inputs = expected;
 227                 _io->reset_panner ();
 228         }
 229 }