Respond to MMC even when synced to JACK. Fixes #3700.
[ardour.git] / libs / ardour / ardour / panner.h
index 62512f6181c1b0f8211525ff22944e43bde6e9c8..b07167862e038a4ca721f5b7b9d7d62566c693eb 100644 (file)
@@ -28,6 +28,7 @@
 
 #include "pbd/stateful.h"
 #include "pbd/controllable.h"
+#include "pbd/cartesian.h"
 
 #include "ardour/types.h"
 #include "ardour/automation_control.h"
@@ -39,6 +40,7 @@ class Session;
 class Panner;
 class BufferSet;
 class AudioBuffer;
+class Speakers;
 
 class StreamPanner : public PBD::Stateful
 {
@@ -49,20 +51,13 @@ class StreamPanner : public PBD::Stateful
        void set_muted (bool yn);
        bool muted() const { return _muted; }
 
-       void set_position (float x, bool link_call = false);
-       void set_position (float x, float y, bool link_call = false);
-       void set_position (float x, float y, float z, bool link_call = false);
+       const PBD::AngularVector& get_position() const { return _angles; }
+       const PBD::AngularVector& get_effective_position() const { return _effective_angles; }
+       void set_position (const PBD::AngularVector&, bool link_call = false);
+       void set_diffusion (double);
 
-       void get_position (float& xpos) const { xpos = _x; }
-       void get_position (float& xpos, float& ypos) const { xpos = _x; ypos = _y; }
-       void get_position (float& xpos, float& ypos, float& zpos) const { xpos = _x; ypos = _y; zpos = _z; }
-
-       void get_effective_position (float& xpos) const { xpos = effective_x; }
-       void get_effective_position (float& xpos, float& ypos) const { xpos = effective_x; ypos = effective_y; }
-       void get_effective_position (float& xpos, float& ypos, float& zpos) const { xpos = effective_x; ypos = effective_y; zpos = effective_z; }
-
-       void distribute (AudioBuffer &, BufferSet &, gain_t, nframes_t);
-       void distribute_automated (AudioBuffer &, BufferSet &, nframes_t, nframes_t, nframes_t, pan_t **);
+       void distribute (AudioBuffer &, BufferSet &, gain_t, pframes_t);
+       void distribute_automated (AudioBuffer &, BufferSet &, framepos_t, framepos_t, pframes_t, pan_t **);
 
        /* the basic StreamPanner API */
 
@@ -74,13 +69,14 @@ class StreamPanner : public PBD::Stateful
         *  @param gain_coeff Gain coefficient to apply to output samples.
         *  @param nframes Number of frames in the input.
         */
-       virtual void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
+       virtual void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes) = 0;
        virtual void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                             nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers) = 0;
+                                             framepos_t start, framepos_t end, pframes_t nframes,
+                                             pan_t** buffers) = 0;
 
        boost::shared_ptr<AutomationControl> pan_control()  { return _control; }
 
-       PBD::Signal0<void> Changed;      /* for position */
+       PBD::Signal0<void> Changed;      /* for position or diffusion */
        PBD::Signal0<void> StateChanged; /* for mute, mono */
 
        int set_state (const XMLNode&, int version);
@@ -91,32 +87,39 @@ class StreamPanner : public PBD::Stateful
        /* old school automation loading */
        virtual int load (std::istream&, std::string path, uint32_t&) = 0;
 
+       struct PanControllable : public AutomationControl {
+               PanControllable (Session& s, std::string name, StreamPanner* p, Evoral::Parameter param)
+                       : AutomationControl (s, param,
+                                             boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
+                       , streampanner (p)
+               { assert (param.type() == PanAutomation); }
+                
+               AutomationList* alist() { return (AutomationList*)_list.get(); }
+               StreamPanner* streampanner;
+
+               void set_value (double);
+               double get_value (void) const;
+                double lower () const;
+       };
+
   protected:
        friend class Panner;
        Panner& parent;
 
        void set_mono (bool);
        
-       float _x;
-       float _y;
-       float _z;
-
-       /* these are for automation. they store the last value
-          used by the most recent process() cycle.
-       */
-
-       float effective_x;
-       float effective_y;
-       float effective_z;
+       PBD::AngularVector _angles;
+       PBD::AngularVector _effective_angles;
+       double        _diffusion; 
 
        bool _muted;
        bool _mono;
-
+        
        boost::shared_ptr<AutomationControl> _control;
 
-       void add_state (XMLNode&);
+       XMLNode& get_state ();
 
-       /* Update internal parameters based on _x, _y and _z */
+       /* Update internal parameters based on this.angles */
        virtual void update () = 0;
 };
 
@@ -132,8 +135,30 @@ class BaseStereoPanner : public StreamPanner
           and a type name. See EqualPowerStereoPanner as an example.
        */
 
-       void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
+       void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
+
+       static double azimuth_to_lr_fract (double azi) { 
+               /* 180.0 degrees=> left => 0.0 */
+               /* 0.0 degrees => right => 1.0 */
 
+                /* humans can only distinguish 1 degree of arc between two positions,
+                   so force azi back to an integral value before computing
+                */
+
+               return 1.0 - (rint(azi)/180.0);
+       }
+
+       static double lr_fract_to_azimuth (double fract) { 
+               /* fract = 0.0 => degrees = 180.0 => left */
+               /* fract = 1.0 => degrees = 0.0 => right */
+
+                /* humans can only distinguish 1 degree of arc between two positions,
+                   so force azi back to an integral value after computing
+                */
+
+               return rint (180.0 - (fract * 180.0));
+       }
+       
        /* old school automation loading */
 
        int load (std::istream&, std::string path, uint32_t&);
