2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
6 PulseAudio 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.1 of the License,
9 or (at your option) any later version.
11 PulseAudio 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.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
34 #include <sys/ioctl.h>
37 #include <pulse/xmalloc.h>
39 #include <pulsecore/core-error.h>
40 #include <pulsecore/source.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/core-util.h>
43 #include <pulsecore/modargs.h>
44 #include <pulsecore/log.h>
45 #include <pulsecore/thread.h>
46 #include <pulsecore/thread-mq.h>
47 #include <pulsecore/rtpoll.h>
49 #include "module-pipe-source-symdef.h"
51 PA_MODULE_AUTHOR("Lennart Poettering");
52 PA_MODULE_DESCRIPTION("UNIX pipe source");
53 PA_MODULE_VERSION(PACKAGE_VERSION);
54 PA_MODULE_LOAD_ONCE(FALSE);
56 "source_name=<name for the source> "
57 "source_properties=<properties for the source> "
58 "file=<path of the FIFO> "
59 "format=<sample format> "
61 "channels=<number of channels> "
62 "channel_map=<channel map>");
64 #define DEFAULT_FILE_NAME "/tmp/music.input"
65 #define DEFAULT_SOURCE_NAME "fifo_input"
73 pa_thread_mq thread_mq;
81 pa_rtpoll_item *rtpoll_item;
84 static const char* const valid_modargs[] = {
95 static int source_process_msg(
100 pa_memchunk *chunk) {
102 struct userdata *u = PA_SOURCE(o)->userdata;
106 case PA_SOURCE_MESSAGE_GET_LATENCY: {
112 if (ioctl(u->fd, FIONREAD, &l) >= 0 && l > 0)
116 *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->source->sample_spec);
121 return pa_source_process_msg(o, code, data, offset, chunk);
124 static void thread_func(void *userdata) {
125 struct userdata *u = userdata;
130 pa_log_debug("Thread starting up");
132 pa_thread_mq_install(&u->thread_mq);
136 struct pollfd *pollfd;
138 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
140 /* Try to read some data and pass it on to the source driver */
141 if (u->source->thread_info.state == PA_SOURCE_RUNNING && pollfd->revents) {
145 if (!u->memchunk.memblock) {
146 u->memchunk.memblock = pa_memblock_new(u->core->mempool, pa_pipe_buf(u->fd));
147 u->memchunk.index = u->memchunk.length = 0;
150 pa_assert(pa_memblock_get_length(u->memchunk.memblock) > u->memchunk.index);
152 p = pa_memblock_acquire(u->memchunk.memblock);
153 l = pa_read(u->fd, (uint8_t*) p + u->memchunk.index, pa_memblock_get_length(u->memchunk.memblock) - u->memchunk.index, &read_type);
154 pa_memblock_release(u->memchunk.memblock);
156 pa_assert(l != 0); /* EOF cannot happen, since we opened the fifo for both reading and writing */
162 else if (errno != EAGAIN) {
163 pa_log("Faile to read data from FIFO: %s", pa_cstrerror(errno));
169 u->memchunk.length = (size_t) l;
170 pa_source_post(u->source, &u->memchunk);
171 u->memchunk.index += (size_t) l;
173 if (u->memchunk.index >= pa_memblock_get_length(u->memchunk.memblock)) {
174 pa_memblock_unref(u->memchunk.memblock);
175 pa_memchunk_reset(&u->memchunk);
182 /* Hmm, nothing to do. Let's sleep */
183 pollfd->events = (short) (u->source->thread_info.state == PA_SOURCE_RUNNING ? POLLIN : 0);
185 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
191 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
193 if (pollfd->revents & ~POLLIN) {
194 pa_log("FIFO shutdown.");
200 /* If this was no regular exit from the loop we have to continue
201 * processing messages until we received PA_MESSAGE_SHUTDOWN */
202 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
203 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
206 pa_log_debug("Thread shutting down");
209 int pa__init(pa_module*m) {
215 struct pollfd *pollfd;
216 pa_source_new_data data;
220 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
221 pa_log("failed to parse module arguments.");
225 ss = m->core->default_sample_spec;
226 map = m->core->default_channel_map;
227 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
228 pa_log("invalid sample format specification or channel map");
232 m->userdata = u = pa_xnew0(struct userdata, 1);
235 pa_memchunk_reset(&u->memchunk);
236 u->rtpoll = pa_rtpoll_new();
237 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
239 u->filename = pa_runtime_path(pa_modargs_get_value(ma, "file", DEFAULT_FILE_NAME));
241 mkfifo(u->filename, 0666);
242 if ((u->fd = pa_open_cloexec(u->filename, O_RDWR, 0)) < 0) {
243 pa_log("open('%s'): %s", u->filename, pa_cstrerror(errno));
247 pa_make_fd_nonblock(u->fd);
249 if (fstat(u->fd, &st) < 0) {
250 pa_log("fstat('%s'): %s",u->filename, pa_cstrerror(errno));
254 if (!S_ISFIFO(st.st_mode)) {
255 pa_log("'%s' is not a FIFO.", u->filename);
259 pa_source_new_data_init(&data);
260 data.driver = __FILE__;
262 pa_source_new_data_set_name(&data, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME));
263 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->filename);
264 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Unix FIFO source %s", u->filename);
265 pa_source_new_data_set_sample_spec(&data, &ss);
266 pa_source_new_data_set_channel_map(&data, &map);
268 if (pa_modargs_get_proplist(ma, "source_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
269 pa_log("Invalid properties");
270 pa_source_new_data_done(&data);
274 u->source = pa_source_new(m->core, &data, PA_SOURCE_LATENCY);
275 pa_source_new_data_done(&data);
278 pa_log("Failed to create source.");
282 u->source->parent.process_msg = source_process_msg;
283 u->source->userdata = u;
285 pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
286 pa_source_set_rtpoll(u->source, u->rtpoll);
287 pa_source_set_fixed_latency(u->source, pa_bytes_to_usec(PIPE_BUF, &u->source->sample_spec));
289 u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
290 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
292 pollfd->events = pollfd->revents = 0;
294 if (!(u->thread = pa_thread_new(thread_func, u))) {
295 pa_log("Failed to create thread.");
299 pa_source_put(u->source);
314 int pa__get_n_used(pa_module *m) {
318 pa_assert_se(u = m->userdata);
320 return pa_source_linked_by(u->source);
323 void pa__done(pa_module*m) {
328 if (!(u = m->userdata))
332 pa_source_unlink(u->source);
335 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
336 pa_thread_free(u->thread);
339 pa_thread_mq_done(&u->thread_mq);
342 pa_source_unref(u->source);
344 if (u->memchunk.memblock)
345 pa_memblock_unref(u->memchunk.memblock);
348 pa_rtpoll_item_free(u->rtpoll_item);
351 pa_rtpoll_free(u->rtpoll);
355 pa_xfree(u->filename);
359 pa_assert_se(pa_close(u->fd) == 0);