id3v2.c 31.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * Copyright (c) 2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22 23 24 25 26 27 28
/**
 * @file
 * ID3v2 header parser
 *
 * Specifications available at:
 * http://id3.org/Developer_Information
 */

29 30 31 32 33 34
#include "config.h"

#if CONFIG_ZLIB
#include <zlib.h>
#endif

35
#include "libavutil/avstring.h"
36
#include "libavutil/dict.h"
37
#include "libavutil/intreadwrite.h"
38
#include "avio_internal.h"
39
#include "internal.h"
40 41
#include "id3v1.h"
#include "id3v2.h"
42

43
const AVMetadataConv ff_id3v2_34_metadata_conv[] = {
44 45 46 47 48 49 50 51 52 53 54 55 56 57
    { "TALB", "album"        },
    { "TCOM", "composer"     },
    { "TCON", "genre"        },
    { "TCOP", "copyright"    },
    { "TENC", "encoded_by"   },
    { "TIT2", "title"        },
    { "TLAN", "language"     },
    { "TPE1", "artist"       },
    { "TPE2", "album_artist" },
    { "TPE3", "performer"    },
    { "TPOS", "disc"         },
    { "TPUB", "publisher"    },
    { "TRCK", "track"        },
    { "TSSE", "encoder"      },
wm4's avatar
wm4 committed
58
    { "USLT", "lyrics"       },
59 60 61 62
    { 0 }
};

const AVMetadataConv ff_id3v2_4_metadata_conv[] = {
63
    { "TCMP", "compilation"   },
64
    { "TDRC", "date"          },
65
    { "TDRL", "date"          },
66 67 68 69
    { "TDEN", "creation_time" },
    { "TSOA", "album-sort"    },
    { "TSOP", "artist-sort"   },
    { "TSOT", "title-sort"    },
70 71 72
    { 0 }
};

73
static const AVMetadataConv id3v2_2_metadata_conv[] = {
74 75
    { "TAL", "album"        },
    { "TCO", "genre"        },
76
    { "TCP", "compilation"  },
77 78 79 80 81 82
    { "TT2", "title"        },
    { "TEN", "encoded_by"   },
    { "TP1", "artist"       },
    { "TP2", "album_artist" },
    { "TP3", "performer"    },
    { "TRK", "track"        },
83 84 85 86
    { 0 }
};

const char ff_id3v2_tags[][4] = {
87 88 89 90 91
    "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDLY", "TENC", "TEXT",
    "TFLT", "TIT1", "TIT2", "TIT3", "TKEY", "TLAN", "TLEN", "TMED",
    "TOAL", "TOFN", "TOLY", "TOPE", "TOWN", "TPE1", "TPE2", "TPE3",
    "TPE4", "TPOS", "TPUB", "TRCK", "TRSN", "TRSO", "TSRC", "TSSE",
    { 0 },
92 93 94
};

const char ff_id3v2_4_tags[][4] = {
95 96 97
    "TDEN", "TDOR", "TDRC", "TDRL", "TDTG", "TIPL", "TMCL", "TMOO",
    "TPRO", "TSOA", "TSOP", "TSOT", "TSST",
    { 0 },
98 99 100
};

const char ff_id3v2_3_tags[][4] = {
101 102
    "TDAT", "TIME", "TORY", "TRDA", "TSIZ", "TYER",
    { 0 },
103 104
};

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
const char *ff_id3v2_picture_types[21] = {
    "Other",
    "32x32 pixels 'file icon'",
    "Other file icon",
    "Cover (front)",
    "Cover (back)",
    "Leaflet page",
    "Media (e.g. label side of CD)",
    "Lead artist/lead performer/soloist",
    "Artist/performer",
    "Conductor",
    "Band/Orchestra",
    "Composer",
    "Lyricist/text writer",
    "Recording Location",
    "During recording",
    "During performance",
    "Movie/video screen capture",
    "A bright coloured fish",
    "Illustration",
    "Band/artist logotype",
    "Publisher/Studio logotype",
};

const CodecMime ff_id3v2_mime_tags[] = {
130 131 132 133 134 135 136 137 138
    { "image/gif",  AV_CODEC_ID_GIF   },
    { "image/jpeg", AV_CODEC_ID_MJPEG },
    { "image/jpg",  AV_CODEC_ID_MJPEG },
    { "image/png",  AV_CODEC_ID_PNG   },
    { "image/tiff", AV_CODEC_ID_TIFF  },
    { "image/bmp",  AV_CODEC_ID_BMP   },
    { "JPG",        AV_CODEC_ID_MJPEG }, /* ID3v2.2  */
    { "PNG",        AV_CODEC_ID_PNG   }, /* ID3v2.2  */
    { "",           AV_CODEC_ID_NONE  },
139 140
};

141
int ff_id3v2_match(const uint8_t *buf, const char *magic)
142
{
143 144 145
    return  buf[0]         == magic[0] &&
            buf[1]         == magic[1] &&
            buf[2]         == magic[2] &&
146 147 148 149 150 151
            buf[3]         != 0xff     &&
            buf[4]         != 0xff     &&
           (buf[6] & 0x80) == 0        &&
           (buf[7] & 0x80) == 0        &&
           (buf[8] & 0x80) == 0        &&
           (buf[9] & 0x80) == 0;
152
}
153

