ladish/daemon/virtualizer.c

/* -*- Mode: C ; c-basic-offset: 2 -*- */
/*
 * LADI Session Handler (ladish)
 *
 * Copyright (C) 2009 Nedko Arnaudov <nedko@arnaudov.name>
 *
 **************************************************************************
 * This file contains implementation of the graph virtualizer object
 **************************************************************************
 *
 * LADI Session Handler is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * LADI Session Handler is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "virtualizer.h"
#include "../dbus_constants.h"

struct virtualizer
{

  graph_proxy_handle jack_graph_proxy;
  ladish_graph_handle jack_graph;
  ladish_graph_handle studio_graph;
  uint64_t system_client_id;
  ladish_client_handle system_capture_client;
  ladish_client_handle system_playback_client;
};

/* 47c1cd18-7b21-4389-bec4-6e0658e1d6b1 */
UUID_DEFINE(g_system_capture_uuid,0x47,0xC1,0xCD,0x18,0x7B,0x21,0x43,0x89,0xBE,0xC4,0x6E,0x06,0x58,0xE1,0xD6,0xB1);

/* b2a0bb06-28d8-4bfe-956e-eb24378f9629 */
UUID_DEFINE(g_system_playback_uuid,0xB2,0xA0,0xBB,0x06,0x28,0xD8,0x4B,0xFE,0x95,0x6E,0xEB,0x24,0x37,0x8F,0x96,0x29);

#define virtualizer_ptr ((struct virtualizer *)context)

static void clear(void * context)
{
  log_info("clear");
}

static void client_appeared(void * context, uint64_t id, const char * name)
{
  ladish_client_handle client;

  log_info("client_appeared(%"PRIu64", %s)", id, name);

  client = ladish_graph_find_client_by_name(virtualizer_ptr->jack_graph, name);
  if (client != NULL)
  {
    log_info("found existing client");
    ASSERT(ladish_client_get_jack_id(client) == 0); /* two JACK clients with same name? */
    ladish_client_set_jack_id(client, id);
    ladish_graph_show_client(virtualizer_ptr->jack_graph, client);
    goto exit;
  }

  if (!ladish_client_create(NULL, true, false, false, &client))
  {
    log_error("ladish_client_create() failed. Ignoring client %"PRIu64" (%s)", id, name);
    return;
  }

  ladish_client_set_jack_id(client, id);

  if (!ladish_graph_add_client(virtualizer_ptr->jack_graph, client, name, false))
  {
    log_error("ladish_graph_add_client() failed to add client %"PRIu64" (%s) to JACK graph", id, name);
    ladish_client_destroy(client);
    return;
  }

exit:
  if (strcmp(name, "system") == 0)
  {
    virtualizer_ptr->system_client_id = id;
  }
}

static void client_disappeared(void * context, uint64_t id)
{
  ladish_client_handle client;

  log_info("client_disappeared(%"PRIu64")", id);

  client = ladish_graph_find_client_by_jack_id(virtualizer_ptr->jack_graph, id);
  if (client == NULL)
  {
    log_error("Unknown JACK client with id %"PRIu64" disappeared", id);
    return;
  }

  if (id == virtualizer_ptr->system_client_id)
  {
    virtualizer_ptr->system_client_id = 0;
  }

  if (true)                     /* if client is supposed to be persisted */
  {
    ladish_client_set_jack_id(client, 0);
    ladish_graph_hide_client(virtualizer_ptr->jack_graph, client);
  }
  else
  {
    ladish_graph_remove_client(virtualizer_ptr->jack_graph, client, false);
    ladish_client_destroy(client);
  }
}

