fix doxygen comment of the init functions of all audio format handlers.
[paraslash.git] / audiod.c
index ed5344c076636f77e23fdf6c756f62e6a369a995..5515e5274f6ae152367b39f1a257c5fe5712fa6a 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <noll@mathematik.tu-darmstadt.de>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
 #include "write.h"
 #include "write_common.h"
 #include "error.h"
+#include "signal.h"
 
 /** define the array of error lists needed by para_audiod */
 INIT_AUDIOD_ERRLISTS;
 /** define the array containing all supported audio formats */
-DEFINE_AUDIO_FORMAT_ARRAY;
+const char *audio_formats[] = {AUDIOD_AUDIO_FORMAT_ARRAY NULL};
 
 /** defines how to handle one supported audio format */
 struct audio_format_info {
@@ -65,12 +66,28 @@ struct audio_format_info {
        struct timeval restart_barrier;
 };
 
+/**
+ * para_audiod uses \p MAX_STREAM_SLOTS different slots, each of which may
+ * be associated with a receiver/filter/writer triple. This array holds all
+ * information on the status of these slots.
+ *
+ * \sa struct slot_info
+ * */
 struct slot_info slot[MAX_STREAM_SLOTS];
 
 
+/**
+ * the current mode of operation of which can be changed by the on/off/cycle
+ * commands. It is either, AUDIOD_OFF, AUDIOD_ON or AUDIOD_STANDBY.
+ */
 int audiod_status = AUDIOD_ON;
 
+/**
+ * the gengetopt args_info struct that holds information on all command line
+ * arguments
+ */
 struct audiod_args_info conf;
+
 static char *socket_name;
 static FILE *logfile;
 static struct audio_format_info afi[NUM_AUDIO_FORMATS];
@@ -78,6 +95,12 @@ static struct audio_format_info afi[NUM_AUDIO_FORMATS];
 static struct signal_task signal_task_struct, *sig_task = &signal_task_struct;
 
 static struct status_task status_task_struct;
+
+/**
+ * the task that calls the status command of para_server
+ *
+ * \sa struct status_task
+ */
 struct status_task *stat_task = &status_task_struct;
 static struct timeval initial_delay_barrier;
 
@@ -124,8 +147,11 @@ int get_audio_format_num(char *name)
        return -E_UNSUPPORTED_AUDIO_FORMAT;
 }
 
-/*
- * log function. first argument is loglevel.
+/**
+ * the log function of para_audiod
+ *
+ * \param ll loglevel
+ * \param fmt the format string
  */
 void para_log(int ll, const char* fmt,...)
 {
@@ -242,38 +268,6 @@ static int get_empty_slot(void)
        return -E_NO_MORE_SLOTS;
 }
 
