Merge branch 'maint'
[paraslash.git] / afh.h
diff --git a/afh.h b/afh.h
index b4de774..72987b3 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \endcond */
 
-/** size of the  audio_file info string */
-#define AUDIO_FILE_INFO_SIZE 256
-
 /**
- * Audio format dependent information. Details vary between each audio format
- * handler.
+ * The tags used by all audio format handlers.
+ *
+ * Paraslash only uses the more common tags. These are recognized
+ * for all supported audio formats.
  */
-struct audio_format_info {
+struct taginfo {
+       /** TPE1 (id3v2) / ARTIST (vorbis) / ©ART (aac) */
+       char *artist;
+       /** TIT2/TITLE/©nam */
+       char *title;
+       /** TDRC/YEAR/©day */
+       char *year;
+       /** TALB/ALBUM/©alb */
+       char *album;
+       /** COMM/COMMENT/©cmt */
+       char *comment;
+};
+
+/** 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. */
        long unsigned seconds_total;
-       /** A string that gets filled in by the audio format handler. */
-       char info_string[AUDIO_FILE_INFO_SIZE];
+       /** 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;
+       uint32_t *chunk_table;
        /** 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 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 +71,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,11 +106,20 @@ 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);
+       int (*get_file_info)(char *map, size_t numbytes, int fd,
+               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,
+       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);
+uint32_t afh_get_largest_chunk_size(struct afh_info *afhi);
+void afh_get_header(struct afh_info *afhi, void *map, const char **buf, size_t *len);