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/sink.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-sink-symdef.h"
51 PA_MODULE_AUTHOR("Lennart Poettering");
52 PA_MODULE_DESCRIPTION("UNIX pipe sink");
53 PA_MODULE_VERSION(PACKAGE_VERSION
);
54 PA_MODULE_LOAD_ONCE(FALSE
);
56 "sink_name=<name for the sink> "
57 "sink_properties=<properties for the sink> "
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 "fifo_output"
65 #define DEFAULT_SINK_NAME "fifo_output"
73 pa_thread_mq thread_mq
;
81 pa_rtpoll_item
*rtpoll_item
;
86 static const char* const valid_modargs
[] = {
97 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
98 struct userdata
*u
= PA_SINK(o
)->userdata
;
102 case PA_SINK_MESSAGE_GET_LATENCY
: {
107 if (ioctl(u
->fd
, FIONREAD
, &l
) >= 0 && l
> 0)
111 n
+= u
->memchunk
.length
;
113 *((pa_usec_t
*) data
) = pa_bytes_to_usec(n
, &u
->sink
->sample_spec
);
118 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
121 static int process_render(struct userdata
*u
) {
124 if (u
->memchunk
.length
<= 0)
125 pa_sink_render(u
->sink
, pa_pipe_buf(u
->fd
), &u
->memchunk
);
127 pa_assert(u
->memchunk
.length
> 0);
133 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
134 l
= pa_write(u
->fd
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
, &u
->write_type
);
135 pa_memblock_release(u
->memchunk
.memblock
);
143 else if (errno
== EAGAIN
)
146 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno
));
152 u
->memchunk
.index
+= (size_t) l
;
153 u
->memchunk
.length
-= (size_t) l
;
155 if (u
->memchunk
.length
<= 0) {
156 pa_memblock_unref(u
->memchunk
.memblock
);
157 pa_memchunk_reset(&u
->memchunk
);
165 static void thread_func(void *userdata
) {
166 struct userdata
*u
= userdata
;
170 pa_log_debug("Thread starting up");
172 pa_thread_mq_install(&u
->thread_mq
);
175 struct pollfd
*pollfd
;
178 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
180 /* Render some data and write it to the fifo */
181 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
)) {
183 if (u
->sink
->thread_info
.rewind_requested
)
184 pa_sink_process_rewind(u
->sink
, 0);
186 if (pollfd
->revents
) {
187 if (process_render(u
) < 0)
194 /* Hmm, nothing to do. Let's sleep */
195 pollfd
->events
= (short) (u
->sink
->thread_info
.state
== PA_SINK_RUNNING
? POLLOUT
: 0);
197 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
203 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
205 if (pollfd
->revents
& ~POLLOUT
) {
206 pa_log("FIFO shutdown.");
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
);
218 pa_log_debug("Thread shutting down");
221 int pa__init(pa_module
*m
) {
227 struct pollfd
*pollfd
;
228 pa_sink_new_data data
;
232 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
233 pa_log("Failed to parse module arguments.");
237 ss
= m
->core
->default_sample_spec
;
238 map
= m
->core
->default_channel_map
;
239 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
240 pa_log("Invalid sample format specification or channel map");
244 u
= pa_xnew0(struct userdata
, 1);
248 pa_memchunk_reset(&u
->memchunk
);
249 u
->rtpoll
= pa_rtpoll_new();
250 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
253 u
->filename
= pa_runtime_path(pa_modargs_get_value(ma
, "file", DEFAULT_FILE_NAME
));
255 mkfifo(u
->filename
, 0666);
256 if ((u
->fd
= open(u
->filename
, O_RDWR
|O_NOCTTY
)) < 0) {
257 pa_log("open('%s'): %s", u
->filename
, pa_cstrerror(errno
));
261 pa_make_fd_cloexec(u
->fd
);
262 pa_make_fd_nonblock(u
->fd
);
264 if (fstat(u
->fd
, &st
) < 0) {
265 pa_log("fstat('%s'): %s", u
->filename
, pa_cstrerror(errno
));
269 if (!S_ISFIFO(st
.st_mode
)) {
270 pa_log("'%s' is not a FIFO.", u
->filename
);
274 pa_sink_new_data_init(&data
);
275 data
.driver
= __FILE__
;
277 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
278 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->filename
);
279 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Unix FIFO sink %s", u
->filename
);
280 pa_sink_new_data_set_sample_spec(&data
, &ss
);
281 pa_sink_new_data_set_channel_map(&data
, &map
);
283 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
284 pa_log("Invalid properties");
285 pa_sink_new_data_done(&data
);
289 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
);
290 pa_sink_new_data_done(&data
);
293 pa_log("Failed to create sink.");
297 u
->sink
->parent
.process_msg
= sink_process_msg
;
298 u
->sink
->userdata
= u
;
300 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
301 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
302 pa_sink_set_max_request(u
->sink
, pa_pipe_buf(u
->fd
));
303 pa_sink_set_fixed_latency(u
->sink
, pa_bytes_to_usec(pa_pipe_buf(u
->fd
), &u
->sink
->sample_spec
));
305 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
306 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
308 pollfd
->events
= pollfd
->revents
= 0;
310 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
311 pa_log("Failed to create thread.");
315 pa_sink_put(u
->sink
);
330 int pa__get_n_used(pa_module
*m
) {
334 pa_assert_se(u
= m
->userdata
);
336 return pa_sink_linked_by(u
->sink
);
339 void pa__done(pa_module
*m
) {
344 if (!(u
= m
->userdata
))
348 pa_sink_unlink(u
->sink
);
351 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
352 pa_thread_free(u
->thread
);
355 pa_thread_mq_done(&u
->thread_mq
);
358 pa_sink_unref(u
->sink
);
360 if (u
->memchunk
.memblock
)
361 pa_memblock_unref(u
->memchunk
.memblock
);
364 pa_rtpoll_item_free(u
->rtpoll_item
);
367 pa_rtpoll_free(u
->rtpoll
);
371 pa_xfree(u
->filename
);
375 pa_assert_se(pa_close(u
->fd
) == 0);