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 <vector>
  25 #include <string>
  26 #include <iostream>
  27 #include <sigc++/signal.h>
  28
  29 #include <pbd/stateful.h>
  30 #include <pbd/controllable.h>
  31
  32 #include <ardour/types.h>
  33 #include <ardour/curve.h>
  34 #include <ardour/automation_control.h>
  35
  36 using std::istream;
  37 using std::ostream;
  38
  39 namespace ARDOUR {
  40
  41 class Session;
  42 class Panner;
  43 class BufferSet;
  44 class AudioBuffer;
  45
  46 class StreamPanner : public sigc::trackable, public PBD::Stateful
  47 {
  48   public:
  49         StreamPanner (Panner& p);
  50         ~StreamPanner ();
  51
  52         void set_muted (bool yn);
  53         bool muted() const { return _muted; }
  54
  55         void set_position (float x, bool link_call = false);
  56         void set_position (float x, float y, bool link_call = false);
  57         void set_position (float x, float y, float z, bool link_call = false);
  58
  59         void get_position (float& xpos) const { xpos = x; }
  60         void get_position (float& xpos, float& ypos) const { xpos = x; ypos = y; }
  61         void get_position (float& xpos, float& ypos, float& zpos) const { xpos = x; ypos = y; zpos = z; }
  62
  63         void get_effective_position (float& xpos) const { xpos = effective_x; }
  64         void get_effective_position (float& xpos, float& ypos) const { xpos = effective_x; ypos = effective_y; }
  65         void get_effective_position (float& xpos, float& ypos, float& zpos) const { xpos = effective_x; ypos = effective_y; zpos = effective_z; }
  66
  67         /* the basic StreamPanner API */
  68
  69         virtual void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
  70         virtual void distribute_automated (AudioBuffer& src, BufferSet& obufs,
  71                                      nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers) = 0;
  72
  73         boost::shared_ptr<AutomationControl> pan_control()  { return _control; }
  74
  75         sigc::signal<void> Changed;      /* for position */
  76         sigc::signal<void> StateChanged; /* for mute */
  77
  78         int set_state (const XMLNode&);
  79         virtual XMLNode& state (bool full_state) = 0;
  80
  81         Panner & get_parent() { return parent; }
  82
  83         /* old school automation loading */
  84
  85         virtual int load (istream&, string path, uint32_t&) = 0;
  86
  87   protected:
  88         friend class Panner;
  89         Panner& parent;
  90
  91         float x;
  92         float y;
  93         float z;
  94
  95         /* these are for automation. they store the last value
  96            used by the most recent process() cycle.
  97         */
  98
  99         float effective_x;
 100         float effective_y;
 101         float effective_z;
 102
 103         bool             _muted;
 104
 105         struct PanControllable : public AutomationControl {
 106             PanControllable (Session& s, std::string name, StreamPanner& p)
 107                         : AutomationControl (s, boost::shared_ptr<AutomationList>(new AutomationList(
 108                                                 ParamID(PanAutomation), 0.0, 1.0, 0.5)), name)
 109                         , panner (p) {}
 110
 111             StreamPanner& panner;
 112
 113             void set_value (float);
 114             float get_value (void) const;
 115             bool can_send_feedback() const;
 116         };
 117
 118         boost::shared_ptr<PanControllable> _control;
 119
 120         void add_state (XMLNode&);
 121         virtual void update () = 0;
 122 };
 123
 124 class BaseStereoPanner : public StreamPanner
 125 {
 126   public:
 127         BaseStereoPanner (Panner&);
 128         ~BaseStereoPanner ();
 129
 130         /* this class just leaves the pan law itself to be defined
 131            by the update(), distribute_automated()
 132            methods. derived classes also need a factory method
 133            and a type name. See EqualPowerStereoPanner as an example.
 134         */
 135
 136         void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 137
 138         /* old school automation loading */
 139
 140         int load (istream&, string path, uint32_t&);
 141
 142   protected:
 143         float left;
 144         float right;
 145         float desired_left;
 146         float desired_right;
 147         float left_interp;
 148         float right_interp;
 149 };
 150
 151 class EqualPowerStereoPanner : public BaseStereoPanner
 152 {
 153   public:
 154         EqualPowerStereoPanner (Panner&);
 155         ~EqualPowerStereoPanner ();
 156
 157         void distribute_automated (AudioBuffer& src, BufferSet& obufs,
 158                              nframes_t start, nframes_t end, nframes_t nframes, 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&);
 164         static string name;
 165
 166         XMLNode& state (bool full_state);
 167         XMLNode& get_state (void);
 168         int      set_state (const XMLNode&);
 169
 170   private:
 171         void update ();
 172 };
 173
 174 class Multi2dPanner : public StreamPanner
 175 {
 176   public:
 177         Multi2dPanner (Panner& parent);
 178         ~Multi2dPanner ();
 179
 180         void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 181         void distribute_automated (AudioBuffer& src, BufferSet& obufs,
 182                                    nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
 183
 184         static StreamPanner* factory (Panner&);
 185         static string name;
 186
 187         XMLNode& state (bool full_state);
 188         XMLNode& get_state (void);
 189         int set_state (const XMLNode&);
 190
 191         /* old school automation loading */
 192
 193         int load (istream&, string path, uint32_t&);
 194
 195   private:
 196         void update ();
 197 };
 198
 199 class Panner : public std::vector<StreamPanner*>, public PBD::Stateful, public sigc::trackable
 200 {
 201   public:
 202         struct Output {
 203             float x;
 204             float y;
 205             pan_t current_pan;
 206             pan_t desired_pan;
 207
 208             Output (float xp, float yp)
 209                     : x (xp), y (yp), current_pan (0.0f), desired_pan (0.f) {}
 210
 211         };
 212
 213         Panner (string name, Session&);
 214         virtual ~Panner ();
 215
 216         /// The fundamental Panner function
 217         void distribute(BufferSet& src, BufferSet& dest, nframes_t start_frame, nframes_t end_frames, nframes_t nframes, nframes_t offset);
 218
 219         bool bypassed() const { return _bypassed; }
 220         void set_bypassed (bool yn);
 221
 222         StreamPanner* add ();
 223         void remove (uint32_t which);
 224         void clear ();
 225         void reset (uint32_t noutputs, uint32_t npans);
 226
 227         void snapshot (nframes_t now);
 228         void transport_stopped (nframes_t frame);
 229
 230         void clear_automation ();
 231
 232         void set_automation_state (AutoState);
 233         AutoState automation_state() const;
 234         void set_automation_style (AutoStyle);
 235         AutoStyle automation_style() const;
 236         bool touching() const;
 237
 238         XMLNode& get_state (void);
 239         XMLNode& state (bool full);
 240         int      set_state (const XMLNode&);
 241
 242         sigc::signal<void> Changed;
 243
 244         static bool equivalent (pan_t a, pan_t b) {
 245                 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
 246         }
 247
 248         void move_output (uint32_t, float x, float y);
 249         uint32_t nouts() const { return outputs.size(); }
 250         Output& output (uint32_t n) { return outputs[n]; }
 251
 252         std::vector<Output> outputs;
 253         Session& session() const { return _session; }
 254
 255         enum LinkDirection {
 256                 SameDirection,
 257                 OppositeDirection
 258         };
 259
 260         LinkDirection link_direction() const { return _link_direction; }
 261         void set_link_direction (LinkDirection);
 262
 263         bool linked() const { return _linked; }
 264         void set_linked (bool yn);
 265
 266         sigc::signal<void> LinkStateChanged;
 267         sigc::signal<void> StateChanged; /* for bypass */
 268
 269         /* only StreamPanner should call these */
 270
 271         void set_position (float x, StreamPanner& orig);
 272         void set_position (float x, float y, StreamPanner& orig);
 273         void set_position (float x, float y, float z, StreamPanner& orig);
 274
 275         /* old school automation */
 276
 277         int load ();
 278
 279   private:
 280         void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, nframes_t offset, gain_t gain_coeff);
 281
 282         Session&         _session;
 283         uint32_t     current_outs;
 284         bool             _linked;
 285         bool             _bypassed;
 286         LinkDirection    _link_direction;
 287
 288         static float current_automation_version_number;
 289
 290         /* old school automation handling */
 291
 292         std::string automation_path;
 293         void set_name (std::string);
 294 };
 295
 296 } // namespace ARDOUR
 297
 298 #endif /*__ardour_panner_h__ */