154
int ff_id3v2_tag_len(const uint8_t *buf)
155 156
{
    int len = ((buf[6] & 0x7f) << 21) +
157 158
              ((buf[7] & 0x7f) << 14) +
              ((buf[8] & 0x7f) << 7) +
159
              (buf[9] & 0x7f) +
160
              ID3v2_HEADER_SIZE;
161 162 163 164
    if (buf[5] & 0x10)
        len += ID3v2_HEADER_SIZE;
    return len;
}
165

166
static unsigned int get_size(AVIOContext *s, int len)
167
{
168 169
    int v = 0;
    while (len--)
170
        v = (v << 7) + (avio_r8(s) & 0x7F);
171 172 173
    return v;
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
static unsigned int size_to_syncsafe(unsigned int size)
{
    return (((size) & (0x7f <<  0)) >> 0) +
           (((size) & (0x7f <<  8)) >> 1) +
           (((size) & (0x7f << 16)) >> 2) +
           (((size) & (0x7f << 24)) >> 3);
}

/* No real verification, only check that the tag consists of
 * a combination of capital alpha-numerical characters */
static int is_tag(const char *buf, unsigned int len)
{
    if (!len)
        return 0;

    while (len--)
        if ((buf[len] < 'A' ||
             buf[len] > 'Z') &&
            (buf[len] < '0' ||
             buf[len] > '9'))
            return 0;

    return 1;
}

/**
 * Return 1 if the tag of length len at the given offset is valid, 0 if not, -1 on error
 */
static int check_tag(AVIOContext *s, int offset, unsigned int len)
{
    char tag[4];

    if (len > 4 ||
        avio_seek(s, offset, SEEK_SET) < 0 ||
208
        avio_read(s, tag, len) < (int)len)
209 210 211 212 213 214 215
        return -1;
    else if (!AV_RB32(tag) || is_tag(tag, len))
        return 1;

    return 0;
}

216 217 218
/**
 * Free GEOB type extra metadata.
 */
219
static void free_geobtag(void *obj)
220
{
221
    ID3v2ExtraMetaGEOB *geob = obj;
222 223 224 225
    av_freep(&geob->mime_type);
    av_freep(&geob->file_name);
    av_freep(&geob->description);
    av_freep(&geob->data);
226 227
    av_free(geob);
}
228

229 230
/**
 * Decode characters to UTF-8 according to encoding type. The decoded buffer is
231 232
 * always null terminated. Stop reading when either *maxread bytes are read from
 * pb or U+0000 character is found.
233 234 235 236 237 238
 *
 * @param dst Pointer where the address of the buffer with the decoded bytes is
 * stored. Buffer must be freed by caller.
 * @param maxread Pointer to maximum number of characters to read from the
 * AVIOContext. After execution the value is decremented by the number of bytes
 * actually read.
239
 * @returns 0 if no error occurred, dst is uninitialized on error
240 241
 */
static int decode_str(AVFormatContext *s, AVIOContext *pb, int encoding,
242
                      uint8_t **dst, int *maxread)
243
{
244
    int ret;
245 246 247 248 249
    uint8_t tmp;
    uint32_t ch = 1;
    int left = *maxread;
    unsigned int (*get)(AVIOContext*) = avio_rb16;
    AVIOContext *dynbuf;
250

251 252 253 254
    if ((ret = avio_open_dyn_buf(&dynbuf)) < 0) {
        av_log(s, AV_LOG_ERROR, "Error opening memory stream\n");
        return ret;
    }
255

256
    switch (encoding) {
257
    case ID3v2_ENCODING_ISO8859:
258
        while (left && ch) {
259 260 261
            ch = avio_r8(pb);
            PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
            left--;
262 263 264
        }
        break;

265
    case ID3v2_ENCODING_UTF16BOM:
266 267
        if ((left -= 2) < 0) {
            av_log(s, AV_LOG_ERROR, "Cannot read BOM value, input too short\n");
268 269
            ffio_free_dyn_buf(&dynbuf);
            *dst = NULL;
270 271
            return AVERROR_INVALIDDATA;
        }
272
        switch (avio_rb16(pb)) {
273
        case 0xfffe:
274
            get = avio_rl16;
275 276 277
        case 0xfeff:
            break;
        default:
278
            av_log(s, AV_LOG_ERROR, "Incorrect BOM value\n");
279 280
            ffio_free_dyn_buf(&dynbuf);
            *dst = NULL;
281 282
            *maxread = left;
            return AVERROR_INVALIDDATA;
283 284 285
        }
        // fall-through

286
    case ID3v2_ENCODING_UTF16BE:
287
        while ((left > 1) && ch) {
288 289
            GET_UTF16(ch, ((left -= 2) >= 0 ? get(pb) : 0), break;)
            PUT_UTF8(ch, tmp, avio_w8(dynbuf, tmp);)
290
        }
291
        if (left < 0)
292
            left += 2;  /* did not read last char from pb */
293 294
        break;

295
    case ID3v2_ENCODING_UTF8:
296
        while (left && ch) {
297 298 299 300
            ch = avio_r8(pb);
            avio_w8(dynbuf, ch);
            left--;
        }
301
        break;
302
    default:
303 304 305 306 307 308
        av_log(s, AV_LOG_WARNING, "Unknown encoding\n");
    }

    if (ch)
        avio_w8(dynbuf, 0);

309
    avio_close_dyn_buf(dynbuf, dst);
310 311 312 313 314 315 316 317
    *maxread = left;

    return 0;
}

/**
 * Parse a text tag.
 */
318
static void read_ttag(AVFormatContext *s, AVIOContext *pb, int taglen,
319
                      AVDictionary **metadata, const char *key)
320 321
{
    uint8_t *dst;
322
    int encoding, dict_flags = AV_DICT_DONT_OVERWRITE | AV_DICT_DONT_STRDUP_VAL;
323 324 325 326 327
    unsigned genre;

    if (taglen < 1)
        return;

328
    encoding = avio_r8(pb);
329 330
    taglen--; /* account for encoding type byte */

331
    if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
332 333
        av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
        return;
334 335
    }

336 337 338
    if (!(strcmp(key, "TCON") && strcmp(key, "TCO"))                         &&
        (sscanf(dst, "(%d)", &genre) == 1 || sscanf(dst, "%d", &genre) == 1) &&
        genre <= ID3v1_GENRE_MAX) {
339
        av_freep(&dst);
340
        dst = av_strdup(ff_id3v1_genre_str[genre]);
341 342
    } else if (!(strcmp(key, "TXXX") && strcmp(key, "TXX"))) {
        /* dst now contains the key, need to get value */
343
        key = dst;
344 345 346 347 348
        if (decode_str(s, pb, encoding, &dst, &taglen) < 0) {
            av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", key);
            av_freep(&key);
            return;
        }
349 350
        dict_flags |= AV_DICT_DONT_STRDUP_KEY;
    } else if (!*dst)
351
        av_freep(&dst);
352

353
    if (dst)
354
        av_dict_set(metadata, key, dst, dict_flags);
355 356
}

