src/modules/module-jack-sink.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdlib.h>
  27 #include <sys/stat.h>
  28 #include <stdio.h>
  29 #include <assert.h>
  30 #include <errno.h>
  31 #include <string.h>
  32 #include <fcntl.h>
  33 #include <unistd.h>
  34 #include <limits.h>
  35 #include <pthread.h>
  36
  37 #include <jack/jack.h>
  38
  39 #include <pulse/xmalloc.h>
  40
  41 #include <pulsecore/core-error.h>
  42 #include <pulsecore/iochannel.h>
  43 #include <pulsecore/sink.h>
  44 #include <pulsecore/module.h>
  45 #include <pulsecore/core-util.h>
  46 #include <pulsecore/modargs.h>
  47 #include <pulsecore/log.h>
  48 #include <pulse/mainloop-api.h>
  49
  50 #include "module-jack-sink-symdef.h"
  51
  52 PA_MODULE_AUTHOR("Lennart Poettering")
  53 PA_MODULE_DESCRIPTION("Jack Sink")
  54 PA_MODULE_VERSION(PACKAGE_VERSION)
  55 PA_MODULE_USAGE(
  56         "sink_name=<name of sink> "
  57         "server_name=<jack server name> "
  58         "client_name=<jack client name> "
  59         "channels=<number of channels> "
  60         "connect=<connect ports?> "
  61         "channel_map=<channel map>")
  62
  63 #define DEFAULT_SINK_NAME "jack_out"
  64
  65 struct userdata {
  66     pa_core *core;
  67     pa_module *module;
  68
  69     pa_sink *sink;
  70
  71     unsigned channels;
  72
  73     jack_port_t* port[PA_CHANNELS_MAX];
  74     jack_client_t *client;
  75
  76     pthread_mutex_t mutex;
  77     pthread_cond_t cond;
  78
  79     void * buffer[PA_CHANNELS_MAX];
  80     jack_nframes_t frames_requested;
  81     int quit_requested;
  82
  83     int pipe_fd_type;
  84     int pipe_fds[2];
  85     pa_io_event *io_event;
  86
  87     jack_nframes_t frames_in_buffer;
  88     jack_nframes_t timestamp;
  89 };
  90
  91 static const char* const valid_modargs[] = {
  92     "sink_name",
  93     "server_name",
  94     "client_name",
  95     "channels",
  96     "connect",
  97     "channel_map",
  98     NULL
  99 };
 100
 101 static void stop_sink(struct userdata *u) {
 102     assert (u);
 103
 104     jack_client_close(u->client);
 105     u->client = NULL;
 106     u->core->mainloop->io_free(u->io_event);
 107     u->io_event = NULL;
 108     pa_sink_disconnect(u->sink);
 109     pa_sink_unref(u->sink);
 110     u->sink = NULL;
 111     pa_module_unload_request(u->module);
 112 }
 113
 114 static void io_event_cb(pa_mainloop_api *m, pa_io_event *e, int fd, pa_io_event_flags_t flags, void *userdata) {
 115     struct userdata *u = userdata;
 116     char x;
 117
 118     assert(m);
 119     assert(e);
 120     assert(flags == PA_IO_EVENT_INPUT);
 121     assert(u);
 122     assert(u->pipe_fds[0] == fd);
 123
 124     pa_read(fd, &x, 1, &u->pipe_fd_type);
 125
 126     if (u->quit_requested) {
 127         stop_sink(u);
 128         u->quit_requested = 0;
 129         return;
 130     }
 131
 132     pthread_mutex_lock(&u->mutex);
 133
 134     if (u->frames_requested > 0) {
 135         unsigned fs;
 136         jack_nframes_t frame_idx;
 137         pa_memchunk chunk;
 138
 139         fs = pa_frame_size(&u->sink->sample_spec);
 140
 141         pa_sink_render_full(u->sink, u->frames_requested * fs, &chunk);
 142
 143         for (frame_idx = 0; frame_idx < u->frames_requested; frame_idx ++) {
 144             unsigned c;
 145
 146             for (c = 0; c < u->channels; c++) {
 147                 float *s = ((float*) ((uint8_t*) chunk.memblock->data + chunk.index)) + (frame_idx * u->channels) + c;
 148                 float *d = ((float*) u->buffer[c]) + frame_idx;
 149
 150                 *d = *s;
 151             }
 152         }
 153
 154         pa_memblock_unref(chunk.memblock);
 155
 156         u->frames_requested = 0;
 157
 158         pthread_cond_signal(&u->cond);
 159     }
 160
 161     pthread_mutex_unlock(&u->mutex);
 162 }
 163
 164 static void request_render(struct userdata *u) {
 165     char c = 'x';
 166     assert(u);
 167
 168     assert(u->pipe_fds[1] >= 0);
 169     pa_write(u->pipe_fds[1], &c, 1, &u->pipe_fd_type);
 170 }
 171
 172 static void jack_shutdown(void *arg) {
 173     struct userdata *u = arg;
 174     assert(u);
 175
 176     u->quit_requested = 1;
 177     request_render(u);
 178 }
 179
 180 static int jack_process(jack_nframes_t nframes, void *arg) {
 181     struct userdata *u = arg;
 182     assert(u);
 183
 184     if (jack_transport_query(u->client, NULL) == JackTransportRolling) {
 185         unsigned c;
 186
 187         pthread_mutex_lock(&u->mutex);
 188
 189         u->frames_requested = nframes;
 190
 191         for (c = 0; c < u->channels; c++) {
 192             u->buffer[c] = jack_port_get_buffer(u->port[c], nframes);
 193             assert(u->buffer[c]);
 194         }
 195
 196         request_render(u);
 197
 198         pthread_cond_wait(&u->cond, &u->mutex);
 199
 200         u->frames_in_buffer = nframes;
 201         u->timestamp = jack_get_current_transport_frame(u->client);
 202
 203         pthread_mutex_unlock(&u->mutex);
 204     }
 205
 206     return 0;
 207 }
 208
 209 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 210     struct userdata *u;
 211     jack_nframes_t n, l, d;
 212
 213     assert(s);
 214     u = s->userdata;
 215
 216     if (jack_transport_query(u->client, NULL) != JackTransportRolling)
 217         return 0;
 218
 219     n = jack_get_current_transport_frame(u->client);
 220
 221     if (n < u->timestamp)
 222         return 0;
 223
 224     d = n - u->timestamp;
 225     l = jack_port_get_total_latency(u->client, u->port[0]) + u->frames_in_buffer;
 226
 227     if (d >= l)
 228         return 0;
 229
 230     return pa_bytes_to_usec((l - d) * pa_frame_size(&s->sample_spec), &s->sample_spec);
 231 }
 232
 233 static void jack_error_func(const char*t) {
 234     pa_log_warn("JACK error >%s<", t);
 235 }
 236
 237 int pa__init(pa_core *c, pa_module*m) {
 238     struct userdata *u = NULL;
 239     pa_sample_spec ss;
 240     pa_channel_map map;
 241     pa_modargs *ma = NULL;
 242     jack_status_t status;
 243     const char *server_name, *client_name;
 244     uint32_t channels = 0;
 245     int do_connect = 1;
 246     unsigned i;
 247     const char **ports = NULL, **p;
 248     char *t;
 249
 250     assert(c);
 251     assert(m);
 252
 253     jack_set_error_function(jack_error_func);
 254
 255     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 256         pa_log("failed to parse module arguments.");
 257         goto fail;
 258     }
 259
 260     if (pa_modargs_get_value_boolean(ma, "connect", &do_connect) < 0) {
 261         pa_log("failed to parse connect= argument.");
 262         goto fail;
 263     }
 264
 265     server_name = pa_modargs_get_value(ma, "server_name", NULL);
 266     client_name = pa_modargs_get_value(ma, "client_name", "PulseAudio");
 267
 268     u = pa_xnew0(struct userdata, 1);
 269     m->userdata = u;
 270     u->core = c;
 271     u->module = m;
 272     u->pipe_fds[0] = u->pipe_fds[1] = -1;
 273     u->pipe_fd_type = 0;
 274
 275     pthread_mutex_init(&u->mutex, NULL);
 276     pthread_cond_init(&u->cond, NULL);
 277
 278     if (pipe(u->pipe_fds) < 0) {
 279         pa_log("pipe() failed: %s", pa_cstrerror(errno));
 280         goto fail;
 281     }
 282
 283     pa_make_nonblock_fd(u->pipe_fds[1]);
 284
 285     if (!(u->client = jack_client_open(client_name, server_name ? JackServerName : JackNullOption, &status, server_name))) {
 286         pa_log("jack_client_open() failed.");
 287         goto fail;
 288     }
 289
 290     ports = jack_get_ports(u->client, NULL, NULL, JackPortIsPhysical|JackPortIsInput);
 291
 292     channels = 0;
 293     for (p = ports; *p; p++)
 294         channels++;
 295
 296     if (!channels)
 297         channels = c->default_sample_spec.channels;
 298
 299     if (pa_modargs_get_value_u32(ma, "channels", &channels) < 0 || channels <= 0 || channels >= PA_CHANNELS_MAX) {
 300         pa_log("failed to parse channels= argument.");
 301         goto fail;
 302     }
 303
 304     pa_channel_map_init_auto(&map, channels, PA_CHANNEL_MAP_ALSA);
 305     if (pa_modargs_get_channel_map(ma, &map) < 0 || map.channels != channels) {
 306         pa_log("failed to parse channel_map= argument.");
 307         goto fail;
 308     }
 309
 310     pa_log_info("Successfully connected as '%s'", jack_get_client_name(u->client));
 311
 312     ss.channels = u->channels = channels;
 313     ss.rate = jack_get_sample_rate(u->client);
 314     ss.format = PA_SAMPLE_FLOAT32NE;
 315
 316     assert(pa_sample_spec_valid(&ss));
 317
 318     for (i = 0; i < ss.channels; i++) {
 319         if (!(u->port[i] = jack_port_register(u->client, pa_channel_position_to_string(map.map[i]), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput|JackPortIsTerminal, 0))) {
 320             pa_log("jack_port_register() failed.");
 321             goto fail;
 322         }
 323     }
 324
 325     if (!(u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
 326         pa_log("failed to create sink.");
 327         goto fail;
 328     }
 329
 330     u->sink->userdata = u;
 331     pa_sink_set_owner(u->sink, m);
 332     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Jack sink (%s)", jack_get_client_name(u->client)));
 333     pa_xfree(t);
 334     u->sink->get_latency = sink_get_latency_cb;
 335
 336     jack_set_process_callback(u->client, jack_process, u);
 337     jack_on_shutdown(u->client, jack_shutdown, u);
 338
 339     if (jack_activate(u->client)) {
 340         pa_log("jack_activate() failed");
 341         goto fail;
 342     }
 343
 344     if (do_connect) {
 345         for (i = 0, p = ports; i < ss.channels; i++, p++) {
 346
 347             if (!*p) {
 348                 pa_log("not enough physical output ports, leaving unconnected.");
 349                 break;
 350             }
 351
 352             pa_log_info("connecting %s to %s", jack_port_name(u->port[i]), *p);
 353
 354             if (jack_connect(u->client, jack_port_name(u->port[i]), *p)) {
 355                 pa_log("failed to connect %s to %s, leaving unconnected.", jack_port_name(u->port[i]), *p);
 356                 break;
 357             }
 358         }
 359
 360     }
 361
 362     u->io_event = c->mainloop->io_new(c->mainloop, u->pipe_fds[0], PA_IO_EVENT_INPUT, io_event_cb, u);
 363
 364     free(ports);
 365     pa_modargs_free(ma);
 366
 367     return 0;
 368
 369 fail:
 370     if (ma)
 371         pa_modargs_free(ma);
 372
 373     free(ports);
 374
 375     pa__done(c, m);
 376
 377     return -1;
 378 }
 379
 380 void pa__done(pa_core *c, pa_module*m) {
 381     struct userdata *u;
 382     assert(c && m);
 383
 384     if (!(u = m->userdata))
 385         return;
 386
 387     if (u->client)
 388         jack_client_close(u->client);
 389
 390     if (u->io_event)
 391         c->mainloop->io_free(u->io_event);
 392
 393     if (u->sink) {
 394         pa_sink_disconnect(u->sink);
 395         pa_sink_unref(u->sink);
 396     }
 397
 398     if (u->pipe_fds[0] >= 0)
 399         close(u->pipe_fds[0]);
 400     if (u->pipe_fds[1] >= 0)
 401         close(u->pipe_fds[1]);
 402
 403     pthread_mutex_destroy(&u->mutex);
 404     pthread_cond_destroy(&u->cond);
 405     pa_xfree(u);
 406 }