libs/panners/1in2out/panner_1in2out.h

   1 /*
   2     Copyright (C) 2004-2011 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_panner_1in2out_h__
  21 #define __ardour_panner_1in2out_h__
  22
  23 #include <cmath>
  24 #include <cassert>
  25 #include <vector>
  26 #include <string>
  27 #include <iostream>
  28
  29 #include "pbd/stateful.h"
  30 #include "pbd/controllable.h"
  31 #include "pbd/cartesian.h"
  32
  33 #include "ardour/types.h"
  34 #include "ardour/panner.h"
  35
  36 namespace ARDOUR {
  37
  38 class Panner1in2out : public Panner
  39 {
  40   public:
  41         Panner1in2out (boost::shared_ptr<Pannable>);
  42         ~Panner1in2out ();
  43
  44         void set_position (double);
  45         bool clamp_position (double&);
  46
  47         double position() const;
  48
  49         ChanCount in() const { return ChanCount (DataType::AUDIO, 1); }
  50         ChanCount out() const { return ChanCount (DataType::AUDIO, 2); }
  51
  52         std::set<Evoral::Parameter> what_can_be_automated() const;
  53
  54         /* this class just leaves the pan law itself to be defined
  55            by the update(), do_distribute_automated()
  56            methods. derived classes also need a factory method
  57            and a type name. See EqualPowerStereoPanner as an example.
  58         */
  59
  60         static Panner* factory (boost::shared_ptr<Pannable>, Speakers&);
  61
  62         std::string describe_parameter (Evoral::Parameter);
  63
  64         XMLNode& state (bool full_state);
  65         XMLNode& get_state (void);
  66         int      set_state (const XMLNode&, int version);
  67
  68   protected:
  69         float left;
  70         float right;
  71         float desired_left;
  72         float desired_right;
  73         float left_interp;
  74         float right_interp;
  75
  76         void distribute_one (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which);
  77         void distribute_one_automated (AudioBuffer& srcbuf, BufferSet& obufs,
  78                                        framepos_t start, framepos_t end, pframes_t nframes,
  79                                        pan_t** buffers, uint32_t which);
  80
  81         void update ();
  82 };
  83
  84 } // namespace
  85
  86 #endif /* __ardour_panner_1in2out_h__ */