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
43 ID3v2_ENCODING_ISO8859 = 0,
44 ID3v2_ENCODING_UTF16BOM = 1,
45 ID3v2_ENCODING_UTF16BE = 2,
46 ID3v2_ENCODING_UTF8 = 3,
49 typedef struct ID3v2EncContext {
50 int version; ///< ID3v2 minor version, either 3 or 4
51 int64_t size_pos; ///< offset of the tag total size
52 int len; ///< size of the tag written so far
55 typedef struct ID3v2ExtraMeta {
58 struct ID3v2ExtraMeta *next;
61 typedef struct ID3v2ExtraMetaGEOB {
69 typedef struct ID3v2ExtraMetaAPIC {
78 * Detect ID3v2 Header.
79 * @param buf must be ID3v2_HEADER_SIZE byte long
80 * @param magic magic bytes to identify the header.
81 * If in doubt, use ID3v2_DEFAULT_MAGIC.
83 int ff_id3v2_match(const uint8_t *buf, const char *magic);
86 * Get the length of an ID3v2 tag.
87 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
88 * already detected ID3v2 tag
90 int ff_id3v2_tag_len(const uint8_t *buf);
93 * Read an ID3v2 tag, including supported extra metadata
94 * @param extra_meta If not NULL, extra metadata is parsed into a list of
95 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
97 void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
100 * Initialize an ID3v2 tag.
102 void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
106 * Convert and write all global metadata from s into an ID3v2 tag.
108 int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3);
111 * Write an attached picture from pkt into an ID3v2 tag.
113 int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt);
116 * Finalize an opened ID3v2 tag.
118 void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb);
121 * Write an ID3v2 tag containing all global metadata from s.
122 * @param id3v2_version Subversion of ID3v2; supported values are 3 and 4
123 * @param magic magic bytes to identify the header
124 * If in doubt, use ID3v2_DEFAULT_MAGIC.
126 int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic);
129 * Free memory allocated parsing special (non-text) metadata.
130 * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL.
132 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
135 * Create a stream for each APIC (attached picture) extracted from the
138 int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta);
140 extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
141 extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
144 * A list of text information frames allowed in both ID3 v2.3 and v2.4
145 * http://www.id3.org/id3v2.4.0-frames
146 * http://www.id3.org/id3v2.4.0-changes
148 extern const char ff_id3v2_tags[][4];
151 * ID3v2.4-only text information frames.
153 extern const char ff_id3v2_4_tags[][4];
156 * ID3v2.3-only text information frames.
158 extern const char ff_id3v2_3_tags[][4];
160 extern const CodecMime ff_id3v2_mime_tags[];
162 extern const char *ff_id3v2_picture_types[21];
164 #endif /* AVFORMAT_ID3V2_H */