X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=d25b7043df22b75b214b9bf33f35ce3eee31cea1;hp=bebe3ea3c9ea67dacab10173f36d2312b370ba8a;hb=337d7784b0f8bc30b1fa9af56ace503acd97d40d;hpb=a6e79f02b6eab623425686f8f3cab5bc942e77d4;ds=sidebyside diff --git a/afs.h b/afs.h index bebe3ea3..d25b7043 100644 --- a/afs.h +++ b/afs.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2007 Andre Noll + * Copyright (C) 2007-2009 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ @@ -7,7 +7,6 @@ /** \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,6 +23,8 @@ struct afs_info { uint32_t lyrics_id; /** Mp3, ogg or aac. */ uint8_t audio_format_id; + /** Amplification value. */ + uint8_t amp; }; /** @@ -59,19 +60,23 @@ enum afs_events { 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; }; @@ -90,23 +95,41 @@ struct afs_table { /** 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 send_afs_status(int fd, int parser_friendly); + +/** 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]; + /** The open file descriptor to the current audio file. */ int fd; - long score; - struct afs_info afsi; + /** Vss needs this for streaming. */ struct afh_info afhi; }; enum afs_server_code { NEXT_AUDIO_FILE, + NO_ADMISSIBLE_FILES, AFD_CHANGE }; @@ -140,22 +163,45 @@ 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 send_result(struct osl_object *result, void *fd_ptr); +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 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 stdin_command(int fd, struct osl_object *arg_obj, callback_function *f, - unsigned max_len, struct osl_object *result); + unsigned max_len, callback_result_handler *result_handler, + void *private_result_data); 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 */ @@ -180,7 +226,8 @@ 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); @@ -190,22 +237,19 @@ 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); +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); -int mood_check_callback(__a_unused const struct osl_object *query, - struct osl_object *result); +void mood_check_callback(int fd, __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); +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))) @@ -240,7 +284,7 @@ enum blob_table_columns { NUM_BLOB_COLUMNS }; -/** Define an osl table decription for a blob table. */ +/** 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, \