Libav
id3v2.h
Go to the documentation of this file.
1 /*
2  * ID3v2 header parser
3  * Copyright (c) 2003 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 
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 
47 };
48 
49 typedef struct ID3v2EncContext {
50  int version;
51  int64_t size_pos;
52  int len;
54 
55 typedef struct ID3v2ExtraMeta {
56  const char *tag;
57  void *data;
60 
61 typedef struct ID3v2ExtraMetaGEOB {
62  uint32_t datasize;
68 
69 typedef struct ID3v2ExtraMetaAPIC {
71  const char *type;
73  enum AVCodecID id;
75 
82 int ff_id3v2_match(const uint8_t *buf, const char *magic);
83 
89 int ff_id3v2_tag_len(const uint8_t *buf);
90 
96 void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
97 
101 void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
102  const char *magic);
103 
108 
113 
118 
125 int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic);
126 
131 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
132 
138 
141 
147 extern const char ff_id3v2_tags[][4];
148 
152 extern const char ff_id3v2_4_tags[][4];
153 
157 extern const char ff_id3v2_3_tags[][4];
158 
159 extern const CodecMime ff_id3v2_mime_tags[];
160 
161 extern const char *ff_id3v2_picture_types[21];
162 
163 #endif /* AVFORMAT_ID3V2_H */
const char ff_id3v2_tags[][4]
A list of text information frames allowed in both ID3 v2.3 and v2.4 http://www.id3.org/id3v2.4.0-frames http://www.id3.org/id3v2.4.0-changes.
Definition: id3v2.c:70
void * data
Definition: id3v2.h:57
Bytestream IO Context.
Definition: avio.h:68
int len
size of the tag written so far
Definition: id3v2.h:52
void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version, const char *magic)
Initialize an ID3v2 tag.
Definition: id3v2enc.c:112
int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic)
Write an ID3v2 tag containing all global metadata from s.
Definition: id3v2enc.c:231
int ff_id3v2_tag_len(const uint8_t *buf)
Get the length of an ID3v2 tag.
Definition: id3v2.c:138
uint32_t datasize
Definition: id3v2.h:62
const AVMetadataConv ff_id3v2_34_metadata_conv[]
Definition: id3v2.c:30
int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta)
Create a stream for each APIC (attached picture) extracted from the ID3v2 header. ...
Definition: id3v2.c:738
const char ff_id3v2_3_tags[][4]
ID3v2.3-only text information frames.
Definition: id3v2.c:84
Format I/O context.
Definition: avformat.h:871
ID3v2Encoding
Definition: id3v2.h:42
internal metadata API header see avformat.h or the public API!
uint8_t
const char ff_id3v2_4_tags[][4]
ID3v2.4-only text information frames.
Definition: id3v2.c:78
uint8_t * description
Definition: id3v2.h:65
const char * type
Definition: id3v2.h:71
uint8_t * data
Definition: id3v2.h:66
const CodecMime ff_id3v2_mime_tags[]
Definition: id3v2.c:113
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:105
const char * ff_id3v2_picture_types[21]
Definition: id3v2.c:89
void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb)
Finalize an opened ID3v2 tag.
Definition: id3v2enc.c:223
int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3)
Convert and write all global metadata from s into an ID3v2 tag.
Definition: id3v2enc.c:126
int64_t size_pos
offset of the tag total size
Definition: id3v2.h:51
const AVMetadataConv ff_id3v2_4_metadata_conv[]
Definition: id3v2.c:48
struct ID3v2ExtraMeta * next
Definition: id3v2.h:58
enum AVCodecID id
Definition: id3v2.h:73
uint8_t * description
Definition: id3v2.h:72
void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
Free memory allocated parsing special (non-text) metadata.
Definition: id3v2.c:724
void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta)
Read an ID3v2 tag, including supported extra metadata.
Definition: id3v2.c:692
int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt)
Write an attached picture from pkt into an ID3v2 tag.
Definition: id3v2enc.c:158
uint8_t * mime_type
Definition: id3v2.h:63
A reference to a data buffer.
Definition: buffer.h:81
Main libavformat public API header.
const char * tag
Definition: id3v2.h:56
uint8_t * file_name
Definition: id3v2.h:64
AVBufferRef * buf
Definition: id3v2.h:70
int ff_id3v2_match(const uint8_t *buf, const char *magic)
Detect ID3v2 Header.
Definition: id3v2.c:125
int version
ID3v2 minor version, either 3 or 4.
Definition: id3v2.h:50
This structure stores compressed data.
Definition: avcodec.h:950