summaryrefslogtreecommitdiff
path: root/libavcodec/vorbis_parser.h (plain)
blob: 92050277ed193dc319d6c03f84bdad4fa46169dc
1/*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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_PARSER_H
27#define AVCODEC_VORBIS_PARSER_H
28
29#include <stdint.h>
30
31typedef 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 */
39AVVorbisParseContext *av_vorbis_parse_init(const uint8_t *extradata,
40 int extradata_size);
41
42/**
43 * Free the parser and everything associated with it.
44 */
45void av_vorbis_parse_free(AVVorbisParseContext **s);
46
47#define VORBIS_FLAG_HEADER 0x00000001
48#define VORBIS_FLAG_COMMENT 0x00000002
49#define VORBIS_FLAG_SETUP 0x00000004
50
51/**
52 * Get the duration for a Vorbis packet.
53 *
54 * If @p flags is @c NULL,
55 * special frames are considered invalid.
56 *
57 * @param s Vorbis parser context
58 * @param buf buffer containing a Vorbis frame
59 * @param buf_size size of the buffer
60 * @param flags flags for special frames
61 */
62int av_vorbis_parse_frame_flags(AVVorbisParseContext *s, const uint8_t *buf,
63 int buf_size, int *flags);
64
65/**
66 * Get the duration for a Vorbis packet.
67 *
68 * @param s Vorbis parser context
69 * @param buf buffer containing a Vorbis frame
70 * @param buf_size size of the buffer
71 */
72int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf,
73 int buf_size);
74
75void av_vorbis_parse_reset(AVVorbisParseContext *s);
76
77#endif /* AVCODEC_VORBIS_PARSER_H */
78