Documentation updates for 0.4.

[paraslash.git] / afh.h

diff --git a/afh.h b/afh.h
index 66adfd61c2006a86ea1d1e0fa79f8e11080fe140..72987b31ad789632a3e511b10522ce65ab23d481 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -23,14 +23,35 @@
 
 /** \endcond */
 
+/**
+ * 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) */
+       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 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.
@@ -38,8 +59,6 @@ struct afh_info {
        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.
@@ -91,15 +110,16 @@ struct audio_format_handler {
         *
         * \sa struct afh_info
         */
-       int (*get_file_info)(char *map, size_t numbytes,
+       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,
-       struct afh_info *afhi);
+       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);