wm4's avatar
wm4 committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
static void read_uslt(AVFormatContext *s, AVIOContext *pb, int taglen,
                      AVDictionary **metadata)
{
    uint8_t lang[4];
    uint8_t *descriptor = NULL; // 'Content descriptor'
    uint8_t *text = NULL;
    char *key = NULL;
    int encoding;
    int ok = 0;

    if (taglen < 1)
        goto error;

    encoding = avio_r8(pb);
    taglen--;

    if (avio_read(pb, lang, 3) < 3)
        goto error;
    lang[3] = '\0';
    taglen -= 3;

    if (decode_str(s, pb, encoding, &descriptor, &taglen) < 0)
        goto error;

    if (decode_str(s, pb, encoding, &text, &taglen) < 0)
        goto error;

    // FFmpeg does not support hierarchical metadata, so concatenate the keys.
    key = av_asprintf("lyrics-%s%s%s", descriptor[0] ? (char *)descriptor : "",
                                       descriptor[0] ? "-" : "",
                                       lang);
    if (!key)
        goto error;

    av_dict_set(metadata, key, text, 0);

    ok = 1;
error:
    if (!ok)
        av_log(s, AV_LOG_ERROR, "Error reading lyrics, skipped\n");
    av_free(descriptor);
    av_free(text);
    av_free(key);
}

402 403 404
/**
 * Parse GEOB tag into a ID3v2ExtraMetaGEOB struct.
 */
405
static void read_geobtag(AVFormatContext *s, AVIOContext *pb, int taglen,
406 407
                         const char *tag, ID3v2ExtraMeta **extra_meta,
                         int isv34)
408 409
{
    ID3v2ExtraMetaGEOB *geob_data = NULL;
410
    ID3v2ExtraMeta *new_extra     = NULL;
411 412 413 414 415 416 417 418
    char encoding;
    unsigned int len;

    if (taglen < 1)
        return;

    geob_data = av_mallocz(sizeof(ID3v2ExtraMetaGEOB));
    if (!geob_data) {
419
        av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
420
               sizeof(ID3v2ExtraMetaGEOB));
421 422 423 424 425
        return;
    }

    new_extra = av_mallocz(sizeof(ID3v2ExtraMeta));
    if (!new_extra) {
426
        av_log(s, AV_LOG_ERROR, "Failed to alloc %"SIZE_SPECIFIER" bytes\n",
427
               sizeof(ID3v2ExtraMeta));
428 429 430 431 432 433 434 435
        goto fail;
    }

    /* read encoding type byte */
    encoding = avio_r8(pb);
    taglen--;

    /* read MIME type (always ISO-8859) */
436 437 438
    if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &geob_data->mime_type,
                   &taglen) < 0 ||
        taglen <= 0)
439 440 441
        goto fail;

    /* read file name */
442 443
    if (decode_str(s, pb, encoding, &geob_data->file_name, &taglen) < 0 ||
        taglen <= 0)
444 445 446
        goto fail;

    /* read content description */
447 448
    if (decode_str(s, pb, encoding, &geob_data->description, &taglen) < 0 ||
        taglen < 0)
