Ticket #91: realtime_safety.patch

src/modules/module-jack-sink.c

@@ -3 +3 @@
-/***
-  This file is part of PulseAudio.
-
- Lennart Poettering
+, 2007 Lennart Poettering and Tanu Kaskinen
-
-  PulseAudio is free software; you can redistribute it and/or modify
-  it under the terms of the GNU Lesser General Public License as published
@@ -37 +37 @@
-#include <pthread.h>
-
-#include <jack/jack.h>
+#include <jack/ringbuffer.h>
-
-#include <pulse/xmalloc.h>
-
@@ -51 +52 @@
-
-#include "module-jack-sink-symdef.h"
-
-
+ & Tanu Kaskinen
-PA_MODULE_DESCRIPTION("Jack Sink")
-PA_MODULE_VERSION(PACKAGE_VERSION)
-PA_MODULE_USAGE(
@@ -60 +61 @@
-        "client_name=<jack client name> "
-        "channels=<number of channels> "
-        "connect=<connect ports?> "
+        "buffersize=<number of frames> "
-        "channel_map=<channel map>")
-
-#define DEFAULT_SINK_NAME "jack_out"
+#define DEFAULT_CLIENT_NAME "PulseAudio"
+#define DEFAULT_RINGBUFFER_SIZE 4096
-
-struct userdata {
-    pa_core *core;
-    pa_module *module;
-
+
-    pa_sink *sink;
-
+
-    unsigned channels;
-
-
+
+
+
-    jack_client_t *client;
-
-
-
-
+
-    void * buffer[PA_CHANNELS_MAX];
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    int quit_requested;
-
-    int pipe_fd_type;
-    int pipe_fds[2];
-    pa_io_event *io_event;
+};
-
-
-
+
+
+
+
+
+
+
+
+
+
-};
-
-static const char* const valid_modargs[] = {
@@ -96 +121 @@
-    "client_name",
-    "channels",
-    "connect",
+    "buffersize", /* amount of internal buffering in frames */
-    "channel_map",
-    NULL
-};
-
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
+
+
-
-
-
-
-
-
+
+
-
-    pa_read(fd, &x, 1, &u->pipe_fd_type);
-
-    if (u->quit_requested) {
-        stop_sink(u);
-        u->quit_requested = 0;
-        return;
-    }
-
-    pthread_mutex_lock(&u->mutex);
-
-    if (u->frames_requested > 0) {
-        unsigned fs;
-        jack_nframes_t frame_idx;
-        pa_memchunk chunk;
-
-        fs = pa_frame_size(&u->sink->sample_spec);
-
-        pa_sink_render_full(u->sink, u->frames_requested * fs, &chunk);
-
-        for (frame_idx = 0; frame_idx < u->frames_requested; frame_idx ++) {
-            unsigned c;
-
-            for (c = 0; c < u->channels; c++) {
-                float *s = ((float*) ((uint8_t*) chunk.memblock->data + chunk.index)) + (frame_idx * u->channels) + c;
-                float *d = ((float*) u->buffer[c]) + frame_idx;
-
-                *d = *s;
-            }
-        }
-
-        pa_memblock_unref(chunk.memblock);
-
-        u->frames_requested = 0;
-
-        pthread_cond_signal(&u->cond);
-    }
-
-    pthread_mutex_unlock(&u->mutex);
-}
-
-static void request_render(struct userdata *u) {
-    char c = 'x';
-    assert(u);
-
-    assert(u->pipe_fds[1] >= 0);
-    pa_write(u->pipe_fds[1], &c, 1, &u->pipe_fd_type);
-}
-
-static void jack_shutdown(void *arg) {
-    struct userdata *u = arg;
-    assert(u);
-
-    u->quit_requested = 1;
-    request_render(u);
-}
-
-static int jack_process(jack_nframes_t nframes, void *arg) {
-    struct userdata *u = arg;
-    assert(u);
-
-    if (jack_transport_query(u->client, NULL) == JackTransportRolling) {
-        unsigned c;
-
-        pthread_mutex_lock(&u->mutex);
-
-        u->frames_requested = nframes;
-
-        for (c = 0; c < u->channels; c++) {
-            u->buffer[c] = jack_port_get_buffer(u->port[c], nframes);
-            assert(u->buffer[c]);
-        }
-
-        request_render(u);
-
-        pthread_cond_wait(&u->cond, &u->mutex);
-
-        u->frames_in_buffer = nframes;
-        u->timestamp = jack_get_current_transport_frame(u->client);
-
-        pthread_mutex_unlock(&u->mutex);
-    }
-
-    return 0;
-}
-
-static pa_usec_t sink_get_latency_cb(pa_sink *s) {
-    struct userdata *u;
-    jack_nframes_t n, l, d;
-
-    assert(s);
-    u = s->userdata;
-
-    if (jack_transport_query(u->client, NULL) != JackTransportRolling)
-        return 0;
-
-    n = jack_get_current_transport_frame(u->client);
-
-    if (n < u->timestamp)
-        return 0;
-
-    d = n - u->timestamp;
-    l = jack_port_get_total_latency(u->client, u->port[0]) + u->frames_in_buffer;
-
-    if (d >= l)
-        return 0;
-
-    return pa_bytes_to_usec((l - d) * pa_frame_size(&s->sample_spec), &s->sample_spec);
-}
-
-static void jack_error_func(const char*t) {
-    pa_log_warn("JACK error >%s<", t);
-}
-
-int pa__init(pa_core *c, pa_module*m) {
-    struct userdata *u = NULL;
-
-
-
-
-
-
-
+
-    unsigned i;
-
-
-
+
-    assert(c);
-    assert(m);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    u = pa_xnew0(struct userdata, 1);
+    
-    m->userdata = u;
-    u->core = c;
-    u->module = m;
-    u->pipe_fds[0] = u->pipe_fds[1] = -1;
-    u->pipe_fd_type = 0;
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    if (pipe(u->pipe_fds) < 0) {
-        pa_log("pipe() failed: %s", pa_cstrerror(errno));
-        goto fail;
-    }
-
-    pa_make_nonblock_fd(u->pipe_fds[1]);
-
-
-
+
+
-        goto fail;
+    
+    u->frame_size = pa_frame_size(&u->sink->sample_spec);
+    u->blocksize = jack_get_buffer_size(u->client);
+    
+    /* If buffersize were equal to blocksize, a full block would never fit in the buffer,
+     * because the ringbuffer can never be totally full: one slot is always wasted. */
+    if (o.buffersize <= u->blocksize) {
+        o.buffersize = u->blocksize + 1;
-    }
+    /* The actual ringbuffer size will be rounded up to the nearest power of two. */
+    if (!(u->ringbuffer = jack_ringbuffer_create(o.buffersize * u->frame_size))) {
+        pa_log("jack_ringbuffer_create() failed.");
+        goto fail;
+    }
+    assert(u->ringbuffer->size % u->frame_size == 0);
+    pa_log_info("buffersize is %u frames.", u->ringbuffer->size / u->frame_size);
+    
+    jack_set_process_callback(u->client, jack_process, u);
+    jack_set_buffer_size_callback(u->client, jack_blocksize_cb, u);
+    jack_on_shutdown(u->client, jack_shutdown, u);
+    
+    if (jack_activate(u->client)) {
+        pa_log("jack_activate() failed.");
+        goto fail;
+    }
-
-
+
+
-
-
-
-
+
+
+
+
+
+
-
-
-    channels = c->default_sample_spec.channels
+
+pa__done(c, m)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        goto fail;
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        goto fail;
-    }
+    
+    if (pa_modargs_get_value_u32(ma, "buffersize", &o->buffersize) < 0 || o->buffersize == 0) {
+        pa_log("failed to parse buffersize= argument.");
+        goto fail;
+    }
+    
+    if (pa_modargs_get_value(ma, "channel_map", NULL)) {
+        o->map_given = 1;
+        
+        if (pa_modargs_get_channel_map(ma, &o->map) < 0) {
+            pa_log("failed to parse channel_map= argument.");
+            goto fail;
+        }
+    }
+    
+    return 0;
+    
+fail:
+    if (ma)
+      pa_modargs_free(ma);
+    
+    return -1;
+}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
-    ss.rate = jack_get_sample_rate(u->client);
-    ss.format = PA_SAMPLE_FLOAT32NE;
-
-    assert(pa_sample_spec_valid(&ss));
-
-
-
-
-
-
-
-
-
+
+
-        pa_log("failed to create sink.");
-goto fail
+return -1
-    }
-
+
-    u->sink->userdata = u;
-
+
+
-    pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Jack sink (%s)", jack_get_client_name(u->client)));
-    pa_xfree(t);
+    
-    u->sink->get_latency = sink_get_latency_cb;
+    
+    return 0;
+}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
-    }
+    else if (pthread_create(&u->filler_thread, &thread_attributes, fill_ringbuffer, u) != 0) {
+        pa_log("pthread_create() failed.");
+        retval = -1;
+    }
+    
+    u->filler_thread_is_running = 1;
+    
+    pthread_attr_destroy(&thread_attributes);
+    
+    return retval;
+}
-
-
-
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-
+
+
-    }
+    
+    pthread_mutex_unlock(&u->blocksize_mutex);
+    
+    return 0;
+}
-
-
+
+
+
-
-
-
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
-
-
+
+
-}
-
-void pa__done(pa_core *c, pa_module*m) {
@@ -385 +645 @@
-
-    if (!(u = m->userdata))
-        return;
-
+
+
+
+
+
+
+
-    if (u->client)
-        jack_client_close(u->client);
-
@@ -396 +662 @@
-        pa_sink_disconnect(u->sink);
-        pa_sink_unref(u->sink);
-    }
+    
+    if (u->ringbuffer)
+        jack_ringbuffer_free(u->ringbuffer);
-
-    if (u->pipe_fds[0] >= 0)
-        close(u->pipe_fds[0]);
-    if (u->pipe_fds[1] >= 0)
-        close(u->pipe_fds[1]);
-
-
-
+
+
+
+
-    pa_xfree(u);
-}