build: Unify spelling of commands and directories.

[paraslash.git] / audiod.h

diff --git a/audiod.h b/audiod.h
index 856bc05126dbcb54a24a311a2f0eb19b42060d95..3b4b9bd0416720e5e7d9455df23221cb049a2fc8 100644 (file)
--- a/audiod.h
+++ b/audiod.h
@@ -1,6 +1,11 @@
-/** \file audiod.h symbols exported from audiod.c */
-int num_filters(int audio_format_num);
-int get_audio_format_num(char *name);
+/*
+ * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file audiod.h Symbols exported from audiod.c. */
+
 
 /** enum of audio formats supported by para_audiod */
 enum {AUDIOD_AUDIO_FORMATS_ENUM};
@@ -8,86 +13,38 @@ enum {AUDIOD_AUDIO_FORMATS_ENUM};
 /** array of audio format names supported by para_audiod */
 extern const char *audio_formats[];
 
-/** maximal number of simultaneous instances */
-#define MAX_STREAM_SLOTS 5
-
 /**
  * the possible modes of operation
  *
  * - 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};
-
-/**
- * describes one instance of a receiver-filter-writer chain
- *
- * \sa receier_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;
-       /** writer start time */
-       struct timeval wstime;
-       /** the receiver info associated with this slot */
-       struct receiver_node *receiver_node;
-       /** the active filter chain */
-       struct filter_chain *fc;
-       /** the active writer node group */
-       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 audiod's child (para_client stat)
- *
- * \sa struct task, struct sched
  */
-struct status_task {
-       /** the associated task structure of audiod */
-       struct task task;
-       struct private_client_data *pcd;
-       /** the array of status items sent by para_server */
-       char *stat_item_values[NUM_STAT_ITEMS];
-       /** 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 averaged 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 \a af_status is "playing" */
-       int playing;
+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**);
+       /** 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;
 };
 
-extern struct status_task *stat_task;
-extern struct slot_info slot[MAX_STREAM_SLOTS];
+__malloc char *audiod_get_decoder_flags(void);
 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);
-void audiod_status_dump(void);
-void dump_empty_status(void);
+int handle_connect(int accept_fd, fd_set *rfds, uid_t *uid_whitelist);
+void audiod_status_dump(bool force);
+char *get_time_string(void);
+struct btr_node *audiod_get_btr_root(void);
 
-/** iterate over all slots */
-#define FOR_EACH_SLOT(_slot) for (_slot = 0; _slot < MAX_STREAM_SLOTS; _slot++)
+void stat_client_write_item(int item_num);
+void clear_and_dump_items(void);
+void close_stat_clients(void);