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 "internal.h" 28#include "metadata.h" 29 30#define ID3v2_HEADER_SIZE 10 31 32/** 33 * Default magic bytes for ID3v2 header: "ID3" 34 */ 35#define ID3v2_DEFAULT_MAGIC "ID3" 36 37#define ID3v2_FLAG_DATALEN 0x0001 38#define ID3v2_FLAG_UNSYNCH 0x0002 39#define ID3v2_FLAG_ENCRYPTION 0x0004 40#define ID3v2_FLAG_COMPRESSION 0x0008 41 42#define ID3v2_PRIV_METADATA_PREFIX "id3v2_priv." 43 44enum ID3v2Encoding { 45 ID3v2_ENCODING_ISO8859 = 0, 46 ID3v2_ENCODING_UTF16BOM = 1, 47 ID3v2_ENCODING_UTF16BE = 2, 48 ID3v2_ENCODING_UTF8 = 3, 49}; 50 51typedef 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 55} ID3v2EncContext; 56 57typedef struct ID3v2ExtraMetaGEOB { 58 uint32_t datasize; 59 uint8_t *mime_type; 60 uint8_t *file_name; 61 uint8_t *description; 62 uint8_t *data; 63} ID3v2ExtraMetaGEOB; 64 65typedef struct ID3v2ExtraMetaAPIC { 66 AVBufferRef *buf; 67 const char *type; 68 uint8_t *description; 69 enum AVCodecID id; 70} ID3v2ExtraMetaAPIC; 71 72typedef struct ID3v2ExtraMetaPRIV { 73 uint8_t *owner; 74 uint8_t *data; 75 uint32_t datasize; 76} ID3v2ExtraMetaPRIV; 77 78typedef struct ID3v2ExtraMetaCHAP { 79 uint8_t *element_id; 80 uint32_t start, end; 81 AVDictionary *meta; 82} ID3v2ExtraMetaCHAP; 83 84typedef struct ID3v2ExtraMeta { 85 const char *tag; 86 struct ID3v2ExtraMeta *next; 87 union { 88 ID3v2ExtraMetaAPIC apic; 89 ID3v2ExtraMetaCHAP chap; 90 ID3v2ExtraMetaGEOB geob; 91 ID3v2ExtraMetaPRIV priv; 92 } data; 93} ID3v2ExtraMeta; 94 95/** 96 * Detect ID3v2 Header. 97 * @param buf must be ID3v2_HEADER_SIZE byte long 98 * @param magic magic bytes to identify the header. 99 * If in doubt, use ID3v2_DEFAULT_MAGIC. 100 */ 101int ff_id3v2_match(const uint8_t *buf, const char *magic); 102 103/** 104 * Get the length of an ID3v2 tag. 105 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an 106 * already detected ID3v2 tag 107 */ 108int ff_id3v2_tag_len(const uint8_t *buf); 109 110/** 111 * Read an ID3v2 tag into specified dictionary and retrieve supported extra metadata. 112 * 113 * @param metadata Parsed metadata is stored here 114 * @param[out] extra_meta If not NULL, extra metadata is parsed into a list of 115 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list 116 */ 117void ff_id3v2_read_dict(AVIOContext *pb, AVDictionary **metadata, const char *magic, ID3v2ExtraMeta **extra_meta); 118 119/** 120 * Read an ID3v2 tag, including supported extra metadata. 121 * 122 * Data is read from and stored to AVFormatContext. 123 * 124 * @param[out] extra_meta If not NULL, extra metadata is parsed into a list of 125 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list 126 * @param[opt] max_search_search restrict ID3 magic number search (bytes from start) 127 */ 128void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta, 129 unsigned int max_search_size); 130 131/** 132 * Initialize an ID3v2 tag. 133 */ 134void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version, 135 const char *magic); 136 137/** 138 * Convert and write all global metadata from s into an ID3v2 tag. 139 */ 140int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3); 141 142/** 143 * Write an attached picture from pkt into an ID3v2 tag. 144 */ 145int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt); 146 147/** 148 * Finalize an opened ID3v2 tag. 149 */ 150void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb, int padding_bytes); 151 152/** 153 * Write an ID3v2 tag containing all global metadata from s. 154 * @param id3v2_version Subversion of ID3v2; supported values are 3 and 4 155 * @param magic magic bytes to identify the header 156 * If in doubt, use ID3v2_DEFAULT_MAGIC. 157 */ 158int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic); 159 160/** 161 * Free memory allocated parsing special (non-text) metadata. 162 * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL. 163 */ 164void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta); 165 166/** 167 * Create a stream for each APIC (attached picture) extracted from the 168 * ID3v2 header. 169 */ 170int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta *extra_meta); 171 172/** 173 * Create chapters for all CHAP tags found in the ID3v2 header. 174 */ 175int ff_id3v2_parse_chapters(AVFormatContext *s, ID3v2ExtraMeta *extra_meta); 176 177/** 178 * Parse PRIV tags into a dictionary. The PRIV owner is the metadata key. The 179 * PRIV data is the value, with non-printable characters escaped. 180 */ 181int ff_id3v2_parse_priv_dict(AVDictionary **d, ID3v2ExtraMeta *extra_meta); 182 183/** 184 * Add metadata for all PRIV tags in the ID3v2 header. The PRIV owner is the 185 * metadata key. The PRIV data is the value, with non-printable characters 186 * escaped. 187 */ 188int ff_id3v2_parse_priv(AVFormatContext *s, ID3v2ExtraMeta *extra_meta); 189 190extern const AVMetadataConv ff_id3v2_34_metadata_conv[]; 191extern const AVMetadataConv ff_id3v2_4_metadata_conv[]; 192 193/** 194 * A list of text information frames allowed in both ID3 v2.3 and v2.4 195 * http://www.id3.org/id3v2.4.0-frames 196 * http://www.id3.org/id3v2.4.0-changes 197 */ 198extern const char ff_id3v2_tags[][4]; 199 200/** 201 * ID3v2.4-only text information frames. 202 */ 203extern const char ff_id3v2_4_tags[][4]; 204 205/** 206 * ID3v2.3-only text information frames. 207 */ 208extern const char ff_id3v2_3_tags[][4]; 209 210extern const CodecMime ff_id3v2_mime_tags[]; 211 212extern const char * const ff_id3v2_picture_types[21]; 213 214#endif /* AVFORMAT_ID3V2_H */ 215