X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afh.h;h=d2ac93aec96f95a0ca0bf706327f831520145ee7;hp=7a30947a637e43fbeccc9788b30c21f917a427df;hb=6bded356ec89b1344049ff702e6c6babaeccd439;hpb=73073e4f4209c874f2f41e270376a9802862df8f

diff --git a/afh.h b/afh.h
index 7a30947a..d2ac93ae 100644
--- a/afh.h
+++ b/afh.h
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file afh.h Structures for audio format handling (para_server). */
 
@@ -36,10 +32,12 @@ struct afh_info {
 	/** Id3 tags, vorbis comments, aac tags. */
 	struct taginfo tags;
 	/**
-  	 * The table that specifies the offset of the individual pieces in
-  	 * the current audio file.
- 	 */
+	 * 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;
 	/**
@@ -48,7 +46,7 @@ struct afh_info {
 	 * 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.
-   	 */
+	 */
 	uint32_t header_len;
 	/** The number of channels. */
 	uint8_t channels;
@@ -64,7 +62,10 @@ struct audio_file_data {
 	int fd;
 	/** Vss needs this for streaming. */
 	struct afh_info afhi;
-	/** Size of the largest chunk. */
+	/**
+	 * 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;
@@ -88,7 +89,7 @@ struct audio_format_handler {
 	 */
 	void (*init)(struct audio_format_handler*);
 	/** Typical file endings for files that can be handled by this afh. */
-	const char **suffixes;
+	const char * const *suffixes;
 	/**
 	 * Check if this audio format handler can handle the file.
 	 *
@@ -98,12 +99,32 @@ struct audio_format_handler {
 	 * success, the function must return a positive value and fill in the
 	 * given struct afh_info.
 	 *
-	 * \sa struct afh_info
+	 * \sa struct \ref afh_info.
 	 */
 	int (*get_file_info)(char *map, size_t numbytes, int fd,
-		struct afh_info *afi);
+		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.
+	 *
+	 * 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.
 	 *
@@ -119,10 +140,12 @@ 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);
-void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
-		void *map, const char **buf, size_t *len);
+__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);
+		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);
@@ -130,3 +153,5 @@ 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);