2 Copyright (C) 2004-2011 Paul Davis
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.
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.
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.
20 #ifndef __ardour_panner_h__
21 #define __ardour_panner_h__
29 #include "pbd/cartesian.h"
30 #include "pbd/signals.h"
31 #include "pbd/stateful.h"
33 #include "ardour/libardour_visibility.h"
34 #include "ardour/types.h"
35 #include "ardour/automation_control.h"
36 #include "ardour/automatable.h"
39 /* This section is for actual panners to use. They will include this file,
40 * declare ARDOURPANNER_DLL_EXPORTS during compilation, and ... voila.
43 #ifdef ARDOURPANNER_DLL_EXPORTS // defined if we are building a panner implementation
44 #define ARDOURPANNER_API LIBARDOUR_DLL_EXPORT
46 #define ARDOURPANNER_API LIBARDOUR_DLL_IMPORT
48 #define ARDOURPANNER_LOCAL LIBARDOUR_DLL_LOCAL
58 class LIBARDOUR_API Panner : public PBD::Stateful, public PBD::ScopedConnectionList
61 Panner (boost::shared_ptr<Pannable>);
64 virtual boost::shared_ptr<Speakers> get_speakers() const { return boost::shared_ptr<Speakers>(); }
66 virtual ChanCount in() const = 0;
67 virtual ChanCount out() const = 0;
69 virtual void configure_io (ARDOUR::ChanCount /*in*/, ARDOUR::ChanCount /*out*/) {}
71 /* derived implementations of these methods must indicate
72 whether it is legal for a Controllable to use the
73 value of the argument (post-call) in a call to
74 Controllable::set_value().
76 they have a choice of:
78 * return true, leave argument unchanged
79 * return true, modify argument
83 virtual bool clamp_position (double&) { return true; }
84 virtual bool clamp_width (double&) { return true; }
85 virtual bool clamp_elevation (double&) { return true; }
87 virtual std::pair<double, double> position_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
88 virtual std::pair<double, double> width_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
89 virtual std::pair<double, double> elevation_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
91 virtual void set_position (double) { }
92 virtual void set_width (double) { }
93 virtual void set_elevation (double) { }
95 virtual double position () const { return 0.0; }
96 virtual double width () const { return 0.0; }
97 virtual double elevation () const { return 0.0; }
99 virtual PBD::AngularVector signal_position (uint32_t) const { return PBD::AngularVector(); }
101 virtual void reset () = 0;
103 /* azimut, width or elevation updated -> recalc signal_position -> emit Changed */
104 PBD::Signal0<void> SignalPositionChanged;
106 void set_automation_state (AutoState);
107 AutoState automation_state() const;
108 void set_automation_style (AutoStyle);
109 AutoStyle automation_style() const;
111 virtual std::set<Evoral::Parameter> what_can_be_automated() const;
112 virtual std::string describe_parameter (Evoral::Parameter);
113 virtual std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
115 bool touching() const;
117 static double azimuth_to_lr_fract (double azi) {
118 /* 180.0 degrees=> left => 0.0 */
119 /* 0.0 degrees => right => 1.0 */
121 /* humans can only distinguish 1 degree of arc between two positions,
122 so force azi back to an integral value before computing
125 return 1.0 - (rint(azi)/180.0);
128 static double lr_fract_to_azimuth (double fract) {
129 /* fract = 0.0 => degrees = 180.0 => left */
130 /* fract = 1.0 => degrees = 0.0 => right */
132 /* humans can only distinguish 1 degree of arc between two positions,
133 so force azi back to an integral value after computing
136 return rint (180.0 - (fract * 180.0));
140 * Pan some input buffers to a number of output buffers.
142 * @param ibufs Input buffers (one per panner input)
143 * @param obufs Output buffers (one per panner output).
144 * @param gain_coeff fixed, additional gain coefficient to apply to output samples.
145 * @param nframes Number of frames in the input.
147 * Derived panners can choose to implement these if they need to gain more
148 * control over the panning algorithm. The default is to call
149 * distribute_one() or distribute_one_automated() on each input buffer to
150 * deliver it to each output buffer.
152 * If a panner does not need to override this default behaviour, it can
153 * just implement distribute_one() and distribute_one_automated() (below).
155 virtual void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
156 virtual void distribute_automated (BufferSet& ibufs, BufferSet& obufs,
157 framepos_t start, framepos_t end, pframes_t nframes,
160 int set_state (const XMLNode&, int version);
161 XMLNode& get_state ();
163 boost::shared_ptr<Pannable> pannable() const { return _pannable; }
165 static bool equivalent (pan_t a, pan_t b) {
166 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
169 static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
170 /* XXX azimuth only, at present */
171 return fabs (a.azi - b.azi) < 1.0;
174 virtual void freeze ();
175 virtual void thaw ();
178 boost::shared_ptr<Pannable> _pannable;
180 virtual void distribute_one (AudioBuffer&, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which) = 0;
181 virtual void distribute_one_automated (AudioBuffer&, BufferSet& obufs,
182 framepos_t start, framepos_t end, pframes_t nframes,
183 pan_t** buffers, uint32_t which) = 0;
191 struct LIBARDOUR_API PanPluginDescriptor {
193 std::string panner_uri;
198 ARDOUR::Panner* (*factory)(boost::shared_ptr<ARDOUR::Pannable>, boost::shared_ptr<ARDOUR::Speakers>);
202 #endif /* __ardour_panner_h__ */