3 * Copyright (c) 2003 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
22 #ifndef AVFORMAT_ID3V2_H
23 #define AVFORMAT_ID3V2_H
29 #define ID3v2_HEADER_SIZE 10
32 * Default magic bytes for ID3v2 header: "ID3"
34 #define ID3v2_DEFAULT_MAGIC "ID3"
36 #define ID3v2_FLAG_DATALEN 0x0001
37 #define ID3v2_FLAG_UNSYNCH 0x0002
38 #define ID3v2_FLAG_ENCRYPTION 0x0004
39 #define ID3v2_FLAG_COMPRESSION 0x0008
42 ID3v2_ENCODING_ISO8859 = 0,
43 ID3v2_ENCODING_UTF16BOM = 1,
44 ID3v2_ENCODING_UTF16BE = 2,
45 ID3v2_ENCODING_UTF8 = 3,
48 typedef struct ID3v2ExtraMeta {
51 struct ID3v2ExtraMeta *next;
54 typedef struct ID3v2ExtraMetaGEOB {
62 typedef struct ID3v2EMFunc {
65 void (*read)(AVFormatContext*, AVIOContext*, int, char*, ID3v2ExtraMeta **);
70 * Detect ID3v2 Header.
71 * @param buf must be ID3v2_HEADER_SIZE byte long
72 * @param magic magic bytes to identify the header, machine byte order.
73 * If in doubt, use ID3v2_DEFAULT_MAGIC.
75 int ff_id3v2_match(const uint8_t *buf, const char *magic);
78 * Get the length of an ID3v2 tag.
79 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
80 * already detected ID3v2 tag
82 int ff_id3v2_tag_len(const uint8_t *buf);
85 * Read an ID3v2 tag (text tags only)
87 void ff_id3v2_read(AVFormatContext *s, const char *magic);
90 * Read an ID3v2 tag, including supported extra metadata (currently only GEOB)
91 * @param extra_meta If not NULL, extra metadata is parsed into a list of
92 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
94 void ff_id3v2_read_all(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
97 * Free memory allocated parsing special (non-text) metadata.
98 * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL.
100 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
102 extern const ID3v2EMFunc ff_id3v2_extra_meta_funcs[];
104 extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
105 extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
106 extern const AVMetadataConv ff_id3v2_2_metadata_conv[];
109 * A list of text information frames allowed in both ID3 v2.3 and v2.4
110 * http://www.id3.org/id3v2.4.0-frames
111 * http://www.id3.org/id3v2.4.0-changes
113 extern const char ff_id3v2_tags[][4];
116 * ID3v2.4-only text information frames.
118 extern const char ff_id3v2_4_tags[][4];
121 * ID3v2.3-only text information frames.
123 extern const char ff_id3v2_3_tags[][4];
125 #endif /* AVFORMAT_ID3V2_H */