449 450 451 452 453 454 455 456 457 458
        goto fail;

    if (taglen) {
        /* save encapsulated binary data */
        geob_data->data = av_malloc(taglen);
        if (!geob_data->data) {
            av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", taglen);
            goto fail;
        }
        if ((len = avio_read(pb, geob_data->data, taglen)) < taglen)
459 460
            av_log(s, AV_LOG_WARNING,
                   "Error reading GEOB frame, data truncated.\n");
461 462
        geob_data->datasize = len;
    } else {
463
        geob_data->data     = NULL;
464 465 466 467
        geob_data->datasize = 0;
    }

    /* add data to the list */
468
    new_extra->tag  = "GEOB";
469 470
    new_extra->data = geob_data;
    new_extra->next = *extra_meta;
471
    *extra_meta     = new_extra;
472 473 474 475 476 477 478 479

    return;

fail:
    av_log(s, AV_LOG_ERROR, "Error reading frame %s, skipped\n", tag);
    free_geobtag(geob_data);
    av_free(new_extra);
    return;
480 481
}

482 483
static int is_number(const char *str)
{
484 485
    while (*str >= '0' && *str <= '9')
        str++;
486 487 488
    return !*str;
}

489
static AVDictionaryEntry *get_date_tag(AVDictionary *m, const char *tag)
490
{
491 492
    AVDictionaryEntry *t;
    if ((t = av_dict_get(m, tag, NULL, AV_DICT_MATCH_CASE)) &&
493 494 495 496 497
        strlen(t->value) == 4 && is_number(t->value))
        return t;
    return NULL;
}

498
static void merge_date(AVDictionary **m)
499
{
500
    AVDictionaryEntry *t;
501
    char date[17] = { 0 };      // YYYY-MM-DD hh:mm
502 503 504 505 506

    if (!(t = get_date_tag(*m, "TYER")) &&
        !(t = get_date_tag(*m, "TYE")))
        return;
    av_strlcpy(date, t->value, 5);
507
    av_dict_set(m, "TYER", NULL, 0);
508
    av_dict_set(m, "TYE", NULL, 0);
509 510 511 512 513

    if (!(t = get_date_tag(*m, "TDAT")) &&
        !(t = get_date_tag(*m, "TDA")))
        goto finish;
    snprintf(date + 4, sizeof(date) - 4, "-%.2s-%.2s", t->value + 2, t->value);
514
    av_dict_set(m, "TDAT", NULL, 0);
515
    av_dict_set(m, "TDA", NULL, 0);
516 517 518 519

    if (!(t = get_date_tag(*m, "TIME")) &&
        !(t = get_date_tag(*m, "TIM")))
        goto finish;
520 521
    snprintf(date + 10, sizeof(date) - 10,
             " %.2s:%.2s", t->value, t->value + 2);
522
    av_dict_set(m, "TIME", NULL, 0);
523
    av_dict_set(m, "TIM", NULL, 0);
524 525 526

finish:
    if (date[0])
527
        av_dict_set(m, "date", date, 0);
528 529
}

530 531 532
static void free_apic(void *obj)
{
    ID3v2ExtraMetaAPIC *apic = obj;
533
    av_buffer_unref(&apic->buf);
534 535 536 537
    av_freep(&apic->description);
    av_freep(&apic);
}

538 539 540 541 542 543 544
static void rstrip_spaces(char *buf)
{
    size_t len = strlen(buf);
    while (len > 0 && buf[len - 1] == ' ')
        buf[--len] = 0;
}

545
static void read_apic(AVFormatContext *s, AVIOContext *pb, int taglen,
546 547
                      const char *tag, ID3v2ExtraMeta **extra_meta,
                      int isv34)
