universal change in the design of the way Route/Track controls are designed and used...
[ardour.git] / libs / ardour / vca.cc
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 #include "pbd/convert.h"
20
21 #include "ardour/automation_control.h"
22 #include "ardour/gain_control.h"
23 #include "ardour/rc_configuration.h"
24 #include "ardour/route.h"
25 #include "ardour/session.h"
26 #include "ardour/vca.h"
27
28 #include "i18n.h"
29
30 using namespace ARDOUR;
31 using namespace PBD;
32 using std::string;
33
34 gint VCA::next_number = 1;
35 string VCA::xml_node_name (X_("VCA"));
36
37 string
38 VCA::default_name_template ()
39 {
40         return _("VCA %n");
41 }
42
43 int
44 VCA::next_vca_number ()
45 {
46         /* recall that atomic_int_add() returns the value before the add. We
47          * start at one, then next one will be two etc.
48          */
49         return g_atomic_int_add (&next_number, 1);
50 }
51
52 void
53 VCA::set_next_vca_number (uint32_t n)
54 {
55         g_atomic_int_set (&next_number, n);
56 }
57
58 uint32_t
59 VCA::get_next_vca_number ()
60 {
61         return g_atomic_int_get (&next_number);
62 }
63
64 VCA::VCA (Session& s,  uint32_t num, const string& name)
65         : Stripable (s, name)
66         , Muteable (s, name)
67         , Automatable (s)
68         , _number (num)
69         , _gain_control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
70         , _solo_requested (false)
71         , _mute_requested (false)
72 {
73 }
74
75 int
76 VCA::init ()
77 {
78         _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
79         _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
80
81         add_control (_gain_control);
82         add_control (_solo_control);
83         add_control (_mute_control);
84
85         return 0;
86 }
87
88 VCA::~VCA ()
89 {
90         DropReferences (); /* emit signal */
91 }
92
93 uint32_t
94 VCA::remote_control_id () const
95 {
96         return 9999999 + _number;
97 }
98
99 XMLNode&
100 VCA::get_state ()
101 {
102         XMLNode* node = new XMLNode (xml_node_name);
103         node->add_property (X_("name"), _name);
104         node->add_property (X_("number"), _number);
105         node->add_property (X_("soloed"), (_solo_requested ? X_("yes") : X_("no")));
106         node->add_property (X_("muted"), (_mute_requested ? X_("yes") : X_("no")));
107
108         node->add_child_nocopy (_gain_control->get_state());
109         node->add_child_nocopy (get_automation_xml_state());
110
111         return *node;
112 }
113
114 int
115 VCA::set_state (XMLNode const& node, int version)
116 {
117         XMLProperty const* prop;
118
119         if ((prop = node.property ("name")) != 0) {
120                 set_name (prop->value());
121         }
122
123         if ((prop = node.property ("number")) != 0) {
124                 _number = atoi (prop->value());
125         }
126
127         XMLNodeList const &children (node.children());
128         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
129                 if ((*i)->name() == Controllable::xml_node_name) {
130                         XMLProperty* prop = (*i)->property ("name");
131                         if (prop && prop->value() == X_("gaincontrol")) {
132                                 _gain_control->set_state (**i, version);
133                         }
134                 }
135         }
136
137         return 0;
138 }
139
140 void
141 VCA::set_solo (bool yn)
142 {
143         _solo_requested = yn;
144 }
145
146 void
147 VCA::set_mute (bool yn)
148 {
149         _mute_requested = yn;
150 }
151
152 bool
153 VCA::soloed () const
154 {
155         return _solo_requested;
156 }
157
158 bool
159 VCA::muted () const
160 {
161         return _mute_requested;
162 }