FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vorbis_parser.h
Go to the documentation of this file.
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 #include <stdint.h>
31 
33 
34 /**
35  * Allocate and initialize the Vorbis parser using headers in the extradata.
36  *
37  * @param avctx codec context
38  * @param s Vorbis parser context
39  */
41  int extradata_size);
42 
43 /**
44  * Free the parser and everything associated with it.
45  */
47 
48 #define VORBIS_FLAG_HEADER 0x00000001
49 #define VORBIS_FLAG_COMMENT 0x00000002
50 #define VORBIS_FLAG_SETUP 0x00000004
51 
52 /**
53  * Get the duration for a Vorbis packet.
54  *
55  * If @p flags is @c NULL,
56  * special frames are considered invalid.
57  *
58  * @param s Vorbis parser context
59  * @param buf buffer containing a Vorbis frame
60  * @param buf_size size of the buffer
61  * @param flags flags for special frames
62  */
64  int buf_size, int *flags);
65 
66 /**
67  * Get the duration for a Vorbis packet.
68  *
69  * @param s Vorbis parser context
70  * @param buf buffer containing a Vorbis frame
71  * @param buf_size size of the buffer
72  */
74  int buf_size);
75 
77 
78 #endif /* AVCODEC_VORBIS_PARSE_H */