2 * Copyright (C) 2003-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file mp3_afh.c para_server's mp3 audio format handler */
10 * This file is based in part on mp3tech.c and mp3tech.h, Copyright (C)
11 * 2000-2001 Cedric Tefft <cedric@earthling.net>, which in turn is based
14 * * MP3Info 0.5 by Ricardo Cerqueira <rmc@rccn.net>
15 * * MP3Stat 0.9 by Ed Sweetman <safemode@voicenet.com> and
16 * Johannes Overmann <overmann@iname.com>
27 /** \cond some defines and structs which are only used in this file */
30 * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
31 * to see before we decide we are looking at a real MP3 file
33 #define MIN_CONSEC_GOOD_FRAMES 4
34 #define FRAME_HEADER_SIZE 4
35 #define MIN_FRAME_SIZE 21
46 unsigned int copyright
;
47 unsigned int original
;
48 unsigned int emphasis
;
52 static const int frequencies
[3][4] = {
53 {22050,24000,16000,50000}, /* MPEG 2.0 */
54 {44100,48000,32000,50000}, /* MPEG 1.0 */
55 {11025,12000,8000,50000} /* MPEG 2.5 */
58 static const int mp3info_bitrate
[2][3][14] = {
60 {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
61 {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
62 {8,16,24,32,40,48,56,64,80,96,112,128,144,160} /* layer 3 */
66 {32,64,96,128,160,192,224,256,288,320,352,384,416,448}, /* layer 1 */
67 {32,48,56,64,80,96,112,128,160,192,224,256,320,384}, /* layer 2 */
68 {32,40,48,56,64,80,96,112,128,160,192,224,256,320} /* layer 3 */
72 static const int frame_size_index
[] = {24000, 72000, 72000};
73 static const char *mode_text
[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
79 static char *get_latin1(id3_ucs4_t
const *string
)
83 return (char *)id3_ucs4_latin1duplicate(string
);
86 static char *get_stringlist(union id3_field
*field
)
88 unsigned int k
, nstrings
= id3_field_getnstrings(field
);
91 for (k
= 0; k
< nstrings
; k
++) {
92 char *tmp
= (char *)get_latin1(id3_field_getstrings(field
, k
));
95 result
= make_message("%s %s", tmp2
, tmp
);
104 static char *get_string(union id3_field
*field
)
106 id3_ucs4_t
const *string
= id3_field_getfullstring(field
);
108 return get_latin1(string
);
111 #define FOR_EACH_FIELD(f, j, fr) for (j = 0; j < (fr)->nfields && \
112 (f = id3_frame_field((fr), j)); j++)
114 static char *get_strings(struct id3_frame
*fr
)
117 union id3_field
*field
;
119 FOR_EACH_FIELD(field
, j
, fr
) {
120 enum id3_field_type type
= id3_field_type(field
);
122 if (type
== ID3_FIELD_TYPE_STRINGLIST
)
123 return get_stringlist(field
);
124 if (type
== ID3_FIELD_TYPE_STRINGFULL
)
125 return get_string(field
);
130 static char *mp3_get_id3(__a_unused
unsigned char *map
,
131 __a_unused
size_t numbytes
, int fd
)
134 struct id3_tag
*id3_t
;
135 char *title
= NULL
, *artist
= NULL
, *album
= NULL
, *year
= NULL
,
136 *comment
= NULL
, *result
;
137 struct id3_file
*id3_f
= id3_file_fdopen(fd
, ID3_FILE_MODE_READONLY
);
141 id3_t
= id3_file_tag(id3_f
);
144 for (i
= 0; i
< id3_t
->nframes
; i
++) {
145 struct id3_frame
*fr
= id3_t
->frames
[i
];
146 if (!strcmp(fr
->id
, "TIT2")) {
148 title
= get_strings(fr
);
151 if (!strcmp(fr
->id
, "TPE1")) {
153 artist
= get_strings(fr
);
156 if (!strcmp(fr
->id
, "TALB")) {
158 album
= get_strings(fr
);
161 if (!strcmp(fr
->id
, "TDRC")) {
163 year
= get_strings(fr
);
166 if (!strcmp(fr
->id
, "COMM")) {
168 comment
= get_strings(fr
);
172 id3_file_close(id3_f
);
173 result
= make_taginfo(title
, artist
, album
, year
, comment
);
182 id3_file_close(id3_f
);
183 return make_message("%s: (no id3 v1/v2 tag)\n%s:\n",
184 status_item_list
[SI_TAGINFO1
],
185 status_item_list
[SI_TAGINFO2
]);
188 #else /* HAVE_LIBID3TAG */
191 * Remove trailing whitespace from the end of a string
193 static char *unpad(char *string
)
195 char *pos
= string
+ strlen(string
) - 1;
196 while (para_isspace(pos
[0]))
201 static char *mp3_get_id3(unsigned char *map
, size_t numbytes
, __a_unused
int fd
)
203 char title
[31], artist
[31], album
[31], year
[5], comment
[31];
206 if (numbytes
< 128 || strncmp("TAG", (char *)map
+ numbytes
- 128, 3)) {
207 PARA_DEBUG_LOG("no id3 v1 tag\n");
208 return make_message("%s: (no id3 v1 tag)\n%s:\n",
209 status_item_list
[SI_TAGINFO1
],
210 status_item_list
[SI_TAGINFO2
]);
212 fpos
= numbytes
- 125;
213 memcpy(title
, map
+ fpos
, 30);
216 memcpy(artist
, map
+ fpos
, 30);
219 memcpy(album
, map
+ fpos
, 30);
222 memcpy(year
, map
+ fpos
, 4);
225 memcpy(comment
, map
+ fpos
, 30);
232 return make_taginfo(title
, artist
, album
, year
, comment
);
234 #endif /* HAVE_LIBID3TAG */
236 static int header_frequency(struct mp3header
*h
)
238 if (h
->version
> 2 || h
->freq
> 3)
239 return -E_HEADER_FREQ
;
240 return frequencies
[h
->version
][h
->freq
];
243 static const char *header_mode(struct mp3header
*h
)
246 h
->mode
= 4; /* invalid */
247 return mode_text
[h
->mode
];
250 static int header_channels(struct mp3header
*h
)
259 static int header_bitrate(struct mp3header
*h
)
261 if (!h
->layer
|| h
->layer
> 3 || h
->bitrate
> 14 || !h
->bitrate
)
262 return -E_HEADER_BITRATE
;
263 return mp3info_bitrate
[h
->version
& 1][3 - h
->layer
][h
->bitrate
- 1];
266 static int frame_length(struct mp3header
*header
)
268 int hb
, hf
= header_frequency(header
);
272 hb
= header_bitrate(header
);
275 if (header
->sync
!= 0xFFE || header
->layer
> 3)
277 return frame_size_index
[3 - header
->layer
] *
278 ((header
->version
& 1) + 1) * hb
/ hf
282 static int compare_headers(struct mp3header
*h1
,struct mp3header
*h2
)
284 if ((*(unsigned int*)h1
) == (*(unsigned int*)h2
))
286 if ((h1
->version
== h2
->version
) &&
287 (h1
->layer
== h2
->layer
) &&
288 (h1
->crc
== h2
->crc
) &&
289 (h1
->freq
== h2
->freq
) &&
290 (h1
->mode
== h2
->mode
) &&
291 (h1
->copyright
== h2
->copyright
) &&
292 (h1
->original
== h2
->original
) &&
293 (h1
->emphasis
== h2
->emphasis
))
299 * get next MP3 frame header.
301 * On success, the header frame length is returned and the given header
302 * structure that is filled in. A return value of zero means that we did not
303 * retrieve a valid frame header, and a negative return value indicates an
306 static int get_header(unsigned char *map
, size_t numbytes
, off_t
*fpos
,
307 struct mp3header
*header
)
311 if (*fpos
+ FRAME_HEADER_SIZE
> numbytes
) {
312 *fpos
= numbytes
- 1;
316 header
->layer
= (map
[*fpos
+ 1] >> 1) & 3;
317 header
->sync
= (((int)map
[*fpos
]<<4) | ((int)(map
[*fpos
+ 1]&0xE0)>>4));
318 if (map
[*fpos
+ 1] & 0x10)
319 header
->version
= (map
[*fpos
+ 1] >> 3) & 1;
322 if ((header
->sync
!= 0xFFE) || (header
->layer
!= 1)) {
327 header
->crc
= map
[*fpos
+ 1] & 1;
328 header
->bitrate
= (map
[*fpos
+ 2] >> 4) & 0x0F;
329 header
->freq
= (map
[*fpos
+ 2] >> 2) & 0x3;
330 header
->padding
= (map
[*fpos
+ 2] >>1) & 0x1;
331 header
->mode
= (map
[*fpos
+ 3] >> 6) & 0x3;
332 fl
= frame_length(header
);
333 ret
= (fl
>= MIN_FRAME_SIZE
)? fl
: -E_FRAME_LENGTH
;
335 *fpos
+= FRAME_HEADER_SIZE
;
340 * find the next mp3 header
342 * Return the length of the next frame header or zero if the end of the file is
345 static int mp3_seek_next_header(unsigned char *map
, size_t numbytes
, off_t
*fpos
,
346 struct mp3header
*result
)
348 int k
, l
= 0, first_len
;
349 struct mp3header h
, h2
;
350 long valid_start
= 0;
352 for (; *fpos
< numbytes
; (*fpos
)++) {
353 if (map
[*fpos
] != 0xff)
356 first_len
= get_header(map
, numbytes
, fpos
, &h
);
359 *fpos
+= first_len
- FRAME_HEADER_SIZE
;
360 for (k
= 1; k
< MIN_CONSEC_GOOD_FRAMES
; k
++) {
361 if ((l
= get_header(map
, numbytes
, fpos
, &h2
)) <= 0)
363 if (!compare_headers(&h
, &h2
))
365 *fpos
+= l
- FRAME_HEADER_SIZE
;
367 if (k
== MIN_CONSEC_GOOD_FRAMES
) {
376 static int find_valid_start(unsigned char *map
, size_t numbytes
, off_t
*fpos
,
377 struct mp3header
*header
)
381 frame_len
= get_header(map
, numbytes
, fpos
, header
);
385 frame_len
= mp3_seek_next_header(map
, numbytes
, fpos
, header
);
389 *fpos
-= FRAME_HEADER_SIZE
;
391 return -E_FRAME_LENGTH
;
395 static int mp3_read_info(unsigned char *map
, size_t numbytes
, int fd
,
396 struct afh_info
*afhi
)
398 uint64_t freq_sum
= 0, br_sum
= 0;
399 int fl
= 0, ret
, len
= 0, old_br
= -1, vbr
= 0;
400 struct timeval total_time
= {0, 0};
401 unsigned chunk_table_size
= 1000; /* gets increased on demand */
403 struct mp3header header
;
406 afhi
->chunks_total
= 0;
407 afhi
->chunk_table
= para_malloc(chunk_table_size
* sizeof(uint32_t));
408 taginfo
= mp3_get_id3(map
, numbytes
, fd
);
411 struct timeval tmp
, cct
; /* current chunk time */
413 len
= find_valid_start(map
, numbytes
, &fpos
, &header
);
417 if (!afhi
->chunks_total
)
419 end
= afhi
->chunk_table
[afhi
->chunks_total
- 1] + fl
;
420 afhi
->chunk_table
[afhi
->chunks_total
]
421 = PARA_MIN(end
, numbytes
);
424 ret
= header_frequency(&header
);
428 ret
= header_bitrate(&header
);
432 ret
= frame_length(&header
);
438 tv_divide(br
* 125, &tmp
, &cct
);
439 tv_add(&cct
, &total_time
, &tmp
);
441 if (afhi
->chunks_total
>= chunk_table_size
) {
442 chunk_table_size
*= 2;
443 afhi
->chunk_table
= para_realloc(afhi
->chunk_table
,
444 chunk_table_size
* sizeof(uint32_t));
446 afhi
->chunk_table
[afhi
->chunks_total
] = fpos
;
447 afhi
->chunks_total
++;
450 if (afhi
->chunks_total
!= 1 && old_br
!= br
)
455 if (!freq_sum
|| !br_sum
)
457 afhi
->bitrate
= br_sum
/ afhi
->chunks_total
;
458 afhi
->frequency
= freq_sum
/ afhi
->chunks_total
;
459 afhi
->channels
= header_channels(&header
);
460 afhi
->seconds_total
= (tv2ms(&total_time
) + 500) / 1000;
461 tv_divide(afhi
->chunks_total
, &total_time
, &afhi
->chunk_tv
);
462 PARA_DEBUG_LOG("%lu chunks, each %lums\n", afhi
->chunks_total
,
463 tv2ms(&afhi
->chunk_tv
));
464 tv_scale(3, &afhi
->chunk_tv
, &afhi
->eof_tv
);
465 PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&afhi
->eof_tv
));
466 afhi
->info_string
= make_message("%s: %cbr, %s\n%s",
467 status_item_list
[SI_AUDIO_FILE_INFO
], vbr
? 'v' : 'c',
468 header_mode(&header
), taginfo
);
473 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
474 free(afhi
->chunk_table
);
479 * Read mp3 information from audio file
481 static int mp3_get_file_info(char *map
, size_t numbytes
, int fd
,
482 struct afh_info
*afhi
)
486 ret
= mp3_read_info((unsigned char *)map
, numbytes
, fd
, afhi
);
489 if (afhi
->seconds_total
< 2 || !afhi
->chunks_total
)
494 static const char* mp3_suffixes
[] = {"mp3", NULL
};
497 * the init function of the mp3 audio format handler
499 * \param afh pointer to the struct to initialize
501 void mp3_init(struct audio_format_handler
*afh
)
503 afh
->get_file_info
= mp3_get_file_info
;
504 afh
->suffixes
= mp3_suffixes
;