jack1/libjack/client.c

/* -*- mode: c; c-file-style: "bsd"; -*- */
/*
    Copyright (C) 2001-2003 Paul Davis
    Copyright (C) 2005 Jussi Laako

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 2.1 of the License, or
    (at your option) any later version.

    This program 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

 */

#include <config.h>

#include <pthread.h>
#include <errno.h>
#include <fcntl.h>
#include <stdarg.h>
#include <stdio.h>
#include <limits.h>
#ifdef HAVE_STDINT_H
#include <stdint.h>
#endif
#include <regex.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/wait.h>

#include <jack/jack.h>
#include <jack/jslist.h>
#include <jack/thread.h>
#include <jack/uuid.h>

#include "internal.h"
#include "engine.h"
#include "pool.h"
#include "version.h"
#include "shm.h"
#include "unlock.h"
#include "varargs.h"
#include "intsimd.h"
#include "messagebuffer.h"

#include <sysdeps/time.h>

#include "local.h"

#include <sysdeps/poll.h>
#include <sysdeps/ipc.h>

#ifdef JACK_USE_MACH_THREADS
#include <sysdeps/pThreadUtilities.h>
#endif

static pthread_mutex_t client_lock;
static pthread_cond_t client_ready;

static int
jack_client_close_aux(jack_client_t *client);

#define EVENT_POLL_INDEX 0
#define WAIT_POLL_INDEX 1
#define event_fd pollfd[EVENT_POLL_INDEX].fd
#define graph_wait_fd pollfd[WAIT_POLL_INDEX].fd

typedef struct {
	int status;
	struct _jack_client *client;
	const char *client_name;
} client_info;

#ifdef USE_DYNSIMD

#ifdef ARCH_X86

int cpu_type = 0;

static void
init_cpu ()
{
	cpu_type = ((have_3dnow () << 8) | have_sse ());
#if 0
	if (ARCH_X86_HAVE_3DNOW (cpu_type)) {
		jack_debug ("Enhanced3DNow! detected");
	}
	if (ARCH_X86_HAVE_SSE2 (cpu_type)) {
		jack_debug ("SSE2 detected");
	}
	if ((!ARCH_X86_HAVE_3DNOW (cpu_type)) && (!ARCH_X86_HAVE_SSE2 (cpu_type))) {
		jack_debug ("No supported SIMD instruction sets detected");
	}
#endif
	jack_port_set_funcs ();
}

#else /* ARCH_X86 */

static void
init_cpu ()
{
	jack_port_set_funcs ();
}

#endif  /* ARCH_X86 */

#endif  /* USE_DYNSIMD */

/*
 * The following read/write wrappers handle the case of interruption
 * by system signals:
 */
static int
read_retry(int fd, void *dst, int size)
{
	int error;
	do {
		error = read(fd, dst, size);
	} while (error == -1 && errno == EINTR);
	return (error);
}

static int
write_retry(int fd, const void *src, int size)
{
	int error;
	do {
		error = write(fd, src, size);
	} while (error == -1 && errno == EINTR);
	return (error);
}

const char *
jack_get_tmpdir ()
{
	static char tmpdir[PATH_MAX + 1] = "";
	FILE* in;
	size_t len;
	char buf[PATH_MAX + 2]; /* allow tmpdir to live anywhere, plus newline, plus null */
	char *pathenv;
	char *pathcopy;
	char *p;

	/* return tmpdir if set */
	if (tmpdir[0] != '\0') {
		return tmpdir;
	}

	/* some implementations of popen(3) close a security loophole by
	   resetting PATH for the exec'd command. since we *want* to
	   use the user's PATH setting to locate jackd, we have to
	   do it ourselves.
	 */

	if ((pathenv = getenv ("PATH")) == 0) {
		return NULL;
	}

	/* don't let strtok(3) mess with the real environment variable */

	if ((pathcopy = strdup (pathenv)) == NULL) {
		return NULL;
	}
	p = strtok (pathcopy, ":");

	while (p) {
		char jackd[PATH_MAX + 1];
		char command[PATH_MAX + 4];

		snprintf (jackd, sizeof(jackd), "%s/jackd", p);

		if (access (jackd, X_OK) == 0) {

			snprintf (command, sizeof(command), "%s -l", jackd);

			if ((in = popen (command, "r")) != NULL) {
				break;
			}
		}

		p = strtok (NULL, ":");
	}

	if (p == NULL) {
		/* no command successfully started */
		free (pathcopy);
		return NULL;
	}

	if (fgets (buf, sizeof(buf), in) == NULL) {
		pclose (in);
		free (pathcopy);
		return NULL;
	}

	len = strlen (buf);

	if (buf[len - 1] != '\n') {
		/* didn't get a whole line */
		pclose (in);
		free (pathcopy);
		return NULL;
	}

	memcpy (tmpdir, buf, len - 1);
	tmpdir[len - 1] = '\0';

	pclose (in);
	free (pathcopy);

	return tmpdir;
}

void
jack_error (const char *fmt, ...)
{
	va_list ap;
	char buffer[300];

	va_start (ap, fmt);
	vsnprintf (buffer, sizeof(buffer), fmt, ap);
	jack_error_callback (buffer);
	va_end (ap);
}

void
default_jack_error_callback (const char *desc)
{
	fprintf (stderr, "%s\n", desc);
	fflush (stderr);
}

void
default_jack_info_callback (const char *desc)
{
	fprintf (stdout, "%s\n", desc);
	fflush (stdout);
}

void
silent_jack_error_callback (const char *desc)
{
}

void (*jack_error_callback)(const char *desc) = &default_jack_error_callback;
void (*jack_info_callback)(const char *desc) = &default_jack_info_callback;

void
jack_info (const char *fmt, ...)
{
	va_list ap;
	char buffer[300];

	va_start (ap, fmt);
	vsnprintf (buffer, sizeof(buffer), fmt, ap);
	jack_info_callback (buffer);
	va_end (ap);
}

static int
oop_client_deliver_request (void *ptr, jack_request_t *req)
{
	int wok, rok;
	jack_client_t *client = (jack_client_t*)ptr;

	wok = (write_retry (client->request_fd, req, sizeof(*req))
	       == sizeof(*req));

	/* if necessary, add variable length key data after a PropertyChange request
	 */

	if (req->type == PropertyChangeNotify) {
		if (req->x.property.keylen) {
			if (write_retry (client->request_fd, req->x.property.key, req->x.property.keylen) != req->x.property.keylen) {
				jack_error ("cannot send property key of length %d to server",
					    req->x.property.keylen);
				req->status = -1;
				return req->status;
			}
		}
	}

	rok = (read_retry (client->request_fd, req, sizeof(*req))
	       == sizeof(*req));

	if (wok && rok) {               /* everything OK? */
		return req->status;
	}

	req->status = -1;               /* request failed */

	/* check for server shutdown */
	if (client->engine->engine_ok == 0) {
		return req->status;
	}

	/* otherwise report errors */
	if (!wok) {
		jack_error ("cannot send request type %d to server",
			    req->type);
	}
	if (!rok) {
		jack_error ("cannot read result for request type %d from"
			    " server (%s)", req->type, strerror (errno));
	}
	return req->status;
}

int
jack_client_deliver_request (const jack_client_t *client, jack_request_t *req)
{
	/* indirect through the function pointer that was set either
	 * by jack_client_open() or by jack_new_client_request() in
	 * the server.
	 */

	return client->deliver_request (client->deliver_arg, req);
}

#if JACK_USE_MACH_THREADS

jack_client_t *
jack_client_alloc ()
{
	jack_client_t *client;

	if ((client = (jack_client_t*)calloc (1, sizeof(jack_client_t))) == NULL) {
		return NULL;
	}

	if ((client->pollfd = (struct pollfd*)malloc (sizeof(struct pollfd) * 1)) == NULL) {
		free (client);
		return NULL;
	}

	client->pollmax = 1;
	client->request_fd = -1;
	client->event_fd = -1;
	client->upstream_is_jackd = 0;
	client->graph_next_fd = -1;
	client->ports = NULL;
	client->ports_ext = NULL;
	client->engine = NULL;
	client->control = NULL;
	client->thread_ok = FALSE;
	client->rt_thread_ok = FALSE;
	client->first_active = TRUE;
	client->on_shutdown = NULL;
	client->on_info_shutdown = NULL;
	client->n_port_types = 0;
	client->port_segment = NULL;

#ifdef USE_DYNSIMD
	init_cpu ();
#endif  /* USE_DYNSIMD */

	return client;
}

#else

jack_client_t *
jack_client_alloc ()
{
	jack_client_t *client;

	if ((client = (jack_client_t*)calloc (1, sizeof(jack_client_t))) == NULL) {
		return NULL;
	}
	if ((client->pollfd = (struct pollfd*)malloc (sizeof(struct pollfd) * 2)) == NULL) {
		free (client);
		return NULL;
	}

	client->pollmax = 2;
	client->request_fd = -1;
	client->event_fd = -1;
	client->upstream_is_jackd = 0;
	client->graph_wait_fd = -1;
	client->graph_next_fd = -1;
	client->ports = NULL;
	client->ports_ext = NULL;
	client->engine = NULL;
	client->control = NULL;
	client->thread_ok = FALSE;
	client->first_active = TRUE;
	client->on_shutdown = NULL;
	client->on_info_shutdown = NULL;
	client->n_port_types = 0;
	client->port_segment = NULL;

#ifdef USE_DYNSIMD
	init_cpu ();
#endif  /* USE_DYNSIMD */

	return client;
}

#endif

/*
 * Build the jack_client_t structure for an internal client.
 */
jack_client_t *
jack_client_alloc_internal (jack_client_control_t *cc, jack_engine_t* engine)
{
	jack_client_t* client;

	client = jack_client_alloc ();

	client->control = cc;
	client->engine = engine->control;

	client->n_port_types = client->engine->n_port_types;
	client->port_segment = &engine->port_segment[0];

	return client;
}

static void
jack_client_free (jack_client_t *client)
{
	if (client->pollfd) {
		free (client->pollfd);
	}

	free (client);
}