static void port_appeared(void * context, uint64_t client_id, uint64_t port_id, const char * port_name, bool is_input, bool is_terminal, bool is_midi)
{
  ladish_client_handle client;
  ladish_port_handle port;
  uint32_t type;
  uint32_t flags;
  const char * jack_client_name;

  log_info("port_appeared(%"PRIu64", %"PRIu64", %s (%s, %s))", client_id, port_id, port_name, is_input ? "in" : "out", is_midi ? "midi" : "audio");

  client = ladish_graph_find_client_by_jack_id(virtualizer_ptr->jack_graph, client_id);
  if (client == NULL)
  {
    log_error("Port of unknown JACK client with id %"PRIu64" appeared", client_id);
    return;
  }

  jack_client_name = ladish_graph_get_client_name(virtualizer_ptr->jack_graph, client);

  type = is_midi ? JACKDBUS_PORT_TYPE_MIDI : JACKDBUS_PORT_TYPE_AUDIO;
  flags = is_input ? JACKDBUS_PORT_FLAG_INPUT : JACKDBUS_PORT_FLAG_OUTPUT;
  if (is_terminal)
  {
    flags |= JACKDBUS_PORT_FLAG_TERMINAL;
  }

  port = ladish_graph_find_port_by_name(virtualizer_ptr->jack_graph, client, port_name);
  if (port != NULL)
  {
    log_info("found existing port");

    ASSERT(ladish_port_get_jack_id(port) == 0); /* two JACK ports with same name? */
    ladish_port_set_jack_id(port, port_id);
    ladish_graph_adjust_port(virtualizer_ptr->jack_graph, port, type, flags);
    ladish_graph_show_port(virtualizer_ptr->jack_graph, port);

    if (!ladish_graph_is_port_present(virtualizer_ptr->studio_graph, port))
    {
      log_error("JACK port not found in studio graph");
      ASSERT_NO_PASS;
      return;
    }
    else
    {
      ladish_graph_adjust_port(virtualizer_ptr->studio_graph, port, type, flags);
      ladish_graph_show_port(virtualizer_ptr->studio_graph, port);
      return;
    }
  }

  if (!ladish_port_create(NULL, &port))
  {
    log_error("ladish_port_create() failed.");
    return;
  }

  ladish_port_set_jack_id(port, port_id);

  if (!ladish_graph_add_port(virtualizer_ptr->jack_graph, client, port, port_name, type, flags, false))
  {
    log_error("ladish_graph_add_port() failed.");
    ladish_port_destroy(port);
    return;
  }

  if (client_id == virtualizer_ptr->system_client_id)
  {
    if (!is_input)
    { /* output capture port */
      if (virtualizer_ptr->system_capture_client == NULL)
      {
        if (!ladish_client_create(g_system_capture_uuid, true, false, true, &virtualizer_ptr->system_capture_client))
        {
          log_error("ladish_client_create() failed.");
          return;
        }

        if (!ladish_graph_add_client(virtualizer_ptr->studio_graph, virtualizer_ptr->system_capture_client, "Hardware Capture", false))
        {
          log_error("ladish_graph_add_client() failed.");
          ladish_graph_remove_client(virtualizer_ptr->studio_graph, virtualizer_ptr->system_capture_client, true);
          virtualizer_ptr->system_capture_client = NULL;
          return;
        }
      }

      client = virtualizer_ptr->system_capture_client;
    }
    else
    { /* input capture port */
      if (virtualizer_ptr->system_playback_client == NULL)
      {
        if (!ladish_client_create(g_system_playback_uuid, true, false, true, &virtualizer_ptr->system_playback_client))
        {
          log_error("ladish_client_create() failed.");
          return;
        }

        if (!ladish_graph_add_client(virtualizer_ptr->studio_graph, virtualizer_ptr->system_playback_client, "Hardware Playback", false))
        {
          ladish_graph_remove_client(virtualizer_ptr->studio_graph, virtualizer_ptr->system_playback_client, true);
          virtualizer_ptr->system_playback_client = NULL;
          return;
        }
      }

      client = virtualizer_ptr->system_playback_client;
    }
  }
  else
  { /* non-system client */
    client = ladish_graph_find_client_by_jack_id(virtualizer_ptr->studio_graph, client_id);
    if (client == NULL)
    {
      if (!ladish_client_create(NULL, false, false, false, &client))
      {
        log_error("ladish_client_create() failed.");
        return;
      }

      ladish_client_set_jack_id(client, client_id);

      if (!ladish_graph_add_client(virtualizer_ptr->studio_graph, client, jack_client_name, false))
      {
        log_error("ladish_graph_add_client() failed to add client '%s' to studio graph", jack_client_name);
        ladish_client_destroy(client);
        return;
      }
    }
  }

  if (!ladish_graph_add_port(virtualizer_ptr->studio_graph, client, port, port_name, type, flags, false))
  {
    log_error("ladish_graph_add_port() failed.");
    return;
  }
}

