jmcore.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains implementation of the JACK multicore (snake)
   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 #include "common.h"
  28
  29 #include <unistd.h>
  30 #include <signal.h>
  31 #include <jack/jack.h>
  32 #include <jack/midiport.h>
  33
  34 #include "dbus/helpers.h"
  35 #include "dbus/error.h"
  36 #include "dbus_constants.h"
  37
  38 extern const struct dbus_interface_descriptor g_interface;
  39
  40 static const char * g_dbus_unique_name;
  41 static dbus_object_path g_object;
  42 static bool g_quit;
  43
  44 struct list_head g_pairs;
  45
  46 struct port_pair
  47 {
  48   struct list_head siblings;
  49   jack_client_t * client;
  50   bool dead;
  51   bool midi;
  52   jack_port_t * input_port;
  53   jack_port_t * output_port;
  54   char * input_port_name;
  55   char * output_port_name;
  56 };
  57
  58 #define pair_ptr ((struct port_pair *)arg)
  59
  60 void shutdown_callback(void * arg)
  61 {
  62   pair_ptr->dead = true;
  63 }
  64
  65 int process_callback(jack_nframes_t nframes, void * arg)
  66 {
  67   void * input;
  68   void * output;
  69   jack_midi_event_t midi_event;
  70   jack_nframes_t midi_event_index;
  71
  72   input = jack_port_get_buffer(pair_ptr->input_port, nframes);
  73   output = jack_port_get_buffer(pair_ptr->output_port, nframes);
  74
  75   if (!pair_ptr->midi)
  76   {
  77     memcpy(output, input, nframes * sizeof(jack_default_audio_sample_t));
  78   }
  79   else
  80   {
  81     jack_midi_clear_buffer(output);
  82     midi_event_index = 0;
  83     while (jack_midi_event_get(&midi_event, input, midi_event_index) == 0)
  84     {
  85       jack_midi_event_write(output, midi_event.time, midi_event.buffer, midi_event.size);
  86       midi_event_index++;
  87     }
  88   }
  89
  90   return 0;
  91 }
  92
  93 #undef pair_ptr
  94
  95 static void destroy_pair(struct port_pair * pair_ptr)
  96 {
  97   list_del(&pair_ptr->siblings);
  98   jack_client_close(pair_ptr->client);
  99   free(pair_ptr->input_port_name);
 100   free(pair_ptr->output_port_name);
 101   free(pair_ptr);
 102 }
 103
 104 static void bury_zombie_pairs(void)
 105 {
 106   struct list_head * node_ptr;
 107   struct list_head * temp_node_ptr;
 108   struct port_pair * pair_ptr;
 109
 110   list_for_each_safe(node_ptr, temp_node_ptr, &g_pairs)
 111   {
 112     pair_ptr = list_entry(node_ptr, struct port_pair, siblings);
 113     if (pair_ptr->dead)
 114     {
 115       log_info("Bury zombie '%s':'%s'", pair_ptr->input_port_name, pair_ptr->output_port_name);
 116       destroy_pair(pair_ptr);
 117     }
 118   }
 119 }
 120
 121 static bool connect_dbus(void)
 122 {
 123   int ret;
 124
 125   dbus_error_init(&g_dbus_error);
 126
 127   g_dbus_connection = dbus_bus_get(DBUS_BUS_SESSION, &g_dbus_error);
 128   if (dbus_error_is_set(&g_dbus_error))
 129   {
 130     log_error("Failed to get bus: %s", g_dbus_error.message);
 131     dbus_error_free(&g_dbus_error);
 132     goto fail;
 133   }
 134
 135   g_dbus_unique_name = dbus_bus_get_unique_name(g_dbus_connection);
 136   if (g_dbus_unique_name == NULL)
 137   {
 138     log_error("Failed to read unique bus name");
 139     goto unref_connection;
 140   }
 141
 142   log_info("Connected to local session bus, unique name is \"%s\"", g_dbus_unique_name);
 143
 144   ret = dbus_bus_request_name(g_dbus_connection, JMCORE_SERVICE_NAME, DBUS_NAME_FLAG_DO_NOT_QUEUE, &g_dbus_error);
 145   if (ret == -1)
 146   {
 147     log_error("Failed to acquire bus name: %s", g_dbus_error.message);
 148     dbus_error_free(&g_dbus_error);
 149     goto unref_connection;
 150   }
 151
 152   if (ret == DBUS_REQUEST_NAME_REPLY_EXISTS)
 153   {
 154     log_error("Requested connection name already exists");
 155     goto unref_connection;
 156   }
 157
 158   g_object = dbus_object_path_new(JMCORE_OBJECT_PATH, &g_interface, NULL, NULL);
 159   if (g_object == NULL)
 160   {
 161     goto unref_connection;
 162   }
 163
 164   if (!dbus_object_path_register(g_dbus_connection, g_object))
 165   {
 166     goto destroy_control_object;
 167   }
 168
 169   return true;
 170
 171 destroy_control_object:
 172   dbus_object_path_destroy(g_dbus_connection, g_object);
 173 unref_connection:
 174   dbus_connection_unref(g_dbus_connection);
 175
 176 fail:
 177   return false;
 178 }
 179
 180 static void disconnect_dbus(void)
 181 {
 182   dbus_object_path_destroy(g_dbus_connection, g_object);
 183   dbus_connection_unref(g_dbus_connection);
 184 }
 185
 186 void term_signal_handler(int signum)
 187 {
 188   log_info("Caught signal %d (%s), terminating", signum, strsignal(signum));
 189   g_quit = true;
 190 }
 191
 192 bool install_term_signal_handler(int signum, bool ignore_if_already_ignored)
 193 {
 194   sig_t sigh;
 195
 196   sigh = signal(signum, term_signal_handler);
 197   if (sigh == SIG_ERR)
 198   {
 199     log_error("signal() failed to install handler function for signal %d.", signum);
 200     return false;
 201   }
 202
 203   if (sigh == SIG_IGN && ignore_if_already_ignored)
 204   {
 205     signal(SIGTERM, SIG_IGN);
 206   }
 207
 208   return true;
 209 }
 210
 211 int main(int argc, char ** argv)
 212 {
 213   int ret;
 214
 215   INIT_LIST_HEAD(&g_pairs);
 216
 217   install_term_signal_handler(SIGTERM, false);
 218   install_term_signal_handler(SIGINT, true);
 219
 220   if (!connect_dbus())
 221   {
 222     log_error("Failed to connect to D-Bus");
 223     return 1;
 224   }
 225
 226   while (!g_quit)
 227   {
 228     dbus_connection_read_write_dispatch(g_dbus_connection, 50);
 229     bury_zombie_pairs();
 230   }
 231
 232   ret = 0;
 233
 234   while (!list_empty(&g_pairs))
 235   {
 236     destroy_pair(list_entry(g_pairs.next, struct port_pair, siblings));
 237   }
 238
 239   disconnect_dbus();
 240   return 0;
 241 }
 242
 243 /***************************************************************************/
 244 /* D-Bus interface implementation */
 245
 246 static void jmcore_get_pid(struct dbus_method_call * call_ptr)
 247 {
 248   dbus_int64_t pid;
 249
 250   pid = getpid();
 251
 252   method_return_new_single(call_ptr, DBUS_TYPE_INT64, &pid);
 253 }
 254
 255 static void jmcore_create(struct dbus_method_call * call_ptr)
 256 {
 257   dbus_bool_t midi;
 258   const char * input;
 259   const char * output;
 260   struct port_pair * pair_ptr;
 261   int ret;
 262
 263   dbus_error_init(&g_dbus_error);
 264   if (!dbus_message_get_args(
 265         call_ptr->message,
 266         &g_dbus_error,
 267         DBUS_TYPE_BOOLEAN, &midi,
 268         DBUS_TYPE_STRING, &input,
 269         DBUS_TYPE_STRING, &output,
 270         DBUS_TYPE_INVALID))
 271   {
 272     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "Invalid arguments to method \"%s\": %s",  call_ptr->method_name, g_dbus_error.message);
 273     dbus_error_free(&g_dbus_error);
 274     goto exit;
 275   }
 276
 277   pair_ptr = malloc(sizeof(struct port_pair));
 278   if (pair_ptr == NULL)
 279   {
 280     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Allocation of port pair structure failed");
 281     goto exit;
 282   }
 283
 284   pair_ptr->input_port_name = strdup(input);
 285   if (pair_ptr->input_port_name == NULL)
 286   {
 287     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Allocation of port name buffer failed");
 288     goto free_pair;
 289   }
 290
 291   pair_ptr->output_port_name = strdup(output);
 292   if (pair_ptr->input_port_name == NULL)
 293   {
 294     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Allocation of port name buffer failed");
 295     goto free_input_name;
 296   }
 297
 298   pair_ptr->client = jack_client_open("jmcore", JackNoStartServer, NULL);
 299   if (pair_ptr->client == NULL)
 300   {
 301     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Cannot connect to JACK server");
 302     goto free_output_name;
 303   }
 304
 305   pair_ptr->midi = midi;
 306   pair_ptr->dead = false;
 307
 308   ret = jack_set_process_callback(pair_ptr->client, process_callback, pair_ptr);
 309   if (ret != 0)
 310   {
 311     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "JACK process callback setup failed");
 312     goto close_client;
 313   }
 314
 315   jack_on_shutdown(pair_ptr->client, shutdown_callback, pair_ptr);
 316
 317   pair_ptr->input_port = jack_port_register(pair_ptr->client, input, midi ? JACK_DEFAULT_MIDI_TYPE : JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
 318   if (pair_ptr->input_port == NULL)
 319   {
 320     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Port '%s' registration failed.", input);
 321     goto free_output_name;
 322   }
 323
 324   pair_ptr->output_port = jack_port_register(pair_ptr->client, output, midi ? JACK_DEFAULT_MIDI_TYPE : JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
 325   if (pair_ptr->input_port == NULL)
 326   {
 327     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "Port '%s' registration failed.", output);
 328     goto unregister_input_port;
 329   }
 330
 331   list_add_tail(&pair_ptr->siblings, &g_pairs);
 332
 333   ret = jack_activate(pair_ptr->client);
 334   if (ret != 0)
 335   {
 336     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_GENERIC, "JACK client activation failed");
 337     goto remove_from_list;
 338   }
 339
 340   method_return_new_void(call_ptr);
 341   goto exit;
 342
 343 remove_from_list:
 344   list_del(&pair_ptr->siblings);
 345 //unregister_output_port:
 346   jack_port_unregister(pair_ptr->client, pair_ptr->output_port);
 347 unregister_input_port:
 348   jack_port_unregister(pair_ptr->client, pair_ptr->input_port);
 349 close_client:
 350   jack_client_close(pair_ptr->client);
 351 free_output_name:
 352   free(pair_ptr->output_port_name);
 353 free_input_name:
 354   free(pair_ptr->input_port_name);
 355 free_pair:
 356   free(pair_ptr);
 357 exit:
 358   return;
 359 }
 360
 361 static void jmcore_destroy(struct dbus_method_call * call_ptr)
 362 {
 363   const char * port;
 364   struct list_head * node_ptr;
 365   struct port_pair * pair_ptr;
 366
 367   dbus_error_init(&g_dbus_error);
 368   if (!dbus_message_get_args(call_ptr->message, &g_dbus_error, DBUS_TYPE_STRING, &port, DBUS_TYPE_INVALID))
 369   {
 370     lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "Invalid arguments to method \"%s\": %s",  call_ptr->method_name, g_dbus_error.message);
 371     dbus_error_free(&g_dbus_error);
 372     return;
 373   }
 374
 375   list_for_each(node_ptr, &g_pairs)
 376   {
 377     pair_ptr = list_entry(node_ptr, struct port_pair, siblings);
 378     if (strcmp(pair_ptr->input_port_name, port) == 0 ||
 379         strcmp(pair_ptr->output_port_name, port) == 0)
 380     {
 381       destroy_pair(pair_ptr);
 382       method_return_new_void(call_ptr);
 383       return;
 384     }
 385   }
 386
 387   lash_dbus_error(call_ptr, LASH_DBUS_ERROR_INVALID_ARGS, "port '%s' not found.", port);
 388   return;
 389 }
 390
 391 static void jmcore_exit(struct dbus_method_call * call_ptr)
 392 {
 393   log_info("Exit command received through D-Bus");
 394   g_quit = true;
 395   method_return_new_void(call_ptr);
 396 }
 397
 398 METHOD_ARGS_BEGIN(get_pid, "Get process ID")
 399   METHOD_ARG_DESCRIBE_OUT("process_id", DBUS_TYPE_INT64_AS_STRING, "Process ID")
 400 METHOD_ARGS_END
 401
 402 METHOD_ARGS_BEGIN(create, "Create port pair")
 403   METHOD_ARG_DESCRIBE_IN("midi", "b", "Whether to create midi or audio ports")
 404   METHOD_ARG_DESCRIBE_IN("input_port", "s", "Input port name")
 405   METHOD_ARG_DESCRIBE_IN("output_port", "s", "Output port name")
 406 METHOD_ARGS_END
 407
 408 METHOD_ARGS_BEGIN(destroy, "Destroy port pair")
 409   METHOD_ARG_DESCRIBE_IN("port", "s", "Port name")
 410 METHOD_ARGS_END
 411
 412 METHOD_ARGS_BEGIN(exit, "Tell jmcore D-Bus service to exit")
 413 METHOD_ARGS_END
 414
 415 METHODS_BEGIN
 416   METHOD_DESCRIBE(get_pid, jmcore_get_pid)
 417   METHOD_DESCRIBE(create, jmcore_create)
 418   METHOD_DESCRIBE(destroy, jmcore_destroy)
 419   METHOD_DESCRIBE(exit, jmcore_exit)
 420 METHODS_END
 421
 422 INTERFACE_BEGIN(g_interface, JMCORE_IFACE)
 423   INTERFACE_DEFAULT_HANDLER
 424   INTERFACE_EXPOSE_METHODS
 425 INTERFACE_END