/*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * 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"
-#define OV_AUDIO_FORMAT_ARRAY , "ogg"
-#else
-#define OV_AUDIO_FORMAT ""
-#define OV_AUDIO_FORMAT_ARRAY
-#endif
+/** \file afh.h Structures for audio format handling (para_server). */
-#ifdef HAVE_FAAD
-#define AAC_AUDIO_FORMAT " aac"
-#define AAC_AUDIO_FORMAT_ARRAY , "aac"
-#else
-#define AAC_AUDIO_FORMAT ""
-#define AAC_AUDIO_FORMAT_ARRAY
-#endif
+/**
+ * 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)/ author(spx) */
+ char *artist;
+ /** TIT2/TITLE/nam */
+ char *title;
+ /** TDRC/YEAR/day */
+ char *year;
+ /** TALB/ALBUM/alb */
+ char *album;
+ /** COMM/COMMENT/cmt */
+ char *comment;
+};
-#define SUPPORTED_AUDIO_FORMATS "mp3" OV_AUDIO_FORMAT AAC_AUDIO_FORMAT
-#define SUPPORTED_AUDIO_FORMATS_ARRAY "mp3" OV_AUDIO_FORMAT_ARRAY \
- AAC_AUDIO_FORMAT_ARRAY, NULL
+/** Audio format dependent information. */
+struct afh_info {
+ /** The number of chunks this audio file contains. */
+ uint32_t chunks_total;
+ /** The length of the audio file in seconds. */
+ 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.
+ */
+ uint32_t *chunk_table;
+ /** Period of time between sending data chunks. */
+ struct timeval chunk_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
+ * 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;
+ /** Frequency in Hz. */
+ uint16_t frequency;
+ /** Exact meaning depends on audio format. */
+ uint16_t bitrate;
+};
-/** \endcond */
+/** 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 exactly 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 all the other function pointers.
+ * 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
- */
+ /** Name of the audio format. */
const char *name;
/**
- * typical file endings for files that can be handled by this afh.
- */
- const char **suffixes;
- /**
- * pointer to the audio format handler's init function
+ * Pointer to the audio format handler's init function.
*
* Must initialize all function pointers and is assumed to succeed.
*/
void (*init)(struct audio_format_handler*);
+ /** Typical file endings for files that can be handled by this afh. */
+ const char **suffixes;
/**
- * period of time between sending data chunks
- */
- struct timeval chunk_tv; /* length of one chunk of data */
- /**
- * end of file timeout - do not load new audio file until this time
- *
- */
- struct timeval eof_tv; /* timeout on eof */
- /**
- * Pointer to the optional get-header function.
+ * Check if this audio format handler can handle the file.
*
- * This is called from a sender in case a new client connects in the middle of
- * the stream. The audio format handler may set this to NULL to indicate that
- * this audio format does not need any special header treatment. If non-NULL,
- * the function it points to must return a pointer to a buffer holding the
- * current audio file header, together with the header length.
- */
- char *(*get_header_info)(int *header_len);
- /**
- * check if this audio format handler can handle the file
+ * 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 afh_info.
*
- * 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 did not recognize the given file. On success, the function is
- * expected to return a positive value and to fill in \arg info_str, \arg
- * chunks and \arg seconds appropriately and to return the chunk table
- * via \a vss_chunk_table.
- */
- int (*get_file_info)(FILE *audio_file, char *info_str,
- long unsigned *chunks, int *seconds, size_t **vss_chunk_table);
+ * \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);
/**
- * cleanup function of this audio format handler
+ * Write audio file with altered tags, optional.
*
- * This close function should deallocate any resources
- * associated with the current audio file. In particular, it is responsible
- * for closing the file handle. It is assumed to succeed.
- */
- void (*close_audio_file)(void);
+ * The output file descriptor has been opened by the caller and must not
+ * be closed in this function.
+ */
+ 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);
projects / paraslash.git / blobdiff