src/modules/module-jack-source.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 <errno.h>
  32 #include <string.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35 #include <limits.h>
  36
  37 #include <jack/jack.h>
  38
  39 #include <pulse/xmalloc.h>
  40
  41 #include <pulsecore/core-error.h>
  42 #include <pulsecore/source.h>
  43 #include <pulsecore/module.h>
  44 #include <pulsecore/core-util.h>
  45 #include <pulsecore/modargs.h>
  46 #include <pulsecore/log.h>
  47 #include <pulsecore/thread.h>
  48 #include <pulsecore/thread-mq.h>
  49 #include <pulsecore/rtpoll.h>
  50 #include <pulsecore/sample-util.h>
  51
  52 #include "module-jack-source-symdef.h"
  53
  54 /* See module-jack-sink for a few comments how this module basically
  55  * works */
  56
  57 PA_MODULE_AUTHOR("Lennart Poettering");
  58 PA_MODULE_DESCRIPTION("JACK Source");
  59 PA_MODULE_VERSION(PACKAGE_VERSION);
  60 PA_MODULE_LOAD_ONCE(TRUE);
  61 PA_MODULE_USAGE(
  62         "source_name=<name of source> "
  63         "server_name=<jack server name> "
  64         "client_name=<jack client name> "
  65         "channels=<number of channels> "
  66         "connect=<connect ports?>"
  67         "channel_map=<channel map>");
  68
  69 #define DEFAULT_SOURCE_NAME "jack_in"
  70
  71 struct userdata {
  72     pa_core *core;
  73     pa_module *module;
  74     pa_source *source;
  75
  76     unsigned channels;
  77
  78     jack_port_t* port[PA_CHANNELS_MAX];
  79     jack_client_t *client;
  80
  81     pa_thread_mq thread_mq;
  82     pa_asyncmsgq *jack_msgq;
  83     pa_rtpoll *rtpoll;
  84     pa_rtpoll_item *rtpoll_item;
  85
  86     pa_thread *thread;
  87
  88     jack_nframes_t saved_frame_time;
  89     pa_bool_t saved_frame_time_valid;
  90 };
  91
  92 static const char* const valid_modargs[] = {
  93     "source_name",
  94     "server_name",
  95     "client_name",
  96     "channels",
  97     "connect",
  98     "channel_map",
  99     NULL
 100 };
 101
 102 enum {
 103     SOURCE_MESSAGE_POST = PA_SOURCE_MESSAGE_MAX,
 104     SOURCE_MESSAGE_ON_SHUTDOWN
 105 };
 106
 107 static int source_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 108     struct userdata *u = PA_SOURCE(o)->userdata;
 109
 110     switch (code) {
 111
 112         case SOURCE_MESSAGE_POST:
 113
 114             /* Handle the new block from the JACK thread */
 115             pa_assert(chunk);
 116             pa_assert(chunk->length > 0);
 117
 118             if (u->source->thread_info.state == PA_SOURCE_RUNNING)
 119                 pa_source_post(u->source, chunk);
 120
 121             u->saved_frame_time = offset;
 122             u->saved_frame_time_valid = TRUE;
 123
 124             return 0;
 125
 126         case SOURCE_MESSAGE_ON_SHUTDOWN:
 127             pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 128             return 0;
 129
 130         case PA_SOURCE_MESSAGE_GET_LATENCY: {
 131             jack_nframes_t l, ft, d;
 132             size_t n;
 133
 134             /* This is the "worst-case" latency */
 135             l = jack_port_get_total_latency(u->client, u->port[0]);
 136
 137             if (u->saved_frame_time_valid) {
 138                 /* Adjust the worst case latency by the time that
 139                  * passed since we last handed data to JACK */
 140
 141                 ft = jack_frame_time(u->client);
 142                 d = ft > u->saved_frame_time ? ft - u->saved_frame_time : 0;
 143                 l += d;
 144             }
 145
 146             /* Convert it to usec */
 147             n = l * pa_frame_size(&u->source->sample_spec);
 148             *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->source->sample_spec);
 149
 150             return 0;
 151         }
 152     }
 153
 154     return pa_source_process_msg(o, code, data, offset, chunk);
 155 }
 156
 157 static int jack_process(jack_nframes_t nframes, void *arg) {
 158     unsigned c;
 159     struct userdata *u = arg;
 160     const void *buffer[PA_CHANNELS_MAX];
 161     void *p;
 162     jack_nframes_t frame_time;
 163     pa_memchunk chunk;
 164
 165     pa_assert(u);
 166
 167     for (c = 0; c < u->channels; c++)
 168         pa_assert(buffer[c] = jack_port_get_buffer(u->port[c], nframes));
 169
 170     /* We interleave the data and pass it on to the other RT thread */
 171
 172     pa_memchunk_reset(&chunk);
 173     chunk.length = nframes * pa_frame_size(&u->source->sample_spec);
 174     chunk.memblock = pa_memblock_new(u->core->mempool, chunk.length);
 175     p = pa_memblock_acquire(chunk.memblock);
 176     pa_interleave(buffer, u->channels, p, sizeof(float), nframes);
 177     pa_memblock_release(chunk.memblock);
 178
 179     frame_time = jack_frame_time(u->client);
 180
 181     pa_asyncmsgq_post(u->jack_msgq, PA_MSGOBJECT(u->source), SOURCE_MESSAGE_POST, NULL, frame_time, &chunk, NULL);
 182
 183     pa_memblock_unref(chunk.memblock);
 184
 185     return 0;
 186 }
 187
 188 static void thread_func(void *userdata) {
 189     struct userdata *u = userdata;
 190
 191     pa_assert(u);
 192
 193     pa_log_debug("Thread starting up");
 194
 195     if (u->core->realtime_scheduling)
 196         pa_make_realtime(u->core->realtime_priority);
 197
 198     pa_thread_mq_install(&u->thread_mq);
 199     pa_rtpoll_install(u->rtpoll);
 200
 201     for (;;) {
 202         int ret;
 203
 204         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
 205             goto fail;
 206
 207         if (ret == 0)
 208             goto finish;
 209     }
 210
 211 fail:
 212     /* If this was no regular exit from the loop we have to continue
 213      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 214     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 215     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 216
 217 finish:
 218     pa_log_debug("Thread shutting down");
 219 }
 220
 221 static void jack_error_func(const char*t) {
 222     char *s;
 223
 224     s = pa_xstrndup(t, strcspn(t, "\n\r"));
 225     pa_log_warn("JACK error >%s<", s);
 226     pa_xfree(s);
 227 }
 228
 229 static void jack_init(void *arg) {
 230     struct userdata *u = arg;
 231
 232     pa_log_info("JACK thread starting up.");
 233
 234     if (u->core->realtime_scheduling)
 235         pa_make_realtime(u->core->realtime_priority+4);
 236 }
 237
 238 static void jack_shutdown(void* arg) {
 239     struct userdata *u = arg;
 240
 241     pa_log_info("JACK thread shutting down..");
 242     pa_asyncmsgq_post(u->jack_msgq, PA_MSGOBJECT(u->source), SOURCE_MESSAGE_ON_SHUTDOWN, NULL, 0, NULL, NULL);
 243 }
 244
 245 int pa__init(pa_module*m) {
 246     struct userdata *u = NULL;
 247     pa_sample_spec ss;
 248     pa_channel_map map;
 249     pa_modargs *ma = NULL;
 250     jack_status_t status;
 251     const char *server_name, *client_name;
 252     uint32_t channels = 0;
 253     pa_bool_t do_connect = TRUE;
 254     unsigned i;
 255     const char **ports = NULL, **p;
 256     pa_source_new_data data;
 257
 258     pa_assert(m);
 259
 260     jack_set_error_function(jack_error_func);
 261
 262     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 263         pa_log("Failed to parse module arguments.");
 264         goto fail;
 265     }
 266
 267     if (pa_modargs_get_value_boolean(ma, "connect", &do_connect) < 0) {
 268         pa_log("Failed to parse connect= argument.");
 269         goto fail;
 270     }
 271
 272     server_name = pa_modargs_get_value(ma, "server_name", NULL);
 273     client_name = pa_modargs_get_value(ma, "client_name", "PulseAudio JACK Source");
 274
 275     u = pa_xnew0(struct userdata, 1);
 276     u->core = m->core;
 277     u->module = m;
 278     m->userdata = u;
 279     u->saved_frame_time_valid = FALSE;
 280
 281     u->rtpoll = pa_rtpoll_new();
 282     pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
 283
 284     u->jack_msgq = pa_asyncmsgq_new(0);
 285     u->rtpoll_item = pa_rtpoll_item_new_asyncmsgq_read(u->rtpoll, PA_RTPOLL_EARLY-1, u->jack_msgq);
 286
 287     if (!(u->client = jack_client_open(client_name, server_name ? JackServerName : JackNullOption, &status, server_name))) {
 288         pa_log("jack_client_open() failed.");
 289         goto fail;
 290     }
 291
 292     ports = jack_get_ports(u->client, NULL, NULL, JackPortIsPhysical|JackPortIsOutput);
 293
 294     channels = 0;
 295     for (p = ports; *p; p++)
 296         channels++;
 297
 298     if (!channels)
 299         channels = m->core->default_sample_spec.channels;
 300
 301     if (pa_modargs_get_value_u32(ma, "channels", &channels) < 0 || channels <= 0 || channels >= PA_CHANNELS_MAX) {
 302         pa_log("failed to parse channels= argument.");
 303         goto fail;
 304     }
 305
 306     pa_assert_se(pa_channel_map_init_auto(&map, channels, PA_CHANNEL_MAP_AUX));
 307     pa_channel_map_init_auto(&map, channels, PA_CHANNEL_MAP_ALSA);
 308     if (pa_modargs_get_channel_map(ma, NULL, &map) < 0 || map.channels != channels) {
 309         pa_log("failed to parse channel_map= argument.");
 310         goto fail;
 311     }
 312
 313     pa_log_info("Successfully connected as '%s'", jack_get_client_name(u->client));
 314
 315     ss.channels = u->channels = channels;
 316     ss.rate = jack_get_sample_rate(u->client);
 317     ss.format = PA_SAMPLE_FLOAT32NE;
 318
 319     pa_assert(pa_sample_spec_valid(&ss));
 320
 321     for (i = 0; i < ss.channels; i++) {
 322         if (!(u->port[i] = jack_port_register(u->client, pa_channel_position_to_string(map.map[i]), JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput|JackPortIsTerminal, 0))) {
 323             pa_log("jack_port_register() failed.");
 324             goto fail;
 325         }
 326     }
 327
 328     pa_source_new_data_init(&data);
 329     data.driver = __FILE__;
 330     data.module = m;
 331     pa_source_new_data_set_name(&data, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME));
 332     pa_source_new_data_set_sample_spec(&data, &ss);
 333     pa_source_new_data_set_channel_map(&data, &map);
 334     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_API, "jack");
 335     if (server_name)
 336         pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, server_name);
 337     pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Jack source (%s)", jack_get_client_name(u->client));
 338     pa_proplist_sets(data.proplist, "jack.client_name", jack_get_client_name(u->client));
 339
 340     u->source = pa_source_new(m->core, &data, PA_SOURCE_LATENCY);
 341     pa_source_new_data_done(&data);
 342
 343     if (!u->source) {
 344         pa_log("Failed to create source.");
 345         goto fail;
 346     }
 347
 348     u->source->parent.process_msg = source_process_msg;
 349     u->source->userdata = u;
 350
 351     pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
 352     pa_source_set_rtpoll(u->source, u->rtpoll);
 353
 354     jack_set_process_callback(u->client, jack_process, u);
 355     jack_on_shutdown(u->client, jack_shutdown, u);
 356     jack_set_thread_init_callback(u->client, jack_init, u);
 357
 358     if (!(u->thread = pa_thread_new(thread_func, u))) {
 359         pa_log("Failed to create thread.");
 360         goto fail;
 361     }
 362
 363     if (jack_activate(u->client)) {
 364         pa_log("jack_activate() failed");
 365         goto fail;
 366     }
 367
 368     if (do_connect) {
 369         for (i = 0, p = ports; i < ss.channels; i++, p++) {
 370
 371             if (!*p) {
 372                 pa_log("not enough physical output ports, leaving unconnected.");
 373                 break;
 374             }
 375
 376             pa_log_info("connecting %s to %s", jack_port_name(u->port[i]), *p);
 377
 378             if (jack_connect(u->client, *p, jack_port_name(u->port[i]))) {
 379                 pa_log("failed to connect %s to %s, leaving unconnected.", jack_port_name(u->port[i]), *p);
 380                 break;
 381             }
 382         }
 383
 384     }
 385
 386     pa_source_put(u->source);
 387
 388     free(ports);
 389     pa_modargs_free(ma);
 390
 391     return 0;
 392
 393 fail:
 394     if (ma)
 395         pa_modargs_free(ma);
 396
 397     free(ports);
 398
 399     pa__done(m);
 400
 401     return -1;
 402 }
 403
 404 void pa__done(pa_module*m) {
 405     struct userdata *u;
 406     pa_assert(m);
 407
 408     if (!(u = m->userdata))
 409         return;
 410
 411     if (u->client)
 412         jack_client_close(u->client);
 413
 414     if (u->source)
 415         pa_source_unlink(u->source);
 416
 417     if (u->thread) {
 418         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
 419         pa_thread_free(u->thread);
 420     }
 421
 422     pa_thread_mq_done(&u->thread_mq);
 423
 424     if (u->source)
 425         pa_source_unref(u->source);
 426
 427     if (u->rtpoll_item)
 428         pa_rtpoll_item_free(u->rtpoll_item);
 429
 430     if (u->jack_msgq)
 431         pa_asyncmsgq_unref(u->jack_msgq);
 432
 433     if (u->rtpoll)
 434         pa_rtpoll_free(u->rtpoll);
 435
 436     pa_xfree(u);
 437 }