2 * Copyright (C) 2003-2007 Andre Noll <maan@systemlinux.org>
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.
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.
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.
19 /** \file mp3_afh.c para_server's mp3 audio format handler */
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
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>
31 #include "server.cmdline.h"
38 /** \cond some defines and structs which are only used in this file */
41 * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
42 * to see before we decide we are looking at a real MP3 file
44 #define MIN_CONSEC_GOOD_FRAMES 4
46 #define FRAME_HEADER_SIZE 4
47 #define MIN_FRAME_SIZE 21
58 unsigned int copyright;
59 unsigned int original;
60 unsigned int emphasis;
72 struct mp3header header;
76 long unsigned br_average;
77 long unsigned seconds;
82 static const int frequencies[3][4] = {
83 {22050,24000,16000,50000}, /* MPEG 2.0 */
84 {44100,48000,32000,50000}, /* MPEG 1.0 */
85 {11025,12000,8000,50000} /* MPEG 2.5 */
88 static const int mp3info_bitrate[2][3][14] = {
90 {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
91 {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
92 {8,16,24,32,40,48,56,64,80,96,112,128,144,160} /* layer 3 */
96 {32,64,96,128,160,192,224,256,288,320,352,384,416,448}, /* layer 1 */
97 {32,48,56,64,80,96,112,128,160,192,224,256,320,384}, /* layer 2 */
98 {32,40,48,56,64,80,96,112,128,160,192,224,256,320} /* layer 3 */
102 static const int frame_size_index[] = {24000, 72000, 72000};
103 static const char *mode_text[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
106 static struct mp3info mp3;
107 static ssize_t num_chunks;
109 static int header_frequency(struct mp3header *h)
111 if (h->version > 2 || h->freq > 3)
112 return -E_HEADER_FREQ;
113 return frequencies[h->version][h->freq];
116 static const char *header_mode(struct mp3header *h)
119 h->mode = 4; /* invalid */
120 return mode_text[h->mode];
122 static int header_bitrate(struct mp3header *h)
124 if (h->layer > 3 || h->bitrate > 14)
125 return -E_HEADER_BITRATE;
126 return mp3info_bitrate[h->version & 1][3 - h->layer][h->bitrate - 1];
129 static int frame_length(struct mp3header *header)
131 int hb, hf = header_frequency(header);
135 hb = header_bitrate(header);
138 if (header->sync != 0xFFE || header->layer > 3)
140 return frame_size_index[3 - header->layer] *
141 ((header->version & 1) + 1) * hb / hf
145 static void write_info_str(struct audio_format_info *afi)
147 int v = mp3.id3_isvalid;
149 snprintf(afi->info_string, MMD_INFO_SIZE,
150 "audio_file_info1:%d x %lums, %lu kbit/s (%cbr) %i KHz %s\n"
151 "audio_file_info2:%s, by %s\n"
152 "audio_file_info3:A: %s, Y: %s, C: %s\n",
154 tv2ms(&afi->chunk_tv),
158 header_mode(&mp3.header),
159 v && *mp3.id3.title? mp3.id3.title : "(title tag not set)",
160 v && *mp3.id3.artist? mp3.id3.artist : "(artist tag not set)",
161 v && *mp3.id3.album? mp3.id3.album : "(album tag not set)",
162 v && *mp3.id3.year? mp3.id3.year : "????",
163 v && *mp3.id3.comment? mp3.id3.comment : "(comment tag not set)"
168 * Remove trailing whitespace from the end of a string
170 static char *unpad(char *string)
172 char *pos = string + strlen(string) - 1;
173 while (isspace(pos[0]))
178 static int compare_headers(struct mp3header *h1,struct mp3header *h2)
180 if ((*(uint*)h1) == (*(uint*)h2))
182 if ((h1->version == h2->version) &&
183 (h1->layer == h2->layer) &&
184 (h1->crc == h2->crc) &&
185 (h1->freq == h2->freq) &&
186 (h1->mode == h2->mode) &&
187 (h1->copyright == h2->copyright) &&
188 (h1->original == h2->original) &&
189 (h1->emphasis == h2->emphasis))
195 * get next MP3 frame header.
197 * \param stream to read the header from
198 * \param header structure that gets filled in by get_header()
200 * \return On success, the header frame length is returned. A return value of
201 * zero means that we did not retrieve a valid frame header, and a negative
202 * return value indicates an error.
204 static int get_header(FILE *file, struct mp3header *header)
206 unsigned char buffer[FRAME_HEADER_SIZE];
209 if (!file || !header)
210 return -E_MP3_NO_FILE;
211 ret = para_fread(buffer, FRAME_HEADER_SIZE, 1, file);
212 if (ret < FRAME_HEADER_SIZE) {
214 return ret < 0? ret : 0;
216 header->layer = (buffer[1] >> 1) & 3;
217 header->sync = (((int)buffer[0]<<4) | ((int)(buffer[1]&0xE0)>>4));
218 if (buffer[1] & 0x10)
219 header->version = (buffer[1] >> 3) & 1;
222 if ((header->sync != 0xFFE) || (header->layer != 1)) {
224 // PARA_DEBUG_LOG("%s: header not found\n", __func__);
227 header->crc = buffer[1] & 1;
228 header->bitrate = (buffer[2] >> 4) & 0x0F;
229 // PARA_DEBUG_LOG("%s: found header, bitrate: %u\n", __func__,
231 header->freq = (buffer[2] >> 2) & 0x3;
232 header->padding = (buffer[2] >>1) & 0x1;
233 header->mode = (buffer[3] >> 6) & 0x3;
234 fl = frame_length(header);
235 return (fl >= MIN_FRAME_SIZE)? fl : -E_FRAME_LENGTH;
239 * find the next mp3 header
241 * \return On success, the length of the next frame header. If the end of the
242 * file was reached, the function returns zero. On errors, a negative value is
246 static int mp3_seek_next_header(void)
248 int k, l = 0, c, first_len, ret;
249 struct mp3header h, h2;
250 long valid_start = 0;
253 while ((c = fgetc(infile)) != 255 && (c != EOF))
258 valid_start = ftell(infile);
259 first_len = get_header(infile, &h);
262 ret = para_fseek(infile, first_len - FRAME_HEADER_SIZE, SEEK_CUR);
265 for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
266 if ((l = get_header(infile, &h2)) <= 0)
268 if (!compare_headers(&h, &h2))
270 ret = para_fseek(infile, l - FRAME_HEADER_SIZE, SEEK_CUR);
274 if (k == MIN_CONSEC_GOOD_FRAMES) {
275 ret = para_fseek(infile, valid_start, SEEK_SET);
278 memcpy(&(mp3.header), &h2, sizeof(struct mp3header));
284 static int mp3_get_id3(void)
290 mp3.id3.title[0] = '\0';
291 mp3.id3.artist[0] = '\0';
292 mp3.id3.album[0] = '\0';
293 mp3.id3.comment[0] = '\0';
294 mp3.id3.year[0] = '\0';
295 ret = para_fseek(infile, -128, SEEK_END);
298 if (para_fread(fbuf, 1, 3, infile) < 0)
301 if (strcmp("TAG", fbuf)) {
302 PARA_INFO_LOG("%s", "no id3 tag\n");
305 ret = para_fseek(infile, -125, SEEK_END);
308 if (para_fread(mp3.id3.title, 1, 30, infile) != 30)
310 mp3.id3.title[30] = '\0';
311 if (para_fread(mp3.id3.artist, 1, 30, infile) != 30)
313 mp3.id3.artist[30] = '\0';
314 if (para_fread(mp3.id3.album, 1, 30, infile) != 30)
316 mp3.id3.album[30] = '\0';
317 if (para_fread(mp3.id3.year, 1, 4, infile) != 4)
319 mp3.id3.year[4] = '\0';
320 if (para_fread(mp3.id3.comment, 1, 30, infile) != 30)
322 mp3.id3.comment[30] = '\0';
324 unpad(mp3.id3.title);
325 unpad(mp3.id3.artist);
326 unpad(mp3.id3.album);
328 unpad(mp3.id3.comment);
332 static int find_valid_start(void)
337 return -E_MP3_NO_FILE;
338 frame_len = get_header(infile, &mp3.header);
342 frame_len = mp3_seek_next_header();
346 ret = para_fseek(infile, -FRAME_HEADER_SIZE, SEEK_CUR);
351 return -E_FRAME_LENGTH;
355 static int mp3_read_info(struct audio_format_info *afi)
357 long fl_avg = 0, freq_avg = 0, br_avg = 0;
358 int ret, len = 0, old_br = -1;
359 struct timeval total_time = {0, 0};
360 unsigned chunk_table_size = 1000; /* gets increased on demand */
363 afi->chunk_table = para_malloc(chunk_table_size * sizeof(size_t));
372 struct timeval tmp, cct; /* current chunk time */
374 ret = para_fseek(infile, len, SEEK_CUR);
378 len = find_valid_start();
381 freq = header_frequency(&mp3.header);
382 br = header_bitrate(&mp3.header);
383 fl = frame_length(&mp3.header);
384 if (freq < 0 || br < 0 || fl < 0)
388 tv_divide(br * 125, &tmp, &cct);
389 tv_add(&cct, &total_time, &tmp);
391 //PARA_DEBUG_LOG("%s: br: %d, freq: %d, fl: %d, cct: %lu\n", __func__, br, freq, fl, cct.tv_usec);
392 if (num_chunks >= chunk_table_size) {
393 chunk_table_size *= 2;
394 afi->chunk_table = para_realloc(afi->chunk_table,
395 chunk_table_size * sizeof(size_t));
397 afi->chunk_table[num_chunks] = ftell(infile);
398 if (num_chunks < 10 || !(num_chunks % 1000))
399 PARA_INFO_LOG("chunk #%d: %zd\n", num_chunks,
400 afi->chunk_table[num_chunks]);
402 if (num_chunks == 1) {
403 // entry = ftell(infile);
404 // PARA_INFO_LOG("entry: %zd\n", entry);
411 freq_avg += (freq - freq_avg) / (num_chunks + 1);
412 fl_avg += (fl - fl_avg) / (num_chunks + 1);
413 br_avg += (br - br_avg) / (num_chunks + 1);
419 if (!num_chunks || !freq_avg || !br_avg)
421 ret= para_fseek(infile, 0, SEEK_END);
424 afi->chunk_table[num_chunks] = ftell(infile);
425 mp3.br_average = br_avg;
427 mp3.seconds = (tv2ms(&total_time) + 500) / 1000;
428 tv_divide(num_chunks, &total_time, &afi->chunk_tv);
430 PARA_DEBUG_LOG("%zu chunks, each %lums\n", num_chunks, tv2ms(&afi->chunk_tv));
431 tv_scale(3, &afi->chunk_tv, &afi->eof_tv);
432 PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&afi->eof_tv));
435 PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
436 free(afi->chunk_table);
441 * Read mp3 information from audio file
443 static int mp3_get_file_info(FILE *audio_file, struct audio_format_info *afi)
448 return -E_MP3_NO_FILE;
450 ret = mp3_read_info(afi);
456 afi->chunks_total = num_chunks;
457 afi->seconds_total = mp3.seconds;
458 if (afi->seconds_total < 2 || !afi->chunks_total)
463 static void mp3_close_audio_file(void)
471 static const char* mp3_suffixes[] = {"mp3", NULL};
474 * the init function of the mp3 audio format handler
476 * \param p pointer to the struct to initialize
478 void mp3_init(struct audio_format_handler *afh)
480 afh->get_file_info = mp3_get_file_info;
481 afh->close_audio_file = mp3_close_audio_file;
482 afh->suffixes = mp3_suffixes;