2 * Copyright (C) 2006 Paul Davis
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
31 #include <glibmm/miscutils.h>
32 #include <boost/signals2.hpp>
34 #include <pbd/pthread_utils.h>
35 #include <pbd/file_utils.h>
36 #include <pbd/filesystem.h>
37 #include <pbd/failed_constructor.h>
39 #include "ardour/session.h"
40 #include "ardour/route.h"
41 #include "ardour/audio_track.h"
42 #include "ardour/midi_track.h"
43 #include "ardour/dB.h"
44 #include "ardour/filesystem_paths.h"
47 #include "osc_controllable.h"
50 using namespace ARDOUR;
54 #include "pbd/abstract_ui.cc" // instantiate template
56 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
58 OSC* OSC::_instance = 0;
61 static void error_callback(int num, const char *m, const char *path)
63 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
66 static void error_callback(int, const char *, const char *)
72 OSC::OSC (Session& s, uint32_t port)
73 : ControlProtocol (s, "OSC", this)
74 , AbstractUI<OSCUIRequest> ("osc")
81 _namespace_root = "/ardour";
82 _send_route_changes = true;
88 // "Application Hooks"
90 session->Exported.connect (*this, ui_bind (&OSC::session_exported, this, _1, _2), this);
100 OSC::do_request (OSCUIRequest* req)
102 if (req->type == CallSlot) {
104 call_slot (req->the_slot);
106 } else if (req->type == Quit) {
113 OSC::set_active (bool yn)
123 OSC::get_active () const
125 return _osc_server != 0;
129 OSC::set_feedback (bool yn)
131 _send_route_changes = yn;
136 OSC::get_feedback () const
138 return _send_route_changes;
147 /* already started */
151 for (int j=0; j < 20; ++j) {
152 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
154 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
158 cerr << "can't get osc at port: " << _port << endl;
164 #ifdef ARDOUR_OSC_UNIX_SERVER
166 // APPEARS sluggish for now
168 // attempt to create unix socket server too
170 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
171 int fd = mkstemp(tmpstr);
177 _osc_unix_server = lo_server_new (tmpstr, error_callback);
179 if (_osc_unix_server) {
180 _osc_unix_socket_path = tmpstr;
185 cerr << "OSC @ " << get_server_url () << endl;
187 PBD::sys::path url_file;
189 if (find_file_in_search_path (ardour_search_path() + system_config_search_path(),
190 "osc_url", url_file)) {
191 _osc_url_file = url_file.to_string();
193 urlfile.open(_osc_url_file.c_str(), ios::trunc);
196 urlfile << get_server_url () << endl;
201 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
205 register_callbacks();
207 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
209 /* startup the event loop thread */
219 if (_osc_unix_server) {
220 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
221 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
222 src->attach (_main_loop->get_context());
223 local_server = src->gobj();
224 g_source_ref (local_server);
228 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
229 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
230 src->attach (_main_loop->get_context());
231 remote_server = src->gobj();
232 g_source_ref (remote_server);
235 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
236 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
245 g_source_destroy (local_server);
246 g_source_unref (local_server);
251 g_source_destroy (remote_server);
252 g_source_unref (remote_server);
259 int fd = lo_server_get_socket_fd(_osc_server);
263 lo_server_free (_osc_server);
267 if (_osc_unix_server) {
268 int fd = lo_server_get_socket_fd(_osc_unix_server);
272 lo_server_free (_osc_unix_server);
273 _osc_unix_server = 0;
276 if (!_osc_unix_socket_path.empty()) {
277 unlink (_osc_unix_socket_path.c_str());
280 if (!_osc_url_file.empty() ) {
281 unlink (_osc_url_file.c_str() );
288 OSC::register_callbacks()
293 srvs[0] = _osc_server;
294 srvs[1] = _osc_unix_server;
296 for (size_t i = 0; i < 2; ++i) {
304 /* this is a special catchall handler */
306 lo_server_add_method (serv, 0, 0, _catchall, this);
308 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
310 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
311 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
312 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
313 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
314 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
315 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
316 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
317 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
318 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
319 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
320 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
321 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
322 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
323 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
324 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
325 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
326 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
327 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
328 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
330 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
331 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
332 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
333 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
334 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
338 /* still not-really-standardized query interface */
339 REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
340 REGISTER_CALLBACK (serv, "/ardour/set", "", set);
344 // un/register_update args= s:ctrl s:returl s:retpath
345 lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
346 lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
347 lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
348 lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
354 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
361 lo_server_recv (srv);
368 OSC::get_server_url()
374 urlstr = lo_server_get_url (_osc_server);
383 OSC::get_unix_server_url()
388 if (_osc_unix_server) {
389 urlstr = lo_server_get_url (_osc_unix_server);
399 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
403 subpath = (char*) malloc (len-15+1);
404 memcpy (subpath, path, len-15);
405 subpath[len-15] = '\0';
407 send_current_value (subpath, argv, argc, msg);
413 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
419 lo_message reply = lo_message_new ();
420 boost::shared_ptr<Route> r;
423 lo_message_add_string (reply, path);
426 lo_message_add_string (reply, "bad syntax");
429 r = session->route_by_remote_id (id);
432 lo_message_add_string (reply, "not found");
435 if (strcmp (path, "/routes/state") == 0) {
437 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
438 lo_message_add_string (reply, "AT");
439 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
440 lo_message_add_string (reply, "MT");
442 lo_message_add_string (reply, "B");
445 lo_message_add_string (reply, r->name().c_str());
446 lo_message_add_int32 (reply, r->n_inputs().n_audio());
447 lo_message_add_int32 (reply, r->n_outputs().n_audio());
448 lo_message_add_int32 (reply, r->muted());
449 lo_message_add_int32 (reply, r->soloed());
451 } else if (strcmp (path, "/routes/mute") == 0) {
453 lo_message_add_int32 (reply, (float) r->muted());
455 } else if (strcmp (path, "/routes/solo") == 0) {
457 lo_message_add_int32 (reply, r->soloed());
462 lo_send_message (lo_message_get_source (msg), "#reply", reply);
463 lo_message_free (reply);
467 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
469 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
473 OSC::catchall (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg)
476 int ret = 1; /* unhandled */
478 cerr << "Received a message, path = " << path << " types = \""
479 << (types ? types : "NULL") << '"' << endl;
481 /* 15 for /#current_value plus 2 for /<path> */
485 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
486 current_value_query (path, len, argv, argc, msg);
489 } else if (strcmp (path, "/routes/listen") == 0) {
491 cerr << "set up listener\n";
493 lo_message reply = lo_message_new ();
496 lo_message_add_string (reply, "syntax error");
498 for (int n = 0; n < argc; ++n) {
500 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
503 lo_message_add_string (reply, "not found");
504 cerr << "no such route\n";
507 cerr << "add listener\n";
508 listen_to_route (r, lo_message_get_source (msg));
509 lo_message_add_int32 (reply, argv[n]->i);
514 lo_send_message (lo_message_get_source (msg), "#reply", reply);
515 lo_message_free (reply);
517 } else if (strcmp (path, "/routes/ignore") == 0) {
519 for (int n = 0; n < argc; ++n) {
521 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
524 end_listen (r, lo_message_get_source (msg));
533 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
535 Controllables::iterator x;
536 bool route_exists = false;
538 cerr << "listen to route\n";
540 /* avoid duplicate listens */
542 for (x = controllables.begin(); x != controllables.end(); ++x) {
544 OSCRouteControllable* rc;
546 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
548 if (rc->route() == route) {
551 /* XXX NEED lo_address_equal() */
553 if (rc->address() == addr) {
560 cerr << "listener binding to signals\n";
565 path = X_("/route/solo");
566 c = new OSCRouteControllable (addr, path, route->solo_control(), route);
567 controllables.push_back (c);
569 path = X_("/route/mute");
570 c = new OSCRouteControllable (addr, path, route->mute_control(), route);
571 controllables.push_back (c);
573 path = X_("/route/gain");
574 c = new OSCRouteControllable (addr, path, route->gain_control(), route);
575 controllables.push_back (c);
577 cerr << "Now have " << controllables.size() << " controllables\n";
579 /* if there is no existing controllable related to this route, make sure we clean up
580 if it is ever deleted.
584 route->DropReferences.connect (*this, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
589 OSC::drop_route (boost::weak_ptr<Route> wr)
591 boost::shared_ptr<Route> r = wr.lock ();
597 for (Controllables::iterator x = controllables.begin(); x != controllables.end();) {
599 OSCRouteControllable* rc;
601 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
602 if (rc->route() == r) {
604 x = controllables.erase (x);
615 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
617 Controllables::iterator x;
619 for (x = controllables.begin(); x != controllables.end(); ++x) {
621 OSCRouteControllable* rc;
623 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
625 /* XXX NEED lo_address_equal () */
627 if (rc->route() == r && rc->address() == addr) {
628 controllables.erase (x);
635 // "Application Hook" Handlers //
637 OSC::session_loaded( Session& s ) {
638 lo_address listener = lo_address_new( NULL, "7770" );
639 lo_send( listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str() );
643 OSC::session_exported( std::string path, std::string name ) {
644 lo_address listener = lo_address_new( NULL, "7770" );
645 lo_send( listener, "/session/exported", "ss", path.c_str(), name.c_str() );
648 // end "Application Hook" Handlers //
653 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
658 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
662 const char *returl = argv[1]->s;
663 lo_address addr = find_or_cache_addr (returl);
665 const char *retpath = argv[2]->s;
668 if (strcmp (argv[0]->s, "transport_frame") == 0) {
671 lo_send (addr, retpath, "i", session->transport_frame());
674 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
677 lo_send (addr, retpath, "i", session->transport_frame());
680 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
683 lo_send (addr, retpath, "i", session->transport_frame());
686 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
689 lo_send (addr, retpath, "i", session->transport_frame());
692 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
695 lo_send (addr, retpath, "i", session->transport_frame());
698 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
701 lo_send (addr, retpath, "i", session->transport_frame());
713 OSC::route_mute (int rid, int yn)
715 if (!session) return -1;
717 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
720 r->set_mute (yn, this);
726 OSC::route_solo (int rid, int yn)
728 if (!session) return -1;
730 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
733 r->set_solo (yn, this);
739 OSC::route_recenable (int rid, int yn)
741 if (!session) return -1;
743 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
746 r->set_record_enable (yn, this);
752 OSC::route_set_gain_abs (int rid, float level)
754 if (!session) return -1;
756 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
759 r->set_gain (level, this);
766 OSC::route_set_gain_dB (int rid, float dB)
768 if (!session) return -1;
770 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
773 r->set_gain (dB_to_coefficient (dB), this);
782 return *(new XMLNode ("OSC"));
786 OSC::set_state (const XMLNode&, int /*version*/)