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,  uint32_t num, const std::string& name);
  39         VCA (Session& session, XMLNode const&, int version);
  40         ~VCA();
  41
  42         std::string name() const { return _name; }
  43         uint32_t number () const { return _number; }
  44
  45         void set_name (std::string const&);
  46
  47         void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
  48         double get_value () const;
  49
  50         boost::shared_ptr<GainControl> control() const { return _control; }
  51
  52         XMLNode& get_state();
  53         int set_state (XMLNode const&, int version);
  54
  55         void add_solo_mute_target (boost::shared_ptr<Route>);
  56         void remove_solo_mute_target (boost::shared_ptr<Route>);
  57
  58         void set_solo (bool yn);
  59         bool soloed () const;
  60
  61         void set_mute (bool yn);
  62         bool muted () const;
  63
  64         PBD::Signal0<void> SoloChange;
  65         PBD::Signal0<void> MuteChange;
  66
  67         static std::string default_name_template ();
  68         static int next_vca_number ();
  69         static std::string xml_node_name;
  70
  71   private:
  72         uint32_t    _number;
  73         std::string _name;
  74         boost::shared_ptr<GainControl> _control;
  75         RouteList solo_mute_targets;
  76         PBD::ScopedConnectionList solo_mute_connections;
  77         mutable Glib::Threads::RWLock solo_mute_lock;
  78         bool _solo_requested;
  79         bool _mute_requested;
  80
  81         static gint next_number;
  82
  83         void solo_mute_target_going_away (boost::weak_ptr<Route>);
  84         bool soloed_locked () const;
  85         bool muted_locked () const;
  86
  87 };
  88
  89 } /* namespace */
  90
  91 #endif /* __ardour_vca_h__ */