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 "metadata.h"
28 
29 #define ID3v2_HEADER_SIZE 10
30 
34 #define ID3v2_DEFAULT_MAGIC "ID3"
35 
36 #define ID3v2_FLAG_DATALEN 0x0001
37 #define ID3v2_FLAG_UNSYNCH 0x0002
38 #define ID3v2_FLAG_ENCRYPTION 0x0004
39 #define ID3v2_FLAG_COMPRESSION 0x0008
40 
46 };
47 
48 typedef struct ID3v2ExtraMeta {
49  const char *tag;
50  void *data;
53 
54 typedef struct ID3v2ExtraMetaGEOB {
55  uint32_t datasize;
56  uint8_t *mime_type;
57  uint8_t *file_name;
58  uint8_t *description;
59  uint8_t *data;
61 
68 int ff_id3v2_match(const uint8_t *buf, const char *magic);
69 
75 int ff_id3v2_tag_len(const uint8_t *buf);
76 
80 void ff_id3v2_read(AVFormatContext *s, const char *magic);
81 
87 void ff_id3v2_read_all(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
88 
95 int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version, const char *magic);
96 
101 void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);
102 
105 
111 extern const char ff_id3v2_tags[][4];
112 
116 extern const char ff_id3v2_4_tags[][4];
117 
121 extern const char ff_id3v2_3_tags[][4];
122 
123 #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:50
int ff_id3v2_tag_len(const uint8_t *buf)
Get the length of an ID3v2 tag.
Definition: id3v2.c:102
uint32_t datasize
Definition: id3v2.h:55
const AVMetadataConv ff_id3v2_34_metadata_conv[]
Definition: id3v2.c:29
const char ff_id3v2_3_tags[][4]
ID3v2.3-only text information frames.
Definition: id3v2.c:84
Format I/O context.
Definition: avformat.h:863
ID3v2Encoding
Definition: id3v2.h:41
internal metadata API header see avformat.h or the public API!
struct ID3v2ExtraMetaGEOB ID3v2ExtraMetaGEOB
const char ff_id3v2_4_tags[][4]
ID3v2.4-only text information frames.
Definition: id3v2.c:78
uint8_t * description
Definition: id3v2.h:58
uint8_t * data
Definition: id3v2.h:59
void ff_id3v2_read(AVFormatContext *s, const char *magic)
Read an ID3v2 tag (text tags only)
Definition: id3v2.c:587
int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version, const char *magic)
Write an ID3v2 tag.
Definition: id3v2enc.c:100
const AVMetadataConv ff_id3v2_4_metadata_conv[]
Definition: id3v2.c:47
struct ID3v2ExtraMeta * next
Definition: id3v2.h:51
void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta)
Free memory allocated parsing special (non-text) metadata.
Definition: id3v2.c:592
struct ID3v2ExtraMeta ID3v2ExtraMeta
uint8_t * mime_type
Definition: id3v2.h:56
Main libavformat public API header.
const char * tag
Definition: id3v2.h:49
void ff_id3v2_read_all(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta)
Read an ID3v2 tag, including supported extra metadata (currently only GEOB)
Definition: id3v2.c:556
uint8_t * file_name
Definition: id3v2.h:57
int ff_id3v2_match(const uint8_t *buf, const char *magic)
Detect ID3v2 Header.
Definition: id3v2.c:89