X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=76b819058642db7ffb81acf5eaa268f3cae37f3a;hp=db931d989133a53a82ae38c07bbe75aeb581e5a6;hb=d5538ff0dd9f6531a1a319b49c32bd72597fb2c3;hpb=02d818d9e4d816d6decb319b522f0074038e68e2 diff --git a/afs.h b/afs.h index db931d98..76b81905 100644 --- a/afs.h +++ b/afs.h @@ -1,13 +1,12 @@ /* - * Copyright (C) 2007 Andre Noll + * Copyright (C) 2007-2010 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" #include "hash.h" /** Audio file selector data stored in the audio file table. */ @@ -24,59 +23,133 @@ struct afs_info { uint32_t lyrics_id; /** Mp3, ogg or aac. */ uint8_t audio_format_id; + /** Amplification value. */ + uint8_t amp; }; +/** + * 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, - }; +/** + * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_ADD. + */ struct rmatt_event_data { + /** The name of the attribute being added. */ const char *name; + /** Its bit number. */ unsigned char bitnum; }; - -struct addatt_event_data { - const char *name; - unsigned char bitnum; -}; - +/** + * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_AFSI_CHANGE. + */ struct afsi_change_event_data { - const struct osl_row *aft_row; + /** Pointer to the row that has changed. */ + struct osl_row *aft_row; + /** Afs info before the change. */ 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}; +/** 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, +}; -struct audio_file_data { - enum play_mode current_play_mode; - long score; +/** + * 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; - struct audio_format_info afhi; + /** The full path of the audio file. */ char *path; - struct osl_object map; + /** The score value (if -a was given). */ + long score; + /** The sha1 hash of audio file. */ + HASH_TYPE *hash; +}; + +/** Data about the current audio file, passed from afs to server. */ +struct audio_file_data { + /** The open file descriptor to the current audio file. */ + int fd; + /** Vss needs this for streaming. */ + 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, }; /** Flags passed to for_each_matching_row(). */ @@ -109,23 +182,42 @@ struct pattern_match_data { 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 *); + +/** + * 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 void callback_function(int fd, const struct osl_object *); + +/** + * Callbacks send chunks to data back to the command handler. Pointers to + * this type of function are used by \ref send_callback_request and friends + * to deal with the data in the command handler process. + * + * \sa \ref send_callback_request(). + */ +typedef int callback_result_handler(struct osl_object *result, void *private); +int rc4_send_result(struct osl_object *result, void *private); +int pass_buffer_as_shm(char *buf, size_t size, void *fd_ptr); + __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, - callback_function *f, struct osl_object *result); + callback_result_handler *result_handler, + void *private_result_data); int send_option_arg_callback_request(struct osl_object *options, - int argc, char * const * const argv, callback_function *f, - struct osl_object *result); -int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f, - unsigned max_len, struct osl_object *result); + int argc, char * const * const argv, callback_function *f, + callback_result_handler *result_handler, + void *private_result_data); +int send_standard_callback_request(int argc, char * const * const argv, + callback_function *f, callback_result_handler *result_handler, + void *private_result_data); 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 */ @@ -150,34 +242,29 @@ 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); int audio_file_loop(void *private_data, osl_rbtree_loop_func *func); -int aft_check_callback(const struct osl_object *query, struct osl_object *result); - -/* mood */ -int change_current_mood(char *mood_name); -int reload_current_mood(void); -int mood_check_callback(__a_unused const struct osl_object *query, - struct osl_object *result); - +void aft_check_callback(int fd, __a_unused const struct osl_object *query); /* playlist */ int playlist_open(char *name); -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); +void playlist_close(void); +void playlist_check_callback(int fd, __a_unused const struct osl_object *query); /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */ #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); \ @@ -205,18 +292,3 @@ enum blob_table_columns { /** A blob table has that many columns. */ NUM_BLOB_COLUMNS }; - -#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 DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table; - -#define INIT_BLOB_TABLE(table_name) \ - DEFINE_BLOB_TABLE_DESC(table_name); \ - DEFINE_BLOB_TABLE_PTR(table_name); -