void
jack_client_fix_port_buffers (jack_client_t *client)
{
	JSList *node;
	jack_port_t *port;

	/* This releases all local memory owned by input ports
	   and sets the buffer pointer to NULL. This will cause
	   jack_port_get_buffer() to reallocate space for the
	   buffer on the next call (if there is one).
	 */

	for (node = client->ports; node; node = jack_slist_next (node)) {
		port = (jack_port_t*)node->data;

		if (port->shared->flags & JackPortIsInput) {
			if (port->mix_buffer) {
				size_t buffer_size =
					jack_port_type_buffer_size ( port->type_info,
								     client->engine->buffer_size );
				jack_pool_release (port->mix_buffer);
				port->mix_buffer = NULL;
				pthread_mutex_lock (&port->connection_lock);
				if (jack_slist_length (port->connections) > 1) {
					port->mix_buffer = jack_pool_alloc (buffer_size);
					port->fptr.buffer_init (port->mix_buffer,
								buffer_size,
								client->engine->buffer_size);
				}
				pthread_mutex_unlock (&port->connection_lock);
			}
		}
	}
}

int
jack_client_handle_port_connection (jack_client_t *client, jack_event_t *event)
{
	jack_port_t *control_port;
	jack_port_t *other = 0;
	JSList *node;
	int need_free = FALSE;

	if (jack_uuid_compare (client->engine->ports[event->x.self_id].client_id, client->control->uuid) == 0 ||
	    jack_uuid_compare (client->engine->ports[event->y.other_id].client_id, client->control->uuid) == 0) {

		/* its one of ours */

		switch (event->type) {
		case PortConnected:
			other = jack_port_new (client, event->y.other_id,
					       client->engine);
			/* jack_port_by_id_int() always returns an internal
			 * port that does not need to be deallocated
			 */
			control_port = jack_port_by_id_int (client, event->x.self_id,
							    &need_free);
			pthread_mutex_lock (&control_port->connection_lock);

			if ((control_port->shared->flags & JackPortIsInput)
			    && (control_port->connections != NULL)
			    && (control_port->mix_buffer == NULL)  ) {
				size_t buffer_size =
					jack_port_type_buffer_size ( control_port->type_info,
								     client->engine->buffer_size );
				control_port->mix_buffer = jack_pool_alloc (buffer_size);
				control_port->fptr.buffer_init (control_port->mix_buffer,
								buffer_size,
								client->engine->buffer_size);
			}

			control_port->connections =
				jack_slist_prepend (control_port->connections,
						    (void*)other);
			pthread_mutex_unlock (&control_port->connection_lock);
			break;

		case PortDisconnected:
			/* jack_port_by_id_int() always returns an internal
			 * port that does not need to be deallocated
			 */
			control_port = jack_port_by_id_int (client, event->x.self_id,
							    &need_free);
			pthread_mutex_lock (&control_port->connection_lock);

			for (node = control_port->connections; node;
			     node = jack_slist_next (node)) {

				other = (jack_port_t*)node->data;

				if (other->shared->id == event->y.other_id) {
					control_port->connections =
						jack_slist_remove_link (
							control_port->connections,
							node);
					jack_slist_free_1 (node);
					free (other);
					break;
				}
			}

			pthread_mutex_unlock (&control_port->connection_lock);
			break;

		default:
			/* impossible */
			break;
		}
	}

	if (client->control->port_connect_cbset) {
		client->port_connect (event->x.self_id, event->y.other_id,
				      (event->type == PortConnected ? 1 : 0),
				      client->port_connect_arg);
	}

	return 0;
}

int
jack_client_handle_session_callback (jack_client_t *client, jack_event_t *event)
{
	char uuidstr[37];
	jack_session_event_t *s_event;

	if (!client->control->session_cbset) {
		return -1;
	}

	jack_uuid_unparse (client->control->uuid, uuidstr);

	s_event = malloc ( sizeof(jack_session_event_t) );
	s_event->type = event->y.n;
	s_event->session_dir = strdup (event->x.name);
	s_event->client_uuid = strdup (uuidstr);
	s_event->command_line = NULL;
	s_event->future = 0;

	client->session_cb_immediate_reply = 0;
	client->session_cb (s_event, client->session_cb_arg);

	if (client->session_cb_immediate_reply) {
		return 2;
	}
	return 1;
}

static void
jack_port_recalculate_latency (jack_port_t *port, jack_latency_callback_mode_t mode)
{
	jack_latency_range_t latency = { UINT32_MAX, 0 };
	JSList *node;

	pthread_mutex_lock (&port->connection_lock);
	for (node = port->connections; node; node = jack_slist_next (node)) {
		jack_port_t *other = node->data;
		jack_latency_range_t other_latency;

		jack_port_get_latency_range (other, mode, &other_latency);

		if (other_latency.max > latency.max) {
			latency.max = other_latency.max;
		}
		if (other_latency.min < latency.min) {
			latency.min = other_latency.min;
		}

	}
	pthread_mutex_unlock (&port->connection_lock);

	if (latency.min == UINT32_MAX) {
		latency.min = 0;
	}

	jack_port_set_latency_range (port, mode, &latency);
}

int
jack_client_handle_latency_callback (jack_client_t *client, jack_event_t *event, int is_driver)
{
	jack_latency_callback_mode_t mode = (event->x.n == 0) ? JackCaptureLatency : JackPlaybackLatency;
	JSList *node;
	jack_latency_range_t latency = { UINT32_MAX, 0 };

	/* first setup all latency values of the ports.
	 * this is based on the connections of the ports.
	 */
	for (node = client->ports; node; node = jack_slist_next (node)) {
		jack_port_t *port = node->data;

		if ((jack_port_flags (port) & JackPortIsOutput) && (mode == JackPlaybackLatency)) {
			jack_port_recalculate_latency (port, mode);
		}
		if ((jack_port_flags (port) & JackPortIsInput) && (mode == JackCaptureLatency)) {
			jack_port_recalculate_latency (port, mode);
		}
	}

	/* for a driver invocation without its own latency callback, this is enough.
	 * input and output ports do not depend on each other.
	 */
	if (is_driver && !client->control->latency_cbset) {
		return 0;
	}

	if (!client->control->latency_cbset) {
		/*
		 * default action is to assume all ports depend on each other.
		 * then always take the maximum latency.
		 */

		if (mode == JackPlaybackLatency) {
			/* iterate over all OutputPorts, to find maximum playback latency
			 */
			for (node = client->ports; node; node = jack_slist_next (node)) {
				jack_port_t *port = node->data;

				if (port->shared->flags & JackPortIsOutput) {
					jack_latency_range_t other_latency;

					jack_port_get_latency_range (port, mode, &other_latency);
					if (other_latency.max > latency.max) {
						latency.max = other_latency.max;
					}
					if (other_latency.min < latency.min) {
						latency.min = other_latency.min;
					}
				}
			}

			if (latency.min == UINT32_MAX) {
				latency.min = 0;
			}

			/* now set the found latency on all input ports
			 */
			for (node = client->ports; node; node = jack_slist_next (node)) {
				jack_port_t *port = node->data;

				if (port->shared->flags & JackPortIsInput) {
					jack_port_set_latency_range (port, mode, &latency);
				}
			}
		}
		if (mode == JackCaptureLatency) {
			/* iterate over all InputPorts, to find maximum playback latency
			 */
			for (node = client->ports; node; node = jack_slist_next (node)) {
				jack_port_t *port = node->data;

				if (port->shared->flags & JackPortIsInput) {
					jack_latency_range_t other_latency;

					jack_port_get_latency_range (port, mode, &other_latency);
					if (other_latency.max > latency.max) {
						latency.max = other_latency.max;
					}
					if (other_latency.min < latency.min) {
						latency.min = other_latency.min;
					}
				}
			}

			if (latency.min == UINT32_MAX) {
				latency.min = 0;
			}

			/* now set the found latency on all output ports
			 */
			for (node = client->ports; node; node = jack_slist_next (node)) {
				jack_port_t *port = node->data;

				if (port->shared->flags & JackPortIsOutput) {
					jack_port_set_latency_range (port, mode, &latency);
				}
			}
		}
		return 0;
	}

	/* we have a latency callback setup by the client,
	 * lets use it...
	 */
	client->latency_cb ( mode, client->latency_cb_arg);
	return 0;
}

#if JACK_USE_MACH_THREADS

static int
jack_handle_reorder (jack_client_t *client, jack_event_t *event)
{
	client->pollmax = 1;

	/* If the client registered its own callback for graph order events,
	   execute it now.
	 */

	if (client->control->graph_order_cbset) {
		client->graph_order (client->graph_order_arg);
	}

	return 0;
}

#else

static int
jack_handle_reorder (jack_client_t *client, jack_event_t *event)
{
	char path[PATH_MAX + 1];

	DEBUG ("graph reorder\n");

	if (client->graph_wait_fd >= 0) {
		DEBUG ("closing graph_wait_fd==%d", client->graph_wait_fd);
		close (client->graph_wait_fd);
		client->graph_wait_fd = -1;
	}

	if (client->graph_next_fd >= 0) {
		DEBUG ("closing graph_next_fd==%d", client->graph_next_fd);
		close (client->graph_next_fd);
		client->graph_next_fd = -1;
	}

	sprintf (path, "%s-%" PRIu32, client->fifo_prefix, event->x.n);

	if ((client->graph_wait_fd = open (path, O_RDONLY | O_NONBLOCK)) < 0) {
		jack_error ("cannot open specified fifo [%s] for reading (%s)",
			    path, strerror (errno));
		return -1;
	}
	DEBUG ("opened new graph_wait_fd %d (%s)", client->graph_wait_fd, path);

	sprintf (path, "%s-%" PRIu32, client->fifo_prefix, event->x.n + 1);

	if ((client->graph_next_fd = open (path, O_WRONLY | O_NONBLOCK)) < 0) {
		jack_error ("cannot open specified fifo [%s] for writing (%s)",
			    path, strerror (errno));
		return -1;
	}

	client->upstream_is_jackd = event->y.n;
	client->pollmax = 2;

	DEBUG ("opened new graph_next_fd %d (%s) (upstream is jackd? %d)",
	       client->graph_next_fd, path,
	       client->upstream_is_jackd);

	/* If the client registered its own callback for graph order events,
	   execute it now.
	 */

	if (client->control->graph_order_cbset) {
		client->graph_order (client->graph_order_arg);
	}

	return 0;
}

