cosmetics: Drop empty comment lines
[ffmpeg.git] / libavcodec / vorbis_parser.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /**
20  * @file
21  * A public API for Vorbis parsing
22  *
23  * Determines the duration for each packet.
24  */
25
26 #ifndef AVCODEC_VORBIS_PARSE_H
27 #define AVCODEC_VORBIS_PARSE_H
28
29 #include <stdint.h>
30
31 typedef struct AVVorbisParseContext AVVorbisParseContext;
32
33 /**
34  * Allocate and initialize the Vorbis parser using headers in the extradata.
35  *
36  * @param avctx codec context
37  * @param s     Vorbis parser context
38  */
39 AVVorbisParseContext *av_vorbis_parse_init(const uint8_t *extradata,
40                                            int extradata_size);
41
42 /**
43  * Free the parser and everything associated with it.
44  */
45 void av_vorbis_parse_free(AVVorbisParseContext **s);
46
47 /**
48  * Get the duration for a Vorbis packet.
49  *
50  * @param s        Vorbis parser context
51  * @param buf      buffer containing a Vorbis frame
52  * @param buf_size size of the buffer
53  */
54 int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf,
55                           int buf_size);
56
57 void av_vorbis_parse_reset(AVVorbisParseContext *s);
58
59 #endif /* AVCODEC_VORBIS_PARSE_H */