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   DBusError err;
 194   char rule[1024];
 195   const char ** signal;
 196
 197   const char * control_signals[] = {
 198     "ServerStarted",
 199     "ServerStopped",
 200     NULL};
 201
 202   dbus_bus_add_match(
 203     g_dbus_connection,
 204     "type='signal',interface='"DBUS_INTERFACE_DBUS"',member=NameOwnerChanged,arg0='"JACKDBUS_SERVICE_NAME"'",
 205     &err);
 206   if (dbus_error_is_set(&err))
 207   {
 208     lash_error("Failed to add D-Bus match rule: %s", err.message);
 209     dbus_error_free(&err);
 210     return false;
 211   }
 212
 213   for (signal = control_signals; *signal != NULL; signal++)
 214   {
 215     snprintf(
 216       rule,
 217       sizeof(rule),
 218       "type='signal',sender='"JACKDBUS_SERVICE_NAME"',path='"JACKDBUS_OBJECT_PATH"',interface='"JACKDBUS_IFACE_CONTROL"',member='%s'",
 219       *signal);
 220
 221     dbus_bus_add_match(g_dbus_connection, rule, &err);
 222     if (dbus_error_is_set(&err))
 223     {
 224       lash_error("Failed to add D-Bus match rule: %s", err.message);
 225       dbus_error_free(&err);
 226       return false;
 227     }
 228   }
 229
 230   if (!dbus_connection_add_filter(g_dbus_connection, dbus_signal_handler, NULL, NULL))
 231   {
 232     lash_error("Failed to add D-Bus filter");
 233     return false;
 234   }
 235
 236   g_on_server_started = server_started;
 237   g_on_server_stopped = server_stopped;
 238   g_on_server_appeared = server_appeared;
 239   g_on_server_disappeared = server_disappeared;
 240
 241   {
 242     bool started;
 243
 244     if (jack_proxy_is_started(&started))
 245     {
 246       if (g_on_server_appeared != NULL)
 247       {
 248         g_on_server_appeared();
 249       }
 250
 251       if (g_on_server_started != NULL && started)
 252       {
 253         g_on_server_started();
 254       }
 255     }
 256   }
 257
 258   return true;
 259 }
 260
 261 void
 262 jack_proxy_uninit(
 263   void)
 264 {
 265   dbus_connection_remove_filter(g_dbus_connection, dbus_signal_handler, NULL);
 266 }
 267
 268 bool
 269 jack_proxy_is_started(
 270   bool * started_ptr)
 271 {
 272   dbus_bool_t started;
 273
 274   if (!dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "IsStarted", "", "b", &started))
 275   {
 276     return false;
 277   }
 278
 279   *started_ptr = started;
 280   return true;
 281 }
 282
 283 bool
 284 jack_proxy_get_client_pid(
 285   uint64_t client_id,
 286   pid_t * pid_ptr)
 287 {
 288   return false;
 289 }
 290
 291 bool
 292 jack_proxy_connect_ports(
 293   uint64_t port1_id,
 294   uint64_t port2_id)
 295 {
 296   return false;
 297 }
 298
 299 static
 300 bool
 301 add_address(
 302   DBusMessageIter * iter_ptr,
 303   const char * address)
 304 {
 305   DBusMessageIter array_iter;
 306   const char * component;
 307
 308   if (!dbus_message_iter_open_container(iter_ptr, DBUS_TYPE_ARRAY, "s", &array_iter))
 309   {
 310     lash_error("dbus_message_iter_open_container() failed.");
 311     return false;
 312   }
 313
 314   if (address != NULL)
 315   {
 316     component = address;
 317     while (*component != 0)
 318     {
 319       if (!dbus_message_iter_append_basic(&array_iter, DBUS_TYPE_STRING, &component))
 320       {
 321         lash_error("dbus_message_iter_append_basic() failed.");
 322         return false;
 323       }
 324
 325       component += strlen(component) + 1;
 326     }
 327   }
 328
 329   dbus_message_iter_close_container(iter_ptr, &array_iter);
 330
 331   return true;
 332 }
 333
 334 bool
 335 jack_proxy_read_conf_container(
 336   const char * address,
 337   void * callback_context,
 338   bool (* callback)(void * context, bool leaf, const char * address, char * child))
 339 {
 340   DBusMessage * request_ptr;
 341   DBusMessage * reply_ptr;
 342   DBusMessageIter top_iter;
 343   DBusMessageIter array_iter;
 344   const char * reply_signature;
 345   dbus_bool_t leaf;           /* Whether children are parameters (true) or containers (false) */
 346   char * child;
 347
 348   request_ptr = dbus_message_new_method_call(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONFIGURE, "ReadContainer");
 349   if (request_ptr == NULL)
 350   {
 351     lash_error("dbus_message_new_method_call() failed.");
 352     return false;
 353   }
 354
 355   dbus_message_iter_init_append(request_ptr, &top_iter);
 356
 357   if (!add_address(&top_iter, address))
 358   {
 359     dbus_message_unref(request_ptr);
 360     return false;
 361   }
 362
 363   // send message and get a handle for a reply
 364   reply_ptr = dbus_connection_send_with_reply_and_block(
 365     g_dbus_connection,
 366     request_ptr,
 367     DBUS_CALL_DEFAULT_TIMEOUT,
 368     &g_dbus_error);
 369
 370   dbus_message_unref(request_ptr);
 371
 372   if (reply_ptr == NULL)
 373   {
 374     lash_error("no reply from JACK server, error is '%s'", g_dbus_error.message);
 375     dbus_error_free(&g_dbus_error);
 376     return false;
 377   }
 378
 379   reply_signature = dbus_message_get_signature(reply_ptr);
 380
 381   if (strcmp(reply_signature, "bas") != 0)
 382   {
 383     lash_error("ReadContainer() reply signature mismatch. '%s'", reply_signature);
 384     dbus_message_unref(reply_ptr);
 385     return false;
 386   }
 387
 388   dbus_message_iter_init(reply_ptr, &top_iter);
 389
 390   dbus_message_iter_get_basic(&top_iter, &leaf);
 391   dbus_message_iter_next(&top_iter);
 392
 393   dbus_message_iter_recurse(&top_iter, &array_iter);
 394
 395   while (dbus_message_iter_get_arg_type(&array_iter) != DBUS_TYPE_INVALID)
 396   {
 397     dbus_message_iter_get_basic(&array_iter, &child);
 398
 399     if (!callback(callback_context, leaf, address, child))
 400     {
 401       break;
 402     }
 403
 404     dbus_message_iter_next(&array_iter);
 405   }
 406
 407   dbus_message_unref(reply_ptr);
 408
 409   return true;
 410 }
 411
 412 bool
 413 get_variant(
 414   DBusMessageIter * iter_ptr,
 415   struct jack_parameter_variant * parameter_ptr)
 416 {
 417   DBusMessageIter variant_iter;
 418   int type;
 419   dbus_bool_t boolean;
 420   dbus_int32_t int32;
 421   dbus_uint32_t uint32;
 422   char * string;
 423
 424   dbus_message_iter_recurse(iter_ptr, &variant_iter);
 425   lash_debug("variant signature: '%s'", dbus_message_iter_get_signature(&variant_iter));
 426
 427   type = dbus_message_iter_get_arg_type(&variant_iter);
 428   switch (type)
 429   {
 430   case DBUS_TYPE_INT32:
 431     dbus_message_iter_get_basic(&variant_iter, &int32);
 432     parameter_ptr->value.int32 = int32;
 433     parameter_ptr->type = jack_int32;
 434     return true;
 435   case DBUS_TYPE_UINT32:
 436     dbus_message_iter_get_basic(&variant_iter, &uint32);
 437     parameter_ptr->value.uint32 = uint32;
 438     parameter_ptr->type = jack_uint32;
 439     return true;
 440   case DBUS_TYPE_BYTE:
 441     dbus_message_iter_get_basic(&variant_iter, &parameter_ptr->value.byte);
 442     parameter_ptr->type = jack_byte;
 443     return true;
 444   case DBUS_TYPE_STRING:
 445     dbus_message_iter_get_basic(&variant_iter, &string);
 446     string = strdup(string);
 447     if (string == NULL)
 448     {
 449       lash_error("strdup failed.");
 450       return false;
 451     }
 452
 453     parameter_ptr->value.string = string;
 454     parameter_ptr->type = jack_string;
 455     return true;
 456   case DBUS_TYPE_BOOLEAN:
 457     dbus_message_iter_get_basic(&variant_iter, &boolean);
 458     parameter_ptr->value.boolean = boolean;
 459     parameter_ptr->type = jack_boolean;
 460     return true;
 461   }
 462
 463   lash_error("Unknown D-Bus parameter type %i", (int)type);
 464   return false;
 465 }
 466
 467 bool
 468 jack_proxy_get_parameter_value(
 469   const char * address,
 470   bool * is_set_ptr,
 471   struct jack_parameter_variant * parameter_ptr)
 472 {
 473   DBusMessage * request_ptr;
 474   DBusMessage * reply_ptr;
 475   DBusMessageIter top_iter;
 476   const char * reply_signature;
 477   dbus_bool_t is_set;
 478   struct jack_parameter_variant default_value;
 479
 480   request_ptr = dbus_message_new_method_call(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONFIGURE, "GetParameterValue");
 481   if (request_ptr == NULL)
 482   {
 483     lash_error("dbus_message_new_method_call() failed.");
 484     return false;
 485   }
 486
 487   dbus_message_iter_init_append(request_ptr, &top_iter);
 488
 489   if (!add_address(&top_iter, address))
 490   {
 491     dbus_message_unref(request_ptr);
 492     return false;
 493   }
 494
 495   // send message and get a handle for a reply
 496   reply_ptr = dbus_connection_send_with_reply_and_block(
 497     g_dbus_connection,
 498     request_ptr,
 499     DBUS_CALL_DEFAULT_TIMEOUT,
 500     &g_dbus_error);
 501
 502   dbus_message_unref(request_ptr);
 503
 504   if (reply_ptr == NULL)
 505   {
 506     lash_error("no reply from JACK server, error is '%s'", g_dbus_error.message);
 507     dbus_error_free(&g_dbus_error);
 508     return false;
 509   }
 510
 511   reply_signature = dbus_message_get_signature(reply_ptr);
 512
 513   if (strcmp(reply_signature, "bvv") != 0)
 514   {
 515     lash_error("GetParameterValue() reply signature mismatch. '%s'", reply_signature);
 516     dbus_message_unref(reply_ptr);
 517     return false;
 518   }
 519
 520   dbus_message_iter_init(reply_ptr, &top_iter);
 521
 522   dbus_message_iter_get_basic(&top_iter, &is_set);
 523   dbus_message_iter_next(&top_iter);
 524
 525   if (!get_variant(&top_iter, &default_value))
 526   {
 527     dbus_message_unref(reply_ptr);
 528     return false;
 529   }
 530
 531   if (default_value.type == jack_string)
 532   {
 533     free(default_value.value.string);
 534   }
 535
 536   dbus_message_iter_next(&top_iter);
 537
 538   if (!get_variant(&top_iter, parameter_ptr))
 539   {
 540     dbus_message_unref(reply_ptr);
 541     return false;
 542   }
 543
 544   dbus_message_unref(reply_ptr);
 545
 546   *is_set_ptr = is_set;
 547
 548   return true;
 549 }
 550
 551 bool jack_proxy_start_server(void)
 552 {
 553   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "StartServer", "", "");
 554 }
 555
 556 bool jack_proxy_stop_server(void)
 557 {
 558   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "StopServer", "", "");
 559 }
 560
 561 bool jack_proxy_is_realtime(bool * realtime_ptr)
 562 {
 563   dbus_bool_t realtime;
 564
 565   if (!dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "IsStarted", "", "b", &realtime))
 566   {
 567     return false;
 568   }
 569
 570   *realtime_ptr = realtime;
 571   return true;
 572 }
 573
 574 bool jack_proxy_sample_rate(uint32_t * sample_rate_ptr)
 575 {
 576   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetSampleRate", "", "u", sample_rate_ptr);
 577 }
 578
 579 bool jack_proxy_get_xruns(uint32_t * xruns_ptr)
 580 {
 581   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetXruns", "", "u", xruns_ptr);
 582 }
 583
 584 bool jack_proxy_get_dsp_load(double * dsp_load_ptr)
 585 {
 586   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetXruns", "", "d", dsp_load_ptr);
 587 }
 588
 589 bool jack_proxy_get_buffer_size(uint32_t * size_ptr)
 590 {
 591   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetBufferSize", "", "u", size_ptr);
 592 }
 593
 594 bool jack_proxy_set_buffer_size(uint32_t size)
 595 {
 596   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetBufferSize", "u", &size, "");
 597 }
 598
 599 bool jack_proxy_reset_xruns(void)
 600 {
 601   return dbus_call_simple(JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, JACKDBUS_IFACE_CONTROL, "GetBufferSize", "", "");
 602 }