add multiple inclusion guards to headers
[libav.git] / libavcodec / xiph.h
1 /*
2 * Copyright (C) 2007 FFmpeg Project
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef AVCODEC_XIPH_H
22 #define AVCODEC_XIPH_H
23
24 #include "common.h"
25
26 /**
27 * Splits a single extradata buffer into the three headers that most
28 * Xiph codecs use. (e.g. Theora and Vorbis)
29 * Works both with Matroska's packing and lavc's packing.
30 *
31 * @param[in] extradata The single chunk that combines all three headers
32 * @param[in] extradata_size The size of the extradata buffer
33 * @param[in] first_header_size The size of the first header, used to
34 * differentiate between the Matroska packing and lavc packing.
35 * @param[out] header_start Pointers to the start of the three separate headers.
36 * @param[out] header_len The sizes of each of the three headers.
37 * @return On error a negative value is returned, on success zero.
38 */
39 int ff_split_xiph_headers(uint8_t *extradata, int extradata_size,
40 int first_header_size, uint8_t *header_start[3],
41 int header_len[3]);
42
43 #endif