X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=8beca5aefcd0b9d06aed05e915877a2c5104a1a8;hp=7a3f963f940e3e710e02d0dbb34e42e97a9542fd;hb=ac9f8fc0b4a20b3ec1d205029ef61321174d15b6;hpb=18ee892832075829c1a0aec3427645f753077272 diff --git a/afs.h b/afs.h index 7a3f963f..8beca5ae 100644 --- a/afs.h +++ b/afs.h @@ -1,13 +1,7 @@ -/* - * Copyright (C) 2007-2014 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2007 Andre Noll , see file COPYING. */ /** \file afs.h Exported symbols of the audio file selector. */ -#include - /** Audio file selector data stored in the audio file table. */ struct afs_info { /** Seconds since the epoch. */ @@ -104,42 +98,12 @@ enum play_mode { 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 hash value of audio file data. */ - unsigned char *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; - /** Size of the largest chunk. */ - uint32_t max_chunk_size; - /** Needed to get the audio file header. */ - uint8_t audio_format_id; -}; - /** * 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 + * 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 @@ -173,12 +137,14 @@ 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. */ @@ -187,6 +153,24 @@ struct pattern_match_data { 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; + /** + * Convenience pointer for the deserialized parse result. + * + * Most afs command handlers call \ref send_lls_callback_request() to + * serialize the parse result of the subcommand and pass it to the + * callback. In afs context a pointer to the deserialized parse result + * is stored here. + */ + struct lls_parse_result *lpr; +}; /** * Afs command handlers run as a process which is not related to the afs @@ -194,16 +178,14 @@ 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. - * - * \sa \ref send_callback_request(). + * 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); @@ -238,26 +220,21 @@ _static_inline_ int afs_max_size_handler(char *buf, size_t size, void *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, +__noreturn void afs_init(int socket_fd); +__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, +int send_callback_request(afs_callback *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, - 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 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); @@ -272,23 +249,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 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_audio_file_path_of_row(const struct osl_row *row, char **path); 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); +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)))