548 549
{
    int enc, pic_type;
550 551 552 553
    char mimetype[64];
    const CodecMime *mime     = ff_id3v2_mime_tags;
    enum AVCodecID id         = AV_CODEC_ID_NONE;
    ID3v2ExtraMetaAPIC *apic  = NULL;
554
    ID3v2ExtraMeta *new_extra = NULL;
555
    int64_t end               = avio_tell(pb) + taglen;
556

557
    if (taglen <= 4 || (!isv34 && taglen <= 6))
558 559 560 561 562 563 564 565 566 567 568
        goto fail;

    new_extra = av_mallocz(sizeof(*new_extra));
    apic      = av_mallocz(sizeof(*apic));
    if (!new_extra || !apic)
        goto fail;

    enc = avio_r8(pb);
    taglen--;

    /* mimetype */
569
    if (isv34) {
570
        taglen -= avio_get_str(pb, taglen, mimetype, sizeof(mimetype));
571 572 573
    } else {
        avio_read(pb, mimetype, 3);
        mimetype[3] = 0;
574
        taglen    -= 3;
575
    }
576

577
    while (mime->id != AV_CODEC_ID_NONE) {
578
        if (!av_strncasecmp(mime->str, mimetype, sizeof(mimetype))) {
579 580 581 582 583
            id = mime->id;
            break;
        }
        mime++;
    }
584
    if (id == AV_CODEC_ID_NONE) {
585 586
        av_log(s, AV_LOG_WARNING,
               "Unknown attached picture mimetype: %s, skipping.\n", mimetype);
587 588 589 590 591 592 593 594
        goto fail;
    }
    apic->id = id;

    /* picture type */
    pic_type = avio_r8(pb);
    taglen--;
    if (pic_type < 0 || pic_type >= FF_ARRAY_ELEMS(ff_id3v2_picture_types)) {
595 596
        av_log(s, AV_LOG_WARNING, "Unknown attached picture type %d.\n",
               pic_type);
597 598 599 600 601 602
        pic_type = 0;
    }
    apic->type = ff_id3v2_picture_types[pic_type];

    /* description and picture data */
    if (decode_str(s, pb, enc, &apic->description, &taglen) < 0) {
603 604
        av_log(s, AV_LOG_ERROR,
               "Error decoding attached picture description.\n");
605 606 607
        goto fail;
    }

608
    apic->buf = av_buffer_alloc(taglen + AV_INPUT_BUFFER_PADDING_SIZE);
609
    if (!apic->buf || !taglen || avio_read(pb, apic->buf->data, taglen) != taglen)
610
        goto fail;
611
    memset(apic->buf->data + taglen, 0, AV_INPUT_BUFFER_PADDING_SIZE);
612

613 614 615 616
    new_extra->tag  = "APIC";
    new_extra->data = apic;
    new_extra->next = *extra_meta;
    *extra_meta     = new_extra;
617

618 619 620 621
    // The description must be unique, and some ID3v2 tag writers add spaces
    // to write several APIC entries with the same description.
    rstrip_spaces(apic->description);

622 623 624 625 626 627 628 629 630
    return;

fail:
    if (apic)
        free_apic(apic);
    av_freep(&new_extra);
    avio_seek(pb, end, SEEK_SET);
}

631
static void read_chapter(AVFormatContext *s, AVIOContext *pb, int len, const char *ttag, ID3v2ExtraMeta **extra_meta, int isv34)
Paul B Mahol's avatar
Paul B Mahol committed
632 633 634
{
    AVRational time_base = {1, 1000};
    uint32_t start, end;
635
    AVChapter *chapter;
636
    uint8_t *dst = NULL;
637 638
    int taglen;
    char tag[5];
Paul B Mahol's avatar
Paul B Mahol committed
639

640 641 642 643 644 645 646 647
    if (!s) {
        /* We should probably just put the chapter data to extra_meta here
         * and do the AVFormatContext-needing part in a separate
         * ff_id3v2_parse_apic()-like function. */
        av_log(NULL, AV_LOG_DEBUG, "No AVFormatContext, skipped ID3 chapter data\n");
        return;
    }

648 649
    if (decode_str(s, pb, 0, &dst, &len) < 0)
        return;
650
    if (len < 16)
Paul B Mahol's avatar
Paul B Mahol committed
651 652 653 654
        return;

    start = avio_rb32(pb);
    end   = avio_rb32(pb);
655 656 657 658 659 660 661
    avio_skip(pb, 8);

    chapter = avpriv_new_chapter(s, s->nb_chapters + 1, time_base, start, end, dst);
    if (!chapter) {
        av_free(dst);
        return;
    }
Paul B Mahol's avatar
Paul B Mahol committed
662

663 664
    len -= 16;
    while (len > 10) {
665 666
        if (avio_read(pb, tag, 4) < 4)
            goto end;
667 668 669 670
        tag[4] = 0;
        taglen = avio_rb32(pb);
        avio_skip(pb, 2);
        len -= 10;
671 672
        if (taglen < 0 || taglen > len)
            goto end;
673 674 675 676 677
        if (tag[0] == 'T')
            read_ttag(s, pb, taglen, &chapter->metadata, tag);
        else
            avio_skip(pb, taglen);
        len -= taglen;
Paul B Mahol's avatar
Paul B Mahol committed
678 679
    }

680 681
    ff_metadata_conv(&chapter->metadata, NULL, ff_id3v2_34_metadata_conv);
    ff_metadata_conv(&chapter->metadata, NULL, ff_id3v2_4_metadata_conv);
682
end:
683
    av_free(dst);
Paul B Mahol's avatar
Paul B Mahol committed
684 685
}

686 687 688 689 690 691 692 693 694
static void free_priv(void *obj)
{
    ID3v2ExtraMetaPRIV *priv = obj;
    av_freep(&priv->owner);
    av_freep(&priv->data);
    av_freep(&priv);
}

static void read_priv(AVFormatContext *s, AVIOContext *pb, int taglen,
695
                      const char *tag, ID3v2ExtraMeta **extra_meta, int isv34)
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
{
    ID3v2ExtraMeta *meta;
    ID3v2ExtraMetaPRIV *priv;

    meta = av_mallocz(sizeof(*meta));
    priv = av_mallocz(sizeof(*priv));

    if (!meta || !priv)
        goto fail;

    if (decode_str(s, pb, ID3v2_ENCODING_ISO8859, &priv->owner, &taglen) < 0)
        goto fail;

    priv->data = av_malloc(taglen);
    if (!priv->data)
        goto fail;

    priv->datasize = taglen;

    if (avio_read(pb, priv->data, priv->datasize) != priv->datasize)
        goto fail;

    meta->tag   = "PRIV";
    meta->data  = priv;
    meta->next  = *extra_meta;
    *extra_meta = meta;

    return;

fail:
    if (priv)
        free_priv(priv);
    av_freep(&meta);
}

