2 Copyright (C) 2004 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__
28 #include <sigc++/signal.h>
30 #include "pbd/stateful.h"
31 #include "pbd/controllable.h"
33 #include "ardour/types.h"
34 #include "ardour/automation_control.h"
35 #include "ardour/processor.h"
45 class StreamPanner : public sigc::trackable, public PBD::Stateful
48 StreamPanner (Panner& p, Evoral::Parameter param);
51 void set_muted (bool yn);
52 bool muted() const { return _muted; }
54 void set_position (float x, bool link_call = false);
55 void set_position (float x, float y, bool link_call = false);
56 void set_position (float x, float y, float z, bool link_call = false);
58 void get_position (float& xpos) const { xpos = x; }
59 void get_position (float& xpos, float& ypos) const { xpos = x; ypos = y; }
60 void get_position (float& xpos, float& ypos, float& zpos) const { xpos = x; ypos = y; zpos = z; }
62 void get_effective_position (float& xpos) const { xpos = effective_x; }
63 void get_effective_position (float& xpos, float& ypos) const { xpos = effective_x; ypos = effective_y; }
64 void get_effective_position (float& xpos, float& ypos, float& zpos) const { xpos = effective_x; ypos = effective_y; zpos = effective_z; }
66 /* the basic StreamPanner API */
68 virtual void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
69 virtual void distribute_automated (AudioBuffer& src, BufferSet& obufs,
70 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers) = 0;
72 boost::shared_ptr<AutomationControl> pan_control() { return _control; }
74 sigc::signal<void> Changed; /* for position */
75 sigc::signal<void> StateChanged; /* for mute */
77 int set_state (const XMLNode&);
78 virtual XMLNode& state (bool full_state) = 0;
80 Panner & get_parent() { return parent; }
82 /* old school automation loading */
84 virtual int load (std::istream&, std::string path, uint32_t&) = 0;
94 /* these are for automation. they store the last value
95 used by the most recent process() cycle.
104 boost::shared_ptr<AutomationControl> _control;
106 void add_state (XMLNode&);
107 virtual void update () = 0;
110 class BaseStereoPanner : public StreamPanner
113 BaseStereoPanner (Panner&, Evoral::Parameter param);
114 ~BaseStereoPanner ();
116 /* this class just leaves the pan law itself to be defined
117 by the update(), distribute_automated()
118 methods. derived classes also need a factory method
119 and a type name. See EqualPowerStereoPanner as an example.
122 void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
124 /* old school automation loading */
126 int load (std::istream&, std::string path, uint32_t&);
137 class EqualPowerStereoPanner : public BaseStereoPanner
140 EqualPowerStereoPanner (Panner&, Evoral::Parameter param);
141 ~EqualPowerStereoPanner ();
143 void distribute_automated (AudioBuffer& src, BufferSet& obufs,
144 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
146 void get_current_coefficients (pan_t*) const;
147 void get_desired_coefficients (pan_t*) const;
149 static StreamPanner* factory (Panner&, Evoral::Parameter param);
150 static std::string name;
152 XMLNode& state (bool full_state);
153 XMLNode& get_state (void);
154 int set_state (const XMLNode&);
160 class Multi2dPanner : public StreamPanner
163 Multi2dPanner (Panner& parent, Evoral::Parameter);
166 void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
167 void distribute_automated (AudioBuffer& src, BufferSet& obufs,
168 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
170 static StreamPanner* factory (Panner&, Evoral::Parameter);
171 static std::string name;
173 XMLNode& state (bool full_state);
174 XMLNode& get_state (void);
175 int set_state (const XMLNode&);
177 /* old school automation loading */
179 int load (std::istream&, std::string path, uint32_t&);
186 class Panner : public Processor
195 Output (float xp, float yp)
196 : x (xp), y (yp), current_pan (0.0f), desired_pan (0.f) {}
200 //Panner (std::string name, Session&, int _num_bufs);
201 Panner (std::string name, Session&);
204 void clear_panners ();
205 bool empty() const { return _streampanners.empty(); }
207 /// The fundamental Panner function
208 void set_automation_state (AutoState);
209 AutoState automation_state() const;
210 void set_automation_style (AutoStyle);
211 AutoStyle automation_style() const;
212 bool touching() const;
214 bool is_in_place () const { return false; }
215 bool is_out_of_place () const { return true; }
216 bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const { return true; };
218 void run_out_of_place(BufferSet& src, BufferSet& dest, sframes_t start_frame, sframes_t end_frames, nframes_t nframes);
220 //void* get_inline_gui() const = 0;
221 //void* get_full_gui() const = 0;
223 bool bypassed() const { return _bypassed; }
224 void set_bypassed (bool yn);
226 StreamPanner* add ();
227 void remove (uint32_t which);
228 void reset (uint32_t noutputs, uint32_t npans);
229 void reset_streampanner (uint32_t which_panner);
230 void reset_to_default ();
232 XMLNode& get_state (void);
233 XMLNode& state (bool full);
234 int set_state (const XMLNode&);
236 static bool equivalent (pan_t a, pan_t b) {
237 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
240 void move_output (uint32_t, float x, float y);
241 uint32_t nouts() const { return outputs.size(); }
242 Output& output (uint32_t n) { return outputs[n]; }
244 std::vector<Output> outputs;
251 LinkDirection link_direction() const { return _link_direction; }
252 void set_link_direction (LinkDirection);
254 bool linked() const { return _linked; }
255 void set_linked (bool yn);
257 StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; }
258 uint32_t npanners() const { return _streampanners.size(); }
260 sigc::signal<void> Changed;
261 sigc::signal<void> LinkStateChanged;
262 sigc::signal<void> StateChanged; /* for bypass */
264 /* only StreamPanner should call these */
266 void set_position (float x, StreamPanner& orig);
267 void set_position (float x, float y, StreamPanner& orig);
268 void set_position (float x, float y, float z, StreamPanner& orig);
270 /* old school automation */
274 struct PanControllable : public AutomationControl {
275 PanControllable (Session& s, std::string name, Panner& p, Evoral::Parameter param)
276 : AutomationControl (s, param,
277 boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
279 { assert(param.type() != NullAutomation); }
281 AutomationList* alist() { return (AutomationList*)_list.get(); }
284 void set_value (float);
285 float get_value (void) const;
288 boost::shared_ptr<AutomationControl> pan_control (int id, int chan=0) {
289 return automation_control(Evoral::Parameter (PanAutomation, chan, id));
292 boost::shared_ptr<const AutomationControl> pan_control (int id, int chan=0) const {
293 return automation_control(Evoral::Parameter (PanAutomation, chan, id));
297 /* disallow copy construction */
298 Panner (Panner const &);
300 void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, gain_t gain_coeff);
301 std::vector<StreamPanner*> _streampanners;
302 uint32_t current_outs;
305 LinkDirection _link_direction;
307 static float current_automation_version_number;
309 /* old school automation handling */
311 std::string automation_path;
314 } // namespace ARDOUR
316 #endif /*__ardour_panner_h__ */