libs/ardour/ardour/panner.h

   1 /*
   2     Copyright (C) 2004 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/stateful.h"
  30 #include "pbd/controllable.h"
  31 #include "pbd/cartesian.h"
  32
  33 #include "ardour/types.h"
  34 #include "ardour/automation_control.h"
  35 #include "ardour/processor.h"
  36
  37 namespace ARDOUR {
  38
  39 class Session;
  40 class Panner;
  41 class BufferSet;
  42 class AudioBuffer;
  43 class Speakers;
  44
  45 class StreamPanner : public PBD::Stateful
  46 {
  47   public:
  48         StreamPanner (Panner& p, Evoral::Parameter param);
  49         ~StreamPanner ();
  50
  51         void set_muted (bool yn);
  52         bool muted() const { return _muted; }
  53
  54         const PBD::AngularVector& get_position() const { return _angles; }
  55         const PBD::AngularVector& get_effective_position() const { return _effective_angles; }
  56         void set_position (const PBD::AngularVector&, bool link_call = false);
  57         void set_diffusion (double);
  58
  59         void distribute (AudioBuffer &, BufferSet &, gain_t, nframes_t);
  60         void distribute_automated (AudioBuffer &, BufferSet &, nframes_t, nframes_t, nframes_t, pan_t **);
  61
  62         /* the basic StreamPanner API */
  63
  64         /**
  65          *  Pan some input samples to a number of output buffers.
  66          *
  67          *  @param src Input buffer.
  68          *  @param obufs Output buffers (one per panner output).
  69          *  @param gain_coeff Gain coefficient to apply to output samples.
  70          *  @param nframes Number of frames in the input.
  71          */
  72         virtual void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
  73         virtual void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
  74                                               nframes_t start, nframes_t end, nframes_t nframes,
  75                                               pan_t** buffers) = 0;
  76
  77         boost::shared_ptr<AutomationControl> pan_control()  { return _control; }
  78
  79         PBD::Signal0<void> Changed;      /* for position or diffusion */
  80         PBD::Signal0<void> StateChanged; /* for mute, mono */
  81
  82         int set_state (const XMLNode&, int version);
  83         virtual XMLNode& state (bool full_state) = 0;
  84
  85         Panner & get_parent() { return parent; }
  86
  87         /* old school automation loading */
  88         virtual int load (std::istream&, std::string path, uint32_t&) = 0;
  89
  90   protected:
  91         friend class Panner;
  92         Panner& parent;
  93
  94         void set_mono (bool);
  95
  96         PBD::AngularVector _angles;
  97         PBD::AngularVector _effective_angles;
  98         double        _diffusion;
  99
 100         bool _muted;
 101         bool _mono;
 102
 103         boost::shared_ptr<AutomationControl> _control;
 104
 105         void add_state (XMLNode&);
 106
 107         /* Update internal parameters based on this.angles */
 108         virtual void update () = 0;
 109 };
 110
 111 class BaseStereoPanner : public StreamPanner
 112 {
 113   public:
 114         BaseStereoPanner (Panner&, Evoral::Parameter param);
 115         ~BaseStereoPanner ();
 116
 117         /* this class just leaves the pan law itself to be defined
 118            by the update(), do_distribute_automated()
 119            methods. derived classes also need a factory method
 120            and a type name. See EqualPowerStereoPanner as an example.
 121         */
 122
 123         void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 124
 125         static double azimuth_to_lr_fract (double azi) {
 126                 /* 180.0 degrees=> left => 0.0 */
 127                 /* 0.0 degrees => right => 1.0 */
 128                 return 1.0 - (azi/180.0);
 129         }
 130
 131         static double lr_fract_to_azimuth (double fract) {
 132                 /* fract = 0.0 => degrees = 180.0 => left */
 133                 /* fract = 1.0 => degrees = 0.0 => right */
 134                 return 180.0 - (fract * 180.0);
 135         }
 136
 137         /* old school automation loading */
 138
 139         int load (std::istream&, std::string path, uint32_t&);
 140
 141   protected:
 142         float left;
 143         float right;
 144         float desired_left;
 145         float desired_right;
 146         float left_interp;
 147         float right_interp;
 148 };
 149
 150 class EqualPowerStereoPanner : public BaseStereoPanner
 151 {
 152   public:
 153         EqualPowerStereoPanner (Panner&, Evoral::Parameter param);
 154         ~EqualPowerStereoPanner ();
 155
 156         void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
 157                                       nframes_t start, nframes_t end, nframes_t nframes,
 158                                       pan_t** buffers);
 159
 160         void get_current_coefficients (pan_t*) const;
 161         void get_desired_coefficients (pan_t*) const;
 162
 163         static StreamPanner* factory (Panner&, Evoral::Parameter param, Speakers&);
 164         static std::string name;
 165
 166         XMLNode& state (bool full_state);
 167         XMLNode& get_state (void);
 168         int      set_state (const XMLNode&, int version);
 169
 170   private:
 171         void update ();
 172 };
 173
 174 /** Class to pan from some number of inputs to some number of outputs.
 175  *  This class has a number of StreamPanners, one for each input.
 176  */
 177 class Panner : public SessionObject, public Automatable
 178 {
 179 public:
 180         struct Output {
 181             PBD::AngularVector position;
 182             pan_t current_pan;
 183             pan_t desired_pan;
 184
 185             Output (const PBD::AngularVector& a)
 186             : position (a), current_pan (0), desired_pan (0) {}
 187
 188         };
 189
 190         Panner (std::string name, Session&);
 191         virtual ~Panner ();
 192
 193         void clear_panners ();
 194         bool empty() const { return _streampanners.empty(); }
 195
 196         void set_automation_state (AutoState);
 197         AutoState automation_state() const;
 198         void set_automation_style (AutoStyle);
 199         AutoStyle automation_style() const;
 200         bool touching() const;
 201
 202         bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return true; };
 203
 204         /// The fundamental Panner function
 205         void run (BufferSet& src, BufferSet& dest, framepos_t start_frame, framepos_t end_frames, nframes_t nframes);
 206
 207         bool bypassed() const { return _bypassed; }
 208         void set_bypassed (bool yn);
 209         bool mono () const { return _mono; }
 210         void set_mono (bool);
 211
 212         StreamPanner* add ();
 213         void remove (uint32_t which);
 214         void reset (uint32_t noutputs, uint32_t npans);
 215         void reset_streampanner (uint32_t which_panner);
 216         void reset_to_default ();
 217
 218         XMLNode& get_state (void);
 219         XMLNode& state (bool full);
 220         int      set_state (const XMLNode&, int version);
 221
 222         static bool equivalent (pan_t a, pan_t b) {
 223                 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
 224         }
 225         static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
 226                 /* XXX azimuth only, at present */
 227                 return fabs (a.azi - b.azi) < 1.0;
 228         }
 229
 230         void move_output (uint32_t, float x, float y);
 231         uint32_t nouts() const { return outputs.size(); }
 232         Output& output (uint32_t n) { return outputs[n]; }
 233
 234         enum LinkDirection {
 235                 SameDirection,
 236                 OppositeDirection
 237         };
 238
 239         LinkDirection link_direction() const { return _link_direction; }
 240         void set_link_direction (LinkDirection);
 241
 242         bool linked() const { return _linked; }
 243         void set_linked (bool yn);
 244
 245         StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; }
 246         uint32_t npanners() const { return _streampanners.size(); }
 247
 248         PBD::Signal0<void> Changed; /* panner and/or outputs count changed */
 249         PBD::Signal0<void> LinkStateChanged;
 250         PBD::Signal0<void> StateChanged; /* for bypass */
 251
 252         /* only StreamPanner should call these */
 253
 254         void set_position (const PBD::AngularVector&, StreamPanner& orig);
 255
 256         /* old school automation */
 257
 258         int load ();
 259
 260         struct PanControllable : public AutomationControl {
 261                 PanControllable (Session& s, std::string name, Panner& p, Evoral::Parameter param)
 262                         : AutomationControl (s, param,
 263                                         boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
 264                         , panner (p)
 265                 { assert(param.type() != NullAutomation); }
 266
 267                 AutomationList* alist() { return (AutomationList*)_list.get(); }
 268                 Panner& panner;
 269
 270                 void set_value (double);
 271                 double get_value (void) const;
 272         };
 273
 274         boost::shared_ptr<AutomationControl> pan_control (int id, int chan=0) {
 275                 return automation_control (Evoral::Parameter (PanAutomation, chan, id));
 276         }
 277
 278         boost::shared_ptr<const AutomationControl> pan_control (int id, int chan=0) const {
 279                 return automation_control (Evoral::Parameter (PanAutomation, chan, id));
 280         }
 281
 282         static std::string value_as_string (double);
 283
 284   private:
 285         /* disallow copy construction */
 286         Panner (Panner const &);
 287
 288         void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, gain_t gain_coeff);
 289         std::vector<StreamPanner*> _streampanners; ///< one StreamPanner per input
 290         std::vector<Output> outputs;
 291         uint32_t     current_outs;
 292         bool             _linked;
 293         bool             _bypassed;
 294         bool             _mono;
 295         LinkDirection    _link_direction;
 296
 297         static float current_automation_version_number;
 298
 299         void setup_speakers (uint32_t nouts);
 300
 301         /* old school automation handling */
 302
 303         std::string automation_path;
 304 };
 305
 306 } // namespace ARDOUR
 307
 308 #endif /*__ardour_panner_h__ */