static void port_disappeared(void * context, uint64_t client_id, uint64_t port_id)
{
  ladish_client_handle client;
  ladish_port_handle port;

  log_info("port_disappeared(%"PRIu64")", port_id);

  client = ladish_graph_find_client_by_jack_id(virtualizer_ptr->jack_graph, client_id);
  if (client == NULL)
  {
    log_error("Port of unknown JACK client with id %"PRIu64" disappeared", client_id);
    return;
  }

  port = ladish_graph_find_port_by_jack_id(virtualizer_ptr->jack_graph, port_id);
  if (port == NULL)
  {
    log_error("Unknown JACK port with id %"PRIu64" disappeared", port_id);
    return;
  }

  if (true)                     /* if client is supposed to be persisted */
  {
    ladish_port_set_jack_id(port, 0);
    ladish_graph_hide_port(virtualizer_ptr->jack_graph, port);
    ladish_graph_hide_port(virtualizer_ptr->studio_graph, port);
    client = ladish_graph_get_port_client(virtualizer_ptr->studio_graph, port);
    if (ladish_graph_is_client_looks_empty(virtualizer_ptr->studio_graph, client))
    {
        ladish_graph_hide_client(virtualizer_ptr->studio_graph, client);
    }
  }
  else
  {
    ladish_graph_remove_port(virtualizer_ptr->jack_graph, port);

    client = ladish_graph_remove_port(virtualizer_ptr->studio_graph, port);
    if (client != NULL)
    {
      if (ladish_graph_is_client_empty(virtualizer_ptr->studio_graph, client))
      {
        ladish_graph_remove_client(virtualizer_ptr->studio_graph, client, false);
        if (client == virtualizer_ptr->system_capture_client)
        {
          virtualizer_ptr->system_capture_client = NULL;
        }
        if (client == virtualizer_ptr->system_playback_client)
        {
          virtualizer_ptr->system_playback_client = NULL;
        }
      }
    }
  }
}

static bool ports_connect_request(void * context, ladish_graph_handle graph_handle, ladish_port_handle port1, ladish_port_handle port2)
{
  uint64_t port1_id;
  uint64_t port2_id;

  ASSERT(graph_handle == virtualizer_ptr->studio_graph);
  log_info("virtualizer: ports connect request");

  port1_id = ladish_port_get_jack_id(port1);
  port2_id = ladish_port_get_jack_id(port2);

  graph_proxy_connect_ports(virtualizer_ptr->jack_graph_proxy, port1_id, port2_id);

  return true;
}

static bool ports_disconnect_request(void * context, ladish_graph_handle graph_handle, uint64_t connection_id)
{
  ladish_port_handle port1;
  ladish_port_handle port2;
  uint64_t port1_id;
  uint64_t port2_id;

  log_info("virtualizer: ports disconnect request");

  ASSERT(graph_handle == virtualizer_ptr->studio_graph);

  if (!ladish_graph_get_connection_ports(virtualizer_ptr->jack_graph, connection_id, &port1, &port2))
  {
    log_error("cannot find ports that are disconnect-requested");
    ASSERT_NO_PASS;
    return false;
  }

  port1_id = ladish_port_get_jack_id(port1);
  port2_id = ladish_port_get_jack_id(port2);

  graph_proxy_disconnect_ports(virtualizer_ptr->jack_graph_proxy, port1_id, port2_id);

  return true;
}

static void ports_connected(void * context, uint64_t client1_id, uint64_t port1_id, uint64_t client2_id, uint64_t port2_id)
{
  ladish_port_handle port1;
  ladish_port_handle port2;
  uint64_t connection_id;

  log_info("ports_connected %"PRIu64":%"PRIu64" %"PRIu64":%"PRIu64"", client1_id, port1_id, client2_id, port2_id);

  port1 = ladish_graph_find_port_by_jack_id(virtualizer_ptr->jack_graph, port1_id);
  if (port1 == NULL)
  {
    log_error("Unknown JACK port with id %"PRIu64" connected", port1_id);
    return;
  }

  port2 = ladish_graph_find_port_by_jack_id(virtualizer_ptr->jack_graph, port2_id);
  if (port2 == NULL)
  {
    log_error("Unknown JACK port with id %"PRIu64" connected", port2_id);
    return;
  }

  ladish_graph_add_connection(virtualizer_ptr->jack_graph, port1, port2, false);

  if (ladish_graph_find_connection(virtualizer_ptr->studio_graph, port1, port2, &connection_id))
  {
    log_info("showing hidden connection");
    ladish_graph_show_connection(virtualizer_ptr->studio_graph, connection_id);
  }
  else
  {
    log_info("creating new connection");
    ladish_graph_add_connection(virtualizer_ptr->studio_graph, port1, port2, false);
  }
}

