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