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