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         struct PanControllable : public AutomationControl {
  91                 PanControllable (Session& s, std::string name, StreamPanner& p, Evoral::Parameter param)
  92                         : AutomationControl (s, param,
  93                                              boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
  94                         , streampanner (p)
  95                 { assert(param.type() != NullAutomation); }
  96
  97                 AutomationList* alist() { return (AutomationList*)_list.get(); }
  98                 StreamPanner& streampanner;
  99
 100                 void set_value (double);
 101                 double get_value (void) const;
 102         };
 103
 104   protected:
 105         friend class Panner;
 106         Panner& parent;
 107
 108         void set_mono (bool);
 109
 110         PBD::AngularVector _angles;
 111         PBD::AngularVector _effective_angles;
 112         double        _diffusion;
 113
 114         bool _muted;
 115         bool _mono;
 116
 117         boost::shared_ptr<AutomationControl> _control;
 118
 119         XMLNode& get_state ();
 120
 121         /* Update internal parameters based on this.angles */
 122         virtual void update () = 0;
 123 };
 124
 125 class BaseStereoPanner : public StreamPanner
 126 {
 127   public:
 128         BaseStereoPanner (Panner&, Evoral::Parameter param);
 129         ~BaseStereoPanner ();
 130
 131         /* this class just leaves the pan law itself to be defined
 132            by the update(), do_distribute_automated()
 133            methods. derived classes also need a factory method
 134            and a type name. See EqualPowerStereoPanner as an example.
 135         */
 136
 137         void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 138
 139         static double azimuth_to_lr_fract (double azi) {
 140                 /* 180.0 degrees=> left => 0.0 */
 141                 /* 0.0 degrees => right => 1.0 */
 142                 return 1.0 - (azi/180.0);
 143         }
 144
 145         static double lr_fract_to_azimuth (double fract) {
 146                 /* fract = 0.0 => degrees = 180.0 => left */
 147                 /* fract = 1.0 => degrees = 0.0 => right */
 148                 return 180.0 - (fract * 180.0);
 149         }
 150
 151         /* old school automation loading */
 152
 153         int load (std::istream&, std::string path, uint32_t&);
 154
 155   protected:
 156         float left;
 157         float right;
 158         float desired_left;
 159         float desired_right;
 160         float left_interp;
 161         float right_interp;
 162 };
 163
 164 class EqualPowerStereoPanner : public BaseStereoPanner
 165 {
 166   public:
 167         EqualPowerStereoPanner (Panner&, Evoral::Parameter param);
 168         ~EqualPowerStereoPanner ();
 169
 170         void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
 171                                       nframes_t start, nframes_t end, nframes_t nframes,
 172                                       pan_t** buffers);
 173
 174         void get_current_coefficients (pan_t*) const;
 175         void get_desired_coefficients (pan_t*) const;
 176
 177         static StreamPanner* factory (Panner&, Evoral::Parameter param, Speakers&);
 178         static std::string name;
 179
 180         XMLNode& state (bool full_state);
 181         XMLNode& get_state (void);
 182         int      set_state (const XMLNode&, int version);
 183
 184   private:
 185         void update ();
 186 };
 187
 188 /** Class to pan from some number of inputs to some number of outputs.
 189  *  This class has a number of StreamPanners, one for each input.
 190  */
 191 class Panner : public SessionObject, public Automatable
 192 {
 193 public:
 194         struct Output {
 195             PBD::AngularVector position;
 196             pan_t current_pan;
 197             pan_t desired_pan;
 198
 199             Output (const PBD::AngularVector& a)
 200             : position (a), current_pan (0), desired_pan (0) {}
 201
 202         };
 203
 204         Panner (std::string name, Session&);
 205         virtual ~Panner ();
 206
 207         void clear_panners ();
 208         bool empty() const { return _streampanners.empty(); }
 209
 210         void set_automation_state (AutoState);
 211         AutoState automation_state() const;
 212         void set_automation_style (AutoStyle);
 213         AutoStyle automation_style() const;
 214         bool touching() const;
 215
 216         bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return true; };
 217
 218         /// The fundamental Panner function
 219         void run (BufferSet& src, BufferSet& dest, framepos_t start_frame, framepos_t end_frames, nframes_t nframes);
 220
 221         bool bypassed() const { return _bypassed; }
 222         void set_bypassed (bool yn);
 223         bool mono () const { return _mono; }
 224         void set_mono (bool);
 225
 226         StreamPanner* add ();
 227         void remove (uint32_t which);
 228         void reset (uint32_t noutputs, uint32_t npans);
 229         void reset_streampanner (uint32_t which_panner);
 230         void reset_to_default ();
 231
 232         XMLNode& get_state (void);
 233         XMLNode& state (bool full);
 234         int      set_state (const XMLNode&, int version);
 235
 236         static bool equivalent (pan_t a, pan_t b) {
 237                 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
 238         }
 239         static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
 240                 /* XXX azimuth only, at present */
 241                 return fabs (a.azi - b.azi) < 1.0;
 242         }
 243
 244         void move_output (uint32_t, float x, float y);
 245         uint32_t nouts() const { return outputs.size(); }
 246         Output& output (uint32_t n) { return outputs[n]; }
 247
 248         enum LinkDirection {
 249                 SameDirection,
 250                 OppositeDirection
 251         };
 252
 253         LinkDirection link_direction() const { return _link_direction; }
 254         void set_link_direction (LinkDirection);
 255
 256         bool linked() const { return _linked; }
 257         void set_linked (bool yn);
 258
 259         StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; }
 260         uint32_t npanners() const { return _streampanners.size(); }
 261
 262         PBD::Signal0<void> Changed; /* panner and/or outputs count changed */
 263         PBD::Signal0<void> LinkStateChanged;
 264         PBD::Signal0<void> StateChanged; /* for bypass */
 265
 266         /* only StreamPanner should call these */
 267
 268         void set_position (const PBD::AngularVector&, StreamPanner& orig);
 269
 270         /* old school automation */
 271
 272         int load ();
 273
 274         boost::shared_ptr<AutomationControl> pan_control (int id, uint32_t chan=0) {
 275                 return automation_control (Evoral::Parameter (PanAutomation, chan, id));
 276         }
 277
 278         boost::shared_ptr<const AutomationControl> pan_control (int id, uint32_t 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__ */