X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=b415bfec6c2c7aa6d8fcb0f12308c7e8d30b7025;hp=269927f4ec1980bb9ffcab66a1e9af301476920b;hb=f652ce6afe7f6fd0e42814505234cbf4321a736e;hpb=e752cdeab213b329552e1eecd5687bca512217c5 diff --git a/afs.h b/afs.h index 269927f4..b415bfec 100644 --- a/afs.h +++ b/afs.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2007-2009 Andre Noll + * Copyright (C) 2007-2013 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, aac, wma, spx. */ uint8_t audio_format_id; /** Amplification value. */ uint8_t amp; @@ -97,7 +96,13 @@ 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. @@ -113,24 +118,41 @@ struct ls_data { char *path; /** The score value (if -a was given). */ long score; - /** The sha1 hash of audio file. */ - HASH_TYPE *hash; + /** The hash value of audio file data. */ + unsigned char *hash; }; -int send_afs_status(int fd); - /** 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 + * 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(). */ @@ -159,6 +181,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); }; @@ -181,9 +205,38 @@ 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 send_result(struct osl_object *result, void *fd_ptr); -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, 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, @@ -198,9 +251,6 @@ int send_option_arg_callback_request(struct osl_object *options, 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 string_compare(const struct osl_object *obj1, const struct osl_object *obj2); int for_each_matching_row(struct pattern_match_data *pmd); @@ -239,13 +289,6 @@ 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); - - /* playlist */ int playlist_open(char *name); void playlist_close(void); @@ -283,21 +326,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); -