mp3_afh.c: Kill unused inbuf and inbuf_size;
[paraslash.git] / mp3_afh.c
1 /*
2 * Copyright (C) 2003-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file mp3_afh.c para_server's mp3 audio format handler */
20
21 /*
22 * This file is based in part on mp3tech.c and mp3tech.h, Copyright (C)
23 * 2000-2001 Cedric Tefft <cedric@earthling.net>, which in turn is based
24 * in part on
25 *
26 * * MP3Info 0.5 by Ricardo Cerqueira <rmc@rccn.net>
27 * * MP3Stat 0.9 by Ed Sweetman <safemode@voicenet.com> and
28 * Johannes Overmann <overmann@iname.com>
29 */
30
31 #include "server.cmdline.h"
32 #include "server.h"
33 #include "vss.h"
34 #include "afh.h"
35 #include "error.h"
36 #include "fd.h"
37 #include "string.h"
38
39 /** \cond some defines and structs which are only used in this file */
40
41 /*
42 * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
43 * to see before we decide we are looking at a real MP3 file
44 */
45 #define MIN_CONSEC_GOOD_FRAMES 4
46
47 #define FRAME_HEADER_SIZE 4
48 #define MIN_FRAME_SIZE 21
49
50 struct mp3header {
51 unsigned long sync;
52 unsigned int version;
53 unsigned int layer;
54 unsigned int crc;
55 unsigned int bitrate;
56 unsigned int freq;
57 unsigned int padding;
58 unsigned int mode;
59 unsigned int copyright;
60 unsigned int original;
61 unsigned int emphasis;
62 };
63
64 struct id3tag {
65 char title[31];
66 char artist[31];
67 char album[31];
68 char year[5];
69 char comment[31];
70 };
71
72 struct mp3info {
73 char *filename;
74 struct mp3header header;
75 int id3_isvalid;
76 struct id3tag id3;
77 int vbr;
78 long unsigned br_average;
79 long unsigned seconds;
80 int freq;
81 };
82
83 /** \endcond */
84 static int frequencies[3][4] = {
85 {22050,24000,16000,50000}, /* MPEG 2.0 */
86 {44100,48000,32000,50000}, /* MPEG 1.0 */
87 {11025,12000,8000,50000} /* MPEG 2.5 */
88 };
89
90 static int mp3info_bitrate[2][3][14] = {
91 { /* MPEG 2.0 */
92 {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
93 {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
94 {8,16,24,32,40,48,56,64,80,96,112,128,144,160} /* layer 3 */
95 },
96
97 { /* MPEG 1.0 */
98 {32,64,96,128,160,192,224,256,288,320,352,384,416,448}, /* layer 1 */
99 {32,48,56,64,80,96,112,128,160,192,224,256,320,384}, /* layer 2 */
100 {32,40,48,56,64,80,96,112,128,160,192,224,256,320} /* layer 3 */
101 }
102 };
103
104 static int frame_size_index[] = {24000, 72000, 72000};
105 static const char *mode_text[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
106
107 static FILE *infile;
108 static struct mp3info mp3;
109 static struct audio_format_handler *af;
110 static ssize_t *chunk_table, num_chunks;
111
112 static int header_frequency(struct mp3header *h)
113 {
114 if (h->version > 2 || h->freq > 3)
115 return -E_HEADER_FREQ;
116 return frequencies[h->version][h->freq];
117 }
118
119 static const char *header_mode(struct mp3header *h)
120 {
121 if (h->mode > 4)
122 h->mode = 4; /* invalid */
123 return mode_text[h->mode];
124 }
125 static int header_bitrate(struct mp3header *h)
126 {
127 if (h->layer > 3 || h->bitrate > 14)
128 return -E_HEADER_BITRATE;
129 return mp3info_bitrate[h->version & 1][3 - h->layer][h->bitrate - 1];
130 }
131
132 static int frame_length(struct mp3header *header)
133 {
134 int hb, hf = header_frequency(header);
135
136 if (hf < 0)
137 return hf;
138 hb = header_bitrate(header);
139 if (hb < 0)
140 return hb;
141 if (header->sync != 0xFFE || header->layer > 3)
142 return -E_FRAME;
143 return frame_size_index[3 - header->layer] *
144 ((header->version & 1) + 1) * hb / hf
145 + header->padding;
146 }
147
148 static void write_info_str(char *info_str)
149 {
150 int v = mp3.id3_isvalid;
151
152 snprintf(info_str, MMD_INFO_SIZE,
153 "audio_file_info1:%d x %lums, %lu kbit/s (%cbr) %i KHz %s\n"
154 "audio_file_info2:%s, by %s\n"
155 "audio_file_info3:A: %s, Y: %s, C: %s\n",
156 num_chunks,
157 tv2ms(&af->chunk_tv),
158 mp3.br_average,
159 mp3.vbr? 'v' : 'c',
160 mp3.freq / 1000,
161 header_mode(&mp3.header),
162 v && *mp3.id3.title? mp3.id3.title : "(title tag not set)",
163 v && *mp3.id3.artist? mp3.id3.artist : "(artist tag not set)",
164 v && *mp3.id3.album? mp3.id3.album : "(album tag not set)",
165 v && *mp3.id3.year? mp3.id3.year : "????",
166 v && *mp3.id3.comment? mp3.id3.comment : "(comment tag not set)"
167 );
168 }
169
170 /*
171 * Remove trailing whitespace from the end of a string
172 */
173 static char *unpad(char *string)
174 {
175 char *pos = string + strlen(string) - 1;
176 while (isspace(pos[0]))
177 (pos--)[0] = 0;
178 return string;
179 }
180
181 static int compare_headers(struct mp3header *h1,struct mp3header *h2)
182 {
183 if ((*(uint*)h1) == (*(uint*)h2))
184 return 1;
185 if ((h1->version == h2->version) &&
186 (h1->layer == h2->layer) &&
187 (h1->crc == h2->crc) &&
188 (h1->freq == h2->freq) &&
189 (h1->mode == h2->mode) &&
190 (h1->copyright == h2->copyright) &&
191 (h1->original == h2->original) &&
192 (h1->emphasis == h2->emphasis))
193 return 1;
194 else
195 return 0;
196 }
197
198 /**
199 * get next MP3 frame header.
200 *
201 * \param stream to read the header from
202 * \param header structure that gets filled in by get_header()
203 *
204 * \return On success, the header frame length is returned. A return value of
205 * zero means that we did not retrieve a valid frame header, and a negative
206 * return value indicates an error.
207 */
208 static int get_header(FILE *file, struct mp3header *header)
209 {
210 unsigned char buffer[FRAME_HEADER_SIZE];
211 int fl, ret;
212
213 if (!file || !header)
214 return -E_MP3_NO_FILE;
215 ret = para_fread(buffer, FRAME_HEADER_SIZE, 1, file);
216 if (ret < FRAME_HEADER_SIZE) {
217 header->sync = 0;
218 return ret < 0? ret : 0;
219 }
220 header->layer = (buffer[1] >> 1) & 3;
221 header->sync = (((int)buffer[0]<<4) | ((int)(buffer[1]&0xE0)>>4));
222 if (buffer[1] & 0x10)
223 header->version = (buffer[1] >> 3) & 1;
224 else
225 header->version = 2;
226 if ((header->sync != 0xFFE) || (header->layer != 1)) {
227 header->sync = 0;
228 // PARA_DEBUG_LOG("%s: header not found\n", __func__);
229 return 0;
230 }
231 header->crc = buffer[1] & 1;
232 header->bitrate = (buffer[2] >> 4) & 0x0F;
233 // PARA_DEBUG_LOG("%s: found header, bitrate: %u\n", __func__,
234 // header->bitrate);
235 header->freq = (buffer[2] >> 2) & 0x3;
236 header->padding = (buffer[2] >>1) & 0x1;
237 header->mode = (buffer[3] >> 6) & 0x3;
238 fl = frame_length(header);
239 return (fl >= MIN_FRAME_SIZE)? fl : -E_FRAME_LENGTH;
240 }
241
242 /**
243 * find the next mp3 header
244 *
245 * \return On success, the length of the next frame header. If the end of the
246 * file was reached, the function returns zero. On errors, a negative value is
247 * returned.
248 *
249 */
250 static int mp3_seek_next_header(void)
251 {
252 int k, l = 0, c, first_len, ret;
253 struct mp3header h, h2;
254 long valid_start = 0;
255
256 while (1) {
257 while ((c = fgetc(infile)) != 255 && (c != EOF))
258 ; /* nothing */
259 if (c != 255)
260 return 0;
261 ungetc(c, infile);
262 valid_start = ftell(infile);
263 first_len = get_header(infile, &h);
264 if (first_len <= 0)
265 continue;
266 ret = para_fseek(infile, first_len - FRAME_HEADER_SIZE, SEEK_CUR);
267 if (ret < 0)
268 return ret;
269 for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
270 if ((l = get_header(infile, &h2)) <= 0)
271 break;
272 if (!compare_headers(&h, &h2))
273 break;
274 ret = para_fseek(infile, l - FRAME_HEADER_SIZE, SEEK_CUR);
275 if (ret < 0)
276 return ret;
277 }
278 if (k == MIN_CONSEC_GOOD_FRAMES) {
279 ret = para_fseek(infile, valid_start, SEEK_SET);
280 if (ret < 0)
281 return ret;
282 memcpy(&(mp3.header), &h2, sizeof(struct mp3header));
283 return first_len;
284 }
285 }
286 }
287
288 static int mp3_get_id3(void)
289 {
290 char fbuf[4];
291 int ret;
292
293 mp3.id3_isvalid = 0;
294 mp3.id3.title[0] = '\0';
295 mp3.id3.artist[0] = '\0';
296 mp3.id3.album[0] = '\0';
297 mp3.id3.comment[0] = '\0';
298 mp3.id3.year[0] = '\0';
299 ret = para_fseek(infile, -128, SEEK_END);
300 if (ret < 0 )
301 return ret;
302 if (para_fread(fbuf, 1, 3, infile) < 0)
303 return -E_FREAD;
304 fbuf[3] = '\0';
305 if (strcmp("TAG", fbuf)) {
306 PARA_INFO_LOG("%s", "no id3 tag\n");
307 return 0;
308 }
309 ret = para_fseek(infile, -125, SEEK_END);
310 if (ret < 0)
311 return ret;
312 if (para_fread(mp3.id3.title, 1, 30, infile) != 30)
313 return -E_FREAD;
314 mp3.id3.title[30] = '\0';
315 if (para_fread(mp3.id3.artist, 1, 30, infile) != 30)
316 return -E_FREAD;
317 mp3.id3.artist[30] = '\0';
318 if (para_fread(mp3.id3.album, 1, 30, infile) != 30)
319 return -E_FREAD;
320 mp3.id3.album[30] = '\0';
321 if (para_fread(mp3.id3.year, 1, 4, infile) != 4)
322 return -E_FREAD;
323 mp3.id3.year[4] = '\0';
324 if (para_fread(mp3.id3.comment, 1, 30, infile) != 30)
325 return -E_FREAD;
326 mp3.id3.comment[30] = '\0';
327 mp3.id3_isvalid = 1;
328 unpad(mp3.id3.title);
329 unpad(mp3.id3.artist);
330 unpad(mp3.id3.album);
331 unpad(mp3.id3.year);
332 unpad(mp3.id3.comment);
333 return 1;
334 }
335
336 static int find_valid_start(void)
337 {
338 int ret, frame_len;
339
340 if (!infile)
341 return -E_MP3_NO_FILE;
342 frame_len = get_header(infile, &mp3.header);
343 if (frame_len < 0)
344 return frame_len;
345 if (!frame_len) {
346 frame_len = mp3_seek_next_header();
347 if (frame_len <= 0)
348 return frame_len;
349 } else {
350 ret = para_fseek(infile, -FRAME_HEADER_SIZE, SEEK_CUR);
351 if (ret < 0)
352 return ret;
353 }
354 if (frame_len <= 1)
355 return -E_FRAME_LENGTH;
356 return frame_len;
357 }
358
359 static int mp3_read_info(void)
360 {
361 long fl_avg = 0, freq_avg = 0, br_avg = 0;
362 int ret, len = 0, old_br = -1;
363 struct timeval total_time = {0, 0};
364 unsigned chunk_table_size = 1000; /* gets increased on demand */
365
366 num_chunks = 0;
367 chunk_table = para_malloc(chunk_table_size * sizeof(size_t));
368 ret = mp3_get_id3();
369 if (ret < 0)
370 goto err_out;
371 rewind(infile);
372 mp3.vbr = 0;
373 mp3.freq = 0;
374 while (1) {
375 int freq, br, fl;
376 struct timeval tmp, cct; /* current chunk time */
377 if (len > 0) {
378 ret = para_fseek(infile, len, SEEK_CUR);
379 if (ret < 0)
380 goto err_out;
381 }
382 len = find_valid_start();
383 if (len <= 0)
384 break;
385 freq = header_frequency(&mp3.header);
386 br = header_bitrate(&mp3.header);
387 fl = frame_length(&mp3.header);
388 if (freq < 0 || br < 0 || fl < 0)
389 continue;
390 tmp.tv_sec = fl;
391 tmp.tv_usec = 0;
392 tv_divide(br * 125, &tmp, &cct);
393 tv_add(&cct, &total_time, &tmp);
394 total_time = tmp;
395 //PARA_DEBUG_LOG("%s: br: %d, freq: %d, fl: %d, cct: %lu\n", __func__, br, freq, fl, cct.tv_usec);
396 if (num_chunks >= chunk_table_size) {
397 chunk_table_size *= 2;
398 chunk_table = para_realloc(chunk_table,
399 chunk_table_size * sizeof(size_t));
400 }
401 chunk_table[num_chunks] = ftell(infile);
402 if (num_chunks < 10 || !(num_chunks % 1000))
403 PARA_INFO_LOG("chunk #%d: %zd\n", num_chunks,
404 chunk_table[num_chunks]);
405 num_chunks++;
406 if (num_chunks == 1) {
407 // entry = ftell(infile);
408 // PARA_INFO_LOG("entry: %zd\n", entry);
409 freq_avg = freq;
410 br_avg = br;
411 old_br = br;
412 fl_avg = fl;
413 continue;
414 }
415 freq_avg += (freq - freq_avg) / (num_chunks + 1);
416 fl_avg += (fl - fl_avg) / (num_chunks + 1);
417 br_avg += (br - br_avg) / (num_chunks + 1);
418 if (old_br != br)
419 mp3.vbr = 1;
420 old_br = br;
421 }
422 ret = -E_MP3_INFO;
423 if (!num_chunks || !freq_avg || !br_avg)
424 goto err_out;
425 ret= para_fseek(infile, 0, SEEK_END);
426 if (ret < 0)
427 goto err_out;
428 chunk_table[num_chunks] = ftell(infile);
429 mp3.br_average = br_avg;
430 mp3.freq = freq_avg;
431 mp3.seconds = (tv2ms(&total_time) + 500) / 1000;
432 tv_divide(num_chunks, &total_time, &af->chunk_tv);
433 rewind(infile);
434 PARA_DEBUG_LOG("%zu chunks, each %lums\n", num_chunks, tv2ms(&af->chunk_tv));
435 tv_scale(3, &af->chunk_tv, &af->eof_tv);
436 PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&af->eof_tv));
437 return 1;
438 err_out:
439 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
440 free(chunk_table);
441 return ret;
442 }
443
444 /*
445 * Read mp3 information from audio file
446 */
447 static int mp3_get_file_info(FILE *audio_file, char *info_str,
448 long unsigned *frames, int *seconds, size_t **vss_chunk_table)
449 {
450 int ret;
451
452 if (!audio_file)
453 return -E_MP3_NO_FILE;
454 infile = audio_file;
455 ret = mp3_read_info();
456 if (ret < 0) {
457 infile = NULL;
458 return ret;
459 }
460 write_info_str(info_str);
461 *frames = num_chunks;
462 *seconds = mp3.seconds;
463 *vss_chunk_table = chunk_table;
464 if (*seconds < 2 || !*frames)
465 return -E_MP3_INFO;
466 return 1;
467 }
468
469 static void mp3_close_audio_file(void)
470 {
471 if (!infile)
472 return;
473 fclose(infile);
474 infile = NULL;
475 free(chunk_table);
476 }
477
478 static const char* mp3_suffixes[] = {"mp3", NULL};
479
480 /**
481 * the init function of the mp3 audio format handler
482 *
483 * \param p pointer to the struct to initialize
484 */
485 void mp3_init(struct audio_format_handler *p)
486 {
487 af = p;
488 af->get_file_info = mp3_get_file_info;
489 af->close_audio_file = mp3_close_audio_file;
490 af->get_header_info = NULL;
491 /* eof_tv gets overwritten in mp3_get_file_info() */
492 af->eof_tv.tv_sec = 0;
493 af->eof_tv.tv_usec = 100 * 1000;
494 af->suffixes = mp3_suffixes;
495 }