X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afh.h;h=d2ac93aec96f95a0ca0bf706327f831520145ee7;hp=73c02c128565f9d03fe216dd4732a75877f5f5a1;hb=bb1996d4ef04bf33e735f2ce49e9edeeb5a66e80;hpb=471684761a2039bbc89aa1e3c33c62de6bef86cf diff --git a/afh.h b/afh.h index 73c02c12..d2ac93ae 100644 --- a/afh.h +++ b/afh.h @@ -1,106 +1,157 @@ -/* - * Copyright (C) 2005-2007 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ - -/** \file afh.h 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 +/* Copyright (C) 2005 Andre Noll , see file COPYING. */ -#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 +/** \file afh.h Structures for audio format handling (para_server). */ -#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 - -/** \endcond */ - -/** size of the audio_file info string */ -#define AUDIO_FILE_INFO_SIZE 16384 +/** + * The tags used by all audio format handlers. + * + * Paraslash only uses the more common tags. These are recognized + * for all supported audio formats. + */ +struct taginfo { + /** TPE1 (id3v2) / ARTIST (vorbis) / ART (aac)/ author(spx) */ + char *artist; + /** TIT2/TITLE/nam */ + char *title; + /** TDRC/YEAR/day */ + char *year; + /** TALB/ALBUM/alb */ + char *album; + /** COMM/COMMENT/cmt */ + char *comment; +}; -struct audio_format_info { - /** the number of chunks this audio file contains */ - long unsigned chunks_total; - /** the length of the audio file in seconds */ - long unsigned seconds_total; - /** a string that gets filled in by the audio format handler */ - char info_string[AUDIO_FILE_INFO_SIZE]; +/** Audio format dependent information. */ +struct afh_info { + /** The number of chunks this audio file contains. */ + uint32_t chunks_total; + /** The length of the audio file in seconds. */ + uint32_t seconds_total; + /** Audio handler specific info about the file. */ + char *techinfo; + /** Id3 tags, vorbis comments, aac tags. */ + struct taginfo tags; /** - * the table that specifies the offset of the individual pieces in - * the current audio file. - */ - size_t *chunk_table; - /** period of time between sending data chunks */ + * The table that specifies the offset of the individual pieces in + * the current audio file. + */ + uint32_t *chunk_table; + /** Size of the largest chunk, introduced in v0.6.0. */ + uint32_t max_chunk_size; + /** Period of time between sending data chunks. */ struct timeval chunk_tv; - /** end of file timeout - do not load new audio file until this time */ - struct timeval eof_tv; /** * The header is needed by senders in case a new client connects in the * middle of the stream. The length of the header defaults to zero * which means that this audio format does not need any special header * treatment. The audio format handler does not need to set this to * zero in this case. - */ - unsigned header_len; - /** - * The position of the header within the audio file. Ignored if \a - * header_len equals zero. */ - unsigned header_offset; + uint32_t header_len; + /** The number of channels. */ uint8_t channels; + /** Frequency in Hz. */ uint16_t frequency; + /** Exact meaning depends on audio format. */ uint16_t bitrate; }; +/** 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. Superseded by afhi->max_chunk_size. May + * be removed after v0.6.1. + */ + uint32_t max_chunk_size; + /** Needed to get the audio file header. */ + uint8_t audio_format_id; +}; + /** - * structure for audio format handling + * 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. + * There's 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 the other part of this struct. */ struct audio_format_handler { - /** - * name of the audio format - */ + /** 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 + * Pointer to the audio format handler's init function. * * Must initialize all function pointers and is assumed to succeed. */ void (*init)(struct audio_format_handler*); + /** Typical file endings for files that can be handled by this afh. */ + const char * const *suffixes; /** - * check if this audio format handler can handle the file + * Check if this audio format handler can handle the file. * - * This is a pointer to a function returning whether a given file is + * 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 + * this audio format handler is unable to decode the given file. On * success, the function must return a positive value and fill in the - * given struct audio_format_info. + * given struct afh_info. + * + * \sa struct \ref afh_info. + */ + int (*get_file_info)(char *map, size_t numbytes, int fd, + struct afh_info *afhi); + /** Optional, used for header-rewriting. See \ref afh_get_header(). */ + void (*get_header)(void *map, size_t mapsize, char **buf, size_t *len); + /** + * An audio format handler may signify support for dynamic chunks by + * defining ->get_chunk below. In this case the vss calls ->open() at + * BOS, ->get_chunk() for each chunk while streaming, and ->close() at + * EOS. The chunk table is not accessed at all. * - * \sa struct audio_format_info - */ - int (*get_file_info)(char *map, size_t numbytes, - struct audio_format_info *afi); + * The function may return its (opaque) context through the last + * argument. The returned pointer is passed to subsequent calls to + * ->get_chunk() and ->close(). + */ + int (*open)(const void *map, size_t mapsize, void **afh_context); + /** + * Return a reference to one chunk. The returned pointer points to a + * portion of the memory mapped audio file. The caller must not call + * free() on it. + */ + int (*get_chunk)(long unsigned chunk_num, void *afh_context, + const char **buf, size_t *len); + /** Deallocate the resources occupied by ->open(). */ + void (*close)(void *afh_context); + /** + * Write audio file with altered tags, optional. + * + * The output file descriptor has been opened by the caller and must not + * be closed in this function. + */ + int (*rewrite_tags)(const char *map, size_t mapsize, struct taginfo *tags, + int output_fd, const char *filename); }; +void afh_init(void); +int guess_audio_format(const char *name); +int compute_afhi(const char *path, char *data, size_t size, + int fd, struct afh_info *afhi); +const char *audio_format_name(int); +__must_check int afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi, + uint8_t audio_format_id, const void *map, size_t mapsize, + const char **buf, size_t *len, void **afh_context); +void afh_close(void *afh_context, uint8_t audio_format_id); +int32_t afh_get_start_chunk(int32_t approx_chunk_num, + const struct afh_info *afhi, uint8_t audio_format_id); +void afh_get_header(struct afh_info *afhi, uint8_t audio_format_id, + void *map, size_t mapsize, char **buf, size_t *len); +void afh_free_header(char *header_buf, uint8_t audio_format_id); +void clear_afhi(struct afh_info *afhi); +unsigned afh_get_afhi_txt(int audio_format_num, struct afh_info *afhi, char **result); +int afh_rewrite_tags(int audio_format_id, void *map, size_t mapsize, + struct taginfo *tags, int output_fd, const char *filename); +void set_max_chunk_size(struct afh_info *afhi); +bool afh_supports_dynamic_chunks(int audio_format_id);