Respond to MMC even when synced to JACK. Fixes #3700.
[ardour.git] / libs / ardour / ardour / panner.h
index 6cd3b0755d3286b9f712852ee46e1911919da603..b07167862e038a4ca721f5b7b9d7d62566c693eb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2004 Paul Davis 
+    Copyright (C) 2004 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <vector>
 #include <string>
 #include <iostream>
-#include <sigc++/signal.h>
 
-#include <pbd/stateful.h> 
-#include <pbd/controllable.h>
+#include "pbd/stateful.h"
+#include "pbd/controllable.h"
+#include "pbd/cartesian.h"
 
-#include <ardour/types.h>
-#include <ardour/automation_control.h>
-
-using std::istream;
-using std::ostream;
+#include "ardour/types.h"
+#include "ardour/automation_control.h"
+#include "ardour/processor.h"
 
 namespace ARDOUR {
 
@@ -42,103 +40,128 @@ class Session;
 class Panner;
 class BufferSet;
 class AudioBuffer;
+class Speakers;
 
-class StreamPanner : public sigc::trackable, public PBD::Stateful
+class StreamPanner : public PBD::Stateful
 {
   public:
-       StreamPanner (Panner& p, Parameter param);
+       StreamPanner (Panner& p, Evoral::Parameter param);
        ~StreamPanner ();
 
        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);
-
-       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; }
+       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_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, pframes_t);
+       void distribute_automated (AudioBuffer &, BufferSet &, framepos_t, framepos_t, pframes_t, pan_t **);
 
        /* the basic StreamPanner API */
 
-       virtual void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
-       virtual void distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                    nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers) = 0;
+       /**
+        *  Pan some input samples to a number of output buffers.
+        *
+        *  @param src Input buffer.
+        *  @param obufs Output buffers (one per panner output).
+        *  @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, pframes_t nframes) = 0;
+       virtual void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
+                                             framepos_t start, framepos_t end, pframes_t nframes,
+                                             pan_t** buffers) = 0;
 
        boost::shared_ptr<AutomationControl> pan_control()  { return _control; }
-       
-       sigc::signal<void> Changed;      /* for position */
-       sigc::signal<void> StateChanged; /* for mute */
 
-       int set_state (const XMLNode&);
+       PBD::Signal0<void> Changed;      /* for position or diffusion */
+       PBD::Signal0<void> StateChanged; /* for mute, mono */
+
+       int set_state (const XMLNode&, int version);
        virtual XMLNode& state (bool full_state) = 0;
-       
+
        Panner & get_parent() { return parent; }
 
        /* old school automation loading */
+       virtual int load (std::istream&, std::string path, uint32_t&) = 0;
 
-       virtual int load (istream&, 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;
 
-       float x;
-       float y;
-       float z;
+       void set_mono (bool);
        
-       /* 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;
 
-       struct PanControllable : public AutomationControl {
-           PanControllable (Session& s, std::string name, StreamPanner& p, 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(); }
-           StreamPanner& panner;
-           
-           void set_value (float);
-           float get_value (void) const;
-       };
+       XMLNode& get_state ();
 
-       boost::shared_ptr<PanControllable> _control;
-
-       void add_state (XMLNode&);
+       /* Update internal parameters based on this.angles */
        virtual void update () = 0;
 };
 
 class BaseStereoPanner : public StreamPanner
 {
   public:
-       BaseStereoPanner (Panner&, Parameter param);
+       BaseStereoPanner (Panner&, Evoral::Parameter param);
        ~BaseStereoPanner ();
 
        /* this class just leaves the pan law itself to be defined
-          by the update(), distribute_automated() 
+          by the update(), do_distribute_automated()
           methods. derived classes also need a factory method
           and a type name. See EqualPowerStereoPanner as an example.
        */
 
-       void 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 (istream&, string path, uint32_t&);
+       int load (std::istream&, std::string path, uint32_t&);
 
   protected:
        float left;
@@ -152,107 +175,89 @@ class BaseStereoPanner : public StreamPanner
 class EqualPowerStereoPanner : public BaseStereoPanner
 {
   public:
-       EqualPowerStereoPanner (Panner&, Parameter param);
+       EqualPowerStereoPanner (Panner&, Evoral::Parameter param);
        ~EqualPowerStereoPanner ();
 
-       void distribute_automated (AudioBuffer& src, BufferSet& obufs, 
-                            nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
+       void do_distribute_automated (AudioBuffer& src, BufferSet& obufs,
+                                     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&, Parameter param);
-       static string name;
+       static StreamPanner* factory (Panner&, Evoral::Parameter param, Speakers&);
+       static std::string name;
 
        XMLNode& state (bool full_state); 
        XMLNode& get_state (void); 
-       int      set_state (const XMLNode&);
+       int      set_state (const XMLNode&, int version);
 
   private:
        void update ();
 };
 
-class Multi2dPanner : public StreamPanner
+/** Class to pan from some number of inputs to some number of outputs.
+ *  This class has a number of StreamPanners, one for each input.
+ */
+class Panner : public SessionObject, public Automatable
 {
-  public:
-       Multi2dPanner (Panner& parent, Parameter);
-       ~Multi2dPanner ();
-
-       void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
-       void distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                  nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
-
-       static StreamPanner* factory (Panner&, Parameter);
-       static string name;
+public:
+       struct Output {
+            PBD::AngularVector position;
+            pan_t current_pan;
+            pan_t desired_pan;
+            
+            Output (const PBD::AngularVector& a) 
+            : position (a), current_pan (0), desired_pan (0) {}
 
-       XMLNode& state (bool full_state); 
-       XMLNode& get_state (void);
-       int set_state (const XMLNode&);
+       };
 
-       /* old school automation loading */
+       Panner (std::string name, Session&);
+       virtual ~Panner ();
 
-       int load (istream&, string path, uint32_t&);
+       void clear_panners ();
+       bool empty() const { return _streampanners.empty(); }
 
-  private:
-       void update ();
-};
+       void set_automation_state (AutoState);
+       AutoState automation_state() const;
+       void set_automation_style (AutoStyle);
+       AutoStyle automation_style() const;
+       bool touching() const;
 
-class Panner : public std::vector<StreamPanner*>, public PBD::Stateful, public sigc::trackable
-{
-  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.0f), desired_pan (0.f) {}
-                   
-       };
+       std::string describe_parameter (Evoral::Parameter param);
 
-       Panner (string name, Session&);
-       virtual ~Panner ();
+       bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) const { return true; };
 
        /// The fundamental Panner function
