X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=ea4b497e4b3b1bc2e54ab202962638ab25598d4d;hp=a596317f957f2dabb8a7287d689810883f4270b6;hb=b1206644af64376f11877f14fa9f9dd3c30f8e4b;hpb=f1b7734b997352b8df737b8184af69ca91c1b7dd diff --git a/afs.h b/afs.h index a596317f..ea4b497e 100644 --- a/afs.h +++ b/afs.h @@ -1,15 +1,11 @@ /* - * Copyright (C) 2007-2008 Andre Noll + * Copyright (C) 2007 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ /** \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. */ struct afs_info { /** Seconds since the epoch. */ @@ -22,7 +18,7 @@ struct afs_info { uint32_t image_id; /** Lyrics blob associated with this file (foreign key). */ uint32_t lyrics_id; - /** Mp3, ogg or aac. */ + /** Mp3, ogg, ... */ uint8_t audio_format_id; /** Amplification value. */ uint8_t amp; @@ -61,14 +57,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 { + /** Pointer to the row that has changed. */ struct osl_row *aft_row; + /** Afs info before the change. */ struct afs_info *old_afsi; }; @@ -87,48 +92,35 @@ 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. + * Codes used for communication between the server and the afs process. * - * Needed to produce ls and stat output. + * Before forking the afs child, para_server creates a bidirectional pipe + * through which both processes communicate. Usually para_server requests a new + * audio file 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. */ -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 { - /** 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; - /** Vss needs this for streaming. */ - struct afh_info afhi; -}; - 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(). */ @@ -149,18 +141,32 @@ struct pattern_match_data { unsigned loop_col_num; /** Data from this column is matched against the given patterns. */ unsigned match_col_num; - /** \see pattern_match_flags. */ + /** \see \ref 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; + /** Obtained by deserializing the query buffer in the callback. */ + struct lls_parse_result *lpr; + /** Do not try to match the first inputs of lpr */ + unsigned input_skip; /** Data pointer passed to the action function. */ void *data; + /** Gets increased by one for each match. */ + unsigned num_matches; /** For each matching row, this function will be called. */ int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data); }; +/** Arguments passed to each afs callback. */ +struct afs_callback_arg { + /** The local socket connecting afs and the command handler. */ + int fd; + /** Callback-specific data. */ + struct osl_object query; + /** Will be written on band SBD_OUTPUT, fully buffered. */ + struct para_buffer pbout; + struct lls_parse_result *lpr; +}; /** * Afs command handlers run as a process which is not related to the afs @@ -168,44 +174,63 @@ struct pattern_match_data { * 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(). + * \sa \ref send_callback_request(). */ -typedef void callback_function(int fd, const struct osl_object *); +typedef int afs_callback(struct afs_callback_arg *aca); /** - * 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. + * Some AFS callbacks need to send data back to the command handler. Pointers + * to this type of function are passed to \ref send_callback_request() and + * related functions to dispatch the data in the command handler process. + */ +typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private); +int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private); +int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size); + +/** Structure passed to the AFS max_size handler. */ +struct afs_max_size_handler_data { + /** Local socket connecting the command handler and the AFS process. */ + int fd; + /** The sideband designator for this data packet. */ + uint8_t band; +}; + +/** + * Standard max_size handler for AFS commands. * - * \sa \ref send_callback_request(). + * \param buf Contains (part of) the AFS command output. + * \param size The number of bytes in \a buf. + * \param private Pointer to a \ref afs_max_size_handler_data structure. + * + * Whenever the output of an AFS command exceeds the maximal size of a shared + * memory area, the max size handler of the para_buffer which holds the command + * output is called with \a private being a pointer to a structure of type + * afs_max_size_handler_data. + * + * \return The return value of the underlying call to \ref + * pass_buffer_as_shm(). */ -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); +_static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private) +{ + struct afs_max_size_handler_data *amshd = private; + return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size); +} __noreturn void afs_init(uint32_t cookie, int socket_fd); -void afs_event(enum afs_events event, struct para_buffer *pb, +__must_check int afs_event(enum afs_events event, struct para_buffer *pb, void *data); -int send_callback_request(callback_function *f, struct osl_object *query, - 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, +int send_callback_request(afs_callback *f, struct osl_object *query, 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, callback_result_handler *result_handler, - void *private_result_data); +int send_lls_callback_request(afs_callback *f, + const struct lls_command * const cmd, + struct lls_parse_result *lpr, void *private_result_data); int string_compare(const struct osl_object *obj1, const struct osl_object *obj2); int for_each_matching_row(struct pattern_match_data *pmd); /* score */ 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); int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row); int score_add(const struct osl_row *row, long score); @@ -220,34 +245,24 @@ 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); +int attribute_check_callback(struct afs_callback_arg *aca); /* 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, long score, - struct audio_file_data *afd); +int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb); +int open_and_update_audio_file(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 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); -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); -void mood_check_callback(int fd, __a_unused const struct osl_object *query); - +int aft_check_callback(struct afs_callback_arg *aca); /* playlist */ -int playlist_open(char *name); +int playlist_open(const char *name); void playlist_close(void); -void playlist_check_callback(int fd, __a_unused const struct osl_object *query); +int playlist_check_callback(struct afs_callback_arg *aca); /** 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))) @@ -281,21 +296,3 @@ enum blob_table_columns { /** A blob table has that many 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, \ - .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); -