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
32 #include <sys/ioctl.h>
34 #ifdef HAVE_SYS_FILIO_H
35 #include <sys/filio.h>
38 #include <pulse/xmalloc.h>
40 #include <pulsecore/core-error.h>
41 #include <pulsecore/source.h>
42 #include <pulsecore/module.h>
43 #include <pulsecore/core-util.h>
44 #include <pulsecore/modargs.h>
45 #include <pulsecore/log.h>
46 #include <pulsecore/thread.h>
47 #include <pulsecore/thread-mq.h>
48 #include <pulsecore/rtpoll.h>
49 #include <pulsecore/poll.h>
51 #include "module-pipe-source-symdef.h"
53 PA_MODULE_AUTHOR("Lennart Poettering");
54 PA_MODULE_DESCRIPTION("UNIX pipe source");
55 PA_MODULE_VERSION(PACKAGE_VERSION);
56 PA_MODULE_LOAD_ONCE(FALSE);
58 "source_name=<name for the source> "
59 "source_properties=<properties for the source> "
60 "file=<path of the FIFO> "
61 "format=<sample format> "
63 "channels=<number of channels> "
64 "channel_map=<channel map>");
66 #define DEFAULT_FILE_NAME "/tmp/music.input"
67 #define DEFAULT_SOURCE_NAME "fifo_input"
75 pa_thread_mq thread_mq;
83 pa_rtpoll_item *rtpoll_item;
86 static const char* const valid_modargs[] = {
97 static int source_process_msg(
102 pa_memchunk *chunk) {
104 struct userdata *u = PA_SOURCE(o)->userdata;
108 case PA_SOURCE_MESSAGE_GET_LATENCY: {
114 if (ioctl(u->fd, FIONREAD, &l) >= 0 && l > 0)
118 *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->source->sample_spec);
123 return pa_source_process_msg(o, code, data, offset, chunk);
126 static void thread_func(void *userdata) {
127 struct userdata *u = userdata;
132 pa_log_debug("Thread starting up");
134 pa_thread_mq_install(&u->thread_mq);
138 struct pollfd *pollfd;
140 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
142 /* Try to read some data and pass it on to the source driver */
143 if (u->source->thread_info.state == PA_SOURCE_RUNNING && pollfd->revents) {
147 if (!u->memchunk.memblock) {
148 u->memchunk.memblock = pa_memblock_new(u->core->mempool, pa_pipe_buf(u->fd));
149 u->memchunk.index = u->memchunk.length = 0;
152 pa_assert(pa_memblock_get_length(u->memchunk.memblock) > u->memchunk.index);
154 p = pa_memblock_acquire(u->memchunk.memblock);
155 l = pa_read(u->fd, (uint8_t*) p + u->memchunk.index, pa_memblock_get_length(u->memchunk.memblock) - u->memchunk.index, &read_type);
156 pa_memblock_release(u->memchunk.memblock);
158 pa_assert(l != 0); /* EOF cannot happen, since we opened the fifo for both reading and writing */
164 else if (errno != EAGAIN) {
165 pa_log("Failed to read data from FIFO: %s", pa_cstrerror(errno));
171 u->memchunk.length = (size_t) l;
172 pa_source_post(u->source, &u->memchunk);
173 u->memchunk.index += (size_t) l;
175 if (u->memchunk.index >= pa_memblock_get_length(u->memchunk.memblock)) {
176 pa_memblock_unref(u->memchunk.memblock);
177 pa_memchunk_reset(&u->memchunk);
184 /* Hmm, nothing to do. Let's sleep */
185 pollfd->events = (short) (u->source->thread_info.state == PA_SOURCE_RUNNING ? POLLIN : 0);
187 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
193 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
195 if (pollfd->revents & ~POLLIN) {
196 pa_log("FIFO shutdown.");
202 /* If this was no regular exit from the loop we have to continue
203 * processing messages until we received PA_MESSAGE_SHUTDOWN */
204 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
205 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
208 pa_log_debug("Thread shutting down");
211 int pa__init(pa_module*m) {
217 struct pollfd *pollfd;
218 pa_source_new_data data;
222 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
223 pa_log("failed to parse module arguments.");
227 ss = m->core->default_sample_spec;
228 map = m->core->default_channel_map;
229 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
230 pa_log("invalid sample format specification or channel map");
234 m->userdata = u = pa_xnew0(struct userdata, 1);
237 pa_memchunk_reset(&u->memchunk);
238 u->rtpoll = pa_rtpoll_new();
239 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
241 u->filename = pa_runtime_path(pa_modargs_get_value(ma, "file", DEFAULT_FILE_NAME));
243 mkfifo(u->filename, 0666);
244 if ((u->fd = pa_open_cloexec(u->filename, O_RDWR, 0)) < 0) {
245 pa_log("open('%s'): %s", u->filename, pa_cstrerror(errno));
249 pa_make_fd_nonblock(u->fd);
251 if (fstat(u->fd, &st) < 0) {
252 pa_log("fstat('%s'): %s",u->filename, pa_cstrerror(errno));
256 if (!S_ISFIFO(st.st_mode)) {
257 pa_log("'%s' is not a FIFO.", u->filename);
261 pa_source_new_data_init(&data);
262 data.driver = __FILE__;
264 pa_source_new_data_set_name(&data, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME));
265 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->filename);
266 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Unix FIFO source %s", u->filename);
267 pa_source_new_data_set_sample_spec(&data, &ss);
268 pa_source_new_data_set_channel_map(&data, &map);
270 if (pa_modargs_get_proplist(ma, "source_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
271 pa_log("Invalid properties");
272 pa_source_new_data_done(&data);
276 u->source = pa_source_new(m->core, &data, PA_SOURCE_LATENCY);
277 pa_source_new_data_done(&data);
280 pa_log("Failed to create source.");
284 u->source->parent.process_msg = source_process_msg;
285 u->source->userdata = u;
287 pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
288 pa_source_set_rtpoll(u->source, u->rtpoll);
289 pa_source_set_fixed_latency(u->source, pa_bytes_to_usec(pa_pipe_buf(u->fd), &u->source->sample_spec));
291 u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
292 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
294 pollfd->events = pollfd->revents = 0;
296 if (!(u->thread = pa_thread_new("pipe-source", thread_func, u))) {
297 pa_log("Failed to create thread.");
301 pa_source_put(u->source);
316 int pa__get_n_used(pa_module *m) {
320 pa_assert_se(u = m->userdata);
322 return pa_source_linked_by(u->source);
325 void pa__done(pa_module*m) {
330 if (!(u = m->userdata))
334 pa_source_unlink(u->source);
337 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
338 pa_thread_free(u->thread);
341 pa_thread_mq_done(&u->thread_mq);
344 pa_source_unref(u->source);
346 if (u->memchunk.memblock)
347 pa_memblock_unref(u->memchunk.memblock);
350 pa_rtpoll_item_free(u->rtpoll_item);
353 pa_rtpoll_free(u->rtpoll);
357 pa_xfree(u->filename);
361 pa_assert_se(pa_close(u->fd) == 0);