expand and improve VCA API
[ardour.git] / 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
27 #include "ardour/session_handle.h"
28
29 namespace ARDOUR {
30
31 class GainControl;
32 class Route;
33
34 class LIBARDOUR_API VCA : public SessionHandleRef {
35   public:
36         VCA (Session& session, const std::string& name, uint32_t num);
37
38         std::string name() const { return _name; }
39         uint32_t number () const { return _number; }
40
41         void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
42         double get_value () const;
43
44         boost::shared_ptr<GainControl> control() const { return _control; }
45
46         void add (boost::shared_ptr<Route>);
47         void remove (boost::shared_ptr<Route>);
48
49         static std::string default_name_template ();
50         static int next_vca_number ();
51   private:
52         uint32_t    _number;
53         std::string _name;
54         boost::shared_ptr<GainControl> _control;
55
56         static gint next_number;
57 };
58
59 } /* namespace */
60
61 #endif /* __ardour_vca_h__ */