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};
66 static const char *mode_text[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
72 static char *get_utf8(id3_ucs4_t const *string)
76 return (char *)id3_ucs4_utf8duplicate(string);
79 static char *get_stringlist(union id3_field *field)
81 unsigned int k, nstrings = id3_field_getnstrings(field);
84 for (k = 0; k < nstrings; k++) {
85 char *tmp = (char *)get_utf8(id3_field_getstrings(field, k));
88 result = make_message("%s %s", tmp2, tmp);
97 static char *get_string(union id3_field *field)
99 id3_ucs4_t const *string = id3_field_getfullstring(field);
101 return get_utf8(string);
104 #define FOR_EACH_FIELD(f, j, fr) for (j = 0; j < (fr)->nfields && \
105 (f = id3_frame_field((fr), j)); j++)
107 static char *get_strings(struct id3_frame *fr)
110 union id3_field *field;
112 FOR_EACH_FIELD(field, j, fr) {
113 enum id3_field_type type = id3_field_type(field);
115 if (type == ID3_FIELD_TYPE_STRINGLIST)
116 return get_stringlist(field);
117 if (type == ID3_FIELD_TYPE_STRINGFULL)
118 return get_string(field);
123 /* this only sets values which are undefined so far */
124 static void parse_frames(struct id3_tag *id3_t, struct taginfo *tags)
128 for (i = 0; i < id3_t->nframes; i++) {
129 struct id3_frame *fr = id3_t->frames[i];
130 if (!strcmp(fr->id, ID3_FRAME_TITLE)) {
132 tags->title = get_strings(fr);
135 if (!strcmp(fr->id, ID3_FRAME_ARTIST)) {
137 tags->artist = get_strings(fr);
140 if (!strcmp(fr->id, ID3_FRAME_ALBUM)) {
142 tags->album = get_strings(fr);
145 if (!strcmp(fr->id, ID3_FRAME_YEAR)) {
147 tags->year = get_strings(fr);
150 if (!strcmp(fr->id, ID3_FRAME_COMMENT)) {
152 tags->comment = get_strings(fr);
158 static int mp3_get_id3(unsigned char *map, size_t numbytes, __a_unused int fd,
159 struct taginfo *tags)
162 struct id3_tag *id3_t;
164 /* id3v2 tags are usually located at the beginning. */
165 id3_t = id3_tag_parse(map, numbytes);
167 parse_frames(id3_t, tags);
169 id3_tag_delete(id3_t);
171 /* Also look for an id3v1 tag at the end of the file. */
172 if (numbytes >= 128) {
173 id3_t = id3_tag_parse(map + numbytes - 128, 128);
175 parse_frames(id3_t, tags);
177 id3_tag_delete(id3_t);
183 /* These helpers are not mentioned in the libid3tag header file. */
184 void id3_field_init(union id3_field *field, enum id3_field_type type);
185 void id3_field_finish(union id3_field *field);
188 * Frames of type ID3_FRAME_COMMENT contain three fields of type language,
189 * string, and fullstring. The third field contains the actual comment.
191 static int set_comment_fields(struct id3_frame *fr, id3_ucs4_t *ucs4_val)
194 union id3_field *field;
196 field = id3_frame_field(fr, 1);
197 id3_field_init(field, ID3_FIELD_TYPE_LANGUAGE);
199 field = id3_frame_field(fr, 2);
200 id3_field_init(field, ID3_FIELD_TYPE_STRING);
202 field = id3_frame_field(fr, 3);
203 id3_field_init(field, ID3_FIELD_TYPE_STRINGFULL);
204 ret = id3_field_setfullstring(field, ucs4_val);
206 return -E_ID3_SETSTRING;
211 * UCS-4 stands for Universal Character Set where each character uses exactly
212 * 32 bits. It is also known as UTF-32, see ISO 10646.
214 * We have to use UCS-4 as an intermediate representation because the functions
215 * of libid3tag which set the tag content expect an array of UCS-4 characters.
216 * Fortunately, libid3tag contains conversion functions from and to UTF-8.
218 static int replace_tag(char const *id, const char *val, struct id3_tag *id3_t,
222 struct id3_frame *fr;
223 union id3_field *field;
224 id3_ucs4_t *ucs4_val;
226 /* First, detach all frames that match the given id. */
227 while ((fr = id3_tag_findframe(id3_t, id, 0))) {
228 PARA_INFO_LOG("deleting %s frame\n", id);
229 ret = id3_tag_detachframe(id3_t, fr);
231 return -E_ID3_DETACH;
232 id3_frame_delete(fr);
236 fr = id3_frame_new(id);
237 PARA_DEBUG_LOG("frame desc: %s, %u fields\n", fr->description, fr->nfields);
239 /* Frame 0 contains the encoding. We always use UTF-8. */
240 field = id3_frame_field(fr, 0);
241 id3_field_init(field, ID3_FIELD_TYPE_TEXTENCODING);
242 ret = id3_field_settextencoding(field, ID3_FIELD_TEXTENCODING_UTF_8);
244 return -E_ID3_SETENCODING;
245 /* create UCS-4 representation */
246 ucs4_val = id3_utf8_ucs4duplicate((const id3_utf8_t *)val);
248 if (strcmp(id, ID3_FRAME_COMMENT) == 0)
249 ret = set_comment_fields(fr, ucs4_val);
251 /* Non-comment frames contain the value in field 1. */
252 field = id3_frame_field(fr, 1);
253 if (options & ID3_TAG_OPTION_ID3V1) {
254 id3_ucs4_t *ptr[] = {ucs4_val, NULL};
255 id3_field_init(field, ID3_FIELD_TYPE_STRINGLIST);
256 ret = id3_field_setstrings(field, 1, ptr);
258 id3_field_init(field, ID3_FIELD_TYPE_STRINGFULL);
259 ret = id3_field_setfullstring(field, ucs4_val);
264 return -E_ID3_SETSTRING;
266 PARA_INFO_LOG("attaching %s frame, value: %s\n", id, val);
267 ret = id3_tag_attachframe(id3_t, fr);
269 return -E_ID3_ATTACH;
273 static int replace_tags(struct id3_tag *id3_t, struct taginfo *tags)
275 int ret, options = id3_tag_options(id3_t, 0, 0);
277 ret = replace_tag(ID3_FRAME_ARTIST, tags->artist, id3_t, options);
280 ret = replace_tag(ID3_FRAME_TITLE, tags->title, id3_t, options);
283 ret = replace_tag(ID3_FRAME_ALBUM, tags->album, id3_t, options);
286 ret = replace_tag(ID3_FRAME_YEAR, tags->year, id3_t, options);
289 ret = replace_tag(ID3_FRAME_COMMENT, tags->comment, id3_t, options);
295 /* id3_tag_delete() does not seem to work due to refcount issues. */
296 static void free_tag(struct id3_tag *id3_t)
302 for (i = 0; i < id3_t->nframes; i++) {
303 struct id3_frame *fr = id3_t->frames[i];
304 for (j = 0; j < fr->nfields; j++) {
305 union id3_field *field = &fr->fields[j];
306 id3_field_finish(field);
314 static int mp3_rewrite_tags(const char *map, size_t mapsize,
315 struct taginfo *tags, int fd, __a_unused const char *filename)
318 id3_length_t old_v2size, new_v2size;
319 id3_byte_t v1_buffer[128], *v2_buffer;
321 struct id3_tag *v1_tag = NULL, *v2_tag = NULL;
323 if (mapsize >= 128) {
324 v1_tag = id3_tag_parse((const id3_byte_t *)map + mapsize - 128,
327 PARA_NOTICE_LOG("replacing id3v1 tag\n");
328 ret = replace_tags(v1_tag, tags);
331 id3_tag_render(v1_tag, v1_buffer);
335 v2_tag = id3_tag_parse((const id3_byte_t *)map, mapsize);
337 PARA_NOTICE_LOG("replacing id3v2 tag\n");
338 old_v2size = v2_tag->paddedsize;
340 PARA_NOTICE_LOG("adding id3v2 tag\n");
341 v2_tag = id3_tag_new();
345 * Turn off all options to avoid creating an extended header. id321
346 * does not understand it.
348 id3_tag_options(v2_tag, ~0U, 0);
349 ret = replace_tags(v2_tag, tags);
352 new_v2size = id3_tag_render(v2_tag, NULL);
353 v2_buffer = para_malloc(new_v2size);
354 id3_tag_render(v2_tag, v2_buffer);
355 PARA_INFO_LOG("writing v2 tag (%lu bytes)\n", new_v2size);
356 ret = write_all(fd, (char *)v2_buffer, new_v2size);
360 data_sz = mapsize - old_v2size;
361 if (v1_tag && data_sz >= 128)
363 PARA_INFO_LOG("writing data part (%zu bytes)\n", data_sz);
364 ret = write_all(fd, map + old_v2size, data_sz);
368 PARA_INFO_LOG("writing v1 tag\n");
369 ret = write_all(fd, (char *)v1_buffer, 128);
377 #else /* HAVE_ID3TAG */
380 * Remove trailing whitespace from the end of a string
382 static char *unpad(char *string)
384 char *pos = string + strlen(string) - 1;
385 while (para_isspace(pos[0]))
390 static int mp3_get_id3(unsigned char *map, size_t numbytes, __a_unused int fd,
391 struct taginfo *tags)
393 char title[31], artist[31], album[31], year[5], comment[31];
396 if (numbytes < 128 || strncmp("TAG", (char *)map + numbytes - 128, 3)) {
397 PARA_DEBUG_LOG("no id3 v1 tag\n");
400 fpos = numbytes - 125;
401 memcpy(title, map + fpos, 30);
404 memcpy(artist, map + fpos, 30);
407 memcpy(album, map + fpos, 30);
410 memcpy(year, map + fpos, 4);
413 memcpy(comment, map + fpos, 30);
420 tags->artist = para_strdup(artist);
421 tags->title = para_strdup(title);
422 tags->year = para_strdup(year);
423 tags->album = para_strdup(album);
424 tags->comment = para_strdup(comment);
427 #endif /* HAVE_ID3TAG */
429 static int header_frequency(struct mp3header *h)
431 if (h->version > 2 || h->freq > 3)
432 return -E_HEADER_FREQ;
433 return frequencies[h->version][h->freq];
436 static const char *header_mode(struct mp3header *h)
439 h->mode = 4; /* invalid */
440 return mode_text[h->mode];
443 static int header_channels(struct mp3header *h)
452 static int header_bitrate(struct mp3header *h)
454 if (!h->layer || h->layer > 3 || h->bitrate > 14 || !h->bitrate)
455 return -E_HEADER_BITRATE;
456 return mp3info_bitrate[h->version & 1][3 - h->layer][h->bitrate - 1];
459 static int frame_length(struct mp3header *header)
461 int hb, hf = header_frequency(header);
465 hb = header_bitrate(header);
468 if (header->sync != 0xFFE || header->layer > 3)
470 return frame_size_index[3 - header->layer] *
471 ((header->version & 1) + 1) * hb / hf
475 static int compare_headers(struct mp3header *h1,struct mp3header *h2)
477 if ((*(unsigned int*)h1) == (*(unsigned int*)h2))
479 if ((h1->version == h2->version) &&
480 (h1->layer == h2->layer) &&
481 (h1->crc == h2->crc) &&
482 (h1->freq == h2->freq) &&
483 (h1->mode == h2->mode) &&
484 (h1->copyright == h2->copyright) &&
485 (h1->original == h2->original) &&
486 (h1->emphasis == h2->emphasis))
492 * get next MP3 frame header.
494 * On success, the header frame length is returned and the given header
495 * structure that is filled in. A return value of zero means that we did not
496 * retrieve a valid frame header, and a negative return value indicates an
499 static int get_header(unsigned char *map, size_t numbytes, off_t *fpos,
500 struct mp3header *header)
504 if (*fpos + FRAME_HEADER_SIZE > numbytes) {
505 *fpos = numbytes - 1;
509 header->layer = (map[*fpos + 1] >> 1) & 3;
510 header->sync = (((int)map[*fpos]<<4) | ((int)(map[*fpos + 1]&0xE0)>>4));
511 if (map[*fpos + 1] & 0x10)
512 header->version = (map[*fpos + 1] >> 3) & 1;
515 if ((header->sync != 0xFFE) || (header->layer != 1)) {
520 header->crc = map[*fpos + 1] & 1;
521 header->bitrate = (map[*fpos + 2] >> 4) & 0x0F;
522 header->freq = (map[*fpos + 2] >> 2) & 0x3;
523 header->padding = (map[*fpos + 2] >>1) & 0x1;
524 header->mode = (map[*fpos + 3] >> 6) & 0x3;
525 fl = frame_length(header);
526 ret = (fl >= MIN_FRAME_SIZE)? fl : -E_FRAME_LENGTH;
528 *fpos += FRAME_HEADER_SIZE;
533 * find the next mp3 header
535 * Return the length of the next frame header or zero if the end of the file is
538 static int mp3_seek_next_header(unsigned char *map, size_t numbytes, off_t *fpos,
539 struct mp3header *result)
541 int k, l = 0, first_len;
542 struct mp3header h, h2;
543 long valid_start = 0;
545 for (; *fpos < numbytes; (*fpos)++) {
546 if (map[*fpos] != 0xff)
549 first_len = get_header(map, numbytes, fpos, &h);
552 *fpos += first_len - FRAME_HEADER_SIZE;
553 for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
554 if ((l = get_header(map, numbytes, fpos, &h2)) <= 0)
556 if (!compare_headers(&h, &h2))
558 *fpos += l - FRAME_HEADER_SIZE;
560 if (k == MIN_CONSEC_GOOD_FRAMES) {
569 static int find_valid_start(unsigned char *map, size_t numbytes, off_t *fpos,
570 struct mp3header *header)
574 frame_len = get_header(map, numbytes, fpos, header);
578 frame_len = mp3_seek_next_header(map, numbytes, fpos, header);
582 *fpos -= FRAME_HEADER_SIZE;
584 return -E_FRAME_LENGTH;
588 static int mp3_read_info(unsigned char *map, size_t numbytes, int fd,
589 struct afh_info *afhi)
591 uint64_t freq_sum = 0, br_sum = 0;
592 int fl = 0, ret, len = 0, old_br = -1, vbr = 0;
593 struct timeval total_time = {0, 0};
594 unsigned chunk_table_size = 1000; /* gets increased on demand */
596 struct mp3header header;
597 const char *tag_versions[] = {"no", "id3v1", "id3v2", "id3v1+id3v2"};
599 afhi->chunks_total = 0;
600 afhi->chunk_table = para_malloc(chunk_table_size * sizeof(uint32_t));
603 struct timeval tmp, cct; /* current chunk time */
605 len = find_valid_start(map, numbytes, &fpos, &header);
609 if (!afhi->chunks_total)
611 end = afhi->chunk_table[afhi->chunks_total - 1] + fl;
612 afhi->chunk_table[afhi->chunks_total]
613 = PARA_MIN(end, numbytes);
616 ret = header_frequency(&header);
620 ret = header_bitrate(&header);
624 ret = frame_length(&header);
628 tmp.tv_sec = fl - header.padding;
630 tv_divide(br * 125, &tmp, &cct);
631 tv_add(&cct, &total_time, &tmp);
633 if (afhi->chunks_total >= chunk_table_size) {
634 chunk_table_size *= 2;
635 afhi->chunk_table = para_realloc(afhi->chunk_table,
636 chunk_table_size * sizeof(uint32_t));
638 afhi->chunk_table[afhi->chunks_total] = fpos;
639 afhi->chunks_total++;
642 if (afhi->chunks_total != 1 && old_br != br)
647 if (!freq_sum || !br_sum)
649 afhi->bitrate = br_sum / afhi->chunks_total;
650 afhi->frequency = freq_sum / afhi->chunks_total;
651 afhi->channels = header_channels(&header);
652 afhi->seconds_total = (tv2ms(&total_time) + 500) / 1000;
653 tv_divide(afhi->chunks_total, &total_time, &afhi->chunk_tv);
654 PARA_DEBUG_LOG("%" PRIu32 "chunks, each %lums\n", afhi->chunks_total,
655 tv2ms(&afhi->chunk_tv));
656 set_max_chunk_size(afhi);
657 ret = mp3_get_id3(map, numbytes, fd, &afhi->tags);
658 afhi->techinfo = make_message("%cbr, %s, %s tags", vbr? 'v' : 'c',
659 header_mode(&header), tag_versions[ret]);
662 free(afhi->chunk_table);
667 * Read mp3 information from audio file
669 static int mp3_get_file_info(char *map, size_t numbytes, int fd,
670 struct afh_info *afhi)
674 ret = mp3_read_info((unsigned char *)map, numbytes, fd, afhi);
677 if (afhi->seconds_total < 2 || !afhi->chunks_total)
682 static const char * const mp3_suffixes[] = {"mp3", NULL};
685 * the init function of the mp3 audio format handler
687 * \param afh pointer to the struct to initialize
689 void mp3_afh_init(struct audio_format_handler *afh)
691 afh->get_file_info = mp3_get_file_info;
692 afh->suffixes = mp3_suffixes;
693 #ifdef HAVE_LIBID3TAG
694 afh->rewrite_tags = mp3_rewrite_tags;
695 #endif /* HAVE_LIBID3TAG */