731 732 733
typedef struct ID3v2EMFunc {
    const char *tag3;
    const char *tag4;
734
    void (*read)(AVFormatContext *s, AVIOContext *pb, int taglen,
735 736
                 const char *tag, ID3v2ExtraMeta **extra_meta,
                 int isv34);
737
    void (*free)(void *obj);
738 739 740
} ID3v2EMFunc;

static const ID3v2EMFunc id3v2_extra_meta_funcs[] = {
741
    { "GEO", "GEOB", read_geobtag, free_geobtag },
742
    { "PIC", "APIC", read_apic,    free_apic    },
743
    { "CHAP","CHAP", read_chapter, NULL         },
744
    { "PRIV","PRIV", read_priv,    free_priv    },
745 746 747
    { NULL }
};

748 749 750 751 752 753 754 755
/**
 * Get the corresponding ID3v2EMFunc struct for a tag.
 * @param isv34 Determines if v2.2 or v2.3/4 strings are used
 * @return A pointer to the ID3v2EMFunc struct if found, NULL otherwise.
 */
static const ID3v2EMFunc *get_extra_meta_func(const char *tag, int isv34)
{
    int i = 0;
756
    while (id3v2_extra_meta_funcs[i].tag3) {
757
        if (tag && !memcmp(tag,
758 759
                    (isv34 ? id3v2_extra_meta_funcs[i].tag4 :
                             id3v2_extra_meta_funcs[i].tag3),
760
                    (isv34 ? 4 : 3)))
761
            return &id3v2_extra_meta_funcs[i];
762 763
        i++;
    }
764
    return NULL;
765 766
}

767 768
static void id3v2_parse(AVIOContext *pb, AVDictionary **metadata,
                        AVFormatContext *s, int len, uint8_t version,
769
                        uint8_t flags, ID3v2ExtraMeta **extra_meta)
