X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=f9a44893db741e5ac7eabb9d52175c804d2f75bd;hp=ab2db3aa1f90c561732abc34b528f0a7b20f1ebb;hb=74cfed2536a16ca85bc0ce97f6bf307c96ae0d3d;hpb=ea689d919fd6fdbfaba2de9d1cd207e033c319fd

diff --git a/afs.h b/afs.h
index ab2db3aa..f9a44893 100644
--- a/afs.h
+++ b/afs.h
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file afs.h Exported symbos of the audio file selector. */
+/** \file afs.h Exported symbols of the audio file selector. */
 
 #include <regex.h>
 #include "osl.h"
@@ -26,22 +26,104 @@ struct afs_info {
 	uint8_t audio_format_id;
 };
 
-enum afs_table_flags {TBLFLAG_SKIP_CREATE};
+/**
+ * Events caused by changes to an afs table.
+ *
+ * Whenever an afs table changes, an event is generated which causes afs to
+ * call the event handlers of all other tables. For example, if an audio file
+ * is added, the event handler of the mood table checks the new file for
+ * admissibility.
+ */
+enum afs_events {
+	/** An attribute was added. */
+	ATTRIBUTE_ADD,
+	/** An attribute was renamed. */
+	ATTRIBUTE_RENAME,
+	/** An attribute was removed. */
+	ATTRIBUTE_REMOVE,
+	/** The afs info struct of an audio file changed. */
+	AFSI_CHANGE,
+	/** The afh info struct of an audio file changed. */
+	AFHI_CHANGE,
+	/** An audio file was renamed. */
+	AUDIO_FILE_RENAME,
+	/** An audio file was added. */
+	AUDIO_FILE_ADD,
+	/** An audio file is about to be removed. */
+	AUDIO_FILE_REMOVE,
+	/** A new blob was added. */
+	BLOB_ADD,
+	/** A blob was renamed. */
+	BLOB_RENAME,
+	/** A blob is about to be removed. */
+	BLOB_REMOVE,
+};
+
+struct rmatt_event_data {
+	const char *name;
+	unsigned char bitnum;
+};
 