@@ -154,12 +179,13 @@ class EqualPowerStereoPanner : public BaseStereoPanner
        ~EqualPowerStereoPanner ();
 
        void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                     nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
+                                     framepos_t start, framepos_t end, pframes_t nframes,
+                                     pan_t** buffers);
 
        void get_current_coefficients (pan_t*) const;
        void get_desired_coefficients (pan_t*) const;
 
-       static StreamPanner* factory (Panner&, Evoral::Parameter param);
+       static StreamPanner* factory (Panner&, Evoral::Parameter param, Speakers&);
        static std::string name;
 
        XMLNode& state (bool full_state); 
@@ -170,32 +196,6 @@ class EqualPowerStereoPanner : public BaseStereoPanner
        void update ();
 };
 
-class Multi2dPanner : public StreamPanner
-{
-  public:
-       Multi2dPanner (Panner& parent, Evoral::Parameter);
-       ~Multi2dPanner ();
-
-       void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
-       void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                     nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
-
-       static StreamPanner* factory (Panner&, Evoral::Parameter);
-       static std::string name;
-
-       XMLNode& state (bool full_state);
-       XMLNode& get_state (void);
-       int set_state (const XMLNode&, int version);
-
-       /* old school automation loading */
-
-       int load (std::istream&, std::string path, uint32_t&);
-
-  private:
-       void update ();
-};
-
-
 /** Class to pan from some number of inputs to some number of outputs.
  *  This class has a number of StreamPanners, one for each input.
  */
@@ -203,13 +203,12 @@ class Panner : public SessionObject, public Automatable
 {
 public:
        struct Output {
-               float x;
-               float y;
-               pan_t current_pan;
-               pan_t desired_pan;
-
-               Output (float xp, float yp)
-                       : x (xp), y (yp), current_pan (0), desired_pan (0) {}
+            PBD::AngularVector position;
+            pan_t current_pan;
+            pan_t desired_pan;
+            
+            Output (const PBD::AngularVector& a) 
+            : position (a), current_pan (0), desired_pan (0) {}
 
        };
 
@@ -225,10 +224,12 @@ public:
        AutoStyle automation_style() const;
        bool touching() const;
 
+       std::string describe_parameter (Evoral::Parameter param);
+
        bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return true; };
 
        /// The fundamental Panner function
-       void run (BufferSet& src, BufferSet& dest, sframes_t start_frame, sframes_t end_frames, nframes_t nframes);
+       void run (BufferSet& src, BufferSet& dest, framepos_t start_frame, framepos_t end_frames, pframes_t nframes);
 
        bool bypassed() const { return _bypassed; }
        void set_bypassed (bool yn);
@@ -248,6 +249,10 @@ public:
        static bool equivalent (pan_t a, pan_t b) {
                return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
        }
+       static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
+                /* XXX azimuth only, at present */
+               return fabs (a.azi - b.azi) < 1.0;
+       }
 
        void move_output (uint32_t, float x, float y);
        uint32_t nouts() const { return outputs.size(); }
@@ -273,43 +278,39 @@ public:
 
        /* only StreamPanner should call these */
 
-       void set_position (float x, StreamPanner& orig);
-       void set_position (float x, float y, StreamPanner& orig);
-       void set_position (float x, float y, float z, StreamPanner& orig);
+       void set_position (const PBD::AngularVector&, StreamPanner& orig);
 
        /* old school automation */
 
        int load ();
 
-       struct PanControllable : public AutomationControl {
-               PanControllable (Session& s, std::string name, Panner& p, Evoral::Parameter param)
-                       : AutomationControl (s, param,
-                                       boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
-                       , panner (p)
-               { assert(param.type() != NullAutomation); }
-
-               AutomationList* alist() { return (AutomationList*)_list.get(); }
-               Panner& panner;
-
-               void set_value (double);
-               double get_value (void) const;
-       };
-
-       boost::shared_ptr<AutomationControl> pan_control (int id, int chan=0) {
+       boost::shared_ptr<AutomationControl> pan_control (int id, uint32_t chan=0) {
                return automation_control (Evoral::Parameter (PanAutomation, chan, id));
        }
 
-       boost::shared_ptr<const AutomationControl> pan_control (int id, int chan=0) const {
+       boost::shared_ptr<const AutomationControl> pan_control (int id, uint32_t chan=0) const {
                return automation_control (Evoral::Parameter (PanAutomation, chan, id));
        }
 
-       static std::string value_as_string (double);
+       boost::shared_ptr<AutomationControl> direction_control () {
+               return automation_control (Evoral::Parameter (PanAutomation, 0, 100));
+       }
 
+       boost::shared_ptr<AutomationControl> width_control () {
+               return automation_control (Evoral::Parameter (PanAutomation, 0, 200));
+       }
+
+        void set_stereo_position (double);
+        void set_stereo_width (double);
+        bool set_stereo_pan (double pos, double width);
+        
+       static std::string value_as_string (double);
+        
   private:
        /* disallow copy construction */
        Panner (Panner const &);
 
-       void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, gain_t gain_coeff);
+       void distribute_no_automation(BufferSet& src, BufferSet& dest, pframes_t nframes, gain_t gain_coeff);
        std::vector<StreamPanner*> _streampanners; ///< one StreamPanner per input
        std::vector<Output> outputs;
        uint32_t     current_outs;
@@ -320,6 +321,9 @@ public:
 
        static float current_automation_version_number;
 
+       void setup_speakers (uint32_t nouts);
+        void setup_meta_controls ();
+
        /* old school automation handling */
 
        std::string automation_path;