id3v2: read attached pictures and export them in ID3v2ExtraMeta.
[ffmpeg.git] / libavformat / id3v2.h
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
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 enum ID3v2Encoding {
43     ID3v2_ENCODING_ISO8859  = 0,
44     ID3v2_ENCODING_UTF16BOM = 1,
45     ID3v2_ENCODING_UTF16BE  = 2,
46     ID3v2_ENCODING_UTF8     = 3,
47 };
48
49 typedef struct ID3v2ExtraMeta {
50     const char *tag;
51     void *data;
52     struct ID3v2ExtraMeta *next;
53 } ID3v2ExtraMeta;
54
55 typedef struct ID3v2ExtraMetaGEOB {
56     uint32_t datasize;
57     uint8_t *mime_type;
58     uint8_t *file_name;
59     uint8_t *description;
60     uint8_t *data;
61 } ID3v2ExtraMetaGEOB;
62
63 typedef struct ID3v2ExtraMetaAPIC {
64     uint8_t     *data;
65     int          len;
66     const char  *type;
67     uint8_t     *description;
68     enum CodecID id;
69 } ID3v2ExtraMetaAPIC;
70
71 /**
72  * Detect ID3v2 Header.
73  * @param buf   must be ID3v2_HEADER_SIZE byte long
74  * @param magic magic bytes to identify the header.
75  * If in doubt, use ID3v2_DEFAULT_MAGIC.
76  */
77 int ff_id3v2_match(const uint8_t *buf, const char *magic);
78
79 /**
80  * Get the length of an ID3v2 tag.
81  * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
82  * already detected ID3v2 tag
83  */
84 int ff_id3v2_tag_len(const uint8_t *buf);
85
86 /**
87  * Read an ID3v2 tag (text tags only)
88  */
89 void ff_id3v2_read(AVFormatContext *s, const char *magic);
90
91 /**
92  * Read an ID3v2 tag, including supported extra metadata (currently only GEOB)
93  * @param extra_meta If not NULL, extra metadata is parsed into a list of
94  * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
95  */
96 void ff_id3v2_read_all(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
97
98 /**
99  * Write an ID3v2 tag.
100  * @param id3v2_version Subversion of ID3v2; supported values are 3 and 4
101  * @param magic magic bytes to identify the header
102  * If in doubt, use ID3v2_DEFAULT_MAGIC.
103  */
104 int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version, const char *magic);
105
106 /**
107  * Free memory allocated parsing special (non-text) metadata.
108  * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL.
109  */
110 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
111
112 extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
113 extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
114
115 /**
116  * A list of text information frames allowed in both ID3 v2.3 and v2.4
117  * http://www.id3.org/id3v2.4.0-frames
118  * http://www.id3.org/id3v2.4.0-changes
119  */
120 extern const char ff_id3v2_tags[][4];
121
122 /**
123  * ID3v2.4-only text information frames.
124  */
125 extern const char ff_id3v2_4_tags[][4];
126
127 /**
128  * ID3v2.3-only text information frames.
129  */
130 extern const char ff_id3v2_3_tags[][4];
131
132 extern const CodecMime ff_id3v2_mime_tags[];
133
134 extern const char *ff_id3v2_picture_types[21];
135
136 #endif /* AVFORMAT_ID3V2_H */