A very rough first version of the sink.

I can actually play music to my airport now (woot).
Still very rough round the edges and I need to handle disconnects etc. but it's all good progress :)

git-svn-id: file:///home/lennart/svn/public/pulseaudio/branches/coling@2398 fefdeb5f-60dc-0310-8127-8f9354f1896f

src/modules/module-raop-sink.c

@@ -3,8 +3,7 @@
 /***
   This file is part of PulseAudio.
 
-  Copyright 2004-2006 Lennart Poettering
+  Copyright 2008 Colin Guthrie
-  Copyright 2008      Colin Guthrie
 
   PulseAudio is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
@@ -34,52 +33,50 @@
 #include <fcntl.h>
 #include <unistd.h>
 #include <limits.h>
-#include <sys/ioctl.h>
 #include <poll.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <netinet/tcp.h>
+#include <sys/ioctl.h>
+
+#ifdef HAVE_LINUX_SOCKIOS_H
+#include <linux/sockios.h>
+#endif
 
 #include <pulse/xmalloc.h>
+#include <pulse/timeval.h>
 
 #include <pulsecore/core-error.h>
+#include <pulsecore/iochannel.h>
 #include <pulsecore/sink.h>
 #include <pulsecore/module.h>
 #include <pulsecore/core-util.h>
 #include <pulsecore/modargs.h>
 #include <pulsecore/log.h>
-#include <pulsecore/thread.h>
+#include <pulsecore/socket-client.h>
+#include <pulsecore/authkey.h>
 #include <pulsecore/thread-mq.h>
-#include <pulsecore/random.h>
+#include <pulsecore/thread.h>
-#include <pulsecore/rtpoll.h>
+#include <pulsecore/time-smoother.h>
+#include <pulsecore/rtclock.h>
+#include <pulsecore/socket-util.h>
 
+#include "module-raop-sink-symdef.h"
 #include "rtp.h"
 #include "sdp.h"
 #include "sap.h"
 #include "raop_client.h"
 
-
-#include "module-raop-sink-symdef.h"
-
-#define JACK_STATUS_DISCONNECTED 0
-#define JACK_STATUS_CONNECTED 1
-
-#define JACK_TYPE_ANALOG 0
-#define JACK_TYPE_DIGITAL 1
-
-#define VOLUME_DEF -30
-#define VOLUME_MIN -144
-#define VOLUME_MAX 0
-
-
 PA_MODULE_AUTHOR("Colin Guthrie");
-PA_MODULE_DESCRIPTION("RAOP Sink (Apple Airport)");
+PA_MODULE_DESCRIPTION("RAOP Sink (Apple Airtunes)");
 PA_MODULE_VERSION(PACKAGE_VERSION);
 PA_MODULE_LOAD_ONCE(FALSE);
 PA_MODULE_USAGE(
-        "server=<address> "
         "sink_name=<name for the sink> "
+        "server=<address> cookie=<filename>  "
         "format=<sample format> "
         "channels=<number of channels> "
-        "rate=<sample rate>"
+        "rate=<sample rate>");
-        "channel_map=<channel map>");
 
 #define DEFAULT_SINK_NAME "airtunes"
 
@@ -88,17 +85,35 @@ struct userdata {
     pa_module *module;
     pa_sink *sink;
 
-    pa_thread *thread;
     pa_thread_mq thread_mq;
     pa_rtpoll *rtpoll;
+    pa_rtpoll_item *rtpoll_item;
+    pa_thread *thread;
 
-    char *server_name;
+    pa_memchunk raw_memchunk;
+    pa_memchunk encoded_memchunk;
+
+    void *write_data;
+    size_t write_length, write_index;
+
+    void *read_data;
+    size_t read_length, read_index;
+
+    pa_usec_t latency;
+
+    /*esd_format_t format;*/
+    int32_t rate;
+
+    pa_smoother *smoother;
+    int fd;
+
+    int64_t offset;
+    int64_t encoding_overhead;
+    double encoding_ratio;
 
     pa_raop_client *raop;
-    //pa_socket_client *client;
-    pa_memchunk memchunk;
 
