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 int32_t next_encoding_overhead
;
113 double encoding_ratio
;
115 pa_raop_client
*raop
;
120 static const char* const valid_modargs
[] = {
130 SINK_MESSAGE_PASS_SOCKET
= PA_SINK_MESSAGE_MAX
133 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
134 struct userdata
*u
= PA_SINK(o
)->userdata
;
138 case PA_SINK_MESSAGE_SET_STATE
:
140 switch ((pa_sink_state_t
) PA_PTR_TO_UINT(data
)) {
142 case PA_SINK_SUSPENDED
:
143 pa_assert(PA_SINK_OPENED(u
->sink
->thread_info
.state
));
145 pa_smoother_pause(u
->smoother
, pa_rtclock_usec());
149 case PA_SINK_RUNNING
:
151 if (u
->sink
->thread_info
.state
== PA_SINK_SUSPENDED
)
152 pa_smoother_resume(u
->smoother
, pa_rtclock_usec());
156 case PA_SINK_UNLINKED
:
163 case PA_SINK_MESSAGE_GET_LATENCY
: {
166 r
= pa_smoother_get(u
->smoother
, pa_rtclock_usec());
167 w
= pa_bytes_to_usec((u
->offset
- u
->encoding_overhead
+ (u
->encoded_memchunk
.length
/ u
->encoding_ratio
)), &u
->sink
->sample_spec
);
169 *((pa_usec_t
*) data
) = w
> r
? w
- r
: 0;
173 case SINK_MESSAGE_PASS_SOCKET
: {
174 struct pollfd
*pollfd
;
176 pa_assert(!u
->rtpoll_item
);
178 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
179 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
181 pollfd
->events
= POLLOUT
;
188 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
191 static void thread_func(void *userdata
) {
192 struct userdata
*u
= userdata
;
195 uint32_t silence_overhead
;
196 double silence_ratio
;
200 pa_log_debug("Thread starting up");
202 pa_thread_mq_install(&u
->thread_mq
);
203 pa_rtpoll_install(u
->rtpoll
);
205 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_usec());
207 /* Create a chunk of memory that is our encoded silence sample. */
208 pa_memchunk_reset(&silence
);
213 if (u
->rtpoll_item
) {
214 struct pollfd
*pollfd
;
215 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
217 /* Render some data and write it to the fifo */
218 if (pollfd
->revents
) {
223 if (!silence
.memblock
) {
224 pa_memchunk silence_tmp
;
226 pa_memchunk_reset(&silence_tmp
);
227 silence_tmp
.memblock
= pa_memblock_new(u
->core
->mempool
, 4096);
228 silence_tmp
.length
= 4096;
229 p
= pa_memblock_acquire(silence_tmp
.memblock
);
231 pa_memblock_release(silence_tmp
.memblock
);
232 pa_raop_client_encode_sample(u
->raop
, &silence_tmp
, &silence
);
233 pa_assert(0 == silence_tmp
.length
);
234 silence_overhead
= silence_tmp
.length
- 4096;
235 silence_ratio
= silence_tmp
.length
/ 4096;
236 pa_memblock_unref(silence_tmp
.memblock
);
242 if (u
->encoded_memchunk
.length
<= 0) {
243 if (u
->encoded_memchunk
.memblock
)
244 pa_memblock_unref(u
->encoded_memchunk
.memblock
);
245 if (PA_SINK_OPENED(u
->sink
->thread_info
.state
)) {
248 /* We render real data */
249 if (u
->raw_memchunk
.length
<= 0) {
250 if (u
->raw_memchunk
.memblock
)
251 pa_memblock_unref(u
->raw_memchunk
.memblock
);
252 pa_memchunk_reset(&u
->raw_memchunk
);
254 /* Grab unencoded data */
255 pa_sink_render(u
->sink
, u
->block_size
, &u
->raw_memchunk
);
257 pa_assert(u
->raw_memchunk
.length
> 0);
260 rl
= u
->raw_memchunk
.length
;
261 u
->encoding_overhead
+= u
->next_encoding_overhead
;
262 pa_raop_client_encode_sample(u
->raop
, &u
->raw_memchunk
, &u
->encoded_memchunk
);
263 u
->next_encoding_overhead
= (u
->encoded_memchunk
.length
- (rl
- u
->raw_memchunk
.length
));
264 u
->encoding_ratio
= u
->encoded_memchunk
.length
/ (rl
- u
->raw_memchunk
.length
);
266 /* We render some silence into our memchunk */
267 u
->encoding_overhead
+= u
->next_encoding_overhead
;
268 memcpy(&u
->encoded_memchunk
, &silence
, sizeof(pa_memchunk
));
269 pa_memblock_ref(silence
.memblock
);
270 u
->next_encoding_overhead
= silence_overhead
;
271 u
->encoding_ratio
= silence_ratio
;
274 pa_assert(u
->encoded_memchunk
.length
> 0);
276 p
= pa_memblock_acquire(u
->encoded_memchunk
.memblock
);
277 l
= pa_write(u
->fd
, (uint8_t*) p
+ u
->encoded_memchunk
.index
, u
->encoded_memchunk
.length
, &write_type
);
278 pa_memblock_release(u
->encoded_memchunk
.memblock
);
286 else if (errno
== EAGAIN
) {
288 /* OK, we filled all socket buffers up
293 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno
));
300 u
->encoded_memchunk
.index
+= l
;
301 u
->encoded_memchunk
.length
-= l
;
305 if (u
->encoded_memchunk
.length
> 0)
307 /* OK, we wrote less that we asked for,
308 * hence we can assume that the socket
309 * buffers are full now */
316 /* At this spot we know that the socket buffers are
317 * fully filled up. This is the best time to estimate
318 * the playback position of the server */
325 if (ioctl(u
->fd
, SIOCOUTQ
, &l
) >= 0 && l
> 0)
330 usec
= pa_bytes_to_usec(n
, &u
->sink
->sample_spec
);
332 if (usec
> u
->latency
)
337 pa_smoother_put(u
->smoother
, pa_rtclock_usec(), usec
);
340 /* Hmm, nothing to do. Let's sleep */
341 /* pollfd->events = PA_SINK_OPENED(u->sink->thread_info.state) ? POLLOUT : 0; */
344 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
350 if (u
->rtpoll_item
) {
351 struct pollfd
* pollfd
;
353 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
355 if (pollfd
->revents
& ~POLLOUT
) {
356 pa_log("FIFO shutdown.");
363 /* If this was no regular exit from the loop we have to continue
364 * processing messages until we received PA_MESSAGE_SHUTDOWN */
365 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
366 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
369 if (silence
.memblock
)
370 pa_memblock_unref(silence
.memblock
);
371 pa_log_debug("Thread shutting down");
374 static void on_connection(PA_GCC_UNUSED
int fd
, void*userdata
) {
375 struct userdata
*u
= userdata
;
378 pa_assert(u
->fd
< 0);
381 pa_log_debug("Connection authenticated, handing fd to IO thread...");
383 pa_asyncmsgq_post(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_PASS_SOCKET
, NULL
, 0, NULL
, NULL
);
386 static void on_close(void*userdata
) {
387 struct userdata
*u
= userdata
;
390 pa_log_debug("Control connection closed.");
391 pa_module_unload_request(u
->module
);
394 int pa__init(pa_module
*m
) {
395 struct userdata
*u
= NULL
;
398 pa_modargs
*ma
= NULL
;
403 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
404 pa_log("failed to parse module arguments");
408 ss
= m
->core
->default_sample_spec
;
409 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
410 pa_log("invalid sample format specification");
414 if ((/*ss.format != PA_SAMPLE_U8 &&*/ ss
.format
!= PA_SAMPLE_S16NE
) ||
416 pa_log("sample type support is limited to mono/stereo and U8 or S16NE sample data");
420 u
= pa_xnew0(struct userdata
, 1);
425 u
->smoother
= pa_smoother_new(PA_USEC_PER_SEC
, PA_USEC_PER_SEC
*2, TRUE
);
426 pa_memchunk_reset(&u
->raw_memchunk
);
427 pa_memchunk_reset(&u
->encoded_memchunk
);
429 u
->encoding_overhead
= 0;
430 u
->next_encoding_overhead
= 0;
431 u
->encoding_ratio
= 1.0;
433 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
);
434 u
->rtpoll
= pa_rtpoll_new();
435 pa_rtpoll_item_new_asyncmsgq(u
->rtpoll
, PA_RTPOLL_EARLY
, u
->thread_mq
.inq
);
436 u
->rtpoll_item
= NULL
;
439 (ss.format == PA_SAMPLE_U8 ? ESD_BITS8 : ESD_BITS16) |
440 (ss.channels == 2 ? ESD_STEREO : ESD_MONO);*/
442 u
->block_size
= pa_usec_to_bytes(PA_USEC_PER_SEC
/20, &ss
);
444 u
->read_data
= u
->write_data
= NULL
;
445 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
447 /*u->state = STATE_AUTH;*/
450 if (!(u
->sink
= pa_sink_new(m
->core
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, NULL
))) {
451 pa_log("Failed to create sink.");
455 u
->sink
->parent
.process_msg
= sink_process_msg
;
456 u
->sink
->userdata
= u
;
457 u
->sink
->flags
= PA_SINK_LATENCY
|PA_SINK_NETWORK
;
459 pa_sink_set_module(u
->sink
, m
);
460 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
461 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
463 if (!(p
= pa_modargs_get_value(ma
, "server", NULL
))) {
464 pa_log("No server argument given.");
468 if (!(u
->raop
= pa_raop_client_new(u
->core
, p
))) {
469 pa_log("Failed to connect to server.");
473 pa_raop_client_set_callback(u
->raop
, on_connection
, u
);
474 pa_raop_client_set_closed_callback(u
->raop
, on_close
, u
);
475 pa_sink_set_description(u
->sink
, t
= pa_sprintf_malloc("Airtunes sink '%s'", p
));
479 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
480 pa_log("Failed to create thread.");
484 pa_sink_put(u
->sink
);
499 void pa__done(pa_module
*m
) {
503 if (!(u
= m
->userdata
))
507 pa_sink_unlink(u
->sink
);
510 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
511 pa_thread_free(u
->thread
);
514 pa_thread_mq_done(&u
->thread_mq
);
517 pa_sink_unref(u
->sink
);
520 pa_rtpoll_item_free(u
->rtpoll_item
);
523 pa_rtpoll_free(u
->rtpoll
);
525 if (u
->raw_memchunk
.memblock
)
526 pa_memblock_unref(u
->raw_memchunk
.memblock
);
528 if (u
->encoded_memchunk
.memblock
)
529 pa_memblock_unref(u
->encoded_memchunk
.memblock
);
532 pa_raop_client_free(u
->raop
);
534 pa_xfree(u
->read_data
);
535 pa_xfree(u
->write_data
);
538 pa_smoother_free(u
->smoother
);