jack_proxy.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2009 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains helper functionality for accessing JACK through D-Bus
   9  **************************************************************************
  10  *
  11  * LADI Session Handler is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * LADI Session Handler is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  23  * or write to the Free Software Foundation, Inc.,
  24  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 //#define LASH_DEBUG
  28
  29 #include <dbus/dbus.h>
  30
  31 #include "common.h"
  32 #include "jack_proxy.h"
  33 #include "dbus/helpers.h"
  34 #include "common/debug.h"
  35 #include "dbus_constants.h"
  36
  37 jack_proxy_callback_server_started g_on_server_started;
  38 jack_proxy_callback_server_stopped g_on_server_stopped;
  39 jack_proxy_callback_server_appeared g_on_server_appeared;
  40 jack_proxy_callback_server_disappeared g_on_server_disappeared;
  41
  42 static
  43 void
  44 on_jack_control_signal(
  45   DBusMessage * message_ptr,
  46   const char * signal_name)
  47 {
  48   if (strcmp(signal_name, "ServerStarted") == 0)
  49   {
  50     lash_debug("JACK server start detected.");
  51     if (g_on_server_started != NULL)
  52     {
  53       g_on_server_started();
  54     }
  55
  56     return;
  57   }
  58
  59   if (strcmp(signal_name, "ServerStopped") == 0)
  60   {
  61     lash_debug("JACK server stop detected.");
  62     if (g_on_server_stopped != NULL)
  63     {
  64       g_on_server_stopped();
  65     }
  66
  67     return;
  68   }
  69 }
  70
  71 static
  72 DBusHandlerResult
  73 on_bus_signal(
  74   DBusMessage * message_ptr,
  75   const char * signal_name)
  76 {
  77   const char * object_name;
  78   const char * old_owner;
  79   const char * new_owner;
  80
  81   //lash_info("bus signal '%s' received", signal_name);
  82
  83   dbus_error_init(&g_dbus_error);
  84
  85   if (strcmp(signal_name, "NameOwnerChanged") == 0)
  86   {
  87     //lash_info("NameOwnerChanged signal received");
  88
  89     if (!dbus_message_get_args(
  90           message_ptr,
  91           &g_dbus_error,
  92           DBUS_TYPE_STRING, &object_name,
  93           DBUS_TYPE_STRING, &old_owner,
  94           DBUS_TYPE_STRING, &new_owner,
  95           DBUS_TYPE_INVALID)) {
  96       lash_error("Cannot get message arguments: %s", g_dbus_error.message);
  97       dbus_error_free(&g_dbus_error);
  98       return DBUS_HANDLER_RESULT_HANDLED;
  99     }
 100
 101     if (strcmp(object_name, JACKDBUS_SERVICE_NAME) != 0)
 102     {
 103       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 104     }
 105
 106     if (old_owner[0] == '\0')
 107     {
 108       lash_debug("JACK serivce appeared");
 109       if (g_on_server_appeared != NULL)
 110       {
 111         g_on_server_appeared();
 112       }
 113     }
 114     else if (new_owner[0] == '\0')
 115     {
 116       lash_debug("JACK serivce disappeared");
 117       if (g_on_server_disappeared != NULL)
 118       {
 119         g_on_server_disappeared();
 120       }
 121     }
 122
 123     return DBUS_HANDLER_RESULT_HANDLED;
 124   }
 125
 126   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 127 }
 128
 129 static
 130 DBusHandlerResult
 131 dbus_signal_handler(
 132   DBusConnection * connection_ptr,
 133   DBusMessage * message_ptr,
 134   void * data)
 135 {
 136   const char * object_path;
 137   const char * interface;
 138   const char * signal_name;
 139
 140   /* Non-signal messages are ignored */
 141   if (dbus_message_get_type(message_ptr) != DBUS_MESSAGE_TYPE_SIGNAL)
 142   {
 143     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 144   }
 145
 146   interface = dbus_message_get_interface(message_ptr);
 147   if (interface == NULL)
 148   {
 149     /* Signals with no interface are ignored */
 150     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 151   }
 152
 153   object_path = dbus_message_get_path(message_ptr);
 154
 155   signal_name = dbus_message_get_member(message_ptr);
 156   if (signal_name == NULL)
 157   {
 158     lash_error("Received signal with NULL member");
 159     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 160   }
 161
 162   lash_debug("'%s' sent signal '%s'::'%s'", object_path, interface, signal_name);
 163
 164   /* Handle JACK patchbay and control interface signals */
 165   if (object_path != NULL && strcmp(object_path, JACKDBUS_OBJECT_PATH) == 0)
 166   {
 167     if (strcmp(interface, JACKDBUS_IFACE_CONTROL) == 0)
 168     {
 169       on_jack_control_signal(message_ptr, signal_name);
 170       return DBUS_HANDLER_RESULT_HANDLED;
 171     }
 172
 173     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 174   }
 175
 176   /* Handle session bus signals to track JACK service alive state */
 177   if (strcmp(interface, DBUS_INTERFACE_DBUS) == 0)
 178   {
 179     return on_bus_signal(message_ptr, signal_name);
 180   }
 181
 182   /* Let everything else pass through */
 183   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 184 }
 185
 186 bool
 187 jack_proxy_init(
 188   jack_proxy_callback_server_started server_started,
 189   jack_proxy_callback_server_stopped server_stopped,
 190   jack_proxy_callback_server_appeared server_appeared,
 191   jack_proxy_callback_server_disappeared server_disappeared)
 192 {
 193   char rule[1024];
 194   const char ** signal;
 195
 196   const char * control_signals[] = {
 197     "ServerStarted",
 198     "ServerStopped",
 199     NULL};
 200
 201   dbus_bus_add_match(
 202     g_dbus_connection,
 203     "type='signal',interface='"DBUS_INTERFACE_DBUS"',member=NameOwnerChanged,arg0='"JACKDBUS_SERVICE_NAME"'",
 204     &g_dbus_error);
 205   if (dbus_error_is_set(&g_dbus_error))
 206   {
 207     lash_error("Failed to add D-Bus match rule: %s", g_dbus_error.message);
 208     dbus_error_free(&g_dbus_error);
 209     return false;
 210   }
 211
 212   for (signal = control_signals; *signal != NULL; signal++)
 213   {
 214     snprintf(
 215       rule,
 216       sizeof(rule),
 217       "type='signal',sender='"JACKDBUS_SERVICE_NAME"',path='"JACKDBUS_OBJECT_PATH"',interface='"JACKDBUS_IFACE_CONTROL"',member='%s'",
 218       *signal);
 219
 220     dbus_bus_add_match(g_dbus_connection, rule, &g_dbus_error);
 221     if (dbus_error_is_set(&g_dbus_error))
 222     {
 223       lash_error("Failed to add D-Bus match rule: %s", g_dbus_error.message);
 224       dbus_error_free(&g_dbus_error);
 225       return false;
 226     }
 227   }
 228
 229   if (!dbus_connection_add_filter(g_dbus_connection, dbus_signal_handler, NULL, NULL))
 230   {
 231     lash_error("Failed to add D-Bus filter");
 232     return false;
 233   }
 234
 235   g_on_server_started = server_started;
 236   g_on_server_stopped = server_stopped;
 237   g_on_server_appeared = server_appeared;
 238   g_on_server_disappeared = server_disappeared;
 239
 240   {
 241     bool started;
 242
 243     if (jack_proxy_is_started(&started))
 244     {
 245       if (g_on_server_appeared != NULL)
 246       {
 247         g_on_server_appeared();
 248       }
 249
 250       if (g_on_server_started != NULL && started)
 251       {
 252         g_on_server_started();
 253       }
 254     }
 255   }
 256
 257   return true;
 258 }
 259
 260 void
 261 jack_proxy_uninit(
 262   void)
 263 {
 264   dbus_connection_remove_filter(g_dbus_connection, dbus_signal_handler, NULL);
 265 }
 266
 267 bool
 268 jack_proxy_is_started(
 269   bool * started_ptr)
 270 {
 271   dbus_bool_t started;
 272
 273   if (!dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "IsStarted", "", "b", &started))
 274   {
 275     return false;
 276   }
 277
 278   *started_ptr = started;
 279   return true;
 280 }
 281
 282 bool
 283 jack_proxy_get_client_pid(
 284   uint64_t client_id,
 285   pid_t * pid_ptr)
 286 {
 287   return false;
 288 }
 289
 290 bool
 291 jack_proxy_connect_ports(
 292   uint64_t port1_id,
 293   uint64_t port2_id)
 294 {
 295   return false;
 296 }
 297
 298 static
 299 bool
 300 add_address(
 301   DBusMessageIter * iter_ptr,
 302   const char * address)
 303 {
 304   DBusMessageIter array_iter;
 305   const char * component;
 306
 307   if (!dbus_message_iter_open_container(iter_ptr, DBUS_TYPE_ARRAY, "s", &array_iter))
 308   {
 309     lash_error("dbus_message_iter_open_container() failed.");
 310     return false;
 311   }
 312
 313   if (address != NULL)
 314   {
 315     component = address;
 316     while (*component != 0)
 317     {
 318       if (!dbus_message_iter_append_basic(&array_iter, DBUS_TYPE_STRING, &component))
 319       {
 320         lash_error("dbus_message_iter_append_basic() failed.");
 321         return false;
 322       }
 323
 324       component += strlen(component) + 1;
 325     }
 326   }
 327
 328   dbus_message_iter_close_container(iter_ptr, &array_iter);
 329
 330   return true;
 331 }
 332
 333 bool
 334 jack_proxy_read_conf_container(
 335   const char * address,
 336   void * callback_context,
 337   bool (* callback)(void * context, bool leaf, const char * address, char * child))
 338 {
 339   DBusMessage * request_ptr;
 340   DBusMessage * reply_ptr;
 341   DBusMessageIter top_iter;
 342   DBusMessageIter array_iter;
 343   const char * reply_signature;
 344   dbus_bool_t leaf;           /* Whether children are parameters (true) or containers (false) */
 345   char * child;
 346
 347   request_ptr = dbus_message_new_method_call(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONFIGURE, "ReadContainer");
 348   if (request_ptr == NULL)
 349   {
 350     lash_error("dbus_message_new_method_call() failed.");
 351     return false;
 352   }
 353
 354   dbus_message_iter_init_append(request_ptr, &top_iter);
 355
 356   if (!add_address(&top_iter, address))
 357   {
 358     dbus_message_unref(request_ptr);
 359     return false;
 360   }
 361
 362   // send message and get a handle for a reply
 363   reply_ptr = dbus_connection_send_with_reply_and_block(
 364     g_dbus_connection,
 365     request_ptr,
 366     DBUS_CALL_DEFAULT_TIMEOUT,
 367     &g_dbus_error);
 368
 369   dbus_message_unref(request_ptr);
 370
 371   if (reply_ptr == NULL)
 372   {
 373     lash_error("no reply from JACK server, error is '%s'", g_dbus_error.message);
 374     dbus_error_free(&g_dbus_error);
 375     return false;
 376   }
 377
 378   reply_signature = dbus_message_get_signature(reply_ptr);
 379
 380   if (strcmp(reply_signature, "bas") != 0)
 381   {
 382     lash_error("ReadContainer() reply signature mismatch. '%s'", reply_signature);
 383     dbus_message_unref(reply_ptr);
 384     return false;
 385   }
 386
 387   dbus_message_iter_init(reply_ptr, &top_iter);
 388
 389   dbus_message_iter_get_basic(&top_iter, &leaf);
 390   dbus_message_iter_next(&top_iter);
 391
 392   dbus_message_iter_recurse(&top_iter, &array_iter);
 393
 394   while (dbus_message_iter_get_arg_type(&array_iter) != DBUS_TYPE_INVALID)
 395   {
 396     dbus_message_iter_get_basic(&array_iter, &child);
 397
 398     if (!callback(callback_context, leaf, address, child))
 399     {
 400       break;
 401     }
 402
 403     dbus_message_iter_next(&array_iter);
 404   }
 405
 406   dbus_message_unref(reply_ptr);
 407
 408   return true;
 409 }
 410
 411 bool
 412 get_variant(
 413   DBusMessageIter * iter_ptr,
 414   struct jack_parameter_variant * parameter_ptr)
 415 {
 416   DBusMessageIter variant_iter;
 417   int type;
 418   dbus_bool_t boolean;
 419   dbus_int32_t int32;
 420   dbus_uint32_t uint32;
 421   char * string;
 422
 423   dbus_message_iter_recurse(iter_ptr, &variant_iter);
 424   lash_debug("variant signature: '%s'", dbus_message_iter_get_signature(&variant_iter));
 425
 426   type = dbus_message_iter_get_arg_type(&variant_iter);
 427   switch (type)
 428   {
 429   case DBUS_TYPE_INT32:
 430     dbus_message_iter_get_basic(&variant_iter, &int32);
 431     parameter_ptr->value.int32 = int32;
 432     parameter_ptr->type = jack_int32;
 433     return true;
 434   case DBUS_TYPE_UINT32:
 435     dbus_message_iter_get_basic(&variant_iter, &uint32);
 436     parameter_ptr->value.uint32 = uint32;
 437     parameter_ptr->type = jack_uint32;
 438     return true;
 439   case DBUS_TYPE_BYTE:
 440     dbus_message_iter_get_basic(&variant_iter, &parameter_ptr->value.byte);
 441     parameter_ptr->type = jack_byte;
 442     return true;
 443   case DBUS_TYPE_STRING:
 444     dbus_message_iter_get_basic(&variant_iter, &string);
 445     string = strdup(string);
 446     if (string == NULL)
 447     {
 448       lash_error("strdup failed.");
 449       return false;
 450     }
 451
 452     parameter_ptr->value.string = string;
 453     parameter_ptr->type = jack_string;
 454     return true;
 455   case DBUS_TYPE_BOOLEAN:
 456     dbus_message_iter_get_basic(&variant_iter, &boolean);
 457     parameter_ptr->value.boolean = boolean;
 458     parameter_ptr->type = jack_boolean;
 459     return true;
 460   }
 461
 462   lash_error("Unknown D-Bus parameter type %i", (int)type);
 463   return false;
 464 }
 465
 466 bool
 467 jack_proxy_get_parameter_value(
 468   const char * address,
 469   bool * is_set_ptr,
 470   struct jack_parameter_variant * parameter_ptr)
 471 {
 472   DBusMessage * request_ptr;
 473   DBusMessage * reply_ptr;
 474   DBusMessageIter top_iter;
 475   const char * reply_signature;
 476   dbus_bool_t is_set;
 477   struct jack_parameter_variant default_value;
 478
 479   request_ptr = dbus_message_new_method_call(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONFIGURE, "GetParameterValue");
 480   if (request_ptr == NULL)
 481   {
 482     lash_error("dbus_message_new_method_call() failed.");
 483     return false;
 484   }
 485
 486   dbus_message_iter_init_append(request_ptr, &top_iter);
 487
 488   if (!add_address(&top_iter, address))
 489   {
 490     dbus_message_unref(request_ptr);
 491     return false;
 492   }
 493
 494   // send message and get a handle for a reply
 495   reply_ptr = dbus_connection_send_with_reply_and_block(
 496     g_dbus_connection,
 497     request_ptr,
 498     DBUS_CALL_DEFAULT_TIMEOUT,
 499     &g_dbus_error);
 500
 501   dbus_message_unref(request_ptr);
 502
 503   if (reply_ptr == NULL)
 504   {
 505     lash_error("no reply from JACK server, error is '%s'", g_dbus_error.message);
 506     dbus_error_free(&g_dbus_error);
 507     return false;
 508   }
 509
 510   reply_signature = dbus_message_get_signature(reply_ptr);
 511
 512   if (strcmp(reply_signature, "bvv") != 0)
 513   {
 514     lash_error("GetParameterValue() reply signature mismatch. '%s'", reply_signature);
 515     dbus_message_unref(reply_ptr);
 516     return false;
 517   }
 518
 519   dbus_message_iter_init(reply_ptr, &top_iter);
 520
 521   dbus_message_iter_get_basic(&top_iter, &is_set);
 522   dbus_message_iter_next(&top_iter);
 523
 524   if (!get_variant(&top_iter, &default_value))
 525   {
 526     dbus_message_unref(reply_ptr);
 527     return false;
 528   }
 529
 530   if (default_value.type == jack_string)
 531   {
 532     free(default_value.value.string);
 533   }
 534
 535   dbus_message_iter_next(&top_iter);
 536
 537   if (!get_variant(&top_iter, parameter_ptr))
 538   {
 539     dbus_message_unref(reply_ptr);
 540     return false;
 541   }
 542
 543   dbus_message_unref(reply_ptr);
 544
 545   *is_set_ptr = is_set;
 546
 547   return true;
 548 }
 549
 550 bool jack_proxy_start_server(void)
 551 {
 552   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "StartServer", "", "");
 553 }
 554
 555 bool jack_proxy_stop_server(void)
 556 {
 557   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "StopServer", "", "");
 558 }
 559
 560 bool jack_proxy_is_realtime(bool * realtime_ptr)
 561 {
 562   dbus_bool_t realtime;
 563
 564   if (!dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "IsStarted", "", "b", &realtime))
 565   {
 566     return false;
 567   }
 568
 569   *realtime_ptr = realtime;
 570   return true;
 571 }
 572
 573 bool jack_proxy_sample_rate(uint32_t * sample_rate_ptr)
 574 {
 575   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetSampleRate", "", "u", sample_rate_ptr);
 576 }
 577
 578 bool jack_proxy_get_xruns(uint32_t * xruns_ptr)
 579 {
 580   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetXruns", "", "u", xruns_ptr);
 581 }
 582
 583 bool jack_proxy_get_dsp_load(double * dsp_load_ptr)
 584 {
 585   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetLoad", "", "d", dsp_load_ptr);
 586 }
 587
 588 bool jack_proxy_get_buffer_size(uint32_t * size_ptr)
 589 {
 590   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetBufferSize", "", "u", size_ptr);
 591 }
 592
 593 bool jack_proxy_set_buffer_size(uint32_t size)
 594 {
 595   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "SetBufferSize", "u", &size, "");
 596 }
 597
 598 bool jack_proxy_reset_xruns(void)
 599 {
 600   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "ResetXruns", "", "");
 601 }