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 ChanCount in() const = 0;
52 virtual ChanCount out() const = 0;
54 virtual void configure_io (ARDOUR::ChanCount in, ARDOUR::ChanCount out) {}
56 /* derived implementations of these methods must indicate
57 whether it is legal for a Controllable to use the
58 value of the argument (post-call) in a call to
59 Controllable::set_value().
61 they have a choice of:
63 * return true, leave argument unchanged
64 * return true, modify argument
69 virtual bool clamp_position (double&) { return true; }
70 virtual bool clamp_width (double&) { return true; }
71 virtual bool clamp_elevation (double&) { return true; }
73 virtual void set_position (double) { }
74 virtual void set_width (double) { }
75 virtual void set_elevation (double) { }
77 virtual double position () const { return 0.0; }
78 virtual double width () const { return 0.0; }
79 virtual double elevation () const { return 0.0; }
81 virtual void reset() {}
83 virtual bool bypassed() const { return _bypassed; }
84 virtual void set_bypassed (bool yn);
86 virtual bool is_mono () const { return _mono; }
87 virtual void set_mono (bool);
89 void set_automation_state (AutoState);
90 AutoState automation_state() const;
91 void set_automation_style (AutoStyle);
92 AutoStyle automation_style() const;
94 virtual std::set<Evoral::Parameter> what_can_be_automated() const;
95 virtual std::string describe_parameter (Evoral::Parameter);
96 virtual std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
98 bool touching() const;
100 static double azimuth_to_lr_fract (double azi) {
101 /* 180.0 degrees=> left => 0.0 */
102 /* 0.0 degrees => right => 1.0 */
104 /* humans can only distinguish 1 degree of arc between two positions,
105 so force azi back to an integral value before computing
108 return 1.0 - (rint(azi)/180.0);
111 static double lr_fract_to_azimuth (double fract) {
112 /* fract = 0.0 => degrees = 180.0 => left */
113 /* fract = 1.0 => degrees = 0.0 => right */
115 /* humans can only distinguish 1 degree of arc between two positions,
116 so force azi back to an integral value after computing
119 return rint (180.0 - (fract * 180.0));
123 * Pan some input buffers to a number of output buffers.
125 * @param ibufs Input buffers (one per panner input)
126 * @param obufs Output buffers (one per panner output).
127 * @param gain_coeff fixed, additional gain coefficient to apply to output samples.
128 * @param nframes Number of frames in the input.
130 * Derived panners can choose to implement these if they need to gain more control over the panning algorithm.
131 * the default is to (1) check if _mono is true, and if so, just deliver .. (2) otherwise, call
132 * distribute_one() or distribute_one_automated() on each input buffer to deliver it to each output
135 * If a panner does not need to override this default behaviour, it can just implement
136 * distribute_one() and distribute_one_automated() (below).
138 virtual void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
139 virtual void distribute_automated (BufferSet& ibufs, BufferSet& obufs,
140 framepos_t start, framepos_t end, pframes_t nframes,
143 PBD::Signal0<void> Changed; /* for positional info */
144 PBD::Signal0<void> StateChanged; /* for mute, mono */
146 int set_state (const XMLNode&, int version);
147 virtual XMLNode& state (bool full_state) = 0;
149 boost::shared_ptr<Pannable> pannable() const { return _pannable; }
151 //virtual std::string describe_parameter (Evoral::Parameter);
152 //virtual std::string value_as_string (Evoral::Parameter, double val);
154 static bool equivalent (pan_t a, pan_t b) {
155 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
158 static bool equivalent (const PBD::AngularVector& a, const PBD::AngularVector& b) {
159 /* XXX azimuth only, at present */
160 return fabs (a.azi - b.azi) < 1.0;
164 boost::shared_ptr<Pannable> _pannable;
168 XMLNode& get_state ();
171 virtual void distribute_one (AudioBuffer&, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which) = 0;
172 virtual void distribute_one_automated (AudioBuffer&, BufferSet& obufs,
173 framepos_t start, framepos_t end, pframes_t nframes,
174 pan_t** buffers, uint32_t which) = 0;
180 struct PanPluginDescriptor {
184 ARDOUR::Panner* (*factory)(boost::shared_ptr<ARDOUR::Pannable>, ARDOUR::Speakers&);
188 #endif /* __ardour_panner_h__ */