libs/ardour/osc.cc

   1 /*
   2  * Copyright (C) 2006 Paul Davis
   3  *
   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.
   8  *
   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.
  13  *
  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.
  17  *
  18  */
  19
  20 #include <iostream>
  21 #include <fstream>
  22 #include <cstdio>
  23 #include <cstdlib>
  24 #include <cerrno>
  25 #include <algorithm>
  26
  27 #include <sys/poll.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30
  31 #include <glibmm/miscutils.h>
  32
  33 #include <pbd/pthread_utils.h>
  34
  35 #include <ardour/osc.h>
  36 #include <ardour/session.h>
  37 #include <ardour/route.h>
  38 #include <ardour/audio_track.h>
  39 #include <ardour/dB.h>
  40
  41 #include "i18n.h"
  42
  43 using namespace ARDOUR;
  44 using namespace sigc;
  45 using namespace std;
  46
  47 static void error_callback(int num, const char *m, const char *path)
  48 {
  49 #ifdef DEBUG
  50         fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
  51 #endif
  52 }
  53
  54 OSC::OSC (uint32_t port)
  55         : _port(port)
  56 {
  57         _shutdown = false;
  58         _osc_server = 0;
  59         _osc_unix_server = 0;
  60         _osc_thread = 0;
  61 }
  62
  63 int
  64 OSC::start ()
  65 {
  66         char tmpstr[255];
  67
  68         if (_osc_server) {
  69                 /* already started */
  70                 return 0;
  71         }
  72
  73         for (int j=0; j < 20; ++j) {
  74                 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
  75
  76                 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
  77                         break;
  78                 }
  79 #ifdef DEBUG
  80                 cerr << "can't get osc at port: " << _port << endl;
  81 #endif
  82                 _port++;
  83                 continue;
  84         }
  85
  86 #ifdef ARDOUR_OSC_UNIX_SERVER
  87
  88         // APPEARS sluggish for now
  89
  90         // attempt to create unix socket server too
  91
  92         snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
  93         int fd = mkstemp(tmpstr);
  94
  95         if (fd >= 0 ) {
  96                 unlink (tmpstr);
  97                 close (fd);
  98
  99                 _osc_unix_server = lo_server_new (tmpstr, error_callback);
 100
 101                 if (_osc_unix_server) {
 102                         _osc_unix_socket_path = tmpstr;
 103                 }
 104         }
 105 #endif
 106
 107         cerr << "OSC @ " << get_server_url () << endl;
 108
 109         _osc_url_file = Glib::build_filename (get_user_ardour_path (), "osc_url");
 110
 111         ofstream urlfile;
 112         urlfile.open(_osc_url_file.c_str(),ios::trunc);
 113
 114         if (urlfile) {
 115                 urlfile << get_server_url () << endl;
 116                 urlfile.close();
 117         } else {
 118                 cerr << "Couldn't write '" <<  _osc_url_file << "'" <<endl;
 119         }
 120
 121         register_callbacks();
 122
 123         // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
 124
 125         if (!init_osc_thread()) {
 126                 return -1;
 127         }
 128         return 0;
 129 }
 130
 131 int
 132 OSC::stop ()
 133 {
 134         if (_osc_server == 0) {
 135                 /* already stopped */
 136                 return 0;
 137         }
 138
 139         // stop server thread
 140         terminate_osc_thread();
 141
 142         lo_server_free (_osc_server);
 143         _osc_server = 0;
 144
 145         if (!_osc_unix_socket_path.empty()) {
 146                 // unlink it
 147                 unlink(_osc_unix_socket_path.c_str());
 148         }
 149
 150         if (!  _osc_url_file.empty() ) {
 151                 unlink(_osc_url_file.c_str() );
 152         }
 153         return 0;
 154 }
 155
 156 OSC::~OSC()
 157 {
 158         stop ();
 159 }
 160
 161 void
 162 OSC::register_callbacks()
 163 {
 164         lo_server srvs[2];
 165         lo_server serv;
 166
 167         srvs[0] = _osc_server;
 168         srvs[1] = _osc_unix_server;
 169
 170         for (size_t i = 0; i < 2; ++i) {
 171
 172                 if (!srvs[i]) {
 173                         continue;
 174                 }
 175
 176                 serv = srvs[i];
 177
 178 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
 179
 180                 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
 181                 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
 182                 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
 183                 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
 184                 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
 185                 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
 186                 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
 187                 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
 188                 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
 189                 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
 190                 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
 191                 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
 192                 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
 193                 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
 194                 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
 195                 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
 196                 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
 197                 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
 198                 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
 199
 200                 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
 201                 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
 202                 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
 203                 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
 204                 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
 205
 206 #if 0
 207                 REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
 208                 REGISTER_CALLBACK (serv, "/ardour/set", "", set);
 209 #endif
 210
 211 #if 0
 212                 // un/register_update args= s:ctrl s:returl s:retpath
 213                 lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
 214                 lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
 215                 lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
 216                 lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
 217 #endif
 218         }
 219 }
 220
 221 bool
 222 OSC::init_osc_thread ()
 223 {
 224         // create new thread to run server
 225         if (pipe (_request_pipe)) {
 226                 cerr << "Cannot create osc request signal pipe" <<  strerror (errno) << endl;
 227                 return false;
 228         }
 229
 230         if (fcntl (_request_pipe[0], F_SETFL, O_NONBLOCK)) {
 231                 cerr << "osc: cannot set O_NONBLOCK on signal read pipe " << strerror (errno) << endl;
 232                 return false;
 233         }
 234
 235         if (fcntl (_request_pipe[1], F_SETFL, O_NONBLOCK)) {
 236                 cerr << "osc: cannot set O_NONBLOCK on signal write pipe " << strerror (errno) << endl;
 237                 return false;
 238         }
 239
 240         pthread_attr_t attr;
 241         pthread_attr_init(&attr);
 242         pthread_attr_setstacksize(&attr, 500000);
 243
 244         pthread_create_and_store (X_("OSC"), &_osc_thread, &attr, &OSC::_osc_receiver, this);
 245         if (!_osc_thread) {
 246                 return false;
 247         }
 248         pthread_attr_destroy(&attr);
 249
 250         //pthread_detach (_osc_thread);
 251         return true;
 252 }
 253
 254 void
 255 OSC::terminate_osc_thread ()
 256 {
 257         void* status;
 258
 259         _shutdown = true;
 260
 261         poke_osc_thread ();
 262
 263         pthread_join (_osc_thread, &status);
 264 }
 265
 266 void
 267 OSC::poke_osc_thread ()
 268 {
 269         char c;
 270
 271         if (write (_request_pipe[1], &c, 1) != 1) {
 272                 cerr << "cannot send signal to osc thread! " <<  strerror (errno) << endl;
 273         }
 274 }
 275
 276 std::string
 277 OSC::get_server_url()
 278 {
 279         string url;
 280         char * urlstr;
 281
 282         if (_osc_server) {
 283                 urlstr = lo_server_get_url (_osc_server);
 284                 url = urlstr;
 285                 free (urlstr);
 286         }
 287
 288         return url;
 289 }
 290
 291 std::string
 292 OSC::get_unix_server_url()
 293 {
 294         string url;
 295         char * urlstr;
 296
 297         if (_osc_unix_server) {
 298                 urlstr = lo_server_get_url (_osc_unix_server);
 299                 url = urlstr;
 300                 free (urlstr);
 301         }
 302
 303         return url;
 304 }
 305
 306
 307 /* server thread */
 308
 309 void *
 310 OSC::_osc_receiver(void * arg)
 311 {
 312         PBD::notify_gui_about_thread_creation (pthread_self(), X_("OSC"));
 313         static_cast<OSC*> (arg)->osc_receiver();
 314         return 0;
 315 }
 316
 317 void
 318 OSC::osc_receiver()
 319 {
 320         struct pollfd pfd[3];
 321         int fds[3];
 322         lo_server srvs[3];
 323         int nfds = 0;
 324         int timeout = -1;
 325         int ret;
 326
 327         fds[0] = _request_pipe[0];
 328         nfds++;
 329
 330         if (_osc_server && lo_server_get_socket_fd(_osc_server) >= 0) {
 331                 fds[nfds] = lo_server_get_socket_fd(_osc_server);
 332                 srvs[nfds] = _osc_server;
 333                 nfds++;
 334         }
 335
 336         if (_osc_unix_server && lo_server_get_socket_fd(_osc_unix_server) >= 0) {
 337                 fds[nfds] = lo_server_get_socket_fd(_osc_unix_server);
 338                 srvs[nfds] = _osc_unix_server;
 339                 nfds++;
 340         }
 341
 342
 343         while (!_shutdown) {
 344
 345                 for (int i=0; i < nfds; ++i) {
 346                         pfd[i].fd = fds[i];
 347                         pfd[i].events = POLLIN|POLLPRI|POLLHUP|POLLERR;
 348                         pfd[i].revents = 0;
 349                 }
 350
 351         again:
 352                 //cerr << "poll on " << nfds << " for " << timeout << endl;
 353                 if ((ret = poll (pfd, nfds, timeout)) < 0) {
 354                         if (errno == EINTR) {
 355                                 /* gdb at work, perhaps */
 356                                 goto again;
 357                         }
 358
 359                         cerr << "OSC thread poll failed: " <<  strerror (errno) << endl;
 360
 361                         break;
 362                 }
 363
 364                 //cerr << "poll returned " << ret << "  pfd[0].revents = " << pfd[0].revents << "  pfd[1].revents = " << pfd[1].revents << endl;
 365
 366                 if (_shutdown) {
 367                         break;
 368                 }
 369
 370                 if ((pfd[0].revents & ~POLLIN)) {
 371                         cerr << "OSC: error polling extra port" << endl;
 372                         break;
 373                 }
 374
 375                 for (int i=1; i < nfds; ++i) {
 376                         if (pfd[i].revents & POLLIN)
 377                         {
 378                                 // this invokes callbacks
 379                                 // cerr << "invoking recv on " << pfd[i].fd << endl;
 380                                 lo_server_recv(srvs[i]);
 381                         }
 382                 }
 383
 384         }
 385
 386         //cerr << "SL engine shutdown" << endl;
 387
 388         if (_osc_server) {
 389                 int fd = lo_server_get_socket_fd(_osc_server);
 390                 if (fd >=0) {
 391                         // hack around
 392                         close(fd);
 393                 }
 394                 lo_server_free (_osc_server);
 395                 _osc_server = 0;
 396         }
 397
 398         if (_osc_unix_server) {
 399                 cerr << "freeing unix server" << endl;
 400                 lo_server_free (_osc_unix_server);
 401                 _osc_unix_server = 0;
 402         }
 403
 404         close(_request_pipe[0]);
 405         close(_request_pipe[1]);
 406 }
 407
 408 void
 409 OSC::set_session (Session& s)
 410 {
 411         session = &s;
 412         session->GoingAway.connect (mem_fun (*this, &OSC::session_going_away));
 413
 414         // "Application Hooks"
 415         session_loaded( s );
 416         session->Exported.connect( mem_fun( *this, &OSC::session_exported ) );
 417 }
 418
 419 void
 420 OSC::session_going_away ()
 421 {
 422         session = 0;
 423 }
 424
 425 // "Application Hook" Handlers //
 426 void
 427 OSC::session_loaded( Session& s ) {
 428         lo_address listener = lo_address_new( NULL, "7770" );
 429         lo_send( listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str() );
 430 }
 431
 432 void
 433 OSC::session_exported( std::string path, std::string name ) {
 434         lo_address listener = lo_address_new( NULL, "7770" );
 435         lo_send( listener, "/session/exported", "ss", path.c_str(), name.c_str() );
 436 }
 437
 438 // end "Application Hook" Handlers //
 439
 440 /* path callbacks */
 441
 442 int
 443 OSC::current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void* user_data)
 444 {
 445 #if 0
 446         const char* returl;
 447
 448         if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
 449                 return 1;
 450         }
 451
 452         const char *returl = argv[1]->s;
 453         lo_address addr = find_or_cache_addr (returl);
 454
 455         const char *retpath = argv[2]->s;
 456
 457
 458         if (strcmp (argv[0]->s, "transport_frame")) {
 459
 460                 if (session) {
 461                         lo_send (addr, retpath, "i", session->transport_frame());
 462                 }
 463
 464         } else if (strcmp (argv[0]->s, "transport_speed")) {
 465
 466                 if (session) {
 467                         lo_send (addr, retpath, "i", session->transport_frame());
 468                 }
 469
 470         } else if (strcmp (argv[0]->s, "transport_locked")) {
 471
 472                 if (session) {
 473                         lo_send (addr, retpath, "i", session->transport_frame());
 474                 }
 475
 476         } else if (strcmp (argv[0]->s, "punch_in") {
 477
 478                 if (session) {
 479                         lo_send (addr, retpath, "i", session->transport_frame());
 480                 }
 481
 482         } else if (strcmp (argv[0]->s, "punch_out") {
 483
 484                 if (session) {
 485                         lo_send (addr, retpath, "i", session->transport_frame());
 486                 }
 487
 488         } else if (strcmp (argv[0]->s, "rec_enable") {
 489
 490                 if (session) {
 491                         lo_send (addr, retpath, "i", session->transport_frame());
 492                 }
 493
 494         } else {
 495
 496                 /* error */
 497         }
 498 #endif
 499         return 0;
 500 }
 501
 502 int
 503 OSC::route_mute (int rid, int yn)
 504 {
 505         if (!session) return -1;
 506
 507         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
 508
 509         if (r) {
 510                 r->set_mute (yn, this);
 511         }
 512         return 0;
 513 }
 514
 515 int
 516 OSC::route_solo (int rid, int yn)
 517 {
 518         if (!session) return -1;
 519
 520         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
 521
 522         if (r) {
 523                 r->set_solo (yn, this);
 524         }
 525         return 0;
 526 }
 527
 528 int
 529 OSC::route_recenable (int rid, int yn)
 530 {
 531         if (!session) return -1;
 532
 533         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
 534
 535         if (r) {
 536                 r->set_record_enable (yn, this);
 537         }
 538         return 0;
 539 }
 540
 541 int
 542 OSC::route_set_gain_abs (int rid, float level)
 543 {
 544         if (!session) return -1;
 545
 546         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
 547
 548         if (r) {
 549                 r->set_gain (level, this);
 550         }
 551
 552         return 0;
 553 }
 554
 555 int
 556 OSC::route_set_gain_dB (int rid, float dB)
 557 {
 558         if (!session) return -1;
 559
 560         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
 561
 562         if (r) {
 563                 r->set_gain (dB_to_coefficient (dB), this);
 564         }
 565
 566         return 0;
 567 }