Merge /fml/ag-raetsch/home/maan/scm/paraslash_meins/paraslash/

[paraslash.git] / audiod.c

diff --git a/audiod.c b/audiod.c
index 0105fa362fe845b6720f8ebcb8d7602f3987c0e6..9d0d0741cb86dd2e94c78eff1ed3503df5edbdd6 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -66,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];
@@ -79,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;
 
@@ -125,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,...)
 {
@@ -243,43 +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);
-       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;
-       }
-}
-
-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
  *
@@ -969,9 +957,58 @@ static void init_command_task(struct command_task *ct)
        sprintf(ct->task.status, "command task");
 }
 
+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);
+       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;
+       }
+}
+
+/**
+ * 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);
+}
+
+
 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};
 
@@ -1073,6 +1110,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;