libs/panners/vbap/vbap.h

   1 /*
   2     Copyright (C) 2010 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 #ifndef __libardour_vbap_h__
  20 #define __libardour_vbap_h__
  21
  22 #include <string>
  23 #include <map>
  24
  25 #include "pbd/cartesian.h"
  26
  27 #include "ardour/panner.h"
  28 #include "ardour/panner_shell.h"
  29
  30 #include "vbap_speakers.h"
  31
  32 namespace ARDOUR {
  33
  34 class Speakers;
  35 class Pannable;
  36
  37 class VBAPanner : public Panner
  38 {
  39 public:
  40         VBAPanner (boost::shared_ptr<Pannable>, boost::shared_ptr<Speakers>);
  41         ~VBAPanner ();
  42
  43         void configure_io (ChanCount in, ChanCount /* ignored - we use Speakers */);
  44         ChanCount in() const;
  45         ChanCount out() const;
  46
  47         void set_position (double);
  48         void set_width (double);
  49
  50         std::set<Evoral::Parameter> what_can_be_automated() const;
  51
  52         static Panner* factory (boost::shared_ptr<Pannable>, boost::shared_ptr<Speakers>);
  53
  54         void distribute (BufferSet& ibufs, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes);
  55
  56         void set_azimuth_elevation (double azimuth, double elevation);
  57
  58         std::string describe_parameter (Evoral::Parameter);
  59         std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
  60
  61         XMLNode& get_state ();
  62
  63         PBD::AngularVector signal_position (uint32_t n) const;
  64         boost::shared_ptr<Speakers> get_speakers() const;
  65
  66 private:
  67         struct Signal {
  68             PBD::AngularVector direction;
  69             std::vector<double> gains; /* most recently used gain for all speakers */
  70
  71             int outputs[3];  /* most recent set of outputs used (2 or 3, depending on dimension) */
  72             int desired_outputs[3]; /* outputs to use the next time we distribute */
  73             double desired_gains[3]; /* target gains for desired_outputs */
  74
  75             Signal (Session&, VBAPanner&, uint32_t which, uint32_t n_speakers);
  76             void resize_gains (uint32_t n_speakers);
  77         };
  78
  79         std::vector<Signal*> _signals;
  80         boost::shared_ptr<VBAPSpeakers>  _speakers;
  81
  82         void compute_gains (double g[3], int ls[3], int azi, int ele);
  83         void update ();
  84         void clear_signals ();
  85
  86         void distribute_one (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes, uint32_t which);
  87         void distribute_one_automated (AudioBuffer& src, BufferSet& obufs,
  88                                           framepos_t start, framepos_t end, pframes_t nframes,
  89                                           pan_t** buffers, uint32_t which);
  90 };
  91
  92 } /* namespace */
  93
  94 #endif /* __libardour_vbap_h__ */