dbus/controller_iface_control.c

   1 /* -*- Mode: C ; c-basic-offset: 4 -*- */
   2 /*
   3     Copyright (C) 2007,2008,2010 Nedko Arnaudov
   4     Copyright (C) 2007-2008 Juuso Alasuutari
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #if defined(HAVE_CONFIG_H)
  22 #include "config.h"
  23 #endif
  24
  25 #include <stdint.h>
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <assert.h>
  29 #include <dbus/dbus.h>
  30
  31 #include "jackdbus.h"
  32 #include "controller_internal.h"
  33 #include "xml.h"
  34
  35 #define JACK_DBUS_IFACE_NAME "org.jackaudio.JackControl"
  36
  37 void
  38 jack_controller_control_send_signal_server_started(void)
  39 {
  40
  41     jack_dbus_send_signal(
  42         JACK_CONTROLLER_OBJECT_PATH,
  43         JACK_DBUS_IFACE_NAME,
  44         "ServerStarted",
  45         DBUS_TYPE_INVALID);
  46 }
  47
  48 void
  49 jack_controller_control_send_signal_server_stopped(void)
  50 {
  51
  52     jack_dbus_send_signal(
  53         JACK_CONTROLLER_OBJECT_PATH,
  54         JACK_DBUS_IFACE_NAME,
  55         "ServerStopped",
  56         DBUS_TYPE_INVALID);
  57 }
  58
  59 #define controller_ptr ((struct jack_controller *)call->context)
  60
  61 /*
  62  * Check if the supplied method name exists in org.jackaudio.JackControl,
  63  * if it does execute it and return true. Otherwise return false.
  64  */
  65 static
  66 bool
  67 jack_control_run_method(
  68     struct jack_dbus_method_call * call,
  69     const struct jack_dbus_interface_method_descriptor * methods)
  70 {
  71     int ret;
  72     int type;
  73     message_arg_t arg;
  74
  75     /* use empty reply if not overridden in the code that follows */
  76     type = DBUS_TYPE_INVALID;
  77
  78     if (strcmp (call->method_name, "Exit") == 0)
  79     {
  80         g_exit_command = TRUE;
  81     }
  82     else if (strcmp (call->method_name, "IsStarted") == 0)
  83     {
  84         type = DBUS_TYPE_BOOLEAN;
  85         arg.boolean = (dbus_bool_t) (controller_ptr->started ? TRUE : FALSE);
  86     }
  87     else if (strcmp (call->method_name, "StartServer") == 0)
  88     {
  89         if (controller_ptr->started)
  90         {
  91             jack_info("Ignoring JACK server start request because server is already started.");
  92         }
  93         else
  94         {
  95             if (!jack_controller_start_server(controller_ptr, call))
  96             {
  97                 /* the reply is set by the failed function */
  98                 assert(call->reply != NULL);
  99                 return true;
 100             }
 101
 102             jack_controller_control_send_signal_server_started();
 103         }
 104     }
 105     else if (strcmp (call->method_name, "StopServer") == 0)
 106     {
 107         if (!controller_ptr->started)
 108         {
 109             jack_info("Ignoring JACK server stop request because server is already stopped.");
 110         }
 111         else
 112         {
 113             if (!jack_controller_stop_server(controller_ptr, call))
 114             {
 115                 /* the reply is set by the failed function */
 116                 assert(call->reply != NULL);
 117                 return true;
 118             }
 119
 120             jack_controller_control_send_signal_server_stopped();
 121         }
 122     }
 123     else if (strcmp (call->method_name, "SwitchMaster") == 0)
 124     {
 125         if (!controller_ptr->started)
 126         {
 127             goto not_started;
 128         }
 129         else
 130         {
 131             if (!jack_controller_switch_master(controller_ptr, call))
 132             {
 133                 /* the reply is set by the failed function */
 134                 assert(call->reply != NULL);
 135                 return true;
 136             }
 137         }
 138     }
 139     else if (strcmp (call->method_name, "GetLoad") == 0)
 140     {
 141         if (!controller_ptr->started)
 142         {
 143             goto not_started;
 144         }
 145
 146         type = DBUS_TYPE_DOUBLE;
 147         arg.doubl = jack_cpu_load(controller_ptr->client);
 148     }
 149     else if (strcmp (call->method_name, "GetXruns") == 0)
 150     {
 151         type = DBUS_TYPE_UINT32;
 152         arg.uint32 = controller_ptr->xruns;
 153     }
 154     else if (strcmp (call->method_name, "GetSampleRate") == 0)
 155     {
 156         if (!controller_ptr->started)
 157         {
 158             goto not_started;
 159         }
 160
 161         type = DBUS_TYPE_UINT32;
 162         arg.uint32 = jack_get_sample_rate(controller_ptr->client);
 163     }
 164     else if (strcmp (call->method_name, "GetLatency") == 0)
 165     {
 166         if (!controller_ptr->started)
 167         {
 168             goto not_started;
 169         }
 170
 171         type = DBUS_TYPE_DOUBLE;
 172         arg.doubl =  ((float)jack_get_buffer_size(controller_ptr->client) / (float)jack_get_sample_rate(controller_ptr->client)) * 1000.0f;
 173     }
 174     else if (strcmp (call->method_name, "GetBufferSize") == 0)
 175     {
 176         if (!controller_ptr->started)
 177         {
 178             goto not_started;
 179         }
 180
 181         type = DBUS_TYPE_UINT32;
 182         arg.uint32 = jack_get_buffer_size(controller_ptr->client);
 183     }
 184     else if (strcmp (call->method_name, "SetBufferSize") == 0)
 185     {
 186         dbus_uint32_t buffer_size;
 187
 188         if (!controller_ptr->started)
 189         {
 190             goto not_started;
 191         }
 192
 193         if (!jack_dbus_get_method_args(call, DBUS_TYPE_UINT32, &buffer_size, DBUS_TYPE_INVALID))
 194         {
 195             /* jack_dbus_get_method_args() has set reply for us */
 196             goto exit;
 197         }
 198
 199         ret = jack_set_buffer_size(controller_ptr->client, buffer_size);
 200         if (ret != 0)
 201         {
 202             jack_dbus_error(
 203                 call,
 204                 JACK_DBUS_ERROR_GENERIC,
 205                 "jack_set_buffer_size(%u) failed with error %d", (unsigned int)buffer_size, ret);
 206
 207             goto exit;
 208         }
 209     }
 210     else if (strcmp (call->method_name, "IsRealtime") == 0)
 211     {
 212         type = DBUS_TYPE_BOOLEAN;
 213         arg.boolean = jack_is_realtime(controller_ptr->client) ? TRUE : FALSE;
 214     }
 215     else if (strcmp (call->method_name, "ResetXruns") == 0)
 216     {
 217         controller_ptr->xruns = 0;
 218     }
 219     else if (strcmp (call->method_name, "LoadInternal") == 0)
 220     {
 221         const char *internal_name;
 222
 223         if (!jack_dbus_get_method_args(call, DBUS_TYPE_STRING, &internal_name, DBUS_TYPE_INVALID))
 224         {
 225             /* The method call had invalid arguments meaning that
 226             * get_method_args() has constructed an error for us.
 227             */
 228             goto exit;
 229         }
 230
 231         if (!jack_controller_load_internal(controller_ptr, internal_name)) {
 232             jack_dbus_error(
 233                 call,
 234                 JACK_DBUS_ERROR_GENERIC,
 235                 "jack_controller_load_internal failed for internal (%s)", internal_name);
 236         }
 237     }
 238     else if (strcmp (call->method_name, "AddSlaveDriver") == 0)
 239     {
 240         const char *driver_name;
 241
 242         if (controller_ptr->started)
 243         {
 244             goto fail_started;
 245         }
 246
 247         if (!jack_dbus_get_method_args(call, DBUS_TYPE_STRING, &driver_name, DBUS_TYPE_INVALID))
 248         {
 249             /* The method call had invalid arguments meaning that
 250             * get_method_args() has constructed an error for us.
 251             */
 252             goto exit;
 253         }
 254
 255         if (!jack_controller_add_slave_driver(controller_ptr, driver_name))
 256         {
 257             jack_dbus_error(
 258                 call,
 259                 JACK_DBUS_ERROR_GENERIC,
 260                 "jack_controller_add_slave_driver failed for driver (%s)", driver_name);
 261         }
 262         else
 263         {
 264             jack_controller_pending_save(controller_ptr);
 265         }
 266     }
 267     else if (strcmp (call->method_name, "RemoveSlaveDriver") == 0)
 268     {
 269         const char *driver_name;
 270
 271         if (controller_ptr->started)
 272         {
 273             goto fail_started;
 274         }
 275
 276         if (!jack_dbus_get_method_args(call, DBUS_TYPE_STRING, &driver_name, DBUS_TYPE_INVALID))
 277         {
 278             /* The method call had invalid arguments meaning that
 279             * get_method_args() has constructed an error for us.
 280             */
 281             goto exit;
 282         }
 283
 284         if (!jack_controller_remove_slave_driver(controller_ptr, driver_name))
 285         {
 286             jack_dbus_error(
 287                 call,
 288                 JACK_DBUS_ERROR_GENERIC,
 289                 "jack_controller_remove_slave_driver failed for driver (%s)", driver_name);
 290         }
 291         else
 292         {
 293             jack_controller_pending_save(controller_ptr);
 294         }
 295     }
 296     else if (strcmp (call->method_name, "UnloadInternal") == 0)
 297     {
 298         const char *internal_name;
 299
 300         if (!jack_dbus_get_method_args(call, DBUS_TYPE_STRING, &internal_name, DBUS_TYPE_INVALID))
 301         {
 302             /* The method call had invalid arguments meaning that
 303             * get_method_args() has constructed an error for us.
 304             */
 305             goto exit;
 306         }
 307
 308         if (!jack_controller_unload_internal(controller_ptr, internal_name)) {
 309             jack_dbus_error(
 310                 call,
 311                 JACK_DBUS_ERROR_GENERIC,
 312                 "jack_controller_unload_internal failed for internal (%s)", internal_name);
 313         }
 314     }
 315
 316     else
 317     {
 318         return false;
 319     }
 320
 321     jack_dbus_construct_method_return_single(call, type, arg);
 322     goto exit;
 323
 324 not_started:
 325     jack_dbus_only_error(
 326         call,
 327         JACK_DBUS_ERROR_SERVER_NOT_RUNNING,
 328         "Can't execute method '%s' with stopped JACK server",
 329         call->method_name);
 330     goto exit;
 331
 332 fail_started:
 333     jack_dbus_only_error(
 334         call,
 335         JACK_DBUS_ERROR_SERVER_RUNNING,
 336         "Can't execute method '%s' with started JACK server",
 337         call->method_name);
 338     goto exit;
 339
 340 exit:
 341     return true;
 342 }
 343
 344 #undef controller_ptr
 345
 346 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(IsStarted)
 347     JACK_DBUS_METHOD_ARGUMENT("started", "b", true)
 348 JACK_DBUS_METHOD_ARGUMENTS_END
 349
 350 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(StartServer)
 351 JACK_DBUS_METHOD_ARGUMENTS_END
 352
 353 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(StopServer)
 354 JACK_DBUS_METHOD_ARGUMENTS_END
 355
 356 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(SwitchMaster)
 357 JACK_DBUS_METHOD_ARGUMENTS_END
 358
 359 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(GetLoad)
 360     JACK_DBUS_METHOD_ARGUMENT("load", "d", true)
 361 JACK_DBUS_METHOD_ARGUMENTS_END
 362
 363 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(GetXruns)
 364     JACK_DBUS_METHOD_ARGUMENT("xruns_count", "u", true)
 365 JACK_DBUS_METHOD_ARGUMENTS_END
 366
 367 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(GetSampleRate)
 368     JACK_DBUS_METHOD_ARGUMENT("sample_rate", "u", true)
 369 JACK_DBUS_METHOD_ARGUMENTS_END
 370
 371 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(GetLatency)
 372     JACK_DBUS_METHOD_ARGUMENT("latency_ms", "d", true)
 373 JACK_DBUS_METHOD_ARGUMENTS_END
 374
 375 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(GetBufferSize)
 376     JACK_DBUS_METHOD_ARGUMENT("buffer_size_frames", "u", true)
 377 JACK_DBUS_METHOD_ARGUMENTS_END
 378
 379 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(SetBufferSize)
 380     JACK_DBUS_METHOD_ARGUMENT("buffer_size_frames", "u", false)
 381 JACK_DBUS_METHOD_ARGUMENTS_END
 382
 383 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(IsRealtime)
 384     JACK_DBUS_METHOD_ARGUMENT("realtime", "b", true)
 385 JACK_DBUS_METHOD_ARGUMENTS_END
 386
 387 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(ResetXruns)
 388 JACK_DBUS_METHOD_ARGUMENTS_END
 389
 390 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(LoadInternal)
 391     JACK_DBUS_METHOD_ARGUMENT("internal", "s", false)
 392 JACK_DBUS_METHOD_ARGUMENTS_END
 393
 394 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(UnloadInternal)
 395     JACK_DBUS_METHOD_ARGUMENT("internal", "s", false)
 396 JACK_DBUS_METHOD_ARGUMENTS_END
 397
 398 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(AddSlaveDriver)
 399     JACK_DBUS_METHOD_ARGUMENT("driver_name", "s", false)
 400 JACK_DBUS_METHOD_ARGUMENTS_END
 401
 402 JACK_DBUS_METHOD_ARGUMENTS_BEGIN(RemoveSlaveDriver)
 403     JACK_DBUS_METHOD_ARGUMENT("driver_name", "s", false)
 404 JACK_DBUS_METHOD_ARGUMENTS_END
 405
 406 JACK_DBUS_METHODS_BEGIN
 407     JACK_DBUS_METHOD_DESCRIBE(IsStarted, NULL)
 408     JACK_DBUS_METHOD_DESCRIBE(StartServer, NULL)
 409     JACK_DBUS_METHOD_DESCRIBE(StopServer, NULL)
 410     JACK_DBUS_METHOD_DESCRIBE(SwitchMaster, NULL)
 411     JACK_DBUS_METHOD_DESCRIBE(GetLoad, NULL)
 412     JACK_DBUS_METHOD_DESCRIBE(GetXruns, NULL)
 413     JACK_DBUS_METHOD_DESCRIBE(GetSampleRate, NULL)
 414     JACK_DBUS_METHOD_DESCRIBE(GetLatency, NULL)
 415     JACK_DBUS_METHOD_DESCRIBE(GetBufferSize, NULL)
 416     JACK_DBUS_METHOD_DESCRIBE(SetBufferSize, NULL)
 417     JACK_DBUS_METHOD_DESCRIBE(IsRealtime, NULL)
 418     JACK_DBUS_METHOD_DESCRIBE(ResetXruns, NULL)
 419     JACK_DBUS_METHOD_DESCRIBE(LoadInternal, NULL)
 420     JACK_DBUS_METHOD_DESCRIBE(UnloadInternal, NULL)
 421     JACK_DBUS_METHOD_DESCRIBE(AddSlaveDriver, NULL)
 422     JACK_DBUS_METHOD_DESCRIBE(RemoveSlaveDriver, NULL)
 423 JACK_DBUS_METHODS_END
 424
 425 JACK_DBUS_SIGNAL_ARGUMENTS_BEGIN(ServerStarted)
 426 JACK_DBUS_SIGNAL_ARGUMENTS_END
 427
 428 JACK_DBUS_SIGNAL_ARGUMENTS_BEGIN(ServerStopped)
 429 JACK_DBUS_SIGNAL_ARGUMENTS_END
 430
 431 JACK_DBUS_SIGNALS_BEGIN
 432     JACK_DBUS_SIGNAL_DESCRIBE(ServerStarted)
 433     JACK_DBUS_SIGNAL_DESCRIBE(ServerStopped)
 434 JACK_DBUS_SIGNALS_END
 435
 436 JACK_DBUS_IFACE_BEGIN(g_jack_controller_iface_control, JACK_DBUS_IFACE_NAME)
 437     JACK_DBUS_IFACE_HANDLER(jack_control_run_method)
 438     JACK_DBUS_IFACE_EXPOSE_METHODS
 439     JACK_DBUS_IFACE_EXPOSE_SIGNALS
 440 JACK_DBUS_IFACE_END