4 This file is part of PulseAudio.
6 Copyright 2008 Colin Guthrie
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.
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.
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
37 #include <sys/socket.h>
38 #include <netinet/in.h>
39 #include <netinet/tcp.h>
40 #include <sys/ioctl.h>
42 #ifdef HAVE_LINUX_SOCKIOS_H
43 #include <linux/sockios.h>
46 #include <pulse/xmalloc.h>
47 #include <pulse/timeval.h>
49 #include <pulsecore/core-error.h>
50 #include <pulsecore/iochannel.h>
51 #include <pulsecore/sink.h>
52 #include <pulsecore/module.h>
53 #include <pulsecore/core-util.h>
54 #include <pulsecore/modargs.h>
55 #include <pulsecore/log.h>
56 #include <pulsecore/socket-client.h>
57 #include <pulsecore/authkey.h>
58 #include <pulsecore/thread-mq.h>
59 #include <pulsecore/thread.h>
60 #include <pulsecore/time-smoother.h>
61 #include <pulsecore/rtclock.h>
62 #include <pulsecore/socket-util.h>
64 #include "module-raop-sink-symdef.h"
68 #include "raop_client.h"
70 PA_MODULE_AUTHOR("Colin Guthrie");
71 PA_MODULE_DESCRIPTION("RAOP Sink (Apple Airtunes)");
72 PA_MODULE_VERSION(PACKAGE_VERSION);
73 PA_MODULE_LOAD_ONCE(FALSE);
75 "sink_name=<name for the sink> "
76 "server=<address> cookie=<filename> "
77 "format=<sample format> "
78 "channels=<number of channels> "
79 "rate=<sample rate>");
81 #define DEFAULT_SINK_NAME "airtunes"
88 pa_thread_mq thread_mq;
90 pa_rtpoll_item *rtpoll_item;
93 pa_memchunk raw_memchunk;
94 pa_memchunk encoded_memchunk;
97 size_t write_length, write_index;
100 size_t read_length, read_index;
104 /*esd_format_t format;*/
107 pa_smoother *smoother;
111 int64_t encoding_overhead;
112 double encoding_ratio;
114 pa_raop_client *raop;
119 static const char* const valid_modargs[] = {
129 SINK_MESSAGE_PASS_SOCKET = PA_SINK_MESSAGE_MAX
132 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
133 struct userdata *u = PA_SINK(o)->userdata;
137 case PA_SINK_MESSAGE_SET_STATE:
139 switch ((pa_sink_state_t) PA_PTR_TO_UINT(data)) {
141 case PA_SINK_SUSPENDED:
142 pa_assert(PA_SINK_OPENED(u->sink->thread_info.state));
144 pa_smoother_pause(u->smoother, pa_rtclock_usec());
148 case PA_SINK_RUNNING:
150 if (u->sink->thread_info.state == PA_SINK_SUSPENDED)
151 pa_smoother_resume(u->smoother, pa_rtclock_usec());
155 case PA_SINK_UNLINKED:
162 case PA_SINK_MESSAGE_GET_LATENCY: {
165 r = pa_smoother_get(u->smoother, pa_rtclock_usec());
166 w = pa_bytes_to_usec((u->offset - u->encoding_overhead + (u->encoded_memchunk.length / u->encoding_ratio)), &u->sink->sample_spec);
168 *((pa_usec_t*) data) = w > r ? w - r : 0;
172 case SINK_MESSAGE_PASS_SOCKET: {
173 struct pollfd *pollfd;
175 pa_assert(!u->rtpoll_item);
177 u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
178 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
180 pollfd->events = pollfd->revents = 0;
186 return pa_sink_process_msg(o, code, data, offset, chunk);
189 static void thread_func(void *userdata) {
190 struct userdata *u = userdata;
195 pa_log_debug("Thread starting up");
197 pa_thread_mq_install(&u->thread_mq);
198 pa_rtpoll_install(u->rtpoll);
200 pa_smoother_set_time_offset(u->smoother, pa_rtclock_usec());
205 if (u->rtpoll_item) {
206 struct pollfd *pollfd;
207 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
209 /* Render some data and write it to the fifo */
210 if (PA_SINK_OPENED(u->sink->thread_info.state) && pollfd->revents) {
218 if (u->raw_memchunk.length <= 0) {
219 /* Grab unencoded data */
220 pa_sink_render(u->sink, u->block_size, &u->raw_memchunk);
222 pa_assert(u->raw_memchunk.length > 0);
224 if (u->encoded_memchunk.length <= 0) {
226 size_t rl = u->raw_memchunk.length;
227 if (u->encoded_memchunk.memblock)
228 pa_memblock_unref(u->encoded_memchunk.memblock);
229 u->encoded_memchunk = pa_raop_client_encode_sample(u->raop, u->core->mempool, &u->raw_memchunk);
230 u->encoding_overhead += (u->encoded_memchunk.length - (rl - u->raw_memchunk.length));
231 u->encoding_ratio = u->encoded_memchunk.length / (rl - u->raw_memchunk.length);
233 pa_assert(u->encoded_memchunk.length > 0);
235 p = pa_memblock_acquire(u->encoded_memchunk.memblock);
236 l = pa_write(u->fd, (uint8_t*) p + u->encoded_memchunk.index, u->encoded_memchunk.length, &write_type);
237 pa_memblock_release(u->encoded_memchunk.memblock);
245 else if (errno == EAGAIN) {
247 /* OK, we filled all socket buffers up
252 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
259 u->encoded_memchunk.index += l;
260 u->encoded_memchunk.length -= l;
262 if (u->encoded_memchunk.length <= 0) {
263 pa_memblock_unref(u->encoded_memchunk.memblock);
264 pa_memchunk_reset(&u->encoded_memchunk);
269 if (u->encoded_memchunk.length > 0)
271 /* OK, we wrote less that we asked for,
272 * hence we can assume that the socket
273 * buffers are full now */
280 /* At this spot we know that the socket buffers are
281 * fully filled up. This is the best time to estimate
282 * the playback position of the server */
289 if (ioctl(u->fd, SIOCOUTQ, &l) >= 0 && l > 0)
294 usec = pa_bytes_to_usec(n, &u->sink->sample_spec);
296 if (usec > u->latency)
301 pa_smoother_put(u->smoother, pa_rtclock_usec(), usec);
304 /* Hmm, nothing to do. Let's sleep */
305 pollfd->events = PA_SINK_OPENED(u->sink->thread_info.state) ? POLLOUT : 0;
308 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
314 if (u->rtpoll_item) {
315 struct pollfd* pollfd;
317 pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
319 if (pollfd->revents & ~POLLOUT) {
320 pa_log("FIFO shutdown.");
327 /* If this was no regular exit from the loop we have to continue
328 * processing messages until we received PA_MESSAGE_SHUTDOWN */
329 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
330 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
333 pa_log_debug("Thread shutting down");
336 static void on_connection(PA_GCC_UNUSED int fd, void*userdata) {
337 struct userdata *u = userdata;
340 pa_assert(u->fd < 0);
343 pa_log_debug("Connection authenticated, handing fd to IO thread...");
345 pa_asyncmsgq_post(u->thread_mq.inq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_PASS_SOCKET, NULL, 0, NULL, NULL);
348 int pa__init(pa_module*m) {
349 struct userdata *u = NULL;
352 pa_modargs *ma = NULL;
357 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
358 pa_log("failed to parse module arguments");
362 ss = m->core->default_sample_spec;
363 if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
364 pa_log("invalid sample format specification");
368 if ((/*ss.format != PA_SAMPLE_U8 &&*/ ss.format != PA_SAMPLE_S16NE) ||
370 pa_log("sample type support is limited to mono/stereo and U8 or S16NE sample data");
374 u = pa_xnew0(struct userdata, 1);
379 u->smoother = pa_smoother_new(PA_USEC_PER_SEC, PA_USEC_PER_SEC*2, TRUE);
380 pa_memchunk_reset(&u->raw_memchunk);
381 pa_memchunk_reset(&u->encoded_memchunk);
383 u->encoding_overhead = 0;
384 u->encoding_ratio = 1.0;
386 pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
387 u->rtpoll = pa_rtpoll_new();
388 pa_rtpoll_item_new_asyncmsgq(u->rtpoll, PA_RTPOLL_EARLY, u->thread_mq.inq);
389 u->rtpoll_item = NULL;
392 (ss.format == PA_SAMPLE_U8 ? ESD_BITS8 : ESD_BITS16) |
393 (ss.channels == 2 ? ESD_STEREO : ESD_MONO);*/
395 u->block_size = pa_usec_to_bytes(PA_USEC_PER_SEC/20, &ss);
397 u->read_data = u->write_data = NULL;
398 u->read_index = u->write_index = u->read_length = u->write_length = 0;
400 /*u->state = STATE_AUTH;*/
403 if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, NULL))) {
404 pa_log("Failed to create sink.");
408 u->sink->parent.process_msg = sink_process_msg;
409 u->sink->userdata = u;
410 u->sink->flags = PA_SINK_LATENCY|PA_SINK_NETWORK;
412 pa_sink_set_module(u->sink, m);
413 pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
414 pa_sink_set_rtpoll(u->sink, u->rtpoll);
416 if (!(p = pa_modargs_get_value(ma, "server", NULL))) {
417 pa_log("No server argument given.");
421 if (!(u->raop = pa_raop_client_new(u->core->mainloop, p))) {
422 pa_log("Failed to connect to server.");
426 pa_raop_client_set_callback(u->raop, on_connection, u);
427 pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Airtunes sink '%s'", p));
431 if (!(u->thread = pa_thread_new(thread_func, u))) {
432 pa_log("Failed to create thread.");
436 pa_sink_put(u->sink);
451 void pa__done(pa_module*m) {
455 if (!(u = m->userdata))
459 pa_sink_unlink(u->sink);
462 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
463 pa_thread_free(u->thread);
466 pa_thread_mq_done(&u->thread_mq);
469 pa_sink_unref(u->sink);
472 pa_rtpoll_item_free(u->rtpoll_item);
475 pa_rtpoll_free(u->rtpoll);
477 if (u->raw_memchunk.memblock)
478 pa_memblock_unref(u->raw_memchunk.memblock);
480 if (u->encoded_memchunk.memblock)
481 pa_memblock_unref(u->encoded_memchunk.memblock);
484 pa_raop_client_free(u->raop);
486 pa_xfree(u->read_data);
487 pa_xfree(u->write_data);
490 pa_smoother_free(u->smoother);