libs/ardour/ardour/vca.h

   1 /*
   2     Copyright (C) 2016 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __ardour_vca_h__
  20 #define __ardour_vca_h__
  21
  22 #include <string>
  23 #include <boost/shared_ptr.hpp>
  24
  25 #include "pbd/controllable.h"
  26 #include "pbd/statefuldestructible.h"
  27
  28 #include "ardour/automatable.h"
  29 #include "ardour/session_handle.h"
  30
  31 namespace ARDOUR {
  32
  33 class GainControl;
  34 class Route;
  35
  36 class LIBARDOUR_API VCA : public SessionHandleRef, public PBD::StatefulDestructible, public Automatable {
  37   public:
  38         VCA (Session& session, const std::string& name, uint32_t num);
  39         VCA (Session& session, XMLNode const&, int version);
  40
  41         std::string name() const { return _name; }
  42         uint32_t number () const { return _number; }
  43
  44         void set_name (std::string const&);
  45
  46         void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
  47         double get_value () const;
  48
  49         boost::shared_ptr<GainControl> control() const { return _control; }
  50
  51         void add (boost::shared_ptr<Route>);
  52         void remove (boost::shared_ptr<Route>);
  53
  54         XMLNode& get_state();
  55         int set_state (XMLNode const&, int version);
  56
  57         static std::string default_name_template ();
  58         static int next_vca_number ();
  59         static std::string xml_node_name;
  60
  61   private:
  62         uint32_t    _number;
  63         std::string _name;
  64         boost::shared_ptr<GainControl> _control;
  65
  66         static gint next_number;
  67 };
  68
  69 } /* namespace */
  70
  71 #endif /* __ardour_vca_h__ */