X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=f4f022207790254254b2beaebb4af6608a694f3b;hp=19d5b685e927811f3ab74d6e771824f274c368c8;hb=ce8cd1e4ec6f4b2bf3ac29575be7852d2d55ff8b;hpb=db34194eaab9819772bd55ea1ab08c719ed8f1c8 diff --git a/afs.h b/afs.h index 19d5b685..f4f02220 100644 --- a/afs.h +++ b/afs.h @@ -1,141 +1,172 @@ /* - * Copyright (C) 2005-2006 Andre Noll + * Copyright (C) 2007 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file afs.h functions and structures for audio format handling (para_server) */ - -/** \cond */ -#ifdef HAVE_OGGVORBIS -#define OV_AUDIO_FORMAT " ogg" -#define OV_AUDIO_FORMAT_ARRAY , "ogg" -#else -#define OV_AUDIO_FORMAT "" -#define OV_AUDIO_FORMAT_ARRAY -#endif - -#ifdef HAVE_FAAD -#define AAC_AUDIO_FORMAT " aac" -#define AAC_AUDIO_FORMAT_ARRAY , "aac" -#else -#define AAC_AUDIO_FORMAT "" -#define AAC_AUDIO_FORMAT_ARRAY -#endif - -#define SUPPORTED_AUDIO_FORMATS "mp3" OV_AUDIO_FORMAT AAC_AUDIO_FORMAT -#define SUPPORTED_AUDIO_FORMATS_ARRAY "mp3" OV_AUDIO_FORMAT_ARRAY \ - AAC_AUDIO_FORMAT_ARRAY, NULL - -/* status flags */ -#define AFS_NOMORE 1 -#define AFS_NEXT 2 -#define AFS_REPOS 4 -#define AFS_PLAYING 8 -#define DBT_CHANGE 16 -/** \endcond */ - -/** - * structure for audio format handling - * - * There's exactly one such struct for each supported audio format. Initially, - * only \a name and \a init are defined. During the startup process, - * para_server calls the \a init function of each audio format handler which is - * expected to fill in all the other function pointers. - */ -struct audio_format_handler { - /** - * name of the audio format - */ - const char *name; - /** - * typical file endings for files that can be handled by this afh. - */ - const char **suffixes; - /** - * pointer to the audio format handler's init function - * - * Must initialize all function pointers and is assumed to succeed. - */ - void (*init)(void*); - /** - * period of time between sending data chunks - */ - struct timeval chunk_tv; /* length of one chunk of data */ - /** - * end of file timeout - do not load new audio file until this time - * - */ - struct timeval eof_tv; /* timeout on eof */ - /** - * Pointer to the optional get-header function. - * - * This is called from a sender in case a new client connects in the middle of - * the stream. The audio format handler may set this to NULL to indicate that - * this audio format does not need any special header treatment. If non-NULL, - * the function it points to must return a pointer to a buffer holding the - * current audio file header, together with the header length. - */ - char *(*get_header_info)(int *header_len); - /** - * check if this audio format handler can handle the file - * - * This is a pointer to a function returning whether a given file is valid for - * this audio format. A negative return value indicates that this audio format - * handler did not recognize the given file. On success, the function is - * expected to return a positive value and to fill in \arg info_str, \arg - * chunks and \arg seconds appropriately. - */ - int (*get_file_info)(FILE *audio_file, char *info_str, - long unsigned *chunks, int *seconds); - /** - * cleanup function of this audio format handler - * - * This close function should deallocate any resources - * associated with the current audio file. In particular, it is responsible - * for closing the file handle. It is assumed to succeed. - */ - void (*close_audio_file)(void); - /** - * jump to another position in the current audio file - * - * This is called if a client issued the ff or jmp command with \a request - * being the number of the next chunk that should be sent out. Must return a - * positive value on success and a negative value on errors. - */ - int (*reposition_stream)(long unsigned request); - /** - * function responsible for reading one data chunk. - * - * \a read_chunk() must return a pointer to the next chunk of data that should - * be sent out, or \p NULL on errors or if the end of the file was encountered. - * - * If it returns non-NULL, \a len must contain the length of the returned - * buffer (which may be zero if nothing has to be sent for some reason). - * Otherwise, \a len is used to distinguish between the eof and the error case: - * It must be zero in the eof case, or negative if an error occcured. - */ - char * (*read_chunk)(long unsigned chunk_num, ssize_t *len); +#include +#include "osl.h" +#include "hash.h" + +/** Audio file selector data stored in the audio file table. */ +struct afs_info { + /** Seconds since the epoch. */ + uint64_t last_played; + /** Bitfield of set attributes. */ + uint64_t attributes; + /** Counts how many times the file was selected. */ + uint32_t num_played; + /** Image blob associated with this file (foreign key). */ + uint32_t image_id; + /** Lyrics blob associated with this file (foreign key). */ + uint32_t lyrics_id; + /** Mp3, ogg or aac. */ + uint8_t audio_format_id; +}; + +enum afs_table_flags {TBLFLAG_SKIP_CREATE}; + +struct table_info { + const struct osl_table_description *desc; + enum afs_table_flags flags; +}; + +enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST}; + +struct audio_file_data { + enum play_mode current_play_mode; + long score; + struct afs_info afsi; + struct audio_format_info afhi; + char *path; + struct osl_object map; +}; + +enum pattern_match_flags { + PM_REVERSE_LOOP = 1, + PM_NO_PATTERN_MATCHES_EVERYTHING = 2, + PM_SKIP_EMPTY_NAME = 4, +}; + +struct pattern_match_data { + struct osl_table *table; + unsigned loop_col_num; + unsigned match_col_num; + unsigned pm_flags; + int fnmatch_flags; + struct osl_object patterns; + void *data; + int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data); }; -void afs_init(void); -void afs_send_chunk(void); -struct timeval *afs_preselect(void); -const char *audio_format_name(int); -unsigned int afs_playing(void); -unsigned int afs_next(void); -unsigned int afs_repos(void); -unsigned int afs_paused(void); +/* afs */ +typedef int callback_function(const struct osl_object *, struct osl_object *); +__noreturn int afs_init(uint32_t cookie, int socket_fd); +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); +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 string_compare(const struct osl_object *obj1, const struct osl_object *obj2); +int para_atol(const char *str, long *result); +int open_next_audio_file(struct audio_file_data *afd); +int close_audio_file(struct audio_file_data *afd); +int for_each_matching_row(struct pattern_match_data *pmd); + +/* score */ +int score_init(struct table_info *ti, const char *db); +void score_shutdown(enum osl_close_flags flags); +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); +int score_update(const struct osl_row *aft_row, long new_score); +int get_num_admissible_files(unsigned *num); +int score_delete(const struct osl_row *aft_row); +int row_belongs_to_score_table(const struct osl_row *aft_row); + +/* attribute */ +int attribute_init(struct table_info *ti, const char *db); +void attribute_shutdown(enum osl_close_flags flags); +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); + +/* aft */ +int aft_init(struct table_info *ti, const char *db); +void aft_shutdown(enum osl_close_flags flags); +int aft_get_row_of_path(char *path, struct osl_row **row); +int open_and_update_audio_file(struct osl_row *aft_row, 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_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 mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi); +int reload_current_mood(void); +int mood_delete_audio_file(const struct osl_row *aft_row); +int mood_check_callback(__a_unused const struct osl_object *query, + struct osl_object *result); + + +/* playlist */ +int playlist_open(char *name); +void playlist_close(void); +int playlist_update_audio_file(struct osl_row *aft_row); +int playlist_check_callback(__a_unused const struct osl_object *query, + struct osl_object *result); + +/** 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))) + + +#define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \ + int table_name ## _init(struct table_info *ti, const char *db); \ + void table_name ## _shutdown(enum osl_close_flags flags); \ + int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \ + int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \ + char **name, struct osl_object *def); \ + extern struct osl_table *table_name ## _table; + +DECLARE_BLOB_SYMBOLS(lyrics, lyr); +DECLARE_BLOB_SYMBOLS(images, img); +DECLARE_BLOB_SYMBOLS(moods, mood); +DECLARE_BLOB_SYMBOLS(playlists, pl); + +/** The columns of an abstract blob table. */ +enum blob_table_columns { + /** The identifier, a positive integer that never repeats. */ + BLOBCOL_ID, + /** The unique name of the blob. */ + BLOBCOL_NAME, + /** The actual blob contents. */ + BLOBCOL_DEF, + /** A blob table has that many columns. */ + NUM_BLOB_COLUMNS +}; + +#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 DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table; + +#define INIT_BLOB_TABLE(table_name) \ + DEFINE_BLOB_TABLE_DESC(table_name); \ + DEFINE_BLOB_TABLE_PTR(table_name);