Merge commit 'coling/lgpl21'
[profile/ivi/pulseaudio.git] / src / modules / module-pipe-sink.c
1 /***
2   This file is part of PulseAudio.
3
4   Copyright 2004-2006 Lennart Poettering
5
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.
10
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.
15
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
19   USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <stdlib.h>
27 #include <sys/stat.h>
28 #include <stdio.h>
29 #include <errno.h>
30 #include <string.h>
31 #include <fcntl.h>
32 #include <unistd.h>
33 #include <limits.h>
34 #include <sys/ioctl.h>
35 #include <poll.h>
36
37 #include <pulse/xmalloc.h>
38
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>
48
49 #include "module-pipe-sink-symdef.h"
50
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);
55 PA_MODULE_USAGE(
56         "sink_name=<name for the sink> "
57         "file=<path of the FIFO> "
58         "format=<sample format> "
59         "channels=<number of channels> "
60         "rate=<sample rate>"
61         "channel_map=<channel map>");
62
63 #define DEFAULT_FILE_NAME "fifo_output"
64 #define DEFAULT_SINK_NAME "fifo_output"
65
66 struct userdata {
67     pa_core *core;
68     pa_module *module;
69     pa_sink *sink;
70
71     pa_thread *thread;
72     pa_thread_mq thread_mq;
73     pa_rtpoll *rtpoll;
74
75     char *filename;
76     int fd;
77
78     pa_memchunk memchunk;
79
80     pa_rtpoll_item *rtpoll_item;
81
82     int write_type;
83 };
84
85 static const char* const valid_modargs[] = {
86     "file",
87     "rate",
88     "format",
89     "channels",
90     "sink_name",
91     "channel_map",
92     NULL
93 };
94
95 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
96     struct userdata *u = PA_SINK(o)->userdata;
97
98     switch (code) {
99
100         case PA_SINK_MESSAGE_GET_LATENCY: {
101             size_t n = 0;
102             int l;
103
104 #ifdef FIONREAD
105             if (ioctl(u->fd, FIONREAD, &l) >= 0 && l > 0)
106                 n = (size_t) l;
107 #endif
108
109             n += u->memchunk.length;
110
111             *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->sink->sample_spec);
112             return 0;
113         }
114     }
115
116     return pa_sink_process_msg(o, code, data, offset, chunk);
117 }
118
119 static int process_render(struct userdata *u) {
120     pa_assert(u);
121
122     if (u->memchunk.length <= 0)
123         pa_sink_render(u->sink, PIPE_BUF, &u->memchunk);
124
125     pa_assert(u->memchunk.length > 0);
126
127     for (;;) {
128         ssize_t l;
129         void *p;
130
131         p = pa_memblock_acquire(u->memchunk.memblock);
132         l = pa_write(u->fd, (uint8_t*) p + u->memchunk.index, u->memchunk.length, &u->write_type);
133         pa_memblock_release(u->memchunk.memblock);
134
135         pa_assert(l != 0);
136
137         if (l < 0) {
138
139             if (errno == EINTR)
140                 continue;
141             else if (errno == EAGAIN)
142                 return 0;
143             else {
144                 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
145                 return -1;
146             }
147
148         } else {
149
150             u->memchunk.index += (size_t) l;
151             u->memchunk.length -= (size_t) l;
152
153             if (u->memchunk.length <= 0) {
154                 pa_memblock_unref(u->memchunk.memblock);
155                 pa_memchunk_reset(&u->memchunk);
156             }
157         }
158
159         return 0;
160     }
161 }
162
163 static void thread_func(void *userdata) {
164     struct userdata *u = userdata;
165
166     pa_assert(u);
167
168     pa_log_debug("Thread starting up");
169
170     pa_thread_mq_install(&u->thread_mq);
171     pa_rtpoll_install(u->rtpoll);
172
173     for (;;) {
174         struct pollfd *pollfd;
175         int ret;
176
177         pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
178
179         /* Render some data and write it to the fifo */
180         if (PA_SINK_IS_OPENED(u->sink->thread_info.state)) {
181
182             if (u->sink->thread_info.rewind_requested)
183                 pa_sink_process_rewind(u->sink, 0);
184
185             if (pollfd->revents) {
186                 if (process_render(u) < 0)
187                     goto fail;
188
189                 pollfd->revents = 0;
190             }
191         }
192
193         /* Hmm, nothing to do. Let's sleep */
194         pollfd->events = (short) (u->sink->thread_info.state == PA_SINK_RUNNING ? POLLOUT : 0);
195
196         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
197             goto fail;
198
199         if (ret == 0)
200             goto finish;
201
202         pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
203
204         if (pollfd->revents & ~POLLOUT) {
205             pa_log("FIFO shutdown.");
206             goto fail;
207         }
208     }
209
210 fail:
211     /* If this was no regular exit from the loop we have to continue
212      * processing messages until we received PA_MESSAGE_SHUTDOWN */
213     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
214     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
215
216 finish:
217     pa_log_debug("Thread shutting down");
218 }
219
220 int pa__init(pa_module*m) {
221     struct userdata *u;
222     struct stat st;
223     pa_sample_spec ss;
224     pa_channel_map map;
225     pa_modargs *ma;
226     struct pollfd *pollfd;
227     pa_sink_new_data data;
228
229     pa_assert(m);
230
231     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
232         pa_log("Failed to parse module arguments.");
233         goto fail;
234     }
235
236     ss = m->core->default_sample_spec;
237     map = m->core->default_channel_map;
238     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
239         pa_log("Invalid sample format specification or channel map");
240         goto fail;
241     }
242
243     u = pa_xnew0(struct userdata, 1);
244     u->core = m->core;
245     u->module = m;
246     m->userdata = u;
247     pa_memchunk_reset(&u->memchunk);
248     u->rtpoll = pa_rtpoll_new();
249     pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
250     u->write_type = 0;
251
252     u->filename = pa_runtime_path(pa_modargs_get_value(ma, "file", DEFAULT_FILE_NAME));
253
254     mkfifo(u->filename, 0666);
255     if ((u->fd = open(u->filename, O_RDWR|O_NOCTTY)) < 0) {
256         pa_log("open('%s'): %s", u->filename, pa_cstrerror(errno));
257         goto fail;
258     }
259
260     pa_make_fd_cloexec(u->fd);
261     pa_make_fd_nonblock(u->fd);
262
263     if (fstat(u->fd, &st) < 0) {
264         pa_log("fstat('%s'): %s", u->filename, pa_cstrerror(errno));
265         goto fail;
266     }
267
268     if (!S_ISFIFO(st.st_mode)) {
269         pa_log("'%s' is not a FIFO.", u->filename);
270         goto fail;
271     }
272
273     pa_sink_new_data_init(&data);
274     data.driver = __FILE__;
275     data.module = m;
276     pa_sink_new_data_set_name(&data, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME));
277     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->filename);
278     pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Unix FIFO sink %s", u->filename);
279     pa_sink_new_data_set_sample_spec(&data, &ss);
280     pa_sink_new_data_set_channel_map(&data, &map);
281
282     u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY);
283     pa_sink_new_data_done(&data);
284
285     if (!u->sink) {
286         pa_log("Failed to create sink.");
287         goto fail;
288     }
289
290     u->sink->parent.process_msg = sink_process_msg;
291     u->sink->userdata = u;
292
293     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
294     pa_sink_set_rtpoll(u->sink, u->rtpoll);
295
296     u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
297     pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
298     pollfd->fd = u->fd;
299     pollfd->events = pollfd->revents = 0;
300
301     if (!(u->thread = pa_thread_new(thread_func, u))) {
302         pa_log("Failed to create thread.");
303         goto fail;
304     }
305
306     pa_sink_put(u->sink);
307
308     pa_modargs_free(ma);
309
310     return 0;
311
312 fail:
313     if (ma)
314         pa_modargs_free(ma);
315
316     pa__done(m);
317
318     return -1;
319 }
320
321 int pa__get_n_used(pa_module *m) {
322     struct userdata *u;
323
324     pa_assert(m);
325     pa_assert_se(u = m->userdata);
326
327     return pa_sink_linked_by(u->sink);
328 }
329
330 void pa__done(pa_module*m) {
331     struct userdata *u;
332
333     pa_assert(m);
334
335     if (!(u = m->userdata))
336         return;
337
338     if (u->sink)
339         pa_sink_unlink(u->sink);
340
341     if (u->thread) {
342         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
343         pa_thread_free(u->thread);
344     }
345
346     pa_thread_mq_done(&u->thread_mq);
347
348     if (u->sink)
349         pa_sink_unref(u->sink);
350
351     if (u->memchunk.memblock)
352        pa_memblock_unref(u->memchunk.memblock);
353
354     if (u->rtpoll_item)
355         pa_rtpoll_item_free(u->rtpoll_item);
356
357     if (u->rtpoll)
358         pa_rtpoll_free(u->rtpoll);
359
360     if (u->filename) {
361         unlink(u->filename);
362         pa_xfree(u->filename);
363     }
364
365     if (u->fd >= 0)
366         pa_assert_se(pa_close(u->fd) == 0);
367
368     pa_xfree(u);
369 }