src/modules/module-jack-sink.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio 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   polypaudio 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 polypaudio; 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 <polyp/error.h>
  40 #include <polyp/xmalloc.h>
  41
  42 #include <polypcore/iochannel.h>
  43 #include <polypcore/sink.h>
  44 #include <polypcore/module.h>
  45 #include <polypcore/core-util.h>
  46 #include <polypcore/modargs.h>
  47 #include <polypcore/log.h>
  48 #include <polyp/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_fds[2];
  84     pa_io_event *io_event;
  85
  86     jack_nframes_t frames_in_buffer;
  87     jack_nframes_t timestamp;
  88 };
  89
  90 static const char* const valid_modargs[] = {
  91     "sink_name",
  92     "server_name",
  93     "client_name",
  94     "channels",
  95     "connect",
  96     "channel_map",
  97     NULL
  98 };
  99
 100 static void stop_sink(struct userdata *u) {
 101     assert (u);
 102
 103     jack_client_close(u->client);
 104     u->client = NULL;
 105     u->core->mainloop->io_free(u->io_event);
 106     u->io_event = NULL;
 107     pa_sink_disconnect(u->sink);
 108     pa_sink_unref(u->sink);
 109     u->sink = NULL;
 110     pa_module_unload_request(u->module);
 111 }
 112
 113 static void io_event_cb(pa_mainloop_api *m, pa_io_event *e, int fd, pa_io_event_flags_t flags, void *userdata) {
 114     struct userdata *u = userdata;
 115     char x;
 116
 117     assert(m);
 118     assert(e);
 119     assert(flags == PA_IO_EVENT_INPUT);
 120     assert(u);
 121     assert(u->pipe_fds[0] == fd);
 122
 123     read(fd, &x, 1);
 124
 125     if (u->quit_requested) {
 126         stop_sink(u);
 127         u->quit_requested = 0;
 128         return;
 129     }
 130
 131     pthread_mutex_lock(&u->mutex);
 132
 133     if (u->frames_requested > 0) {
 134         unsigned fs;
 135         jack_nframes_t frame_idx;
 136         pa_memchunk chunk;
 137
 138         fs = pa_frame_size(&u->sink->sample_spec);
 139
 140         pa_sink_render_full(u->sink, u->frames_requested * fs, &chunk);
 141
 142         for (frame_idx = 0; frame_idx < u->frames_requested; frame_idx ++) {
 143             unsigned c;
 144
 145             for (c = 0; c < u->channels; c++) {
 146                 float *s = ((float*) ((uint8_t*) chunk.memblock->data + chunk.index)) + (frame_idx * u->channels) + c;
 147                 float *d = ((float*) u->buffer[c]) + frame_idx;
 148
 149                 *d = *s;
 150             }
 151         }
 152
 153         pa_memblock_unref(chunk.memblock);
 154
 155         u->frames_requested = 0;
 156
 157         pthread_cond_signal(&u->cond);
 158     }
 159
 160     pthread_mutex_unlock(&u->mutex);
 161 }
 162
 163 static void request_render(struct userdata *u) {
 164     char c = 'x';
 165     assert(u);
 166
 167     assert(u->pipe_fds[1] >= 0);
 168     write(u->pipe_fds[1], &c, 1);
 169 }
 170
 171 static void jack_shutdown(void *arg) {
 172     struct userdata *u = arg;
 173     assert(u);
 174
 175     u->quit_requested = 1;
 176     request_render(u);
 177 }
 178
 179 static int jack_process(jack_nframes_t nframes, void *arg) {
 180     struct userdata *u = arg;
 181     assert(u);
 182
 183     if (jack_transport_query(u->client, NULL) == JackTransportRolling) {
 184         unsigned c;
 185
 186         pthread_mutex_lock(&u->mutex);
 187
 188         u->frames_requested = nframes;
 189
 190         for (c = 0; c < u->channels; c++) {
 191             u->buffer[c] = jack_port_get_buffer(u->port[c], nframes);
 192             assert(u->buffer[c]);
 193         }
 194
 195         request_render(u);
 196
 197         pthread_cond_wait(&u->cond, &u->mutex);
 198
 199         u->frames_in_buffer = nframes;
 200         u->timestamp = jack_get_current_transport_frame(u->client);
 201
 202         pthread_mutex_unlock(&u->mutex);
 203     }
 204
 205     return 0;
 206 }
 207
 208 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 209     struct userdata *u;
 210     jack_nframes_t n, l, d;
 211
 212     assert(s);
 213     u = s->userdata;
 214
 215     if (jack_transport_query(u->client, NULL) != JackTransportRolling)
 216         return 0;
 217
 218     n = jack_get_current_transport_frame(u->client);
 219
 220     if (n < u->timestamp)
 221         return 0;
 222
 223     d = n - u->timestamp;
 224     l = jack_port_get_total_latency(u->client, u->port[0]) + u->frames_in_buffer;
 225
 226     if (d >= l)
 227         return 0;
 228
 229     return pa_bytes_to_usec((l - d) * pa_frame_size(&s->sample_spec), &s->sample_spec);
 230 }
 231
 232 static void jack_error_func(const char*t) {
 233     pa_log_warn(__FILE__": JACK error >%s<", t);
 234 }
 235
 236 int pa__init(pa_core *c, pa_module*m) {
 237     struct userdata *u = NULL;
 238     pa_sample_spec ss;
 239     pa_channel_map map;
 240     pa_modargs *ma = NULL;
 241     jack_status_t status;
 242     const char *server_name, *client_name;
 243     uint32_t channels = 0;
 244     int connect = 1;
 245     unsigned i;
 246     const char **ports = NULL, **p;
 247
 248     assert(c);
 249     assert(m);
 250
 251     jack_set_error_function(jack_error_func);
 252
 253     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 254         pa_log(__FILE__": failed to parse module arguments.");
 255         goto fail;
 256     }
 257
 258     if (pa_modargs_get_value_boolean(ma, "connect", &connect) < 0) {
 259         pa_log(__FILE__": failed to parse connect= argument.");
 260         goto fail;
 261     }
 262
 263     server_name = pa_modargs_get_value(ma, "server_name", NULL);
 264     client_name = pa_modargs_get_value(ma, "client_name", "polypaudio");
 265
 266     u = pa_xnew0(struct userdata, 1);
 267     m->userdata = u;
 268     u->core = c;
 269     u->module = m;
 270     u->pipe_fds[0] = u->pipe_fds[1] = -1;
 271
 272     pthread_mutex_init(&u->mutex, NULL);
 273     pthread_cond_init(&u->cond, NULL);
 274
 275     if (pipe(u->pipe_fds) < 0) {
 276         pa_log(__FILE__": pipe() failed: %s", pa_cstrerror(errno));
 277         goto fail;
 278     }
 279
 280     pa_make_nonblock_fd(u->pipe_fds[1]);
 281
 282     if (!(u->client = jack_client_open(client_name, server_name ? JackServerName : JackNullOption, &status, server_name))) {
 283         pa_log(__FILE__": jack_client_open() failed.");
 284         goto fail;
 285     }
 286
 287     ports = jack_get_ports(u->client, NULL, NULL, JackPortIsPhysical|JackPortIsInput);
 288
 289     channels = 0;
 290     for (p = ports; *p; p++)
 291         channels++;
 292
 293     if (!channels)
 294         channels = c->default_sample_spec.channels;
 295
 296     if (pa_modargs_get_value_u32(ma, "channels", &channels) < 0 || channels <= 0 || channels >= PA_CHANNELS_MAX) {
 297         pa_log(__FILE__": failed to parse channels= argument.");
 298         goto fail;
 299     }
 300
 301     pa_channel_map_init_auto(&map, channels, PA_CHANNEL_MAP_ALSA);
 302     if (pa_modargs_get_channel_map(ma, &map) < 0 || map.channels != channels) {
 303         pa_log(__FILE__": failed to parse channel_map= argument.");
 304         goto fail;
 305     }
 306
 307     pa_log_info(__FILE__": Successfully connected as '%s'", jack_get_client_name(u->client));
 308
 309     ss.channels = u->channels = channels;
 310     ss.rate = jack_get_sample_rate(u->client);
 311     ss.format = PA_SAMPLE_FLOAT32NE;
 312
 313     assert(pa_sample_spec_valid(&ss));
 314
 315     for (i = 0; i < ss.channels; i++) {
 316         if (!(u->port[i] = jack_port_register(u->client, pa_channel_position_to_string(map.map[i]), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput|JackPortIsTerminal, 0))) {
 317             pa_log(__FILE__": jack_port_register() failed.");
 318             goto fail;
 319         }
 320     }
 321
 322     if (!(u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
 323         pa_log(__FILE__": failed to create sink.");
 324         goto fail;
 325     }
 326
 327     u->sink->userdata = u;
 328     pa_sink_set_owner(u->sink, m);
 329     u->sink->description = pa_sprintf_malloc("Jack sink (%s)", jack_get_client_name(u->client));
 330     u->sink->get_latency = sink_get_latency_cb;
 331
 332     jack_set_process_callback(u->client, jack_process, u);
 333     jack_on_shutdown(u->client, jack_shutdown, u);
 334
 335     if (jack_activate(u->client)) {
 336         pa_log(__FILE__": jack_activate() failed");
 337         goto fail;
 338     }
 339
 340     if (connect) {
 341         for (i = 0, p = ports; i < ss.channels; i++, p++) {
 342
 343             if (!*p) {
 344                 pa_log(__FILE__": not enough physical output ports, leaving unconnected.");
 345                 break;
 346             }
 347
 348             pa_log_info(__FILE__": connecting %s to %s", jack_port_name(u->port[i]), *p);
 349
 350             if (jack_connect(u->client, jack_port_name(u->port[i]), *p)) {
 351                 pa_log(__FILE__": failed to connect %s to %s, leaving unconnected.", jack_port_name(u->port[i]), *p);
 352                 break;
 353             }
 354         }
 355
 356     }
 357
 358     u->io_event = c->mainloop->io_new(c->mainloop, u->pipe_fds[0], PA_IO_EVENT_INPUT, io_event_cb, u);
 359
 360     free(ports);
 361     pa_modargs_free(ma);
 362
 363     return 0;
 364
 365 fail:
 366     if (ma)
 367         pa_modargs_free(ma);
 368
 369     free(ports);
 370
 371     pa__done(c, m);
 372
 373     return -1;
 374 }
 375
 376 void pa__done(pa_core *c, pa_module*m) {
 377     struct userdata *u;
 378     assert(c && m);
 379
 380     if (!(u = m->userdata))
 381         return;
 382
 383     if (u->client)
 384         jack_client_close(u->client);
 385
 386     if (u->io_event)
 387         c->mainloop->io_free(u->io_event);
 388
 389     if (u->sink) {
 390         pa_sink_disconnect(u->sink);
 391         pa_sink_unref(u->sink);
 392     }
 393
 394     if (u->pipe_fds[0] >= 0)
 395         close(u->pipe_fds[0]);
 396     if (u->pipe_fds[1] >= 0)
 397         close(u->pipe_fds[1]);
 398
 399     pthread_mutex_destroy(&u->mutex);
 400     pthread_cond_destroy(&u->cond);
 401     pa_xfree(u);
 402 }