X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=libs%2Fardour%2Fardour%2Fpanner.h;h=b30b1859a3ec2e7dca916d386657c4f9951895bc;hb=682ebad62bdc85df151ad0b81dc27cc9f3e71cec;hp=abee3431ce351e24568645f4cf7e43e059a45e6d;hpb=ece5093234e4c185cf536d2b4e5edfeb90622409;p=ardour.git diff --git a/libs/ardour/ardour/panner.h b/libs/ardour/ardour/panner.h index abee3431ce..b30b1859a3 100644 --- a/libs/ardour/ardour/panner.h +++ b/libs/ardour/ardour/panner.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2004 Paul Davis + Copyright (C) 2004-2011 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 @@ -26,303 +26,158 @@ #include #include +#include "pbd/cartesian.h" +#include "pbd/signals.h" #include "pbd/stateful.h" -#include "pbd/controllable.h" #include "ardour/types.h" #include "ardour/automation_control.h" -#include "ardour/processor.h" +#include "ardour/automatable.h" namespace ARDOUR { class Session; -class Panner; +class Pannable; class BufferSet; class AudioBuffer; +class Speakers; -class StreamPanner : public PBD::Stateful +class Panner : public PBD::Stateful, public PBD::ScopedConnectionList { - public: - 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; } - - 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 **); - - /* the basic StreamPanner API */ - - /** - * 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, nframes_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; - - boost::shared_ptr pan_control() { return _control; } - - PBD::Signal0 Changed; /* for position */ - PBD::Signal0 StateChanged; /* for mute, mono */ +public: + Panner (boost::shared_ptr); + ~Panner (); - int set_state (const XMLNode&, int version); - virtual XMLNode& state (bool full_state) = 0; + virtual boost::shared_ptr get_speakers() const { return boost::shared_ptr(); } - Panner & get_parent() { return parent; } + virtual ChanCount in() const = 0; + virtual ChanCount out() const = 0; - /* old school automation loading */ - virtual int load (std::istream&, std::string path, uint32_t&) = 0; + virtual void configure_io (ARDOUR::ChanCount /*in*/, ARDOUR::ChanCount /*out*/) {} - protected: - friend class Panner; - Panner& parent; + /* derived implementations of these methods must indicate + whether it is legal for a Controllable to use the + value of the argument (post-call) in a call to + Controllable::set_value(). - void set_mono (bool); - - float _x; - float _y; - float _z; + they have a choice of: - /* these are for automation. they store the last value - used by the most recent process() cycle. + * return true, leave argument unchanged + * return true, modify argument + * return false */ - float effective_x; - float effective_y; - float effective_z; + virtual bool clamp_position (double&) { return true; } + virtual bool clamp_width (double&) { return true; } + virtual bool clamp_elevation (double&) { return true; } - bool _muted; - bool _mono; + virtual std::pair position_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); } + virtual std::pair width_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); } + virtual std::pair elevation_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); } - boost::shared_ptr _control; + virtual void set_position (double) { } + virtual void set_width (double) { } + virtual void set_elevation (double) { } - void add_state (XMLNode&); + virtual double position () const { return 0.0; } + virtual double width () const { return 0.0; } + virtual double elevation () const { return 0.0; } - /* Update internal parameters based on _x, _y and _z */ - virtual void update () = 0; -}; + virtual PBD::AngularVector signal_position (uint32_t) const { return PBD::AngularVector(); } -class BaseStereoPanner : public StreamPanner -{ - public: - BaseStereoPanner (Panner&, Evoral::Parameter param); - ~BaseStereoPanner (); - - /* this class just leaves the pan law itself to be defined - by the update(), do_distribute_automated() - methods. derived classes also need a factory method - and a type name. See EqualPowerStereoPanner as an example. - */ + virtual void reset () = 0; - void do_distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes); - - /* old school automation loading */ - - int load (std::istream&, std::string path, uint32_t&); + void set_automation_state (AutoState); + AutoState automation_state() const; + void set_automation_style (AutoStyle); + AutoStyle automation_style() const; - protected: - float left; - float right; - float desired_left; - float desired_right; - float left_interp; - float right_interp; -}; + virtual std::set what_can_be_automated() const; + virtual std::string describe_parameter (Evoral::Parameter); + virtual std::string value_as_string (boost::shared_ptr) const; -class EqualPowerStereoPanner : public BaseStereoPanner -{ - public: - EqualPowerStereoPanner (Panner&, Evoral::Parameter param); - ~EqualPowerStereoPanner (); + bool touching() const; - void do_distribute_automated (AudioBuffer& src, BufferSet& obufs, - nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers); + static double azimuth_to_lr_fract (double azi) { + /* 180.0 degrees=> left => 0.0 */ + /* 0.0 degrees => right => 1.0 */ - void get_current_coefficients (pan_t*) const; - void get_desired_coefficients (pan_t*) const; + /* humans can only distinguish 1 degree of arc between two positions, + so force azi back to an integral value before computing + */ - static StreamPanner* factory (Panner&, Evoral::Parameter param); - static std::string name; + return 1.0 - (rint(azi)/180.0); + } - XMLNode& state (bool full_state); - XMLNode& get_state (void); - int set_state (const XMLNode&, int version); + static double lr_fract_to_azimuth (double fract) { + /* fract = 0.0 => degrees = 180.0 => left */ + /* fract = 1.0 => degrees = 0.0 => right */ - private: - void update (); -}; + /* humans can only distinguish 1 degree of arc between two positions, + so force azi back to an integral value after computing + */ -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); + return rint (180.0 - (fract * 180.0)); + } - static StreamPanner* factory (Panner&, Evoral::Parameter); - static std::string name; + /** + * Pan some input buffers to a number of output buffers. + * + * @param ibufs Input buffers (one per panner input) + * @param obufs Output buffers (one per panner output). + * @param gain_coeff fixed, additional gain coefficient to apply to output samples. + * @param nframes Number of frames in the input. + * + * Derived panners can choose to implement these if they need to gain more + * control over the panning algorithm. The default is to call + * distribute_one() or distribute_one_automated() on each input buffer to + * deliver it to each output buffer. + * + * If a panner does not need to override this default behaviour, it can + * just implement distribute_one() and distribute_one_automated() (below). + */ + virtual void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes); + virtual void distribute_automated (BufferSet& ibufs, BufferSet& obufs, + framepos_t start, framepos_t end, pframes_t nframes, + pan_t** buffers); - 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. - */ -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) {} - - }; - - Panner (std::string name, Session&); - virtual ~Panner (); - - void clear_panners (); - bool empty() const { return _streampanners.empty(); } - - void set_automation_state (AutoState); - AutoState automation_state() const; - void set_automation_style (AutoStyle); - AutoStyle automation_style() const; - bool touching() const; - - 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); - - 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 reset (uint32_t noutputs, uint32_t npans); - 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 version); + XMLNode& get_state (); + + boost::shared_ptr pannable() const { return _pannable; } static bool equivalent (pan_t a, pan_t b) { return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner } - void move_output (uint32_t, float x, float y); - uint32_t nouts() const { return outputs.size(); } - Output& output (uint32_t n) { return outputs[n]; } - - enum LinkDirection { - SameDirection, - OppositeDirection - }; - - LinkDirection link_direction() const { return _link_direction; } - void set_link_direction (LinkDirection); - - bool linked() const { return _linked; } - void set_linked (bool yn); - - StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; } - uint32_t npanners() const { return _streampanners.size(); } - - PBD::Signal0 Changed; /* panner and/or outputs count changed */ - PBD::Signal0 LinkStateChanged; - PBD::Signal0 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); - - /* 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(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 pan_control (int id, int chan=0) { - return automation_control (Evoral::Parameter (PanAutomation, chan, id)); + static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) { + /* XXX azimuth only, at present */ + return fabs (a.azi - b.azi) < 1.0; } - boost::shared_ptr pan_control (int id, int chan=0) const { - return automation_control (Evoral::Parameter (PanAutomation, chan, id)); - } + virtual void freeze (); + virtual void thaw (); - private: - /* disallow copy construction */ - Panner (Panner const &); +protected: + boost::shared_ptr _pannable; - void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, gain_t gain_coeff); - std::vector _streampanners; ///< one StreamPanner per input - std::vector outputs; - uint32_t current_outs; - bool _linked; - bool _bypassed; - bool _mono; - LinkDirection _link_direction; + virtual void distribute_one (AudioBuffer&, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which) = 0; + virtual void distribute_one_automated (AudioBuffer&, BufferSet& obufs, + framepos_t start, framepos_t end, pframes_t nframes, + pan_t** buffers, uint32_t which) = 0; - static float current_automation_version_number; + int32_t _frozen; +}; - /* old school automation handling */ +} // namespace - std::string automation_path; +extern "C" { +struct PanPluginDescriptor { + std::string name; + int32_t in; + int32_t out; + ARDOUR::Panner* (*factory)(boost::shared_ptr, boost::shared_ptr); }; +} -} // namespace ARDOUR - -#endif /*__ardour_panner_h__ */ +#endif /* __ardour_panner_h__ */