git.sesse.net Git - ffmpeg/blob - libavformat/id3v2.c

   1 /*
   2  * Copyright (c) 2003 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 /**
  22  * @file
  23  * ID3v2 header parser
  24  *
  25  * Specifications available at:
  26  * http://id3.org/Developer_Information
  27  */
  28
  29 #include "config.h"
  30
  31 #if CONFIG_ZLIB
  32 #include <zlib.h>
  33 #endif
  34
  35 #include "libavutil/avstring.h"
  36 #include "libavutil/bprint.h"
  37 #include "libavutil/dict.h"
  38 #include "libavutil/intreadwrite.h"
  39 #include "avio_internal.h"
  40 #include "internal.h"
  41 #include "id3v1.h"
  42 #include "id3v2.h"
  43
  44 const AVMetadataConv ff_id3v2_34_metadata_conv[] = {
  45     { "TALB", "album"        },
  46     { "TCOM", "composer"     },
  47     { "TCON", "genre"        },
  48     { "TCOP", "copyright"    },
  49     { "TENC", "encoded_by"   },
  50     { "TIT2", "title"        },
  51     { "TLAN", "language"     },
  52     { "TPE1", "artist"       },
  53     { "TPE2", "album_artist" },
  54     { "TPE3", "performer"    },
  55     { "TPOS", "disc"         },
  56     { "TPUB", "publisher"    },
  57     { "TRCK", "track"        },
  58     { "TSSE", "encoder"      },
  59     { "USLT", "lyrics"       },
  60     { 0 }
  61 };
  62
  63 const AVMetadataConv ff_id3v2_4_metadata_conv[] = {
  64     { "TCMP", "compilation"   },
  65     { "TDRC", "date"          },
  66     { "TDRL", "date"          },
  67     { "TDEN", "creation_time" },
  68     { "TSOA", "album-sort"    },
  69     { "TSOP", "artist-sort"   },
  70     { "TSOT", "title-sort"    },
  71     { 0 }
  72 };
  73
  74 static const AVMetadataConv id3v2_2_metadata_conv[] = {
  75     { "TAL", "album"        },
  76     { "TCO", "genre"        },
  77     { "TCP", "compilation"  },
  78     { "TT2", "title"        },
  79     { "TEN", "encoded_by"   },
  80     { "TP1", "artist"       },
  81     { "TP2", "album_artist" },
  82     { "TP3", "performer"    },
  83     { "TRK", "track"        },
  84     { 0 }
  85 };
  86
  87 const char ff_id3v2_tags[][4] = {
  88     "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDLY", "TENC", "TEXT",
  89     "TFLT", "TIT1", "TIT2", "TIT3", "TKEY", "TLAN", "TLEN", "TMED",
  90     "TOAL", "TOFN", "TOLY", "TOPE", "TOWN", "TPE1", "TPE2", "TPE3",
  91     "TPE4", "TPOS", "TPUB", "TRCK", "TRSN", "TRSO", "TSRC", "TSSE",
  92     { 0 },
  93 };
  94
  95 const char ff_id3v2_4_tags[][4] = {
  96     "TDEN", "TDOR", "TDRC", "TDRL", "TDTG", "TIPL", "TMCL", "TMOO",
  97     "TPRO", "TSOA", "TSOP", "TSOT", "TSST",
  98     { 0 },
  99 };
 100
 101 const char ff_id3v2_3_tags[][4] = {
 102     "TDAT", "TIME", "TORY", "TRDA", "TSIZ", "TYER",
 103     { 0 },
 104 };
 105
 106 const char * const ff_id3v2_picture_types[21] = {
 107     "Other",
 108     "32x32 pixels 'file icon'",
 109     "Other file icon",
 110     "Cover (front)",
 111     "Cover (back)",
 112     "Leaflet page",
 113     "Media (e.g. label side of CD)",
 114     "Lead artist/lead performer/soloist",
 115     "Artist/performer",
 116     "Conductor",
 117     "Band/Orchestra",
 118     "Composer",
 119     "Lyricist/text writer",
 120     "Recording Location",
 121     "During recording",
 122     "During performance",
 123     "Movie/video screen capture",
 124     "A bright coloured fish",
 125     "Illustration",
 126     "Band/artist logotype",
 127     "Publisher/Studio logotype",
 128 };
 129
 130 const CodecMime ff_id3v2_mime_tags[] = {
 131     { "image/gif",  AV_CODEC_ID_GIF   },
 132     { "image/jpeg", AV_CODEC_ID_MJPEG },
 133     { "image/jpg",  AV_CODEC_ID_MJPEG },
 134     { "image/png",  AV_CODEC_ID_PNG   },
 135     { "image/tiff", AV_CODEC_ID_TIFF  },
 136     { "image/bmp",  AV_CODEC_ID_BMP   },
 137     { "JPG",        AV_CODEC_ID_MJPEG }, /* ID3v2.2  */
 138     { "PNG",        AV_CODEC_ID_PNG   }, /* ID3v2.2  */
 139     { "",           AV_CODEC_ID_NONE  },
 140 };
 141
 142 int ff_id3v2_match(const uint8_t *buf, const char *magic)
 143 {
 144     return  buf[0]         == magic[0] &&
 145             buf[1]         == magic[1] &&
 146             buf[2]         == magic[2] &&
 147             buf[3]         != 0xff     &&
 148             buf[4]         != 0xff     &&
 149            (buf[6] & 0x80) == 0        &&
 150            (buf[7] & 0x80) == 0        &&
 151            (buf[8] & 0x80) == 0        &&
 152            (buf[9] & 0x80) == 0;
 153 }
 154
 155 int ff_id3v2_tag_len(const uint8_t *buf)
 156 {
 157     int len = ((buf[6] & 0x7f) << 21) +
 158               ((buf[7] & 0x7f) << 14) +
 159               ((buf[8] & 0x7f) << 7) +
 160               (buf[9] & 0x7f) +
 161               ID3v2_HEADER_SIZE;
 162     if (buf[5] & 0x10)
 163         len += ID3v2_HEADER_SIZE;
 164     return len;
 165 }
 166
 167 static unsigned int get_size(AVIOContext *s, int len)
 168 {
 169     int v = 0;
 170     while (len--)
 171         v = (v << 7) + (avio_r8(s) & 0x7F);
 172     return v;
 173 }
 174
 175 static unsigned int size_to_syncsafe(unsigned int size)
 176 {
 177     return (((size) & (0x7f <<  0)) >> 0) +
 178            (((size) & (0x7f <<  8)) >> 1) +
 179            (((size) & (0x7f << 16)) >> 2) +
 180            (((size) & (0x7f << 24)) >> 3);
 181 }
 182
 183 /* No real verification, only check that the tag consists of
 184  * a combination of capital alpha-numerical characters */
 185 static int is_tag(const char *buf, unsigned int len)
 186 {
 187     if (!len)
 188         return 0;
 189
 190     while (len--)
 191         if ((buf[len] < 'A' ||
 192              buf[len] > 'Z') &&
 193             (buf[len] < '0' ||
 194              buf[len] > '9'))
 195             return 0;
 196
 197     return 1;
 198 }
 199
 200 /**
 201  * Return 1 if the tag of length len at the given offset is valid, 0 if not, -1 on error
 202  */
 203 static int check_tag(AVIOContext *s, int offset, unsigned int len)
 204 {
 205     char tag[4];
 206
 207     if (len > 4 ||
 208         avio_seek(s, offset, SEEK_SET) < 0 ||
 209         avio_read(s, tag, len) < (int)len)
 210         return -1;
 211     else if (!AV_RB32(tag) || is_tag(tag, len))
 212         return 1;
 213
 214     return 0;
 215 }
 216
 217 /**
 218  * Free GEOB type extra metadata.
 219  */
 220 static void free_geobtag(void *obj)
 221 {
 222     ID3v2ExtraMetaGEOB *geob = obj;
 223     av_freep(&geob->mime_type);
 224     av_freep(&geob->file_name);
 225     av_freep(&geob->description);
 226     av_freep(&geob->data);
 227     av_free(geob);
 228 }
 229
 230 /**
 231  * Decode characters to UTF-8 according to encoding type. The decoded buffer is
 232  * always null terminated. Stop reading when either *maxread bytes are read from
 233  * pb or U+0000 character is found.
 234  *
 235  * @param dst Pointer where the address of the buffer with the decoded bytes is
 236  * stored. Buffer must be freed by caller.
 237  * @param maxread Pointer to maximum number of characters to read from the
 238  * AVIOContext. After execution the value is decremented by the number of bytes
 239  * actually read.
 240  * @returns 0 if no error occurred, dst is uninitialized on error
 241  */
 242 static int decode_str(AVFormatContext *s, AVIOContext *pb, int encoding,
 243                       uint8_t **dst, int *maxread)
 244 {
 245     int ret;
 246     uint8_t tmp;
 247     uint32_t ch = 1;
 248     int left = *maxread;
 249     unsigned int (*get)(AVIOContext*) = avio_rb16;
 250     AVIOContext *dynbuf;
 251
 252     if ((ret = avio_open_dyn_buf(&dynbuf)) < 0) {
 253         av_log(s, AV_LOG_ERROR, "Error opening memory stream\n");
 254         return ret;
 255     }
 256
 257     switch (encoding) {
 258     case ID3v2_ENCODING_ISO8859:
 259         while (left && ch) {
 260             ch = avio_r8(pb);
 261             PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
 262             left--;
 263         }
 264         break;
 265
 266     case ID3v2_ENCODING_UTF16BOM:
 267         if ((left -= 2) < 0) {
 268             av_log(s, AV_LOG_ERROR, "Cannot read BOM value, input too short\n");
 269             ffio_free_dyn_buf(&dynbuf);
 270             *dst = NULL;
 271             return AVERROR_INVALIDDATA;
 272         }
 273         switch (avio_rb16(pb)) {
 274         case 0xfffe:
 275             get = avio_rl16;
 276         case 0xfeff:
 277             break;
 278         default:
 279             av_log(s, AV_LOG_ERROR, "Incorrect BOM value\n");
 280             ffio_free_dyn_buf(&dynbuf);
 281             *dst = NULL;
 282             *maxread = left;
 283             return AVERROR_INVALIDDATA;
 284         }
 285         // fall-through
 286
 287     case ID3v2_ENCODING_UTF16BE:
 288         while ((left > 1) && ch) {
 289             GET_UTF16(ch, ((left -= 2) >= 0 ? get(pb) : 0), break;)
 290             PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
 291         }
 292         if (left < 0)
 293             left += 2;  /* did not read last char from pb */
 294         break;
 295
 296     case ID3v2_ENCODING_UTF8:
 297         while (left && ch) {
 298             ch = avio_r8(pb);
 299             avio_w8(dynbuf, ch);
 300             left--;
 301         }
 302         break;
 303     default:
 304         av_log(s, AV_LOG_WARNING, "Unknown encoding\n");
 305     }
 306
 307     if (ch)
 308         avio_w8(dynbuf, 0);
 309
 310     avio_close_dyn_buf(dynbuf, dst);
 311     *maxread = left;
 312
 313     return 0;
 314 }
 315
 316 /**
 317  * Parse a text tag.
 318  */
 319 static void read_ttag(AVFormatContext *s, AVIOContext *pb, int taglen,
 320                       AVDictionary **metadata, const char *key)
 321 {
 322     uint8_t *dst;
 323     int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
 324     unsigned genre;
 325
 326     if (taglen < 1)
 327         return;
 328
 329     encoding = avio_r8(pb);
 330     taglen--; /* account for encoding type byte */
 331
 332     if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
 333         av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
 334         return;
 335     }
 336
 337     if (!(strcmp(key, "TCON") && strcmp(key, "TCO"))                         &&
 338         (sscanf(dst, "(%d)", &genre) == 1 || sscanf(dst, "%d", &genre) == 1) &&
 339         genre <= ID3v1_GENRE_MAX) {
 340         av_freep(&dst);
 341         dst = av_strdup(ff_id3v1_genre_str[genre]);
 342     } else if (!(strcmp(key, "TXXX") && strcmp(key, "TXX"))) {
 343         /* dst now contains the key, need to get value */
 344         key = dst;
 345         if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
 346             av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
 347             av_freep(&key);
 348             return;
 349         }
 350         dict_flags |= AV_DICT_DONT_STRDUP_KEY;
 351     } else if (!*dst)
 352         av_freep(&dst);
 353
 354     if (dst)
 355         av_dict_set(metadata, key, dst, dict_flags);
 356 }
 357
 358 static void read_uslt(AVFormatContext *s, AVIOContext *pb, int taglen,
 359                       AVDictionary **metadata)
 360 {
 361     uint8_t lang[4];
 362     uint8_t *descriptor = NULL; // 'Content descriptor'
 363     uint8_t *text = NULL;
 364     char *key = NULL;
 365     int encoding;
 366     int ok = 0;
 367
 368     if (taglen < 1)
 369         goto error;
 370
 371     encoding = avio_r8(pb);
 372     taglen--;
 373
 374     if (avio_read(pb, lang, 3) < 3)
 375         goto error;
 376     lang[3] = '\0';
 377     taglen -= 3;
 378
 379     if (decode_str(s, pb, encoding, &descriptor, &taglen) < 0)
 380         goto error;
 381
 382     if (decode_str(s, pb, encoding, &text, &taglen) < 0)
 383         goto error;
 384
 385     // FFmpeg does not support hierarchical metadata, so concatenate the keys.
 386     key = av_asprintf("lyrics-%s%s%s", descriptor[0] ? (char *)descriptor : "",
 387                                        descriptor[0] ? "-" : "",
 388                                        lang);
 389     if (!key)
 390         goto error;
 391
 392     av_dict_set(metadata, key, text, 0);
 393
 394     ok = 1;
 395 error:
 396     if (!ok)
 397         av_log(s, AV_LOG_ERROR, "Error reading lyrics, skipped\n");
 398     av_free(descriptor);
 399     av_free(text);
 400     av_free(key);
 401 }
 402
 403 /**
 404  * Parse a comment tag.
 405  */
 406 static void read_comment(AVFormatContext *s, AVIOContext *pb, int taglen,
 407                       AVDictionary **metadata)
 408 {
 409     const char *key = "comment";
 410     uint8_t *dst;
 411     int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
 412     av_unused int language;
 413
 414     if (taglen < 4)
 415         return;
 416
 417     encoding = avio_r8(pb);
 418     language = avio_rl24(pb);
 419     taglen -= 4;
 420
 421     if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
 422         av_log(s, AV_LOG_ERROR, "Error reading comment frame, skipped\n");
 423         return;
 424     }
 425
 426     if (dst && !*dst)
 427         av_freep(&dst);
 428
 429     if (dst) {
 430         key = (const char *) dst;
 431         dict_flags |= AV_DICT_DONT_STRDUP_KEY;
 432     }
 433
 434     if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
 435         av_log(s, AV_LOG_ERROR, "Error reading comment frame, skipped\n");
 436         if (dict_flags & AV_DICT_DONT_STRDUP_KEY)
 437             av_freep((void*)&key);
 438         return;
 439     }
 440
 441     if (dst)
 442         av_dict_set(metadata, key, (const char *) dst, dict_flags);
 443 }
 444
 445 /**
 446  * Parse GEOB tag into a ID3v2ExtraMetaGEOB struct.
 447  */
 448 static void read_geobtag(AVFormatContext *s, AVIOContext *pb, int taglen,
 449                          const char *tag, ID3v2ExtraMeta **extra_meta,
 450                          int isv34)
 451 {
 452     ID3v2ExtraMetaGEOB *geob_data = NULL;
 453     ID3v2ExtraMeta *new_extra     = NULL;
 454     char encoding;
 455     unsigned int len;
 456
 457     if (taglen < 1)
 458         return;
 459
 460     geob_data = av_mallocz(sizeof(ID3v2ExtraMetaGEOB));
 461     if (!geob_data) {
 462         av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
 463                sizeof(ID3v2ExtraMetaGEOB));
 464         return;
 465     }
 466
 467     new_extra = av_mallocz(sizeof(ID3v2ExtraMeta));
 468     if (!new_extra) {
 469         av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
 470                sizeof(ID3v2ExtraMeta));
 471         goto fail;
 472     }
 473
 474     /* read encoding type byte */
 475     encoding = avio_r8(pb);
 476     taglen--;
 477
 478     /* read MIME type (always ISO-8859) */
 479     if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &geob_data->mime_type,
 480                    &taglen) < 0 ||
 481         taglen <= 0)
 482         goto fail;
 483
 484     /* read file name */
 485     if (decode_str(s, pb, encoding, &geob_data->file_name, &taglen) < 0 ||
 486         taglen <= 0)
 487         goto fail;
 488
 489     /* read content description */
 490     if (decode_str(s, pb, encoding, &geob_data->description, &taglen) < 0 ||
 491         taglen < 0)
 492         goto fail;
 493
 494     if (taglen) {
 495         /* save encapsulated binary data */
 496         geob_data->data = av_malloc(taglen);
 497         if (!geob_data->data) {
 498             av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", taglen);
 499             goto fail;
 500         }
 501         if ((len = avio_read(pb, geob_data->data, taglen)) < taglen)
 502             av_log(s, AV_LOG_WARNING,
 503                    "Error reading GEOB frame, data truncated.\n");
 504         geob_data->datasize = len;
 505     } else {
 506         geob_data->data     = NULL;
 507         geob_data->datasize = 0;
 508     }
 509
 510     /* add data to the list */
 511     new_extra->tag  = "GEOB";
 512     new_extra->data = geob_data;
 513     new_extra->next = *extra_meta;
 514     *extra_meta     = new_extra;
 515
 516     return;
 517
 518 fail:
 519     av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", tag);
 520     free_geobtag(geob_data);
 521     av_free(new_extra);
 522     return;
 523 }
 524
 525 static int is_number(const char *str)
 526 {
 527     while (*str >= '0' && *str <= '9')
 528         str++;
 529     return !*str;
 530 }
 531
 532 static AVDictionaryEntry *get_date_tag(AVDictionary *m, const char *tag)
 533 {
 534     AVDictionaryEntry *t;
 535     if ((t = av_dict_get(m, tag, NULL, AV_DICT_MATCH_CASE)) &&
 536         strlen(t->value) == 4 && is_number(t->value))
 537         return t;
 538     return NULL;
 539 }
 540
 541 static void merge_date(AVDictionary **m)
 542 {
 543     AVDictionaryEntry *t;
 544     char date[17] = { 0 };      // YYYY-MM-DD hh:mm
 545
 546     if (!(t = get_date_tag(*m, "TYER")) &&
 547         !(t = get_date_tag(*m, "TYE")))
 548         return;
 549     av_strlcpy(date, t->value, 5);
 550     av_dict_set(m, "TYER", NULL, 0);
 551     av_dict_set(m, "TYE", NULL, 0);
 552
 553     if (!(t = get_date_tag(*m, "TDAT")) &&
 554         !(t = get_date_tag(*m, "TDA")))
 555         goto finish;
 556     snprintf(date + 4, sizeof(date) - 4, "-%.2s-%.2s", t->value + 2, t->value);
 557     av_dict_set(m, "TDAT", NULL, 0);
 558     av_dict_set(m, "TDA", NULL, 0);
 559
 560     if (!(t = get_date_tag(*m, "TIME")) &&
 561         !(t = get_date_tag(*m, "TIM")))
 562         goto finish;
 563     snprintf(date + 10, sizeof(date) - 10,
 564              " %.2s:%.2s", t->value, t->value + 2);
 565     av_dict_set(m, "TIME", NULL, 0);
 566     av_dict_set(m, "TIM", NULL, 0);
 567
 568 finish:
 569     if (date[0])
 570         av_dict_set(m, "date", date, 0);
 571 }
 572
 573 static void free_apic(void *obj)
 574 {
 575     ID3v2ExtraMetaAPIC *apic = obj;
 576     av_buffer_unref(&apic->buf);
 577     av_freep(&apic->description);
 578     av_freep(&apic);
 579 }
 580
 581 static void rstrip_spaces(char *buf)
 582 {
 583     size_t len = strlen(buf);
 584     while (len > 0 && buf[len - 1] == ' ')
 585         buf[--len] = 0;
 586 }
 587
 588 static void read_apic(AVFormatContext *s, AVIOContext *pb, int taglen,
 589                       const char *tag, ID3v2ExtraMeta **extra_meta,
 590                       int isv34)
 591 {
 592     int enc, pic_type;
 593     char mimetype[64];
 594     const CodecMime *mime     = ff_id3v2_mime_tags;
 595     enum AVCodecID id         = AV_CODEC_ID_NONE;
 596     ID3v2ExtraMetaAPIC *apic  = NULL;
 597     ID3v2ExtraMeta *new_extra = NULL;
 598     int64_t end               = avio_tell(pb) + taglen;
 599
 600     if (taglen <= 4 || (!isv34 && taglen <= 6))
 601         goto fail;
 602
 603     new_extra = av_mallocz(sizeof(*new_extra));
 604     apic      = av_mallocz(sizeof(*apic));
 605     if (!new_extra || !apic)
 606         goto fail;
 607
 608     enc = avio_r8(pb);
 609     taglen--;
 610
 611     /* mimetype */
 612     if (isv34) {
 613         taglen -= avio_get_str(pb, taglen, mimetype, sizeof(mimetype));
 614     } else {
 615         avio_read(pb, mimetype, 3);
 616         mimetype[3] = 0;
 617         taglen    -= 3;
 618     }
 619
 620     while (mime->id != AV_CODEC_ID_NONE) {
 621         if (!av_strncasecmp(mime->str, mimetype, sizeof(mimetype))) {
 622             id = mime->id;
 623             break;
 624         }
 625         mime++;
 626     }
 627     if (id == AV_CODEC_ID_NONE) {
 628         av_log(s, AV_LOG_WARNING,
 629                "Unknown attached picture mimetype: %s, skipping.\n", mimetype);
 630         goto fail;
 631     }
 632     apic->id = id;
 633
 634     /* picture type */
 635     pic_type = avio_r8(pb);
 636     taglen--;
 637     if (pic_type < 0 || pic_type >= FF_ARRAY_ELEMS(ff_id3v2_picture_types)) {
 638         av_log(s, AV_LOG_WARNING, "Unknown attached picture type %d.\n",
 639                pic_type);
 640         pic_type = 0;
 641     }
 642     apic->type = ff_id3v2_picture_types[pic_type];
 643
 644     /* description and picture data */
 645     if (decode_str(s, pb, enc, &apic->description, &taglen) < 0) {
 646         av_log(s, AV_LOG_ERROR,
 647                "Error decoding attached picture description.\n");
 648         goto fail;
 649     }
 650
 651     apic->buf = av_buffer_alloc(taglen + AV_INPUT_BUFFER_PADDING_SIZE);
 652     if (!apic->buf || !taglen || avio_read(pb, apic->buf->data, taglen) != taglen)
 653         goto fail;
 654     memset(apic->buf->data + taglen, 0, AV_INPUT_BUFFER_PADDING_SIZE);
 655
 656     new_extra->tag  = "APIC";
 657     new_extra->data = apic;
 658     new_extra->next = *extra_meta;
 659     *extra_meta     = new_extra;
 660
 661     // The description must be unique, and some ID3v2 tag writers add spaces
 662     // to write several APIC entries with the same description.
 663     rstrip_spaces(apic->description);
 664
 665     return;
 666
 667 fail:
 668     if (apic)
 669         free_apic(apic);
 670     av_freep(&new_extra);
 671     avio_seek(pb, end, SEEK_SET);
 672 }
 673
 674 static void free_chapter(void *obj)
 675 {
 676     ID3v2ExtraMetaCHAP *chap = obj;
 677     av_freep(&chap->element_id);
 678     av_dict_free(&chap->meta);
 679     av_freep(&chap);
 680 }
 681
 682 static void read_chapter(AVFormatContext *s, AVIOContext *pb, int len, const char *ttag, ID3v2ExtraMeta **extra_meta, int isv34)
 683 {
 684     int taglen;
 685     char tag[5];
 686     ID3v2ExtraMeta *new_extra = NULL;
 687     ID3v2ExtraMetaCHAP *chap  = NULL;
 688
 689     new_extra = av_mallocz(sizeof(*new_extra));
 690     chap      = av_mallocz(sizeof(*chap));
 691
 692     if (!new_extra || !chap)
 693         goto fail;
 694
 695     if (decode_str(s, pb, 0, &chap->element_id, &len) < 0)
 696         goto fail;
 697
 698     if (len < 16)
 699         goto fail;
 700
 701     chap->start = avio_rb32(pb);
 702     chap->end   = avio_rb32(pb);
 703     avio_skip(pb, 8);
 704
 705     len -= 16;
 706     while (len > 10) {
 707         if (avio_read(pb, tag, 4) < 4)
 708             goto fail;
 709         tag[4] = 0;
 710         taglen = avio_rb32(pb);
 711         avio_skip(pb, 2);
 712         len -= 10;
 713         if (taglen < 0 || taglen > len)
 714             goto fail;
 715         if (tag[0] == 'T')
 716             read_ttag(s, pb, taglen, &chap->meta, tag);
 717         else
 718             avio_skip(pb, taglen);
 719         len -= taglen;
 720     }
 721
 722     ff_metadata_conv(&chap->meta, NULL, ff_id3v2_34_metadata_conv);
 723     ff_metadata_conv(&chap->meta, NULL, ff_id3v2_4_metadata_conv);
 724
 725     new_extra->tag  = "CHAP";
 726     new_extra->data = chap;
 727     new_extra->next = *extra_meta;
 728     *extra_meta     = new_extra;
 729
 730     return;
 731
 732 fail:
 733     if (chap)
 734         free_chapter(chap);
 735     av_freep(&new_extra);
 736 }
 737
 738 static void free_priv(void *obj)
 739 {
 740     ID3v2ExtraMetaPRIV *priv = obj;
 741     av_freep(&priv->owner);
 742     av_freep(&priv->data);
 743     av_freep(&priv);
 744 }
 745
 746 static void read_priv(AVFormatContext *s, AVIOContext *pb, int taglen,
 747                       const char *tag, ID3v2ExtraMeta **extra_meta, int isv34)
 748 {
 749     ID3v2ExtraMeta *meta;
 750     ID3v2ExtraMetaPRIV *priv;
 751
 752     meta = av_mallocz(sizeof(*meta));
 753     priv = av_mallocz(sizeof(*priv));
 754
 755     if (!meta || !priv)
 756         goto fail;
 757
 758     if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &priv->owner, &taglen) < 0)
 759         goto fail;
 760
 761     priv->data = av_malloc(taglen);
 762     if (!priv->data)
 763         goto fail;
 764
 765     priv->datasize = taglen;
 766
 767     if (avio_read(pb, priv->data, priv->datasize) != priv->datasize)
 768         goto fail;
 769
 770     meta->tag   = "PRIV";
 771     meta->data  = priv;
 772     meta->next  = *extra_meta;
 773     *extra_meta = meta;
 774
 775     return;
 776
 777 fail:
 778     if (priv)
 779         free_priv(priv);
 780     av_freep(&meta);
 781 }
 782
 783 typedef struct ID3v2EMFunc {
 784     const char *tag3;
 785     const char *tag4;
 786     void (*read)(AVFormatContext *s, AVIOContext *pb, int taglen,
 787                  const char *tag, ID3v2ExtraMeta **extra_meta,
 788                  int isv34);
 789     void (*free)(void *obj);
 790 } ID3v2EMFunc;
 791
 792 static const ID3v2EMFunc id3v2_extra_meta_funcs[] = {
 793     { "GEO", "GEOB", read_geobtag, free_geobtag },
 794     { "PIC", "APIC", read_apic,    free_apic    },
 795     { "CHAP","CHAP", read_chapter, free_chapter },
 796     { "PRIV","PRIV", read_priv,    free_priv    },
 797     { NULL }
 798 };
 799
 800 /**
 801  * Get the corresponding ID3v2EMFunc struct for a tag.
 802  * @param isv34 Determines if v2.2 or v2.3/4 strings are used
 803  * @return A pointer to the ID3v2EMFunc struct if found, NULL otherwise.
 804  */
 805 static const ID3v2EMFunc *get_extra_meta_func(const char *tag, int isv34)
 806 {
 807     int i = 0;
 808     while (id3v2_extra_meta_funcs[i].tag3) {
 809         if (tag && !memcmp(tag,
 810                     (isv34 ? id3v2_extra_meta_funcs[i].tag4 :
 811                              id3v2_extra_meta_funcs[i].tag3),
 812                     (isv34 ? 4 : 3)))
 813             return &id3v2_extra_meta_funcs[i];
 814         i++;
 815     }
 816     return NULL;
 817 }
 818
 819 static void id3v2_parse(AVIOContext *pb, AVDictionary **metadata,
 820                         AVFormatContext *s, int len, uint8_t version,
 821                         uint8_t flags, ID3v2ExtraMeta **extra_meta)
 822 {
 823     int isv34, unsync;
 824     unsigned tlen;
 825     char tag[5];
 826     int64_t next, end = avio_tell(pb) + len;
 827     int taghdrlen;
 828     const char *reason = NULL;
 829     AVIOContext pb_local;
 830     AVIOContext *pbx;
 831     unsigned char *buffer = NULL;
 832     int buffer_size       = 0;
 833     const ID3v2EMFunc *extra_func = NULL;
 834     unsigned char *uncompressed_buffer = NULL;
 835     av_unused int uncompressed_buffer_size = 0;
 836     const char *comm_frame;
 837
 838     av_log(s, AV_LOG_DEBUG, "id3v2 ver:%d flags:%02X len:%d\n", version, flags, len);
 839
 840     switch (version) {
 841     case 2:
 842         if (flags & 0x40) {
 843             reason = "compression";
 844             goto error;
 845         }
 846         isv34     = 0;
 847         taghdrlen = 6;
 848         comm_frame = "COM";
 849         break;
 850
 851     case 3:
 852     case 4:
 853         isv34     = 1;
 854         taghdrlen = 10;
 855         comm_frame = "COMM";
 856         break;
 857
 858     default:
 859         reason = "version";
 860         goto error;
 861     }
 862
 863     unsync = flags & 0x80;
 864
 865     if (isv34 && flags & 0x40) { /* Extended header present, just skip over it */
 866         int extlen = get_size(pb, 4);
 867         if (version == 4)
 868             /* In v2.4 the length includes the length field we just read. */
 869             extlen -= 4;
 870
 871         if (extlen < 0) {
 872             reason = "invalid extended header length";
 873             goto error;
 874         }
 875         avio_skip(pb, extlen);
 876         len -= extlen + 4;
 877         if (len < 0) {
 878             reason = "extended header too long.";
 879             goto error;
 880         }
 881     }
 882
 883     while (len >= taghdrlen) {
 884         unsigned int tflags = 0;
 885         int tunsync         = 0;
 886         int tcomp           = 0;
 887         int tencr           = 0;
 888         unsigned long av_unused dlen;
 889
 890         if (isv34) {
 891             if (avio_read(pb, tag, 4) < 4)
 892                 break;
 893             tag[4] = 0;
 894             if (version == 3) {
 895                 tlen = avio_rb32(pb);
 896             } else {
 897                 /* some encoders incorrectly uses v3 sizes instead of syncsafe ones
 898                  * so check the next tag to see which one to use */
 899                 tlen = avio_rb32(pb);
 900                 if (tlen > 0x7f) {
 901                     if (tlen < len) {
 902                         int64_t cur = avio_tell(pb);
 903
 904                         if (ffio_ensure_seekback(pb, 2 /* tflags */ + tlen + 4 /* next tag */))
 905                             break;
 906
 907                         if (check_tag(pb, cur + 2 + size_to_syncsafe(tlen), 4) == 1)
 908                             tlen = size_to_syncsafe(tlen);
 909                         else if (check_tag(pb, cur + 2 + tlen, 4) != 1)
 910                             break;
 911                         avio_seek(pb, cur, SEEK_SET);
 912                     } else
 913                         tlen = size_to_syncsafe(tlen);
 914                 }
 915             }
 916             tflags  = avio_rb16(pb);
 917             tunsync = tflags & ID3v2_FLAG_UNSYNCH;
 918         } else {
 919             if (avio_read(pb, tag, 3) < 3)
 920                 break;
 921             tag[3] = 0;
 922             tlen   = avio_rb24(pb);
 923         }
 924         if (tlen > (1<<28))
 925             break;
 926         len -= taghdrlen + tlen;
 927
 928         if (len < 0)
 929             break;
 930
 931         next = avio_tell(pb) + tlen;
 932
 933         if (!tlen) {
 934             if (tag[0])
 935                 av_log(s, AV_LOG_DEBUG, "Invalid empty frame %s, skipping.\n",
 936                        tag);
 937             continue;
 938         }
 939
 940         if (tflags & ID3v2_FLAG_DATALEN) {
 941             if (tlen < 4)
 942                 break;
 943             dlen = avio_rb32(pb);
 944             tlen -= 4;
 945         } else
 946             dlen = tlen;
 947
 948         tcomp = tflags & ID3v2_FLAG_COMPRESSION;
 949         tencr = tflags & ID3v2_FLAG_ENCRYPTION;
 950
 951         /* skip encrypted tags and, if no zlib, compressed tags */
 952         if (tencr || (!CONFIG_ZLIB && tcomp)) {
 953             const char *type;
 954             if (!tcomp)
 955                 type = "encrypted";
 956             else if (!tencr)
 957                 type = "compressed";
 958             else
 959                 type = "encrypted and compressed";
 960
 961             av_log(s, AV_LOG_WARNING, "Skipping %s ID3v2 frame %s.\n", type, tag);
 962             avio_skip(pb, tlen);
 963         /* check for text tag or supported special meta tag */
 964         } else if (tag[0] == 'T' ||
 965                    !memcmp(tag, "USLT", 4) ||
 966                    !strcmp(tag, comm_frame) ||
 967                    (extra_meta &&
 968                     (extra_func = get_extra_meta_func(tag, isv34)))) {
 969             pbx = pb;
 970
 971             if (unsync || tunsync || tcomp) {
 972                 av_fast_malloc(&buffer, &buffer_size, tlen);
 973                 if (!buffer) {
 974                     av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", tlen);
 975                     goto seek;
 976                 }
 977             }
 978             if (unsync || tunsync) {
 979                 uint8_t *b = buffer;
 980                 uint8_t *t = buffer;
 981                 uint8_t *end = t + tlen;
 982
 983                 if (avio_read(pb, buffer, tlen) != tlen) {
 984                     av_log(s, AV_LOG_ERROR, "Failed to read tag data\n");
 985                     goto seek;
 986                 }
 987
 988                 while (t != end) {
 989                     *b++ = *t++;
 990                     if (t != end && t[-1] == 0xff && !t[0])
 991                         t++;
 992                 }
 993
 994                 ffio_init_context(&pb_local, buffer, b - buffer, 0, NULL, NULL, NULL,
 995                                   NULL);
 996                 tlen = b - buffer;
 997                 pbx  = &pb_local; // read from sync buffer
 998             }
 999
1000 #if CONFIG_ZLIB
1001                 if (tcomp) {
1002                     int err;
1003
1004                     av_log(s, AV_LOG_DEBUG, "Compresssed frame %s tlen=%d dlen=%ld\n", tag, tlen, dlen);
1005
1006                     av_fast_malloc(&uncompressed_buffer, &uncompressed_buffer_size, dlen);
1007                     if (!uncompressed_buffer) {
1008                         av_log(s, AV_LOG_ERROR, "Failed to alloc %ld bytes\n", dlen);
1009                         goto seek;
1010                     }
1011
1012                     if (!(unsync || tunsync)) {
1013                         err = avio_read(pb, buffer, tlen);
1014                         if (err < 0) {
1015                             av_log(s, AV_LOG_ERROR, "Failed to read compressed tag\n");
1016                             goto seek;
1017                         }
1018                         tlen = err;
1019                     }
1020
1021                     err = uncompress(uncompressed_buffer, &dlen, buffer, tlen);
1022                     if (err != Z_OK) {
1023                         av_log(s, AV_LOG_ERROR, "Failed to uncompress tag: %d\n", err);
1024                         goto seek;
1025                     }
1026                     ffio_init_context(&pb_local, uncompressed_buffer, dlen, 0, NULL, NULL, NULL, NULL);
1027                     tlen = dlen;
1028                     pbx = &pb_local; // read from sync buffer
1029                 }
1030 #endif
1031             if (tag[0] == 'T')
1032                 /* parse text tag */
1033                 read_ttag(s, pbx, tlen, metadata, tag);
1034             else if (!memcmp(tag, "USLT", 4))
1035                 read_uslt(s, pbx, tlen, metadata);
1036             else if (!strcmp(tag, comm_frame))
1037                 read_comment(s, pbx, tlen, metadata);
1038             else
1039                 /* parse special meta tag */
1040                 extra_func->read(s, pbx, tlen, tag, extra_meta, isv34);
1041         } else if (!tag[0]) {
1042             if (tag[1])
1043                 av_log(s, AV_LOG_WARNING, "invalid frame id, assuming padding\n");
1044             avio_skip(pb, tlen);
1045             break;
1046         }
1047         /* Skip to end of tag */
1048 seek:
1049         avio_seek(pb, next, SEEK_SET);
1050     }
1051
1052     /* Footer preset, always 10 bytes, skip over it */
1053     if (version == 4 && flags & 0x10)
1054         end += 10;
1055
1056 error:
1057     if (reason)
1058         av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n",
1059                version, reason);
1060     avio_seek(pb, end, SEEK_SET);
1061     av_free(buffer);
1062     av_free(uncompressed_buffer);
1063     return;
1064 }
1065
1066 static void id3v2_read_internal(AVIOContext *pb, AVDictionary **metadata,
1067                                 AVFormatContext *s, const char *magic,
1068                                 ID3v2ExtraMeta **extra_meta, int64_t max_search_size)
1069 {
1070     int len, ret;
1071     uint8_t buf[ID3v2_HEADER_SIZE];
1072     int found_header;
1073     int64_t start, off;
1074
1075     if (max_search_size && max_search_size < ID3v2_HEADER_SIZE)
1076         return;
1077
1078     start = avio_tell(pb);
1079     do {
1080         /* save the current offset in case there's nothing to read/skip */
1081         off = avio_tell(pb);
1082         if (max_search_size && off - start >= max_search_size - ID3v2_HEADER_SIZE) {
1083             avio_seek(pb, off, SEEK_SET);
1084             break;
1085         }
1086
1087         ret = ffio_ensure_seekback(pb, ID3v2_HEADER_SIZE);
1088         if (ret >= 0)
1089             ret = avio_read(pb, buf, ID3v2_HEADER_SIZE);
1090         if (ret != ID3v2_HEADER_SIZE) {
1091             avio_seek(pb, off, SEEK_SET);
1092             break;
1093         }
1094         found_header = ff_id3v2_match(buf, magic);
1095         if (found_header) {
1096             /* parse ID3v2 header */
1097             len = ((buf[6] & 0x7f) << 21) |
1098                   ((buf[7] & 0x7f) << 14) |
1099                   ((buf[8] & 0x7f) << 7) |
1100                    (buf[9] & 0x7f);
1101             id3v2_parse(pb, metadata, s, len, buf[3], buf[5], extra_meta);
1102         } else {
1103             avio_seek(pb, off, SEEK_SET);
1104         }
1105     } while (found_header);
1106     ff_metadata_conv(metadata, NULL, ff_id3v2_34_metadata_conv);
1107     ff_metadata_conv(metadata, NULL, id3v2_2_metadata_conv);
1108     ff_metadata_conv(metadata, NULL, ff_id3v2_4_metadata_conv);
1109     merge_date(metadata);
1110 }
1111
1112 void ff_id3v2_read_dict(AVIOContext *pb, AVDictionary **metadata,
1113                         const char *magic, ID3v2ExtraMeta **extra_meta)
1114 {
1115     id3v2_read_internal(pb, metadata, NULL, magic, extra_meta, 0);
1116 }
1117
1118 void ff_id3v2_read(AVFormatContext *s, const char *magic,
1119                    ID3v2ExtraMeta **extra_meta, unsigned int max_search_size)
1120 {
1121     id3v2_read_internal(s->pb, &s->metadata, s, magic, extra_meta, max_search_size);
1122 }
1123
1124 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
1125 {
1126     ID3v2ExtraMeta *current = *extra_meta, *next;
1127     const ID3v2EMFunc *extra_func;
1128
1129     while (current) {
1130         if ((extra_func = get_extra_meta_func(current->tag, 1)))
1131             extra_func->free(current->data);
1132         next = current->next;
1133         av_freep(&current);
1134         current = next;
1135     }
1136
1137     *extra_meta = NULL;
1138 }
1139
1140 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1141 {
1142     ID3v2ExtraMeta *cur;
1143
1144     for (cur = *extra_meta; cur; cur = cur->next) {
1145         ID3v2ExtraMetaAPIC *apic;
1146         AVStream *st;
1147
1148         if (strcmp(cur->tag, "APIC"))
1149             continue;
1150         apic = cur->data;
1151
1152         if (!(st = avformat_new_stream(s, NULL)))
1153             return AVERROR(ENOMEM);
1154
1155         st->disposition      |= AV_DISPOSITION_ATTACHED_PIC;
1156         st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
1157         st->codecpar->codec_id   = apic->id;
1158
1159         if (AV_RB64(apic->buf->data) == 0x89504e470d0a1a0a)
1160             st->codecpar->codec_id = AV_CODEC_ID_PNG;
1161
1162         if (apic->description[0])
1163             av_dict_set(&st->metadata, "title", apic->description, 0);
1164
1165         av_dict_set(&st->metadata, "comment", apic->type, 0);
1166
1167         av_init_packet(&st->attached_pic);
1168         st->attached_pic.buf          = apic->buf;
1169         st->attached_pic.data         = apic->buf->data;
1170         st->attached_pic.size         = apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE;
1171         st->attached_pic.stream_index = st->index;
1172         st->attached_pic.flags       |= AV_PKT_FLAG_KEY;
1173
1174         apic->buf = NULL;
1175     }
1176
1177     return 0;
1178 }
1179
1180 int ff_id3v2_parse_chapters(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1181 {
1182     int ret = 0;
1183     ID3v2ExtraMeta *cur;
1184     AVRational time_base = {1, 1000};
1185     ID3v2ExtraMetaCHAP **chapters = NULL;
1186     int num_chapters = 0;
1187     int i;
1188
1189     // since extra_meta is a linked list where elements are prepended,
1190     // we need to reverse the order of chapters
1191     for (cur = *extra_meta; cur; cur = cur->next) {
1192         ID3v2ExtraMetaCHAP *chap;
1193
1194         if (strcmp(cur->tag, "CHAP"))
1195             continue;
1196         chap = cur->data;
1197
1198         if ((ret = av_dynarray_add_nofree(&chapters, &num_chapters, chap)) < 0)
1199             goto end;
1200     }
1201
1202     for (i = 0; i < (num_chapters / 2); i++) {
1203         ID3v2ExtraMetaCHAP *right;
1204         int right_index;
1205
1206         right_index = (num_chapters - 1) - i;
1207         right = chapters[right_index];
1208
1209         chapters[right_index] = chapters[i];
1210         chapters[i] = right;
1211     }
1212
1213     for (i = 0; i < num_chapters; i++) {
1214         ID3v2ExtraMetaCHAP *chap;
1215         AVChapter *chapter;
1216
1217         chap = chapters[i];
1218         chapter = avpriv_new_chapter(s, i, time_base, chap->start, chap->end, chap->element_id);
1219         if (!chapter)
1220             continue;
1221
1222         if ((ret = av_dict_copy(&chapter->metadata, chap->meta, 0)) < 0)
1223             goto end;
1224     }
1225
1226 end:
1227     av_freep(&chapters);
1228     return ret;
1229 }
1230
1231 int ff_id3v2_parse_priv_dict(AVDictionary **metadata, ID3v2ExtraMeta **extra_meta)
1232 {
1233     ID3v2ExtraMeta *cur;
1234     int dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL;
1235
1236     for (cur = *extra_meta; cur; cur = cur->next) {
1237         if (!strcmp(cur->tag, "PRIV")) {
1238             ID3v2ExtraMetaPRIV *priv = cur->data;
1239             AVBPrint bprint;
1240             char *escaped, *key;
1241             int i, ret;
1242
1243             if ((key = av_asprintf(ID3v2_PRIV_METADATA_PREFIX "%s", priv->owner)) == NULL) {
1244                 return AVERROR(ENOMEM);
1245             }
1246
1247             av_bprint_init(&bprint, priv->datasize + 1, AV_BPRINT_SIZE_UNLIMITED);
1248
1249             for (i = 0; i < priv->datasize; i++) {
1250                 if (priv->data[i] < 32 || priv->data[i] > 126 || priv->data[i] == '\\') {
1251                     av_bprintf(&bprint, "\\x%02x", priv->data[i]);
1252                 } else {
1253                     av_bprint_chars(&bprint, priv->data[i], 1);
1254                 }
1255             }
1256
1257             if ((ret = av_bprint_finalize(&bprint, &escaped)) < 0) {
1258                 av_free(key);
1259                 return ret;
1260             }
1261
1262             if ((ret = av_dict_set(metadata, key, escaped, dict_flags)) < 0) {
1263                 av_free(key);
1264                 av_free(escaped);
1265                 return ret;
1266             }
1267         }
1268     }
1269
1270     return 0;
1271 }
1272
1273 int ff_id3v2_parse_priv(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
1274 {
1275     return ff_id3v2_parse_priv_dict(&s->metadata, extra_meta);
1276 }