/*** This file is part of PulseAudio. Copyright 2013 Alexander Couzens 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, see . ***/ #ifdef HAVE_CONFIG_H #include #endif #include "restart-module.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include PA_MODULE_AUTHOR("Alexander Couzens"); PA_MODULE_DESCRIPTION("Create a network source which connects via a stream to a remote PulseAudio server"); PA_MODULE_VERSION(PACKAGE_VERSION); PA_MODULE_LOAD_ONCE(false); PA_MODULE_USAGE( "server=
" "source= " "source_name= " "source_properties= " "reconnect_interval_ms= " "format= " "channels= " "rate= " "channel_map= " "cookie=" ); #define TUNNEL_THREAD_FAILED_MAINLOOP 1 static int do_init(pa_module *m); static void do_done(pa_module *m); static void stream_state_cb(pa_stream *stream, void *userdata); static void stream_read_cb(pa_stream *s, size_t length, void *userdata); static void context_state_cb(pa_context *c, void *userdata); static void source_update_requested_latency_cb(pa_source *s); struct tunnel_msg { pa_msgobject parent; }; typedef struct tunnel_msg tunnel_msg; PA_DEFINE_PRIVATE_CLASS(tunnel_msg, pa_msgobject); enum { TUNNEL_MESSAGE_CREATE_SOURCE_REQUEST, TUNNEL_MESSAGE_MAYBE_RESTART, }; enum { TUNNEL_MESSAGE_SOURCE_CREATED = PA_SOURCE_MESSAGE_MAX, }; struct userdata { pa_module *module; pa_source *source; pa_thread *thread; pa_thread_mq *thread_mq; pa_mainloop *thread_mainloop; pa_mainloop_api *thread_mainloop_api; pa_context *context; pa_stream *stream; pa_rtpoll *rtpoll; bool update_stream_bufferattr_after_connect; bool connected; bool shutting_down; bool new_data; char *cookie_file; char *remote_server; char *remote_source_name; char *source_name; pa_proplist *source_proplist; pa_sample_spec sample_spec; pa_channel_map channel_map; tunnel_msg *msg; pa_usec_t reconnect_interval_us; }; struct module_restart_data { struct userdata *userdata; pa_restart_data *restart_data; }; static const char* const valid_modargs[] = { "source_name", "source_properties", "server", "source", "format", "channels", "rate", "channel_map", "cookie", "reconnect_interval_ms", NULL, }; static void cork_stream(struct userdata *u, bool cork) { pa_operation *operation; pa_assert(u); pa_assert(u->stream); if ((operation = pa_stream_cork(u->stream, cork, NULL, NULL))) pa_operation_unref(operation); } static void reset_bufferattr(pa_buffer_attr *bufferattr) { pa_assert(bufferattr); bufferattr->fragsize = (uint32_t) -1; bufferattr->minreq = (uint32_t) -1; bufferattr->maxlength = (uint32_t) -1; bufferattr->prebuf = (uint32_t) -1; bufferattr->tlength = (uint32_t) -1; } static pa_proplist* tunnel_new_proplist(struct userdata *u) { pa_proplist *proplist = pa_proplist_new(); pa_assert(proplist); pa_proplist_sets(proplist, PA_PROP_APPLICATION_NAME, "PulseAudio"); pa_proplist_sets(proplist, PA_PROP_APPLICATION_ID, "org.PulseAudio.PulseAudio"); pa_proplist_sets(proplist, PA_PROP_APPLICATION_VERSION, PACKAGE_VERSION); pa_init_proplist(proplist); return proplist; } static void stream_read_cb(pa_stream *s, size_t length, void *userdata) { struct userdata *u = userdata; u->new_data = true; } /* called from io context to read samples from the stream into our source */ static void read_new_samples(struct userdata *u) { const void *p; size_t readable = 0; pa_memchunk memchunk; pa_assert(u); u->new_data = false; pa_memchunk_reset(&memchunk); if (PA_UNLIKELY(!u->connected || pa_stream_get_state(u->stream) != PA_STREAM_READY)) return; readable = pa_stream_readable_size(u->stream); while (readable > 0) { size_t nbytes = 0; if (PA_UNLIKELY(pa_stream_peek(u->stream, &p, &nbytes) != 0)) { pa_log("pa_stream_peek() failed: %s", pa_strerror(pa_context_errno(u->context))); u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); return; } if (PA_LIKELY(p)) { /* we have valid data */ memchunk.memblock = pa_memblock_new_fixed(u->module->core->mempool, (void *) p, nbytes, true); memchunk.length = nbytes; memchunk.index = 0; pa_source_post(u->source, &memchunk); pa_memblock_unref_fixed(memchunk.memblock); } else { size_t bytes_to_generate = nbytes; /* we have a hole. generate silence */ memchunk = u->source->silence; pa_memblock_ref(memchunk.memblock); while (bytes_to_generate > 0) { if (bytes_to_generate < memchunk.length) memchunk.length = bytes_to_generate; pa_source_post(u->source, &memchunk); bytes_to_generate -= memchunk.length; } pa_memblock_unref(memchunk.memblock); } pa_stream_drop(u->stream); readable -= nbytes; } } static void thread_func(void *userdata) { struct userdata *u = userdata; pa_proplist *proplist; pa_assert(u); pa_log_debug("Thread starting up"); pa_thread_mq_install(u->thread_mq); proplist = tunnel_new_proplist(u); u->context = pa_context_new_with_proplist(u->thread_mainloop_api, "PulseAudio", proplist); pa_proplist_free(proplist); if (!u->context) { pa_log("Failed to create libpulse context"); goto fail; } if (u->cookie_file && pa_context_load_cookie_from_file(u->context, u->cookie_file) != 0) { pa_log_error("Can not load cookie file!"); goto fail; } pa_context_set_state_callback(u->context, context_state_cb, u); if (pa_context_connect(u->context, u->remote_server, PA_CONTEXT_NOAUTOSPAWN, NULL) < 0) { pa_log("Failed to connect libpulse context: %s", pa_strerror(pa_context_errno(u->context))); goto fail; } for (;;) { int ret; if (pa_mainloop_iterate(u->thread_mainloop, 1, &ret) < 0) { if (ret == 0) goto finish; else goto fail; } if (u->new_data) read_new_samples(u); /* Run the rtpoll to process messages that other modules may have placed in the queue. */ pa_rtpoll_set_timer_relative(u->rtpoll, 0); if (pa_rtpoll_run(u->rtpoll) < 0) goto fail; } fail: /* send a message to the ctl thread to ask it to either terminate us, or * restart us, but either way this thread will exit, so then wait for the * shutdown message */ pa_asyncmsgq_post(u->thread_mq->outq, PA_MSGOBJECT(u->msg), TUNNEL_MESSAGE_MAYBE_RESTART, u, 0, NULL, NULL); pa_asyncmsgq_wait_for(u->thread_mq->inq, PA_MESSAGE_SHUTDOWN); finish: if (u->stream) { pa_stream_disconnect(u->stream); pa_stream_unref(u->stream); u->stream = NULL; } if (u->context) { pa_context_disconnect(u->context); pa_context_unref(u->context); u->context = NULL; } pa_log_debug("Thread shutting down"); } static void stream_state_cb(pa_stream *stream, void *userdata) { struct userdata *u = userdata; pa_assert(u); switch (pa_stream_get_state(stream)) { case PA_STREAM_FAILED: pa_log_error("Stream failed: %s", pa_strerror(pa_context_errno(u->context))); u->connected = false; u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); break; case PA_STREAM_TERMINATED: pa_log_debug("Stream terminated."); break; case PA_STREAM_READY: if (PA_SOURCE_IS_OPENED(u->source->thread_info.state)) cork_stream(u, false); /* Only call our requested_latency_cb when requested_latency * changed between PA_STREAM_CREATING -> PA_STREAM_READY, because * we don't want to override the initial fragsize set by the server * without a good reason. */ if (u->update_stream_bufferattr_after_connect) source_update_requested_latency_cb(u->source); case PA_STREAM_UNCONNECTED: case PA_STREAM_CREATING: break; } } /* Do a reinit of the module. Note that u will be freed as a result of this * call. */ static void maybe_restart(struct module_restart_data *rd) { struct userdata *u = rd->userdata; if (rd->restart_data) { pa_log_debug("Restart already pending"); return; } if (u->reconnect_interval_us > 0) { /* The handle returned here must be freed when do_init() finishes successfully * and when the module exits. */ rd->restart_data = pa_restart_module_reinit(u->module, do_init, do_done, u->reconnect_interval_us); } else { /* exit the module */ pa_module_unload_request(u->module, true); } } static void on_source_created(struct userdata *u) { pa_proplist *proplist; pa_buffer_attr bufferattr; pa_usec_t requested_latency; char *username = pa_get_user_name_malloc(); char *hostname = pa_get_host_name_malloc(); /* TODO: old tunnel put here the remote source_name into stream name e.g. 'Null Output for lynxis@lazus' */ char *stream_name = pa_sprintf_malloc(_("Tunnel for %s@%s"), username, hostname); pa_xfree(username); pa_xfree(hostname); pa_assert_io_context(); /* if we still don't have a source, then source creation failed, and we * should kill this io thread */ if (!u->source) { pa_log_error("Could not create a source."); u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); return; } proplist = tunnel_new_proplist(u); u->stream = pa_stream_new_with_proplist(u->context, stream_name, &u->source->sample_spec, &u->source->channel_map, proplist); pa_proplist_free(proplist); pa_xfree(stream_name); if (!u->stream) { pa_log_error("Could not create a stream: %s", pa_strerror(pa_context_errno(u->context))); u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); return; } requested_latency = pa_source_get_requested_latency_within_thread(u->source); if (requested_latency == (uint32_t) -1) requested_latency = u->source->thread_info.max_latency; reset_bufferattr(&bufferattr); bufferattr.fragsize = pa_usec_to_bytes(requested_latency, &u->source->sample_spec); pa_stream_set_state_callback(u->stream, stream_state_cb, u); pa_stream_set_read_callback(u->stream, stream_read_cb, u); if (pa_stream_connect_record(u->stream, u->remote_source_name, &bufferattr, PA_STREAM_INTERPOLATE_TIMING|PA_STREAM_DONT_MOVE|PA_STREAM_AUTO_TIMING_UPDATE|PA_STREAM_START_CORKED|PA_STREAM_ADJUST_LATENCY) < 0) { pa_log_debug("Could not create stream: %s", pa_strerror(pa_context_errno(u->context))); u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); } u->connected = true; } static void context_state_cb(pa_context *c, void *userdata) { struct userdata *u = userdata; pa_assert(u); switch (pa_context_get_state(c)) { case PA_CONTEXT_UNCONNECTED: case PA_CONTEXT_CONNECTING: case PA_CONTEXT_AUTHORIZING: case PA_CONTEXT_SETTING_NAME: break; case PA_CONTEXT_READY: pa_log_debug("Connection successful. Creating stream."); pa_assert(!u->stream); pa_assert(!u->source); pa_log_debug("Asking ctl thread to create source."); pa_asyncmsgq_post(u->thread_mq->outq, PA_MSGOBJECT(u->msg), TUNNEL_MESSAGE_CREATE_SOURCE_REQUEST, u, 0, NULL, NULL); break; case PA_CONTEXT_FAILED: pa_log_debug("Context failed with err %s.", pa_strerror(pa_context_errno(u->context))); u->connected = false; u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); break; case PA_CONTEXT_TERMINATED: pa_log_debug("Context terminated."); u->connected = false; u->thread_mainloop_api->quit(u->thread_mainloop_api, TUNNEL_THREAD_FAILED_MAINLOOP); break; } } static void source_update_requested_latency_cb(pa_source *s) { struct userdata *u; pa_operation *operation; size_t nbytes; pa_usec_t block_usec; pa_buffer_attr bufferattr; pa_source_assert_ref(s); pa_assert_se(u = s->userdata); block_usec = pa_source_get_requested_latency_within_thread(s); if (block_usec == (pa_usec_t) -1) block_usec = s->thread_info.max_latency; nbytes = pa_usec_to_bytes(block_usec, &s->sample_spec); if (u->stream) { switch (pa_stream_get_state(u->stream)) { case PA_STREAM_READY: if (pa_stream_get_buffer_attr(u->stream)->fragsize == nbytes) break; reset_bufferattr(&bufferattr); bufferattr.fragsize = nbytes; if ((operation = pa_stream_set_buffer_attr(u->stream, &bufferattr, NULL, NULL))) pa_operation_unref(operation); break; case PA_STREAM_CREATING: /* we have to delay our request until stream is ready */ u->update_stream_bufferattr_after_connect = true; break; default: break; } } } static int source_process_msg_cb(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) { struct userdata *u = PA_SOURCE(o)->userdata; switch (code) { case PA_SOURCE_MESSAGE_GET_LATENCY: { int negative; pa_usec_t remote_latency; if (!PA_SOURCE_IS_LINKED(u->source->thread_info.state)) { *((int64_t*) data) = 0; return 0; } if (!u->stream) { *((int64_t*) data) = 0; return 0; } if (pa_stream_get_state(u->stream) != PA_STREAM_READY) { *((int64_t*) data) = 0; return 0; } if (pa_stream_get_latency(u->stream, &remote_latency, &negative) < 0) { *((int64_t*) data) = 0; return 0; } if (negative) *((int64_t*) data) = - (int64_t)remote_latency; else *((int64_t*) data) = remote_latency; return 0; } case TUNNEL_MESSAGE_SOURCE_CREATED: on_source_created(u); return 0; } return pa_source_process_msg(o, code, data, offset, chunk); } /* Called from the IO thread. */ static int source_set_state_in_io_thread_cb(pa_source *s, pa_source_state_t new_state, pa_suspend_cause_t new_suspend_cause) { struct userdata *u; pa_assert(s); pa_assert_se(u = s->userdata); /* It may be that only the suspend cause is changing, in which case there's * nothing to do. */ if (new_state == s->thread_info.state) return 0; if (!u->stream || pa_stream_get_state(u->stream) != PA_STREAM_READY) return 0; switch (new_state) { case PA_SOURCE_SUSPENDED: { cork_stream(u, true); break; } case PA_SOURCE_IDLE: case PA_SOURCE_RUNNING: { cork_stream(u, false); break; } case PA_SOURCE_INVALID_STATE: case PA_SOURCE_INIT: case PA_SOURCE_UNLINKED: break; } return 0; } /* Creates a source in the main thread. * * This method is called when we receive a message from the io thread that a * connection has been established with the server. We defer creation of the * source until the connection is established, because we don't have a source * if the remote server isn't there. */ static void create_source(struct userdata *u) { pa_source_new_data source_data; pa_assert_ctl_context(); /* Create source */ pa_source_new_data_init(&source_data); source_data.driver = __FILE__; source_data.module = u->module; pa_source_new_data_set_name(&source_data, u->source_name); pa_source_new_data_set_sample_spec(&source_data, &u->sample_spec); pa_source_new_data_set_channel_map(&source_data, &u->channel_map); pa_proplist_update(source_data.proplist, PA_UPDATE_REPLACE, u->source_proplist); if (!(u->source = pa_source_new(u->module->core, &source_data, PA_SOURCE_LATENCY | PA_SOURCE_DYNAMIC_LATENCY | PA_SOURCE_NETWORK))) { pa_log("Failed to create source."); goto finish; } u->source->userdata = u; u->source->parent.process_msg = source_process_msg_cb; u->source->set_state_in_io_thread = source_set_state_in_io_thread_cb; u->source->update_requested_latency = source_update_requested_latency_cb; pa_source_set_asyncmsgq(u->source, u->thread_mq->inq); pa_source_set_rtpoll(u->source, u->rtpoll); pa_source_put(u->source); finish: pa_source_new_data_done(&source_data); /* tell any interested io threads that the sink they asked for has now been * created (even if we failed, we still notify the thread, so they can * either handle or kill the thread, rather than deadlock waiting for a * message that will never come */ pa_asyncmsgq_send(u->source->asyncmsgq, PA_MSGOBJECT(u->source), TUNNEL_MESSAGE_SOURCE_CREATED, u, 0, NULL); } /* Runs in PA mainloop context */ static int tunnel_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) { struct userdata *u = (struct userdata *) data; pa_assert(u); pa_assert_ctl_context(); if (u->shutting_down) return 0; switch (code) { case TUNNEL_MESSAGE_CREATE_SOURCE_REQUEST: create_source(u); break; case TUNNEL_MESSAGE_MAYBE_RESTART: maybe_restart(u->module->userdata); break; } return 0; } static int do_init(pa_module *m) { struct userdata *u = NULL; struct module_restart_data *rd; pa_modargs *ma = NULL; const char *remote_server = NULL; char *default_source_name = NULL; uint32_t reconnect_interval_ms = 0; pa_assert(m); pa_assert(m->userdata); rd = m->userdata; if (!(ma = pa_modargs_new(m->argument, valid_modargs))) { pa_log("Failed to parse module arguments."); goto fail; } u = pa_xnew0(struct userdata, 1); u->module = m; rd->userdata = u; u->sample_spec = m->core->default_sample_spec; u->channel_map = m->core->default_channel_map; if (pa_modargs_get_sample_spec_and_channel_map(ma, &u->sample_spec, &u->channel_map, PA_CHANNEL_MAP_DEFAULT) < 0) { pa_log("Invalid sample format specification or channel map"); goto fail; } remote_server = pa_modargs_get_value(ma, "server", NULL); if (!remote_server) { pa_log("No server given!"); goto fail; } u->remote_server = pa_xstrdup(remote_server); u->thread_mainloop = pa_mainloop_new(); if (u->thread_mainloop == NULL) { pa_log("Failed to create mainloop"); goto fail; } u->thread_mainloop_api = pa_mainloop_get_api(u->thread_mainloop); u->cookie_file = pa_xstrdup(pa_modargs_get_value(ma, "cookie", NULL)); u->remote_source_name = pa_xstrdup(pa_modargs_get_value(ma, "source", NULL)); u->thread_mq = pa_xnew0(pa_thread_mq, 1); if (pa_thread_mq_init_thread_mainloop(u->thread_mq, m->core->mainloop, u->thread_mainloop_api) < 0) { pa_log("pa_thread_mq_init_thread_mainloop() failed."); goto fail; } u->msg = pa_msgobject_new(tunnel_msg); u->msg->parent.process_msg = tunnel_process_msg; /* The rtpoll created here must curently only exist to avoid crashes when * the module is used together with module-loopback. Because module-loopback * runs pa_asyncmsgq_process_one() from the pop callback, the rtpoll need not * be run. We will do so anyway for potential modules similar to * module-combine-sink that use the rtpoll of the underlying source for * message exchange. */ u->rtpoll = pa_rtpoll_new(); default_source_name = pa_sprintf_malloc("tunnel-source-new.%s", remote_server); u->source_name = pa_xstrdup(pa_modargs_get_value(ma, "source_name", default_source_name)); u->source_proplist = pa_proplist_new(); pa_proplist_sets(u->source_proplist, PA_PROP_DEVICE_CLASS, "sound"); pa_proplist_setf(u->source_proplist, PA_PROP_DEVICE_DESCRIPTION, _("Tunnel to %s/%s"), remote_server, pa_strempty(u->remote_source_name)); if (pa_modargs_get_proplist(ma, "source_properties", u->source_proplist, PA_UPDATE_REPLACE) < 0) { pa_log("Invalid properties"); goto fail; } pa_modargs_get_value_u32(ma, "reconnect_interval_ms", &reconnect_interval_ms); u->reconnect_interval_us = reconnect_interval_ms * PA_USEC_PER_MSEC; if (!(u->thread = pa_thread_new("tunnel-source", thread_func, u))) { pa_log("Failed to create thread."); goto fail; } /* If the module is restarting and do_init() finishes successfully, the * restart data is no longer needed. If do_init() fails, don't touch the * restart data, because following restart attempts will continue to use * the same data. If restart_data is NULL, that means no restart is * currently pending. */ if (rd->restart_data) { pa_restart_free(rd->restart_data); rd->restart_data = NULL; } pa_modargs_free(ma); pa_xfree(default_source_name); return 0; fail: if (ma) pa_modargs_free(ma); if (default_source_name) pa_xfree(default_source_name); return -1; } static void do_done(pa_module *m) { struct userdata *u = NULL; struct module_restart_data *rd; pa_assert(m); if (!(rd = m->userdata)) return; if (!(u = rd->userdata)) return; u->shutting_down = true; if (u->source) pa_source_unlink(u->source); if (u->thread) { pa_asyncmsgq_send(u->thread_mq->inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL); pa_thread_free(u->thread); } if (u->thread_mq) { pa_thread_mq_done(u->thread_mq); pa_xfree(u->thread_mq); } if (u->thread_mainloop) pa_mainloop_free(u->thread_mainloop); if (u->cookie_file) pa_xfree(u->cookie_file); if (u->remote_source_name) pa_xfree(u->remote_source_name); if (u->remote_server) pa_xfree(u->remote_server); if (u->source) pa_source_unref(u->source); if (u->rtpoll) pa_rtpoll_free(u->rtpoll); if (u->source_proplist) pa_proplist_free(u->source_proplist); if (u->source_name) pa_xfree(u->source_name); pa_xfree(u->msg); pa_xfree(u); rd->userdata = NULL; } int pa__init(pa_module *m) { int ret; pa_assert(m); m->userdata = pa_xnew0(struct module_restart_data, 1); ret = do_init(m); if (ret < 0) pa__done(m); return ret; } void pa__done(pa_module *m) { pa_assert(m); do_done(m); if (m->userdata) { struct module_restart_data *rd = m->userdata; if (rd->restart_data) pa_restart_free(rd->restart_data); pa_xfree(m->userdata); } }