3 * Copyright (c) 2003 Fabrice Bellard
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/avstring.h"
23 #include "libavutil/dict.h"
24 #include "libavutil/intreadwrite.h"
25 #include "avio_internal.h"
30 const AVMetadataConv ff_id3v2_34_metadata_conv[] = {
32 { "TCOM", "composer" },
34 { "TCOP", "copyright" },
35 { "TENC", "encoded_by" },
37 { "TLAN", "language" },
39 { "TPE2", "album_artist" },
40 { "TPE3", "performer" },
42 { "TPUB", "publisher" },
44 { "TSSE", "encoder" },
48 const AVMetadataConv ff_id3v2_4_metadata_conv[] = {
51 { "TDEN", "creation_time" },
52 { "TSOA", "album-sort" },
53 { "TSOP", "artist-sort" },
54 { "TSOT", "title-sort" },
58 static const AVMetadataConv id3v2_2_metadata_conv[] = {
62 { "TEN", "encoded_by" },
64 { "TP2", "album_artist" },
65 { "TP3", "performer" },
70 const char ff_id3v2_tags[][4] = {
71 "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDLY", "TENC", "TEXT",
72 "TFLT", "TIT1", "TIT2", "TIT3", "TKEY", "TLAN", "TLEN", "TMED",
73 "TOAL", "TOFN", "TOLY", "TOPE", "TOWN", "TPE1", "TPE2", "TPE3",
74 "TPE4", "TPOS", "TPUB", "TRCK", "TRSN", "TRSO", "TSRC", "TSSE",
78 const char ff_id3v2_4_tags[][4] = {
79 "TDEN", "TDOR", "TDRC", "TDRL", "TDTG", "TIPL", "TMCL", "TMOO",
80 "TPRO", "TSOA", "TSOP", "TSOT", "TSST",
84 const char ff_id3v2_3_tags[][4] = {
85 "TDAT", "TIME", "TORY", "TRDA", "TSIZ", "TYER",
89 const char *ff_id3v2_picture_types[21] = {
91 "32x32 pixels 'file icon'",
96 "Media (e.g. label side of CD)",
97 "Lead artist/lead performer/soloist",
102 "Lyricist/text writer",
103 "Recording Location",
105 "During performance",
106 "Movie/video screen capture",
107 "A bright coloured fish",
109 "Band/artist logotype",
110 "Publisher/Studio logotype",
113 const CodecMime ff_id3v2_mime_tags[] = {
114 { "image/gif", AV_CODEC_ID_GIF },
115 { "image/jpeg", AV_CODEC_ID_MJPEG },
116 { "image/jpg", AV_CODEC_ID_MJPEG },
117 { "image/png", AV_CODEC_ID_PNG },
118 { "image/tiff", AV_CODEC_ID_TIFF },
119 { "image/bmp", AV_CODEC_ID_BMP },
120 { "JPG", AV_CODEC_ID_MJPEG }, /* ID3v2.2 */
121 { "PNG", AV_CODEC_ID_PNG }, /* ID3v2.2 */
122 { "", AV_CODEC_ID_NONE },
125 int ff_id3v2_match(const uint8_t *buf, const char *magic)
127 return buf[0] == magic[0] &&
128 buf[1] == magic[1] &&
129 buf[2] == magic[2] &&
132 (buf[6] & 0x80) == 0 &&
133 (buf[7] & 0x80) == 0 &&
134 (buf[8] & 0x80) == 0 &&
135 (buf[9] & 0x80) == 0;
138 int ff_id3v2_tag_len(const uint8_t *buf)
140 int len = ((buf[6] & 0x7f) << 21) +
141 ((buf[7] & 0x7f) << 14) +
142 ((buf[8] & 0x7f) << 7) +
146 len += ID3v2_HEADER_SIZE;
150 static unsigned int get_size(AVIOContext *s, int len)
154 v = (v << 7) + (avio_r8(s) & 0x7F);
159 * Free GEOB type extra metadata.
161 static void free_geobtag(void *obj)
163 ID3v2ExtraMetaGEOB *geob = obj;
164 av_free(geob->mime_type);
165 av_free(geob->file_name);
166 av_free(geob->description);
172 * Decode characters to UTF-8 according to encoding type. The decoded buffer is
173 * always null terminated. Stop reading when either *maxread bytes are read from
174 * pb or U+0000 character is found.
176 * @param dst Pointer where the address of the buffer with the decoded bytes is
177 * stored. Buffer must be freed by caller.
178 * @param maxread Pointer to maximum number of characters to read from the
179 * AVIOContext. After execution the value is decremented by the number of bytes
181 * @returns 0 if no error occurred, dst is uninitialized on error
183 static int decode_str(AVFormatContext *s, AVIOContext *pb, int encoding,
184 uint8_t **dst, int *maxread)
190 unsigned int (*get)(AVIOContext*) = avio_rb16;
193 if ((ret = avio_open_dyn_buf(&dynbuf)) < 0) {
194 av_log(s, AV_LOG_ERROR, "Error opening memory stream\n");
199 case ID3v2_ENCODING_ISO8859:
202 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
207 case ID3v2_ENCODING_UTF16BOM:
208 if ((left -= 2) < 0) {
209 av_log(s, AV_LOG_ERROR, "Cannot read BOM value, input too short\n");
210 avio_close_dyn_buf(dynbuf, dst);
212 return AVERROR_INVALIDDATA;
214 switch (avio_rb16(pb)) {
220 av_log(s, AV_LOG_ERROR, "Incorrect BOM value\n");
221 avio_close_dyn_buf(dynbuf, dst);
224 return AVERROR_INVALIDDATA;
228 case ID3v2_ENCODING_UTF16BE:
229 while ((left > 1) && ch) {
230 GET_UTF16(ch, ((left -= 2) >= 0 ? get(pb) : 0), break;)
231 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
234 left += 2; /* did not read last char from pb */
237 case ID3v2_ENCODING_UTF8:
245 av_log(s, AV_LOG_WARNING, "Unknown encoding\n");
251 avio_close_dyn_buf(dynbuf, dst);
260 static void read_ttag(AVFormatContext *s, AVIOContext *pb, int taglen,
264 int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
270 encoding = avio_r8(pb);
271 taglen--; /* account for encoding type byte */
273 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
274 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
278 if (!(strcmp(key, "TCON") && strcmp(key, "TCO")) &&
279 (sscanf(dst, "(%d)", &genre) == 1 || sscanf(dst, "%d", &genre) == 1) &&
280 genre <= ID3v1_GENRE_MAX) {
282 dst = av_strdup(ff_id3v1_genre_str[genre]);
283 } else if (!(strcmp(key, "TXXX") && strcmp(key, "TXX"))) {
284 /* dst now contains the key, need to get value */
286 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
287 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
291 dict_flags |= AV_DICT_DONT_STRDUP_KEY;
296 av_dict_set(&s->metadata, key, dst, dict_flags);
300 * Parse GEOB tag into a ID3v2ExtraMetaGEOB struct.
302 static void read_geobtag(AVFormatContext *s, AVIOContext *pb, int taglen,
303 char *tag, ID3v2ExtraMeta **extra_meta)
305 ID3v2ExtraMetaGEOB *geob_data = NULL;
306 ID3v2ExtraMeta *new_extra = NULL;
313 geob_data = av_mallocz(sizeof(ID3v2ExtraMetaGEOB));
315 av_log(s, AV_LOG_ERROR, "Failed to alloc %zu bytes\n",
316 sizeof(ID3v2ExtraMetaGEOB));
320 new_extra = av_mallocz(sizeof(ID3v2ExtraMeta));
322 av_log(s, AV_LOG_ERROR, "Failed to alloc %zu bytes\n",
323 sizeof(ID3v2ExtraMeta));
327 /* read encoding type byte */
328 encoding = avio_r8(pb);
331 /* read MIME type (always ISO-8859) */
332 if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &geob_data->mime_type,
338 if (decode_str(s, pb, encoding, &geob_data->file_name, &taglen) < 0 ||
342 /* read content description */
343 if (decode_str(s, pb, encoding, &geob_data->description, &taglen) < 0 ||
348 /* save encapsulated binary data */
349 geob_data->data = av_malloc(taglen);
350 if (!geob_data->data) {
351 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", taglen);
354 if ((len = avio_read(pb, geob_data->data, taglen)) < taglen)
355 av_log(s, AV_LOG_WARNING,
356 "Error reading GEOB frame, data truncated.\n");
357 geob_data->datasize = len;
359 geob_data->data = NULL;
360 geob_data->datasize = 0;
363 /* add data to the list */
364 new_extra->tag = "GEOB";
365 new_extra->data = geob_data;
366 new_extra->next = *extra_meta;
367 *extra_meta = new_extra;
372 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", tag);
373 free_geobtag(geob_data);
378 static int is_number(const char *str)
380 while (*str >= '0' && *str <= '9')
385 static AVDictionaryEntry *get_date_tag(AVDictionary *m, const char *tag)
387 AVDictionaryEntry *t;
388 if ((t = av_dict_get(m, tag, NULL, AV_DICT_MATCH_CASE)) &&
389 strlen(t->value) == 4 && is_number(t->value))
394 static void merge_date(AVDictionary **m)
396 AVDictionaryEntry *t;
397 char date[17] = { 0 }; // YYYY-MM-DD hh:mm
399 if (!(t = get_date_tag(*m, "TYER")) &&
400 !(t = get_date_tag(*m, "TYE")))
402 av_strlcpy(date, t->value, 5);
403 av_dict_set(m, "TYER", NULL, 0);
404 av_dict_set(m, "TYE", NULL, 0);
406 if (!(t = get_date_tag(*m, "TDAT")) &&
407 !(t = get_date_tag(*m, "TDA")))
409 snprintf(date + 4, sizeof(date) - 4, "-%.2s-%.2s", t->value + 2, t->value);
410 av_dict_set(m, "TDAT", NULL, 0);
411 av_dict_set(m, "TDA", NULL, 0);
413 if (!(t = get_date_tag(*m, "TIME")) &&
414 !(t = get_date_tag(*m, "TIM")))
416 snprintf(date + 10, sizeof(date) - 10,
417 " %.2s:%.2s", t->value, t->value + 2);
418 av_dict_set(m, "TIME", NULL, 0);
419 av_dict_set(m, "TIM", NULL, 0);
423 av_dict_set(m, "date", date, 0);
426 static void free_apic(void *obj)
428 ID3v2ExtraMetaAPIC *apic = obj;
429 av_buffer_unref(&apic->buf);
430 av_freep(&apic->description);
434 static void read_apic(AVFormatContext *s, AVIOContext *pb, int taglen,
435 char *tag, ID3v2ExtraMeta **extra_meta)
439 const CodecMime *mime = ff_id3v2_mime_tags;
440 enum AVCodecID id = AV_CODEC_ID_NONE;
441 ID3v2ExtraMetaAPIC *apic = NULL;
442 ID3v2ExtraMeta *new_extra = NULL;
443 int64_t end = avio_tell(pb) + taglen;
448 new_extra = av_mallocz(sizeof(*new_extra));
449 apic = av_mallocz(sizeof(*apic));
450 if (!new_extra || !apic)
457 taglen -= avio_get_str(pb, taglen, mimetype, sizeof(mimetype));
458 while (mime->id != AV_CODEC_ID_NONE) {
459 if (!av_strncasecmp(mime->str, mimetype, sizeof(mimetype))) {
465 if (id == AV_CODEC_ID_NONE) {
466 av_log(s, AV_LOG_WARNING,
467 "Unknown attached picture mimetype: %s, skipping.\n", mimetype);
473 pic_type = avio_r8(pb);
475 if (pic_type < 0 || pic_type >= FF_ARRAY_ELEMS(ff_id3v2_picture_types)) {
476 av_log(s, AV_LOG_WARNING, "Unknown attached picture type %d.\n",
480 apic->type = ff_id3v2_picture_types[pic_type];
482 /* description and picture data */
483 if (decode_str(s, pb, enc, &apic->description, &taglen) < 0) {
484 av_log(s, AV_LOG_ERROR,
485 "Error decoding attached picture description.\n");
489 apic->buf = av_buffer_alloc(taglen + FF_INPUT_BUFFER_PADDING_SIZE);
490 if (!apic->buf || avio_read(pb, apic->buf->data, taglen) != taglen)
492 memset(apic->buf->data + taglen, 0, FF_INPUT_BUFFER_PADDING_SIZE);
494 new_extra->tag = "APIC";
495 new_extra->data = apic;
496 new_extra->next = *extra_meta;
497 *extra_meta = new_extra;
504 av_freep(&new_extra);
505 avio_seek(pb, end, SEEK_SET);
508 typedef struct ID3v2EMFunc {
511 void (*read)(AVFormatContext *, AVIOContext *, int, char *,
513 void (*free)(void *obj);
516 static const ID3v2EMFunc id3v2_extra_meta_funcs[] = {
517 { "GEO", "GEOB", read_geobtag, free_geobtag },
518 { "PIC", "APIC", read_apic, free_apic },
523 * Get the corresponding ID3v2EMFunc struct for a tag.
524 * @param isv34 Determines if v2.2 or v2.3/4 strings are used
525 * @return A pointer to the ID3v2EMFunc struct if found, NULL otherwise.
527 static const ID3v2EMFunc *get_extra_meta_func(const char *tag, int isv34)
530 while (id3v2_extra_meta_funcs[i].tag3) {
532 (isv34 ? id3v2_extra_meta_funcs[i].tag4 :
533 id3v2_extra_meta_funcs[i].tag3),
535 return &id3v2_extra_meta_funcs[i];
541 static void id3v2_parse(AVFormatContext *s, int len, uint8_t version,
542 uint8_t flags, ID3v2ExtraMeta **extra_meta)
544 int isv34, tlen, unsync;
546 int64_t next, end = avio_tell(s->pb) + len;
548 const char *reason = NULL;
551 unsigned char *buffer = NULL;
553 const ID3v2EMFunc *extra_func;
558 reason = "compression";
576 unsync = flags & 0x80;
578 if (isv34 && flags & 0x40) { /* Extended header present, just skip over it */
579 int extlen = get_size(s->pb, 4);
581 /* In v2.4 the length includes the length field we just read. */
585 reason = "invalid extended header length";
588 avio_skip(s->pb, extlen);
591 while (len >= taghdrlen) {
592 unsigned int tflags = 0;
596 avio_read(s->pb, tag, 4);
599 tlen = avio_rb32(s->pb);
601 tlen = get_size(s->pb, 4);
602 tflags = avio_rb16(s->pb);
603 tunsync = tflags & ID3v2_FLAG_UNSYNCH;
605 avio_read(s->pb, tag, 3);
607 tlen = avio_rb24(s->pb);
609 if (tlen < 0 || tlen > len - taghdrlen) {
610 av_log(s, AV_LOG_WARNING,
611 "Invalid size in frame %s, skipping the rest of tag.\n",
615 len -= taghdrlen + tlen;
616 next = avio_tell(s->pb) + tlen;
620 av_log(s, AV_LOG_DEBUG, "Invalid empty frame %s, skipping.\n",
625 if (tflags & ID3v2_FLAG_DATALEN) {
630 if (tflags & (ID3v2_FLAG_ENCRYPTION | ID3v2_FLAG_COMPRESSION)) {
631 av_log(s, AV_LOG_WARNING,
632 "Skipping encrypted/compressed ID3v2 frame %s.\n", tag);
633 avio_skip(s->pb, tlen);
634 /* check for text tag or supported special meta tag */
635 } else if (tag[0] == 'T' ||
637 (extra_func = get_extra_meta_func(tag, isv34)))) {
638 if (unsync || tunsync) {
639 int64_t end = avio_tell(s->pb) + tlen;
641 av_fast_malloc(&buffer, &buffer_size, tlen);
643 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", tlen);
647 while (avio_tell(s->pb) < end && !s->pb->eof_reached) {
648 *b++ = avio_r8(s->pb);
649 if (*(b - 1) == 0xff && avio_tell(s->pb) < end - 1 &&
650 !s->pb->eof_reached ) {
651 uint8_t val = avio_r8(s->pb);
652 *b++ = val ? val : avio_r8(s->pb);
655 ffio_init_context(&pb, buffer, b - buffer, 0, NULL, NULL, NULL,
658 pbx = &pb; // read from sync buffer
660 pbx = s->pb; // read straight from input
664 read_ttag(s, pbx, tlen, tag);
666 /* parse special meta tag */
667 extra_func->read(s, pbx, tlen, tag, extra_meta);
668 } else if (!tag[0]) {
670 av_log(s, AV_LOG_WARNING, "invalid frame id, assuming padding");
671 avio_skip(s->pb, tlen);
674 /* Skip to end of tag */
676 avio_seek(s->pb, next, SEEK_SET);
679 /* Footer preset, always 10 bytes, skip over it */
680 if (version == 4 && flags & 0x10)
685 av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n",
687 avio_seek(s->pb, end, SEEK_SET);
692 void ff_id3v2_read(AVFormatContext *s, const char *magic,
693 ID3v2ExtraMeta **extra_meta)
696 uint8_t buf[ID3v2_HEADER_SIZE];
701 /* save the current offset in case there's nothing to read/skip */
702 off = avio_tell(s->pb);
703 ret = avio_read(s->pb, buf, ID3v2_HEADER_SIZE);
704 if (ret != ID3v2_HEADER_SIZE)
706 found_header = ff_id3v2_match(buf, magic);
708 /* parse ID3v2 header */
709 len = ((buf[6] & 0x7f) << 21) |
710 ((buf[7] & 0x7f) << 14) |
711 ((buf[8] & 0x7f) << 7) |
713 id3v2_parse(s, len, buf[3], buf[5], extra_meta);
715 avio_seek(s->pb, off, SEEK_SET);
717 } while (found_header);
718 ff_metadata_conv(&s->metadata, NULL, ff_id3v2_34_metadata_conv);
719 ff_metadata_conv(&s->metadata, NULL, id3v2_2_metadata_conv);
720 ff_metadata_conv(&s->metadata, NULL, ff_id3v2_4_metadata_conv);
721 merge_date(&s->metadata);
724 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
726 ID3v2ExtraMeta *current = *extra_meta, *next;
727 const ID3v2EMFunc *extra_func;
730 if ((extra_func = get_extra_meta_func(current->tag, 1)))
731 extra_func->free(current->data);
732 next = current->next;
738 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
742 for (cur = *extra_meta; cur; cur = cur->next) {
743 ID3v2ExtraMetaAPIC *apic;
746 if (strcmp(cur->tag, "APIC"))
750 if (!(st = avformat_new_stream(s, NULL)))
751 return AVERROR(ENOMEM);
753 st->disposition |= AV_DISPOSITION_ATTACHED_PIC;
754 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
755 st->codec->codec_id = apic->id;
756 av_dict_set(&st->metadata, "title", apic->description, 0);
757 av_dict_set(&st->metadata, "comment", apic->type, 0);
759 av_init_packet(&st->attached_pic);
760 st->attached_pic.buf = apic->buf;
761 st->attached_pic.data = apic->buf->data;
762 st->attached_pic.size = apic->buf->size - FF_INPUT_BUFFER_PADDING_SIZE;
763 st->attached_pic.stream_index = st->index;
764 st->attached_pic.flags |= AV_PKT_FLAG_KEY;