src/modules/module-jack-sink.c

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