the paraslash-0.3.2 release tarball

[paraslash.git] / afh.h

diff --git a/afh.h b/afh.h
index 9ad078582e156be166b7c06dc35100549a26f337..a441d5fecc322726189c43dc45c78ceae108b847 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -23,14 +23,11 @@
 
 /** \endcond */
 
-/** size of the  audio_file info string */
+/** Size of the audio_file info string. */
 #define AUDIO_FILE_INFO_SIZE 256
 
-/**
- * Audio format dependent information. Details vary between each audio format
- * handler.
- */
-struct audio_format_info {
+/** Audio format dependent information. */
+struct afh_info {
        /** The number of chunks this audio file contains. */
        long unsigned chunks_total;
        /** The length of the audio file in seconds. */
@@ -46,6 +43,11 @@ struct audio_format_info {
        struct timeval chunk_tv;
        /** End of file timeout - Do not load new audio file until this time. */
        struct timeval eof_tv;
+       /**
+        * The position of the header within the audio file. Ignored if \a
+        * header_len equals zero.
+        */
+       uint32_t header_offset;
        /**
         * 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
@@ -53,15 +55,10 @@ struct audio_format_info {
         * 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;
-       /** Frquency on Hz. */
+       /** Frequency in Hz. */
        uint16_t frequency;
        /** Exact meaning depends on audio format. */
        uint16_t bitrate;
@@ -93,16 +90,19 @@ struct audio_format_handler {
         * valid for this audio format. A negative return value indicates that
         * 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 audio_format_info
+        * \sa struct afh_info
         */
        int (*get_file_info)(char *map, size_t numbytes,
-               struct audio_format_info *afi);
+               struct afh_info *afi);
 };
 
 void afh_init(void);
 int guess_audio_format(const char *name);
 int compute_afhi(const char *path, char *data, size_t size,
-       struct audio_format_info *afhi);
+       struct afh_info *afhi);
 const char *audio_format_name(int);
+void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
+               void *map, char **buf, size_t *len);
+void afh_get_header(struct afh_info *afhi, void *map, char **buf, size_t *len);