-    pa_rtpoll_item *rtpoll_item;
+    size_t block_size;
 };
 
 static const char* const valid_modargs[] = {
@@ -107,30 +122,64 @@ static const char* const valid_modargs[] = {
     "format",
     "channels",
     "sink_name",
-    "channel_map",
     NULL
 };
 
+enum {
+    SINK_MESSAGE_PASS_SOCKET = PA_SINK_MESSAGE_MAX
+};
+
 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
     struct userdata *u = PA_SINK(o)->userdata;
 
     switch (code) {
 
-        case PA_SINK_MESSAGE_GET_LATENCY: {
+        case PA_SINK_MESSAGE_SET_STATE:
-            size_t n = 0;
-            //int l;
 
-#ifdef TIOCINQ
+            switch ((pa_sink_state_t) PA_PTR_TO_UINT(data)) {
-            /*
-            if (ioctl(u->fd, TIOCINQ, &l) >= 0 && l > 0)
-                n = (size_t) l;
-            */
-#endif
 
-            n += u->memchunk.length;
+                case PA_SINK_SUSPENDED:
+                    pa_assert(PA_SINK_OPENED(u->sink->thread_info.state));
+
+                    pa_smoother_pause(u->smoother, pa_rtclock_usec());
+                    break;
+
+                case PA_SINK_IDLE:
+                case PA_SINK_RUNNING:
+
+                    if (u->sink->thread_info.state == PA_SINK_SUSPENDED)
+                        pa_smoother_resume(u->smoother, pa_rtclock_usec());
+
+                    break;
+
+                case PA_SINK_UNLINKED:
+                case PA_SINK_INIT:
+                    ;
+            }
 
-            *((pa_usec_t*) data) = pa_bytes_to_usec(n, &u->sink->sample_spec);
             break;
+
+        case PA_SINK_MESSAGE_GET_LATENCY: {
+            pa_usec_t w, r;
+
+            r = pa_smoother_get(u->smoother, pa_rtclock_usec());
+            w = pa_bytes_to_usec((u->offset - u->encoding_overhead + (u->encoded_memchunk.length / u->encoding_ratio)), &u->sink->sample_spec);
+
+            *((pa_usec_t*) data) = w > r ? w - r : 0;
+            break;
+        }
+
+        case SINK_MESSAGE_PASS_SOCKET: {
+            struct pollfd *pollfd;
+
+            pa_assert(!u->rtpoll_item);
+
+            u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
+            pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
+            pollfd->fd = u->fd;
+            pollfd->events = pollfd->revents = 0;
+
+            return 0;
         }
     }
 
@@ -139,7 +188,7 @@ static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offse
 
 static void thread_func(void *userdata) {
     struct userdata *u = userdata;
-    //int write_type = 0;
+    int write_type = 0;
 
     pa_assert(u);
 
@@ -148,55 +197,113 @@ static void thread_func(void *userdata) {
     pa_thread_mq_install(&u->thread_mq);
     pa_rtpoll_install(u->rtpoll);
 
+    pa_smoother_set_time_offset(u->smoother, pa_rtclock_usec());
+
     for (;;) {
-        struct pollfd *pollfd;
         int ret;
 
-        pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
+        if (u->rtpoll_item) {
+            struct pollfd *pollfd;
+            pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
 
-        /* Render some data and write it to the fifo */
+            /* Render some data and write it to the fifo */
-        if (u->sink->thread_info.state == PA_SINK_RUNNING && pollfd->revents) {
+            if (PA_SINK_OPENED(u->sink->thread_info.state) && pollfd->revents) {
-            ssize_t l;
+                pa_usec_t usec;
-            void *p;
+                int64_t n;
 
-            if (u->memchunk.length <= 0)
+                for (;;) {
-                pa_sink_render(u->sink, PIPE_BUF, &u->memchunk);
+                    ssize_t l;
+                    void *p;
 
-            pa_assert(u->memchunk.length > 0);
+                    if (u->raw_memchunk.length <= 0) {
+                        /* Grab unencoded data */
+                        pa_sink_render(u->sink, u->block_size, &u->raw_memchunk);
+                    }
+                    pa_assert(u->raw_memchunk.length > 0);
 
-            p = pa_memblock_acquire(u->memchunk.memblock);
+                    if (u->encoded_memchunk.length <= 0) {
-            //l = pa_write(u->fd, (uint8_t*) p + u->memchunk.index, u->memchunk.length, &write_type);
+                        /* Encode it */
-            // Fake the length of the "write".
+                        size_t rl = u->raw_memchunk.length;
-            l = u->memchunk.length;
+                        if (u->encoded_memchunk.memblock)
-            pa_memblock_release(u->memchunk.memblock);
+                            pa_memblock_unref(u->encoded_memchunk.memblock);
+                        u->encoded_memchunk = pa_raop_client_encode_sample(u->raop, u->core->mempool, &u->raw_memchunk);
+                        u->encoding_overhead += (u->encoded_memchunk.length - (rl - u->raw_memchunk.length));
+                        u->encoding_ratio = u->encoded_memchunk.length / (rl - u->raw_memchunk.length);
+                    }
+                    pa_assert(u->encoded_memchunk.length > 0);
 
-            pa_assert(l != 0);
+                    p = pa_memblock_acquire(u->encoded_memchunk.memblock);
+                    l = pa_write(u->fd, (uint8_t*) p + u->encoded_memchunk.index, u->encoded_memchunk.length, &write_type);
+                    pa_memblock_release(u->encoded_memchunk.memblock);
 
-            if (l < 0) {
+                    pa_assert(l != 0);
 
-                if (errno == EINTR)
+                    if (l < 0) {
-                    continue;
+
-                else if (errno != EAGAIN) {
+                        if (errno == EINTR)
-                    pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
+                            continue;
-                    goto fail;
+                        else if (errno == EAGAIN) {
+
+                            /* OK, we filled all socket buffers up
+                             * now. */
+                            goto filled_up;
+
+                        } else {
+                            pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno));
+                            goto fail;
+                        }
+
+                    } else {
+                        u->offset += l;
+
+                        u->encoded_memchunk.index += l;
+                        u->encoded_memchunk.length -= l;
+
+                        if (u->encoded_memchunk.length <= 0) {
+                            pa_memblock_unref(u->encoded_memchunk.memblock);
+                            pa_memchunk_reset(&u->encoded_memchunk);
+                        }
+
+                        pollfd->revents = 0;
+
+                        if (u->encoded_memchunk.length > 0)
+
+                            /* OK, we wrote less that we asked for,
+                             * hence we can assume that the socket
+                             * buffers are full now */
+                            goto filled_up;
+                    }
                 }
 
-            } else {
+            filled_up:
 
-                u->memchunk.index += l;
+                /* At this spot we know that the socket buffers are
-                u->memchunk.length -= l;
+                 * fully filled up. This is the best time to estimate
+                 * the playback position of the server */
 
-                if (u->memchunk.length <= 0) {
+                n = u->offset;
-                    pa_memblock_unref(u->memchunk.memblock);
+
-                    pa_memchunk_reset(&u->memchunk);
+#ifdef SIOCOUTQ
+                {
+                    int l;
+                    if (ioctl(u->fd, SIOCOUTQ, &l) >= 0 && l > 0)
+                        n -= l;
                 }
+#endif
 
-                pollfd->revents = 0;
+                usec = pa_bytes_to_usec(n, &u->sink->sample_spec);
+
+                if (usec > u->latency)
+                    usec -= u->latency;
+                else
+                    usec = 0;
+
+                pa_smoother_put(u->smoother, pa_rtclock_usec(), usec);
             }
-        }
 
-        /* Hmm, nothing to do. Let's sleep */
+            /* Hmm, nothing to do. Let's sleep */
-        pollfd->events = u->sink->thread_info.state == PA_SINK_RUNNING ? POLLOUT : 0;
+            pollfd->events = PA_SINK_OPENED(u->sink->thread_info.state)  ? POLLOUT : 0;
+        }
 
         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
             goto fail;
@@ -204,11 +311,15 @@ static void thread_func(void *userdata) {
         if (ret == 0)
             goto finish;
 
-        pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
+        if (u->rtpoll_item) {
+            struct pollfd* pollfd;
 
-        if (pollfd->revents & ~POLLOUT) {
+            pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
-            pa_log("FIFO shutdown.");
+
-            goto fail;
+            if (pollfd->revents & ~POLLOUT) {
+                pa_log("FIFO shutdown.");
+                goto fail;
+            }
         }
     }
 
@@ -222,25 +333,41 @@ finish:
     pa_log_debug("Thread shutting down");
 }
 
+static void on_connection(PA_GCC_UNUSED int fd, void*userdata) {
+    struct userdata *u = userdata;
+    pa_assert(u);
+
+    pa_assert(u->fd < 0);
+    u->fd = fd;
+
+    pa_log_debug("Connection authenticated, handing fd to IO thread...");
+
+    pa_asyncmsgq_post(u->thread_mq.inq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_PASS_SOCKET, NULL, 0, NULL, NULL);
+}
+
 int pa__init(pa_module*m) {
-    struct userdata *u;
+    struct userdata *u = NULL;
-    //struct stat st;
+    const char *p;
     pa_sample_spec ss;
-    pa_channel_map map;
+    pa_modargs *ma = NULL;
-    pa_modargs *ma;
     char *t;
-    struct pollfd *pollfd;
 
     pa_assert(m);
 
     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
-        pa_log("Failed to parse module arguments.");
+        pa_log("failed to parse module arguments");
         goto fail;
     }
 
     ss = m->core->default_sample_spec;
-    if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
+    if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
-        pa_log("Invalid sample format specification or channel map");
+        pa_log("invalid sample format specification");
+        goto fail;
+    }
+
+    if ((/*ss.format != PA_SAMPLE_U8 &&*/ ss.format != PA_SAMPLE_S16NE) ||
+        (ss.channels > 2)) {
+        pa_log("sample type support is limited to mono/stereo and U8 or S16NE sample data");
         goto fail;
     }
 
@@ -248,54 +375,58 @@ int pa__init(pa_module*m) {
     u->core = m->core;
     u->module = m;
     m->userdata = u;
+    u->fd = -1;
+    u->smoother = pa_smoother_new(PA_USEC_PER_SEC, PA_USEC_PER_SEC*2, TRUE);
+    pa_memchunk_reset(&u->raw_memchunk);
+    pa_memchunk_reset(&u->encoded_memchunk);
+    u->offset = 0;
+    u->encoding_overhead = 0;
+    u->encoding_ratio = 1.0;
 
-    pa_memchunk_reset(&u->memchunk);
     pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
     u->rtpoll = pa_rtpoll_new();
     pa_rtpoll_item_new_asyncmsgq(u->rtpoll, PA_RTPOLL_EARLY, u->thread_mq.inq);
+    u->rtpoll_item = NULL;
 
-    u->server_name = pa_xstrdup(pa_modargs_get_value(ma, "server", NULL));
+    /*u->format =
+        (ss.format == PA_SAMPLE_U8 ? ESD_BITS8 : ESD_BITS16) |
+        (ss.channels == 2 ? ESD_STEREO : ESD_MONO);*/
+    u->rate = ss.rate;
+    u->block_size = pa_usec_to_bytes(PA_USEC_PER_SEC/20, &ss);
 
-    // Open a connection to the server... this is just to connect and test....
+    u->read_data = u->write_data = NULL;
-    /*
+    u->read_index = u->write_index = u->read_length = u->write_length = 0;
-    mkfifo(u->filename, 0666);
-    if ((u->fd = open(u->filename, O_RDWR|O_NOCTTY)) < 0) {
-        pa_log("open('%s'): %s", u->filename, pa_cstrerror(errno));
-        goto fail;
-    }
 
-    pa_make_fd_cloexec(u->fd);
+    /*u->state = STATE_AUTH;*/
-    pa_make_fd_nonblock(u->fd);
+    u->latency = 0;
 
-    if (fstat(u->fd, &st) < 0) {
+    if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, NULL))) {
-        pa_log("fstat('%s'): %s", u->filename, pa_cstrerror(errno));
-        goto fail;
-    }
-
-    if (!S_ISFIFO(st.st_mode)) {
-        pa_log("'%s' is not a FIFO.", u->filename);
-        goto fail;
-    }
-    */
-    if (!(u->sink = pa_sink_new(m->core, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
         pa_log("Failed to create sink.");
         goto fail;
     }
 
     u->sink->parent.process_msg = sink_process_msg;
     u->sink->userdata = u;
-    u->sink->flags = PA_SINK_LATENCY;
+    u->sink->flags = PA_SINK_LATENCY|PA_SINK_NETWORK;
 
     pa_sink_set_module(u->sink, m);
     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
     pa_sink_set_rtpoll(u->sink, u->rtpoll);
-    pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Airtunes sink '%s'", u->server_name));
+
+    if (!(p = pa_modargs_get_value(ma, "server", NULL))) {
+        pa_log("No server argument given.");
+        goto fail;
+    }
+
+    if (!(u->raop = pa_raop_client_new(u->core->mainloop, p))) {
+        pa_log("Failed to connect to server.");
+        goto fail;
+    }
+
+    pa_raop_client_set_callback(u->raop, on_connection, u);
+    pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Airtunes sink '%s'", p));
     pa_xfree(t);
 
-    u->rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, 1);
-    pollfd = pa_rtpoll_item_get_pollfd(u->rtpoll_item, NULL);
-    //pollfd->fd = u->fd;
-    pollfd->events = pollfd->revents = 0;
 
     if (!(u->thread = pa_thread_new(thread_func, u))) {
         pa_log("Failed to create thread.");
@@ -319,7 +450,6 @@ fail:
 
 void pa__done(pa_module*m) {
     struct userdata *u;
-
     pa_assert(m);
 
     if (!(u = m->userdata))
@@ -338,15 +468,29 @@ void pa__done(pa_module*m) {
     if (u->sink)
         pa_sink_unref(u->sink);
 
-    if (u->memchunk.memblock)
-       pa_memblock_unref(u->memchunk.memblock);
-
     if (u->rtpoll_item)
         pa_rtpoll_item_free(u->rtpoll_item);
 
     if (u->rtpoll)
         pa_rtpoll_free(u->rtpoll);
 
-    pa_xfree(u->server_name);
+    if (u->raw_memchunk.memblock)
+        pa_memblock_unref(u->raw_memchunk.memblock);
+
+    if (u->encoded_memchunk.memblock)
+        pa_memblock_unref(u->encoded_memchunk.memblock);
+
+    if (u->raop)
+        pa_raop_client_free(u->raop);
+
+    pa_xfree(u->read_data);
+    pa_xfree(u->write_data);
+
+    if (u->smoother)
+        pa_smoother_free(u->smoother);
+
+    if (u->fd >= 0)
+        pa_close(u->fd);
+
     pa_xfree(u);
 }