2 Copyright (C) 2006,2007 John Anderson
3 Copyright (C) 2012 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <glibmm/miscutils.h>
24 #include "pbd/xml++.h"
25 #include "pbd/error.h"
26 #include "pbd/pathscanner.h"
28 #include "ardour/filesystem_paths.h"
30 #include "device_info.h"
34 using namespace Mackie;
36 using namespace ARDOUR;
40 std::map<std::string,DeviceInfo> DeviceInfo::device_info;
42 DeviceInfo::DeviceInfo()
45 , _has_two_character_display (true)
46 , _has_master_fader (true)
47 , _has_segmented_display (false)
48 , _has_timecode_display (true)
49 , _has_global_controls (true)
50 , _has_jog_wheel (true)
51 , _has_touch_sense_faders (true)
52 , _uses_logic_control_buttons (false)
53 , _name (X_("Mackie Control Universal Pro"))
55 mackie_control_buttons ();
58 DeviceInfo::~DeviceInfo()
63 DeviceInfo::mackie_control_buttons ()
65 _global_buttons.clear ();
68 _global_buttons[Button::Edit] = GlobalButtonInfo ("edit", "none", 0x33);
70 _global_buttons[Button::F9] = GlobalButtonInfo ("F9", "none", 0x3e);
71 _global_buttons[Button::F10] = GlobalButtonInfo ("F10", "none", 0x3f);
72 _global_buttons[Button::F11] = GlobalButtonInfo ("F11", "none", 0x40);
73 _global_buttons[Button::F12] = GlobalButtonInfo ("F12", "none", 0x41);
74 _global_buttons[Button::F13] = GlobalButtonInfo ("F13", "none", 0x42);
75 _global_buttons[Button::F14] = GlobalButtonInfo ("F14", "none", 0x43);
76 _global_buttons[Button::F15] = GlobalButtonInfo ("F15", "none", 0x44);
77 _global_buttons[Button::F16] = GlobalButtonInfo ("F16", "none", 0x45);
78 _global_buttons[Button::Ctrl] = GlobalButtonInfo ("ctrl", "modifiers", 0x46);
79 _global_buttons[Button::Option] = GlobalButtonInfo ("option", "modifiers", 0x47);
80 _global_buttons[Button::Snapshot] = GlobalButtonInfo ("snapshot", "modifiers", 0x48);
81 _global_buttons[Button::Shift] = GlobalButtonInfo ("shift", "modifiers", 0x49);
82 _global_buttons[Button::Read] = GlobalButtonInfo ("read", "automation", 0x4a);
83 _global_buttons[Button::Write] = GlobalButtonInfo ("write", "automation", 0x4b);
84 _global_buttons[Button::Undo] = GlobalButtonInfo ("undo", "functions", 0x4c);
85 _global_buttons[Button::Save] = GlobalButtonInfo ("save", "automation", 0x4d);
86 _global_buttons[Button::Touch] = GlobalButtonInfo ("touch", "automation", 0x4e);
87 _global_buttons[Button::Redo] = GlobalButtonInfo ("redo", "functions", 0x4f);
88 _global_buttons[Button::FdrGroup] = GlobalButtonInfo ("fader group", "functions", 0x50);
89 _global_buttons[Button::ClearSolo] = GlobalButtonInfo ("clear solo", "functions", 0x51);
90 _global_buttons[Button::Cancel] = GlobalButtonInfo ("cancel", "functions", 0x52);
91 _global_buttons[Button::Marker] = GlobalButtonInfo ("marker", "functions", 0x53);
92 _global_buttons[Button::Mixer] = GlobalButtonInfo ("mixer", "transport", 0x54);
93 _global_buttons[Button::FrmLeft] = GlobalButtonInfo ("frm left", "transport", 0x55);
94 _global_buttons[Button::FrmRight] = GlobalButtonInfo ("frm right", "transport", 0x56);
95 _global_buttons[Button::End] = GlobalButtonInfo ("end", "transport", 0x57);
96 _global_buttons[Button::PunchIn] = GlobalButtonInfo ("punch in", "transport", 0x58);
97 _global_buttons[Button::PunchOut] = GlobalButtonInfo ("punch out", "transport", 0x59);
98 _global_buttons[Button::Loop] = GlobalButtonInfo ("loop", "transport", 0x59);
99 _global_buttons[Button::Home] = GlobalButtonInfo ("home", "transport", 0x5a);
101 _strip_buttons[Button::FaderTouch] = StripButtonInfo (0xe0, "fader touch");
105 DeviceInfo::logic_control_buttons ()
107 _global_buttons.clear ();
110 _global_buttons[Button::View] = GlobalButtonInfo ("view", "view", 0x33);
112 _global_buttons[Button::MidiTracks] = GlobalButtonInfo ("miditracks", "view", 0x3e);
113 _global_buttons[Button::Inputs] = GlobalButtonInfo ("inputs", "view", 0x3f);
114 _global_buttons[Button::AudioTracks] = GlobalButtonInfo ("audiotracks", "view", 0x40);
115 _global_buttons[Button::AudioInstruments] = GlobalButtonInfo ("audio instruments", "view", 0x41);
116 _global_buttons[Button::Aux] = GlobalButtonInfo ("aux", "view", 0x42);
117 _global_buttons[Button::Busses] = GlobalButtonInfo ("busses", "view", 0x43);
118 _global_buttons[Button::Outputs] = GlobalButtonInfo ("outputs", "view", 0x44);
119 _global_buttons[Button::User] = GlobalButtonInfo ("user_ready", "view", 0x45);
120 _global_buttons[Button::Shift] = GlobalButtonInfo ("ctrl", "modifiers", 0x46);
121 _global_buttons[Button::Option] = GlobalButtonInfo ("option", "modifiers", 0x47);
122 _global_buttons[Button::Ctrl] = GlobalButtonInfo ("snapshot", "modifiers", 0x48);
123 _global_buttons[Button::CmdAlt] = GlobalButtonInfo ("shift", "modifiers", 0x49);
124 _global_buttons[Button::Read] = GlobalButtonInfo ("read", "automation", 0x4a);
125 _global_buttons[Button::Write] = GlobalButtonInfo ("write", "automation", 0x4b);
126 _global_buttons[Button::Trim] = GlobalButtonInfo ("trim", "automation", 0x4c);
127 _global_buttons[Button::Touch] = GlobalButtonInfo ("touch", "functions", 0x4d);
128 _global_buttons[Button::Latch] = GlobalButtonInfo ("latch", "functions", 0x4e);
129 _global_buttons[Button::Grp] = GlobalButtonInfo ("group", "functions", 0x4f);
130 _global_buttons[Button::Save] = GlobalButtonInfo ("save", "functions", 0x50);
131 _global_buttons[Button::Undo] = GlobalButtonInfo ("undo", "functions", 0x51);
132 _global_buttons[Button::Cancel] = GlobalButtonInfo ("cancel", "transport", 0x52);
133 _global_buttons[Button::Enter] = GlobalButtonInfo ("enter right", "transport", 0x53);
134 _global_buttons[Button::Marker] = GlobalButtonInfo ("marker", "transport", 0x54);
135 _global_buttons[Button::Nudge] = GlobalButtonInfo ("nudge", "transport", 0x55);
136 _global_buttons[Button::Loop] = GlobalButtonInfo ("cycle", "transport", 0x56);
137 _global_buttons[Button::Drop] = GlobalButtonInfo ("drop", "transport", 0x57);
138 _global_buttons[Button::Replace] = GlobalButtonInfo ("replace", "transport", 0x58);
139 _global_buttons[Button::Click] = GlobalButtonInfo ("click", "transport", 0x59);
140 _global_buttons[Button::Solo] = GlobalButtonInfo ("solo", "transport", 0x5a);
142 _strip_buttons[Button::FaderTouch] = StripButtonInfo (0x68, "fader touch");
146 DeviceInfo::shared_buttons ()
148 _global_buttons[Button::Track] = GlobalButtonInfo ("track", "assignment", 0x28);
149 _global_buttons[Button::Send] = GlobalButtonInfo ("send", "assignment", 0x29);
150 _global_buttons[Button::Pan] = GlobalButtonInfo ("pan", "assignment", 0x2a);
151 _global_buttons[Button::Plugin] = GlobalButtonInfo ("plugin", "assignment", 0x2b);
152 _global_buttons[Button::Eq] = GlobalButtonInfo ("eq", "assignment", 0x2c);
153 _global_buttons[Button::Dyn] = GlobalButtonInfo ("dyn", "assignment", 0x2d);
154 _global_buttons[Button::Left] = GlobalButtonInfo ("left", "bank", 0x2e);
155 _global_buttons[Button::Right] = GlobalButtonInfo ("right", "bank", 0x2f);
156 _global_buttons[Button::ChannelLeft] = GlobalButtonInfo ("channelleft", "bank", 0x30);
157 _global_buttons[Button::ChannelRight] = GlobalButtonInfo ("channelright", "bank", 0x31);
158 _global_buttons[Button::Flip] = GlobalButtonInfo ("flip", "none", 0x32);
160 _global_buttons[Button::NameValue] = GlobalButtonInfo ("name/value", "display", 0x34);
161 _global_buttons[Button::TimecodeBeats] = GlobalButtonInfo ("timecode/beats", "display", 0x35);
162 _global_buttons[Button::F1] = GlobalButtonInfo ("F1", "none", 0x36);
163 _global_buttons[Button::F2] = GlobalButtonInfo ("F2", "none", 0x37);
164 _global_buttons[Button::F3] = GlobalButtonInfo ("F3", "none", 0x38);
165 _global_buttons[Button::F4] = GlobalButtonInfo ("F4", "none", 0x39);
166 _global_buttons[Button::F5] = GlobalButtonInfo ("F5", "none", 0x3a);
167 _global_buttons[Button::F6] = GlobalButtonInfo ("F6", "none", 0x3b);
168 _global_buttons[Button::F7] = GlobalButtonInfo ("F7", "none", 0x3c);
169 _global_buttons[Button::F8] = GlobalButtonInfo ("F8", "none", 0x3d);
171 _global_buttons[Button::Rewind] = GlobalButtonInfo ("rewind", "transport", 0x5b);
172 _global_buttons[Button::Ffwd] = GlobalButtonInfo ("ffwd", "transport", 0x5c);
173 _global_buttons[Button::Stop] = GlobalButtonInfo ("stop", "transport", 0x5d);
174 _global_buttons[Button::Play] = GlobalButtonInfo ("play", "transport", 0x5e);
175 _global_buttons[Button::Record] = GlobalButtonInfo ("record", "transport", 0x5f);
176 _global_buttons[Button::CursorUp] = GlobalButtonInfo ("cursor up", "cursor", 0x60);
177 _global_buttons[Button::CursorDown] = GlobalButtonInfo ("cursor down", "cursor", 0x61);
178 _global_buttons[Button::CursorLeft] = GlobalButtonInfo ("cursor left", "cursor", 0x62);
179 _global_buttons[Button::CursorRight] = GlobalButtonInfo ("cursor right", "cursor", 0x63);
180 _global_buttons[Button::Zoom] = GlobalButtonInfo ("zoom", "none", 0x64);
181 _global_buttons[Button::Scrub] = GlobalButtonInfo ("scrub", "none", 0x65);
182 _global_buttons[Button::UserA] = GlobalButtonInfo ("user a", "user", 0x66);
183 _global_buttons[Button::UserB] = GlobalButtonInfo ("user b", "user", 0x67);
185 _strip_buttons[Button::RecEnable] = StripButtonInfo (0x0, "recenable");
186 _strip_buttons[Button::Solo] = StripButtonInfo (0x08, "solo");
187 _strip_buttons[Button::Mute] = StripButtonInfo (0x10, "mute");
188 _strip_buttons[Button::Select] = StripButtonInfo (0x18, "select");
189 _strip_buttons[Button::VSelect] = StripButtonInfo (0x20, "vselect");
193 DeviceInfo::set_state (const XMLNode& node, int /* version */)
195 const XMLProperty* prop;
196 const XMLNode* child;
198 if (node.name() != "MackieProtocolDevice") {
202 /* name is mandatory */
204 if ((child = node.child ("Name")) != 0) {
205 if ((prop = child->property ("value")) != 0) {
206 _name = prop->value();
212 if ((child = node.child ("Strips")) != 0) {
213 if ((prop = child->property ("value")) != 0) {
214 if ((_strip_cnt = atoi (prop->value())) == 0) {
220 if ((child = node.child ("Extenders")) != 0) {
221 if ((prop = child->property ("value")) != 0) {
222 if ((_extenders = atoi (prop->value())) == 0) {
228 if ((child = node.child ("TwoCharacterDisplay")) != 0) {
229 if ((prop = child->property ("value")) != 0) {
230 _has_two_character_display = string_is_affirmative (prop->value());
234 if ((child = node.child ("MasterFader")) != 0) {
235 if ((prop = child->property ("value")) != 0) {
236 _has_master_fader = string_is_affirmative (prop->value());
240 if ((child = node.child ("DisplaySegments")) != 0) {
241 if ((prop = child->property ("value")) != 0) {
242 _has_segmented_display = string_is_affirmative (prop->value());
246 if ((child = node.child ("TimecodeDisplay")) != 0) {
247 if ((prop = child->property ("value")) != 0) {
248 _has_timecode_display = string_is_affirmative (prop->value());
252 if ((child = node.child ("GlobalControls")) != 0) {
253 if ((prop = child->property ("value")) != 0) {
254 _has_global_controls = string_is_affirmative (prop->value());
258 if ((child = node.child ("JogWheel")) != 0) {
259 if ((prop = child->property ("value")) != 0) {
260 _has_jog_wheel = string_is_affirmative (prop->value());
264 if ((child = node.child ("TouchSenseFaders")) != 0) {
265 if ((prop = child->property ("value")) != 0) {
266 _has_touch_sense_faders = string_is_affirmative (prop->value());
270 if ((child = node.child ("LogicControlButtons")) != 0) {
271 if ((prop = child->property ("value")) != 0) {
272 _uses_logic_control_buttons = string_is_affirmative (prop->value());
274 if (_uses_logic_control_buttons) {
275 logic_control_buttons();
277 mackie_control_buttons ();
282 if ((child = node.child ("Buttons")) != 0) {
283 XMLNodeConstIterator i;
284 const XMLNodeList& nlist (child->children());
286 for (i = nlist.begin(); i != nlist.end(); ++i) {
287 if ((*i)->name() == "GlobalButton") {
288 if ((prop = (*i)->property ("name")) != 0) {
289 int id = Button::name_to_id (prop->value());
291 Button::ID bid = (Button::ID) id;
292 if ((prop = (*i)->property ("id")) != 0) {
293 int val = strtol (prop->value().c_str(), 0, 0);
294 std::map<Button::ID,GlobalButtonInfo>::iterator b = _global_buttons.find (bid);
295 if (b != _global_buttons.end()) {
298 if ((prop = (*i)->property ("label")) != 0) {
299 b->second.label = prop->value();
307 } else if ((*i)->name() == "StripButton") {
308 if ((prop = (*i)->property ("name")) != 0) {
309 int id = Button::name_to_id (prop->value());
311 Button::ID bid = (Button::ID) id;
312 if ((prop = (*i)->property ("baseid")) != 0) {
313 int val = strtol (prop->value().c_str(), 0, 0);
314 std::map<Button::ID,StripButtonInfo>::iterator b = _strip_buttons.find (bid);
315 if (b != _strip_buttons.end()) {
316 b->second.base_id = val;
331 DeviceInfo::name() const
337 DeviceInfo::strip_cnt() const
343 DeviceInfo::extenders() const
349 DeviceInfo::has_master_fader() const
351 return _has_master_fader;
355 DeviceInfo::has_two_character_display() const
357 return _has_two_character_display;
361 DeviceInfo::has_segmented_display() const
363 return _has_segmented_display;
367 DeviceInfo::has_timecode_display () const
369 return _has_timecode_display;
373 DeviceInfo::has_global_controls () const
375 return _has_global_controls;
379 DeviceInfo::has_jog_wheel () const
381 return _has_jog_wheel;
385 DeviceInfo::has_touch_sense_faders () const
387 return _has_touch_sense_faders;
390 static const char * const devinfo_env_variable_name = "ARDOUR_MCP_PATH";
391 static const char* const devinfo_dir_name = "mcp";
392 static const char* const devinfo_suffix = ".device";
395 system_devinfo_search_path ()
397 bool devinfo_path_defined = false;
398 sys::path spath_env (Glib::getenv (devinfo_env_variable_name, devinfo_path_defined));
400 if (devinfo_path_defined) {
404 SearchPath spath (system_data_search_path());
405 spath.add_subdirectory_to_paths(devinfo_dir_name);
407 // just return the first directory in the search path that exists
408 SearchPath::const_iterator i = std::find_if(spath.begin(), spath.end(), sys::exists);
410 if (i == spath.end()) return sys::path();
416 user_devinfo_directory ()
418 sys::path p(user_config_directory());
419 p /= devinfo_dir_name;
425 devinfo_filter (const string &str, void */*arg*/)
427 return (str.length() > strlen(devinfo_suffix) &&
428 str.find (devinfo_suffix) == (str.length() - strlen (devinfo_suffix)));
432 DeviceInfo::reload_device_info ()
436 vector<string *> *devinfos;
438 SearchPath spath (system_devinfo_search_path());
439 spath += user_devinfo_directory ();
441 devinfos = scanner (spath.to_string(), devinfo_filter, 0, false, true);
442 device_info.clear ();
445 error << "No MCP device info files found using " << spath.to_string() << endmsg;
446 std::cerr << "No MCP device info files found using " << spath.to_string() << std::endl;
450 if (devinfos->empty()) {
451 error << "No MCP device info files found using " << spath.to_string() << endmsg;
452 std::cerr << "No MCP device info files found using " << spath.to_string() << std::endl;
456 for (vector<string*>::iterator i = devinfos->begin(); i != devinfos->end(); ++i) {
457 string fullpath = *(*i);
462 if (!tree.read (fullpath.c_str())) {
466 XMLNode* root = tree.root ();
471 if (di.set_state (*root, 3000) == 0) { /* version is ignored for now */
472 device_info[di.name()] = di;
479 std::ostream& operator<< (std::ostream& os, const Mackie::DeviceInfo& di)
481 os << di.name() << ' '
482 << di.strip_cnt() << ' '
483 << di.extenders() << ' '