25ee53e9b87596cf7ef0161487219f3eba296c1b
[libav.git] / libavformat / id3v2.h
1 /*
2 * ID3v2 header parser
3 * Copyright (c) 2003 Fabrice Bellard
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #ifndef AVFORMAT_ID3V2_H
23 #define AVFORMAT_ID3V2_H
24
25 #include <stdint.h>
26 #include "avformat.h"
27 #include "metadata.h"
28
29 #define ID3v2_HEADER_SIZE 10
30
31 /**
32 * Default magic bytes for ID3v2 header: "ID3"
33 */
34 #define ID3v2_DEFAULT_MAGIC "ID3"
35
36 #define ID3v2_FLAG_DATALEN 0x0001
37 #define ID3v2_FLAG_UNSYNCH 0x0002
38 #define ID3v2_FLAG_ENCRYPTION 0x0004
39 #define ID3v2_FLAG_COMPRESSION 0x0008
40
41 /**
42 * Detect ID3v2 Header.
43 * @param buf must be ID3v2_HEADER_SIZE byte long
44 * @param magic magic bytes to identify the header, machine byte order.
45 * If in doubt, use ID3v2_DEFAULT_MAGIC.
46 */
47 int ff_id3v2_match(const uint8_t *buf, const char *magic);
48
49 /**
50 * Get the length of an ID3v2 tag.
51 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
52 * already detected ID3v2 tag
53 */
54 int ff_id3v2_tag_len(const uint8_t *buf);
55
56 /**
57 * Read an ID3v2 tag
58 */
59 void ff_id3v2_read(AVFormatContext *s, const char *magic);
60
61 extern const AVMetadataConv ff_id3v2_metadata_conv[];
62
63 /**
64 * A list of ID3v2.4 text information frames.
65 * http://www.id3.org/id3v2.4.0-frames
66 */
67 extern const char ff_id3v2_tags[][4];
68
69 #endif /* AVFORMAT_ID3V2_H */