src/modules/module-raop-sink.c

   1 /* $Id: module-esound-sink.c 2043 2007-11-09 18:25:40Z lennart $ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2008 Colin Guthrie
   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 <poll.h>
  37 #include <sys/socket.h>
  38 #include <netinet/in.h>
  39 #include <netinet/tcp.h>
  40 #include <sys/ioctl.h>
  41
  42 #ifdef HAVE_LINUX_SOCKIOS_H
  43 #include <linux/sockios.h>
  44 #endif
  45
  46 #include <pulse/xmalloc.h>
  47 #include <pulse/timeval.h>
  48
  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>
  63
  64 #include "module-raop-sink-symdef.h"
  65 #include "rtp.h"
  66 #include "sdp.h"
  67 #include "sap.h"
  68 #include "raop_client.h"
  69
  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);
  74 PA_MODULE_USAGE(
  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>");
  80
  81 #define DEFAULT_SINK_NAME "airtunes"
  82
  83 struct userdata {
  84     pa_core *core;
  85     pa_module *module;
  86     pa_sink *sink;
  87
  88     pa_thread_mq thread_mq;
  89     pa_rtpoll *rtpoll;
  90     pa_rtpoll_item *rtpoll_item;
  91     pa_thread *thread;
  92
  93     pa_memchunk raw_memchunk;
  94     pa_memchunk encoded_memchunk;
  95
  96     void *write_data;
  97     size_t write_length, write_index;
  98
  99     void *read_data;
 100     size_t read_length, read_index;
 101
 102     pa_usec_t latency;
 103
 104     /*esd_format_t format;*/
 105     int32_t rate;
 106
 107     pa_smoother *smoother;
 108     int fd;
 109
 110     int64_t offset;
 111     int64_t encoding_overhead;
 112     int32_t next_encoding_overhead;
 113     double encoding_ratio;
 114
 115     pa_raop_client *raop;
 116
 117     size_t block_size;
 118 };
 119
 120 static const char* const valid_modargs[] = {
 121     "server",
 122     "rate",
 123     "format",
 124     "channels",
 125     "sink_name",
 126     NULL
 127 };
 128
 129 enum {
 130     SINK_MESSAGE_PASS_SOCKET = PA_SINK_MESSAGE_MAX
 131 };
 132
 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;
 135
 136     switch (code) {
 137
 138         case PA_SINK_MESSAGE_SET_STATE:
 139
 140             switch ((pa_sink_state_t) PA_PTR_TO_UINT(data)) {
 141
 142                 case PA_SINK_SUSPENDED:
 143                     pa_assert(PA_SINK_OPENED(u->sink->thread_info.state));
 144
 145                     pa_smoother_pause(u->smoother, pa_rtclock_usec());
 146                     break;
 147
 148                 case PA_SINK_IDLE:
 149                 case PA_SINK_RUNNING:
 150
 151                     if (u->sink->thread_info.state == PA_SINK_SUSPENDED)
 152                         pa_smoother_resume(u->smoother, pa_rtclock_usec());
 153
 154                     break;
 155
 156                 case PA_SINK_UNLINKED:
 157                 case PA_SINK_INIT:
 158                     ;
 159             }
 160
 161             break;
 162
 163         case PA_SINK_MESSAGE_GET_LATENCY: {
 164             pa_usec_t w, r;
 165
 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);
 168
 169             *((pa_usec_t*) data) = w > r ? w - r : 0;
 170             break;
 171         }
 172
 173         case SINK_MESSAGE_PASS_SOCKET: {
 174             struct pollfd *pollfd;
 175
 176             pa_assert(!u->rtpoll_item);
 177
 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);
 180             pollfd->fd = u->fd;
 181             pollfd->events = pollfd->revents = 0;
 182
 183             return 0;
 184         }
 185     }
 186
 187     return pa_sink_process_msg(o, code, data, offset, chunk);
 188 }
 189
 190 static void thread_func(void *userdata) {
 191     struct userdata *u = userdata;
 192     int write_type = 0;
 193
 194     pa_assert(u);
 195
 196     pa_log_debug("Thread starting up");
 197
 198     pa_thread_mq_install(&u->thread_mq);
 199     pa_rtpoll_install(u->rtpoll);
 200
 201     pa_smoother_set_time_offset(u->smoother, pa_rtclock_usec());
 202
 203     for (;;) {
 204         int ret;
 205
 206         if (u->rtpoll_item) {
 207             struct pollfd *pollfd;
 208             pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
 209
 210             /* Render some data and write it to the fifo */
 211             if (PA_SINK_OPENED(u->sink->thread_info.state) && pollfd->revents) {
 212                 pa_usec_t usec;
 213                 int64_t n;
 214
 215                 for (;;) {
 216                     ssize_t l;
 217                     void *p;
 218
 219                     if (u->raw_memchunk.length <= 0) {
 220                         /* Grab unencoded data */
 221                         pa_sink_render(u->sink, u->block_size, &u->raw_memchunk);
 222                     }
 223                     pa_assert(u->raw_memchunk.length > 0);
 224
 225                     if (u->encoded_memchunk.length <= 0) {
 226                         /* Encode it */
 227                         size_t rl = u->raw_memchunk.length;
 228                         u->encoding_overhead += u->next_encoding_overhead;
 229                         u->encoded_memchunk = pa_raop_client_encode_sample(u->raop, &u->raw_memchunk);
 230                         u->next_encoding_overhead = (u->encoded_memchunk.length - (rl - u->raw_memchunk.length));
 231                         u->encoding_ratio = u->encoded_memchunk.length / (rl - u->raw_memchunk.length);
 232                     }
 233                     pa_assert(u->encoded_memchunk.length > 0);
 234
 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);
 238
 239                     pa_assert(l != 0);
 240
 241                     if (l < 0) {
 242
 243                         if (errno == EINTR)
 244                             continue;
 245                         else if (errno == EAGAIN) {
 246
 247                             /* OK, we filled all socket buffers up
 248                              * now. */
 249                             goto filled_up;
 250
 251                         } else {
 252                             pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
 253                             goto fail;
 254                         }
 255
 256                     } else {
 257                         u->offset += l;
 258
 259                         u->encoded_memchunk.index += l;
 260                         u->encoded_memchunk.length -= l;
 261
 262                         pollfd->revents = 0;
 263
 264                         if (u->encoded_memchunk.length > 0)
 265
 266                             /* OK, we wrote less that we asked for,
 267                              * hence we can assume that the socket
 268                              * buffers are full now */
 269                             goto filled_up;
 270                     }
 271                 }
 272
 273             filled_up:
 274
 275                 /* At this spot we know that the socket buffers are
 276                  * fully filled up. This is the best time to estimate
 277                  * the playback position of the server */
 278
 279                 n = u->offset;
 280
 281 #ifdef SIOCOUTQ
 282                 {
 283                     int l;
 284                     if (ioctl(u->fd, SIOCOUTQ, &l) >= 0 && l > 0)
 285                         n -= l;
 286                 }
 287 #endif
 288
 289                 usec = pa_bytes_to_usec(n, &u->sink->sample_spec);
 290
 291                 if (usec > u->latency)
 292                     usec -= u->latency;
 293                 else
 294                     usec = 0;
 295
 296                 pa_smoother_put(u->smoother, pa_rtclock_usec(), usec);
 297             }
 298
 299             /* Hmm, nothing to do. Let's sleep */
 300             pollfd->events = PA_SINK_OPENED(u->sink->thread_info.state)  ? POLLOUT : 0;
 301         }
 302
 303         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
 304             goto fail;
 305
 306         if (ret == 0)
 307             goto finish;
 308
 309         if (u->rtpoll_item) {
 310             struct pollfd* pollfd;
 311
 312             pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
 313
 314             if (pollfd->revents & ~POLLOUT) {
 315                 pa_log("FIFO shutdown.");
 316                 goto fail;
 317             }
 318         }
 319     }
 320
 321 fail:
 322     /* If this was no regular exit from the loop we have to continue
 323      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 324     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 325     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 326
 327 finish:
 328     pa_log_debug("Thread shutting down");
 329 }
 330
 331 static void on_connection(PA_GCC_UNUSED int fd, void*userdata) {
 332     struct userdata *u = userdata;
 333     pa_assert(u);
 334
 335     pa_assert(u->fd < 0);
 336     u->fd = fd;
 337
 338     pa_log_debug("Connection authenticated, handing fd to IO thread...");
 339
 340     pa_asyncmsgq_post(u->thread_mq.inq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_PASS_SOCKET, NULL, 0, NULL, NULL);
 341 }
 342
 343 static void on_close(void*userdata) {
 344     struct userdata *u = userdata;
 345     pa_assert(u);
 346
 347     pa_log_debug("Control connection closed.");
 348     pa_module_unload_request(u->module);
 349 }
 350
 351 int pa__init(pa_module*m) {
 352     struct userdata *u = NULL;
 353     const char *p;
 354     pa_sample_spec ss;
 355     pa_modargs *ma = NULL;
 356     char *t;
 357
 358     pa_assert(m);
 359
 360     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 361         pa_log("failed to parse module arguments");
 362         goto fail;
 363     }
 364
 365     ss = m->core->default_sample_spec;
 366     if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
 367         pa_log("invalid sample format specification");
 368         goto fail;
 369     }
 370
 371     if ((/*ss.format != PA_SAMPLE_U8 &&*/ ss.format != PA_SAMPLE_S16NE) ||
 372         (ss.channels > 2)) {
 373         pa_log("sample type support is limited to mono/stereo and U8 or S16NE sample data");
 374         goto fail;
 375     }
 376
 377     u = pa_xnew0(struct userdata, 1);
 378     u->core = m->core;
 379     u->module = m;
 380     m->userdata = u;
 381     u->fd = -1;
 382     u->smoother = pa_smoother_new(PA_USEC_PER_SEC, PA_USEC_PER_SEC*2, TRUE);
 383     pa_memchunk_reset(&u->raw_memchunk);
 384     pa_memchunk_reset(&u->encoded_memchunk);
 385     u->offset = 0;
 386     u->encoding_overhead = 0;
 387     u->next_encoding_overhead = 0;
 388     u->encoding_ratio = 1.0;
 389
 390     pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
 391     u->rtpoll = pa_rtpoll_new();
 392     pa_rtpoll_item_new_asyncmsgq(u->rtpoll, PA_RTPOLL_EARLY, u->thread_mq.inq);
 393     u->rtpoll_item = NULL;
 394
 395     /*u->format =
 396         (ss.format == PA_SAMPLE_U8 ? ESD_BITS8 : ESD_BITS16) |
 397         (ss.channels == 2 ? ESD_STEREO : ESD_MONO);*/
 398     u->rate = ss.rate;
 399     u->block_size = pa_usec_to_bytes(PA_USEC_PER_SEC/20, &ss);
 400
 401     u->read_data = u->write_data = NULL;
 402     u->read_index = u->write_index = u->read_length = u->write_length = 0;
 403
 404     /*u->state = STATE_AUTH;*/
 405     u->latency = 0;
 406
 407     if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, NULL))) {
 408         pa_log("Failed to create sink.");
 409         goto fail;
 410     }
 411
 412     u->sink->parent.process_msg = sink_process_msg;
 413     u->sink->userdata = u;
 414     u->sink->flags = PA_SINK_LATENCY|PA_SINK_NETWORK;
 415
 416     pa_sink_set_module(u->sink, m);
 417     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
 418     pa_sink_set_rtpoll(u->sink, u->rtpoll);
 419
 420     if (!(p = pa_modargs_get_value(ma, "server", NULL))) {
 421         pa_log("No server argument given.");
 422         goto fail;
 423     }
 424
 425     if (!(u->raop = pa_raop_client_new(u->core, p))) {
 426         pa_log("Failed to connect to server.");
 427         goto fail;
 428     }
 429
 430     pa_raop_client_set_callback(u->raop, on_connection, u);
 431     pa_raop_client_set_closed_callback(u->raop, on_close, u);
 432     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Airtunes sink '%s'", p));
 433     pa_xfree(t);
 434
 435
 436     if (!(u->thread = pa_thread_new(thread_func, u))) {
 437         pa_log("Failed to create thread.");
 438         goto fail;
 439     }
 440
 441     pa_sink_put(u->sink);
 442
 443     pa_modargs_free(ma);
 444
 445     return 0;
 446
 447 fail:
 448     if (ma)
 449         pa_modargs_free(ma);
 450
 451     pa__done(m);
 452
 453     return -1;
 454 }
 455
 456 void pa__done(pa_module*m) {
 457     struct userdata *u;
 458     pa_assert(m);
 459
 460     if (!(u = m->userdata))
 461         return;
 462
 463     if (u->sink)
 464         pa_sink_unlink(u->sink);
 465
 466     if (u->thread) {
 467         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
 468         pa_thread_free(u->thread);
 469     }
 470
 471     pa_thread_mq_done(&u->thread_mq);
 472
 473     if (u->sink)
 474         pa_sink_unref(u->sink);
 475
 476     if (u->rtpoll_item)
 477         pa_rtpoll_item_free(u->rtpoll_item);
 478
 479     if (u->rtpoll)
 480         pa_rtpoll_free(u->rtpoll);
 481
 482     if (u->raw_memchunk.memblock)
 483         pa_memblock_unref(u->raw_memchunk.memblock);
 484
 485     if (u->raop)
 486         pa_raop_client_free(u->raop);
 487
 488     pa_xfree(u->read_data);
 489     pa_xfree(u->write_data);
 490
 491     if (u->smoother)
 492         pa_smoother_free(u->smoother);
 493
 494     if (u->fd >= 0)
 495         pa_close(u->fd);
 496
 497     pa_xfree(u);
 498 }