libs/ardour/panner_shell.cc

   1 /*
   2     Copyright (C) 2004-2011 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 <inttypes.h>
  21
  22 #include <cmath>
  23 #include <cerrno>
  24 #include <fstream>
  25 #include <cstdlib>
  26 #include <string>
  27 #include <cstdio>
  28 #include <locale.h>
  29 #include <unistd.h>
  30 #include <float.h>
  31 #include <iomanip>
  32
  33 #include <glibmm.h>
  34
  35 #include "pbd/cartesian.h"
  36 #include "pbd/boost_debug.h"
  37 #include "pbd/convert.h"
  38 #include "pbd/error.h"
  39 #include "pbd/failed_constructor.h"
  40 #include "pbd/xml++.h"
  41 #include "pbd/enumwriter.h"
  42
  43 #include "evoral/Curve.hpp"
  44
  45 #include "ardour/audio_buffer.h"
  46 #include "ardour/audio_buffer.h"
  47 #include "ardour/automatable.h"
  48 #include "ardour/buffer_set.h"
  49 #include "ardour/debug.h"
  50 #include "ardour/pannable.h"
  51 #include "ardour/panner.h"
  52 #include "ardour/panner_manager.h"
  53 #include "ardour/panner_shell.h"
  54 #include "ardour/runtime_functions.h"
  55 #include "ardour/session.h"
  56 #include "ardour/utils.h"
  57
  58 #include "i18n.h"
  59
  60 #include "pbd/mathfix.h"
  61
  62 using namespace std;
  63 using namespace ARDOUR;
  64 using namespace PBD;
  65
  66 PannerShell::PannerShell (string name, Session& s, boost::shared_ptr<Pannable> p)
  67         : SessionObject (s, name)
  68         , _pannable (p)
  69         , _bypassed (false)
  70 {
  71         set_name (name);
  72 }
  73
  74 PannerShell::~PannerShell ()
  75 {
  76         DEBUG_TRACE(DEBUG::Destruction, string_compose ("panner shell for %1 destructor, pannable is %2\n", _name, _pannable));
  77 }
  78
  79 void
  80 PannerShell::configure_io (ChanCount in, ChanCount out)
  81 {
  82         uint32_t nouts = out.n_audio();
  83         uint32_t nins = in.n_audio();
  84
  85         /* if new and old config don't need panning, or if
  86            the config hasn't changed, we're done.
  87         */
  88
  89         if (_panner && (_panner->in().n_audio() == nins) && (_panner->out().n_audio() == nouts)) {
  90                 return;
  91         }
  92
  93         if (nouts < 2 || nins == 0) {
  94                 /* no need for panning with less than 2 outputs or no inputs */
  95                 if (_panner) {
  96                         _panner.reset ();
  97                         Changed (); /* EMIT SIGNAL */
  98                 }
  99                 return;
 100         }
 101
 102         PannerInfo* pi = PannerManager::instance().select_panner (in, out);
 103         if (!pi) {
 104                 cerr << "No panner found: check that panners are being discovered correctly during startup.\n";
 105                 assert (pi);
 106         }
 107
 108         boost::shared_ptr<Speakers> speakers = _session.get_speakers ();
 109
 110         if (nouts != speakers->size()) {
 111                 /* hmm, output count doesn't match session speaker count so
 112                    create a new speaker set.
 113                 */
 114                 Speakers* s = new Speakers ();
 115                 s->setup_default_speakers (nouts);
 116                 speakers.reset (s);
 117         }
 118
 119         Panner* p = pi->descriptor.factory (_pannable, speakers);
 120         boost_debug_shared_ptr_mark_interesting (p, "Panner");
 121         _panner.reset (p);
 122         _panner->configure_io (in, out);
 123
 124         Changed (); /* EMIT SIGNAL */
 125 }
 126
 127 XMLNode&
 128 PannerShell::get_state ()
 129 {
 130         XMLNode* node = new XMLNode ("PannerShell");
 131
 132         node->add_property (X_("bypassed"), _bypassed ? X_("yes") : X_("no"));
 133
 134         if (_panner) {
 135                 node->add_child_nocopy (_panner->get_state ());
 136         }
 137
 138         return *node;
 139 }
 140
 141 int
 142 PannerShell::set_state (const XMLNode& node, int version)
 143 {
 144         XMLNodeList nlist = node.children ();
 145         XMLNodeConstIterator niter;
 146         const XMLProperty *prop;
 147         LocaleGuard lg (X_("POSIX"));
 148
 149         if ((prop = node.property (X_("bypassed"))) != 0) {
 150                 set_bypassed (string_is_affirmative (prop->value ()));
 151         }
 152
 153         _panner.reset ();
 154
 155         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 156
 157                 if ((*niter)->name() == X_("Panner")) {
 158
 159                         if ((prop = (*niter)->property (X_("type")))) {
 160
 161                                 list<PannerInfo*>::iterator p;
 162                                 PannerManager& pm (PannerManager::instance());
 163
 164                                 for (p = pm.panner_info.begin(); p != pm.panner_info.end(); ++p) {
 165                                         if (prop->value() == (*p)->descriptor.name) {
 166
 167                                                 /* note that we assume that all the stream panners
 168                                                    are of the same type. pretty good
 169                                                    assumption, but it's still an assumption.
 170                                                 */
 171
 172                                                 _panner.reset ((*p)->descriptor.factory (_pannable, _session.get_speakers ()));
 173
 174                                                 if (_panner->set_state (**niter, version) == 0) {
 175                                                         return -1;
 176                                                 }
 177
 178                                                 break;
 179                                         }
 180                                 }
 181
 182                                 if (p == pm.panner_info.end()) {
 183                                         error << string_compose (_("Unknown panner plugin \"%1\" found in pan state - ignored"),
 184                                                                  prop->value())
 185                                               << endmsg;
 186                                 }
 187
 188                         } else {
 189                                 error << _("panner plugin node has no type information!")
 190                                       << endmsg;
 191                                 return -1;
 192                         }
 193                 }
 194         }
 195
 196         return 0;
 197 }
 198
 199
 200 void
 201 PannerShell::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, pframes_t nframes, gain_t gain_coeff)
 202 {
 203         if (outbufs.count().n_audio() == 0) {
 204                 // Don't want to lose audio...
 205                 assert(inbufs.count().n_audio() == 0);
 206                 return;
 207         }
 208
 209         if (outbufs.count().n_audio() == 1) {
 210
 211                 /* just one output: no real panning going on */
 212
 213                 AudioBuffer& dst = outbufs.get_audio(0);
 214
 215                 if (gain_coeff == 0.0f) {
 216
 217                         /* gain was zero, so make it silent */
 218
 219                         dst.silence (nframes);
 220
 221                 } else if (gain_coeff == 1.0f){
 222
 223                         /* mix all input buffers into the output */
 224
 225                         // copy the first
 226                         dst.read_from(inbufs.get_audio(0), nframes);
 227
 228                         // accumulate starting with the second
 229                         if (inbufs.count().n_audio() > 0) {
 230                                 BufferSet::audio_iterator i = inbufs.audio_begin();
 231                                 for (++i; i != inbufs.audio_end(); ++i) {
 232                                         dst.merge_from(*i, nframes);
 233                                 }
 234                         }
 235
 236                 } else {
 237
 238                         /* mix all buffers into the output, scaling them all by the gain */
 239
 240                         // copy the first
 241                         dst.read_from(inbufs.get_audio(0), nframes);
 242
 243                         // accumulate (with gain) starting with the second
 244                         if (inbufs.count().n_audio() > 0) {
 245                                 BufferSet::audio_iterator i = inbufs.audio_begin();
 246                                 for (++i; i != inbufs.audio_end(); ++i) {
 247                                         dst.accumulate_with_gain_from(*i, nframes, gain_coeff);
 248                                 }
 249                         }
 250
 251                 }
 252
 253                 return;
 254         }
 255
 256         /* multiple outputs ... we must have a panner */
 257
 258         assert (_panner);
 259
 260         /* setup silent buffers so that we can mix into the outbuffers (slightly suboptimal -
 261            better to copy the first set of data then mix after that, but hey, its 2011)
 262         */
 263
 264         for (BufferSet::audio_iterator b = outbufs.audio_begin(); b != outbufs.audio_end(); ++b) {
 265                 (*b).silence (nframes);
 266         }
 267
 268         _panner->distribute (inbufs, outbufs, gain_coeff, nframes);
 269 }
 270
 271 void
 272 PannerShell::run (BufferSet& inbufs, BufferSet& outbufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
 273 {
 274         if (outbufs.count().n_audio() == 0) {
 275                 // Failing to deliver audio we were asked to deliver is a bug
 276                 assert(inbufs.count().n_audio() == 0);
 277                 return;
 278         }
 279
 280         if (outbufs.count().n_audio() == 1) {
 281
 282                 /* one output only: no panner */
 283
 284                 AudioBuffer& dst = outbufs.get_audio(0);
 285
 286                 // FIXME: apply gain automation?
 287
 288                 // copy the first
 289                 dst.read_from (inbufs.get_audio(0), nframes);
 290
 291                 // accumulate starting with the second
 292                 BufferSet::audio_iterator i = inbufs.audio_begin();
 293                 for (++i; i != inbufs.audio_end(); ++i) {
 294                         dst.merge_from (*i, nframes);
 295                 }
 296
 297                 return;
 298         }
 299
 300         // More than 1 output
 301
 302         AutoState as = _panner->automation_state ();
 303
 304         // If we shouldn't play automation defer to distribute_no_automation
 305
 306         if (!(as & Play || ((as & Touch) && !_panner->touching()))) {
 307
 308                 // Speed quietning
 309                 gain_t gain_coeff = 1.0;
 310
 311                 if (fabsf(_session.transport_speed()) > 1.5f && Config->get_quieten_at_speed ()) {
 312                         gain_coeff = speed_quietning;
 313                 }
 314
 315                 distribute_no_automation (inbufs, outbufs, nframes, gain_coeff);
 316
 317         } else {
 318
 319                 /* setup the terrible silence so that we can mix into the outbuffers (slightly suboptimal -
 320                    better to copy the first set of data then mix after that, but hey, its 2011)
 321                 */
 322                 for (BufferSet::audio_iterator i = outbufs.audio_begin(); i != outbufs.audio_end(); ++i) {
 323                         i->silence(nframes);
 324                 }
 325
 326                 _panner->distribute_automated (inbufs, outbufs, start_frame, end_frame, nframes, _session.pan_automation_buffer());
 327         }
 328 }
 329
 330 void
 331 PannerShell::set_bypassed (bool yn)
 332 {
 333         if (yn == _bypassed) {
 334                 return;
 335         }
 336
 337         _bypassed = yn;
 338         Changed (); /* EMIT SIGNAL */
 339 }
 340
 341 bool
 342 PannerShell::bypassed () const
 343 {
 344         return _bypassed;
 345 }