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                         if (u->raw_memchunk.memblock)
 221                             pa_memblock_unref(u->raw_memchunk.memblock);
 222                         pa_memchunk_reset(&u->raw_memchunk);
 223
 224                         /* Grab unencoded data */
 225                         pa_sink_render(u->sink, u->block_size, &u->raw_memchunk);
 226                     }
 227                     pa_assert(u->raw_memchunk.length > 0);
 228
 229                     if (u->encoded_memchunk.length <= 0) {
 230                         /* Encode it */
 231                         size_t rl = u->raw_memchunk.length;
 232                         u->encoding_overhead += u->next_encoding_overhead;
 233                         pa_raop_client_encode_sample(u->raop, &u->raw_memchunk, &u->encoded_memchunk);
 234                         u->next_encoding_overhead = (u->encoded_memchunk.length - (rl - u->raw_memchunk.length));
 235                         u->encoding_ratio = u->encoded_memchunk.length / (rl - u->raw_memchunk.length);
 236                     }
 237                     pa_assert(u->encoded_memchunk.length > 0);
 238
 239                     p = pa_memblock_acquire(u->encoded_memchunk.memblock);
 240                     l = pa_write(u->fd, (uint8_t*) p + u->encoded_memchunk.index, u->encoded_memchunk.length, &write_type);
 241                     pa_memblock_release(u->encoded_memchunk.memblock);
 242
 243                     pa_assert(l != 0);
 244
 245                     if (l < 0) {
 246
 247                         if (errno == EINTR)
 248                             continue;
 249                         else if (errno == EAGAIN) {
 250
 251                             /* OK, we filled all socket buffers up
 252                              * now. */
 253                             goto filled_up;
 254
 255                         } else {
 256                             pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
 257                             goto fail;
 258                         }
 259
 260                     } else {
 261                         u->offset += l;
 262
 263                         u->encoded_memchunk.index += l;
 264                         u->encoded_memchunk.length -= l;
 265
 266                         pollfd->revents = 0;
 267
 268                         if (u->encoded_memchunk.length > 0)
 269
 270                             /* OK, we wrote less that we asked for,
 271                              * hence we can assume that the socket
 272                              * buffers are full now */
 273                             goto filled_up;
 274                     }
 275                 }
 276
 277             filled_up:
 278
 279                 /* At this spot we know that the socket buffers are
 280                  * fully filled up. This is the best time to estimate
 281                  * the playback position of the server */
 282
 283                 n = u->offset;
 284
 285 #ifdef SIOCOUTQ
 286                 {
 287                     int l;
 288                     if (ioctl(u->fd, SIOCOUTQ, &l) >= 0 && l > 0)
 289                         n -= l;
 290                 }
 291 #endif
 292
 293                 usec = pa_bytes_to_usec(n, &u->sink->sample_spec);
 294
 295                 if (usec > u->latency)
 296                     usec -= u->latency;
 297                 else
 298                     usec = 0;
 299
 300                 pa_smoother_put(u->smoother, pa_rtclock_usec(), usec);
 301             }
 302
 303             /* Hmm, nothing to do. Let's sleep */
 304             pollfd->events = PA_SINK_OPENED(u->sink->thread_info.state)  ? POLLOUT : 0;
 305         }
 306
 307         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
 308             goto fail;
 309
 310         if (ret == 0)
 311             goto finish;
 312
 313         if (u->rtpoll_item) {
 314             struct pollfd* pollfd;
 315
 316             pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
 317
 318             if (pollfd->revents & ~POLLOUT) {
 319                 pa_log("FIFO shutdown.");
 320                 goto fail;
 321             }
 322         }
 323     }
 324
 325 fail:
 326     /* If this was no regular exit from the loop we have to continue
 327      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 328     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 329     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 330
 331 finish:
 332     pa_log_debug("Thread shutting down");
 333 }
 334
 335 static void on_connection(PA_GCC_UNUSED int fd, void*userdata) {
 336     struct userdata *u = userdata;
 337     pa_assert(u);
 338
 339     pa_assert(u->fd < 0);
 340     u->fd = fd;
 341
 342     pa_log_debug("Connection authenticated, handing fd to IO thread...");
 343
 344     pa_asyncmsgq_post(u->thread_mq.inq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_PASS_SOCKET, NULL, 0, NULL, NULL);
 345 }
 346
 347 static void on_close(void*userdata) {
 348     struct userdata *u = userdata;
 349     pa_assert(u);
 350
 351     pa_log_debug("Control connection closed.");
 352     pa_module_unload_request(u->module);
 353 }
 354
 355 int pa__init(pa_module*m) {
 356     struct userdata *u = NULL;
 357     const char *p;
 358     pa_sample_spec ss;
 359     pa_modargs *ma = NULL;
 360     char *t;
 361
 362     pa_assert(m);
 363
 364     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 365         pa_log("failed to parse module arguments");
 366         goto fail;
 367     }
 368
 369     ss = m->core->default_sample_spec;
 370     if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
 371         pa_log("invalid sample format specification");
 372         goto fail;
 373     }
 374
 375     if ((/*ss.format != PA_SAMPLE_U8 &&*/ ss.format != PA_SAMPLE_S16NE) ||
 376         (ss.channels > 2)) {
 377         pa_log("sample type support is limited to mono/stereo and U8 or S16NE sample data");
 378         goto fail;
 379     }
 380
 381     u = pa_xnew0(struct userdata, 1);
 382     u->core = m->core;
 383     u->module = m;
 384     m->userdata = u;
 385     u->fd = -1;
 386     u->smoother = pa_smoother_new(PA_USEC_PER_SEC, PA_USEC_PER_SEC*2, TRUE);
 387     pa_memchunk_reset(&u->raw_memchunk);
 388     pa_memchunk_reset(&u->encoded_memchunk);
 389     u->offset = 0;
 390     u->encoding_overhead = 0;
 391     u->next_encoding_overhead = 0;
 392     u->encoding_ratio = 1.0;
 393
 394     pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
 395     u->rtpoll = pa_rtpoll_new();
 396     pa_rtpoll_item_new_asyncmsgq(u->rtpoll, PA_RTPOLL_EARLY, u->thread_mq.inq);
 397     u->rtpoll_item = NULL;
 398
 399     /*u->format =
 400         (ss.format == PA_SAMPLE_U8 ? ESD_BITS8 : ESD_BITS16) |
 401         (ss.channels == 2 ? ESD_STEREO : ESD_MONO);*/
 402     u->rate = ss.rate;
 403     u->block_size = pa_usec_to_bytes(PA_USEC_PER_SEC/20, &ss);
 404
 405     u->read_data = u->write_data = NULL;
 406     u->read_index = u->write_index = u->read_length = u->write_length = 0;
 407
 408     /*u->state = STATE_AUTH;*/
 409     u->latency = 0;
 410
 411     if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, NULL))) {
 412         pa_log("Failed to create sink.");
 413         goto fail;
 414     }
 415
 416     u->sink->parent.process_msg = sink_process_msg;
 417     u->sink->userdata = u;
 418     u->sink->flags = PA_SINK_LATENCY|PA_SINK_NETWORK;
 419
 420     pa_sink_set_module(u->sink, m);
 421     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
 422     pa_sink_set_rtpoll(u->sink, u->rtpoll);
 423
 424     if (!(p = pa_modargs_get_value(ma, "server", NULL))) {
 425         pa_log("No server argument given.");
 426         goto fail;
 427     }
 428
 429     if (!(u->raop = pa_raop_client_new(u->core, p))) {
 430         pa_log("Failed to connect to server.");
 431         goto fail;
 432     }
 433
 434     pa_raop_client_set_callback(u->raop, on_connection, u);
 435     pa_raop_client_set_closed_callback(u->raop, on_close, u);
 436     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Airtunes sink '%s'", p));
 437     pa_xfree(t);
 438
 439
 440     if (!(u->thread = pa_thread_new(thread_func, u))) {
 441         pa_log("Failed to create thread.");
 442         goto fail;
 443     }
 444
 445     pa_sink_put(u->sink);
 446
 447     pa_modargs_free(ma);
 448
 449     return 0;
 450
 451 fail:
 452     if (ma)
 453         pa_modargs_free(ma);
 454
 455     pa__done(m);
 456
 457     return -1;
 458 }
 459
 460 void pa__done(pa_module*m) {
 461     struct userdata *u;
 462     pa_assert(m);
 463
 464     if (!(u = m->userdata))
 465         return;
 466
 467     if (u->sink)
 468         pa_sink_unlink(u->sink);
 469
 470     if (u->thread) {
 471         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
 472         pa_thread_free(u->thread);
 473     }
 474
 475     pa_thread_mq_done(&u->thread_mq);
 476
 477     if (u->sink)
 478         pa_sink_unref(u->sink);
 479
 480     if (u->rtpoll_item)
 481         pa_rtpoll_item_free(u->rtpoll_item);
 482
 483     if (u->rtpoll)
 484         pa_rtpoll_free(u->rtpoll);
 485
 486     if (u->raw_memchunk.memblock)
 487         pa_memblock_unref(u->raw_memchunk.memblock);
 488
 489     if (u->encoded_memchunk.memblock)
 490         pa_memblock_unref(u->encoded_memchunk.memblock);
 491
 492     if (u->raop)
 493         pa_raop_client_free(u->raop);
 494
 495     pa_xfree(u->read_data);
 496     pa_xfree(u->write_data);
 497
 498     if (u->smoother)
 499         pa_smoother_free(u->smoother);
 500
 501     if (u->fd >= 0)
 502         pa_close(u->fd);
 503
 504     pa_xfree(u);
 505 }