Merge/split side data.
[ffmpeg.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 enum ID3v2Encoding {
42     ID3v2_ENCODING_ISO8859  = 0,
43     ID3v2_ENCODING_UTF16BOM = 1,
44     ID3v2_ENCODING_UTF16BE  = 2,
45     ID3v2_ENCODING_UTF8     = 3,
46 };
47
48 /**
49  * Detect ID3v2 Header.
50  * @param buf   must be ID3v2_HEADER_SIZE byte long
51  * @param magic magic bytes to identify the header, machine byte order.
52  * If in doubt, use ID3v2_DEFAULT_MAGIC.
53  */
54 int ff_id3v2_match(const uint8_t *buf, const char *magic);
55
56 /**
57  * Get the length of an ID3v2 tag.
58  * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
59  * already detected ID3v2 tag
60  */
61 int ff_id3v2_tag_len(const uint8_t *buf);
62
63 /**
64  * Read an ID3v2 tag
65  */
66 void ff_id3v2_read(AVFormatContext *s, const char *magic);
67
68 extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
69 extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
70 extern const AVMetadataConv ff_id3v2_2_metadata_conv[];
71
72 /**
73  * A list of text information frames allowed in both ID3 v2.3 and v2.4
74  * http://www.id3.org/id3v2.4.0-frames
75  * http://www.id3.org/id3v2.4.0-changes
76  */
77 extern const char ff_id3v2_tags[][4];
78
79 /**
80  * ID3v2.4-only text information frames.
81  */
82 extern const char ff_id3v2_4_tags[][4];
83
84 /**
85  * ID3v2.3-only text information frames.
86  */
87 extern const char ff_id3v2_3_tags[][4];
88
89 #endif /* AVFORMAT_ID3V2_H */