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
35 #include "libavutil/avstring.h"
36 #include "libavutil/bprint.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/intreadwrite.h"
39 #include "libavcodec/png.h"
40 #include "avio_internal.h"
45 const AVMetadataConv ff_id3v2_34_metadata_conv[] = {
47 { "TCOM", "composer" },
49 { "TCOP", "copyright" },
50 { "TENC", "encoded_by" },
52 { "TLAN", "language" },
54 { "TPE2", "album_artist" },
55 { "TPE3", "performer" },
57 { "TPUB", "publisher" },
59 { "TSSE", "encoder" },
64 const AVMetadataConv ff_id3v2_4_metadata_conv[] = {
65 { "TCMP", "compilation" },
68 { "TDEN", "creation_time" },
69 { "TSOA", "album-sort" },
70 { "TSOP", "artist-sort" },
71 { "TSOT", "title-sort" },
75 static const AVMetadataConv id3v2_2_metadata_conv[] = {
78 { "TCP", "compilation" },
80 { "TEN", "encoded_by" },
82 { "TP2", "album_artist" },
83 { "TP3", "performer" },
88 const char ff_id3v2_tags[][4] = {
89 "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDLY", "TENC", "TEXT",
90 "TFLT", "TIT1", "TIT2", "TIT3", "TKEY", "TLAN", "TLEN", "TMED",
91 "TOAL", "TOFN", "TOLY", "TOPE", "TOWN", "TPE1", "TPE2", "TPE3",
92 "TPE4", "TPOS", "TPUB", "TRCK", "TRSN", "TRSO", "TSRC", "TSSE",
96 const char ff_id3v2_4_tags[][4] = {
97 "TDEN", "TDOR", "TDRC", "TDRL", "TDTG", "TIPL", "TMCL", "TMOO",
98 "TPRO", "TSOA", "TSOP", "TSOT", "TSST",
102 const char ff_id3v2_3_tags[][4] = {
103 "TDAT", "TIME", "TORY", "TRDA", "TSIZ", "TYER",
107 const char * const ff_id3v2_picture_types[21] = {
109 "32x32 pixels 'file icon'",
114 "Media (e.g. label side of CD)",
115 "Lead artist/lead performer/soloist",
120 "Lyricist/text writer",
121 "Recording Location",
123 "During performance",
124 "Movie/video screen capture",
125 "A bright coloured fish",
127 "Band/artist logotype",
128 "Publisher/Studio logotype",
131 const CodecMime ff_id3v2_mime_tags[] = {
132 { "image/gif", AV_CODEC_ID_GIF },
133 { "image/jpeg", AV_CODEC_ID_MJPEG },
134 { "image/jpg", AV_CODEC_ID_MJPEG },
135 { "image/png", AV_CODEC_ID_PNG },
136 { "image/tiff", AV_CODEC_ID_TIFF },
137 { "image/bmp", AV_CODEC_ID_BMP },
138 { "JPG", AV_CODEC_ID_MJPEG }, /* ID3v2.2 */
139 { "PNG", AV_CODEC_ID_PNG }, /* ID3v2.2 */
140 { "", AV_CODEC_ID_NONE },
143 int ff_id3v2_match(const uint8_t *buf, const char *magic)
145 return buf[0] == magic[0] &&
146 buf[1] == magic[1] &&
147 buf[2] == magic[2] &&
150 (buf[6] & 0x80) == 0 &&
151 (buf[7] & 0x80) == 0 &&
152 (buf[8] & 0x80) == 0 &&
153 (buf[9] & 0x80) == 0;
156 int ff_id3v2_tag_len(const uint8_t *buf)
158 int len = ((buf[6] & 0x7f) << 21) +
159 ((buf[7] & 0x7f) << 14) +
160 ((buf[8] & 0x7f) << 7) +
164 len += ID3v2_HEADER_SIZE;
168 static unsigned int get_size(AVIOContext *s, int len)
172 v = (v << 7) + (avio_r8(s) & 0x7F);
176 static unsigned int size_to_syncsafe(unsigned int size)
178 return (((size) & (0x7f << 0)) >> 0) +
179 (((size) & (0x7f << 8)) >> 1) +
180 (((size) & (0x7f << 16)) >> 2) +
181 (((size) & (0x7f << 24)) >> 3);
184 /* No real verification, only check that the tag consists of
185 * a combination of capital alpha-numerical characters */
186 static int is_tag(const char *buf, unsigned int len)
192 if ((buf[len] < 'A' ||
202 * Return 1 if the tag of length len at the given offset is valid, 0 if not, -1 on error
204 static int check_tag(AVIOContext *s, int offset, unsigned int len)
209 avio_seek(s, offset, SEEK_SET) < 0 ||
210 avio_read(s, tag, len) < (int)len)
212 else if (!AV_RB32(tag) || is_tag(tag, len))
219 * Free GEOB type extra metadata.
221 static void free_geobtag(void *obj)
223 ID3v2ExtraMetaGEOB *geob = obj;
224 av_freep(&geob->mime_type);
225 av_freep(&geob->file_name);
226 av_freep(&geob->description);
227 av_freep(&geob->data);
232 * Decode characters to UTF-8 according to encoding type. The decoded buffer is
233 * always null terminated. Stop reading when either *maxread bytes are read from
234 * pb or U+0000 character is found.
236 * @param dst Pointer where the address of the buffer with the decoded bytes is
237 * stored. Buffer must be freed by caller.
238 * @param maxread Pointer to maximum number of characters to read from the
239 * AVIOContext. After execution the value is decremented by the number of bytes
241 * @returns 0 if no error occurred, dst is uninitialized on error
243 static int decode_str(AVFormatContext *s, AVIOContext *pb, int encoding,
244 uint8_t **dst, int *maxread)
250 unsigned int (*get)(AVIOContext*) = avio_rb16;
253 if ((ret = avio_open_dyn_buf(&dynbuf)) < 0) {
254 av_log(s, AV_LOG_ERROR, "Error opening memory stream\n");
259 case ID3v2_ENCODING_ISO8859:
262 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
267 case ID3v2_ENCODING_UTF16BOM:
268 if ((left -= 2) < 0) {
269 av_log(s, AV_LOG_ERROR, "Cannot read BOM value, input too short\n");
270 ffio_free_dyn_buf(&dynbuf);
272 return AVERROR_INVALIDDATA;
274 switch (avio_rb16(pb)) {
280 av_log(s, AV_LOG_ERROR, "Incorrect BOM value\n");
281 ffio_free_dyn_buf(&dynbuf);
284 return AVERROR_INVALIDDATA;
288 case ID3v2_ENCODING_UTF16BE:
289 while ((left > 1) && ch) {
290 GET_UTF16(ch, ((left -= 2) >= 0 ? get(pb) : 0), break;)
291 PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
294 left += 2; /* did not read last char from pb */
297 case ID3v2_ENCODING_UTF8:
305 av_log(s, AV_LOG_WARNING, "Unknown encoding\n");
311 avio_close_dyn_buf(dynbuf, dst);
320 static void read_ttag(AVFormatContext *s, AVIOContext *pb, int taglen,
321 AVDictionary **metadata, const char *key)
324 int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
330 encoding = avio_r8(pb);
331 taglen--; /* account for encoding type byte */
333 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
334 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
338 if (!(strcmp(key, "TCON") && strcmp(key, "TCO")) &&
339 (sscanf(dst, "(%d)", &genre) == 1 || sscanf(dst, "%d", &genre) == 1) &&
340 genre <= ID3v1_GENRE_MAX) {
342 dst = av_strdup(ff_id3v1_genre_str[genre]);
343 } else if (!(strcmp(key, "TXXX") && strcmp(key, "TXX"))) {
344 /* dst now contains the key, need to get value */
346 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
347 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
351 dict_flags |= AV_DICT_DONT_STRDUP_KEY;
356 av_dict_set(metadata, key, dst, dict_flags);
359 static void read_uslt(AVFormatContext *s, AVIOContext *pb, int taglen,
360 AVDictionary **metadata)
363 uint8_t *descriptor = NULL; // 'Content descriptor'
372 encoding = avio_r8(pb);
375 if (avio_read(pb, lang, 3) < 3)
380 if (decode_str(s, pb, encoding, &descriptor, &taglen) < 0)
383 if (decode_str(s, pb, encoding, &text, &taglen) < 0)
386 // FFmpeg does not support hierarchical metadata, so concatenate the keys.
387 key = av_asprintf("lyrics-%s%s%s", descriptor[0] ? (char *)descriptor : "",
388 descriptor[0] ? "-" : "",
395 av_dict_set(metadata, key, text,
396 AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL);
401 av_log(s, AV_LOG_ERROR, "Error reading lyrics, skipped\n");
406 * Parse a comment tag.
408 static void read_comment(AVFormatContext *s, AVIOContext *pb, int taglen,
409 AVDictionary **metadata)
411 const char *key = "comment";
413 int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
414 av_unused int language;
419 encoding = avio_r8(pb);
420 language = avio_rl24(pb);
423 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
424 av_log(s, AV_LOG_ERROR, "Error reading comment frame, skipped\n");
432 key = (const char *) dst;
433 dict_flags |= AV_DICT_DONT_STRDUP_KEY;
436 if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
437 av_log(s, AV_LOG_ERROR, "Error reading comment frame, skipped\n");
438 if (dict_flags & AV_DICT_DONT_STRDUP_KEY)
439 av_freep((void*)&key);
444 av_dict_set(metadata, key, (const char *) dst, dict_flags);
448 * Parse GEOB tag into a ID3v2ExtraMetaGEOB struct.
450 static void read_geobtag(AVFormatContext *s, AVIOContext *pb, int taglen,
451 const char *tag, ID3v2ExtraMeta **extra_meta,
454 ID3v2ExtraMetaGEOB *geob_data = NULL;
455 ID3v2ExtraMeta *new_extra = NULL;
462 geob_data = av_mallocz(sizeof(ID3v2ExtraMetaGEOB));
464 av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
465 sizeof(ID3v2ExtraMetaGEOB));
469 new_extra = av_mallocz(sizeof(ID3v2ExtraMeta));
471 av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
472 sizeof(ID3v2ExtraMeta));
476 /* read encoding type byte */
477 encoding = avio_r8(pb);
480 /* read MIME type (always ISO-8859) */
481 if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &geob_data->mime_type,
487 if (decode_str(s, pb, encoding, &geob_data->file_name, &taglen) < 0 ||
491 /* read content description */
492 if (decode_str(s, pb, encoding, &geob_data->description, &taglen) < 0 ||
497 /* save encapsulated binary data */
498 geob_data->data = av_malloc(taglen);
499 if (!geob_data->data) {
500 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", taglen);
503 if ((len = avio_read(pb, geob_data->data, taglen)) < taglen)
504 av_log(s, AV_LOG_WARNING,
505 "Error reading GEOB frame, data truncated.\n");
506 geob_data->datasize = len;
508 geob_data->data = NULL;
509 geob_data->datasize = 0;
512 /* add data to the list */
513 new_extra->tag = "GEOB";
514 new_extra->data = geob_data;
515 new_extra->next = *extra_meta;
516 *extra_meta = new_extra;
521 av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", tag);
522 free_geobtag(geob_data);
527 static int is_number(const char *str)
529 while (*str >= '0' && *str <= '9')
534 static AVDictionaryEntry *get_date_tag(AVDictionary *m, const char *tag)
536 AVDictionaryEntry *t;
537 if ((t = av_dict_get(m, tag, NULL, AV_DICT_MATCH_CASE)) &&
538 strlen(t->value) == 4 && is_number(t->value))
543 static void merge_date(AVDictionary **m)
545 AVDictionaryEntry *t;
546 char date[17] = { 0 }; // YYYY-MM-DD hh:mm
548 if (!(t = get_date_tag(*m, "TYER")) &&
549 !(t = get_date_tag(*m, "TYE")))
551 av_strlcpy(date, t->value, 5);
552 av_dict_set(m, "TYER", NULL, 0);
553 av_dict_set(m, "TYE", NULL, 0);
555 if (!(t = get_date_tag(*m, "TDAT")) &&
556 !(t = get_date_tag(*m, "TDA")))
558 snprintf(date + 4, sizeof(date) - 4, "-%.2s-%.2s", t->value + 2, t->value);
559 av_dict_set(m, "TDAT", NULL, 0);
560 av_dict_set(m, "TDA", NULL, 0);
562 if (!(t = get_date_tag(*m, "TIME")) &&
563 !(t = get_date_tag(*m, "TIM")))
565 snprintf(date + 10, sizeof(date) - 10,
566 " %.2s:%.2s", t->value, t->value + 2);
567 av_dict_set(m, "TIME", NULL, 0);
568 av_dict_set(m, "TIM", NULL, 0);
572 av_dict_set(m, "date", date, 0);
575 static void free_apic(void *obj)
577 ID3v2ExtraMetaAPIC *apic = obj;
578 av_buffer_unref(&apic->buf);
579 av_freep(&apic->description);
583 static void rstrip_spaces(char *buf)
585 size_t len = strlen(buf);
586 while (len > 0 && buf[len - 1] == ' ')
590 static void read_apic(AVFormatContext *s, AVIOContext *pb, int taglen,
591 const char *tag, ID3v2ExtraMeta **extra_meta,
595 char mimetype[64] = {0};
596 const CodecMime *mime = ff_id3v2_mime_tags;
597 enum AVCodecID id = AV_CODEC_ID_NONE;
598 ID3v2ExtraMetaAPIC *apic = NULL;
599 ID3v2ExtraMeta *new_extra = NULL;
600 int64_t end = avio_tell(pb) + taglen;
602 if (taglen <= 4 || (!isv34 && taglen <= 6))
605 new_extra = av_mallocz(sizeof(*new_extra));
606 apic = av_mallocz(sizeof(*apic));
607 if (!new_extra || !apic)
615 taglen -= avio_get_str(pb, taglen, mimetype, sizeof(mimetype));
617 if (avio_read(pb, mimetype, 3) < 0)
624 while (mime->id != AV_CODEC_ID_NONE) {
625 if (!av_strncasecmp(mime->str, mimetype, sizeof(mimetype))) {
631 if (id == AV_CODEC_ID_NONE) {
632 av_log(s, AV_LOG_WARNING,
633 "Unknown attached picture mimetype: %s, skipping.\n", mimetype);
639 pic_type = avio_r8(pb);
641 if (pic_type < 0 || pic_type >= FF_ARRAY_ELEMS(ff_id3v2_picture_types)) {
642 av_log(s, AV_LOG_WARNING, "Unknown attached picture type %d.\n",
646 apic->type = ff_id3v2_picture_types[pic_type];
648 /* description and picture data */
649 if (decode_str(s, pb, enc, &apic->description, &taglen) < 0) {
650 av_log(s, AV_LOG_ERROR,
651 "Error decoding attached picture description.\n");
655 apic->buf = av_buffer_alloc(taglen + AV_INPUT_BUFFER_PADDING_SIZE);
656 if (!apic->buf || !taglen || avio_read(pb, apic->buf->data, taglen) != taglen)
658 memset(apic->buf->data + taglen, 0, AV_INPUT_BUFFER_PADDING_SIZE);
660 new_extra->tag = "APIC";
661 new_extra->data = apic;
662 new_extra->next = *extra_meta;
663 *extra_meta = new_extra;
665 // The description must be unique, and some ID3v2 tag writers add spaces
666 // to write several APIC entries with the same description.
667 rstrip_spaces(apic->description);
674 av_freep(&new_extra);
675 avio_seek(pb, end, SEEK_SET);
678 static void free_chapter(void *obj)
680 ID3v2ExtraMetaCHAP *chap = obj;
681 av_freep(&chap->element_id);
682 av_dict_free(&chap->meta);
686 static void read_chapter(AVFormatContext *s, AVIOContext *pb, int len, const char *ttag, ID3v2ExtraMeta **extra_meta, int isv34)
690 ID3v2ExtraMeta *new_extra = NULL;
691 ID3v2ExtraMetaCHAP *chap = NULL;
693 new_extra = av_mallocz(sizeof(*new_extra));
694 chap = av_mallocz(sizeof(*chap));
696 if (!new_extra || !chap)
699 if (decode_str(s, pb, 0, &chap->element_id, &len) < 0)
705 chap->start = avio_rb32(pb);
706 chap->end = avio_rb32(pb);
711 if (avio_read(pb, tag, 4) < 4)
714 taglen = avio_rb32(pb);
717 if (taglen < 0 || taglen > len)
720 read_ttag(s, pb, taglen, &chap->meta, tag);
722 avio_skip(pb, taglen);
726 ff_metadata_conv(&chap->meta, NULL, ff_id3v2_34_metadata_conv);
727 ff_metadata_conv(&chap->meta, NULL, ff_id3v2_4_metadata_conv);
729 new_extra->tag = "CHAP";
730 new_extra->data = chap;
731 new_extra->next = *extra_meta;
732 *extra_meta = new_extra;
739 av_freep(&new_extra);
742 static void free_priv(void *obj)
744 ID3v2ExtraMetaPRIV *priv = obj;
745 av_freep(&priv->owner);
746 av_freep(&priv->data);
750 static void read_priv(AVFormatContext *s, AVIOContext *pb, int taglen,
751 const char *tag, ID3v2ExtraMeta **extra_meta, int isv34)
753 ID3v2ExtraMeta *meta;
754 ID3v2ExtraMetaPRIV *priv;
756 meta = av_mallocz(sizeof(*meta));
757 priv = av_mallocz(sizeof(*priv));
762 if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &priv->owner, &taglen) < 0)
765 priv->data = av_malloc(taglen);
769 priv->datasize = taglen;
771 if (avio_read(pb, priv->data, priv->datasize) != priv->datasize)
776 meta->next = *extra_meta;
787 typedef struct ID3v2EMFunc {
790 void (*read)(AVFormatContext *s, AVIOContext *pb, int taglen,
791 const char *tag, ID3v2ExtraMeta **extra_meta,
793 void (*free)(void *obj);
796 static const ID3v2EMFunc id3v2_extra_meta_funcs[] = {
797 { "GEO", "GEOB", read_geobtag, free_geobtag },
798 { "PIC", "APIC", read_apic, free_apic },
799 { "CHAP","CHAP", read_chapter, free_chapter },
800 { "PRIV","PRIV", read_priv, free_priv },
805 * Get the corresponding ID3v2EMFunc struct for a tag.
806 * @param isv34 Determines if v2.2 or v2.3/4 strings are used
807 * @return A pointer to the ID3v2EMFunc struct if found, NULL otherwise.
809 static const ID3v2EMFunc *get_extra_meta_func(const char *tag, int isv34)
812 while (id3v2_extra_meta_funcs[i].tag3) {
813 if (tag && !memcmp(tag,
814 (isv34 ? id3v2_extra_meta_funcs[i].tag4 :
815 id3v2_extra_meta_funcs[i].tag3),
817 return &id3v2_extra_meta_funcs[i];
823 static void id3v2_parse(AVIOContext *pb, AVDictionary **metadata,
824 AVFormatContext *s, int len, uint8_t version,
825 uint8_t flags, ID3v2ExtraMeta **extra_meta)
830 int64_t next, end = avio_tell(pb) + len;
832 const char *reason = NULL;
833 AVIOContext pb_local;
835 unsigned char *buffer = NULL;
837 const ID3v2EMFunc *extra_func = NULL;
838 unsigned char *uncompressed_buffer = NULL;
839 av_unused int uncompressed_buffer_size = 0;
840 const char *comm_frame;
842 av_log(s, AV_LOG_DEBUG, "id3v2 ver:%d flags:%02X len:%d\n", version, flags, len);
847 reason = "compression";
867 unsync = flags & 0x80;
869 if (isv34 && flags & 0x40) { /* Extended header present, just skip over it */
870 int extlen = get_size(pb, 4);
872 /* In v2.4 the length includes the length field we just read. */
876 reason = "invalid extended header length";
879 avio_skip(pb, extlen);
882 reason = "extended header too long.";
887 while (len >= taghdrlen) {
888 unsigned int tflags = 0;
892 unsigned long av_unused dlen;
895 if (avio_read(pb, tag, 4) < 4)
899 tlen = avio_rb32(pb);
901 /* some encoders incorrectly uses v3 sizes instead of syncsafe ones
902 * so check the next tag to see which one to use */
903 tlen = avio_rb32(pb);
906 int64_t cur = avio_tell(pb);
908 if (ffio_ensure_seekback(pb, 2 /* tflags */ + tlen + 4 /* next tag */))
911 if (check_tag(pb, cur + 2 + size_to_syncsafe(tlen), 4) == 1)
912 tlen = size_to_syncsafe(tlen);
913 else if (check_tag(pb, cur + 2 + tlen, 4) != 1)
915 avio_seek(pb, cur, SEEK_SET);
917 tlen = size_to_syncsafe(tlen);
920 tflags = avio_rb16(pb);
921 tunsync = tflags & ID3v2_FLAG_UNSYNCH;
923 if (avio_read(pb, tag, 3) < 3)
926 tlen = avio_rb24(pb);
930 len -= taghdrlen + tlen;
935 next = avio_tell(pb) + tlen;
939 av_log(s, AV_LOG_DEBUG, "Invalid empty frame %s, skipping.\n",
944 if (tflags & ID3v2_FLAG_DATALEN) {
947 dlen = avio_rb32(pb);
952 tcomp = tflags & ID3v2_FLAG_COMPRESSION;
953 tencr = tflags & ID3v2_FLAG_ENCRYPTION;
955 /* skip encrypted tags and, if no zlib, compressed tags */
956 if (tencr || (!CONFIG_ZLIB && tcomp)) {
963 type = "encrypted and compressed";
965 av_log(s, AV_LOG_WARNING, "Skipping %s ID3v2 frame %s.\n", type, tag);
967 /* check for text tag or supported special meta tag */
968 } else if (tag[0] == 'T' ||
969 !memcmp(tag, "USLT", 4) ||
970 !strcmp(tag, comm_frame) ||
972 (extra_func = get_extra_meta_func(tag, isv34)))) {
975 if (unsync || tunsync || tcomp) {
976 av_fast_malloc(&buffer, &buffer_size, tlen);
978 av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", tlen);
982 if (unsync || tunsync) {
985 uint8_t *end = t + tlen;
987 if (avio_read(pb, buffer, tlen) != tlen) {
988 av_log(s, AV_LOG_ERROR, "Failed to read tag data\n");
994 if (t != end && t[-1] == 0xff && !t[0])
998 ffio_init_context(&pb_local, buffer, b - buffer, 0, NULL, NULL, NULL,
1001 pbx = &pb_local; // read from sync buffer
1008 av_log(s, AV_LOG_DEBUG, "Compresssed frame %s tlen=%d dlen=%ld\n", tag, tlen, dlen);
1010 av_fast_malloc(&uncompressed_buffer, &uncompressed_buffer_size, dlen);
1011 if (!uncompressed_buffer) {
1012 av_log(s, AV_LOG_ERROR, "Failed to alloc %ld bytes\n", dlen);
1016 if (!(unsync || tunsync)) {
1017 err = avio_read(pb, buffer, tlen);
1019 av_log(s, AV_LOG_ERROR, "Failed to read compressed tag\n");
1025 err = uncompress(uncompressed_buffer, &dlen, buffer, tlen);
1027 av_log(s, AV_LOG_ERROR, "Failed to uncompress tag: %d\n", err);
1030 ffio_init_context(&pb_local, uncompressed_buffer, dlen, 0, NULL, NULL, NULL, NULL);
1032 pbx = &pb_local; // read from sync buffer
1036 /* parse text tag */
1037 read_ttag(s, pbx, tlen, metadata, tag);
1038 else if (!memcmp(tag, "USLT", 4))
1039 read_uslt(s, pbx, tlen, metadata);
1040 else if (!strcmp(tag, comm_frame))
1041 read_comment(s, pbx, tlen, metadata);
1043 /* parse special meta tag */
1044 extra_func->read(s, pbx, tlen, tag, extra_meta, isv34);
1045 } else if (!tag[0]) {
1047 av_log(s, AV_LOG_WARNING, "invalid frame id, assuming padding\n");
1048 avio_skip(pb, tlen);
1051 /* Skip to end of tag */
1053 avio_seek(pb, next, SEEK_SET);
1056 /* Footer preset, always 10 bytes, skip over it */
1057 if (version == 4 && flags & 0x10)
1062 av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n",
1064 avio_seek(pb, end, SEEK_SET);
1066 av_free(uncompressed_buffer);
1070 static void id3v2_read_internal(AVIOContext *pb, AVDictionary **metadata,
1071 AVFormatContext *s, const char *magic,
1072 ID3v2ExtraMeta **extra_meta, int64_t max_search_size)
1075 uint8_t buf[ID3v2_HEADER_SIZE];
1079 if (max_search_size && max_search_size < ID3v2_HEADER_SIZE)
1082 start = avio_tell(pb);
1084 /* save the current offset in case there's nothing to read/skip */
1085 off = avio_tell(pb);
1086 if (max_search_size && off - start >= max_search_size - ID3v2_HEADER_SIZE) {
1087 avio_seek(pb, off, SEEK_SET);
1091 ret = ffio_ensure_seekback(pb, ID3v2_HEADER_SIZE);
1093 ret = avio_read(pb, buf, ID3v2_HEADER_SIZE);
1094 if (ret != ID3v2_HEADER_SIZE) {
1095 avio_seek(pb, off, SEEK_SET);
1098 found_header = ff_id3v2_match(buf, magic);
1100 /* parse ID3v2 header */
1101 len = ((buf[6] & 0x7f) << 21) |
1102 ((buf[7] & 0x7f) << 14) |
1103 ((buf[8] & 0x7f) << 7) |
1105 id3v2_parse(pb, metadata, s, len, buf[3], buf[5], extra_meta);
1107 avio_seek(pb, off, SEEK_SET);
1109 } while (found_header);
1110 ff_metadata_conv(metadata, NULL, ff_id3v2_34_metadata_conv);
1111 ff_metadata_conv(metadata, NULL, id3v2_2_metadata_conv);
1112 ff_metadata_conv(metadata, NULL, ff_id3v2_4_metadata_conv);
1113 merge_date(metadata);
1116 void ff_id3v2_read_dict(AVIOContext *pb, AVDictionary **metadata,
1117 const char *magic, ID3v2ExtraMeta **extra_meta)
1119 id3v2_read_internal(pb, metadata, NULL, magic, extra_meta, 0);
1122 void ff_id3v2_read(AVFormatContext *s, const char *magic,
1123 ID3v2ExtraMeta **extra_meta, unsigned int max_search_size)
1125 id3v2_read_internal(s->pb, &s->metadata, s, magic, extra_meta, max_search_size);
1128 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
1130 ID3v2ExtraMeta *current = *extra_meta, *next;
1131 const ID3v2EMFunc *extra_func;
1134 if ((extra_func = get_extra_meta_func(current->tag, 1)))
1135 extra_func->free(current->data);
1136 next = current->next;
1144 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1146 ID3v2ExtraMeta *cur;
1148 for (cur = *extra_meta; cur; cur = cur->next) {
1149 ID3v2ExtraMetaAPIC *apic;
1152 if (strcmp(cur->tag, "APIC"))
1156 if (!(st = avformat_new_stream(s, NULL)))
1157 return AVERROR(ENOMEM);
1159 st->disposition |= AV_DISPOSITION_ATTACHED_PIC;
1160 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
1161 st->codecpar->codec_id = apic->id;
1163 if (AV_RB64(apic->buf->data) == PNGSIG)
1164 st->codecpar->codec_id = AV_CODEC_ID_PNG;
1166 if (apic->description[0])
1167 av_dict_set(&st->metadata, "title", apic->description, 0);
1169 av_dict_set(&st->metadata, "comment", apic->type, 0);
1171 av_init_packet(&st->attached_pic);
1172 st->attached_pic.buf = apic->buf;
1173 st->attached_pic.data = apic->buf->data;
1174 st->attached_pic.size = apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE;
1175 st->attached_pic.stream_index = st->index;
1176 st->attached_pic.flags |= AV_PKT_FLAG_KEY;
1184 int ff_id3v2_parse_chapters(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1187 ID3v2ExtraMeta *cur;
1188 AVRational time_base = {1, 1000};
1189 ID3v2ExtraMetaCHAP **chapters = NULL;
1190 int num_chapters = 0;
1193 // since extra_meta is a linked list where elements are prepended,
1194 // we need to reverse the order of chapters
1195 for (cur = *extra_meta; cur; cur = cur->next) {
1196 ID3v2ExtraMetaCHAP *chap;
1198 if (strcmp(cur->tag, "CHAP"))
1202 if ((ret = av_dynarray_add_nofree(&chapters, &num_chapters, chap)) < 0)
1206 for (i = 0; i < (num_chapters / 2); i++) {
1207 ID3v2ExtraMetaCHAP *right;
1210 right_index = (num_chapters - 1) - i;
1211 right = chapters[right_index];
1213 chapters[right_index] = chapters[i];
1214 chapters[i] = right;
1217 for (i = 0; i < num_chapters; i++) {
1218 ID3v2ExtraMetaCHAP *chap;
1222 chapter = avpriv_new_chapter(s, i, time_base, chap->start, chap->end, chap->element_id);
1226 if ((ret = av_dict_copy(&chapter->metadata, chap->meta, 0)) < 0)
1231 av_freep(&chapters);
1235 int ff_id3v2_parse_priv_dict(AVDictionary **metadata, ID3v2ExtraMeta **extra_meta)
1237 ID3v2ExtraMeta *cur;
1238 int dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL;
1240 for (cur = *extra_meta; cur; cur = cur->next) {
1241 if (!strcmp(cur->tag, "PRIV")) {
1242 ID3v2ExtraMetaPRIV *priv = cur->data;
1244 char *escaped, *key;
1247 if ((key = av_asprintf(ID3v2_PRIV_METADATA_PREFIX "%s", priv->owner)) == NULL) {
1248 return AVERROR(ENOMEM);
1251 av_bprint_init(&bprint, priv->datasize + 1, AV_BPRINT_SIZE_UNLIMITED);
1253 for (i = 0; i < priv->datasize; i++) {
1254 if (priv->data[i] < 32 || priv->data[i] > 126 || priv->data[i] == '\\') {
1255 av_bprintf(&bprint, "\\x%02x", priv->data[i]);
1257 av_bprint_chars(&bprint, priv->data[i], 1);
1261 if ((ret = av_bprint_finalize(&bprint, &escaped)) < 0) {
1266 if ((ret = av_dict_set(metadata, key, escaped, dict_flags)) < 0) {
1277 int ff_id3v2_parse_priv(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1279 return ff_id3v2_parse_priv_dict(&s->metadata, extra_meta);