-static void close_stat_pipe(void)
-{
-       int i;
-
-       if (!stat_task->pcd)
-               return;
-       client_close(stat_task->pcd);
-       stat_task->pcd = NULL;
-       for (i = 0; i < NUM_STAT_ITEMS; i++) {
-               free(stat_task->stat_item_values[i]);
-               stat_task->stat_item_values[i] = NULL;
-       }
-       dump_empty_status();
-       stat_task->length_seconds = 0;
-       stat_task->offset_seconds = 0;
-       audiod_status_dump();
-       stat_task->playing = 0;
-       stat_task->stat_item_values[SI_STATUS_BAR] = make_message(
-               "%s:no connection to para_server\n",
-               status_item_list[SI_STATUS_BAR]);
-       stat_client_write(stat_task->stat_item_values[SI_STATUS_BAR], SI_STATUS_BAR);
-}
-
-void __noreturn clean_exit(int status, const char *msg)
-{
-       PARA_EMERG_LOG("%s\n", msg);
-       if (socket_name)
-               unlink(socket_name);
-       close_stat_pipe();
-       exit(status);
-}
-
 /**
  * get the number of filters
  *
@@ -473,14 +467,16 @@ static int open_current_receiver(struct sched *s)
        return open_receiver(i) < 0? 0 : 1;
 }
 
-static void compute_time_diff(const struct timeval *status_time)
+static unsigned compute_time_diff(const struct timeval *status_time)
 {
        struct timeval tmp, diff;
-       static int count;
+       static unsigned count;
        int sign, sa_time_diff_sign = stat_task->sa_time_diff_sign;
        const struct timeval max_deviation = {0, 500 * 1000};
        const int time_smooth = 5;
 
+       if (!status_time)
+               return count;
        sign = tv_diff(status_time, now, &diff);
 //             PARA_NOTICE_LOG("%s: sign = %i, sa_time_diff_sign = %i\n", __func__,
 //                     sign, sa_time_diff_sign);
@@ -488,7 +484,7 @@ static void compute_time_diff(const struct timeval *status_time)
                sa_time_diff_sign = sign;
                stat_task->sa_time_diff = diff;
                count++;
-               return;
+               goto out;
        }
        if (count > 5) {
                int s = tv_diff(&diff, &stat_task->sa_time_diff, &tmp);
@@ -502,12 +498,15 @@ static void compute_time_diff(const struct timeval *status_time)
                count > 10? sign : sign * time_smooth, &diff,
                &tmp);
        stat_task->sa_time_diff = tmp;
-       PARA_DEBUG_LOG("time diff (cur/avg): %s%lums/%s%lums\n",
+       PARA_INFO_LOG("time diff (cur/avg): %s%lums/%s%lums\n",
                sign > 0? "+" : "-",
                tv2ms(&diff),
                sa_time_diff_sign ? "+" : "-",
                tv2ms(&stat_task->sa_time_diff)
        );
+out:
+       stat_task->sa_time_diff_sign = sa_time_diff_sign;
+       return count;
 }
 
 static void check_stat_line(char *line)
@@ -525,6 +524,8 @@ static void check_stat_line(char *line)
                PARA_WARNING_LOG("invalid status line: %s\n", line);
                return;
        }
+       if (stat_task->clock_diff_count && itemnum != SI_CURRENT_TIME)
+               return;
        tmp = make_message("%s\n", line);
        stat_client_write(tmp, itemnum);
        free(tmp);
@@ -548,13 +549,15 @@ static void check_stat_line(char *line)
                        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 (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);
+                       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:
@@ -562,22 +565,12 @@ static void check_stat_line(char *line)
                        struct timeval tv = {sec, usec};
                        compute_time_diff(&tv);
                }
+               if (stat_task->clock_diff_count)
+                       stat_task->clock_diff_count--;
                break;
        }
 }
 
-static void handle_signal(int sig)
-{
-       switch (sig) {
-       case SIGINT:
-       case SIGTERM:
-       case SIGHUP:
-               PARA_EMERG_LOG("terminating on signal %d\n", sig);
-               clean_exit(EXIT_FAILURE, "caught deadly signal");
-               return;
-       }
-}
-
 static void try_to_close_slot(int slot_num)
 {
        struct slot_info *s = &slot[slot_num];
@@ -753,7 +746,6 @@ static int init_receivers(void)
        for (i = conf.receiver_given - 1; i >= 0; i--) {
                char *arg = conf.receiver_arg[i];
                char *recv_arg = strchr(arg, ':');
-               PARA_INFO_LOG("arg: %s\n", arg);
                ret = -E_MISSING_COLON;
                if (!recv_arg)
                        goto out;
@@ -904,10 +896,13 @@ static void signal_event_handler(struct task *t)
 {
        struct signal_task *st = t->private_data;
 
-       if (t->ret != -E_SIGNAL_CAUGHT)
-               PARA_ERROR_LOG("%s (ignored)\n", PARA_STRERROR(-t->ret));
-       else
-               handle_signal(st->signum);
+       switch (st->signum) {
+       case SIGINT:
+       case SIGTERM:
+       case SIGHUP:
+               PARA_EMERG_LOG("terminating on signal %d\n", st->signum);
+               clean_exit(EXIT_FAILURE, "caught deadly signal");
+       }
 }
 
 static void signal_pre_select(struct sched *s, struct task *t)
@@ -967,49 +962,107 @@ static void init_command_task(struct command_task *ct)
        sprintf(ct->task.status, "command task");
 }
 
-static void client_task_event_handler(__a_unused struct task *t)
+static void close_stat_pipe(void)
 {
-       struct private_client_data *pcd = t->private_data;
-       if (t->ret == -E_HANDSHAKE_COMPLETE)
+       int i;
+
+       if (!stat_task->pcd)
                return;
-       unregister_task(t);
-       pcd->eof = 1;
+       client_close(stat_task->pcd);
+       stat_task->pcd = NULL;
+       for (i = 0; i < NUM_STAT_ITEMS; i++) {
+               free(stat_task->stat_item_values[i]);
+               stat_task->stat_item_values[i] = NULL;
+       }
+       dump_empty_status();
+       stat_task->length_seconds = 0;
+       stat_task->offset_seconds = 0;
+       audiod_status_dump();
+       stat_task->playing = 0;
+       stat_task->stat_item_values[SI_STATUS_BAR] = make_message(
+               "%s:no connection to para_server\n",
+               status_item_list[SI_STATUS_BAR]);
+       stat_client_write(stat_task->stat_item_values[SI_STATUS_BAR],
+               SI_STATUS_BAR);
+       if (stat_task->clock_diff_count) {
+               stat_task->clock_diff_barrier.tv_sec = now->tv_sec + 1;
+               stat_task->clock_diff_barrier.tv_usec = now->tv_usec;
+       }
 }
 
-static void status_event_handler(__a_unused struct task *t)
+/**
+ * close the connection to para_server and exit
+ *
+ * \param status the exit status which is passed to exit(3)
+ * \param msg the log message
+ *
+ * Log \a msg with loglevel \p EMERG, close the connection to para_server if
+ * open, and call \p exit(status). \a status should be either EXIT_SUCCESS or
+ * EXIT_FAILURE.
+ *
+ * \sa exit(3)
+ */
+void __noreturn clean_exit(int status, const char *msg)
+{
+       PARA_EMERG_LOG("%s\n", msg);
+       if (socket_name)
+               unlink(socket_name);
+       close_stat_pipe();
+       exit(status);
+}
+
+/* avoid busy loop if server is down */
+static void set_stat_task_restart_barrier(void)
+{
+       struct timeval delay = {5, 0};
+       tv_add(now, &delay, &stat_task->restart_barrier);
+}
+
+static void client_task_event_handler(__a_unused struct task *t)
 {
-       struct timeval delay = {1, 0};
        int i;
-       struct status_task *st = t->private_data;
 
-       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-t->ret));
+       if (t->ret == -E_HANDSHAKE_COMPLETE)
+               return;
+       unregister_task(t);
        close_stat_pipe();