-struct table_info {
-	const struct osl_table_description *desc;
-	enum afs_table_flags flags;
+
+struct afsi_change_event_data {
+	const struct osl_row *aft_row;
+	struct afs_info *old_afsi;
+};
+
+/** Function pointers for table handling.  */
+struct afs_table {
+	/** Initializes the other pointers in this struct. */
+	void (*init)(struct afs_table *t);
+	/** The name of this table. */
+	const char *name;
+	/** Gets called on startup and on \p SIGHUP. */
+	int (*open)(const char *base_dir);
+	/** Gets called on shutdown and on \p SIGHUP. */
+	void (*close)(void);
+	/** Called by the \a init afs command. */
+	int (*create)(const char *);
+	/** Handles afs events. */
+	int (*event_handler)(enum afs_events event, struct para_buffer *pb,
+		void *data);
+	/* int *(check)() */
 };
 
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
 
+/**
+ * Data about one audio file.
+ *
+ * Needed to produce ls and stat output.
+ */
+struct ls_data {
+	/** Usual audio format handler information. */
+	struct afh_info afhi;
+	/** Audio file selector information. */
+	struct afs_info afsi;
+	/** The full path of the audio file. */
+	char *path;
+	/** The score value (if -a was given). */
+	long score;
+	/** The sha1 hash of audio file. */
+	HASH_TYPE *hash;
+};
+int make_status_items(struct ls_data *d, struct para_buffer *pb);
+
+#define AFS_STATUS_INFO_SIZE 4096
+
 struct audio_file_data {
 	enum play_mode current_play_mode;
+	char path[_POSIX_PATH_MAX];
+	char afs_status_info[AFS_STATUS_INFO_SIZE];
+	int fd;
 	long score;
 	struct afs_info afsi;
-	struct audio_format_info afhi;
-	char *path;
-	struct osl_object map;
+	struct afh_info afhi;
+};
+
+enum afs_server_code {
+	NEXT_AUDIO_FILE,
+	AFD_CHANGE
 };
 
 /** Flags passed to for_each_matching_row(). */
@@ -77,6 +159,8 @@ struct pattern_match_data {
 /* afs */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
 __noreturn void afs_init(uint32_t cookie, int socket_fd);
+void afs_event(enum afs_events event, struct para_buffer *pb,
+	void *data);
 int send_callback_request(callback_function *f, struct osl_object *query,
 	struct osl_object *result);
 int send_standard_callback_request(int argc, char * const * const argv,
@@ -87,13 +171,11 @@ int send_option_arg_callback_request(struct osl_object *options,
 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
 		unsigned max_len, struct osl_object *result);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
-int open_next_audio_file(struct audio_file_data *afd);
 int close_audio_file(struct audio_file_data *afd);
 int for_each_matching_row(struct pattern_match_data *pmd);
 
 /* score */
-int score_init(struct table_info *ti, const char *db);
-void score_shutdown(enum osl_close_flags flags);
+void score_init(struct afs_table *t);
 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
 int score_get_best(struct osl_row **aft_row, long *score);
@@ -102,24 +184,24 @@ int score_add(const struct osl_row *row, long score);
 int score_update(const struct osl_row *aft_row, long new_score);
 int get_num_admissible_files(unsigned *num);
 int score_delete(const struct osl_row *aft_row);
-int row_belongs_to_score_table(const struct osl_row *aft_row);
+int clear_score_table(void);
+int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
 
 /* attribute */
-int attribute_init(struct table_info *ti, const char *db);
-void attribute_shutdown(enum osl_close_flags flags);
+void attribute_init(struct afs_table *t);
 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 
 /* aft */
-int aft_init(struct table_info *ti, const char *db);
-void aft_shutdown(enum osl_close_flags flags);
+void aft_init(struct afs_table *t);
 int aft_get_row_of_path(const char *path, struct osl_row **row);
 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
+int load_afd(int shmid, struct audio_file_data *afd);
 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
-int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
+int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
 int get_afsi_of_path(const char *path, struct afs_info *afsi);
 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
@@ -129,9 +211,7 @@ int aft_check_callback(const struct osl_object *query, struct osl_object *result
 /* mood */
 int change_current_mood(char *mood_name);
 void close_current_mood(void);
-int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
 int reload_current_mood(void);
-int mood_delete_audio_file(const struct osl_row *aft_row);
 int mood_check_callback(__a_unused const struct osl_object *query,
 	struct osl_object *result);
 
@@ -139,7 +219,6 @@ int mood_check_callback(__a_unused const struct osl_object *query,
 /* playlist */
 int playlist_open(char *name);
 void playlist_close(void);
-int playlist_update_audio_file(struct osl_row *aft_row);
 int playlist_check_callback(__a_unused const struct osl_object *query,
 	struct osl_object *result);
 
@@ -147,13 +226,16 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 
 
+/** Define exported functions and a table pointer for an osl blob table. */
 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
-	int table_name ## _init(struct table_info *ti, const char *db); \
-	void table_name ## _shutdown(enum osl_close_flags flags); \
+	void table_name ## _init(struct afs_table *t); \
 	int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 	int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
+	int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
 	int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 		char **name, struct osl_object *def); \
+	int table_name ##_event_handler(enum afs_events event, \
+		struct para_buffer *pb, void *data); \
 	extern struct osl_table *table_name ## _table;
 
 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
@@ -173,6 +255,7 @@ enum blob_table_columns {
 	NUM_BLOB_COLUMNS
 };
 
+/** Define an osl table decription for a blob table. */
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
 	struct osl_table_description table_name ## _table_desc = { \
 		.name = #table_name, \
@@ -181,8 +264,10 @@ enum blob_table_columns {
 		.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);