#endif

static int
server_connect (const char *server_name)
{
	int fd;
	struct sockaddr_un addr;
	int which = 0;

	char server_dir[PATH_MAX + 1] = "";

	if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0) {
		jack_error ("cannot create client socket (%s)",
			    strerror (errno));
		return -1;
	}

	//JOQ: temporary debug message
	//jack_info ("DEBUG: connecting to `%s' server", server_name);

	addr.sun_family = AF_UNIX;
	snprintf (addr.sun_path, sizeof(addr.sun_path) - 1, "%s/jack_%d",
		  jack_server_dir (server_name, server_dir), which);

	if (connect (fd, (struct sockaddr*)&addr, sizeof(addr)) < 0) {
		close (fd);
		jack_error ("connect(2) call to %s failed (err=%s)", addr.sun_path, strerror (errno));
		return -1;
	}
	return fd;
}

static int
server_event_connect (jack_client_t *client, const char *server_name)
{
	int fd;
	struct sockaddr_un addr;
	jack_client_connect_ack_request_t req;
	jack_client_connect_ack_result_t res;

	char server_dir[PATH_MAX + 1] = "";

	if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0) {
		jack_error ("cannot create client event socket (%s)",
			    strerror (errno));
		return -1;
	}

	addr.sun_family = AF_UNIX;
	snprintf (addr.sun_path, sizeof(addr.sun_path) - 1, "%s/jack_ack_0",
		  jack_server_dir (server_name, server_dir));

	if (connect (fd, (struct sockaddr*)&addr, sizeof(addr)) < 0) {
		jack_error ("cannot connect to jack server for events",
			    strerror (errno));
		close (fd);
		return -1;
	}

	jack_uuid_copy (&req.client_id, client->control->uuid);

	if (write_retry (fd, &req, sizeof(req)) != sizeof(req)) {
		jack_error ("cannot write event connect request to server (%s)",
			    strerror (errno));
		close (fd);
		return -1;
	}

	if (read_retry (fd, &res, sizeof(res)) != sizeof(res)) {
		jack_error ("cannot read event connect result from server (%s)",
			    strerror (errno));
		close (fd);
		return -1;
	}

	if (res.status != 0) {
		jack_error ("cannot connect to server for event stream (%s)",
			    strerror (errno));
		close (fd);
		return -1;
	}

	return fd;
}

/* Exec the JACK server in this process.  Does not return. */
static void
_start_server (const char *server_name)
{
	FILE* fp = 0;
	char filename[255];
	char arguments[255];
	char buffer[255];
	char* command = 0;
	size_t pos = 0;
	size_t result = 0;
	char** argv = 0;
	int i = 0;
	int good = 0;
	int ret;
	char *startup_file;

	if ((startup_file = getenv ("JACK_RC_FILE")) == NULL) {
		snprintf (filename, 255, "%s/.jackdrc", getenv ("HOME"));
		startup_file = filename;
	}

	fp = fopen (startup_file, "r");

	if (!fp) {
		fp = fopen ("/etc/jackdrc", "r");
	}
	/* if still not found, check old config name for backwards compatability */
	if (!fp) {
		fp = fopen ("/etc/jackd.conf", "r");
	}

	if (fp) {
		arguments[0] = '\0';
		ret = fscanf (fp, "%s", buffer);
		while (ret != 0 && ret != EOF) {
			strcat (arguments, buffer);
			strcat (arguments, " ");
			ret = fscanf (fp, "%s", buffer);
		}
		if (strlen (arguments) > 0) {
			good = 1;
		}
	}

	if (!good) {
#if defined(USE_CAPABILITIES)
		command = JACK_LOCATION "/jackstart";
		strncpy (arguments, JACK_LOCATION "/jackstart -T -R -d "
			 JACK_DEFAULT_DRIVER " -p 512", 255);
#else           /* !USE_CAPABILITIES */
		command = JACK_LOCATION "/jackd";
		strncpy (arguments, JACK_LOCATION "/jackd -T -d "
			 JACK_DEFAULT_DRIVER, 255);
#endif          /* USE_CAPABILITIES */
	} else {
		result = strcspn (arguments, " ");
		if ((command = (char*)malloc (result + 1)) == NULL) {
			goto failure;
		}
		strncpy (command, arguments, result);
		command[result] = '\0';
	}

	if ((argv = (char**)malloc (255)) == NULL) {
		goto failure;
	}

	while (1) {
		/* insert -T and -nserver_name in front of arguments */
		if (i == 1) {
			argv[i] = (char*)malloc (strlen ("-T") + 1);
			strcpy (argv[i++], "-T");
			if (server_name) {
				size_t optlen = strlen ("-n");
				char *buf =
					malloc (optlen
						+ strlen (server_name) + 1);
				strcpy (buf, "-n");
				strcpy (buf + optlen, server_name);
				argv[i++] = buf;
			}
		}

		/* skip whitespace */
		while (pos < strlen (arguments) && arguments[pos] && arguments[pos] == ' ')
			++pos;

		if (pos >= strlen (arguments)) {
			break;
		}

		if (arguments[pos] == '\"') {
			++pos;
			result = strcspn (arguments + pos, "\"");
		} else {
			result = strcspn (arguments + pos, " ");
		}

		if (0 == result) {
			break;
		}

		argv[i] = (char*)malloc (result + 1);
		strncpy (argv[i], arguments + pos, result);
		argv[i][result] = '\0';
		pos += result + 1;
		if (++i > 253) {
			break;
		}
	}
	argv[i] = 0;

#if 0
	fprintf (stderr, "execing  JACK using %s\n", command);
	for (_xx = 0; argv[_xx]; ++_xx)
		fprintf (stderr, "\targv[%d] = %s\n", _xx, argv[_xx]);

#endif

	execv (command, argv);

failure:
	/* If execv() succeeds, it does not return.  There's no point
	 * in calling jack_error() here in the child process. */
	fprintf (stderr, "exec of JACK server (command = \"%s\") failed: %s\n", command, strerror (errno));
}

int
start_server (const char *server_name, jack_options_t options)
{
	int status;
	pid_t first_child_pid;

	if ((options & JackNoStartServer)
	    || getenv ("JACK_NO_START_SERVER")) {
		return 1;
	}

	/* The double fork() forces the server to become a child of
	 * init, which will always clean up zombie process state on
	 * termination.  This even works in cases where the server
	 * terminates but this client does not.
	 *
	 * Since fork() is usually implemented using copy-on-write
	 * virtual memory tricks, the overhead of the second fork() is
	 * probably relatively small.
	 */

	first_child_pid = fork ();

	switch (first_child_pid) {
	case 0:                         /* child process */
		switch (fork ()) {
		case 0:                 /* grandchild process */
			_start_server (server_name);
			_exit (99);     /* exec failed */
		case -1:
			_exit (98);
		default:
			_exit (0);
		}
	case -1:                        /* fork() error */
		return 1;               /* failed to start server */
	}

	/* reap the initaial child */
	waitpid (first_child_pid, &status, 0);

	/* only the original parent process goes here */
	return 0;                       /* (probably) successful */
}

static int
jack_request_client (ClientType type,
		     const char* client_name, jack_options_t options,
		     jack_status_t *status, jack_varargs_t *va,
		     jack_client_connect_result_t *res, int *req_fd)
{
	jack_client_connect_request_t req;

	*req_fd = -1;
	memset (&req, 0, sizeof(req));
	req.options = options;

	if (strlen (client_name) >= sizeof(req.name)) {
		jack_error ("\"%s\" is too long to be used as a JACK client"
			    " name.\n"
			    "Please use %lu characters or less.",
			    client_name, sizeof(req.name));
		return -1;
	}

	if (va->load_name
	    && (strlen (va->load_name) > sizeof(req.object_path) - 1)) {
		jack_error ("\"%s\" is too long to be used as a JACK shared"
			    " object name.\n"
			    "Please use %lu characters or less.",
			    va->load_name, sizeof(req.object_path) - 1);
		return -1;
	}

	if (va->load_init
	    && (strlen (va->load_init) > sizeof(req.object_data) - 1)) {
		jack_error ("\"%s\" is too long to be used as a JACK shared"
			    " object data string.\n"
			    "Please use %lu characters or less.",
			    va->load_init, sizeof(req.object_data) - 1);
		return -1;
	}

	if ((*req_fd = server_connect (va->server_name)) < 0) {
		int trys;
		if (start_server (va->server_name, options)) {
			*status |= (JackFailure | JackServerFailed);
			goto fail;
		}
		trys = 5;
		do {
			sleep (1);
			if (--trys < 0) {
				*status |= (JackFailure | JackServerFailed);
				goto fail;
			}
		} while ((*req_fd = server_connect (va->server_name)) < 0);
		*status |= JackServerStarted;
	}

	/* format connection request */

	if (va->sess_uuid && strlen (va->sess_uuid)) {
		if (jack_uuid_parse (va->sess_uuid, &req.uuid) != 0) {
			jack_error ("Given UUID [%s] is not parseable", va->sess_uuid);
			goto fail;
		}
	} else {
		jack_uuid_clear (&req.uuid);
	}
	req.protocol_v = jack_protocol_version;
	req.load = TRUE;
	req.type = type;
	snprintf (req.name, sizeof(req.name),
		  "%s", client_name);
	snprintf (req.object_path, sizeof(req.object_path),
		  "%s", va->load_name);
	snprintf (req.object_data, sizeof(req.object_data),
		  "%s", va->load_init);

	if (write_retry (*req_fd, &req, sizeof(req)) != sizeof(req)) {
		jack_error ("cannot send request to jack server (%s)",
			    strerror (errno));
		*status |= (JackFailure | JackServerError);
		goto fail;
	}

	if (read_retry (*req_fd, res, sizeof(*res)) != sizeof(*res)) {

		if (errno == 0) {
			/* server shut the socket */
			jack_error ("could not attach as client");
			*status |= (JackFailure | JackServerError);
			goto fail;
		}

		if (errno == ECONNRESET) {
			jack_error ("could not attach as JACK client "
				    "(server has exited)");
			*status |= (JackFailure | JackServerError);
			goto fail;
		}

		jack_error ("cannot read response from jack server (%s)",
			    strerror (errno));
		*status |= (JackFailure | JackServerError);
		goto fail;
	}

	*status |= res->status;         /* return server status bits */

	if (*status & JackFailure) {
		if (*status & JackVersionError) {
			jack_error ("client linked with incompatible libjack"
				    " version.");
		}
		jack_error ("could not attach to JACK server");
		*status |= JackServerError;
		goto fail;
	}

	switch (type) {
	case ClientDriver:
	case ClientInternal:
		close (*req_fd);
		*req_fd = -1;
		break;

	default:
		break;
	}

	return 0;

fail:
	jack_error ("attempt to connect to server failed");
	if (*req_fd >= 0) {
		close (*req_fd);
		*req_fd = -1;
	}
	return -1;
}

