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