03_TCP-socket-functions.diff
[paraslash.git] / audiod.h
index 234c67a..9c53e6d 100644 (file)
--- a/audiod.h
+++ b/audiod.h
@@ -1,4 +1,12 @@
+/*
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
 /** \file audiod.h symbols exported from audiod.c */
+
+
 int num_filters(int audio_format_num);
 int get_audio_format_num(char *name);
 
@@ -17,15 +25,35 @@ extern const char *audio_formats[];
  * - off: disconnect from para_server
  * - on: receive status information from para_server and play the audio stream
  * - sb: only receive status information but not the audio stream
-*/
-enum {AUDIOD_OFF, AUDIOD_ON, AUDIOD_STANDBY};
+ */
+enum audiod_status_info {AUDIOD_OFF, AUDIOD_ON, AUDIOD_STANDBY};
+
+/** defines one command of para_audiod */
+struct audiod_command {
+       /** the name of the 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 */
+       const char *usage;
+       /** the long help text */
+       const char *help;
+};
 
 /**
  * describes one instance of a receiver-filter-writer chain
  *
- * \sa receier_node, receiver, filter, filter_node, filter_chain, writer,
+ * \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 */
        int format;
@@ -39,16 +67,6 @@ struct slot_info {
        struct writer_node_group *wng;
 };
 
-/**
- * the main task of audiod
- *
- * \sa struct task, struct sched
- */
-struct audiod_task {
-       struct timeval *now;
-       struct task task;
-};
-
 /**
  * the task for obtaining para_server's status (para_client stat)
  *
@@ -87,7 +105,6 @@ extern struct status_task *stat_task;
 extern struct slot_info slot[MAX_STREAM_SLOTS];
 extern struct audiod_args_info conf;
 extern int audiod_status;
-extern const char *status_item_list[NUM_STAT_ITEMS];
 
 void __noreturn clean_exit(int status, const char *msg);
 int handle_connect(int accept_fd);