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>
36 #include <ardour/session.h>
49 class StreamPanner : public sigc::trackable, public PBD::Stateful
52 StreamPanner (Panner& p, Evoral::Parameter param);
55 void set_muted (bool yn);
56 bool muted() const { return _muted; }
58 void set_position (float x, bool link_call = false);
59 void set_position (float x, float y, bool link_call = false);
60 void set_position (float x, float y, float z, bool link_call = false);
62 void get_position (float& xpos) const { xpos = x; }
63 void get_position (float& xpos, float& ypos) const { xpos = x; ypos = y; }
64 void get_position (float& xpos, float& ypos, float& zpos) const { xpos = x; ypos = y; zpos = z; }
66 void get_effective_position (float& xpos) const { xpos = effective_x; }
67 void get_effective_position (float& xpos, float& ypos) const { xpos = effective_x; ypos = effective_y; }
68 void get_effective_position (float& xpos, float& ypos, float& zpos) const { xpos = effective_x; ypos = effective_y; zpos = effective_z; }
70 /* the basic StreamPanner API */
72 virtual void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes) = 0;
73 virtual void distribute_automated (AudioBuffer& src, BufferSet& obufs,
74 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers) = 0;
76 boost::shared_ptr<AutomationControl> pan_control() { return _control; }
78 sigc::signal<void> Changed; /* for position */
79 sigc::signal<void> StateChanged; /* for mute */
81 int set_state (const XMLNode&);
82 virtual XMLNode& state (bool full_state) = 0;
84 Panner & get_parent() { return parent; }
86 /* old school automation loading */
88 virtual int load (istream&, string path, uint32_t&) = 0;
98 /* these are for automation. they store the last value
99 used by the most recent process() cycle.
108 boost::shared_ptr<AutomationControl> _control;
110 void add_state (XMLNode&);
111 virtual void update () = 0;
114 class BaseStereoPanner : public StreamPanner
117 BaseStereoPanner (Panner&, Evoral::Parameter param);
118 ~BaseStereoPanner ();
120 /* this class just leaves the pan law itself to be defined
121 by the update(), distribute_automated()
122 methods. derived classes also need a factory method
123 and a type name. See EqualPowerStereoPanner as an example.
126 void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
128 /* old school automation loading */
130 int load (istream&, string path, uint32_t&);
141 class EqualPowerStereoPanner : public BaseStereoPanner
144 EqualPowerStereoPanner (Panner&, Evoral::Parameter param);
145 ~EqualPowerStereoPanner ();
147 void distribute_automated (AudioBuffer& src, BufferSet& obufs,
148 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
150 void get_current_coefficients (pan_t*) const;
151 void get_desired_coefficients (pan_t*) const;
153 static StreamPanner* factory (Panner&, Evoral::Parameter param);
156 XMLNode& state (bool full_state);
157 XMLNode& get_state (void);
158 int set_state (const XMLNode&);
164 class Multi2dPanner : public StreamPanner
167 Multi2dPanner (Panner& parent, Evoral::Parameter);
170 void distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes);
171 void distribute_automated (AudioBuffer& src, BufferSet& obufs,
172 nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers);
174 static StreamPanner* factory (Panner&, Evoral::Parameter);
177 XMLNode& state (bool full_state);
178 XMLNode& get_state (void);
179 int set_state (const XMLNode&);
181 /* old school automation loading */
183 int load (istream&, string path, uint32_t&);
190 class Panner : public Processor
199 Output (float xp, float yp)
200 : x (xp), y (yp), current_pan (0.0f), desired_pan (0.f) {}
204 //Panner (std::string name, Session&, int _num_bufs);
205 Panner (string name, Session&);
208 void clear_panners ();
211 /// The fundamental Panner function
212 void set_automation_state (AutoState);
213 AutoState automation_state() const;
214 void set_automation_style (AutoStyle);
215 AutoStyle automation_style() const;
216 bool touching() const;
218 bool is_in_place () const { return false; }
219 bool is_out_of_place () const { return true; }
220 bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const { return true; };
222 void run_out_of_place(BufferSet& src, BufferSet& dest, nframes_t start_frame, nframes_t end_frames, nframes_t nframes, nframes_t offset);
224 //void* get_inline_gui() const = 0;
225 //void* get_full_gui() const = 0;
227 bool bypassed() const { return _bypassed; }
228 void set_bypassed (bool yn);
230 StreamPanner* add ();
231 void remove (uint32_t which);
232 void reset (uint32_t noutputs, uint32_t npans);
237 XMLNode& get_state (void);
238 XMLNode& state (bool full);
239 int set_state (const XMLNode&);
241 static bool equivalent (pan_t a, pan_t b) {
242 return fabsf (a - b) < 0.002; // about 1 degree of arc for a stereo panner
245 void move_output (uint32_t, float x, float y);
246 uint32_t nouts() const { return outputs.size(); }
247 Output& output (uint32_t n) { return outputs[n]; }
249 std::vector<Output> outputs;
256 LinkDirection link_direction() const { return _link_direction; }
257 void set_link_direction (LinkDirection);
259 bool linked() const { return _linked; }
260 void set_linked (bool yn);
262 StreamPanner &streampanner( uint32_t n ) const { assert( n < _streampanners.size() ); return *_streampanners[n]; }
263 uint32_t npanners() const { return _streampanners.size(); }
265 sigc::signal<void> Changed;
266 sigc::signal<void> LinkStateChanged;
267 sigc::signal<void> StateChanged; /* for bypass */
269 /* only StreamPanner should call these */
271 void set_position (float x, StreamPanner& orig);
272 void set_position (float x, float y, StreamPanner& orig);
273 void set_position (float x, float y, float z, StreamPanner& orig);
275 /* old school automation */
279 struct PanControllable : public AutomationControl {
280 PanControllable (Session& s, std::string name, Panner& p, Evoral::Parameter param)
281 : AutomationControl (s, param,
282 boost::shared_ptr<AutomationList>(new AutomationList(param)), name)
284 { assert(param.type() != NullAutomation); }
286 AutomationList* alist() { return (AutomationList*)_list.get(); }
289 void set_value (float);
290 float get_value (void) const;
293 boost::shared_ptr<AutomationControl> pan_control ( int id, int chan=0 ) {
294 return boost::dynamic_pointer_cast<AutomationControl>( control( Evoral::Parameter (PanAutomation, chan, id) ));
297 boost::shared_ptr<const AutomationControl> pan_control ( int id, int chan=0 ) const {
298 return boost::dynamic_pointer_cast<const AutomationControl>( control( Evoral::Parameter (PanAutomation, chan, id) ));
302 void distribute_no_automation(BufferSet& src, BufferSet& dest, nframes_t nframes, nframes_t offset, gain_t gain_coeff);
303 std::vector<StreamPanner*> _streampanners;
304 uint32_t current_outs;
307 LinkDirection _link_direction;
309 static float current_automation_version_number;
311 /* old school automation handling */
313 std::string automation_path;
316 } // namespace ARDOUR
318 #endif /*__ardour_panner_h__ */