static void ports_disconnected(void * context, uint64_t client1_id, uint64_t port1_id, uint64_t client2_id, uint64_t port2_id)
{
  ladish_port_handle port1;
  ladish_port_handle port2;
  uint64_t connection_id;

  log_info("ports_disconnected %"PRIu64":%"PRIu64" %"PRIu64":%"PRIu64"", client1_id, port1_id, client2_id, port2_id);

  port1 = ladish_graph_find_port_by_jack_id(virtualizer_ptr->jack_graph, port1_id);
  if (port1 == NULL)
  {
    log_error("Unknown JACK port with id %"PRIu64" disconnected", port1_id);
    return;
  }

  port2 = ladish_graph_find_port_by_jack_id(virtualizer_ptr->jack_graph, port2_id);
  if (port2 == NULL)
  {
    log_error("Unknown JACK port with id %"PRIu64" disconnected", port2_id);
    return;
  }

  if (ladish_graph_find_connection(virtualizer_ptr->jack_graph, port1, port2, &connection_id))
  {
    ladish_graph_remove_connection(virtualizer_ptr->jack_graph, connection_id);
  }
  else
  {
    log_error("ports %"PRIu64":%"PRIu64" and %"PRIu64":%"PRIu64" are not connected in the JACK graph", client1_id, port1_id, client2_id, port2_id);
  }

  if (ladish_graph_find_connection(virtualizer_ptr->studio_graph, port1, port2, &connection_id))
  {
    ladish_graph_remove_connection(virtualizer_ptr->studio_graph, connection_id);
  }
  else
  {
    log_error("ports %"PRIu64":%"PRIu64" and %"PRIu64":%"PRIu64" are not connected in the Studio graph", client1_id, port1_id, client2_id, port2_id);
  }
}

#undef virtualizer_ptr

bool
ladish_virtualizer_create(
  graph_proxy_handle jack_graph_proxy,
  ladish_graph_handle jack_graph,
  ladish_graph_handle studio_graph,
  ladish_virtualizer_handle * handle_ptr)
{
  struct virtualizer * virtualizer_ptr;

  virtualizer_ptr = malloc(sizeof(struct virtualizer));
  if (virtualizer_ptr == NULL)
  {
    log_error("malloc() failed for struct virtualizer");
    return false;
  }

  virtualizer_ptr->jack_graph_proxy = jack_graph_proxy;
  virtualizer_ptr->jack_graph = jack_graph;
  virtualizer_ptr->studio_graph = studio_graph;
  virtualizer_ptr->system_client_id = 0;
  virtualizer_ptr->system_capture_client = NULL;
  virtualizer_ptr->system_playback_client = NULL;

  if (!graph_proxy_attach(
        jack_graph_proxy,
        virtualizer_ptr,
        clear,
        client_appeared,
        client_disappeared,
        port_appeared,
        port_disappeared,
        ports_connected,
        ports_disconnected))
  {
    free(virtualizer_ptr);
    return false;
  }

  ladish_graph_set_connection_handlers(studio_graph, virtualizer_ptr, ports_connect_request, ports_disconnect_request);

  *handle_ptr = (ladish_virtualizer_handle)virtualizer_ptr;
  return true;
}

#define virtualizer_ptr ((struct virtualizer *)handle)

void
ladish_virtualizer_destroy(
  ladish_virtualizer_handle handle)
{
  log_info("ladish_virtualizer_destroy() called");

  graph_proxy_detach((graph_proxy_handle)handle, virtualizer_ptr);
}

#undef virtualizer_ptr