Add documentation to struct rc4_context.
[paraslash.git] / audiod.h
index 60de4ca..18bf48e 100644 (file)
--- a/audiod.h
+++ b/audiod.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -8,7 +8,7 @@
 
 
 int num_filters(int audio_format_num);
-int get_audio_format_num(char *name);
+int get_audio_format_num(const char *name);
 
 /** enum of audio formats supported by para_audiod */
 enum {AUDIOD_AUDIO_FORMATS_ENUM};
@@ -34,12 +34,6 @@ struct audiod_command {
        const char *name;
        /** pointer to the function that handles the command */
        int (*handler)(int, int, char**);
-       /**
-        * if the command prefers to handle the full line (rather than the usual
-        * argv[] array), it stores a pointer to the corresponding line handling
-        * function here. In this case, the above \a handler pointer must be NULL.
-        */
-       int (*line_handler)(int, char*);
        /** one-line description of the command */
        const char *description;
        /** summary of the command line options */
@@ -49,58 +43,32 @@ struct audiod_command {
 };
 
 /**
- * describes one instance of a receiver-filter-writer chain
+ * Describes one instance of a receiver-filter-writer chain.
  *
  * \sa receiver_node, receiver, filter, filter_node, filter_chain, writer,
  * writer_node, writer_node_group.
  */
 struct slot_info {
-       /** number of the audio format in this slot */
+       /** Number of the audio format in this slot. */
        int format;
-       /** writer start time */
+       /** Receiver start time. */
+       struct timeval rstime;
+       /** Writer start time. */
        struct timeval wstime;
-       /** the receiver info associated with this slot */
+       /** The stream_start status item announced by para_server.  */
+       struct timeval server_stream_start;
+       /** The offset status item announced by para_server. */
+       unsigned offset_seconds;
+       /** The seconds_total status item announced by para_server. */
+       unsigned seconds_total;
+       /** The receiver info associated with this slot. */
        struct receiver_node *receiver_node;
-       /** the active filter chain */
+       /** The active filter chain. */
        struct filter_chain *fc;
-       /** the active writer node group */
+       /** The active writer node group. */
        struct writer_node_group *wng;
 };
 
-/**
- * the task for obtaining para_server's status (para_client stat)
- *
- * \sa struct task, struct sched
- */
-struct status_task {
-       /** the associated task structure of audiod */
-       struct task task;
-       /** client data associated with the stat task */
-       struct client_task *ct;
-       /** do not restart client command until this time */
-       struct timeval restart_barrier;
-       /** last time we received status data from para_server */
-       struct timeval last_status_read;
-       /** the offset value announced by para_server */
-       int offset_seconds;
-       /** the length of the current audio file as announced by para_server */
-       int length_seconds;
-       /** the start of the current stream from the view of para_server */
-       struct timeval server_stream_start;
-       /** the average time deviation between para_server and para_audiod */
-       struct timeval sa_time_diff;
-       /** whether client time is ahead of server time */
-       int sa_time_diff_sign;
-       /** non-zero if para_server's status is "playing" */
-       int playing;
-       /** number of times the clock difference is to be checked */
-       unsigned clock_diff_count;
-       /** when to start the next check for clock difference */
-       struct timeval clock_diff_barrier;
-       /** Number of the audio format as announced by para_server. */
-       int current_audio_format_num;
-};
-
 extern struct slot_info slot[MAX_STREAM_SLOTS];
 extern struct audiod_args_info conf;
 extern int audiod_status;
@@ -108,8 +76,7 @@ extern int audiod_status;
 void __noreturn clean_exit(int status, const char *msg);
 int handle_connect(int accept_fd);
 void audiod_status_dump(void);
-void dump_empty_status(void);
-char *get_time_string(struct timeval *newest_stime);
+char *get_time_string(int slot_num);
 
 /** iterate over all slots */
 #define FOR_EACH_SLOT(_slot) for (_slot = 0; _slot < MAX_STREAM_SLOTS; _slot++)