770
{
771 772
    int isv34, unsync;
    unsigned tlen;
773
    char tag[5];
774
    int64_t next, end = avio_tell(pb) + len;
775
    int taghdrlen;
776
    const char *reason = NULL;
777
    AVIOContext pb_local;
778
    AVIOContext *pbx;
779
    unsigned char *buffer = NULL;
780
    int buffer_size       = 0;
781
    const ID3v2EMFunc *extra_func = NULL;
782
    unsigned char *uncompressed_buffer = NULL;
783
    av_unused int uncompressed_buffer_size = 0;
784

785 786
    av_log(s, AV_LOG_DEBUG, "id3v2 ver:%d flags:%02X len:%d\n", version, flags, len);

787
    switch (version) {
788
    case 2:
789
        if (flags & 0x40) {
790 791 792
            reason = "compression";
            goto error;
        }
793
        isv34     = 0;
794 795 796 797 798
        taghdrlen = 6;
        break;

    case 3:
    case 4:
799
        isv34     = 1;
800 801 802 803 804 805 806 807
        taghdrlen = 10;
        break;

    default:
        reason = "version";
        goto error;
    }

808
    unsync = flags & 0x80;
809

810
    if (isv34 && flags & 0x40) { /* Extended header present, just skip over it */
811
        int extlen = get_size(pb, 4);
812
        if (version == 4)
813 814
            /* In v2.4 the length includes the length field we just read. */
            extlen -= 4;
815 816 817

        if (extlen < 0) {
            reason = "invalid extended header length";
818 819
            goto error;
        }
820
        avio_skip(pb, extlen);
821
        len -= extlen + 4;
822 823 824 825 826
        if (len < 0) {
            reason = "extended header too long.";
            goto error;
        }
    }
827

828
    while (len >= taghdrlen) {
829
        unsigned int tflags = 0;
830
        int tunsync         = 0;
831 832
        int tcomp           = 0;
        int tencr           = 0;
833
        unsigned long av_unused dlen;
834

835
        if (isv34) {
836
            if (avio_read(pb, tag, 4) < 4)
837
                break;
838
            tag[4] = 0;
839
            if (version == 3) {
840
                tlen = avio_rb32(pb);
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
            } else {
                /* some encoders incorrectly uses v3 sizes instead of syncsafe ones
                 * so check the next tag to see which one to use */
                tlen = avio_rb32(pb);
                if (tlen > 0x7f) {
                    if (tlen < len) {
                        int64_t cur = avio_tell(pb);

                        if (ffio_ensure_seekback(pb, 2 /* tflags */ + tlen + 4 /* next tag */))
                            break;

                        if (check_tag(pb, cur + 2 + size_to_syncsafe(tlen), 4) == 1)
                            tlen = size_to_syncsafe(tlen);
                        else if (check_tag(pb, cur + 2 + tlen, 4) != 1)
                            break;
                        avio_seek(pb, cur, SEEK_SET);
                    } else
                        tlen = size_to_syncsafe(tlen);
                }
            }
861
            tflags  = avio_rb16(pb);
862
            tunsync = tflags & ID3v2_FLAG_UNSYNCH;
863
        } else {
864
            if (avio_read(pb, tag, 3) < 3)
865
                break;
866
            tag[3] = 0;
867
            tlen   = avio_rb24(pb);
868
        }
869
        if (tlen > (1<<28))
870
            break;
871 872
        len -= taghdrlen + tlen;

873
        if (len < 0)
874 875
            break;

876
        next = avio_tell(pb) + tlen;
877

878 879
        if (!tlen) {
            if (tag[0])
880 881
                av_log(s, AV_LOG_DEBUG, "Invalid empty frame %s, skipping.\n",
                       tag);
882 883 884
            continue;
        }

885
        if (tflags & ID3v2_FLAG_DATALEN) {
886 887
            if (tlen < 4)
                break;
888
            dlen = avio_rb32(pb);
889
            tlen -= 4;
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
        } else
            dlen = tlen;

        tcomp = tflags & ID3v2_FLAG_COMPRESSION;
        tencr = tflags & ID3v2_FLAG_ENCRYPTION;

        /* skip encrypted tags and, if no zlib, compressed tags */
        if (tencr || (!CONFIG_ZLIB && tcomp)) {
            const char *type;
            if (!tcomp)
                type = "encrypted";
            else if (!tencr)
                type = "compressed";
            else
                type = "encrypted and compressed";
905

906
            av_log(s, AV_LOG_WARNING, "Skipping %s ID3v2 frame %s.\n", type, tag);
907
            avio_skip(pb, tlen);
908
        /* check for text tag or supported special meta tag */
909
        } else if (tag[0] == 'T' ||
wm4's avatar
wm4 committed
910
                   !memcmp(tag, "USLT", 4) ||
911 912
                   (extra_meta &&
                    (extra_func = get_extra_meta_func(tag, isv34)))) {
913
            pbx = pb;
914

915 916
            if (unsync || tunsync || tcomp) {
                av_fast_malloc(&buffer, &buffer_size, tlen);
917
                if (!buffer) {
918
                    av_log(s, AV_LOG_ERROR, "Failed to alloc %d bytes\n", tlen);
919 920
                    goto seek;
                }
921 922
            }
            if (unsync || tunsync) {
923
                int64_t end = avio_tell(pb) + tlen;
924 925
                uint8_t *b;

926
                b = buffer;
927 928 929
                while (avio_tell(pb) < end && b - buffer < tlen && !pb->eof_reached) {
                    *b++ = avio_r8(pb);
                    if (*(b - 1) == 0xff && avio_tell(pb) < end - 1 &&
930
                        b - buffer < tlen &&
931 932 933
                        !pb->eof_reached ) {
                        uint8_t val = avio_r8(pb);
                        *b++ = val ? val : avio_r8(pb);
934 935
                    }
                }
936
                ffio_init_context(&pb_local, buffer, b - buffer, 0, NULL, NULL, NULL,
937
                                  NULL);
938
                tlen = b - buffer;
939
                pbx  = &pb_local; // read from sync buffer
940 941
            }

942 943
#if CONFIG_ZLIB
                if (tcomp) {
944
                    int err;
945

946
                    av_log(s, AV_LOG_DEBUG, "Compresssed frame %s tlen=%d dlen=%ld\n", tag, tlen, dlen);
947

948 949 950
                    av_fast_malloc(&uncompressed_buffer, &uncompressed_buffer_size, dlen);
                    if (!uncompressed_buffer) {
                        av_log(s, AV_LOG_ERROR, "Failed to alloc %ld bytes\n", dlen);
951 952 953
                        goto seek;
                    }

954
                    if (!(unsync || tunsync)) {
955
                        err = avio_read(pb, buffer, tlen);
956 957 958 959 960
                        if (err < 0) {
                            av_log(s, AV_LOG_ERROR, "Failed to read compressed tag\n");
                            goto seek;
                        }
                        tlen = err;
961 962
                    }

963
                    err = uncompress(uncompressed_buffer, &dlen, buffer, tlen);
964 965 966 967
                    if (err != Z_OK) {
                        av_log(s, AV_LOG_ERROR, "Failed to uncompress tag: %d\n", err);
                        goto seek;
                    }
968
                    ffio_init_context(&pb_local, uncompressed_buffer, dlen, 0, NULL, NULL, NULL, NULL);
969
                    tlen = dlen;
970
                    pbx = &pb_local; // read from sync buffer
971 972
                }
#endif
973 974
            if (tag[0] == 'T')
                /* parse text tag */
975
                read_ttag(s, pbx, tlen, metadata, tag);
wm4's avatar
wm4 committed
976 977
            else if (!memcmp(tag, "USLT", 4))
                read_uslt(s, pbx, tlen, metadata);
978 979
            else
                /* parse special meta tag */
980
                extra_func->read(s, pbx, tlen, tag, extra_meta, isv34);
981
        } else if (!tag[0]) {
982
            if (tag[1])
983
                av_log(s, AV_LOG_WARNING, "invalid frame id, assuming padding\n");
984
            avio_skip(pb, tlen);
985 986
            break;
        }
987
        /* Skip to end of tag */
988
seek:
989
        avio_seek(pb, next, SEEK_SET);
990 991
    }

992 993
    /* Footer preset, always 10 bytes, skip over it */
    if (version == 4 && flags & 0x10)
994
        end += 10;
995

996
error:
997
    if (reason)
998 999
        av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n",
               version, reason);
