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/types.h"
34 #include "ardour/automation_control.h"
35 #include "ardour/automatable.h"
45 class Panner : public PBD::Stateful, public PBD::ScopedConnectionList
48 Panner (boost::shared_ptr<Pannable>);
51 virtual boost::shared_ptr<Speakers> get_speakers() const { return boost::shared_ptr<Speakers>(); }
53 virtual ChanCount in() const = 0;
54 virtual ChanCount out() const = 0;
56 virtual void configure_io (ARDOUR::ChanCount /*in*/, ARDOUR::ChanCount /*out*/) {}
58 /* derived implementations of these methods must indicate
59 whether it is legal for a Controllable to use the
60 value of the argument (post-call) in a call to
61 Controllable::set_value().
63 they have a choice of:
65 * return true, leave argument unchanged
66 * return true, modify argument
70 virtual bool clamp_position (double&) { return true; }
71 virtual bool clamp_width (double&) { return true; }
72 virtual bool clamp_elevation (double&) { return true; }
74 virtual std::pair<double, double> position_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
75 virtual std::pair<double, double> width_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
76 virtual std::pair<double, double> elevation_range () const { return std::make_pair (-DBL_MAX, DBL_MAX); }
78 virtual void set_position (double) { }
79 virtual void set_width (double) { }
80 virtual void set_elevation (double) { }
82 virtual double position () const { return 0.0; }
83 virtual double width () const { return 0.0; }
84 virtual double elevation () const { return 0.0; }
86 virtual PBD::AngularVector signal_position (uint32_t) const { return PBD::AngularVector(); }
88 virtual void reset () = 0;
90 /* azimut, width or elevation updated -> recalc signal_position -> emit Changed */
91 PBD::Signal0<void> SignalPositionChanged;
93 void set_automation_state (AutoState);
94 AutoState automation_state() const;
95 void set_automation_style (AutoStyle);
96 AutoStyle automation_style() const;
98 virtual std::set<Evoral::Parameter> what_can_be_automated() const;
99 virtual std::string describe_parameter (Evoral::Parameter);
100 virtual std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
102 bool touching() const;
104 static double azimuth_to_lr_fract (double azi) {
105 /* 180.0 degrees=> left => 0.0 */
106 /* 0.0 degrees => right => 1.0 */
108 /* humans can only distinguish 1 degree of arc between two positions,
109 so force azi back to an integral value before computing
112 return 1.0 - (rint(azi)/180.0);
115 static double lr_fract_to_azimuth (double fract) {
116 /* fract = 0.0 => degrees = 180.0 => left */
117 /* fract = 1.0 => degrees = 0.0 => right */
119 /* humans can only distinguish 1 degree of arc between two positions,
120 so force azi back to an integral value after computing
123 return rint (180.0 - (fract * 180.0));
127 * Pan some input buffers to a number of output buffers.
129 * @param ibufs Input buffers (one per panner input)
130 * @param obufs Output buffers (one per panner output).
131 * @param gain_coeff fixed, additional gain coefficient to apply to output samples.
132 * @param nframes Number of frames in the input.
134 * Derived panners can choose to implement these if they need to gain more
135 * control over the panning algorithm. The default is to call
136 * distribute_one() or distribute_one_automated() on each input buffer to
137 * deliver it to each output buffer.
139 * If a panner does not need to override this default behaviour, it can
140 * just implement distribute_one() and distribute_one_automated() (below).
142 virtual void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
143 virtual void distribute_automated (BufferSet& ibufs, BufferSet& obufs,
144 framepos_t start, framepos_t end, pframes_t nframes,
147 int set_state (const XMLNode&, int version);
148 XMLNode& get_state ();
150 boost::shared_ptr<Pannable> pannable() const { return _pannable; }
152 static bool equivalent (pan_t a, pan_t b) {
153 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
156 static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
157 /* XXX azimuth only, at present */
158 return fabs (a.azi - b.azi) < 1.0;
161 virtual void freeze ();
162 virtual void thaw ();
165 boost::shared_ptr<Pannable> _pannable;
167 virtual void distribute_one (AudioBuffer&, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which) = 0;
168 virtual void distribute_one_automated (AudioBuffer&, BufferSet& obufs,
169 framepos_t start, framepos_t end, pframes_t nframes,
170 pan_t** buffers, uint32_t which) = 0;
178 struct PanPluginDescriptor {
180 std::string panner_uri;
185 ARDOUR::Panner* (*factory)(boost::shared_ptr<ARDOUR::Pannable>, boost::shared_ptr<ARDOUR::Speakers>);
189 #endif /* __ardour_panner_h__ */