libs/ardour/ardour/panner.h

   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 #ifndef __ardour_panner_h__
  21 #define __ardour_panner_h__
  22
  23 #include <cmath>
  24 #include <cassert>
  25 #include <vector>
  26 #include <string>
  27 #include <iostream>
  28
  29 #include "pbd/cartesian.h"
  30 #include "pbd/signals.h"
  31 #include "pbd/stateful.h"
  32
  33 #include "ardour/types.h"
  34 #include "ardour/automation_control.h"
  35 #include "ardour/automatable.h"
  36
  37 namespace ARDOUR {
  38
  39 class Session;
  40 class Pannable;
  41 class BufferSet;
  42 class AudioBuffer;
  43 class Speakers;
  44
  45 class Panner : public PBD::Stateful, public PBD::ScopedConnectionList
  46 {
  47   public:
  48         Panner (boost::shared_ptr<Pannable>);
  49         ~Panner ();
  50
  51         virtual ChanCount in() const = 0;
  52         virtual ChanCount out() const = 0;
  53
  54         virtual void configure_io (ARDOUR::ChanCount /*in*/, ARDOUR::ChanCount /*out*/) {}
  55
  56         /* derived implementations of these methods must indicate
  57            whether it is legal for a Controllable to use the
  58            value of the argument (post-call) in a call to
  59            Controllable::set_value().
  60
  61            they have a choice of:
  62
  63            * return true, leave argument unchanged
  64            * return true, modify argument
  65            * return false
  66
  67         */
  68
  69         virtual bool clamp_position (double&) { return true; }
  70         virtual bool clamp_width (double&) { return true; }
  71         virtual bool clamp_elevation (double&) { return true; }
  72
  73         virtual void set_position (double) { }
  74         virtual void set_width (double) { }
  75         virtual void set_elevation (double) { }
  76
  77         virtual double position () const { return 0.0; }
  78         virtual double width () const { return 0.0; }
  79         virtual double elevation () const { return 0.0; }
  80
  81         virtual void reset() {}
  82
  83         virtual bool bypassed() const { return _bypassed; }
  84         virtual void set_bypassed (bool yn);
  85
  86         void      set_automation_state (AutoState);
  87         AutoState automation_state() const;
  88         void      set_automation_style (AutoStyle);
  89         AutoStyle automation_style() const;
  90
  91         virtual std::set<Evoral::Parameter> what_can_be_automated() const;
  92         virtual std::string describe_parameter (Evoral::Parameter);
  93         virtual std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
  94
  95         bool touching() const;
  96
  97         static double azimuth_to_lr_fract (double azi) {
  98                 /* 180.0 degrees=> left => 0.0 */
  99                 /* 0.0 degrees => right => 1.0 */
 100
 101                 /* humans can only distinguish 1 degree of arc between two positions,
 102                    so force azi back to an integral value before computing
 103                 */
 104
 105                 return 1.0 - (rint(azi)/180.0);
 106         }
 107
 108         static double lr_fract_to_azimuth (double fract) {
 109                 /* fract = 0.0 => degrees = 180.0 => left */
 110                 /* fract = 1.0 => degrees = 0.0 => right */
 111
 112                 /* humans can only distinguish 1 degree of arc between two positions,
 113                    so force azi back to an integral value after computing
 114                 */
 115
 116                 return rint (180.0 - (fract * 180.0));
 117         }
 118
 119         /**
 120          *  Pan some input buffers to a number of output buffers.
 121          *
 122          *  @param ibufs Input buffers (one per panner input)
 123          *  @param obufs Output buffers (one per panner output).
 124          *  @param gain_coeff fixed, additional gain coefficient to apply to output samples.
 125          *  @param nframes Number of frames in the input.
 126          *
 127          *  Derived panners can choose to implement these if they need to gain more control over the panning algorithm.
 128          *  the default is to call distribute_one() or distribute_one_automated() on each input buffer to deliver it to each output
 129          *  buffer.
 130          *
 131          *  If a panner does not need to override this default behaviour, it can just implement
 132          *  distribute_one() and distribute_one_automated() (below).
 133          */
 134         virtual void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
 135         virtual void distribute_automated (BufferSet& ibufs, BufferSet& obufs,
 136                                            framepos_t start, framepos_t end, pframes_t nframes,
 137                                            pan_t** buffers);
 138
 139         PBD::Signal0<void> Changed;      /* for positional info */
 140         PBD::Signal0<void> StateChanged; /* for mute */
 141
 142         int set_state (const XMLNode&, int version);
 143         virtual XMLNode& state (bool full_state) = 0;
 144
 145         boost::shared_ptr<Pannable> pannable() const { return _pannable; }
 146
 147         //virtual std::string describe_parameter (Evoral::Parameter);
 148         //virtual std::string value_as_string (Evoral::Parameter, double val);
 149
 150         static bool equivalent (pan_t a, pan_t b) {
 151                 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
 152         }
 153
 154         static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
 155                 /* XXX azimuth only, at present */
 156                 return fabs (a.azi - b.azi) < 1.0;
 157         }
 158
 159   protected:
 160         boost::shared_ptr<Pannable> _pannable;
 161         bool        _bypassed;
 162
 163         XMLNode& get_state ();
 164
 165         virtual void distribute_one (AudioBuffer&, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which) = 0;
 166         virtual void distribute_one_automated (AudioBuffer&, BufferSet& obufs,
 167                                                framepos_t start, framepos_t end, pframes_t nframes,
 168                                                pan_t** buffers, uint32_t which) = 0;
 169 };
 170
 171 } // namespace
 172
 173 extern "C" {
 174         struct PanPluginDescriptor {
 175             std::string name;
 176             int32_t in;
 177             int32_t out;
 178             ARDOUR::Panner* (*factory)(boost::shared_ptr<ARDOUR::Pannable>, boost::shared_ptr<ARDOUR::Speakers>);
 179         };
 180 }
 181
 182 #endif /* __ardour_panner_h__ */