make use of pa_thread_mq everywhere
[profile/ivi/pulseaudio.git] / src / modules / module-pipe-sink.c
1 /* $Id$ */
2
3 /***
4   This file is part of PulseAudio.
5
6   Copyright 2004-2006 Lennart Poettering
7
8   PulseAudio is free software; you can redistribute it and/or modify
9   it under the terms of the GNU Lesser General Public License as published
10   by the Free Software Foundation; either version 2 of the License,
11   or (at your option) any later version.
12
13   PulseAudio is distributed in the hope that it will be useful, but
14   WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   General Public License for more details.
17
18   You should have received a copy of the GNU Lesser General Public License
19   along with PulseAudio; if not, write to the Free Software
20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21   USA.
22 ***/
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <stdlib.h>
29 #include <sys/stat.h>
30 #include <stdio.h>
31 #include <errno.h>
32 #include <string.h>
33 #include <fcntl.h>
34 #include <unistd.h>
35 #include <limits.h>
36 #include <sys/ioctl.h>
37 #include <sys/poll.h>
38
39 #include <pulse/xmalloc.h>
40
41 #include <pulsecore/core-error.h>
42 #include <pulsecore/sink.h>
43 #include <pulsecore/module.h>
44 #include <pulsecore/core-util.h>
45 #include <pulsecore/modargs.h>
46 #include <pulsecore/log.h>
47 #include <pulsecore/thread.h>
48 #include <pulsecore/thread-mq.h>
49
50 #include "module-pipe-sink-symdef.h"
51
52 PA_MODULE_AUTHOR("Lennart Poettering")
53 PA_MODULE_DESCRIPTION("UNIX pipe sink")
54 PA_MODULE_VERSION(PACKAGE_VERSION)
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 "/tmp/music.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     pa_thread *thread;
71     pa_thread_mq thread_mq;
72     char *filename;
73     int fd;
74
75     pa_memchunk memchunk;
76 };
77
78 static const char* const valid_modargs[] = {
79     "file",
80     "rate",
81     "format",
82     "channels",
83     "sink_name",
84     "channel_map",
85     NULL
86 };
87
88 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
89     struct userdata *u = PA_SINK(o)->userdata;
90
91     switch (code) {
92             
93         case PA_SINK_MESSAGE_GET_LATENCY: {
94             size_t n = 0;
95             int l;
96             
97             if (ioctl(u->fd, TIOCINQ, &l) >= 0 && l > 0)
98                 n = (size_t) l;
99             
100             n += u->memchunk.length;
101             
102             *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->sink->sample_spec);
103             break;
104         }
105     }
106     
107     return pa_sink_process_msg(o, code, data, offset, chunk);
108 }
109
110 static void thread_func(void *userdata) {
111     enum {
112         POLLFD_ASYNCQ,
113         POLLFD_FIFO,
114         POLLFD_MAX,
115     };
116     
117     struct userdata *u = userdata;
118     struct pollfd pollfd[POLLFD_MAX];
119     int write_type = 0;
120
121     pa_assert(u);
122
123     pa_log_debug("Thread starting up");
124
125     pa_thread_mq_install(&u->thread_mq);
126
127     memset(&pollfd, 0, sizeof(pollfd));
128     
129     pollfd[POLLFD_ASYNCQ].fd = pa_asyncmsgq_get_fd(u->thread_mq.inq);
130     pollfd[POLLFD_ASYNCQ].events = POLLIN;
131     pollfd[POLLFD_FIFO].fd = u->fd;
132
133     for (;;) {
134         pa_msgobject *object;
135         int code;
136         void *data;
137         pa_memchunk chunk;
138         int r;
139         int64_t offset;
140
141         /* Check whether there is a message for us to process */
142         if (pa_asyncmsgq_get(u->thread_mq.inq, &object, &code, &data, &offset, &chunk, 0) == 0) {
143             int ret;
144
145             if (!object && code == PA_MESSAGE_SHUTDOWN) {
146                 pa_asyncmsgq_done(u->thread_mq.inq, 0);
147                 goto finish;
148             }
149
150             ret = pa_asyncmsgq_dispatch(object, code, data, offset, &chunk);
151             pa_asyncmsgq_done(u->thread_mq.inq, ret);
152             continue;
153         }
154
155         /* Render some data and write it to the fifo */
156
157         if (u->sink->thread_info.state == PA_SINK_RUNNING && pollfd[POLLFD_FIFO].revents) {
158             ssize_t l;
159             void *p;
160
161             if (u->memchunk.length <= 0)
162                 pa_sink_render(u->sink, PIPE_BUF, &u->memchunk);
163
164             pa_assert(u->memchunk.length > 0);
165
166             p = pa_memblock_acquire(u->memchunk.memblock);
167             l = pa_write(u->fd, (uint8_t*) p + u->memchunk.index, u->memchunk.length, &write_type);
168             pa_memblock_release(u->memchunk.memblock);
169
170             pa_assert(l != 0);
171
172             if (l < 0) {
173
174                 if (errno == EINTR)
175                     continue;
176                 else if (errno != EAGAIN) {
177                     pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
178                     goto fail;
179                 }
180
181             } else {
182
183                 u->memchunk.index += l;
184                 u->memchunk.length -= l;
185
186                 if (u->memchunk.length <= 0) {
187                     pa_memblock_unref(u->memchunk.memblock);
188                     pa_memchunk_reset(&u->memchunk);
189                 }
190
191                 pollfd[POLLFD_FIFO].revents = 0;
192                 continue;
193             }
194         }
195
196         pollfd[POLLFD_FIFO].events = u->sink->thread_info.state == PA_SINK_RUNNING ? POLLOUT : 0;
197
198         /* Hmm, nothing to do. Let's sleep */
199
200         if (pa_asyncmsgq_before_poll(u->thread_mq.inq) < 0)
201             continue;
202
203 /*         pa_log("polling for %u", pollfd[POLLFD_FIFO].events);  */
204         r = poll(pollfd, POLLFD_MAX, -1);
205 /*         pa_log("polling got %u", r > 0 ? pollfd[POLLFD_FIFO].revents : 0);  */
206
207         pa_asyncmsgq_after_poll(u->thread_mq.inq);
208
209         if (r < 0) {
210             if (errno == EINTR) {
211                 pollfd[POLLFD_ASYNCQ].revents = 0;
212                 pollfd[POLLFD_FIFO].revents = 0;
213                 continue;
214             }
215
216             pa_log("poll() failed: %s", pa_cstrerror(errno));
217             goto fail;
218         }
219
220         if (pollfd[POLLFD_FIFO].revents & ~POLLOUT) {
221             pa_log("FIFO shutdown.");
222             goto fail;
223         }
224
225         pa_assert((pollfd[POLLFD_ASYNCQ].revents & ~POLLIN) == 0);
226     }
227
228 fail:
229     /* We have to continue processing messages until we receive the
230      * SHUTDOWN message */
231     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
232     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
233
234 finish:
235     pa_log_debug("Thread shutting down");
236 }
237
238 int pa__init(pa_module*m) {
239     struct userdata *u;
240     struct stat st;
241     pa_sample_spec ss;
242     pa_channel_map map;
243     pa_modargs *ma;
244     char *t;
245
246     pa_assert(m);
247
248     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
249         pa_log("Failed to parse module arguments.");
250         goto fail;
251     }
252
253     ss = m->core->default_sample_spec;
254     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
255         pa_log("Invalid sample format specification or channel map");
256         goto fail;
257     }
258
259     u = pa_xnew0(struct userdata, 1);
260     u->core = m->core;
261     u->module = m;
262     m->userdata = u;
263     pa_memchunk_reset(&u->memchunk);
264     pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
265     
266     u->filename = pa_xstrdup(pa_modargs_get_value(ma, "file", DEFAULT_FILE_NAME));
267
268     mkfifo(u->filename, 0666);
269     if ((u->fd = open(u->filename, O_RDWR|O_NOCTTY)) < 0) {
270         pa_log("open('%s'): %s", u->filename, pa_cstrerror(errno));
271         goto fail;
272     }
273
274     pa_fd_set_cloexec(u->fd, 1);
275     pa_make_nonblock_fd(u->fd);
276
277     if (fstat(u->fd, &st) < 0) {
278         pa_log("fstat('%s'): %s", u->filename, pa_cstrerror(errno));
279         goto fail;
280     }
281
282     if (!S_ISFIFO(st.st_mode)) {
283         pa_log("'%s' is not a FIFO.", u->filename);
284         goto fail;
285     }
286
287     if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
288         pa_log("Failed to create sink.");
289         goto fail;
290     }
291
292     u->sink->parent.process_msg = sink_process_msg;
293     u->sink->userdata = u;
294     
295     pa_sink_set_module(u->sink, m);
296     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
297     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Unix FIFO sink '%s'", u->filename));
298     pa_xfree(t);
299
300     if (!(u->thread = pa_thread_new(thread_func, u))) {
301         pa_log("Failed to create thread.");
302         goto fail;
303     }
304
305     pa_modargs_free(ma);
306
307     return 0;
308
309 fail:
310     if (ma)
311         pa_modargs_free(ma);
312
313     pa__done(m);
314
315     return -1;
316 }
317
318 void pa__done(pa_module*m) {
319     struct userdata *u;
320     
321     pa_assert(m);
322
323     if (!(u = m->userdata))
324         return;
325
326     if (u->sink)
327         pa_sink_disconnect(u->sink);
328
329     if (u->thread) {
330         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
331         pa_thread_free(u->thread);
332     }
333
334     pa_thread_mq_done(&u->thread_mq);
335     
336     if (u->sink)
337         pa_sink_unref(u->sink);
338
339     if (u->memchunk.memblock)
340        pa_memblock_unref(u->memchunk.memblock);
341
342     if (u->filename) {
343         unlink(u->filename);
344         pa_xfree(u->filename);
345     }
346
347     if (u->fd >= 0)
348         close(u->fd);
349
350     pa_xfree(u);
351 }