int
jack_attach_port_segment (jack_client_t *client, jack_port_type_id_t ptid)
{
	/* Lookup, attach and register the port/buffer segments in use
	 * right now.
	 */

	if (client->control->type != ClientExternal) {
		jack_error ("Only external clients need attach port segments");
		abort ();
	}

	/* make sure we have space to store the port
	   segment information.
	 */

	if (ptid >= client->n_port_types) {

		client->port_segment = (jack_shm_info_t*)
				       realloc (client->port_segment,
						sizeof(jack_shm_info_t) * (ptid + 1));

		memset (&client->port_segment[client->n_port_types],
			0,
			sizeof(jack_shm_info_t) *
			(ptid - client->n_port_types));

		client->n_port_types = ptid + 1;

	} else {

		/* release any previous segment */
		jack_release_shm (&client->port_segment[ptid]);
	}

	/* get the index into the shm registry */

	client->port_segment[ptid].index =
		client->engine->port_types[ptid].shm_registry_index;

	/* attach the relevant segment */

	if (jack_attach_shm (&client->port_segment[ptid])) {
		jack_error ("cannot attach port segment shared memory"
			    " (%s)", strerror (errno));
		return -1;
	}

	return 0;
}

jack_client_t *
jack_client_open_aux (const char *client_name,
		      jack_options_t options,
		      jack_status_t *status, va_list ap)
{
	/* optional arguments: */
	jack_varargs_t va;              /* variable arguments */

	int req_fd = -1;
	int ev_fd = -1;
	jack_client_connect_result_t res;
	jack_client_t *client;
	jack_port_type_id_t ptid;
	jack_status_t my_status;

	jack_messagebuffer_init ();

	if (status == NULL) {           /* no status from caller? */
		status = &my_status;    /* use local status word */
	}
	*status = 0;

	/* validate parameters */
	if ((options & ~JackOpenOptions)) {
		*status |= (JackFailure | JackInvalidOption);
		jack_messagebuffer_exit ();
		return NULL;
	}

	/* parse variable arguments */
	jack_varargs_parse (options, ap, &va);

	/* External clients need to know where the tmpdir used for
	   communication with the server lives
	 */
	if (jack_get_tmpdir () == NULL) {
		*status |= JackFailure;
		jack_messagebuffer_exit ();
		return NULL;
	}

	/* External clients need this initialized.  It is already set
	 * up in the server's address space for internal clients.
	 */
	jack_init_time ();

	if (jack_request_client (ClientExternal, client_name, options, status,
				 &va, &res, &req_fd)) {
		jack_messagebuffer_exit ();
		return NULL;
	}

	/* Allocate the jack_client_t structure in local memory.
	 * Shared memory is not accessible yet. */
	client = jack_client_alloc ();
	strcpy (client->name, res.name);
	strcpy (client->fifo_prefix, res.fifo_prefix);
	client->request_fd = req_fd;
	client->pollfd[EVENT_POLL_INDEX].events =
		POLLIN | POLLERR | POLLHUP | POLLNVAL;
#ifndef JACK_USE_MACH_THREADS
	client->pollfd[WAIT_POLL_INDEX].events =
		POLLIN | POLLERR | POLLHUP | POLLNVAL;
#endif

	/* Don't access shared memory until server connected. */
	if (jack_initialize_shm (va.server_name)) {
		jack_error ("Unable to initialize shared memory.");
		*status |= (JackFailure | JackShmFailure);
		goto fail;
	}

	/* attach the engine control/info block */
	client->engine_shm.index = res.engine_shm_index;
	if (jack_attach_shm (&client->engine_shm)) {
		jack_error ("cannot attached engine control shared memory"
			    " segment");
		goto fail;
	}

	client->engine = (jack_control_t*)jack_shm_addr (&client->engine_shm);

	/* initialize clock source as early as possible */
	jack_set_clock_source (client->engine->clock_source);

	/* now attach the client control block */
	client->control_shm.index = res.client_shm_index;
	if (jack_attach_shm (&client->control_shm)) {
		jack_error ("cannot attached client control shared memory"
			    " segment");
		goto fail;
	}

	client->control = (jack_client_control_t*)
			  jack_shm_addr (&client->control_shm);

	/* Nobody else needs to access this shared memory any more, so
	 * destroy it.  Because we have it attached, it won't vanish
	 * till we exit (and release it).
	 */
	jack_destroy_shm (&client->control_shm);

	client->n_port_types = client->engine->n_port_types;
	if ((client->port_segment = (jack_shm_info_t*)malloc (sizeof(jack_shm_info_t) * client->n_port_types)) == NULL) {
		goto fail;
	}

	for (ptid = 0; ptid < client->n_port_types; ++ptid) {
		client->port_segment[ptid].index =
			client->engine->port_types[ptid].shm_registry_index;
		client->port_segment[ptid].attached_at = MAP_FAILED;

		/* the server will send attach events during jack_activate
		 */
	}

	/* set up the client so that it does the right thing for an
	 * external client
	 */
	client->deliver_request = oop_client_deliver_request;
	client->deliver_arg = client;

	if ((ev_fd = server_event_connect (client, va.server_name)) < 0) {
		goto fail;
	}

	client->event_fd = ev_fd;

#ifdef JACK_USE_MACH_THREADS
	/* specific resources for server/client real-time thread
	 * communication */
	client->clienttask = mach_task_self ();

	if (task_get_bootstrap_port (client->clienttask, &client->bp)) {
		jack_error ("Can't find bootstrap port");
		goto fail;
	}

	if (allocate_mach_clientport (client, res.portnum) < 0) {
		jack_error ("Can't allocate mach port");
		goto fail;
	}
	;
#endif  /* JACK_USE_MACH_THREADS */
	return client;

fail:
	jack_messagebuffer_exit ();

	if (client->engine) {
		jack_release_shm (&client->engine_shm);
		client->engine = 0;
	}
	if (client->control) {
		jack_release_shm (&client->control_shm);
		client->control = 0;
	}
	if (req_fd >= 0) {
		close (req_fd);
	}
	if (ev_fd >= 0) {
		close (ev_fd);
	}
	free (client);

	return NULL;
}

jack_client_t* jack_client_open (const char* ext_client_name, jack_options_t options, jack_status_t* status, ...)
{
	va_list ap;

	va_start (ap, status);
	jack_client_t* res = jack_client_open_aux (ext_client_name, options, status, ap);
	va_end (ap);
	return res;
}

jack_client_t *
jack_client_new (const char *client_name)
{
	jack_options_t options = JackUseExactName;

	if (getenv ("JACK_START_SERVER") == NULL) {
		options |= JackNoStartServer;
	}
	return jack_client_open (client_name, options, NULL);
}

char *
jack_get_client_name (jack_client_t *client)
{
	return client->name;
}

int
jack_internal_client_new (const char *client_name,
			  const char *so_name, const char *so_data)
{
	jack_client_connect_result_t res;
	int req_fd;
	jack_varargs_t va;
	jack_status_t status;
	jack_options_t options = JackUseExactName;

	if (getenv ("JACK_START_SERVER") == NULL) {
		options |= JackNoStartServer;
	}

	jack_varargs_init (&va);
	va.load_name = (char*)so_name;
	va.load_init = (char*)so_data;

	return jack_request_client (ClientInternal, client_name,
				    options, &status, &va, &res, &req_fd);
}

char *
jack_default_server_name (void)
{
	char *server_name;

	if ((server_name = getenv ("JACK_DEFAULT_SERVER")) == NULL) {
		server_name = "default";
	}
	return server_name;
}

/* returns the name of the per-user subdirectory of jack_tmpdir */
char *
jack_user_dir (void)
{
	static char user_dir[PATH_MAX + 1] = "";
	const char *tmpdir;

	/* format the path name on the first call */
	if (user_dir[0] == '\0') {
		tmpdir = jack_get_tmpdir ();

		/* previous behavior of jack_tmpdir, should be changed later */
		if (tmpdir == NULL) {
			jack_error ("Unable to get tmpdir in user dir");
			tmpdir = DEFAULT_TMP_DIR;
		}

		if (getenv ("JACK_PROMISCUOUS_SERVER")) {
			snprintf (user_dir, sizeof(user_dir), "%s/jack",
				  tmpdir);
		} else {
			snprintf (user_dir, sizeof(user_dir), "%s/jack-%d",
				  tmpdir, getuid ());
		}
	}

	return user_dir;
}

/* returns the name of the per-server subdirectory of jack_user_dir() */
char *
jack_server_dir (const char *server_name, char *server_dir)
{
	/* format the path name into the suppled server_dir char array,
	 * assuming that server_dir is at least as large as PATH_MAX+1 */

	if (server_name == NULL || server_name[0] == '\0') {
		snprintf (server_dir, PATH_MAX + 1, "%s/%s",
			  jack_user_dir (), jack_default_server_name ());
	} else {
		snprintf (server_dir, PATH_MAX + 1, "%s/%s",
			  jack_user_dir (), server_name);
	}

	return server_dir;
}

