X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=audiod.h;h=8ead33440ce2a77676844b48c4faba7d6fdcb2ba;hp=077ce03e415f45c2937d953a8602193e7f6c68a1;hb=1b46ae4193cddb7d589b0f2f7d8158b84f7e9f6d;hpb=1db8df45ae458aec53f489b5cd414d6866f93b8c

diff --git a/audiod.h b/audiod.h
index 077ce03e..8ead3344 100644
--- a/audiod.h
+++ b/audiod.h
@@ -1,15 +1,36 @@
+/*
+ * Copyright (C) 2006-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.
+ */
+
 /** \file audiod.h symbols exported from audiod.c */
+
+
 int num_filters(int audio_format_num);
 int get_audio_format_num(char *name);
-enum {
-	AUDIO_FORMAT_MP3,
-	AUDIO_FORMAT_OGG,
-	AUDIO_FORMAT_AAC,
-	NUM_AUDIO_FORMATS
-};
+
+/** enum of audio formats supported by para_audiod */
+enum {AUDIOD_AUDIO_FORMATS_ENUM};
+
+/** array of audio format names supported by para_audiod */
 extern const char *audio_formats[];
-#define DEFINE_AUDIO_FORMAT_ARRAY const char *audio_formats[] = {"mp3", "ogg", "aac", NULL}
+
+/** maximal number of simultaneous instances */
 #define MAX_STREAM_SLOTS 5
+
 /**
  * the possible modes of operation
  *
@@ -19,6 +40,26 @@ extern const char *audio_formats[];
 */
 enum {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
  *
@@ -49,13 +90,14 @@ struct audiod_task {
 };
 
 /**
- * the task for audiod's child (para_client stat)
+ * 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 private_client_data *pcd;
 	/** the array of status items sent by para_server */
 	char *stat_item_values[NUM_STAT_ITEMS];
@@ -69,12 +111,16 @@ struct status_task {
 	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 */
+	/** 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 \a af_status is "playing" */
+	/** 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;
 };
 
 extern struct status_task *stat_task;