X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=1399b2aba2d1509fe45ab10c285ae632156dd2e4;hp=9628d5c7c4a428c823f0523e9e98df4c454e1d4b;hb=53d503ce;hpb=1a4b98e797ab5ebb1ee1daa707aa0d520379ccc9

diff --git a/afs.h b/afs.h
index 9628d5c7..1399b2ab 100644
--- a/afs.h
+++ b/afs.h
@@ -4,6 +4,8 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
+/** \file afs.h Exported symbos of the audio file selector. */
+
 #include <regex.h>
 #include "osl.h"
 #include "hash.h"
@@ -12,7 +14,7 @@
 struct afs_info {
 	/** Seconds since the epoch. */
 	uint64_t last_played;
-	/** Bitfield of set attributes. */
+	/** Bit field of set attributes. */
 	uint64_t attributes;
 	/** Counts how many times the file was selected. */
 	uint32_t num_played;
@@ -24,11 +26,31 @@ struct afs_info {
 	uint8_t audio_format_id;
 };
 
-enum afs_table_flags {TBLFLAG_SKIP_CREATE};
+enum afs_events {
+	AFSI_CHANGE,
+	AFHI_CHANGE,
+	AUDIO_FILE_RENAME,
+	AUDIO_FILE_ADD,
+	AUDIO_FILE_REMOVE,
+	AUDIO_FILE_STREAMED,
+	ATTRIBUTE_ADD,
+	ATTRIBUTE_RENAME,
+	ATTRIBUTE_DELETE,
+	LYRICS_DELETE,
+	IMAGE_DELETE,
+	LYRICS_RENAME,
+	IMAGE_RENAME,
+
+};
 
-struct table_info {
-	const struct osl_table_description *desc;
-	enum afs_table_flags flags;
+struct afs_table {
+	void (*init)(struct afs_table *t);
+	const char *name;
+	int (*open)(const char *base_dir);
+	void (*close)(void);
+	int (*create)(const char *);
+	int (*event_handler)(enum afs_events event, struct para_buffer *pb,  void *data);
+	/* int *(check)() */
 };
 
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
@@ -42,26 +64,39 @@ struct audio_file_data {
 	struct osl_object map;
 };
 
+/** Flags passed to for_each_matching_row(). */
 enum pattern_match_flags {
+	/** Loop in reverse order. */
 	PM_REVERSE_LOOP = 1,
+	/** If no pattern is given, loop over all rows. */
 	PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+	/** If the data in match_column is the empty string, skip this row. */
 	PM_SKIP_EMPTY_NAME = 4,
 };
 
+/** Structure passed to for_each_matching_row(). */
 struct pattern_match_data {
+	/** Loop over all rows in this table. */
 	struct osl_table *table;
+	/** Determines the loop order. Must be an rbtree column. */
 	unsigned loop_col_num;
+	/** Data from this column is matched against the given patterns. */
 	unsigned match_col_num;
+	/** \see pattern_match_flags. */
 	unsigned pm_flags;
+	/** This value is passed verbatim to fnmatch(). */
 	int fnmatch_flags;
+	/** Null-terminated array of patterns. */
 	struct osl_object patterns;
+	/** Data pointer passed to the action function. */
 	void *data;
+	/** For each matching row, this function will be called. */
 	int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 };
 
 /* afs */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
-__noreturn int afs_init(uint32_t cookie, int socket_fd);
+__noreturn void afs_init(uint32_t cookie, int socket_fd);
 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,
@@ -77,8 +112,7 @@ 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);
@@ -90,20 +124,20 @@ int score_delete(const struct osl_row *aft_row);
 int row_belongs_to_score_table(const struct osl_row *aft_row);
 
 /* 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);
-int aft_get_row_of_path(char *path, struct osl_row **row);
+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_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_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);
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
@@ -111,7 +145,6 @@ 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);
@@ -121,7 +154,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);
@@ -131,9 +163,9 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
 
 
 #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_name_and_def_by_row(const struct osl_row *row, \
 		char **name, struct osl_object *def); \
 	extern struct osl_table *table_name ## _table;