add Slavable API for VCA assign/unassign
[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 {
71 }
72
73 int
74 VCA::init ()
75 {
76         _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
77         _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
78
79         add_control (_gain_control);
80         add_control (_solo_control);
81         add_control (_mute_control);
82
83         return 0;
84 }
85
86 VCA::~VCA ()
87 {
88         DropReferences (); /* emit signal */
89 }
90
91 uint32_t
92 VCA::remote_control_id () const
93 {
94         return 9999999 + _number;
95 }
96
97 XMLNode&
98 VCA::get_state ()
99 {
100         XMLNode* node = new XMLNode (xml_node_name);
101         node->add_property (X_("name"), _name);
102         node->add_property (X_("number"), _number);
103
104         node->add_child_nocopy (_gain_control->get_state());
105         node->add_child_nocopy (_solo_control->get_state());
106         node->add_child_nocopy (_mute_control->get_state());
107         node->add_child_nocopy (get_automation_xml_state());
108
109         return *node;
110 }
111
112 int
113 VCA::set_state (XMLNode const& node, int version)
114 {
115         XMLProperty const* prop;
116
117         if ((prop = node.property ("name")) != 0) {
118                 set_name (prop->value());
119         }
120
121         if ((prop = node.property ("number")) != 0) {
122                 _number = atoi (prop->value());
123         }
124
125         XMLNodeList const &children (node.children());
126         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
127                 if ((*i)->name() == Controllable::xml_node_name) {
128
129                         XMLProperty* prop = (*i)->property ("name");
130
131                         if (!prop) {
132                                 continue;
133                         }
134
135                         if (prop->value() == _gain_control->name()) {
136                                 _gain_control->set_state (**i, version);
137                         }
138                         if (prop->value() == _solo_control->name()) {
139                                 _solo_control->set_state (**i, version);
140                         }
141                         if (prop->value() == _mute_control->name()) {
142                                 _mute_control->set_state (**i, version);
143                         }
144                 }
145         }
146
147         return 0;
148 }
149
150 void
151 VCA::clear_all_solo_state ()
152 {
153         _solo_control->clear_all_solo_state ();
154 }
155
156 int
157 VCA::assign_controls (boost::shared_ptr<VCA> vca)
158 {
159         _gain_control->add_master (vca->gain_control());
160         _solo_control->add_master (vca->solo_control());
161         _mute_control->add_master (vca->mute_control());
162
163         return 0;
164 }
165
166 int
167 VCA::unassign_controls (boost::shared_ptr<VCA> vca)
168 {
169         if (!vca) {
170                 /* unassign from all */
171                 _gain_control->clear_masters ();
172                 _solo_control->clear_masters ();
173                 _mute_control->clear_masters ();
174         } else {
175                 _gain_control->remove_master (vca->gain_control());
176                 _solo_control->remove_master (vca->solo_control());
177                 _mute_control->remove_master (vca->mute_control());
178         }
179
180         return 0;
181 }