Fix grammar errors in documentation
[ffmpeg.git] / libavformat / id3v2.h
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 "metadata.h"
28
29 #define ID3v2_HEADER_SIZE 10
30
31 /**
32  * Default magic bytes for ID3v2 header: "ID3"
33  */
34 #define ID3v2_DEFAULT_MAGIC "ID3"
35
36 /**
37  * Detect ID3v2 Header.
38  * @buf   must be ID3v2_HEADER_SIZE byte long
39  * @magic magic bytes to identify the header, machine byte order.
40  * If in doubt, use ID3v2_DEFAULT_MAGIC.
41  */
42 int ff_id3v2_match(const uint8_t *buf, const char *magic);
43
44 /**
45  * Get the length of an ID3v2 tag.
46  * @buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
47  * already detected ID3v2 tag
48  */
49 int ff_id3v2_tag_len(const uint8_t *buf);
50
51 /**
52  * ID3v2 parser
53  * Handles ID3v2.2, 2.3 and 2.4.
54  */
55 void ff_id3v2_parse(AVFormatContext *s, int len, uint8_t version, uint8_t flags);
56
57 /**
58  * Read an ID3v2 tag
59  */
60 void ff_id3v2_read(AVFormatContext *s, const char *magic);
61
62 extern const AVMetadataConv ff_id3v2_metadata_conv[];
63
64 /**
65  * A list of ID3v2.4 text information frames.
66  * http://www.id3.org/id3v2.4.0-frames
67  */
68 extern const char ff_id3v2_tags[][4];
69
70 #endif /* AVFORMAT_ID3V2_H */