1 /* Copyright (C) 2003 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file mp3_afh.c para_server's mp3 audio format handler */
6 * This file is based in part on mp3tech.c and mp3tech.h, Copyright (C)
7 * 2000-2001 Cedric Tefft <cedric@earthling.net>, which in turn is based
10 * * MP3Info 0.5 by Ricardo Cerqueira <rmc@rccn.net>
11 * * MP3Stat 0.9 by Ed Sweetman <safemode@voicenet.com> and
12 * Johannes Overmann <overmann@iname.com>
24 * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
25 * to see before we decide we are looking at a real MP3 file
27 #define MIN_CONSEC_GOOD_FRAMES 4
28 #define FRAME_HEADER_SIZE 4
29 #define MIN_FRAME_SIZE 21
40 unsigned int copyright;
41 unsigned int original;
42 unsigned int emphasis;
45 static const int frequencies[3][4] = {
46 {22050,24000,16000,50000}, /* MPEG 2.0 */
47 {44100,48000,32000,50000}, /* MPEG 1.0 */
48 {11025,12000,8000,50000} /* MPEG 2.5 */
51 static const int mp3info_bitrate[2][3][14] = {
53 {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
54 {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
55 {8,16,24,32,40,48,56,64,80,96,112,128,144,160} /* layer 3 */
59 {32,64,96,128,160,192,224,256,288,320,352,384,416,448}, /* layer 1 */
60 {32,48,56,64,80,96,112,128,160,192,224,256,320,384}, /* layer 2 */
61 {32,40,48,56,64,80,96,112,128,160,192,224,256,320} /* layer 3 */
65 static const int frame_size_index[] = {24000, 72000, 72000};
70 static char *get_utf8(id3_ucs4_t const *string)
74 return (char *)id3_ucs4_utf8duplicate(string);
77 static char *get_stringlist(union id3_field *field)
79 unsigned int k, nstrings = id3_field_getnstrings(field);
82 for (k = 0; k < nstrings; k++) {
83 char *tmp = (char *)get_utf8(id3_field_getstrings(field, k));
86 result = make_message("%s %s", tmp2, tmp);
95 static char *get_string(union id3_field *field)
97 id3_ucs4_t const *string = id3_field_getfullstring(field);
99 return get_utf8(string);
102 #define FOR_EACH_FIELD(f, j, fr) for (j = 0; j < (fr)->nfields && \
103 (f = id3_frame_field((fr), j)); j++)
105 static char *get_strings(struct id3_frame *fr)
108 union id3_field *field;
110 FOR_EACH_FIELD(field, j, fr) {
111 enum id3_field_type type = id3_field_type(field);
113 if (type == ID3_FIELD_TYPE_STRINGLIST)
114 return get_stringlist(field);
115 if (type == ID3_FIELD_TYPE_STRINGFULL)
116 return get_string(field);
121 /* this only sets values which are undefined so far */
122 static void parse_frames(struct id3_tag *id3_t, struct taginfo *tags)
126 for (i = 0; i < id3_t->nframes; i++) {
127 struct id3_frame *fr = id3_t->frames[i];
128 if (!strcmp(fr->id, ID3_FRAME_TITLE)) {
130 tags->title = get_strings(fr);
133 if (!strcmp(fr->id, ID3_FRAME_ARTIST)) {
135 tags->artist = get_strings(fr);
138 if (!strcmp(fr->id, ID3_FRAME_ALBUM)) {
140 tags->album = get_strings(fr);
143 if (!strcmp(fr->id, ID3_FRAME_YEAR)) {
145 tags->year = get_strings(fr);
148 if (!strcmp(fr->id, ID3_FRAME_COMMENT)) {
150 tags->comment = get_strings(fr);
156 static int mp3_get_id3(unsigned char *map, size_t numbytes, __a_unused int fd,
157 struct taginfo *tags)
160 struct id3_tag *id3_t;
162 /* id3v2 tags are usually located at the beginning. */
163 id3_t = id3_tag_parse(map, numbytes);
165 parse_frames(id3_t, tags);
167 id3_tag_delete(id3_t);
169 /* Also look for an id3v1 tag at the end of the file. */
170 if (numbytes >= 128) {
171 id3_t = id3_tag_parse(map + numbytes - 128, 128);
173 parse_frames(id3_t, tags);
175 id3_tag_delete(id3_t);
181 /* These helpers are not mentioned in the libid3tag header file. */
182 void id3_field_init(union id3_field *field, enum id3_field_type type);
183 void id3_field_finish(union id3_field *field);
186 * Frames of type ID3_FRAME_COMMENT contain three fields of type language,
187 * string, and fullstring. The third field contains the actual comment.
189 static int set_comment_fields(struct id3_frame *fr, id3_ucs4_t *ucs4_val)
192 union id3_field *field;
194 field = id3_frame_field(fr, 1);
195 id3_field_init(field, ID3_FIELD_TYPE_LANGUAGE);
197 field = id3_frame_field(fr, 2);
198 id3_field_init(field, ID3_FIELD_TYPE_STRING);
200 field = id3_frame_field(fr, 3);
201 id3_field_init(field, ID3_FIELD_TYPE_STRINGFULL);
202 ret = id3_field_setfullstring(field, ucs4_val);
204 return -E_ID3_SETSTRING;
209 * UCS-4 stands for Universal Character Set where each character uses exactly
210 * 32 bits. It is also known as UTF-32, see ISO 10646.
212 * We have to use UCS-4 as an intermediate representation because the functions
213 * of libid3tag which set the tag content expect an array of UCS-4 characters.
214 * Fortunately, libid3tag contains conversion functions from and to UTF-8.
216 static int replace_tag(char const *id, const char *val, struct id3_tag *id3_t,
220 struct id3_frame *fr;
221 union id3_field *field;
222 id3_ucs4_t *ucs4_val;
224 /* First, detach all frames that match the given id. */
225 while ((fr = id3_tag_findframe(id3_t, id, 0))) {
226 PARA_INFO_LOG("deleting %s frame\n", id);
227 ret = id3_tag_detachframe(id3_t, fr);
229 return -E_ID3_DETACH;
230 id3_frame_delete(fr);
234 fr = id3_frame_new(id);
235 PARA_DEBUG_LOG("frame desc: %s, %u fields\n", fr->description, fr->nfields);
237 /* Frame 0 contains the encoding. We always use UTF-8. */
238 field = id3_frame_field(fr, 0);
239 id3_field_init(field, ID3_FIELD_TYPE_TEXTENCODING);
240 ret = id3_field_settextencoding(field, ID3_FIELD_TEXTENCODING_UTF_8);
242 return -E_ID3_SETENCODING;
243 /* create UCS-4 representation */
244 ucs4_val = id3_utf8_ucs4duplicate((const id3_utf8_t *)val);
246 if (strcmp(id, ID3_FRAME_COMMENT) == 0)
247 ret = set_comment_fields(fr, ucs4_val);
249 /* Non-comment frames contain the value in field 1. */
250 field = id3_frame_field(fr, 1);
251 if (options & ID3_TAG_OPTION_ID3V1) {
252 id3_ucs4_t *ptr[] = {ucs4_val, NULL};
253 id3_field_init(field, ID3_FIELD_TYPE_STRINGLIST);
254 ret = id3_field_setstrings(field, 1, ptr);
256 id3_field_init(field, ID3_FIELD_TYPE_STRINGFULL);
257 ret = id3_field_setfullstring(field, ucs4_val);
262 return -E_ID3_SETSTRING;
264 PARA_INFO_LOG("attaching %s frame, value: %s\n", id, val);
265 ret = id3_tag_attachframe(id3_t, fr);
267 return -E_ID3_ATTACH;
271 static int replace_tags(struct id3_tag *id3_t, struct taginfo *tags)
273 int ret, options = id3_tag_options(id3_t, 0, 0);
275 ret = replace_tag(ID3_FRAME_ARTIST, tags->artist, id3_t, options);
278 ret = replace_tag(ID3_FRAME_TITLE, tags->title, id3_t, options);
281 ret = replace_tag(ID3_FRAME_ALBUM, tags->album, id3_t, options);
284 ret = replace_tag(ID3_FRAME_YEAR, tags->year, id3_t, options);
287 ret = replace_tag(ID3_FRAME_COMMENT, tags->comment, id3_t, options);
293 /* id3_tag_delete() does not seem to work due to refcount issues. */
294 static void free_tag(struct id3_tag *id3_t)
300 for (i = 0; i < id3_t->nframes; i++) {
301 struct id3_frame *fr = id3_t->frames[i];
302 for (j = 0; j < fr->nfields; j++) {
303 union id3_field *field = &fr->fields[j];
304 id3_field_finish(field);
312 static int mp3_rewrite_tags(const char *map, size_t mapsize,
313 struct taginfo *tags, int fd, __a_unused const char *filename)
316 id3_length_t old_v2size, new_v2size;
317 id3_byte_t v1_buffer[128], *v2_buffer;
319 struct id3_tag *v1_tag = NULL, *v2_tag = NULL;
321 if (mapsize >= 128) {
322 v1_tag = id3_tag_parse((const id3_byte_t *)map + mapsize - 128,
325 PARA_NOTICE_LOG("replacing id3v1 tag\n");
326 ret = replace_tags(v1_tag, tags);
329 id3_tag_render(v1_tag, v1_buffer);
333 v2_tag = id3_tag_parse((const id3_byte_t *)map, mapsize);
335 PARA_NOTICE_LOG("replacing id3v2 tag\n");
336 old_v2size = v2_tag->paddedsize;
338 PARA_NOTICE_LOG("adding id3v2 tag\n");
339 v2_tag = id3_tag_new();
343 * Turn off all options to avoid creating an extended header. id321
344 * does not understand it.
346 id3_tag_options(v2_tag, ~0U, 0);
347 ret = replace_tags(v2_tag, tags);
350 new_v2size = id3_tag_render(v2_tag, NULL);
351 v2_buffer = alloc(new_v2size);
352 id3_tag_render(v2_tag, v2_buffer);
353 PARA_INFO_LOG("writing v2 tag (%lu bytes)\n", new_v2size);
354 ret = write_all(fd, (char *)v2_buffer, new_v2size);
358 data_sz = mapsize - old_v2size;
359 if (v1_tag && data_sz >= 128)
361 PARA_INFO_LOG("writing data part (%zu bytes)\n", data_sz);
362 ret = write_all(fd, map + old_v2size, data_sz);
366 PARA_INFO_LOG("writing v1 tag\n");
367 ret = write_all(fd, (char *)v1_buffer, 128);
375 #else /* HAVE_ID3TAG */
378 * Remove trailing whitespace from the end of a string
380 static char *unpad(char *string)
382 char *pos = string + strlen(string) - 1;
383 while (para_isspace(pos[0]))
388 static int mp3_get_id3(unsigned char *map, size_t numbytes, __a_unused int fd,
389 struct taginfo *tags)
391 char title[31], artist[31], album[31], year[5], comment[31];
394 if (numbytes < 128 || strncmp("TAG", (char *)map + numbytes - 128, 3)) {
395 PARA_DEBUG_LOG("no id3 v1 tag\n");
398 fpos = numbytes - 125;
399 memcpy(title, map + fpos, 30);
402 memcpy(artist, map + fpos, 30);
405 memcpy(album, map + fpos, 30);
408 memcpy(year, map + fpos, 4);
411 memcpy(comment, map + fpos, 30);
418 tags->artist = para_strdup(artist);
419 tags->title = para_strdup(title);
420 tags->year = para_strdup(year);
421 tags->album = para_strdup(album);
422 tags->comment = para_strdup(comment);
425 #endif /* HAVE_ID3TAG */
427 static int header_frequency(struct mp3header *h)
429 if (h->version > 2 || h->freq > 3)
430 return -E_HEADER_FREQ;
431 return frequencies[h->version][h->freq];
434 static const char *header_mode(const struct mp3header *h)
436 const char * const mode_text[] = {"stereo", "joint stereo",
437 "dual channel", "mono"};
439 if (h->mode >= ARRAY_SIZE(mode_text))
441 return mode_text[h->mode];
444 static int header_channels(struct mp3header *h)
453 static int header_bitrate(struct mp3header *h)
455 if (!h->layer || h->layer > 3 || h->bitrate > 14 || !h->bitrate)
456 return -E_HEADER_BITRATE;
457 return mp3info_bitrate[h->version & 1][3 - h->layer][h->bitrate - 1];
460 static int frame_length(struct mp3header *header)
462 int hb, hf = header_frequency(header);
466 hb = header_bitrate(header);
469 if (header->sync != 0xFFE || header->layer > 3)
471 return frame_size_index[3 - header->layer] *
472 ((header->version & 1) + 1) * hb / hf
476 static int compare_headers(struct mp3header *h1,struct mp3header *h2)
478 if ((*(unsigned int*)h1) == (*(unsigned int*)h2))
480 if ((h1->version == h2->version) &&
481 (h1->layer == h2->layer) &&
482 (h1->crc == h2->crc) &&
483 (h1->freq == h2->freq) &&
484 (h1->mode == h2->mode) &&
485 (h1->copyright == h2->copyright) &&
486 (h1->original == h2->original) &&
487 (h1->emphasis == h2->emphasis))
493 * get next MP3 frame header.
495 * On success, the header frame length is returned and the given header
496 * structure that is filled in. A return value of zero means that we did not
497 * retrieve a valid frame header, and a negative return value indicates an
500 static int get_header(unsigned char *map, size_t numbytes, off_t *fpos,
501 struct mp3header *header)
505 if (*fpos + FRAME_HEADER_SIZE > numbytes) {
506 *fpos = numbytes - 1;
510 header->layer = (map[*fpos + 1] >> 1) & 3;
511 header->sync = (((int)map[*fpos]<<4) | ((int)(map[*fpos + 1]&0xE0)>>4));
512 if (map[*fpos + 1] & 0x10)
513 header->version = (map[*fpos + 1] >> 3) & 1;
516 if ((header->sync != 0xFFE) || (header->layer != 1)) {
521 header->crc = map[*fpos + 1] & 1;
522 header->bitrate = (map[*fpos + 2] >> 4) & 0x0F;
523 header->freq = (map[*fpos + 2] >> 2) & 0x3;
524 header->padding = (map[*fpos + 2] >>1) & 0x1;
525 header->mode = (map[*fpos + 3] >> 6) & 0x3;
526 fl = frame_length(header);
527 ret = (fl >= MIN_FRAME_SIZE)? fl : -E_FRAME_LENGTH;
529 *fpos += FRAME_HEADER_SIZE;
534 * find the next mp3 header
536 * Return the length of the next frame header or zero if the end of the file is
539 static int mp3_seek_next_header(unsigned char *map, size_t numbytes, off_t *fpos,
540 struct mp3header *result)
542 int k, l = 0, first_len;
543 struct mp3header h, h2;
544 long valid_start = 0;
546 for (; *fpos < numbytes; (*fpos)++) {
547 if (map[*fpos] != 0xff)
550 first_len = get_header(map, numbytes, fpos, &h);
553 *fpos += first_len - FRAME_HEADER_SIZE;
554 for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
555 if ((l = get_header(map, numbytes, fpos, &h2)) <= 0)
557 if (!compare_headers(&h, &h2))
559 *fpos += l - FRAME_HEADER_SIZE;
561 if (k == MIN_CONSEC_GOOD_FRAMES) {
570 static int find_valid_start(unsigned char *map, size_t numbytes, off_t *fpos,
571 struct mp3header *header)
575 frame_len = get_header(map, numbytes, fpos, header);
579 frame_len = mp3_seek_next_header(map, numbytes, fpos, header);
583 *fpos -= FRAME_HEADER_SIZE;
585 return -E_FRAME_LENGTH;
589 static int mp3_read_info(unsigned char *map, size_t numbytes, int fd,
590 struct afh_info *afhi)
592 uint64_t freq_sum = 0, br_sum = 0;
593 int fl = 0, ret, len = 0, old_br = -1, vbr = 0;
594 struct timeval total_time = {0, 0};
595 unsigned chunk_table_size = 1000; /* gets increased on demand */
597 struct mp3header header;
598 const char *tag_versions[] = {"no", "id3v1", "id3v2", "id3v1+id3v2"};
600 afhi->chunks_total = 0;
601 afhi->chunk_table = arr_alloc(chunk_table_size, sizeof(uint32_t));
604 struct timeval tmp, cct; /* current chunk time */
606 len = find_valid_start(map, numbytes, &fpos, &header);
610 if (!afhi->chunks_total)
612 end = afhi->chunk_table[afhi->chunks_total - 1] + fl;
613 afhi->chunk_table[afhi->chunks_total]
614 = PARA_MIN(end, numbytes);
617 ret = header_frequency(&header);
621 ret = header_bitrate(&header);
625 ret = frame_length(&header);
629 tmp.tv_sec = fl - header.padding;
631 tv_divide(br * 125, &tmp, &cct);
632 tv_add(&cct, &total_time, &tmp);
634 if (afhi->chunks_total >= chunk_table_size) {
635 chunk_table_size *= 2;
636 afhi->chunk_table = arr_realloc(afhi->chunk_table,
637 chunk_table_size, sizeof(uint32_t));
639 afhi->chunk_table[afhi->chunks_total] = fpos;
640 afhi->chunks_total++;
643 if (afhi->chunks_total != 1 && old_br != br)
648 if (!freq_sum || !br_sum)
650 afhi->bitrate = br_sum / afhi->chunks_total;
651 afhi->frequency = freq_sum / afhi->chunks_total;
652 afhi->channels = header_channels(&header);
653 afhi->seconds_total = (tv2ms(&total_time) + 500) / 1000;
654 tv_divide(afhi->chunks_total, &total_time, &afhi->chunk_tv);
655 PARA_DEBUG_LOG("%" PRIu32 " chunks, each %lums\n", afhi->chunks_total,
656 tv2ms(&afhi->chunk_tv));
657 set_max_chunk_size(afhi);
658 ret = mp3_get_id3(map, numbytes, fd, &afhi->tags);
659 afhi->techinfo = make_message("%cbr, %s, %s tags", vbr? 'v' : 'c',
660 header_mode(&header), tag_versions[ret]);
663 free(afhi->chunk_table);
668 * Read mp3 information from audio file
670 static int mp3_get_file_info(char *map, size_t numbytes, int fd,
671 struct afh_info *afhi)
675 ret = mp3_read_info((unsigned char *)map, numbytes, fd, afhi);
678 if (afhi->chunks_total == 0)
683 static const char * const mp3_suffixes[] = {"mp3", NULL};
686 * The mp3 audio format handler.
688 * It does not depend on any libraries and is hence always compiled in.
690 const struct audio_format_handler mp3_afh = {
691 .get_file_info = mp3_get_file_info,
692 .suffixes = mp3_suffixes,
693 #ifdef HAVE_LIBID3TAG
694 .rewrite_tags = mp3_rewrite_tags,
695 #endif /* HAVE_LIBID3TAG */