X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=52d376737578fa8697bfcfbd873d65cac4dc2169;hp=b5e9d56b2764e4befd5573f7d7c84062fab2df7a;hb=5b8e525dfb2f18a4e0d67b9da264259159ad2184;hpb=fa2e4b062432412b90ad7ba6e85d27764544f1c8 diff --git a/afs.h b/afs.h index b5e9d56b..52d37673 100644 --- a/afs.h +++ b/afs.h @@ -1,10 +1,10 @@ /* - * Copyright (C) 2007 Andre Noll + * Copyright (C) 2007-2008 Andre Noll * * 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 #include "osl.h" @@ -26,19 +26,37 @@ struct afs_info { uint8_t audio_format_id; }; +/** + * 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 { @@ -47,22 +65,24 @@ struct rmatt_event_data { }; -struct addatt_event_data { - const char *name; - unsigned char bitnum; -}; - struct afsi_change_event_data { - const struct osl_row *aft_row; + 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)() */ @@ -70,18 +90,42 @@ struct afs_table { 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); +void make_empty_status_items(char *buf); + +/** At most that many bytes will be passed from afs to para_server. */ +#define VERBOSE_LS_OUTPUT_SIZE 4096 + +/** Data about the current audio file, passed from afs to server. */ struct audio_file_data { - enum play_mode current_play_mode; - char attributes_string[MAXLINE]; - char path[_POSIX_PATH_MAX]; + /** Same info as ls -lv -p current audio_file. */ + char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE]; + /** The open file descriptor to the current audio file. */ int fd; - long score; - struct afs_info afsi; - struct audio_format_info afhi; + /** Vss needs this for streaming. */ + struct afh_info afhi; }; enum afs_server_code { NEXT_AUDIO_FILE, + NO_ADMISSIBLE_FILES, AFD_CHANGE }; @@ -116,6 +160,14 @@ struct pattern_match_data { }; /* afs */ +/** + * Afs command handlers run as a process which is not related to the afs + * process, i.e. they can not change the address space of afs directly. + * Therefore afs commands typically consist of two functions: The command + * handler and the corresponding callback function that runs in afs context. + * + * \sa send_callback_request(). + */ 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, @@ -130,7 +182,6 @@ 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 close_audio_file(struct audio_file_data *afd); int for_each_matching_row(struct pattern_match_data *pmd); /* score */ @@ -155,12 +206,13 @@ int get_attribute_text(uint64_t *atts, const char *delim, char **text); /* aft */ 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 open_and_update_audio_file(struct osl_row *aft_row, long score, + 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); @@ -178,7 +230,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); @@ -186,6 +237,7 @@ 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) \ void table_name ## _init(struct afs_table *t); \ int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \ @@ -214,6 +266,7 @@ enum blob_table_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, \ @@ -222,8 +275,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);