-       /* avoid busy loop if server is down */
-       tv_add(now, &delay, &st->restart_barrier);
+       if (t->ret != -E_SERVER_EOF)
+               stat_task->clock_diff_count = conf.clock_diff_count_arg;
+       set_stat_task_restart_barrier();
        FOR_EACH_AUDIO_FORMAT(i)
-               afi[i].restart_barrier = st->restart_barrier;
+               afi[i].restart_barrier = stat_task->restart_barrier;
 }
 
 static void status_pre_select(struct sched *s, struct task *t)
 {
        struct status_task *st = t->private_data;
-       int argc = 2;
-       char *argv[] = {"audiod", "stat", NULL};
-       t->ret = 1;
-       if (st->pcd && (audiod_status == AUDIOD_OFF || st->pcd->eof))
-               close_stat_pipe();
-       if (!st->pcd && audiod_status != AUDIOD_OFF
-               && tv_diff(now, &st->restart_barrier, NULL) > 0) {
-               t->ret = client_parse_config(argc, argv, &st->pcd);
-               if (t->ret < 0)
-                       return;
-               t->ret = client_open(st->pcd);
-               if (t->ret < 0)
+       int ret;
+
+       t->ret = 1; /* always successful */
+       if (st->pcd || audiod_status == AUDIOD_OFF)
+               return;
+       if (!st->clock_diff_count && tv_diff(now, &st->restart_barrier, NULL)
+                       < 0)
+               return;
+       if (st->clock_diff_count) {
+               char *argv[] = {"audiod", "stat", "1", NULL};
+               int argc = 3;
+               if (tv_diff(now, &st->clock_diff_barrier, NULL) < 0)
                        return;
-               st->pcd->task.event_handler = client_task_event_handler;
-               s->timeout.tv_sec = 0;
-               s->timeout.tv_usec = 1;
+               PARA_INFO_LOG("clock diff count: %d\n", st->clock_diff_count);
+               ret = client_open(argc, argv, &st->pcd);
+
+       } else {
+               char *argv[] = {"audiod", "stat", NULL};
+               int argc = 2;
+               ret = client_open(argc, argv, &st->pcd);
        }
+       set_stat_task_restart_barrier();
+       if (ret < 0)
+               return;
+       st->pcd->task.event_handler = client_task_event_handler;
+       s->timeout.tv_sec = 0;
+       s->timeout.tv_usec = 1;
 }
 
 static void status_post_select(__a_unused struct sched *s, struct task *t)
@@ -1020,6 +1073,12 @@ static void status_post_select(__a_unused struct sched *s, struct task *t)
        t->ret = 1;
        if (!st->pcd || st->pcd->status != CL_RECEIVING)
                return;
+       if (st->pcd && audiod_status == AUDIOD_OFF) {
+               unregister_task(&st->pcd->task);
+               close_stat_pipe();
+               st->clock_diff_count = conf.clock_diff_count_arg;
+               return;
+       }
        bytes_left = for_each_line(st->pcd->buf, st->pcd->loaded,
                &check_stat_line);
        if (st->pcd->loaded != bytes_left) {
@@ -1038,9 +1097,9 @@ static void init_status_task(struct status_task *st)
        memset(st, 0, sizeof(struct status_task));
        st->task.pre_select = status_pre_select;
        st->task.post_select = status_post_select;
-       st->task.event_handler = status_event_handler;
        st->task.private_data = st;
        st->sa_time_diff_sign = 1;
+       st->clock_diff_count = conf.clock_diff_count_arg;
        sprintf(st->task.status, "status task");
 }
 
@@ -1061,6 +1120,16 @@ static void set_initial_status(void)
                PARA_WARNING_LOG("%s", "invalid mode\n");
 }
 
+/**
+ * the main function of para_audiod
+ *
+ * \param argc usual argument count
+ * \param argv usual argument vector
+ *
+ * \return EXIT_SUCCESS or EXIT_FAILURE
+ *
+ * \sa para_audiod(1)
+ * */
 int main(int argc, char *argv[])
 {
        char *cf;
@@ -1071,6 +1140,7 @@ int main(int argc, char *argv[])
 
        valid_fd_012();
        audiod_cmdline_parser(argc, argv, &conf);
+       HANDLE_VERSION_FLAG("audiod", conf);
        para_drop_privileges(conf.user_arg, conf.group_arg);
        cf = configfile_exists();
        if (cf) {