replace standard GPL header by a one-line pointer to COPYING
[paraslash.git] / audiod.c
index 2dba01c6fa938dec24264d69480ddb5b0e23f61a..35c835ecc143fa6c2d73a1c16687f0ed8a8b8f00 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -1,19 +1,7 @@
 /*
  * 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
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file audiod.c the paraslash's audio daemon */
@@ -66,12 +54,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];
@@ -79,6 +83,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;
 
@@ -125,8 +135,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,...)
 {
@@ -442,14 +455,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);
@@ -479,6 +494,7 @@ static void compute_time_diff(const struct timeval *status_time)
        );
 out:
        stat_task->sa_time_diff_sign = sa_time_diff_sign;
+       return count;
 }
 
 static void check_stat_line(char *line)
@@ -521,13 +537,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:
@@ -606,7 +624,7 @@ static void audiod_pre_select(struct sched *s, __a_unused struct task *t)
                        s->timeout = min_delay;
                        continue;
                }
-               PARA_INFO_LOG("inital delay: %lu ms left\n", tv2ms(&diff));
+               PARA_INFO_LOG("initial delay: %lu ms left\n", tv2ms(&diff));
                if (tv_diff(&s->timeout, &diff, NULL) > 0) {
                        s->timeout = diff;
                }
@@ -960,6 +978,18 @@ static void close_stat_pipe(void)
        }
 }
 
+/**
+ * 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);
@@ -969,12 +999,16 @@ void __noreturn clean_exit(int status, const char *msg)
        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 private_client_data *pcd = t->private_data;
        int i;
-       struct timeval delay = {1, 0};
 
        if (t->ret == -E_HANDSHAKE_COMPLETE)
                return;
@@ -982,8 +1016,7 @@ static void client_task_event_handler(__a_unused struct task *t)
        close_stat_pipe();
        if (t->ret != -E_SERVER_EOF)
                stat_task->clock_diff_count = conf.clock_diff_count_arg;
-       /* avoid busy loop if server is down */
-       tv_add(now, &delay, &stat_task->restart_barrier);
+       set_stat_task_restart_barrier();
        FOR_EACH_AUDIO_FORMAT(i)
                afi[i].restart_barrier = stat_task->restart_barrier;
 }
@@ -1012,6 +1045,7 @@ static void status_pre_select(struct sched *s, struct task *t)
                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;
@@ -1074,6 +1108,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;