1000
    avio_seek(pb, end, SEEK_SET);
1001
    av_free(buffer);
1002
    av_free(uncompressed_buffer);
1003 1004
    return;
}
1005

1006 1007
static void id3v2_read_internal(AVIOContext *pb, AVDictionary **metadata,
                                AVFormatContext *s, const char *magic,
1008
                                ID3v2ExtraMeta **extra_meta, int64_t max_search_size)
1009 1010 1011
{
    int len, ret;
    uint8_t buf[ID3v2_HEADER_SIZE];
1012
    int found_header;
1013
    int64_t start, off;
1014

1015 1016 1017 1018
    if (max_search_size && max_search_size < ID3v2_HEADER_SIZE)
        return;

    start = avio_tell(pb);
1019 1020
    do {
        /* save the current offset in case there's nothing to read/skip */
1021
        off = avio_tell(pb);
1022 1023 1024 1025 1026
        if (max_search_size && off - start >= max_search_size - ID3v2_HEADER_SIZE) {
            avio_seek(pb, off, SEEK_SET);
            break;
        }

1027
        ret = avio_read(pb, buf, ID3v2_HEADER_SIZE);
1028
        if (ret != ID3v2_HEADER_SIZE) {
1029
            avio_seek(pb, off, SEEK_SET);
1030
            break;
1031
        }
1032 1033
        found_header = ff_id3v2_match(buf, magic);
        if (found_header) {
1034 1035 1036 1037 1038
            /* parse ID3v2 header */
            len = ((buf[6] & 0x7f) << 21) |
                  ((buf[7] & 0x7f) << 14) |
                  ((buf[8] & 0x7f) << 7) |
                   (buf[9] & 0x7f);
1039
            id3v2_parse(pb, metadata, s, len, buf[3], buf[5], extra_meta);
1040
        } else {
1041
            avio_seek(pb, off, SEEK_SET);
1042 1043
        }
    } while (found_header);
1044 1045 1046 1047 1048 1049 1050 1051 1052
    ff_metadata_conv(metadata, NULL, ff_id3v2_34_metadata_conv);
    ff_metadata_conv(metadata, NULL, id3v2_2_metadata_conv);
    ff_metadata_conv(metadata, NULL, ff_id3v2_4_metadata_conv);
    merge_date(metadata);
}

void ff_id3v2_read_dict(AVIOContext *pb, AVDictionary **metadata,
                        const char *magic, ID3v2ExtraMeta **extra_meta)
{
1053
    id3v2_read_internal(pb, metadata, NULL, magic, extra_meta, 0);
1054 1055 1056
}

void ff_id3v2_read(AVFormatContext *s, const char *magic,
1057
                   ID3v2ExtraMeta **extra_meta, unsigned int max_search_size)
1058
{
1059
    id3v2_read_internal(s->pb, &s->metadata, s, magic, extra_meta, max_search_size);
1060 1061
}

1062 1063 1064
void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
{
    ID3v2ExtraMeta *current = *extra_meta, *next;
1065
    const ID3v2EMFunc *extra_func;
1066 1067

    while (current) {
1068 1069
        if ((extra_func = get_extra_meta_func(current->tag, 1)))
            extra_func->free(current->data);
1070 1071 1072 1073
        next = current->next;
        av_freep(&current);
        current = next;
    }
1074 1075

    *extra_meta = NULL;
1076
}
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093

int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
{
    ID3v2ExtraMeta *cur;

    for (cur = *extra_meta; cur; cur = cur->next) {
        ID3v2ExtraMetaAPIC *apic;
        AVStream *st;

        if (strcmp(cur->tag, "APIC"))
            continue;
        apic = cur->data;

        if (!(st = avformat_new_stream(s, NULL)))
            return AVERROR(ENOMEM);

        st->disposition      |= AV_DISPOSITION_ATTACHED_PIC;
1094 1095
        st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
        st->codecpar->codec_id   = apic->id;
1096

1097
        if (AV_RB64(apic->buf->data) == 0x89504e470d0a1a0a)
1098
            st->codecpar->codec_id = AV_CODEC_ID_PNG;
1099

1100 1101
        if (apic->description[0])
            av_dict_set(&st->metadata, "title", apic->description, 0);
1102

1103 1104 1105
        av_dict_set(&st->metadata, "comment", apic->type, 0);

        av_init_packet(&st->attached_pic);
1106 1107
        st->attached_pic.buf          = apic->buf;
        st->attached_pic.data         = apic->buf->data;
1108
        st->attached_pic.size         = apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE;
1109
        st->attached_pic.stream_index = st->index;
1110
        st->attached_pic.flags       |= AV_PKT_FLAG_KEY;
1111

1112
        apic->buf = NULL;
1113 1114 1115 1116
    }

    return 0;
}