X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=76b819058642db7ffb81acf5eaa268f3cae37f3a;hp=977fc40b6591dd778294ce7a796a6edcb4746f18;hb=d3af91481ef4a00c26530b7238552666424f0b6f;hpb=965eae5ba6664349ff74977439f3214142a3bc9a diff --git a/afs.h b/afs.h index 977fc40b..76b81905 100644 --- a/afs.h +++ b/afs.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2007 Andre Noll + * Copyright (C) 2007-2010 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,14 +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; }; - +/** + * 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; }; @@ -85,10 +95,15 @@ 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}; +/** 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, +}; /** * Data about one audio file. @@ -107,27 +122,34 @@ struct ls_data { /** 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); - -#define VERBOSE_LS_OUTPUT_SIZE 4096 -/* - * Data about the current audio file, passed from afs to server. - */ +/** Data about the current audio file, passed from afs to server. */ struct audio_file_data { - /* Same info as ls -lv -p . */ - char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE]; - /* The open file descriptor to the current audio file. */ + /** The open file descriptor to the current audio file. */ int fd; - /* Vss needs this for streaming. */ + /** 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, - AFD_CHANGE }; /** Flags passed to for_each_matching_row(). */ @@ -160,22 +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 close_audio_file(struct audio_file_data *afd); int for_each_matching_row(struct pattern_match_data *pmd); /* score */ @@ -211,21 +253,12 @@ 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); -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 aft_check_callback(int fd, __a_unused const struct osl_object *query); /* playlist */ int playlist_open(char *name); void playlist_close(void); -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))) @@ -259,21 +292,3 @@ enum blob_table_columns { /** A blob table has that many 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, \ - .num_columns = NUM_BLOB_COLUMNS, \ - .flags = OSL_LARGE_TABLE, \ - .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); -