afh_common.c: Add missing source code documentation.
[paraslash.git] / ogg_afh.c
1 /*
2  * Copyright (C) 2004-2008 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6 /** \file ogg_afh.c para_server's ogg vorbis audio format handler */
7
8 #include <inttypes.h>
9 #include <ogg/ogg.h>
10 #include <vorbis/codec.h>
11 #include <vorbis/vorbisfile.h>
12
13 #include "para.h"
14 #include "afh.h"
15 #include "error.h"
16 #include "string.h"
17 #include "afs.h"
18 #include "server.h"
19
20 /** must be big enough to hold header */
21 #define CHUNK_SIZE 32768
22 static double chunk_time = 0.25;
23
24 /** describes a memory-mapped ogg vorbis file */
25 struct ogg_datasource {
26         /** the memory mapping */
27         char *map;
28         /** this size of the mapping */
29         off_t numbytes;
30         /** the current position in the mapping */
31         off_t fpos;
32 };
33
34 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
35 {
36         struct ogg_datasource *ods = datasource;
37         size_t copy = PARA_MIN(ods->numbytes - ods->fpos, size * nmemb),
38                 ret = copy / size;
39         if (!ret)
40                 return 0;
41         memcpy(buf, ods->map + ods->fpos, copy);
42 //      PARA_INFO_LOG("size: %zd, nmemb: %zd, ret: %zd\n", size, nmemb, ret);
43         ods->fpos += ret * size;
44         return ret;
45 }
46
47 static int cb_seek(void *datasource, ogg_int64_t offset,
48                 int whence)
49 {
50         struct ogg_datasource *ods = datasource;
51         switch (whence) {
52         case SEEK_SET:
53                 if (offset >= 0 && offset <= ods->numbytes) {
54                         ods->fpos = offset;
55                         return 0;
56                 }
57                 errno = EINVAL;
58                 return -1;
59                 break;
60         case SEEK_END:
61                 if (offset <= 0 && -offset <= ods->numbytes) {
62                         ods->fpos = ods->numbytes + offset;
63                         return 0;
64                 }
65                 errno = EINVAL;
66                 return -1;
67                 break;
68         case SEEK_CUR:
69                 if ((offset >= 0 && offset + ods->fpos > ods->numbytes) ||
70                                 (offset < 0 && offset + ods->fpos < 0)) {
71                         errno = EINVAL;
72                         return -1;
73                 }
74                 ods->fpos += offset;
75                 return 0;
76         }
77         errno = EINVAL;
78         return -1;
79 }
80
81 /* don't do anything as vss still needs the open filehandle */
82 static int cb_close(__a_unused void *datasource)
83 {
84         return 0;
85 }
86
87 static long cb_tell(void *datasource)
88 {
89         struct ogg_datasource *ods = datasource;
90         return (unsigned long)ods->fpos;
91 }
92
93 static int ogg_open_callbacks(void *datasource, OggVorbis_File *vf, ov_callbacks c)
94 {
95         int ret = ov_open_callbacks(datasource, vf,
96                 NULL, /* no initial buffer */
97                 0, /* no initial bytes */
98                 c); /* the ov_open_callbacks */
99
100         if (ret == OV_EREAD)
101                 return -E_OGG_READ;
102         if (ret == OV_ENOTVORBIS)
103                 return -E_VORBIS;
104         if (ret == OV_EVERSION)
105                 return -E_OGG_VERSION;
106         if (ret == OV_EBADHEADER)
107                 return -E_OGG_BAD_HEADER;
108         if (ret < 0)
109                 return -E_OGG_UNKNOWN_ERROR;
110         return 1;
111
112 }
113
114 static int ogg_compute_header_len(char *map, size_t numbytes,
115                 struct afh_info *afhi)
116 {
117         int ret;
118         size_t len = PARA_MIN(numbytes, CHUNK_SIZE);
119         int serial;
120         char *buf;
121
122         ogg_page page;
123         ogg_packet packet;
124         vorbis_comment vc;
125         vorbis_info vi;
126         ogg_stream_state *stream_in = para_malloc(sizeof(ogg_stream_state));
127         ogg_stream_state *stream_out = para_malloc(sizeof(ogg_stream_state));
128         ogg_sync_state *sync_in = para_malloc(sizeof(ogg_sync_state));
129
130         ogg_sync_init(sync_in);
131         vorbis_info_init(&vi);
132         vorbis_comment_init(&vc);
133         buf = ogg_sync_buffer(sync_in, (long)len);
134         memcpy(buf, map, len);
135         ogg_sync_wrote(sync_in, (long)len);
136         ret = -E_SYNC_PAGEOUT;
137         if (ogg_sync_pageout(sync_in, &page) <= 0) {
138                 free(stream_in);
139                 free(stream_out);
140                 goto err1;
141         }
142         serial = ogg_page_serialno(&page);
143         ogg_stream_init(stream_in, serial);
144         ogg_stream_init(stream_out, serial);
145         ret = ogg_stream_pagein(stream_in, &page);
146         if (ret < 0) {
147                 ret = -E_STREAM_PAGEIN;
148                 goto err2;
149         }
150         ret = ogg_stream_packetout(stream_in, &packet);
151         if (ret != 1) {
152                 ret = -E_STREAM_PACKETOUT;
153                 goto err2;
154         }
155         ret = -E_VORBIS;
156         if (vorbis_synthesis_headerin(&vi, &vc, &packet) < 0)
157                 goto err2;
158         PARA_DEBUG_LOG("channels: %i, rate: %li\n", vi.channels, vi.rate);
159         ogg_stream_packetin(stream_out, &packet);
160         ret = ogg_sync_pageout(sync_in, &page);
161         if (ret <= 0) {
162                 ret = -E_SYNC_PAGEOUT;
163                 goto err2;
164         }
165         ogg_stream_pagein(stream_in, &page);
166         ogg_stream_packetout(stream_in, &packet);
167         ogg_stream_packetin(stream_out, &packet);
168
169         ret = ogg_sync_pageout(sync_in, &page);
170         if (ret <= 0) {
171                 ret = -E_SYNC_PAGEOUT;
172                 goto err2;
173         }
174         ogg_stream_pagein(stream_in, &page);
175         ogg_stream_packetout(stream_in, &packet);
176         ogg_stream_packetin(stream_out, &packet);
177
178         afhi->header_len = 0;
179         while (ogg_stream_flush(stream_out, &page))
180                 afhi->header_len += page.body_len + page.header_len;
181         PARA_DEBUG_LOG("header_len = %d\n", afhi->header_len);
182         afhi->header_offset = 0;
183         ret = 1;
184 err2:
185         ogg_stream_destroy(stream_in);
186         ogg_stream_destroy(stream_out);
187 err1:
188         ogg_sync_destroy(sync_in);
189         vorbis_info_clear(&vi);
190         vorbis_comment_clear(&vc);
191         return ret;
192 }
193
194 /*
195  * Alloc and fill array table of byte offsets. chunk_table[i] is the
196  * offset in the current input file at which the sample containing time i *
197  * CHUNK_TIME begins. Always successful.
198  */
199 static long unsigned ogg_compute_chunk_table(OggVorbis_File *of,
200         struct afh_info *afhi, long unsigned time_total)
201 {
202         int i, ret, num;
203         ssize_t max_chunk_len, pos = 0, min = 0, old_pos;
204         long unsigned num_chunks;
205
206         old_pos = 0;
207         ret = 0;
208         num = time_total / chunk_time + 3;
209         PARA_DEBUG_LOG("chunk time: %g allocating %d chunk pointers\n",
210                 chunk_time, num);
211         afhi->chunk_table = para_malloc((num + 1) * sizeof(size_t));
212         afhi->chunk_table[0] = 0;
213         max_chunk_len = 0;
214         for (i = 1; ret <= num; i++) {
215                 ogg_int64_t diff;
216                 ret = ov_time_seek(of, i * chunk_time);
217                 if (ret)
218                         break;
219                 pos = ov_raw_tell(of);
220                 diff = pos - old_pos;
221                 max_chunk_len = PARA_MAX(max_chunk_len, diff);
222                 min = (i == 1)? diff : PARA_MIN(min, diff);
223                 afhi->chunk_table[i] = pos;
224 //              if (i < 11 || !((i - 1) % 1000)|| i > num - 11)
225 //                      PARA_DEBUG_LOG("chunk #%d: %g secs, pos: %zd, "
226 //                              "size: %zd\n", i - 1,
227 //                              i * chunk_time, pos, pos - old_pos);
228                 old_pos = pos;
229         }
230         num_chunks = i - 1;
231 //fi->chunk_table[i] = pos;
232         PARA_DEBUG_LOG("%lu chunks (%fs), max chunk: %zd, min chunk: %zd\n",
233                 num_chunks, chunk_time, max_chunk_len, min);
234         return num_chunks;
235 }
236
237 static void ogg_write_info_string(OggVorbis_File *vf, struct afh_info *afhi)
238 {
239         char *taginfo;
240         vorbis_comment *vc = ov_comment(vf,-1);
241
242         if (vc) {
243                 char *artist, *title, *album, *year, *comment;
244                 artist = vorbis_comment_query(vc, "artist", 0);
245                 title = vorbis_comment_query(vc, "title", 0);
246                 album = vorbis_comment_query(vc, "album", 0);
247                 year = vorbis_comment_query(vc, "year", 0);
248                 comment = vorbis_comment_query(vc, "comment", 0);
249                 taginfo = make_taginfo(title, artist, album, year, comment);
250         } else
251                 taginfo = make_message("%s: (no vorbis comments found)\n%s:\n",
252                         status_item_list[SI_TAGINFO1],
253                         status_item_list[SI_TAGINFO2]);
254         afhi->info_string = make_message("%s:\n%s",
255                 status_item_list[SI_AUDIO_FILE_INFO], taginfo);
256         free(taginfo);
257 }
258
259 /*
260  * Init oggvorbis file and write some tech data to given pointers.
261  */
262 static int ogg_get_file_info(char *map, size_t numbytes, __a_unused int fd,
263                 struct afh_info *afhi)
264 {
265         int ret;
266         vorbis_info *vi;
267         OggVorbis_File of;
268         const ov_callbacks ovc = {
269                 .read_func = cb_read,
270                 .seek_func = cb_seek,
271                 .close_func = cb_close,
272                 .tell_func = cb_tell
273         };
274         struct ogg_datasource ods = {.map = map, .numbytes = numbytes, .fpos = 0};
275
276         ret = ogg_compute_header_len(map, numbytes, afhi);
277         if (ret < 0)
278                 return ret;
279         ret = ogg_open_callbacks(&ods, &of, ovc);
280         if (ret < 0)
281                 goto err;
282         ret = -E_OGG_INFO;
283         vi = ov_info(&of, 0);
284         if (!vi)
285                 goto err;
286         afhi->seconds_total = ov_time_total(&of, -1);
287         afhi->frequency = vi->rate;
288         afhi->bitrate = ov_bitrate(&of, 0) / 1000;
289         afhi->channels = vi->channels;
290         afhi->chunks_total = ogg_compute_chunk_table(&of, afhi, afhi->seconds_total);
291         afhi->chunk_tv.tv_sec = 0;
292         afhi->chunk_tv.tv_usec = 250 * 1000;
293         tv_scale(10 / afhi->channels, &afhi->chunk_tv, &afhi->eof_tv);
294         ogg_write_info_string(&of, afhi);
295         ret = 1;
296 err:
297         ov_clear(&of); /* keeps the file open */
298         return ret;
299 }
300
301 static const char* ogg_suffixes[] = {"ogg", NULL};
302
303 /**
304  * the init function of the ogg vorbis audio format handler
305  *
306  * \param afh pointer to the struct to initialize
307  */
308 void ogg_init(struct audio_format_handler *afh)
309 {
310         afh->get_file_info = ogg_get_file_info,
311         afh->suffixes = ogg_suffixes;
312 }