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     $Id$
  19 */
  20
  21 #ifndef __ardour_panner_h__
  22 #define __ardour_panner_h__
  23
  24 #include <cmath>
  25 #include <vector>
  26 #include <string>
  27 #include <iostream>
  28 #include <sigc++/signal.h>
  29
  30 #include <pbd/stateful.h>
  31 #include <pbd/controllable.h>
  32
  33 #include <ardour/types.h>
  34 #include <ardour/curve.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 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         /* automation */
  74
  75         virtual void snapshot (nframes_t now) = 0;
  76         virtual void transport_stopped (nframes_t frame) = 0;
  77         virtual void set_automation_state (AutoState) = 0;
  78         virtual void set_automation_style (AutoStyle) = 0;
  79
  80         PBD::Controllable& control()  { return _control; }
  81
  82         /* XXX this is wrong. for multi-dimensional panners, there
  83            must surely be more than 1 automation curve.
  84         */
  85
  86         virtual Curve& automation() = 0;
  87
  88         virtual int load (istream&, string path, uint32_t&) = 0;
  89
  90         virtual int save (ostream&) const = 0;
  91
  92         sigc::signal<void> Changed;      /* for position */
  93         sigc::signal<void> StateChanged; /* for mute */
  94
  95         int set_state (const XMLNode&);
  96         virtual XMLNode& state (bool full_state) = 0;
  97
  98         Panner & get_parent() { return parent; }
  99
 100   protected:
 101         friend class Panner;
 102         Panner& parent;
 103
 104         float x;
 105         float y;
 106         float z;
 107
 108         /* these are for automation. they store the last value
 109            used by the most recent process() cycle.
 110         */
 111
 112         float effective_x;
 113         float effective_y;
 114         float effective_z;
 115
 116         bool             _muted;
 117
 118         struct PanControllable : public PBD::Controllable {
 119             PanControllable (std::string name, StreamPanner& p) : Controllable (name), panner (p) {}
 120
 121             StreamPanner& panner;
 122
 123             void set_value (float);
 124             float get_value (void) const;
 125             bool can_send_feedback() const;
 126         };
 127
 128         PanControllable  _control;
 129
 130         void add_state (XMLNode&);
 131         virtual void update () = 0;
 132 };
 133
 134 class BaseStereoPanner : public StreamPanner
 135 {
 136   public:
 137         BaseStereoPanner (Panner&);
 138         ~BaseStereoPanner ();
 139
 140         /* this class just leaves the pan law itself to be defined
 141            by the update(), distribute_automated()
 142            methods. derived classes also need a factory method
 143            and a type name. See EqualPowerStereoPanner as an example.
 144         */
 145
 146         void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 147
 148         int load (istream&, string path, uint32_t&);
 149         int save (ostream&) const;
 150         void snapshot (nframes_t now);
 151         void transport_stopped (nframes_t frame);
 152         void set_automation_state (AutoState);
 153         void set_automation_style (AutoStyle);
 154
 155         Curve& automation() { return _automation; }
 156
 157   protected:
 158         float left;
 159         float right;
 160         float desired_left;
 161         float desired_right;
 162         float left_interp;
 163         float right_interp;
 164
 165         Curve  _automation;
 166 };
 167
 168 class EqualPowerStereoPanner : public BaseStereoPanner
 169 {
 170   public:
 171         EqualPowerStereoPanner (Panner&);
 172         ~EqualPowerStereoPanner ();
 173
 174         void distribute_automated (AudioBuffer& src, BufferSet& obufs,
 175                              nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
 176
 177         void get_current_coefficients (pan_t*) const;
 178         void get_desired_coefficients (pan_t*) const;
 179
 180         static StreamPanner* factory (Panner&);
 181         static string name;
 182
 183         XMLNode& state (bool full_state);
 184         XMLNode& get_state (void);
 185         int      set_state (const XMLNode&);
 186
 187   private:
 188         void update ();
 189 };
 190
 191 class Multi2dPanner : public StreamPanner
 192 {
 193   public:
 194         Multi2dPanner (Panner& parent);
 195         ~Multi2dPanner ();
 196
 197         void snapshot (nframes_t now);
 198         void transport_stopped (nframes_t frame);
 199         void set_automation_state (AutoState);
 200         void set_automation_style (AutoStyle);
 201
 202         /* XXX this is wrong. for multi-dimensional panners, there
 203            must surely be more than 1 automation curve.
 204         */
 205
 206         Curve& automation() { return _automation; }
 207
 208         void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
 209         void distribute_automated (AudioBuffer& src, BufferSet& obufs,
 210                              nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
 211
 212         int load (istream&, string path, uint32_t&);
 213         int save (ostream&) const;
 214
 215         static StreamPanner* factory (Panner&);
 216         static string name;
 217
 218         XMLNode& state (bool full_state);
 219         XMLNode& get_state (void);
 220         int set_state (const XMLNode&);
 221
 222   private:
 223         Curve _automation;
 224         void update ();
 225 };
 226
 227 class Panner : public std::vector<StreamPanner*>, public Stateful, public sigc::trackable
 228 {
 229   public:
 230         struct Output {
 231             float x;
 232             float y;
 233             pan_t current_pan;
 234             pan_t desired_pan;
 235
 236             Output (float xp, float yp)
 237                     : x (xp), y (yp), current_pan (0.0f), desired_pan (0.f) {}
 238
 239         };
 240
 241         Panner (string name, Session&);
 242         virtual ~Panner ();
 243
 244         /// The fundamental Panner function
 245         void distribute(BufferSet& src, BufferSet& dest, nframes_t start_frame, nframes_t end_frames, nframes_t nframes, nframes_t offset);
 246
 247         void set_name (string);
 248
 249         bool bypassed() const { return _bypassed; }
 250         void set_bypassed (bool yn);
 251
 252         StreamPanner* add ();
 253         void remove (uint32_t which);
 254         void clear ();
 255         void reset (uint32_t noutputs, uint32_t npans);
 256
 257         void snapshot (nframes_t now);
 258         void transport_stopped (nframes_t frame);
 259
 260         void clear_automation ();
 261
 262         void set_automation_state (AutoState);
 263         AutoState automation_state() const;
 264         void set_automation_style (AutoStyle);
 265         AutoStyle automation_style() const;
 266         bool touching() const;
 267
 268         int load ();
 269         int save () const;
 270
 271         XMLNode& get_state (void);
 272         XMLNode& state (bool full);
 273         int      set_state (const XMLNode&);
 274
 275         sigc::signal<void> Changed;
 276
 277         static bool equivalent (pan_t a, pan_t b) {
 278                 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
 279         }
 280
 281         void move_output (uint32_t, float x, float y);
 282         uint32_t nouts() const { return outputs.size(); }
 283         Output& output (uint32_t n) { return outputs[n]; }
 284
 285         std::vector<Output> outputs;
 286         Session& session() const { return _session; }
 287
 288         enum LinkDirection {
 289                 SameDirection,
 290                 OppositeDirection
 291         };
 292
 293         LinkDirection link_direction() const { return _link_direction; }
 294         void set_link_direction (LinkDirection);
 295
 296         bool linked() const { return _linked; }
 297         void set_linked (bool yn);
 298
 299         sigc::signal<void> LinkStateChanged;
 300         sigc::signal<void> StateChanged; /* for bypass */
 301
 302         /* only StreamPanner should call these */
 303
 304         void set_position (float x, StreamPanner& orig);
 305         void set_position (float x, float y, StreamPanner& orig);
 306         void set_position (float x, float y, float z, StreamPanner& orig);
 307
 308   private:
 309         void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, nframes_t offset, gain_t gain_coeff);
 310
 311
 312         string            automation_path;
 313         Session&         _session;
 314         uint32_t     current_outs;
 315         bool             _linked;
 316         bool             _bypassed;
 317         LinkDirection    _link_direction;
 318
 319         static float current_automation_version_number;
 320 };
 321
 322 } // namespace ARDOUR
 323
 324 #endif /*__ardour_panner_h__ */