diff options
Diffstat (limited to 'src/modules/module-jack-sink.c')
-rw-r--r-- | src/modules/module-jack-sink.c | 497 |
1 files changed, 0 insertions, 497 deletions
diff --git a/src/modules/module-jack-sink.c b/src/modules/module-jack-sink.c deleted file mode 100644 index 31b8a96e..00000000 --- a/src/modules/module-jack-sink.c +++ /dev/null @@ -1,497 +0,0 @@ -/*** - This file is part of PulseAudio. - - Copyright 2006 Lennart Poettering - - PulseAudio is free software; you can redistribute it and/or modify - it under the terms of the GNU Lesser General Public License as published - by the Free Software Foundation; either version 2.1 of the License, - or (at your option) any later version. - - PulseAudio is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License - along with PulseAudio; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - USA. -***/ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include <stdlib.h> -#include <sys/stat.h> -#include <stdio.h> -#include <errno.h> -#include <string.h> -#include <fcntl.h> -#include <unistd.h> -#include <limits.h> - -#include <jack/jack.h> - -#include <pulse/xmalloc.h> - -#include <pulsecore/core-error.h> -#include <pulsecore/sink.h> -#include <pulsecore/module.h> -#include <pulsecore/core-util.h> -#include <pulsecore/modargs.h> -#include <pulsecore/log.h> -#include <pulsecore/thread.h> -#include <pulsecore/thread-mq.h> -#include <pulsecore/rtpoll.h> -#include <pulsecore/sample-util.h> - -#include "module-jack-sink-symdef.h" - -/* General overview: - * - * Because JACK has a very unflexible event loop management which - * doesn't allow us to add our own event sources to the event thread - * we cannot use the JACK real-time thread for dispatching our PA - * work. Instead, we run an additional RT thread which does most of - * the PA handling, and have the JACK RT thread request data from it - * via pa_asyncmsgq. The cost is an additional context switch which - * should hopefully not be that expensive if RT scheduling is - * enabled. A better fix would only be possible with additional event - * source support in JACK. - */ - -PA_MODULE_AUTHOR("Lennart Poettering"); -PA_MODULE_DESCRIPTION("JACK Sink"); -PA_MODULE_LOAD_ONCE(TRUE); -PA_MODULE_VERSION(PACKAGE_VERSION); -PA_MODULE_USAGE( - "sink_name=<name of sink> " - "server_name=<jack server name> " - "client_name=<jack client name> " - "channels=<number of channels> " - "connect=<connect ports?> " - "channel_map=<channel map>"); - -#define DEFAULT_SINK_NAME "jack_out" - -struct userdata { - pa_core *core; - pa_module *module; - pa_sink *sink; - - unsigned channels; - - jack_port_t* port[PA_CHANNELS_MAX]; - jack_client_t *client; - - void *buffer[PA_CHANNELS_MAX]; - - pa_thread_mq thread_mq; - pa_asyncmsgq *jack_msgq; - pa_rtpoll *rtpoll; - pa_rtpoll_item *rtpoll_item; - - pa_thread *thread; - - jack_nframes_t frames_in_buffer; - jack_nframes_t saved_frame_time; - pa_bool_t saved_frame_time_valid; -}; - -static const char* const valid_modargs[] = { - "sink_name", - "server_name", - "client_name", - "channels", - "connect", - "channel_map", - NULL -}; - -enum { - SINK_MESSAGE_RENDER = PA_SINK_MESSAGE_MAX, - SINK_MESSAGE_BUFFER_SIZE, - SINK_MESSAGE_ON_SHUTDOWN -}; - -static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *memchunk) { - struct userdata *u = PA_SINK(o)->userdata; - - switch (code) { - - case SINK_MESSAGE_RENDER: - - /* Handle the request from the JACK thread */ - - if (u->sink->thread_info.state == PA_SINK_RUNNING) { - pa_memchunk chunk; - size_t nbytes; - void *p; - - pa_assert(offset > 0); - nbytes = (size_t) offset * pa_frame_size(&u->sink->sample_spec); - - pa_sink_render_full(u->sink, nbytes, &chunk); - - p = (uint8_t*) pa_memblock_acquire(chunk.memblock) + chunk.index; - pa_deinterleave(p, u->buffer, u->channels, sizeof(float), (unsigned) offset); - pa_memblock_release(chunk.memblock); - - pa_memblock_unref(chunk.memblock); - } else { - unsigned c; - pa_sample_spec ss; - - /* Humm, we're not RUNNING, hence let's write some silence */ - - ss = u->sink->sample_spec; - ss.channels = 1; - - for (c = 0; c < u->channels; c++) - pa_silence_memory(u->buffer[c], (size_t) offset * pa_sample_size(&ss), &ss); - } - - u->frames_in_buffer = (jack_nframes_t) offset; - u->saved_frame_time = * (jack_nframes_t*) data; - u->saved_frame_time_valid = TRUE; - - return 0; - - case SINK_MESSAGE_BUFFER_SIZE: - pa_sink_set_max_request_within_thread(u->sink, (size_t) offset * pa_frame_size(&u->sink->sample_spec)); - return 0; - - case SINK_MESSAGE_ON_SHUTDOWN: - pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL); - return 0; - - case PA_SINK_MESSAGE_GET_LATENCY: { - jack_nframes_t l, ft, d; - size_t n; - - /* This is the "worst-case" latency */ - l = jack_port_get_total_latency(u->client, u->port[0]) + u->frames_in_buffer; - - if (u->saved_frame_time_valid) { - /* Adjust the worst case latency by the time that - * passed since we last handed data to JACK */ - - ft = jack_frame_time(u->client); - d = ft > u->saved_frame_time ? ft - u->saved_frame_time : 0; - l = l > d ? l - d : 0; - } - - /* Convert it to usec */ - n = l * pa_frame_size(&u->sink->sample_spec); - *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->sink->sample_spec); - - return 0; - } - - } - - return pa_sink_process_msg(o, code, data, offset, memchunk); -} - -static int jack_process(jack_nframes_t nframes, void *arg) { - struct userdata *u = arg; - unsigned c; - jack_nframes_t frame_time; - pa_assert(u); - - /* We just forward the request to our other RT thread */ - - for (c = 0; c < u->channels; c++) - pa_assert_se(u->buffer[c] = jack_port_get_buffer(u->port[c], nframes)); - - frame_time = jack_frame_time(u->client); - - pa_assert_se(pa_asyncmsgq_send(u->jack_msgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_RENDER, &frame_time, nframes, NULL) == 0); - return 0; -} - -static void thread_func(void *userdata) { - struct userdata *u = userdata; - - pa_assert(u); - - pa_log_debug("Thread starting up"); - - if (u->core->realtime_scheduling) - pa_make_realtime(u->core->realtime_priority); - - pa_thread_mq_install(&u->thread_mq); - pa_rtpoll_install(u->rtpoll); - - for (;;) { - int ret; - - if (PA_SINK_IS_OPENED(u->sink->thread_info.state)) - if (u->sink->thread_info.rewind_requested) - pa_sink_process_rewind(u->sink, 0); - - if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0) - goto fail; - - if (ret == 0) - goto finish; - } - -fail: - /* If this was no regular exit from the loop we have to continue - * processing messages until we received PA_MESSAGE_SHUTDOWN */ - pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL); - pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN); - -finish: - pa_log_debug("Thread shutting down"); -} - -static void jack_error_func(const char*t) { - char *s; - - s = pa_xstrndup(t, strcspn(t, "\n\r")); - pa_log_warn("JACK error >%s<", s); - pa_xfree(s); -} - -static void jack_init(void *arg) { - struct userdata *u = arg; - - pa_log_info("JACK thread starting up."); - - if (u->core->realtime_scheduling) - pa_make_realtime(u->core->realtime_priority+4); -} - -static void jack_shutdown(void* arg) { - struct userdata *u = arg; - - pa_log_info("JACK thread shutting down."); - pa_asyncmsgq_post(u->jack_msgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_ON_SHUTDOWN, NULL, 0, NULL, NULL); -} - -static int jack_buffer_size(jack_nframes_t nframes, void *arg) { - struct userdata *u = arg; - - pa_log_info("JACK buffer size changed."); - pa_asyncmsgq_post(u->jack_msgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_BUFFER_SIZE, NULL, nframes, NULL, NULL); - return 0; -} - -int pa__init(pa_module*m) { - struct userdata *u = NULL; - pa_sample_spec ss; - pa_channel_map map; - pa_modargs *ma = NULL; - jack_status_t status; - const char *server_name, *client_name; - uint32_t channels = 0; - pa_bool_t do_connect = TRUE; - unsigned i; - const char **ports = NULL, **p; - pa_sink_new_data data; - - pa_assert(m); - - jack_set_error_function(jack_error_func); - - if (!(ma = pa_modargs_new(m->argument, valid_modargs))) { - pa_log("Failed to parse module arguments."); - goto fail; - } - - if (pa_modargs_get_value_boolean(ma, "connect", &do_connect) < 0) { - pa_log("Failed to parse connect= argument."); - goto fail; - } - - server_name = pa_modargs_get_value(ma, "server_name", NULL); - client_name = pa_modargs_get_value(ma, "client_name", "PulseAudio JACK Sink"); - - m->userdata = u = pa_xnew0(struct userdata, 1); - u->core = m->core; - u->module = m; - u->saved_frame_time_valid = FALSE; - u->rtpoll = pa_rtpoll_new(); - pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll); - - /* The queue linking the JACK thread and our RT thread */ - u->jack_msgq = pa_asyncmsgq_new(0); - - /* The msgq from the JACK RT thread should have an even higher - * priority than the normal message queues, to match the guarantee - * all other drivers make: supplying the audio device with data is - * the top priority -- and as long as that is possible we don't do - * anything else */ - u->rtpoll_item = pa_rtpoll_item_new_asyncmsgq_read(u->rtpoll, PA_RTPOLL_EARLY-1, u->jack_msgq); - - if (!(u->client = jack_client_open(client_name, server_name ? JackServerName : JackNullOption, &status, server_name))) { - pa_log("jack_client_open() failed."); - goto fail; - } - - ports = jack_get_ports(u->client, NULL, NULL, JackPortIsPhysical|JackPortIsInput); - - channels = 0; - for (p = ports; *p; p++) - channels++; - - if (!channels) - channels = m->core->default_sample_spec.channels; - - if (pa_modargs_get_value_u32(ma, "channels", &channels) < 0 || - channels <= 0 || - channels > PA_CHANNELS_MAX) { - pa_log("Failed to parse channels= argument."); - goto fail; - } - - if (channels == m->core->default_channel_map.channels) - map = m->core->default_channel_map; - else - pa_channel_map_init_extend(&map, channels, PA_CHANNEL_MAP_ALSA); - - if (pa_modargs_get_channel_map(ma, NULL, &map) < 0 || map.channels != channels) { - pa_log("Failed to parse channel_map= argument."); - goto fail; - } - - pa_log_info("Successfully connected as '%s'", jack_get_client_name(u->client)); - - u->channels = ss.channels = (uint8_t) channels; - ss.rate = jack_get_sample_rate(u->client); - ss.format = PA_SAMPLE_FLOAT32NE; - - pa_assert(pa_sample_spec_valid(&ss)); - - for (i = 0; i < ss.channels; i++) { - if (!(u->port[i] = jack_port_register(u->client, pa_channel_position_to_string(map.map[i]), JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput|JackPortIsTerminal, 0))) { - pa_log("jack_port_register() failed."); - goto fail; - } - } - - pa_sink_new_data_init(&data); - data.driver = __FILE__; - data.module = m; - pa_sink_new_data_set_name(&data, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME)); - pa_sink_new_data_set_sample_spec(&data, &ss); - pa_sink_new_data_set_channel_map(&data, &map); - pa_proplist_sets(data.proplist, PA_PROP_DEVICE_API, "jack"); - if (server_name) - pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, server_name); - pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Jack sink (%s)", jack_get_client_name(u->client)); - pa_proplist_sets(data.proplist, "jack.client_name", jack_get_client_name(u->client)); - - u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY); - pa_sink_new_data_done(&data); - - if (!u->sink) { - pa_log("Failed to create sink."); - goto fail; - } - - u->sink->parent.process_msg = sink_process_msg; - u->sink->userdata = u; - - pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq); - pa_sink_set_rtpoll(u->sink, u->rtpoll); - pa_sink_set_max_request(u->sink, jack_get_buffer_size(u->client) * pa_frame_size(&u->sink->sample_spec)); - - jack_set_process_callback(u->client, jack_process, u); - jack_on_shutdown(u->client, jack_shutdown, u); - jack_set_thread_init_callback(u->client, jack_init, u); - jack_set_buffer_size_callback(u->client, jack_buffer_size, u); - - if (!(u->thread = pa_thread_new(thread_func, u))) { - pa_log("Failed to create thread."); - goto fail; - } - - if (jack_activate(u->client)) { - pa_log("jack_activate() failed"); - goto fail; - } - - if (do_connect) { - for (i = 0, p = ports; i < ss.channels; i++, p++) { - - if (!*p) { - pa_log("Not enough physical output ports, leaving unconnected."); - break; - } - - pa_log_info("Connecting %s to %s", jack_port_name(u->port[i]), *p); - - if (jack_connect(u->client, jack_port_name(u->port[i]), *p)) { - pa_log("Failed to connect %s to %s, leaving unconnected.", jack_port_name(u->port[i]), *p); - break; - } - } - } - - pa_sink_put(u->sink); - - free(ports); - pa_modargs_free(ma); - - return 0; - -fail: - if (ma) - pa_modargs_free(ma); - - free(ports); - - pa__done(m); - - return -1; -} - -int pa__get_n_used(pa_module *m) { - struct userdata *u; - - pa_assert(m); - pa_assert_se(u = m->userdata); - - return pa_sink_linked_by(u->sink); -} - -void pa__done(pa_module*m) { - struct userdata *u; - - pa_assert(m); - - if (!(u = m->userdata)) - return; - - if (u->client) - jack_client_close(u->client); - - if (u->sink) - pa_sink_unlink(u->sink); - - if (u->thread) { - pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL); - pa_thread_free(u->thread); - } - - pa_thread_mq_done(&u->thread_mq); - - if (u->sink) - pa_sink_unref(u->sink); - - if (u->rtpoll_item) - pa_rtpoll_item_free(u->rtpoll_item); - - if (u->jack_msgq) - pa_asyncmsgq_unref(u->jack_msgq); - - if (u->rtpoll) - pa_rtpoll_free(u->rtpoll); - - pa_xfree(u); -} |