X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=76b819058642db7ffb81acf5eaa268f3cae37f3a;hp=9e04a7edee73bda7b90a5555b4281e74214f310a;hb=d5538ff0dd9f6531a1a319b49c32bd72597fb2c3;hpb=f31f8ceeaff0db558b63a46559e7d7464859d0c4

diff --git a/afs.h b/afs.h
index 9e04a7ed..76b81905 100644
--- a/afs.h
+++ b/afs.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2010 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -97,7 +97,13 @@ struct afs_table {
 		void *data);
 };
 
-enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
+/** How audio files are selected by afs. */
+enum play_mode {
+	/** Admissible files are determined by a mood definition. */
+	PLAY_MODE_MOOD,
+	/** All listed files are admissible. */
+	PLAY_MODE_PLAYLIST,
+};
 
 /**
  * Data about one audio file.
@@ -125,10 +131,25 @@ struct audio_file_data {
 	struct afh_info afhi;
 };
 
+/**
+ * Codes used for communication between the server and the afs process.
+ *
+ * Before forking the afs child, para_server creates a bidirectional pipe
+ * through which both processes communicate. Usually para_server requests a new
+ * audio in order to start streaming or when the end of the current audio file
+ * has been reached.  The afs process responds to such a request by sending
+ * back an eight byte buffer. The first four bytes is the uint32_t
+ * representation of the code, usually \p NEXT_AUDIO_FILE if an admissible
+ * audio file was found, successfully opened and verified. The other four bytes
+ * represent the shared memory id of the shared memory area that contains
+ * details about the audio file to be streamed next. The open file descriptor
+ * of that file is also passed from afs to para_server through the same pipe.
+ */
 enum afs_server_code {
+	/** An audio file was successfully opened. */
 	NEXT_AUDIO_FILE,
+	/** No admissible audio file was found. */
 	NO_ADMISSIBLE_FILES,
-	AFD_CHANGE
 };
 
 /** Flags passed to for_each_matching_row(). */
@@ -234,13 +255,6 @@ int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 void aft_check_callback(int fd, __a_unused const struct osl_object *query);
 
-/* mood */
-int change_current_mood(char *mood_name);
-void close_current_mood(void);
-int reload_current_mood(void);
-void mood_check_callback(int fd, __a_unused const struct osl_object *query);
-
-
 /* playlist */
 int playlist_open(char *name);
 void playlist_close(void);
@@ -278,21 +292,3 @@ enum blob_table_columns {
 	/** A blob table has that many columns. */
 	NUM_BLOB_COLUMNS
 };
-
-/** Define an osl table description for a blob table. */
-#define DEFINE_BLOB_TABLE_DESC(table_name) \
-	struct osl_table_description table_name ## _table_desc = { \
-		.name = #table_name, \
-		.num_columns = NUM_BLOB_COLUMNS, \
-		.flags = OSL_LARGE_TABLE, \
-		.column_descriptions = blob_cols \
-	};
-
-/** Define a pointer to an osl blob table with a canonical name. */
-#define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
-
-/** Define a blob table. */
-#define INIT_BLOB_TABLE(table_name) \
-	DEFINE_BLOB_TABLE_DESC(table_name); \
-	DEFINE_BLOB_TABLE_PTR(table_name);
-