Merge branch 'refs/heads/t/markdown'
[paraslash.git] / afh.h
diff --git a/afh.h b/afh.h
index 7c6912c3b89fa8d71fe15f6dae7fb1eb1b6bd82c..7a30947a637e43fbeccc9788b30c21f917a427df 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -1,42 +1,40 @@
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
  *
  * 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"
-#else
-#define OV_AUDIO_FORMAT ""
-#endif
-
-#ifdef HAVE_FAAD
-#define AAC_AUDIO_FORMAT " aac"
-#else
-#define AAC_AUDIO_FORMAT ""
-#endif
-
-#define SUPPORTED_AUDIO_FORMATS "mp3" OV_AUDIO_FORMAT AAC_AUDIO_FORMAT
-
-/** \endcond */
-
-/** size of the  audio_file info string */
-#define AUDIO_FILE_INFO_SIZE 256
+/** \file afh.h Structures for audio format handling (para_server). */
 
 /**
- * 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)/ author(spx) */
+       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;
+       uint32_t 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];
+       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.
@@ -44,8 +42,6 @@ struct audio_format_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 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,27 +49,34 @@ 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;
 };
 
+/** 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. */
+       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 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.
+ * 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. */
@@ -89,15 +92,41 @@ struct audio_format_handler {
        /**
         * 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 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 afh_info
+        */
+       int (*get_file_info)(char *map, size_t numbytes, int fd,
+               struct afh_info *afi);
+       /** Optional, used for header-rewriting. See \ref afh_get_header(). */
+       void (*get_header)(void *map, size_t mapsize, char **buf, size_t *len);
+       /**
+        * Write audio file with altered tags, optional.
         *
-        * \sa struct audio_format_info
+        * The output file descriptor has been opened by the caller and must not
+        * be closed in this function.
         */
-       int (*get_file_info)(char *map, size_t numbytes,
-               struct audio_format_info *afi);
+       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);
+void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
+               void *map, const char **buf, size_t *len);
+int32_t afh_get_start_chunk(int32_t approx_chunk_num,
+               const struct afh_info *afhi);
+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);