-       void distribute(BufferSet& src, BufferSet& dest, nframes_t start_frame, nframes_t end_frames, nframes_t nframes, nframes_t offset);
+       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);
+       bool mono () const { return _mono; }
+       void set_mono (bool);
 
        StreamPanner* add ();
        void remove (uint32_t which);
-       void clear ();
        void reset (uint32_t noutputs, uint32_t npans);
-
-       void snapshot (nframes_t now);
-       void transport_stopped (nframes_t frame);
-       
-       void clear_automation ();
-
-       void set_automation_state (AutoState);
-       AutoState automation_state() const;
-       void set_automation_style (AutoStyle);
-       AutoStyle automation_style() const;
-       bool touching() const;
+       void reset_streampanner (uint32_t which_panner);
+       void reset_to_default ();
 
        XMLNode& get_state (void);
        XMLNode& state (bool full);
-       int      set_state (const XMLNode&);
+       int      set_state (const XMLNode&, int version);
 
-       sigc::signal<void> Changed;
-       
        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(); }
        Output& output (uint32_t n) { return outputs[n]; }
 
-       std::vector<Output> outputs;
-       Session& session() const { return _session; }
-
        enum LinkDirection {
                SameDirection,
                OppositeDirection
@@ -260,38 +265,68 @@ class Panner : public std::vector<StreamPanner*>, public PBD::Stateful, public s
 
        LinkDirection link_direction() const { return _link_direction; }
        void set_link_direction (LinkDirection);
-       
+
        bool linked() const { return _linked; }
        void set_linked (bool yn);
 
-       sigc::signal<void> LinkStateChanged;
-       sigc::signal<void> StateChanged; /* for bypass */
+       StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; }
+       uint32_t npanners() const { return _streampanners.size(); }
+
+       PBD::Signal0<void> Changed; /* panner and/or outputs count changed */
+       PBD::Signal0<void> LinkStateChanged;
+       PBD::Signal0<void> StateChanged; /* for bypass */
 
        /* 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 ();
 
+       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, uint32_t chan=0) const {
+               return automation_control (Evoral::Parameter (PanAutomation, chan, id));
+       }
+
+       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:
-       void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, nframes_t offset, gain_t gain_coeff);
+       /* disallow copy construction */
+       Panner (Panner const &);
 
-       Session&         _session;
+       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;
        bool             _linked;
        bool             _bypassed;
+       bool             _mono;
        LinkDirection    _link_direction;
 
        static float current_automation_version_number;
 
+       void setup_speakers (uint32_t nouts);
+        void setup_meta_controls ();
+
        /* old school automation handling */
 
        std::string automation_path;
-       void set_name (std::string);
 };
 
 } // namespace ARDOUR