void
jack_internal_client_close (const char *client_name)
{
	jack_client_connect_request_t req;
	int fd;
	char *server_name = jack_default_server_name ();

	req.load = FALSE;
	snprintf (req.name, sizeof(req.name), "%s", client_name);

	if ((fd = server_connect (server_name)) < 0) {
		return;
	}

	if (write_retry (fd, &req, sizeof(req)) != sizeof(req)) {
		jack_error ("cannot deliver ClientUnload request to JACK "
			    "server.");
	}

	/* no response to this request */

	close (fd);
	return;
}

int
jack_recompute_total_latencies (jack_client_t* client)
{
	jack_request_t request;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = RecomputeTotalLatencies;
	return jack_client_deliver_request (client, &request);
}

int
jack_recompute_total_latency (jack_client_t* client, jack_port_t* port)
{
	jack_request_t request;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = RecomputeTotalLatency;
	request.x.port_info.port_id = port->shared->id;
	return jack_client_deliver_request (client, &request);
}

int
jack_set_freewheel (jack_client_t* client, int onoff)
{
	jack_request_t request;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = onoff ? FreeWheel : StopFreeWheel;
	jack_uuid_copy (&request.x.client_id, client->control->uuid);
	return jack_client_deliver_request (client, &request);
}

int
jack_session_reply (jack_client_t *client, jack_session_event_t *event )
{
	int retval = 0;

	if (event->command_line) {
		snprintf ((char*)client->control->session_command,
			  sizeof(client->control->session_command),
			  "%s", event->command_line);
		client->control->session_flags = event->flags;

	} else {
		retval = -1;
	}

	if (pthread_self () == client->thread_id) {
		client->session_cb_immediate_reply = 1;
	} else {
		jack_request_t request;
		VALGRIND_MEMSET (&request, 0, sizeof(request));

		request.type = SessionReply;
		jack_uuid_copy (&request.x.client_id, client->control->uuid);

		retval = jack_client_deliver_request (client, &request);
	}

	return retval;
}

void
jack_session_event_free (jack_session_event_t *event)
{
	if (event->command_line) {
		free (event->command_line);
	}

	free ((char*)event->session_dir);
	free ((char*)event->client_uuid);
	free (event);
}

void
jack_session_commands_free (jack_session_command_t *cmds)
{
	int i = 0;

	while (1) {
		if (cmds[i].client_name) {
			free ((char*)cmds[i].client_name);
		}
		if (cmds[i].command) {
			free ((char*)cmds[i].command);
		}
		if (cmds[i].uuid) {
			free ((char*)cmds[i].uuid);
		} else {
			break;
		}

		i += 1;
	}

	free (cmds);
}

jack_session_command_t *
jack_session_notify (jack_client_t* client, const char *target, jack_session_event_type_t code, const char *path )
{
	jack_request_t request;
	jack_session_command_t *retval = NULL;
	int num_replies = 0;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = SessionNotify;
	if ( path ) {
		snprintf ( request.x.session.path, sizeof( request.x.session.path ), "%s", path );
	} else {
		request.x.session.path[0] = '\0';
	}

	if ( target ) {
		snprintf ( request.x.session.target, sizeof( request.x.session.target ), "%s", target );
	} else {
		request.x.session.target[0] = '\0';
	}

	request.x.session.type = code;

	if ( (write_retry (client->request_fd, &request, sizeof(request))
	      != sizeof(request)) ) {
		jack_error ("cannot send request type %d to server",
			    request.type);
		goto out;
	}

	while ( 1 ) {
		jack_uuid_t uid;

		if (read_retry (client->request_fd, &uid, sizeof(uid)) != sizeof(uid)) {
			jack_error ("cannot read result for request type %d from"
				    " server (%s)", request.type, strerror (errno));
			goto out;
		}

		num_replies += 1;
		retval = realloc ( retval, (num_replies) * sizeof(jack_session_command_t) );
		retval[num_replies - 1].client_name = malloc (JACK_CLIENT_NAME_SIZE);
		retval[num_replies - 1].command = malloc (JACK_PORT_NAME_SIZE);
		retval[num_replies - 1].uuid = malloc (JACK_UUID_STRING_SIZE);

		if ( (retval[num_replies - 1].client_name == NULL)
		     || (retval[num_replies - 1].command     == NULL)
		     || (retval[num_replies - 1].uuid        == NULL) ) {
			goto out;
		}

		if (jack_uuid_empty (uid)) {
			break;
		}

		if (read_retry (client->request_fd, (char*)retval[num_replies - 1].client_name, JACK_CLIENT_NAME_SIZE)
		    != JACK_CLIENT_NAME_SIZE) {
			jack_error ("cannot read result for request type %d from"
				    " server (%s)", request.type, strerror (errno));
			goto out;
		}
		if (read_retry (client->request_fd, (char*)retval[num_replies - 1].command, JACK_PORT_NAME_SIZE)
		    != JACK_PORT_NAME_SIZE) {
			jack_error ("cannot read result for request type %d from"
				    " server (%s)", request.type, strerror (errno));
			goto out;
		}
		if (read_retry (client->request_fd, &retval[num_replies - 1].flags, sizeof(retval[num_replies - 1].flags) )
		    != sizeof(retval[num_replies - 1].flags) ) {
			jack_error ("cannot read result for request type %d from"
				    " server (%s)", request.type, strerror (errno));
			goto out;
		}
		jack_uuid_unparse (uid, (char*)retval[num_replies - 1].uuid);
	}
	free ((char*)retval[num_replies - 1].uuid);
	retval[num_replies - 1].uuid = NULL;
	retval[num_replies - 1].client_name = NULL;
	retval[num_replies - 1].command = NULL;
	return retval;
out:
	if ( retval ) {
		jack_session_commands_free (retval);
	}
	return NULL;
}

int
jack_client_has_session_callback (jack_client_t *client, const char *client_name)
{
	jack_request_t request;
	int retval;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = SessionHasCallback;
	strncpy (request.x.name, client_name, JACK_CLIENT_NAME_SIZE);

	retval = jack_client_deliver_request (client, &request);

	return retval;
}

void
jack_start_freewheel (jack_client_t* client)
{
	jack_client_control_t *control = client->control;

	if (client->engine->real_time) {
#if JACK_USE_MACH_THREADS
		jack_drop_real_time_scheduling (client->process_thread);
#else
		jack_drop_real_time_scheduling (client->thread);
#endif
	}

	if (control->freewheel_cb_cbset) {
		client->freewheel_cb (1, client->freewheel_arg);
	}
}

void
jack_stop_freewheel (jack_client_t* client)
{
	jack_client_control_t *control = client->control;

	if (client->engine->real_time) {
#if JACK_USE_MACH_THREADS
		jack_acquire_real_time_scheduling (client->process_thread,
						   client->engine->client_priority);
#else
		jack_acquire_real_time_scheduling (client->thread,
						   client->engine->client_priority);
#endif
	}

	if (control->freewheel_cb_cbset) {
		client->freewheel_cb (0, client->freewheel_arg);
	}
}

static void
jack_client_thread_suicide (jack_client_t* client, const char* reason)
{
#ifdef JACK_USE_MACH_THREADS
	client->rt_thread_ok = FALSE;
#endif

	if (client->on_info_shutdown) {
		jack_error ("%s - calling shutdown handler", reason);
		client->on_info_shutdown (JackClientZombie, reason, client->on_info_shutdown_arg);
	} else if (client->on_shutdown) {
		jack_error ("%s - calling shutdown handler", reason);
		client->on_shutdown (client->on_shutdown_arg);
	} else {
		jack_error ("jack_client_thread: %s - exiting from JACK", reason);
		jack_client_close_aux (client);
		/* Need a fix : possibly make client crash if
		 * zombified without shutdown handler
		 */
	}

	pthread_exit (0);
	/*NOTREACHED*/
}

static int
jack_client_process_events (jack_client_t* client)
{
	jack_event_t event;
	char status = 0;
	jack_client_control_t *control = client->control;
	JSList *node;
	jack_port_t* port;
	char* key = 0;

	DEBUG ("process events");

	if (client->pollfd[EVENT_POLL_INDEX].revents & POLLIN) {

		DEBUG ("client receives an event, "
		       "now reading on event fd");

		/* server has sent us an event. process the
		 * event and reply */

		if (read_retry (client->event_fd, &event, sizeof(event))
		    != sizeof(event)) {
			jack_error ("cannot read server event (%s)",
				    strerror (errno));
			return -1;
		}

		if (event.type == PropertyChange) {
			if (event.y.key_size) {
				key = (char*)malloc (event.y.key_size);
				if (read_retry (client->event_fd, key, event.y.key_size) !=
				    event.y.key_size) {
					jack_error ("cannot read property change key (%s)",
						    strerror (errno));
					return -1;
				}
			}
		}

		status = 0;

		switch (event.type) {
		case PortRegistered:
			for (node = client->ports_ext; node; node = jack_slist_next (node)) {
				port = node->data;
				if (port->shared->id == event.x.port_id) { // Found port, update port type
					port->type_info = &client->engine->port_types[port->shared->ptype_id];
				}
			}
			if (control->port_register_cbset) {
				client->port_register
					(event.x.port_id, TRUE,
					client->port_register_arg);
			}
			break;

		case PortUnregistered:
			if (control->port_register_cbset) {
				client->port_register
					(event.x.port_id, FALSE,
					client->port_register_arg);
			}
			break;

		case ClientRegistered:
			if (control->client_register_cbset) {
				client->client_register
					(event.x.name, TRUE,
					client->client_register_arg);
			}
			break;

		case ClientUnregistered:
			if (control->client_register_cbset) {
				client->client_register
					(event.x.name, FALSE,
					client->client_register_arg);
			}
			break;

		case GraphReordered:
			status = jack_handle_reorder (client, &event);
			break;

		case PortConnected:
		case PortDisconnected:
			status = jack_client_handle_port_connection
					 (client, &event);
			break;

		case BufferSizeChange:
			jack_client_fix_port_buffers (client);
			if (control->bufsize_cbset) {
				status = client->bufsize
						 (client->engine->buffer_size,
						 client->bufsize_arg);
			}
			break;

		case SampleRateChange:
			if (control->srate_cbset) {
				status = client->srate
						 (client->engine->current_time.frame_rate,
						 client->srate_arg);
			}
			break;

		case XRun:
			if (control->xrun_cbset) {
				status = client->xrun
						 (client->xrun_arg);
			}
			break;

		case AttachPortSegment:
			jack_attach_port_segment (client, event.y.ptid);
			break;

		case StartFreewheel:
			jack_start_freewheel (client);
			break;

		case StopFreewheel:
			jack_stop_freewheel (client);
			break;
		case SaveSession:
			status = jack_client_handle_session_callback (client, &event );
			break;
		case LatencyCallback:
			status = jack_client_handle_latency_callback (client, &event, 0 );
			break;
		case PropertyChange:
			if (control->property_cbset) {
				client->property_cb (event.x.uuid, key, event.z.property_change, client->property_cb_arg);
			}
			if (key) {
				free (key);
			}
			break;
		case PortRename:
			if (control->port_rename_cbset) {
				client->port_rename_cb (event.y.other_id, event.x.name, event.z.other_name, client->port_rename_arg);
			}
			break;
		}

		DEBUG ("client has dealt with the event, writing "
		       "response on event fd");

		if (write_retry (client->event_fd, &status, sizeof(status))
		    != sizeof(status)) {
			jack_error ("cannot send event response to "
				    "engine (%s)", strerror (errno));
			return -1;
		}
	}

	return 0;
}


