4af60cf827b80188ccd63ba47b88d719ced97666
[ffmpeg.git] / libavcodec / vorbis_parser.h
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * A public API for Vorbis parsing
23  *
24  * Determines the duration for each packet.
25  */
26
27 #ifndef AVCODEC_VORBIS_PARSE_H
28 #define AVCODEC_VORBIS_PARSE_H
29
30 typedef struct AVVorbisParseContext AVVorbisParseContext;
31
32 /**
33  * Allocate and initialize the Vorbis parser using headers in the extradata.
34  *
35  * @param avctx codec context
36  * @param s     Vorbis parser context
37  */
38 AVVorbisParseContext *av_vorbis_parse_init(const uint8_t *extradata,
39                                            int extradata_size);
40
41 /**
42  * Free the parser and everything associated with it.
43  */
44 void av_vorbis_parse_free(AVVorbisParseContext **s);
45
46 #define VORBIS_FLAG_HEADER  0x00000001
47 #define VORBIS_FLAG_COMMENT 0x00000002
48
49 /**
50  * Get the duration for a Vorbis packet.
51  *
52  * avpriv_vorbis_parse_extradata() must have been successfully called prior to
53  * this in order for a correct duration to be returned. If @p flags is @c NULL,
54  * special frames are considered invalid.
55  *
56  * @param s        Vorbis parser context
57  * @param buf      buffer containing a Vorbis frame
58  * @param buf_size size of the buffer
59  * @param flags    flags for special frames
60  */
61 int avpriv_vorbis_parse_frame_flags(AVVorbisParseContext *s, const uint8_t *buf,
62                                     int buf_size, int *flags);
63
64 /**
65  * Get the duration for a Vorbis packet.
66  *
67  * @param s        Vorbis parser context
68  * @param buf      buffer containing a Vorbis frame
69  * @param buf_size size of the buffer
70  */
71 int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf,
72                           int buf_size);
73
74 void av_vorbis_parse_reset(AVVorbisParseContext *s);
75
76 #endif /* AVCODEC_VORBIS_PARSE_H */