2 * Copyright (c) 2003 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Specifications available at:
26 * http://id3.org/Developer_Information
37 #include "libavutil/avstring.h"
38 #include "libavutil/intreadwrite.h"
39 #include "libavutil/dict.h"
40 #include "avio_internal.h"
43 const AVMetadataConv ff_id3v2_34_metadata_conv[] = {
45 { "TCOM", "composer"},
47 { "TCOP", "copyright"},
48 { "TENC", "encoded_by"},
50 { "TLAN", "language"},
52 { "TPE2", "album_artist"},
53 { "TPE3", "performer"},
55 { "TPUB", "publisher"},
61 const AVMetadataConv ff_id3v2_4_metadata_conv[] = {
64 { "TDEN", "creation_time"},
65 { "TSOA", "album-sort"},
66 { "TSOP", "artist-sort"},
67 { "TSOT", "title-sort"},
71 static const AVMetadataConv id3v2_2_metadata_conv[] = {
75 { "TEN", "encoded_by"},
77 { "TP2", "album_artist"},
78 { "TP3", "performer"},
84 const char ff_id3v2_tags[][4] = {
85 "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDLY", "TENC", "TEXT",
86 "TFLT", "TIT1", "TIT2", "TIT3", "TKEY", "TLAN", "TLEN", "TMED",
87 "TOAL", "TOFN", "TOLY", "TOPE", "TOWN", "TPE1", "TPE2", "TPE3",
88 "TPE4", "TPOS", "TPUB", "TRCK", "TRSN", "TRSO", "TSRC", "TSSE",
92 const char ff_id3v2_4_tags[][4] = {
93 "TDEN", "TDOR", "TDRC", "TDRL", "TDTG", "TIPL", "TMCL", "TMOO",
94 "TPRO", "TSOA", "TSOP", "TSOT", "TSST",
98 const char ff_id3v2_3_tags[][4] = {
99 "TDAT", "TIME", "TORY", "TRDA", "TSIZ", "TYER",
103 const char *ff_id3v2_picture_types[21] = {
105 "32x32 pixels 'file icon'",
110 "Media (e.g. label side of CD)",
111 "Lead artist/lead performer/soloist",
116 "Lyricist/text writer",
117 "Recording Location",
119 "During performance",
120 "Movie/video screen capture",
121 "A bright coloured fish",
123 "Band/artist logotype",
124 "Publisher/Studio logotype",
127 const CodecMime ff_id3v2_mime_tags[] = {
128 {"image/gif" , CODEC_ID_GIF},
129 {"image/jpeg", CODEC_ID_MJPEG},
130 {"image/jpg", CODEC_ID_MJPEG},
131 {"image/png" , CODEC_ID_PNG},
132 {"image/tiff", CODEC_ID_TIFF},
136 int ff_id3v2_match(const uint8_t *buf, const char * magic)
138 return buf[0] == magic[0] &&
139 buf[1] == magic[1] &&
140 buf[2] == magic[2] &&
143 (buf[6] & 0x80) == 0 &&
144 (buf[7] & 0x80) == 0 &&
145 (buf[8] & 0x80) == 0 &&
146 (buf[9] & 0x80) == 0;
149 int ff_id3v2_tag_len(const uint8_t * buf)
151 int len = ((buf[6] & 0x7f) << 21) +
152 ((buf[7] & 0x7f) << 14) +
153 ((buf[8] & 0x7f) << 7) +
157 len += ID3v2_HEADER_SIZE;
161 static unsigned int get_size(AVIOContext *s, int len)
165 v = (v << 7) + (avio_r8(s) & 0x7F);
170 * Free GEOB type extra metadata.
172 static void free_geobtag(void *obj)
174 ID3v2ExtraMetaGEOB *geob = obj;
175 av_free(geob->mime_type);
176 av_free(geob->file_name);
177 av_free(geob->description);
183 * Decode characters to UTF-8 according to encoding type. The decoded buffer is
184 * always null terminated. Stop reading when either *maxread bytes are read from
185 * pb or U+0000 character is found.
187 * @param dst Pointer where the address of the buffer with the decoded bytes is
188 * stored. Buffer must be freed by caller.
189 * @param maxread Pointer to maximum number of characters to read from the
190 * AVIOContext. After execution the value is decremented by the number of bytes
192 * @returns 0 if no error occurred, dst is uninitialized on error
194 static int decode_str(AVFormatContext *s, AVIOContext *pb, int encoding,
195 uint8_t **dst, int *maxread)
201 unsigned int (*get)(AVIOContext*) = avio_rb16;
204 if ((ret = avio_open_dyn_buf(&dynbuf)) < 0) {
205 av_log(s, AV_LOG_ERROR, "Error opening memory stream\n");
211 case ID3v2_ENCODING_ISO8859:
214 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
219 case ID3v2_ENCODING_UTF16BOM:
220 if ((left -= 2) < 0) {
221 av_log(s, AV_LOG_ERROR, "Cannot read BOM value, input too short\n");
222 avio_close_dyn_buf(dynbuf, dst);
224 return AVERROR_INVALIDDATA;
226 switch (avio_rb16(pb)) {
232 av_log(s, AV_LOG_ERROR, "Incorrect BOM value\n");
233 avio_close_dyn_buf(dynbuf, dst);
236 return AVERROR_INVALIDDATA;
240 case ID3v2_ENCODING_UTF16BE:
241 while ((left > 1) && ch) {
242 GET_UTF16(ch, ((left -= 2) >= 0 ? get(pb) : 0), break;)
243 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
246 left += 2; /* did not read last char from pb */
249 case ID3v2_ENCODING_UTF8:
257 av_log(s, AV_LOG_WARNING, "Unknown encoding\n");
263 avio_close_dyn_buf(dynbuf, dst);
272 static void read_ttag(AVFormatContext *s, AVIOContext *pb, int taglen, const char *key)
275 int encoding, dict_flags = AV_DICT_DONT_OVERWRITE;
281 encoding = avio_r8(pb);
282 taglen--; /* account for encoding type byte */
284 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
285 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
289 if (!(strcmp(key, "TCON") && strcmp(key, "TCO"))
290 && (sscanf(dst, "(%d)", &genre) == 1 || sscanf(dst, "%d", &genre) == 1)
291 && genre <= ID3v1_GENRE_MAX) {
293 dst = ff_id3v1_genre_str[genre];
294 } else if (!(strcmp(key, "TXXX") && strcmp(key, "TXX"))) {
295 /* dst now contains the key, need to get value */
297 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
298 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
302 dict_flags |= AV_DICT_DONT_STRDUP_VAL | AV_DICT_DONT_STRDUP_KEY;
305 dict_flags |= AV_DICT_DONT_STRDUP_VAL;
308 av_dict_set(&s->metadata, key, dst, dict_flags);
312 * Parse GEOB tag into a ID3v2ExtraMetaGEOB struct.
314 static void read_geobtag(AVFormatContext *s, AVIOContext *pb, int taglen, char *tag, ID3v2ExtraMeta **extra_meta)
316 ID3v2ExtraMetaGEOB *geob_data = NULL;
317 ID3v2ExtraMeta *new_extra = NULL;
324 geob_data = av_mallocz(sizeof(ID3v2ExtraMetaGEOB));
326 av_log(s, AV_LOG_ERROR, "Failed to alloc %zu bytes\n", sizeof(ID3v2ExtraMetaGEOB));
330 new_extra = av_mallocz(sizeof(ID3v2ExtraMeta));
332 av_log(s, AV_LOG_ERROR, "Failed to alloc %zu bytes\n", sizeof(ID3v2ExtraMeta));
336 /* read encoding type byte */
337 encoding = avio_r8(pb);
340 /* read MIME type (always ISO-8859) */
341 if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &geob_data->mime_type, &taglen) < 0
346 if (decode_str(s, pb, encoding, &geob_data->file_name, &taglen) < 0
350 /* read content description */
351 if (decode_str(s, pb, encoding, &geob_data->description, &taglen) < 0
356 /* save encapsulated binary data */
357 geob_data->data = av_malloc(taglen);
358 if (!geob_data->data) {
359 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", taglen);
362 if ((len = avio_read(pb, geob_data->data, taglen)) < taglen)
363 av_log(s, AV_LOG_WARNING, "Error reading GEOB frame, data truncated.\n");
364 geob_data->datasize = len;
366 geob_data->data = NULL;
367 geob_data->datasize = 0;
370 /* add data to the list */
371 new_extra->tag = "GEOB";
372 new_extra->data = geob_data;
373 new_extra->next = *extra_meta;
374 *extra_meta = new_extra;
379 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", tag);
380 free_geobtag(geob_data);
385 static int is_number(const char *str)
387 while (*str >= '0' && *str <= '9') str++;
391 static AVDictionaryEntry* get_date_tag(AVDictionary *m, const char *tag)
393 AVDictionaryEntry *t;
394 if ((t = av_dict_get(m, tag, NULL, AV_DICT_MATCH_CASE)) &&
395 strlen(t->value) == 4 && is_number(t->value))
400 static void merge_date(AVDictionary **m)
402 AVDictionaryEntry *t;
403 char date[17] = {0}; // YYYY-MM-DD hh:mm
405 if (!(t = get_date_tag(*m, "TYER")) &&
406 !(t = get_date_tag(*m, "TYE")))
408 av_strlcpy(date, t->value, 5);
409 av_dict_set(m, "TYER", NULL, 0);
410 av_dict_set(m, "TYE", NULL, 0);
412 if (!(t = get_date_tag(*m, "TDAT")) &&
413 !(t = get_date_tag(*m, "TDA")))
415 snprintf(date + 4, sizeof(date) - 4, "-%.2s-%.2s", t->value + 2, t->value);
416 av_dict_set(m, "TDAT", NULL, 0);
417 av_dict_set(m, "TDA", NULL, 0);
419 if (!(t = get_date_tag(*m, "TIME")) &&
420 !(t = get_date_tag(*m, "TIM")))
422 snprintf(date + 10, sizeof(date) - 10, " %.2s:%.2s", t->value, t->value + 2);
423 av_dict_set(m, "TIME", NULL, 0);
424 av_dict_set(m, "TIM", NULL, 0);
428 av_dict_set(m, "date", date, 0);
431 static void free_apic(void *obj)
433 ID3v2ExtraMetaAPIC *apic = obj;
434 av_freep(&apic->data);
435 av_freep(&apic->description);
439 static void read_apic(AVFormatContext *s, AVIOContext *pb, int taglen, char *tag, ID3v2ExtraMeta **extra_meta)
443 const CodecMime *mime = ff_id3v2_mime_tags;
444 enum CodecID id = CODEC_ID_NONE;
445 ID3v2ExtraMetaAPIC *apic = NULL;
446 ID3v2ExtraMeta *new_extra = NULL;
447 int64_t end = avio_tell(pb) + taglen;
452 new_extra = av_mallocz(sizeof(*new_extra));
453 apic = av_mallocz(sizeof(*apic));
454 if (!new_extra || !apic)
461 taglen -= avio_get_str(pb, taglen, mimetype, sizeof(mimetype));
462 while (mime->id != CODEC_ID_NONE) {
463 if (!strncmp(mime->str, mimetype, sizeof(mimetype))) {
469 if (id == CODEC_ID_NONE) {
470 av_log(s, AV_LOG_WARNING, "Unknown attached picture mimetype: %s, skipping.\n", mimetype);
476 pic_type = avio_r8(pb);
478 if (pic_type < 0 || pic_type >= FF_ARRAY_ELEMS(ff_id3v2_picture_types)) {
479 av_log(s, AV_LOG_WARNING, "Unknown attached picture type %d.\n", pic_type);
482 apic->type = ff_id3v2_picture_types[pic_type];
484 /* description and picture data */
485 if (decode_str(s, pb, enc, &apic->description, &taglen) < 0) {
486 av_log(s, AV_LOG_ERROR, "Error decoding attached picture description.\n");
491 apic->data = av_malloc(taglen);
492 if (!apic->data || avio_read(pb, apic->data, taglen) != taglen)
495 new_extra->tag = "APIC";
496 new_extra->data = apic;
497 new_extra->next = *extra_meta;
498 *extra_meta = new_extra;
505 av_freep(&new_extra);
506 avio_seek(pb, end, SEEK_SET);
509 typedef struct ID3v2EMFunc {
512 void (*read)(AVFormatContext*, AVIOContext*, int, char*, ID3v2ExtraMeta **);
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) {
531 if (tag && !memcmp(tag,
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 ff_id3v2_parse(AVFormatContext *s, int len, uint8_t version, uint8_t flags, ID3v2ExtraMeta **extra_meta)
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 = NULL;
554 unsigned char *compressed_buffer = NULL;
555 int compressed_buffer_size = 0;
560 reason = "compression";
578 unsync = flags & 0x80;
580 if (isv34 && flags & 0x40) { /* Extended header present, just skip over it */
581 int extlen = get_size(s->pb, 4);
583 extlen -= 4; // in v2.4 the length includes the length field we just read
586 reason = "invalid extended header length";
589 avio_skip(s->pb, extlen);
592 reason = "extended header too long.";
597 while (len >= taghdrlen) {
598 unsigned int tflags = 0;
605 avio_read(s->pb, tag, 4);
608 tlen = avio_rb32(s->pb);
610 tlen = get_size(s->pb, 4);
611 tflags = avio_rb16(s->pb);
612 tunsync = tflags & ID3v2_FLAG_UNSYNCH;
614 avio_read(s->pb, tag, 3);
616 tlen = avio_rb24(s->pb);
620 len -= taghdrlen + tlen;
625 next = avio_tell(s->pb) + tlen;
629 av_log(s, AV_LOG_DEBUG, "Invalid empty frame %s, skipping.\n", tag);
633 if (tflags & ID3v2_FLAG_DATALEN) {
636 dlen = avio_rb32(s->pb);
641 tcomp = tflags & ID3v2_FLAG_COMPRESSION;
642 tencr = tflags & ID3v2_FLAG_ENCRYPTION;
644 /* skip encrypted tags and, if no zlib, compressed tags */
645 if (tencr || (!CONFIG_ZLIB && tcomp)) {
652 type = "encrypted and compressed";
654 av_log(s, AV_LOG_WARNING, "Skipping %s ID3v2 frame %s.\n", type, tag);
655 avio_skip(s->pb, tlen);
656 /* check for text tag or supported special meta tag */
657 } else if (tag[0] == 'T' || (extra_meta && (extra_func = get_extra_meta_func(tag, isv34)))) {
658 if (unsync || tunsync || tcomp) {
661 av_fast_malloc(&buffer, &buffer_size, dlen);
663 av_log(s, AV_LOG_ERROR, "Failed to alloc %ld bytes\n", dlen);
670 av_log(s, AV_LOG_DEBUG, "Compresssed frame %s tlen=%d dlen=%ld\n", tag, tlen, dlen);
672 av_fast_malloc(&compressed_buffer, &compressed_buffer_size, tlen);
673 if (!compressed_buffer) {
674 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", tlen);
678 n = avio_read(s->pb, compressed_buffer, tlen);
680 av_log(s, AV_LOG_ERROR, "Failed to read compressed tag\n");
684 err = uncompress(buffer, &dlen, compressed_buffer, n);
686 av_log(s, AV_LOG_ERROR, "Failed to uncompress tag: %d\n", err);
692 for (i = 0, j = 0; i < dlen; i++, j++) {
694 buffer[j] = avio_r8(s->pb);
695 if (j > 0 && !buffer[j] && buffer[j - 1] == 0xff) {
696 /* Unsynchronised byte, skip it */
700 ffio_init_context(&pb, buffer, j, 0, NULL, NULL, NULL, NULL);
702 pbx = &pb; // read from sync buffer
704 pbx = s->pb; // read straight from input
708 read_ttag(s, pbx, tlen, tag);
710 /* parse special meta tag */
711 extra_func->read(s, pbx, tlen, tag, extra_meta);
715 av_log(s, AV_LOG_WARNING, "invalid frame id, assuming padding");
716 avio_skip(s->pb, tlen);
719 /* Skip to end of tag */
721 avio_seek(s->pb, next, SEEK_SET);
724 if (version == 4 && flags & 0x10) /* Footer preset, always 10 bytes, skip over it */
729 av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n", version, reason);
730 avio_seek(s->pb, end, SEEK_SET);
732 av_free(compressed_buffer);
736 void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta)
739 uint8_t buf[ID3v2_HEADER_SIZE];
744 /* save the current offset in case there's nothing to read/skip */
745 off = avio_tell(s->pb);
746 ret = avio_read(s->pb, buf, ID3v2_HEADER_SIZE);
747 if (ret != ID3v2_HEADER_SIZE)
749 found_header = ff_id3v2_match(buf, magic);
751 /* parse ID3v2 header */
752 len = ((buf[6] & 0x7f) << 21) |
753 ((buf[7] & 0x7f) << 14) |
754 ((buf[8] & 0x7f) << 7) |
756 ff_id3v2_parse(s, len, buf[3], buf[5], extra_meta);
758 avio_seek(s->pb, off, SEEK_SET);
760 } while (found_header);
761 ff_metadata_conv(&s->metadata, NULL, ff_id3v2_34_metadata_conv);
762 ff_metadata_conv(&s->metadata, NULL, id3v2_2_metadata_conv);
763 ff_metadata_conv(&s->metadata, NULL, ff_id3v2_4_metadata_conv);
764 merge_date(&s->metadata);
767 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
769 ID3v2ExtraMeta *current = *extra_meta, *next;
770 const ID3v2EMFunc *extra_func;
773 if ((extra_func = get_extra_meta_func(current->tag, 1)))
774 extra_func->free(current->data);
775 next = current->next;
781 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
785 for (cur = *extra_meta; cur; cur = cur->next) {
786 ID3v2ExtraMetaAPIC *apic;
789 if (strcmp(cur->tag, "APIC"))
793 if (!(st = avformat_new_stream(s, NULL)))
794 return AVERROR(ENOMEM);
796 st->disposition |= AV_DISPOSITION_ATTACHED_PIC;
797 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
798 st->codec->codec_id = apic->id;
799 av_dict_set(&st->metadata, "title", apic->description, 0);
800 av_dict_set(&st->metadata, "comment", apic->type, 0);
802 av_init_packet(&st->attached_pic);
803 st->attached_pic.data = apic->data;
804 st->attached_pic.size = apic->len;
805 st->attached_pic.destruct = av_destruct_packet;
806 st->attached_pic.stream_index = st->index;
807 st->attached_pic.flags |= AV_PKT_FLAG_KEY;