static int
jack_wake_next_client (jack_client_t* client)
{
#ifndef JACK_USE_MACH_THREADS
	struct pollfd pfds[1];
	int pret = 0;
	char c = 0;

	if (write_retry (client->graph_next_fd, &c, sizeof(c))
	    != sizeof(c)) {
		DEBUG ("cannot write byte to fd %d", client->graph_next_fd);
		jack_error ("cannot continue execution of the "
			    "processing graph (%s)",
			    strerror (errno));
		return -1;
	}

	DEBUG ("client sent message to next stage by %" PRIu64 "",
	       jack_get_microseconds ());

	DEBUG ("reading cleanup byte from pipe %d\n", client->graph_wait_fd);

	/* "upstream client went away?  readability is checked in
	 * jack_client_core_wait(), but that's almost a whole cycle
	 * before we get here.
	 */

	if (client->graph_wait_fd >= 0) {
		pfds[0].fd = client->graph_wait_fd;
		pfds[0].events = POLLIN;

		/* 0 timeout, don't actually wait */
		pret = poll (pfds, 1, 0);
	}

	if (pret > 0 && (pfds[0].revents & POLLIN)) {
		if (read_retry (client->graph_wait_fd, &c, sizeof(c))
		    != sizeof(c)) {
			jack_error ("cannot complete execution of the "
				    "processing graph (%s)", strerror (errno));
			return -1;
		}
	} else {
		DEBUG ("cleanup byte from pipe %d not available?\n",
		       client->graph_wait_fd);
	}
#endif
	return 0;
}

#ifdef JACK_USE_MACH_THREADS

static void*
jack_osx_event_thread_work (void* arg)
{
	/* this is OS X: this is NOT the process() thread, but instead
	   just waits for events/callbacks from the server and processes them.

	   All we do here is to poll() for callbacks from the server,
	   and then process any callbacks that arrive.
	 */


	jack_client_t* client = (jack_client_t*)arg;
	jack_client_control_t *control = client->control;

	if (control->thread_init_cbset) {
		DEBUG ("calling OSX event thread init callback");
		client->thread_init (client->thread_init_arg);
	}

	while (1) {

		/* this is OS X - we're only waiting on events */

		DEBUG ("client polling on %s", client->pollmax == 2 ?
		       "event_fd and graph_wait_fd..." :
		       "event_fd only");

		while (1) {
			if (poll (client->pollfd, client->pollmax, 1000) < 0) {
				if (errno == EINTR) {
					continue;
				}
				jack_error ("poll failed in client (%s)",
					    strerror (errno));
				break;
			}

			pthread_testcancel ();

			if (jack_client_process_events (client)) {
				DEBUG ("event processing failed\n");
				break;
			}
		}

		if (control->dead || client->pollfd[EVENT_POLL_INDEX].revents & ~POLLIN) {
			DEBUG ("client appears dead or event pollfd has error status\n");
			break;
		}

		/* go back and wait for the next one */
	}

	jack_client_thread_suicide (client, "logic error");
	/*NOTREACHED*/
	return 0;
}

#else /* !JACK_USE_MACH_THREADS */

static int
jack_client_core_wait (jack_client_t* client)
{
	jack_client_control_t *control = client->control;

	/* this is not OS X - we're waiting on events & process wakeups */

	DEBUG ("client polling on %s", client->pollmax == 2 ?
	       "event_fd and graph_wait_fd..." :
	       "event_fd only");

	while (1) {
		if (poll (client->pollfd, client->pollmax, 1000) < 0) {
			if (errno == EINTR) {
				continue;
			}
			jack_error ("poll failed in client (%s)",
				    strerror (errno));
			return -1;
		}

		pthread_testcancel ();

		/* get an accurate timestamp on waking from poll for a
		 * process() cycle.
		 */

		if (client->graph_wait_fd >= 0
		    && client->pollfd[WAIT_POLL_INDEX].revents & POLLIN) {
			control->awake_at = jack_get_microseconds ();
		}

		DEBUG ("pfd[EVENT].revents = 0x%x pfd[WAIT].revents = 0x%x",
		       client->pollfd[EVENT_POLL_INDEX].revents,
		       client->pollfd[WAIT_POLL_INDEX].revents);

		if (client->graph_wait_fd >= 0 &&
		    (client->pollfd[WAIT_POLL_INDEX].revents & ~POLLIN)) {

			/* our upstream "wait" connection
			   closed, which either means that
			   an intermediate client exited, or
			   jackd exited, or jackd zombified
			   us.

			   we can discover the zombification
			   via client->control->dead, but
			   the other two possibilities are
			   impossible to identify just from
			   this situation. so we have to
			   check what we are connected to,
			   and act accordingly.
			 */

			if (client->upstream_is_jackd) {
				DEBUG ("WE (%s) DIE\n", client->name);
				return 0;
			} else {
				DEBUG ("WE PUNT\n");
				/* don't poll on the wait fd
				 * again until we get a
				 * GraphReordered event.
				 */

				client->graph_wait_fd = -1;
				client->pollmax = 1;
			}
		}

		if (jack_client_process_events (client)) {
			DEBUG ("event processing failed\n");
			return 0;
		}

		if (client->graph_wait_fd >= 0 &&
		    (client->pollfd[WAIT_POLL_INDEX].revents & POLLIN)) {
			DEBUG ("time to run process()\n");
			break;
		}
	}

	if (control->dead || client->pollfd[EVENT_POLL_INDEX].revents & ~POLLIN) {
		DEBUG ("client appears dead or event pollfd has error status\n");
		return -1;
	}

	return 0;
}

#endif

static void*
jack_process_thread_work (void* arg)
{
	/* this is the RT process thread used to handle process()
	   callbacks, and on non-OSX systems, server events/callbacks
	   as well.
	 */

	jack_client_t* client = (jack_client_t*)arg;
	jack_client_control_t *control = client->control;

	/* notify the waiting client that this thread
	   is up and running.
	 */

	pthread_mutex_lock (&client_lock);
	client->thread_ok = TRUE;
	client->thread_id = pthread_self ();
	pthread_cond_signal (&client_ready);
	pthread_mutex_unlock (&client_lock);

	control->pid = getpid ();
	control->pgrp = getpgrp ();

#ifdef JACK_USE_MACH_THREADS
	client->rt_thread_ok = TRUE;
#endif

	if (control->thread_cb_cbset) {

		/* client provided a thread function to run,
		   so just do that.
		 */

		client->thread_cb (client->thread_cb_arg);

	} else {

		if (control->thread_init_cbset) {
			DEBUG ("calling process thread init callback");
			client->thread_init (client->thread_init_arg);
		}

		while (1) {
			int status;

			if (jack_cycle_wait (client) != client->engine->buffer_size) {
				break;
			}

			if (control->process_cbset) {

				/* run process callback, then wait... ad-infinitum */

				DEBUG ("client calls process()");
				status = client->process (client->engine->buffer_size, client->process_arg);
				control->state = Finished;
			} else {
				status = 0;
			}

			/* if status was non-zero, this will not return (it will call
			   jack_client_thread_suicide()
			 */

			jack_cycle_signal (client, status);
		}
	}

	jack_client_thread_suicide (client, "logic error");
	/*NOTREACHED*/
	return 0;
}

jack_nframes_t
jack_thread_wait (jack_client_t* client, int status)
{
	static int msg_delivered = 0;

	if (!msg_delivered) {
		jack_error ("jack_thread_wait(): deprecated, use jack_cycle_wait/jack_cycle_signal");
		msg_delivered = 1;
	}
	return 0;
}

jack_nframes_t jack_cycle_wait (jack_client_t* client)
{
	jack_client_control_t *control = client->control;

	/* SECTION TWO: WAIT FOR NEXT DATA PROCESSING TIME */

#ifdef JACK_USE_MACH_THREADS
	/* on OS X systems, this thread is running a callback provided
	   by the client that has called this function in order to wait
	   for the next process callback. This is how we do that ...
	 */
	jack_client_suspend (client);
#else
	/* on non-OSX systems, this thread is running a callback provided
	   by the client that has called this function in order to wait
	   for the next process() callback or the next event from the
	   server.
	 */
	if (jack_client_core_wait (client)) {
		return 0;
	}
#endif

	/* SECTION THREE: START NEXT DATA PROCESSING TIME */

	/* Time to do data processing */

	control->awake_at = jack_get_microseconds ();
	client->control->state = Running;

	/* begin preemption checking */
	CHECK_PREEMPTION (client->engine, TRUE);

	if (client->control->sync_cb_cbset) {
		jack_call_sync_client (client);
	}

	return client->engine->buffer_size;
}

