Remove autogenerated doxygen comments for commands.
[paraslash.git] / audiod.c
index 72276ffe072f1a24fa67ac866e18c4d9a33889cd..40a35c6a601cf5839b044e44be35992b6e8036d3 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -9,7 +9,6 @@
 #include <sys/types.h>
 #include <dirent.h>
 #include <signal.h>
-#include <openssl/rc4.h>
 #include <stdbool.h>
 
 #include "para.h"
@@ -92,6 +91,7 @@ struct status_task {
        struct timeval restart_barrier;
        /** Last time we received status data from para_server. */
        struct timeval last_status_read;
+       size_t min_iqs;
        /** The offset value announced by para_server. */
        int offset_seconds;
        /** The length of the current audio file as announced by para_server. */
@@ -142,7 +142,6 @@ static struct status_task status_task_struct;
  * \sa struct status_task
  */
 static struct status_task *stat_task = &status_task_struct;
-static struct timeval initial_delay_barrier;
 
 /**
  * the task for handling audiod commands
@@ -160,13 +159,14 @@ struct command_task {
 #define FOR_EACH_AUDIO_FORMAT(af) for (af = 0; af < NUM_AUDIO_FORMATS; af++)
 
 /**
- * get the audio format number
- * \param name the name of the audio format
+ * Get the audio format number.
+ *
+ * \param name The name of the audio format.
  *
  * \return The audio format number on success, -E_UNSUPPORTED_AUDIO_FORMAT if
  * \a name is not a supported audio format.
  */
-int get_audio_format_num(const char *name)
+static int get_audio_format_num(const char *name)
 {
        int i;
 
@@ -178,6 +178,27 @@ int get_audio_format_num(const char *name)
        return -E_UNSUPPORTED_AUDIO_FORMAT;
 }
 
+/**
+ * Compute the play time based on information of the given slot.
+ *
+ * \param slot_num The slot number (negative means: no slot).
+ *
+ * This computes a string of the form "0:07 [3:33] (3%/3:40)" using information
+ * from the status items received from para_server and the start time of the
+ * (first) writer of the given slot.
+ *
+ * It has to to take into account that probably the stream was not started at
+ * the beginning of the file, that the clock between the server and the client
+ * host may differ and that playback of the stream was delayed, e.g. because
+ * the prebuffer filter is used in the filter configuration of the given slot.
+ *
+ * If no writer is active in the given slot, or \a slot_num is negative
+ * (indicating that para_audiod runs in standby mode), an approximation based
+ * only on the status items is computed and the returned string is prefixed
+ * with "~".
+ *
+ * \return A string that must be freed by the caller.
+ */
 char *get_time_string(int slot_num)
 {
        int ret, seconds = 0, length;
@@ -326,7 +347,6 @@ static void close_receiver(int slot_num)
 {
        struct slot_info *s = &slot[slot_num];
        struct audio_format_info *a;
-       struct timeval restart_delay = {0, 200 * 1000};
 
        if (s->format < 0 || !s->receiver_node)
                return;
@@ -337,7 +357,8 @@ static void close_receiver(int slot_num)
        btr_free_node(s->receiver_node->btrn);
        free(s->receiver_node);
        s->receiver_node = NULL;
-       tv_add(now, &restart_delay, &afi[s->format].restart_barrier);
+       tv_add(now, &(struct timeval)EMBRACE(0, 200 * 1000),
+               &a->restart_barrier);
 }
 
 static void writer_cleanup(struct writer_node *wn)
@@ -447,20 +468,6 @@ static int get_empty_slot(void)
        return -E_NO_MORE_SLOTS;
 }
 
-/**
- * get the number of filters
- *
- * \param audio_format_num the number identifying the audio format
- *
- * \return the number of filters for the given audio format
- *
- * \sa struct filter;
- */
-int num_filters(int audio_format_num)
-{
-       return afi[audio_format_num].num_filters;
-}
-
 static void open_filters(struct slot_info *s)
 {
        struct audio_format_info *a = afi + s->format;
@@ -527,16 +534,13 @@ static int open_receiver(int format)
        int ret, slot_num;
        struct receiver *r = a->receiver;
        struct receiver_node *rn;
-       const struct timeval restart_delay = {2, 0};
 
+       tv_add(now, &(struct timeval)EMBRACE(2, 0), &a->restart_barrier);
        ret = get_empty_slot();
        if (ret < 0)
-               goto err;
+               return ret;
        slot_num = ret;
-       s = &slot[slot_num];
-       s->format = format;
-       s->receiver_node = para_calloc(sizeof(struct receiver_node));
-       rn = s->receiver_node;
+       rn = para_calloc(sizeof(*rn));
        rn->receiver = r;
        rn->conf = a->receiver_conf;
        rn->btrn = btr_new_node(&(struct btr_node_description)
@@ -545,41 +549,48 @@ static int open_receiver(int format)
        if (ret < 0) {
                btr_free_node(rn->btrn);
                free(rn);
-               s->receiver_node = NULL;
-               goto err;
+               return ret;
        }
+       s = &slot[slot_num];
+       s->format = format;
+       s->receiver_node = rn;
        PARA_NOTICE_LOG("started %s: %s receiver in slot %d\n",
-               audio_formats[s->format], r->name, slot_num);
+               audio_formats[format], r->name, slot_num);
        rn->task.pre_select = r->pre_select;
        rn->task.post_select = r->post_select;
        sprintf(rn->task.status, "%s receiver node", r->name);
        register_task(&rn->task);
-       ret = slot_num;
-err:
-       if (ret < 0)
-               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
-       tv_add(now, &restart_delay, &afi[format].restart_barrier);
-       return ret;
+       return slot_num;
 }
 
-/* return: 0: Not running, 1: Running, -1: Running but eof (or error) */
-static int receiver_running(int format)
+static bool receiver_running(void)
 {
-       int i, ret = 0;
+       int i;
+       long unsigned ss1 = stat_task->server_stream_start.tv_sec;
 
        FOR_EACH_SLOT(i) {
                struct slot_info *s = &slot[i];
-               if (s->format != format)
-                       continue;
+               long unsigned ss2 = s->server_stream_start.tv_sec;
+
                if (!s->receiver_node)
                        continue;
                if (s->receiver_node->task.error >= 0)
-                       return 1;
-               ret = -1;
+                       return true;
+               if (ss1 == ss2)
+                       return true;
        }
-       return ret;
+       return false;
 }
 
+/**
+ * Return the root node of the current buffer tree.
+ *
+ * This is only used for stream grabbing.
+ *
+ * \return \p NULL if no slot is currently active. If more than one buffer tree
+ * exists, the node corresponding to the most recently started receiver is
+ * returned.
+ */
 struct btr_node *audiod_get_btr_root(void)
 {
        int i, newest_slot = -1;
@@ -606,15 +617,20 @@ struct btr_node *audiod_get_btr_root(void)
 /* whether a new instance of a decoder should be started. */
 static bool must_start_decoder(void)
 {
-       int ret, cafn = stat_task->current_audio_format_num;
+       int cafn = stat_task->current_audio_format_num;
+       unsigned vs = stat_task->vss_status;
 
-       if (cafn < 0 || !stat_task->ct)
+       if (audiod_status != AUDIOD_ON)
                return false;
-       /* Do nothing if the 'N' flag is set or the 'P' flag is unset */
-       if (stat_task->vss_status != VSS_STATUS_FLAG_PLAYING)
+       if (cafn < 0)
                return false;
-       ret = receiver_running(cafn);
-       if (ret != 0) /* already running */
+       if (!stat_task->ct)
+               return false;
+       if (vs & VSS_STATUS_FLAG_NEXT)
+               return false;
+       if (!(vs & VSS_STATUS_FLAG_PLAYING))
+               return false;
+       if (receiver_running())
                return false;
        if (tv_diff(now, &afi[cafn].restart_barrier, NULL) < 0)
                return false;
@@ -688,20 +704,8 @@ static int update_item(int itemnum, char *buf)
                break;
        case SI_STREAM_START:
                if (sscanf(buf, "%lu.%lu", &sec, &usec) == 2) {
-                       struct timeval a_start, delay;
-                       delay.tv_sec = conf.stream_delay_arg / 1000;
-                       delay.tv_usec = (conf.stream_delay_arg % 1000) * 1000;
                        stat_task->server_stream_start.tv_sec = sec;
                        stat_task->server_stream_start.tv_usec = usec;
-                       if (compute_time_diff(NULL) > 2) {
-                               if (stat_task->sa_time_diff_sign < 0)
-                                       tv_add(&stat_task->server_stream_start,
-                                               &stat_task->sa_time_diff, &a_start);
-                               else
-                                       tv_diff(&stat_task->server_stream_start,
-                                               &stat_task->sa_time_diff, &a_start);
-                               tv_add(&a_start, &delay, &initial_delay_barrier);
-                       }
                }
                break;
        case SI_CURRENT_TIME:
@@ -804,6 +808,14 @@ static int parse_receiver_args(void)
                ret = get_audio_format_num(arg);
                if (ret < 0)
                        goto out;
+               /*
+                * If multiple receivers are given for this audio format, the
+                * last one wins and we have to free the previous receiver
+                * config here. Since we are iterating backwards, the winning
+                * receiver arg is in fact the first one given.
+                */
+               if (afi[ret].receiver_conf)
+                       afi[ret].receiver->free_config(afi[ret].receiver_conf);
                afi[ret].receiver_conf = check_receiver_arg(recv_arg, &receiver_num);
                if (!afi[ret].receiver_conf) {
                        ret = -E_RECV_SYNTAX;
@@ -811,9 +823,9 @@ static int parse_receiver_args(void)
                }
                afi[ret].receiver = &receivers[receiver_num];
        }
-       /* use the first available receiver with no arguments
-        * for those audio formats for which no receiver
-        * was specified
+       /*
+        * Use the first available receiver with no arguments for those audio
+        * formats for which no receiver was specified.
         */
        cmd = para_strdup(receivers[0].name);
        FOR_EACH_AUDIO_FORMAT(i) {
@@ -842,6 +854,18 @@ static int init_default_filters(void)
 
                if (a->num_filters)
                        continue; /* no default -- nothing to to */
+               /*
+                * If udp is used to receive this audiod format, add fecdec as
+                * the first filter.
+                */
+               if (strcmp(afi[i].receiver->name, "udp") == 0 ||
+                               strcmp(afi[i].receiver->name, "dccp") == 0) {
+                       tmp = para_strdup("fecdec");
+                       add_filter(i, tmp);
+                       free(tmp);
+                       if (ret < 0)
+                               goto out;
+               }
                /* add "dec" to audio format name */
                tmp = make_message("%sdec", audio_formats[i]);
                for (j = 0; filters[j].name; j++)
@@ -867,7 +891,7 @@ static int parse_filter_args(void)
 {
        int i, ret, nf;
 
-       nf = PARA_MAX(1U, conf.filter_given);
+       nf = PARA_MAX(2U, conf.filter_given);
        PARA_INFO_LOG("maximal number of filters: %d\n", nf);
        FOR_EACH_AUDIO_FORMAT(i) {
                afi[i].filter_conf = para_malloc(nf * sizeof(void *));
@@ -952,19 +976,16 @@ static void signal_pre_select(struct sched *s, struct task *t)
        para_fd_set(st->fd, &s->rfds, &s->max_fileno);
 }
 
-static void signal_post_select(struct sched *s, struct task *t)
+static void signal_post_select(struct sched *s, __a_unused struct task *t)
 {
-       struct signal_task *st = container_of(t, struct signal_task, task);
+       int signum;
 
-       if (!FD_ISSET(st->fd, &s->rfds))
-               return;
-
-       st->signum = para_next_signal();
-       switch (st->signum) {
+       signum = para_next_signal(&s->rfds);
+       switch (signum) {
        case SIGINT:
        case SIGTERM:
        case SIGHUP:
-               PARA_EMERG_LOG("terminating on signal %d\n", st->signum);
+               PARA_EMERG_LOG("terminating on signal %d\n", signum);
                clean_exit(EXIT_FAILURE, "caught deadly signal");
        }
 }
@@ -995,11 +1016,10 @@ static void command_post_select(struct sched *s, struct task *t)
                last_status_dump = *now;
        }
 
-       if (!FD_ISSET(ct->fd, &s->rfds))
-               return;
-       ret = handle_connect(ct->fd);
+       ret = handle_connect(ct->fd, &s->rfds);
        if (ret < 0)
                PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+       audiod_status_dump();
 }
 
 static void init_command_task(struct command_task *ct)
@@ -1062,17 +1082,17 @@ static void try_to_close_slot(int slot_num)
 
        if (s->format < 0)
                return;
-       if (s->receiver_node && s->receiver_node->task.error != -E_TASK_UNREGISTERED)
+       if (s->receiver_node && s->receiver_node->task.error >= 0)
                return;
        for (i = 0; i < a->num_filters; i++)
-               if (s->fns && s->fns[i].task.error != -E_TASK_UNREGISTERED)
+               if (s->fns && s->fns[i].task.error >= 0)
                        return;
        if (a->num_writers > 0) {
                for (i = 0; i < a->num_writers; i++)
-                       if (s->wns && s->wns[i].task.error != -E_TASK_UNREGISTERED)
+                       if (s->wns && s->wns[i].task.error >= 0)
                                return;
        } else {
-               if (s->wns && s->wns[0].task.error != -E_TASK_UNREGISTERED)
+               if (s->wns && s->wns[0].task.error >= 0)
                        return;
        }
        PARA_INFO_LOG("closing slot %d\n", slot_num);
@@ -1100,8 +1120,10 @@ static void start_stop_decoders(void)
        if (!must_start_decoder())
                return;
        ret = open_receiver(stat_task->current_audio_format_num);
-       if (ret < 0)
+       if (ret < 0) {
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
                return;
+       }
        sl = slot + ret;
        a = afi + sl->format;
        if (a->num_filters)
@@ -1121,10 +1143,19 @@ static void status_pre_select(struct sched *s, struct task *t)
        ret = btr_node_status(st->btrn, 0, BTR_NT_LEAF);
        if (ret > 0)
                goto min_delay;
-       if (!st->ct)
+       if (st->ct && audiod_status == AUDIOD_OFF)
+               goto min_delay;
+       if (!st->ct && audiod_status != AUDIOD_OFF)
                sched_request_barrier_or_min_delay(&st->restart_barrier, s);
        if (cafn >= 0)
                sched_request_barrier(&afi[cafn].restart_barrier, s);
+       /*
+        * If para_server is playing we'd like to have a smooth time display
+        * even if we are running in standby mode. So we request a timeout that
+        * expires at the next full second.
+        */
+       if (stat_task->vss_status & VSS_STATUS_FLAG_PLAYING)
+               sched_request_timeout_ms(1000 - now->tv_usec / 1000, s);
        return;
 min_delay:
        sched_min_delay(s);
@@ -1142,7 +1173,7 @@ static void status_post_select(__a_unused struct sched *s, struct task *t)
                        kill_btrn(st->ct->btrn, &st->ct->task, -E_AUDIOD_OFF);
                        goto out;
                }
-               if (st->ct->task.error != -E_TASK_UNREGISTERED)
+               if (st->ct->task.error >= 0)
                        goto out;
                close_stat_pipe();
                st->clock_diff_count = conf.clock_diff_count_arg;
@@ -1153,34 +1184,39 @@ static void status_post_select(__a_unused struct sched *s, struct task *t)
                size_t sz;
                int ret;
                if (st->ct->task.error < 0) {
-                       if (st->ct->task.error != -E_TASK_UNREGISTERED)
+                       if (st->ct->task.error >= 0)
                                goto out;
                        close_stat_pipe();
                        goto out;
                }
                if (st->ct->status != CL_RECEIVING)
                        goto out;
-               ret = btr_node_status(st->btrn, 0, BTR_NT_LEAF);
-               if (ret <= 0)
+               ret = btr_node_status(st->btrn, st->min_iqs, BTR_NT_LEAF);
+               if (ret <= 0) {
+                       struct timeval diff;
+                       tv_diff(now, &st->last_status_read, &diff);
+                       if (diff.tv_sec > 61)
+                               kill_btrn(st->ct->btrn, &st->ct->task,
+                                       -E_STATUS_TIMEOUT);
                        goto out;
+               }
+               btr_merge(st->btrn, st->min_iqs);
                sz = btr_next_buffer(st->btrn, &buf);
                ret = for_each_stat_item(buf, sz, update_item);
                if (ret < 0) {
                        kill_btrn(st->ct->btrn, &st->ct->task, ret);
                        goto out;
                }
-               if (sz != ret)
+               if (sz != ret) {
+                       btr_consume(st->btrn, sz - ret);
                        st->last_status_read = *now;
-               else {
-                       struct timeval diff;
-                       tv_diff(now, &st->last_status_read, &diff);
-                       if (diff.tv_sec > 61)
-                               kill_btrn(st->ct->btrn, &st->ct->task,
-                                       -E_STATUS_TIMEOUT);
-               }
-               btr_consume(st->btrn, sz - ret);
+                       st->min_iqs = 0;
+               } else /* current status item crosses buffers */
+                       st->min_iqs = sz + 1;
                goto out;
        }
+       btr_drain(st->btrn);
+       st->current_audio_format_num = -1;
        if (tv_diff(now, &st->restart_barrier, NULL) < 0)
                goto out;
        if (st->clock_diff_count) { /* get status only one time */
@@ -1255,17 +1291,14 @@ __noreturn static void print_help_and_die(void)
 
 static void init_colors_or_die(void)
 {
-       int ret, i;
+       int i;
 
        if (!want_colors())
                return;
        daemon_set_default_log_colors();
        daemon_set_flag(DF_COLOR_LOG);
-       for (i = 0; i < conf.log_color_given; i++) {
-               ret = daemon_set_log_color(conf.log_color_arg[i]);
-               if (ret < 0)
-                       exit(EXIT_FAILURE);
-       }
+       for (i = 0; i < conf.log_color_given; i++)
+               daemon_set_log_color_or_die(conf.log_color_arg[i]);
 }
 
 /**