Merge branch 'refs/heads/t/ubsan'
[paraslash.git] / afh.h
1 /* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file afh.h Structures for audio format handling (para_server). */
4
5 /**
6 * The tags used by all audio format handlers.
7 *
8 * Paraslash only uses the more common tags. These are recognized
9 * for all supported audio formats.
10 */
11 struct taginfo {
12 /** TPE1 (id3v2) / ARTIST (vorbis) / ART (aac)/ author(spx) */
13 char *artist;
14 /** TIT2/TITLE/nam */
15 char *title;
16 /** TDRC/YEAR/day */
17 char *year;
18 /** TALB/ALBUM/alb */
19 char *album;
20 /** COMM/COMMENT/cmt */
21 char *comment;
22 };
23
24 /** Audio format dependent information. */
25 struct afh_info {
26 /** The number of chunks this audio file contains. */
27 uint32_t chunks_total;
28 /** The length of the audio file in seconds. */
29 uint32_t seconds_total;
30 /** Audio handler specific info about the file. */
31 char *techinfo;
32 /** Id3 tags, vorbis comments, aac tags. */
33 struct taginfo tags;
34 /**
35 * The table that specifies the offset of the individual pieces in
36 * the current audio file.
37 */
38 uint32_t *chunk_table;
39 /** Size of the largest chunk, introduced in v0.6.0. */
40 uint32_t max_chunk_size;
41 /** Period of time between sending data chunks. */
42 struct timeval chunk_tv;
43 /**
44 * The header is needed by senders in case a new client connects in the
45 * middle of the stream. The length of the header defaults to zero
46 * which means that this audio format does not need any special header
47 * treatment. The audio format handler does not need to set this to
48 * zero in this case.
49 */
50 uint32_t header_len;
51 /** The number of channels. */
52 uint8_t channels;
53 /** Frequency in Hz. */
54 uint16_t frequency;
55 /** Exact meaning depends on audio format. */
56 uint16_t bitrate;
57 };
58
59 /** Data about the current audio file, passed from afs to server. */
60 struct audio_file_data {
61 /** Vss needs this for streaming. */
62 struct afh_info afhi;
63 /**
64 * Size of the largest chunk. Superseded by afhi->max_chunk_size. May
65 * be removed after v0.6.1.
66 */
67 uint32_t max_chunk_size;
68 /** Needed to get the audio file header. */
69 uint8_t audio_format_id;
70 };
71
72 /**
73 * Structure for audio format handling.
74 *
75 * There's one such struct for each supported audio format. Initially, only \a
76 * name and \a init are defined. During the startup process, para_server calls
77 * the \a init function of each audio format handler which is expected to fill
78 * in the other part of this struct.
79 */
80 struct audio_format_handler {
81 /** Typical file endings for files that can be handled by this afh. */
82 const char * const *suffixes;
83 /**
84 * Check if this audio format handler can handle the file.
85 *
86 * This is a pointer to a function returning whether a given file is
87 * valid for this audio format. A negative return value indicates that
88 * this audio format handler is unable to decode the given file. On
89 * success, the function must return a positive value and fill in the
90 * given struct afh_info.
91 *
92 * \sa struct \ref afh_info.
93 */
94 int (*get_file_info)(char *map, size_t numbytes, int fd,
95 struct afh_info *afhi);
96 /** Optional, used for header-rewriting. See \ref afh_get_header(). */
97 void (*get_header)(void *map, size_t mapsize, char **buf, size_t *len);
98 /**
99 * An audio format handler may signify support for dynamic chunks by
100 * defining ->get_chunk below. In this case the vss calls ->open() at
101 * BOS, ->get_chunk() for each chunk while streaming, and ->close() at
102 * EOS. The chunk table is not accessed at all.
103 *
104 * The function may return its (opaque) context through the last
105 * argument. The returned pointer is passed to subsequent calls to
106 * ->get_chunk() and ->close().
107 */
108 int (*open)(const void *map, size_t mapsize, void **afh_context);
109 /**
110 * Return a reference to one chunk. The returned pointer points to a
111 * portion of the memory mapped audio file. The caller must not call
112 * free() on it.
113 */
114 int (*get_chunk)(long unsigned chunk_num, void *afh_context,
115 const char **buf, size_t *len);
116 /** Deallocate the resources occupied by ->open(). */
117 void (*close)(void *afh_context);
118 /**
119 * Write audio file with altered tags, optional.
120 *
121 * The output file descriptor has been opened by the caller and must not
122 * be closed in this function.
123 */
124 int (*rewrite_tags)(const char *map, size_t mapsize, struct taginfo *tags,
125 int output_fd, const char *filename);
126 };
127
128 int guess_audio_format(const char *name);
129 int compute_afhi(const char *path, char *data, size_t size,
130 int fd, struct afh_info *afhi);
131 const char *audio_format_name(int);
132 __must_check int afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
133 uint8_t audio_format_id, const void *map, size_t mapsize,
134 const char **buf, size_t *len, void **afh_context);
135 void afh_close(void *afh_context, uint8_t audio_format_id);
136 int32_t afh_get_start_chunk(int32_t approx_chunk_num,
137 const struct afh_info *afhi, uint8_t audio_format_id);
138 void afh_get_header(struct afh_info *afhi, uint8_t audio_format_id,
139 void *map, size_t mapsize, char **buf, size_t *len);
140 void afh_free_header(char *header_buf, uint8_t audio_format_id);
141 void clear_afhi(struct afh_info *afhi);
142 unsigned afh_get_afhi_txt(int audio_format_num, struct afh_info *afhi, char **result);
143 int afh_rewrite_tags(int audio_format_id, void *map, size_t mapsize,
144 struct taginfo *tags, int output_fd, const char *filename);
145 void set_max_chunk_size(struct afh_info *afhi);
146 bool afh_supports_dynamic_chunks(int audio_format_id);