X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=8fd8313a49d682be711101c6931dc0c5238bb5b5;hp=aeaf8fb8189535ec44dbcd14d19f472b710f81d7;hb=fe282244d61b83eb1f285259dd1d55992a96288f;hpb=f113a41a633c0541f0d8418baf40205f4553c885 diff --git a/afs.h b/afs.h index aeaf8fb8..8fd8313a 100644 --- a/afs.h +++ b/afs.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2007-2009 Andre Noll + * Copyright (C) 2007 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 "hash.h" /** Audio file selector data stored in the audio file table. */ struct afs_info { @@ -21,7 +20,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; @@ -97,38 +96,33 @@ struct afs_table { void *data); }; -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; -}; - -/** 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; -}; - 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(). */ @@ -157,6 +151,8 @@ struct pattern_match_data { struct osl_object patterns; /** 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); }; @@ -170,7 +166,7 @@ struct pattern_match_data { * * \sa send_callback_request(). */ -typedef void callback_function(int fd, const struct osl_object *); +typedef int callback_function(int fd, const struct osl_object *); /** * Callbacks send chunks to data back to the command handler. Pointers to @@ -179,12 +175,41 @@ typedef void callback_function(int fd, const struct osl_object *); * * \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); +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. + * + * \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(). + */ +_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, @@ -198,11 +223,11 @@ int send_standard_callback_request(int argc, char * const * const argv, 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); +void flush_and_free_pb(struct para_buffer *pb); /* 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); @@ -221,23 +246,18 @@ 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, long score, - struct audio_file_data *afd); +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); +int aft_check_callback(int fd, __a_unused const struct osl_object *query); /* playlist */ int playlist_open(char *name); void playlist_close(void); -void playlist_check_callback(int fd, __a_unused const struct osl_object *query); +int 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)))