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;
55 #include "pbd/abstract_ui.cc" // instantiate template
58 static void error_callback(int num, const char *m, const char *path)
60 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
63 static void error_callback(int, const char *, const char *)
69 OSC::OSC (Session& s, uint32_t port)
70 : ControlProtocol (s, "OSC")
71 , AbstractUI<OSCUIRequest> ("osc")
77 _namespace_root = "/ardour";
78 _send_route_changes = true;
84 // "Application Hooks"
86 scoped_connect (session->Exported, boost::bind (&OSC::session_exported, this, _1, _2));
95 OSC::do_request (OSCUIRequest* req)
97 if (req->type == CallSlot) {
99 call_slot (req->the_slot);
101 } else if (req->type == Quit) {
108 OSC::set_active (bool yn)
118 OSC::get_active () const
120 return _osc_server != 0;
124 OSC::set_feedback (bool yn)
126 _send_route_changes = yn;
131 OSC::get_feedback () const
133 return _send_route_changes;
142 /* already started */
146 for (int j=0; j < 20; ++j) {
147 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
149 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
153 cerr << "can't get osc at port: " << _port << endl;
159 #ifdef ARDOUR_OSC_UNIX_SERVER
161 // APPEARS sluggish for now
163 // attempt to create unix socket server too
165 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
166 int fd = mkstemp(tmpstr);
172 _osc_unix_server = lo_server_new (tmpstr, error_callback);
174 if (_osc_unix_server) {
175 _osc_unix_socket_path = tmpstr;
180 cerr << "OSC @ " << get_server_url () << endl;
182 PBD::sys::path url_file;
184 if (find_file_in_search_path (ardour_search_path() + system_config_search_path(),
185 "osc_url", url_file)) {
186 _osc_url_file = url_file.to_string();
188 urlfile.open(_osc_url_file.c_str(), ios::trunc);
191 urlfile << get_server_url () << endl;
196 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
200 register_callbacks();
202 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
204 /* startup the event loop thread */
214 if (_osc_unix_server) {
215 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
216 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
217 src->attach (_main_loop->get_context());
218 local_server = src->gobj();
219 g_source_ref (local_server);
223 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
224 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
225 src->attach (_main_loop->get_context());
226 remote_server = src->gobj();
227 g_source_ref (remote_server);
237 g_source_destroy (local_server);
238 g_source_unref (local_server);
243 g_source_destroy (remote_server);
244 g_source_unref (remote_server);
251 int fd = lo_server_get_socket_fd(_osc_server);
255 lo_server_free (_osc_server);
259 if (_osc_unix_server) {
260 int fd = lo_server_get_socket_fd(_osc_unix_server);
264 lo_server_free (_osc_unix_server);
265 _osc_unix_server = 0;
268 if (!_osc_unix_socket_path.empty()) {
269 unlink (_osc_unix_socket_path.c_str());
272 if (!_osc_url_file.empty() ) {
273 unlink (_osc_url_file.c_str() );
280 OSC::register_callbacks()
285 srvs[0] = _osc_server;
286 srvs[1] = _osc_unix_server;
288 for (size_t i = 0; i < 2; ++i) {
296 /* this is a special catchall handler */
298 lo_server_add_method (serv, 0, 0, _catchall, this);
300 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
302 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
303 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
304 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
305 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
306 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
307 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
308 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
309 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
310 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
311 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
312 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
313 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
314 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
315 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
316 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
317 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
318 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
319 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
320 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
322 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
323 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
324 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
325 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
326 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
330 /* still not-really-standardized query interface */
331 REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
332 REGISTER_CALLBACK (serv, "/ardour/set", "", set);
336 // un/register_update args= s:ctrl s:returl s:retpath
337 lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
338 lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
339 lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
340 lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
346 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
353 lo_server_recv (srv);
360 OSC::get_server_url()
366 urlstr = lo_server_get_url (_osc_server);
375 OSC::get_unix_server_url()
380 if (_osc_unix_server) {
381 urlstr = lo_server_get_url (_osc_unix_server);
391 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
395 subpath = (char*) malloc (len-15+1);
396 memcpy (subpath, path, len-15);
397 subpath[len-15] = '\0';
399 send_current_value (subpath, argv, argc, msg);
405 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
411 lo_message reply = lo_message_new ();
412 boost::shared_ptr<Route> r;
415 lo_message_add_string (reply, path);
418 lo_message_add_string (reply, "bad syntax");
421 r = session->route_by_remote_id (id);
424 lo_message_add_string (reply, "not found");
427 if (strcmp (path, "/routes/state") == 0) {
429 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
430 lo_message_add_string (reply, "AT");
431 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
432 lo_message_add_string (reply, "MT");
434 lo_message_add_string (reply, "B");
437 lo_message_add_string (reply, r->name().c_str());
438 lo_message_add_int32 (reply, r->n_inputs().n_audio());
439 lo_message_add_int32 (reply, r->n_outputs().n_audio());
440 lo_message_add_int32 (reply, r->muted());
441 lo_message_add_int32 (reply, r->soloed());
443 } else if (strcmp (path, "/routes/mute") == 0) {
445 lo_message_add_int32 (reply, (float) r->muted());
447 } else if (strcmp (path, "/routes/solo") == 0) {
449 lo_message_add_int32 (reply, r->soloed());
454 lo_send_message (lo_message_get_source (msg), "#reply", reply);
455 lo_message_free (reply);
459 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
461 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
465 OSC::catchall (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg)
468 int ret = 1; /* unhandled */
470 cerr << "Received a message, path = " << path << " types = \""
471 << (types ? types : "NULL") << '"' << endl;
473 /* 15 for /#current_value plus 2 for /<path> */
477 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
478 current_value_query (path, len, argv, argc, msg);
481 } else if (strcmp (path, "/routes/listen") == 0) {
483 cerr << "set up listener\n";
485 lo_message reply = lo_message_new ();
488 lo_message_add_string (reply, "syntax error");
490 for (int n = 0; n < argc; ++n) {
492 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
495 lo_message_add_string (reply, "not found");
496 cerr << "no such route\n";
499 cerr << "add listener\n";
500 listen_to_route (r, lo_message_get_source (msg));
501 lo_message_add_int32 (reply, argv[n]->i);
506 lo_send_message (lo_message_get_source (msg), "#reply", reply);
507 lo_message_free (reply);
509 } else if (strcmp (path, "/routes/ignore") == 0) {
511 for (int n = 0; n < argc; ++n) {
513 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
516 end_listen (r, lo_message_get_source (msg));
525 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
527 Controllables::iterator x;
528 bool route_exists = false;
530 cerr << "listen to route\n";
532 /* avoid duplicate listens */
534 for (x = controllables.begin(); x != controllables.end(); ++x) {
536 OSCRouteControllable* rc;
538 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
540 if (rc->route() == route) {
543 /* XXX NEED lo_address_equal() */
545 if (rc->address() == addr) {
552 cerr << "listener binding to signals\n";
557 path = X_("/route/solo");
558 c = new OSCRouteControllable (addr, path, route->solo_control(), route);
559 controllables.push_back (c);
561 path = X_("/route/mute");
562 c = new OSCRouteControllable (addr, path, route->mute_control(), route);
563 controllables.push_back (c);
565 path = X_("/route/gain");
566 c = new OSCRouteControllable (addr, path, route->gain_control(), route);
567 controllables.push_back (c);
569 cerr << "Now have " << controllables.size() << " controllables\n";
571 /* if there is no existing controllable related to this route, make sure we clean up
572 if it is ever deleted.
576 scoped_connect (route->GoingAway, (boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route))));
581 OSC::drop_route (boost::weak_ptr<Route> wr)
583 boost::shared_ptr<Route> r = wr.lock ();
589 for (Controllables::iterator x = controllables.begin(); x != controllables.end();) {
591 OSCRouteControllable* rc;
593 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
594 if (rc->route() == r) {
596 x = controllables.erase (x);
607 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
609 Controllables::iterator x;
611 for (x = controllables.begin(); x != controllables.end(); ++x) {
613 OSCRouteControllable* rc;
615 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
617 /* XXX NEED lo_address_equal () */
619 if (rc->route() == r && rc->address() == addr) {
620 controllables.erase (x);
627 // "Application Hook" Handlers //
629 OSC::session_loaded( Session& s ) {
630 lo_address listener = lo_address_new( NULL, "7770" );
631 lo_send( listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str() );
635 OSC::session_exported( std::string path, std::string name ) {
636 lo_address listener = lo_address_new( NULL, "7770" );
637 lo_send( listener, "/session/exported", "ss", path.c_str(), name.c_str() );
640 // end "Application Hook" Handlers //
645 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
650 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
654 const char *returl = argv[1]->s;
655 lo_address addr = find_or_cache_addr (returl);
657 const char *retpath = argv[2]->s;
660 if (strcmp (argv[0]->s, "transport_frame") == 0) {
663 lo_send (addr, retpath, "i", session->transport_frame());
666 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
669 lo_send (addr, retpath, "i", session->transport_frame());
672 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
675 lo_send (addr, retpath, "i", session->transport_frame());
678 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
681 lo_send (addr, retpath, "i", session->transport_frame());
684 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
687 lo_send (addr, retpath, "i", session->transport_frame());
690 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
693 lo_send (addr, retpath, "i", session->transport_frame());
705 OSC::route_mute (int rid, int yn)
707 if (!session) return -1;
709 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
712 r->set_mute (yn, this);
718 OSC::route_solo (int rid, int yn)
720 if (!session) return -1;
722 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
725 r->set_solo (yn, this);
731 OSC::route_recenable (int rid, int yn)
733 if (!session) return -1;
735 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
738 r->set_record_enable (yn, this);
744 OSC::route_set_gain_abs (int rid, float level)
746 if (!session) return -1;
748 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
751 r->set_gain (level, this);
758 OSC::route_set_gain_dB (int rid, float dB)
760 if (!session) return -1;
762 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
765 r->set_gain (dB_to_coefficient (dB), this);
774 return *(new XMLNode ("OSC"));
778 OSC::set_state (const XMLNode&, int /*version*/)