void jack_cycle_signal (jack_client_t* client, int status)
{
	client->control->last_status = status;

	/* SECTION ONE: HOUSEKEEPING/CLEANUP FROM LAST DATA PROCESSING */

	/* housekeeping/cleanup after data processing */

	if (status == 0 && client->control->timebase_cb_cbset) {
		jack_call_timebase_master (client);
	}

	/* end preemption checking */
	CHECK_PREEMPTION (client->engine, FALSE);

	client->control->finished_at = jack_get_microseconds ();
	client->control->state = Finished;

	/* wake the next client in the chain (could be the server),
	   and check if we were killed during the process
	   cycle.
	 */

	if (jack_wake_next_client (client)) {
		DEBUG ("client cannot wake next, or is dead\n");
		jack_client_thread_suicide (client, "graph error");
		/*NOTREACHED*/
	}

	if (client->control->dead) {
		jack_client_thread_suicide (client, "zombified");
		/*NOTREACHED*/
	}

	if (status) {
		jack_client_thread_suicide (client, "process error");
		/*NOTREACHED*/
	}

	if (!client->engine->engine_ok) {
		jack_client_thread_suicide (client, "JACK died");
		/*NOTREACHED*/
	}
}

static int
jack_start_thread (jack_client_t *client)
{
#ifdef USE_MLOCK
	if (client->engine->real_time) {
		if (client->engine->do_mlock
		    && (mlockall (MCL_CURRENT | MCL_FUTURE) != 0)) {
			jack_error ("cannot lock down memory for RT thread "
				    "(%s)", strerror (errno));
		}

		if (client->engine->do_munlock) {
			cleanup_mlock ();
		}
	}
#endif  /* USE_MLOCK */

#ifdef JACK_USE_MACH_THREADS
/* Stephane Letz : letz@grame.fr
   On MacOSX, the event/callback-handling thread does not need to be real-time.
 */
	if (jack_client_create_thread (client,
				       &client->thread,
				       client->engine->client_priority,
				       FALSE,
				       jack_osx_event_thread_work, client)) {
		return -1;
	}
#else
	if (jack_client_create_thread (client,
				       &client->thread,
				       client->engine->client_priority,
				       client->engine->real_time,
				       jack_process_thread_work, client)) {
		return -1;
	}

#endif

#ifdef JACK_USE_MACH_THREADS

	/* a secondary thread that runs the process callback and uses
	   ultra-fast Mach primitives for inter-thread signalling.

	   XXX in a properly structured JACK, there would be no
	   need for this, because we would have client wake up
	   methods that encapsulated the underlying mechanism
	   used.

	 */

	if (jack_client_create_thread (client,
				       &client->process_thread,
				       client->engine->client_priority,
				       client->engine->real_time,
				       jack_process_thread_work, client)) {
		return -1;
	}
#endif  /* JACK_USE_MACH_THREADS */

	return 0;
}

int
jack_activate (jack_client_t *client)
{
	jack_request_t req;

	VALGRIND_MEMSET (&req, 0, sizeof(req));

	if (client->control->type == ClientInternal ||
	    client->control->type == ClientDriver) {
		goto startit;
	}

	/* get the pid of the client process to pass it to engine */

	client->control->pid = getpid ();

#ifdef USE_CAPABILITIES

	if (client->engine->has_capabilities != 0 &&
	    client->control->pid != 0 && client->engine->real_time != 0) {

		/* we need to ask the engine for realtime capabilities
		   before trying to start the realtime thread
		 */

		req.type = SetClientCapabilities;
		req.x.client_id = client->control->id;
		req.x.cap_pid = client->control->pid;

		jack_client_deliver_request (client, &req);

		if (req.status) {

			/* what to do? engine is running realtime, it
			   is using capabilities and has them
			   (otherwise we would not get an error
			   return) but for some reason it could not
			   give the client the required capabilities.
			   For now, leave the client so that it
			   still runs, albeit non-realtime.
			 */

			jack_error ("could not receive realtime capabilities, "
				    "client will run non-realtime");
		}
	}
#endif  /* USE_CAPABILITIES */

	if (client->first_active) {

		pthread_mutex_init (&client_lock, NULL);
		pthread_cond_init (&client_ready, NULL);

		pthread_mutex_lock (&client_lock);

		if (jack_start_thread (client)) {
			pthread_mutex_unlock (&client_lock);
			return -1;
		}

		pthread_cond_wait (&client_ready, &client_lock);
		pthread_mutex_unlock (&client_lock);

		if (!client->thread_ok) {
			jack_error ("could not start client thread");
			return -1;
		}

		client->first_active = FALSE;
	}

startit:

	req.type = ActivateClient;
	jack_uuid_copy (&req.x.client_id, client->control->uuid);

	return jack_client_deliver_request (client, &req);
}

static int
jack_deactivate_aux (jack_client_t *client)
{
	jack_request_t req;
	int rc = ESRCH;                         /* already shut down */

	if (client && client->control) {        /* not shut down? */
		rc = 0;
		if (client->control->active) {  /* still active? */
			VALGRIND_MEMSET (&req, 0, sizeof(req));
			req.type = DeactivateClient;
			jack_uuid_copy (&req.x.client_id, client->control->uuid);
			rc = jack_client_deliver_request (client, &req);
		}
	}
	return rc;
}

int
jack_deactivate (jack_client_t *client)
{
	return jack_deactivate_aux (client);
}

static int
jack_client_close_aux (jack_client_t *client)
{
	JSList *node;
	void *status;
	int rc;

	rc = jack_deactivate_aux (client);
	if (rc == ESRCH) {              /* already shut down? */
		return rc;
	}

	if (client->control->type == ClientExternal) {

#if JACK_USE_MACH_THREADS
		if (client->rt_thread_ok) {
			// MacOSX pthread_cancel not implemented in
			// Darwin 5.5, 6.4
			mach_port_t machThread =
				pthread_mach_thread_np (client->process_thread);
			thread_terminate (machThread);
		}
#endif

		/* stop the thread that communicates with the jack
		 * server, only if it was actually running
		 */

		if (client->thread_ok) {
			pthread_cancel (client->thread);
			pthread_join (client->thread, &status);
		}

		if (client->control) {
			jack_release_shm (&client->control_shm);
			client->control = NULL;
		}
		if (client->engine) {
			jack_release_shm (&client->engine_shm);
			client->engine = NULL;
		}

		if (client->port_segment) {
			jack_port_type_id_t ptid;
			for (ptid = 0; ptid < client->n_port_types; ++ptid)
				jack_release_shm (&client->port_segment[ptid]);
			free (client->port_segment);
			client->port_segment = NULL;
		}

#ifndef JACK_USE_MACH_THREADS
		if (client->graph_wait_fd >= 0) {
			close (client->graph_wait_fd);
		}

		if (client->graph_next_fd >= 0) {
			close (client->graph_next_fd);
		}
#endif

		close (client->event_fd);

		if (shutdown (client->request_fd, SHUT_RDWR)) {
			jack_error ("could not shutdown client request socket");
		}

		close (client->request_fd);

	}

	for (node = client->ports; node; node = jack_slist_next (node))
		free (node->data);
	jack_slist_free (client->ports);
	for (node = client->ports_ext; node; node = jack_slist_next (node))
		free (node->data);
	jack_slist_free (client->ports_ext);
	jack_client_free (client);
	jack_messagebuffer_exit ();

	return rc;
}

int
jack_client_close (jack_client_t *client)
{
	return jack_client_close_aux (client);
}

int
jack_is_realtime (jack_client_t *client)
{
	return client->engine->real_time;
}

jack_nframes_t
jack_get_buffer_size (jack_client_t *client)
{
	return client->engine->buffer_size;
}

int
jack_set_buffer_size (jack_client_t *client, jack_nframes_t nframes)
{
#ifdef DO_BUFFER_RESIZE
	jack_request_t req;

	VALGRIND_MEMSET (&req, 0, sizeof(req));

	if (nframes < 1 || nframes > 16384) {
		return ERANGE;
	}

	req.type = SetBufferSize;
	req.x.nframes = nframes;

	return jack_client_deliver_request (client, &req);
#else
	return ENOSYS;

#endif  /* DO_BUFFER_RESIZE */
}

int
jack_connect (jack_client_t *client, const char *source_port,
	      const char *destination_port)
{
	jack_request_t req;

	VALGRIND_MEMSET (&req, 0, sizeof(req));

	req.type = ConnectPorts;

	snprintf (req.x.connect.source_port,
		  sizeof(req.x.connect.source_port), "%s", source_port);
	snprintf (req.x.connect.destination_port,
		  sizeof(req.x.connect.destination_port),
		  "%s", destination_port);

	return jack_client_deliver_request (client, &req);
}

int
jack_port_disconnect (jack_client_t *client, jack_port_t *port)
{
	jack_request_t req;

	if (port->shared->client_id == client->control->uuid) {

		pthread_mutex_lock (&port->connection_lock);

		if (port->connections == NULL) {
			printf ("JACK port not connected\n");
			pthread_mutex_unlock (&port->connection_lock);
			return 0;
		}

		pthread_mutex_unlock (&port->connection_lock);
	}

	VALGRIND_MEMSET (&req, 0, sizeof(req));

	req.type = DisconnectPort;
	req.x.port_info.port_id = port->shared->id;

	return jack_client_deliver_request (client, &req);
}

int
jack_disconnect (jack_client_t *client, const char *source_port,
		 const char *destination_port)
{
	jack_request_t req;

	VALGRIND_MEMSET (&req, 0, sizeof(req));

	req.type = DisconnectPorts;

	snprintf (req.x.connect.source_port,
		  sizeof(req.x.connect.source_port), "%s", source_port);
	snprintf (req.x.connect.destination_port,
		  sizeof(req.x.connect.destination_port),
		  "%s", destination_port);

	return jack_client_deliver_request (client, &req);
}

