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
30 #define ID3v2_HEADER_SIZE 10
33 * Default magic bytes for ID3v2 header: "ID3"
35 #define ID3v2_DEFAULT_MAGIC "ID3"
37 #define ID3v2_FLAG_DATALEN 0x0001
38 #define ID3v2_FLAG_UNSYNCH 0x0002
39 #define ID3v2_FLAG_ENCRYPTION 0x0004
40 #define ID3v2_FLAG_COMPRESSION 0x0008
42 #define ID3v2_PRIV_METADATA_PREFIX "id3v2_priv."
45 ID3v2_ENCODING_ISO8859 = 0,
46 ID3v2_ENCODING_UTF16BOM = 1,
47 ID3v2_ENCODING_UTF16BE = 2,
48 ID3v2_ENCODING_UTF8 = 3,
51 typedef struct ID3v2EncContext {
52 int version; ///< ID3v2 minor version, either 3 or 4
53 int64_t size_pos; ///< offset of the tag total size
54 int len; ///< size of the tag written so far
57 typedef struct ID3v2ExtraMeta {
60 struct ID3v2ExtraMeta *next;
63 typedef struct ID3v2ExtraMetaGEOB {
71 typedef struct ID3v2ExtraMetaAPIC {
78 typedef struct ID3v2ExtraMetaPRIV {
84 typedef struct ID3v2ExtraMetaCHAP {
91 * Detect ID3v2 Header.
92 * @param buf must be ID3v2_HEADER_SIZE byte long
93 * @param magic magic bytes to identify the header.
94 * If in doubt, use ID3v2_DEFAULT_MAGIC.
96 int ff_id3v2_match(const uint8_t *buf, const char *magic);
99 * Get the length of an ID3v2 tag.
100 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
101 * already detected ID3v2 tag
103 int ff_id3v2_tag_len(const uint8_t *buf);
106 * Read an ID3v2 tag into specified dictionary and retrieve supported extra metadata.
108 * @param metadata Parsed metadata is stored here
109 * @param extra_meta If not NULL, extra metadata is parsed into a list of
110 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
112 void ff_id3v2_read_dict(AVIOContext *pb, AVDictionary **metadata, const char *magic, ID3v2ExtraMeta **extra_meta);
115 * Read an ID3v2 tag, including supported extra metadata.
117 * Data is read from and stored to AVFormatContext.
119 * @param extra_meta If not NULL, extra metadata is parsed into a list of
120 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
121 * @param[opt] max_search_search restrict ID3 magic number search (bytes from start)
123 void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta,
124 unsigned int max_search_size);
127 * Initialize an ID3v2 tag.
129 void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
133 * Convert and write all global metadata from s into an ID3v2 tag.
135 int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3);
138 * Write an attached picture from pkt into an ID3v2 tag.
140 int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt);
143 * Finalize an opened ID3v2 tag.
145 void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb, int padding_bytes);
148 * Write an ID3v2 tag containing all global metadata from s.
149 * @param id3v2_version Subversion of ID3v2; supported values are 3 and 4
150 * @param magic magic bytes to identify the header
151 * If in doubt, use ID3v2_DEFAULT_MAGIC.
153 int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic);
156 * Free memory allocated parsing special (non-text) metadata.
157 * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL.
159 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
162 * Create a stream for each APIC (attached picture) extracted from the
165 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta);
168 * Create chapters for all CHAP tags found in the ID3v2 header.
170 int ff_id3v2_parse_chapters(AVFormatContext *s, ID3v2ExtraMeta **extra_meta);
173 * Parse PRIV tags into a dictionary. The PRIV owner is the metadata key. The
174 * PRIV data is the value, with non-printable characters escaped.
176 int ff_id3v2_parse_priv_dict(AVDictionary **d, ID3v2ExtraMeta **extra_meta);
179 * Add metadata for all PRIV tags in the ID3v2 header. The PRIV owner is the
180 * metadata key. The PRIV data is the value, with non-printable characters
183 int ff_id3v2_parse_priv(AVFormatContext *s, ID3v2ExtraMeta **extra_meta);
185 extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
186 extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
189 * A list of text information frames allowed in both ID3 v2.3 and v2.4
190 * http://www.id3.org/id3v2.4.0-frames
191 * http://www.id3.org/id3v2.4.0-changes
193 extern const char ff_id3v2_tags[][4];
196 * ID3v2.4-only text information frames.
198 extern const char ff_id3v2_4_tags[][4];
201 * ID3v2.3-only text information frames.
203 extern const char ff_id3v2_3_tags[][4];
205 extern const CodecMime ff_id3v2_mime_tags[];
207 extern const char * const ff_id3v2_picture_types[21];
209 #endif /* AVFORMAT_ID3V2_H */