2 Copyright (C) 2009-2013 Paul Davis
3 Authors: Sampo Savolainen, Jannis Pohlmann
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.
23 #include "pbd/compose.h"
24 #include "pbd/error.h"
25 #include "ardour/debug.h"
26 #include "ardour/session.h"
31 using namespace ARDOUR;
35 #include "pbd/abstract_ui.cc" // instantiate template
37 void wiimote_control_protocol_mesg_callback (cwiid_wiimote_t *wiimote, int mesg_count, union cwiid_mesg mesg[], timespec *t);
39 WiimoteControlProtocol::WiimoteControlProtocol (Session& session)
40 : ControlProtocol (session, X_("Wiimote"))
41 , AbstractUI<WiimoteControlUIRequest> ("wiimote")
45 , callback_thread_registered (false)
49 WiimoteControlProtocol::~WiimoteControlProtocol ()
55 WiimoteControlProtocol::probe ()
61 WiimoteControlProtocol::set_active (bool yn)
65 DEBUG_TRACE (DEBUG::WiimoteControl, string_compose ("WiimoteControlProtocol::set_active init with yn: '%1'\n", yn));
67 /* do nothing if the active state is not changing */
73 /* activate Wiimote control surface */
76 /* deactivate Wiimote control surface */
80 /* remember new active state */
83 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::set_active done\n");
89 WiimoteControlProtocol::get_state ()
91 XMLNode *node = new XMLNode ("Protocol");
92 node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
93 node->add_property (X_("feedback"), "0");
98 WiimoteControlProtocol::set_state (const XMLNode&, int)
104 WiimoteControlProtocol::do_request (WiimoteControlUIRequest* req)
106 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::do_request init\n");
108 if (req->type == CallSlot) {
109 call_slot (MISSING_INVALIDATOR, req->the_slot);
110 } else if (req->type == Quit) {
114 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::do_request done\n");
118 WiimoteControlProtocol::start ()
120 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::start init\n");
122 // update LEDs whenever the transport or recording state changes
123 session->TransportStateChange.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&WiimoteControlProtocol::update_led_state, this), this);
124 session->RecordStateChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&WiimoteControlProtocol::update_led_state, this), this);
126 // start the Wiimote control UI; it will run in its own thread context
129 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::start done\n");
135 WiimoteControlProtocol::stop ()
137 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::stop init\n");
139 // stop wiimote discovery, just in case
140 stop_wiimote_discovery ();
142 // close and reset the wiimote handle
144 cwiid_close (wiimote);
146 callback_thread_registered = false;
149 // stop the Wiimote control UI
152 // no longer update the LEDs
153 session_connections.drop_connections ();
155 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::stop done\n");
161 WiimoteControlProtocol::thread_init ()
163 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::thread_init init\n");
165 pthread_set_name (X_("wiimote"));
167 // allow to make requests to the GUI and RT thread(s)
168 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self (), X_("wiimote"), 2048);
169 BasicUI::register_thread ("wiimote");
172 start_wiimote_discovery ();
174 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::thread_init done\n");
178 WiimoteControlProtocol::start_wiimote_discovery ()
180 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::start_wiimote_discovery init\n");
182 // connect to the Wiimote using an idle source
183 Glib::RefPtr<Glib::IdleSource> source = Glib::IdleSource::create ();
184 source->connect (sigc::mem_fun (*this, &WiimoteControlProtocol::connect_idle));
185 source->attach (_main_loop->get_context ());
187 // grab a reference on the underlying idle source to keep it around
188 idle_source = source->gobj ();
189 g_source_ref (idle_source);
191 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::start_wiimote_discovery done\n");
195 WiimoteControlProtocol::stop_wiimote_discovery ()
197 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::stop_wiimote_discovery init\n");
200 g_source_unref (idle_source);
204 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::stop_wiimote_discovery done\n");
208 WiimoteControlProtocol::connect_idle ()
210 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::connect_idle init\n");
214 if (connect_wiimote ()) {
215 stop_wiimote_discovery ();
219 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::connect_idle done\n");
225 WiimoteControlProtocol::connect_wiimote ()
227 // abort the discovery and do nothing else if we already have a Wiimote
234 // if we don't have a Wiimote yet, try to discover it; if that
235 // fails, wait for a short period of time and try again
237 cerr << "Wiimote: Not discovered yet, press 1+2 to connect" << endl;
239 bdaddr_t bdaddr = {{ 0, 0, 0, 0, 0, 0 }};
240 wiimote = cwiid_open (&bdaddr, 0);
241 callback_thread_registered = false;
245 // a Wiimote was discovered
246 cerr << "Wiimote: Connected successfully" << endl;
248 // attach the WiimoteControlProtocol object to the Wiimote handle
249 if (cwiid_set_data (wiimote, this)) {
250 cerr << "Wiimote: Failed to attach control protocol" << endl;
254 // clear the last button state to start processing events cleanly
259 // enable message based communication with the Wiimote
260 if (success && cwiid_enable (wiimote, CWIID_FLAG_MESG_IFC)) {
261 cerr << "Wiimote: Failed to enable message based communication" << endl;
265 // enable button events to be received from the Wiimote
266 if (success && cwiid_command (wiimote, CWIID_CMD_RPT_MODE, CWIID_RPT_BTN)) {
267 cerr << "Wiimote: Failed to enable button events" << endl;
271 // receive an event for every single button pressed, not just when
272 // a different button was pressed than before
273 if (success && cwiid_enable (wiimote, CWIID_FLAG_REPEAT_BTN)) {
274 cerr << "Wiimote: Failed to enable repeated button events" << endl;
278 // be notified of new input events
279 if (success && cwiid_set_mesg_callback (wiimote, wiimote_control_protocol_mesg_callback)) {
282 // reset Wiimote handle if the configuration failed
283 if (!success && wiimote) {
284 cwiid_close (wiimote);
286 callback_thread_registered = false;
293 WiimoteControlProtocol::update_led_state ()
295 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::update_led_state init\n");
299 // do nothing if we do not have a Wiimote
301 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::update_led_state no wiimote connected\n");
305 // enable LED1 if Ardour is playing
306 if (session->transport_rolling ()) {
307 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::update_led_state playing, activate LED1\n");
308 state |= CWIID_LED1_ON;
311 // enable LED4 if Ardour is recording
312 if (session->actively_recording ()) {
313 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::update_led_state recording, activate LED4\n");
314 state |= CWIID_LED4_ON;
317 // apply the LED state
318 cwiid_set_led (wiimote, state);
320 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::update_led_state done\n");
324 WiimoteControlProtocol::wiimote_callback (int mesg_count, union cwiid_mesg mesg[])
326 // register the cwiid callback thread if that hasn't happened yet
327 if (!callback_thread_registered) {
328 BasicUI::register_thread ("wiimote callback");
329 callback_thread_registered = true;
332 for (int i = 0; i < mesg_count; i++) {
333 // restart Wiimote discovery when receiving errors
334 if (mesg[i].type == CWIID_MESG_ERROR) {
335 cerr << "Wiimote: disconnected" << endl;
336 cwiid_close (wiimote);
338 callback_thread_registered = false;
339 start_wiimote_discovery ();
343 // skip non-button events
344 if (mesg[i].type != CWIID_MESG_BTN) {
348 // drop buttons from the event that were already pressed before
349 uint16_t b = mesg[i].btn_mesg.buttons & ~button_state;
351 // remember new button state
352 button_state = mesg[i].btn_mesg.buttons;
354 if (button_state & CWIID_BTN_B) {
355 // B + A = abort recording and jump back
356 if (b & CWIID_BTN_A) {
357 access_action ("Transport/ToggleRollForgetCapture");
360 // B + left = move playhead to previous region boundary
361 if (b & CWIID_BTN_LEFT) {
362 access_action ("Editor/playhead-to-previous-region-boundary");
365 // B + right = move playhead to next region boundary
366 if (b & CWIID_BTN_RIGHT) {
367 access_action ("Editor/playhead-to-next-region-boundary");
370 // B + up = move playhead to next marker
371 if (b & CWIID_BTN_UP) {
375 // B + down = move playhead to prev marker
376 if (b & CWIID_BTN_DOWN) {
380 // B + Home = add marker at playhead
381 if (b & CWIID_BTN_HOME) {
382 access_action ("Editor/add-location-from-playhead");
385 // B + minus = move playhead to the start
386 if (b & CWIID_BTN_MINUS) {
387 access_action ("Transport/GotoStart");
390 // B + plus = move playhead to the end
391 if (b & CWIID_BTN_PLUS) {
392 access_action ("Transport/GotoEnd");
395 // A = toggle playback
396 if (b & CWIID_BTN_A) {
397 access_action ("Transport/ToggleRoll");
400 // 1 = toggle recording on the current track
401 if (b & CWIID_BTN_1) {
402 access_action ("Editor/track-record-enable-toggle");
405 // 2 = enable recording in general
406 if (b & CWIID_BTN_2) {
407 rec_enable_toggle ();
410 // left = move playhead back a bit
411 if (b & CWIID_BTN_LEFT) {
412 access_action ("Editor/nudge-playhead-backward");
415 // right = move playhead forward a bit
416 if (b & CWIID_BTN_RIGHT) {
417 access_action ("Editor/nudge-playhead-forward");
420 // up = select previous track
421 if (b & CWIID_BTN_UP) {
422 access_action ("Editor/select-prev-route");
425 // down = select next track
426 if (b & CWIID_BTN_DOWN) {
427 access_action ("Editor/select-next-route");
431 if (b & CWIID_BTN_PLUS) {
432 access_action ("Editor/temporal-zoom-in");
436 if (b & CWIID_BTN_MINUS) {
437 access_action ("Editor/temporal-zoom-out");
441 if (b & CWIID_BTN_HOME) {
442 access_action ("Editor/playhead-to-edit");
449 wiimote_control_protocol_mesg_callback (cwiid_wiimote_t *wiimote, int mesg_count, union cwiid_mesg mesg[], timespec *)
451 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::mesg_callback init\n");
453 WiimoteControlProtocol *protocol = (WiimoteControlProtocol *)cwiid_get_data (wiimote);
456 protocol->wiimote_callback (mesg_count, mesg);
459 DEBUG_TRACE (DEBUG::WiimoteControl, "WiimoteControlProtocol::mesg_callback done\n");