void
jack_set_error_function (void (*func)(const char *))
{
	jack_error_callback = func;
}

void
jack_set_info_function (void (*func)(const char *))
{
	jack_info_callback = func;
}

int
jack_set_graph_order_callback (jack_client_t *client,
			       JackGraphOrderCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->graph_order = callback;
	client->graph_order_arg = arg;
	client->control->graph_order_cbset = (callback != NULL);
	return 0;
}

int
jack_set_latency_callback (jack_client_t *client,
			   JackLatencyCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->latency_cb = callback;
	client->latency_cb_arg = arg;
	client->control->latency_cbset = (callback != NULL);
	return 0;
}

int jack_set_xrun_callback (jack_client_t *client,
			    JackXRunCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}

	client->xrun = callback;
	client->xrun_arg = arg;
	client->control->xrun_cbset = (callback != NULL);
	return 0;
}

int
jack_set_process_callback (jack_client_t *client,
			   JackProcessCallback callback, void *arg)

{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}

	if (client->control->thread_cb_cbset) {
		jack_error ("A thread callback has already been setup, both models cannot be used at the same time!");
		return -1;
	}

	client->process_arg = arg;
	client->process = callback;
	client->control->process_cbset = (callback != NULL);
	return 0;
}

int
jack_set_thread_init_callback (jack_client_t *client,
			       JackThreadInitCallback callback, void *arg)

{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->thread_init_arg = arg;
	client->thread_init = callback;
	client->control->thread_init_cbset = (callback != NULL);

	/* make sure that the message buffer thread is initialized too */

	jack_messagebuffer_thread_init (callback, arg);

	return 0;
}

int
jack_set_freewheel_callback (jack_client_t *client,
			     JackFreewheelCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->freewheel_arg = arg;
	client->freewheel_cb = callback;
	client->control->freewheel_cb_cbset = (callback != NULL);
	return 0;
}

int
jack_set_buffer_size_callback (jack_client_t *client,
			       JackBufferSizeCallback callback, void *arg)
{
	client->bufsize_arg = arg;
	client->bufsize = callback;
	client->control->bufsize_cbset = (callback != NULL);
	return 0;
}

int
jack_set_port_rename_callback (jack_client_t *client,
			       JackPortRenameCallback callback,
			       void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->port_rename_arg = arg;
	client->port_rename_cb = callback;
	client->control->port_rename_cbset = (callback != NULL);
	return 0;
}

int
jack_set_port_registration_callback (jack_client_t *client,
				     JackPortRegistrationCallback callback,
				     void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->port_register_arg = arg;
	client->port_register = callback;
	client->control->port_register_cbset = (callback != NULL);
	return 0;
}

int
jack_set_port_connect_callback (jack_client_t *client,
				JackPortConnectCallback callback,
				void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->port_connect_arg = arg;
	client->port_connect = callback;
	client->control->port_connect_cbset = (callback != NULL);
	return 0;
}

int
jack_set_client_registration_callback (jack_client_t *client,
				       JackClientRegistrationCallback callback,
				       void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}
	client->client_register_arg = arg;
	client->client_register = callback;
	client->control->client_register_cbset = (callback != NULL);
	return 0;
}

int
jack_set_process_thread (jack_client_t* client, JackThreadCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}

	if (client->control->process_cbset) {
		jack_error ("A process callback has already been setup, both models cannot be used at the same time!");
		return -1;
	}

	client->thread_cb_arg = arg;
	client->thread_cb = callback;
	client->control->thread_cb_cbset = (callback != NULL);
	return 0;
}

int
jack_set_session_callback (jack_client_t* client, JackSessionCallback callback, void *arg)
{
	if (client->control->active) {
		jack_error ("You cannot set callbacks on an active client.");
		return -1;
	}

	client->session_cb_arg = arg;
	client->session_cb = callback;
	client->control->session_cbset = (callback != NULL);
	return 0;
}

int
jack_get_process_done_fd (jack_client_t *client)
{
	return client->graph_next_fd;
}

void
jack_on_shutdown (jack_client_t *client, void (*function)(void *arg), void *arg)
{
	client->on_shutdown = function;
	client->on_shutdown_arg = arg;
}

void
jack_on_info_shutdown (jack_client_t *client, void (*function)(jack_status_t, const char*, void *arg), void *arg)
{
	client->on_info_shutdown = function;
	client->on_info_shutdown_arg = arg;
}

char *
jack_get_client_name_by_uuid (jack_client_t *client, const char *uuid_str)
{
	jack_request_t request;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	if (jack_uuid_parse (uuid_str, &request.x.client_id) != 0) {
		return NULL;
	}

	request.type = GetClientByUUID;
	if ( jack_client_deliver_request (client, &request)) {
		return NULL;
	}

	return strdup (request.x.port_info.name);
}

char*
jack_get_uuid_for_client_name (jack_client_t *client, const char *client_name)
{
	jack_request_t request;
	size_t len = strlen (client_name) + 1;

	if ( len > sizeof(request.x.name) ) {
		return NULL;
	}

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = GetUUIDByClientName;
	memcpy (request.x.name, client_name, len);

	if (jack_client_deliver_request ( client, &request)) {
		return NULL;
	}

	char buf[37];
	jack_uuid_unparse (request.x.client_id, buf);
	return strdup (buf);
}

char *
jack_client_get_uuid (jack_client_t *client)
{
	char retval[37];

	jack_uuid_unparse (client->control->uuid, retval);
	return strdup (retval);
}

int
jack_reserve_client_name (jack_client_t *client, const char *name, const char *uuid_str)
{
	jack_request_t request;

	VALGRIND_MEMSET (&request, 0, sizeof(request));

	request.type = ReserveName;
	snprintf ( request.x.reservename.name, sizeof( request.x.reservename.name ), "%s", name );
	if (jack_uuid_parse (uuid_str, &request.x.reservename.uuid) != 0) {
		return -1;
	}

	return jack_client_deliver_request (client, &request);
}

const char **
jack_get_ports (jack_client_t *client,
		const char *port_name_pattern,
		const char *type_name_pattern,
		unsigned long flags)
{
	jack_control_t *engine;
	const char **matching_ports;
	unsigned long match_cnt;
	jack_port_shared_t *psp;
	unsigned long i;
	regex_t port_regex;
	regex_t type_regex;
	int matching;

	engine = client->engine;

	if (port_name_pattern && port_name_pattern[0]) {
		regcomp (&port_regex, port_name_pattern,
			 REG_EXTENDED | REG_NOSUB);
	}
	if (type_name_pattern && type_name_pattern[0]) {
		regcomp (&type_regex, type_name_pattern,
			 REG_EXTENDED | REG_NOSUB);
	}

	psp = engine->ports;
	match_cnt = 0;

	if ((matching_ports = (const char**)malloc (sizeof(char *) * (engine->port_max + 1))) == NULL) {
		return NULL;
	}

	for (i = 0; i < engine->port_max; i++) {
		matching = 1;

		if (!psp[i].in_use) {
			continue;
		}

		if (flags) {
			if ((psp[i].flags & flags) != flags) {
				matching = 0;
			}
		}

		if (matching && port_name_pattern && port_name_pattern[0]) {
			if (regexec (&port_regex, psp[i].name, 0, NULL, 0)) {
				matching = 0;
			}
		}

		if (matching && type_name_pattern && type_name_pattern[0]) {
			jack_port_type_id_t ptid = psp[i].ptype_id;
			if (regexec (&type_regex,
				     engine->port_types[ptid].type_name,
				     0, NULL, 0)) {
				matching = 0;
			}
		}

		if (matching) {
			matching_ports[match_cnt++] = psp[i].name;
		}
	}
	if (port_name_pattern && port_name_pattern[0]) {
		regfree (&port_regex);
	}
	if (type_name_pattern && type_name_pattern[0]) {
		regfree (&type_regex);
	}

	if (match_cnt == 0) {
		free (matching_ports);
		matching_ports = 0;
	} else {
		matching_ports[match_cnt] = 0;
	}

	return matching_ports;
}

float
jack_cpu_load (jack_client_t *client)
{
	return client->engine->cpu_load;
}

float
jack_get_xrun_delayed_usecs (jack_client_t *client)
{
	return client->engine->xrun_delayed_usecs;
}

float
jack_get_max_delayed_usecs (jack_client_t *client)
{
	return client->engine->max_delayed_usecs;
}

void
jack_reset_max_delayed_usecs (jack_client_t *client)
{
	client->engine->max_delayed_usecs =  0.0f;
}

pthread_t
jack_client_thread_id (jack_client_t *client)
{
	if (client->control->type != ClientExternal) {
		/* Internal and driver clients run in ... ??? */
		return 0;
	}

	return client->thread_id;
}

int
jack_client_name_size (void)
{
	return JACK_CLIENT_NAME_SIZE;
}

int
jack_port_name_size (void)
{
	return JACK_PORT_NAME_SIZE;
}

int
jack_port_type_size (void)
{
	return JACK_PORT_TYPE_SIZE;
}

void
jack_free (void* ptr)
{
	free (ptr);
}

const char*
jack_event_type_name (JackEventType type)
{
	switch (type) {
	case BufferSizeChange:
		return "buffer size change";
	case SampleRateChange:
		return "sample rate change";
	case AttachPortSegment:
		return "port segment attached";
	case PortConnected:
		return "ports connected";
	case PortDisconnected:
		return "ports disconnected";
	case GraphReordered:
		return "graph reordered";
	case PortRegistered:
		return "port registered";
	case PortUnregistered:
		return "port unregistered";
	case XRun:
		return "xrun";
	case StartFreewheel:
		return "freewheel started";
	case StopFreewheel:
		return "freewheel stopped";
	case ClientRegistered:
		return "client registered";
	case ClientUnregistered:
		return "client unregistered";
	case SaveSession:
		return "save session";
	case LatencyCallback:
		return "latency callback";
	case PropertyChange:
		return "property change callback";
	case PortRename:
		return "port rename";
	default:
		break;
	}

	return "unknown";
}