X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fpanner.h;h=48f583c18558466b9e603c4f23f47f0f2092e88d;hb=3020b224fa2d6e1b6b8a576e8e8e211e0585f2a2;hp=af3cda94e2647b2b582849bd04ec2ee80d4f3a71;hpb=d7bd270aa10b3a8669223debe4c1b572ae876e2b;p=ardour.git diff --git a/libs/ardour/ardour/panner.h b/libs/ardour/ardour/panner.h index af3cda94e2..48f583c185 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 @@ -21,312 +21,179 @@ #define __ardour_panner_h__ #include +#include #include #include #include -#include -#include -#include +#include "pbd/cartesian.h" +#include "pbd/signals.h" +#include "pbd/stateful.h" -#include -#include +#include "ardour/libardour_visibility.h" +#include "ardour/types.h" +#include "ardour/automation_control.h" +#include "ardour/automatable.h" -using std::istream; -using std::ostream; + +/* This section is for actual panners to use. They will include this file, + * declare ARDOURPANNER_DLL_EXPORTS during compilation, and ... voila. + */ + +#ifdef ARDOURPANNER_DLL_EXPORTS // defined if we are building a panner implementation + #define ARDOURPANNER_API LIBARDOUR_DLL_EXPORT + #else + #define ARDOURPANNER_API LIBARDOUR_DLL_IMPORT + #endif +#define ARDOURPANNER_LOCAL LIBARDOUR_DLL_LOCAL namespace ARDOUR { class Session; -class Panner; +class Pannable; class BufferSet; class AudioBuffer; +class Speakers; -class StreamPanner : public sigc::trackable, public PBD::Stateful +class LIBARDOUR_API Panner : public PBD::Stateful, public PBD::ScopedConnectionList { - public: - StreamPanner (Panner& p); - ~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; } - - /* 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; - - /* automation */ - - virtual void snapshot (nframes_t now) = 0; - virtual void transport_stopped (nframes_t frame) = 0; - virtual void set_automation_state (AutoState) = 0; - virtual void set_automation_style (AutoStyle) = 0; - - PBD::Controllable& control() { return _control; } - - /* XXX this is wrong. for multi-dimensional panners, there - must surely be more than 1 automation curve. - */ - /* TODO: Panner is-a Automation solves this */ - - virtual AutomationList& automation() = 0; - - sigc::signal Changed; /* for position */ - sigc::signal StateChanged; /* for mute */ - - int set_state (const XMLNode&); - virtual XMLNode& state (bool full_state) = 0; - - Panner & get_parent() { return parent; } - - /* old school automation loading */ - - virtual int load (istream&, string path, uint32_t&) = 0; - - protected: - friend class Panner; - Panner& parent; +public: + Panner (boost::shared_ptr); + ~Panner (); - float x; - float y; - float z; - - /* these are for automation. they store the last value - used by the most recent process() cycle. - */ + virtual boost::shared_ptr get_speakers() const { return boost::shared_ptr(); } - float effective_x; - float effective_y; - float effective_z; + virtual ChanCount in() const = 0; + virtual ChanCount out() const = 0; - bool _muted; + virtual void configure_io (ARDOUR::ChanCount /*in*/, ARDOUR::ChanCount /*out*/) {} - struct PanControllable : public PBD::Controllable { - PanControllable (std::string name, StreamPanner& p) : Controllable (name), panner (p) {} - - StreamPanner& panner; - - void set_value (float); - float get_value (void) const; - bool can_send_feedback() const; - }; + /* 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(). - PanControllable _control; - - void add_state (XMLNode&); - virtual void update () = 0; -}; + they have a choice of: -class BaseStereoPanner : public StreamPanner -{ - public: - BaseStereoPanner (Panner&); - ~BaseStereoPanner (); - - /* this class just leaves the pan law itself to be defined - by the update(), distribute_automated() - methods. derived classes also need a factory method - and a type name. See EqualPowerStereoPanner as an example. + * return true, leave argument unchanged + * return true, modify argument + * return false */ - void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes); - - void snapshot (nframes_t now); - void transport_stopped (nframes_t frame); - void set_automation_state (AutoState); - void set_automation_style (AutoStyle); - - /* TODO: StreamPanner is-a Automatable? */ - AutomationList& automation() { return _automation; } - - /* old school automation loading */ - - int load (istream&, string path, uint32_t&); - - protected: - float left; - float right; - float desired_left; - float desired_right; - float left_interp; - float right_interp; - - AutomationList _automation; -}; - -class EqualPowerStereoPanner : public BaseStereoPanner -{ - public: - EqualPowerStereoPanner (Panner&); - ~EqualPowerStereoPanner (); - - void distribute_automated (AudioBuffer& src, BufferSet& obufs, - nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers); + virtual bool clamp_position (double&) { return true; } + virtual bool clamp_width (double&) { return true; } + virtual bool clamp_elevation (double&) { return true; } - void get_current_coefficients (pan_t*) const; - void get_desired_coefficients (pan_t*) const; + 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); } - static StreamPanner* factory (Panner&); - static string name; + virtual void set_position (double) { } + virtual void set_width (double) { } + virtual void set_elevation (double) { } - XMLNode& state (bool full_state); - XMLNode& get_state (void); - int set_state (const XMLNode&); + virtual double position () const { return 0.0; } + virtual double width () const { return 0.0; } + virtual double elevation () const { return 0.0; } - private: - void update (); -}; + virtual PBD::AngularVector signal_position (uint32_t) const { return PBD::AngularVector(); } -class Multi2dPanner : public StreamPanner -{ - public: - Multi2dPanner (Panner& parent); - ~Multi2dPanner (); + virtual void reset () = 0; - void snapshot (nframes_t now); - void transport_stopped (nframes_t frame); - void set_automation_state (AutoState); - void set_automation_style (AutoStyle); + void set_automation_state (AutoState); + AutoState automation_state() const; + void set_automation_style (AutoStyle); + AutoStyle automation_style() const; - /* XXX this is wrong. for multi-dimensional panners, there - must surely be more than 1 automation curve. - */ - - /* TODO: StreamPanner is-a Automatable? */ + 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; - AutomationList& automation() { return _automation; } + bool touching() const; - 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 double azimuth_to_lr_fract (double azi) { + /* 180.0 degrees=> left => 0.0 */ + /* 0.0 degrees => right => 1.0 */ - static StreamPanner* factory (Panner&); - static string name; + /* humans can only distinguish 1 degree of arc between two positions, + so force azi back to an integral value before computing + */ - XMLNode& state (bool full_state); - XMLNode& get_state (void); - int set_state (const XMLNode&); + return 1.0 - (rint(azi)/180.0); + } - /* old school automation loading */ + static double lr_fract_to_azimuth (double fract) { + /* fract = 0.0 => degrees = 180.0 => left */ + /* fract = 1.0 => degrees = 0.0 => right */ - int load (istream&, string path, uint32_t&); + /* humans can only distinguish 1 degree of arc between two positions, + so force azi back to an integral value after computing + */ - private: - AutomationList _automation; - void update (); -}; + return rint (180.0 - (fract * 180.0)); + } -class Panner : public std::vector, 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) {} - - }; - - Panner (string name, Session&); - virtual ~Panner (); - - /// The fundamental Panner function - void distribute(BufferSet& src, BufferSet& dest, nframes_t start_frame, nframes_t end_frames, nframes_t nframes, nframes_t offset); - - bool bypassed() const { return _bypassed; } - void set_bypassed (bool yn); - - 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); + /** + * 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); + + int set_state (const XMLNode&, int version); + XMLNode& get_state (); - void clear_automation (); - - void set_automation_state (AutoState); - AutoState automation_state() const; - void set_automation_style (AutoStyle); - AutoStyle automation_style() const; - bool touching() const; + boost::shared_ptr pannable() const { return _pannable; } - XMLNode& get_state (void); - XMLNode& state (bool full); - int set_state (const XMLNode&); - - sigc::signal 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 } - 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 outputs; - Session& session() const { return _session; } - - 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); - - sigc::signal LinkStateChanged; - sigc::signal 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 (); - - private: - void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, nframes_t offset, gain_t gain_coeff); + static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) { + /* XXX azimuth only, at present */ + return fabs (a.azi - b.azi) < 1.0; + } - Session& _session; - uint32_t current_outs; - bool _linked; - bool _bypassed; - LinkDirection _link_direction; + virtual void freeze (); + virtual void thaw (); - static float current_automation_version_number; +protected: + boost::shared_ptr _pannable; - /* old school automation handling */ + 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; - std::string automation_path; - void set_name (std::string); + int32_t _frozen; }; -} // namespace ARDOUR +} // namespace + +extern "C" { +struct LIBARDOUR_API PanPluginDescriptor { + std::string name; + std::string panner_uri; + std::string gui_uri; + int32_t in; + int32_t out; + uint32_t priority; + ARDOUR::Panner* (*factory)(boost::shared_ptr, boost::shared_ptr); +}; +} -#endif /*__ardour_panner_h__ */ +#endif /* __ardour_panner_h__ */