Add a function to parse Dirac's sequence header
[ffmpeg.git] / libavcodec / dirac.h
1 /*
2  * Copyright (C) 2007 Marco Gerards <marco@gnu.org>
3  * Copyright (C) 2009 David Conrad
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_DIRAC_H
23 #define AVCODEC_DIRAC_H
24
25 /**
26  * @file libavcodec/dirac.h
27  * Interfaces to Dirac Decoder/Encoder
28  * @author Marco Gerards <marco@gnu.org>
29  */
30
31 #include "avcodec.h"
32 #include "get_bits.h"
33
34 typedef struct {
35     unsigned width;
36     unsigned height;
37     uint8_t chroma_format;          ///< 0: 444  1: 422  2: 420
38
39     uint8_t interlaced;
40     uint8_t top_field_first;
41
42     uint8_t frame_rate_index;       ///< index into dirac_frame_rate[]
43     uint8_t aspect_ratio_index;     ///< index into dirac_aspect_ratio[]
44
45     uint16_t clean_width;
46     uint16_t clean_height;
47     uint16_t clean_left_offset;
48     uint16_t clean_right_offset;
49
50     uint8_t pixel_range_index;      ///< index into dirac_pixel_range_presets[]
51     uint8_t color_spec_index;       ///< index into dirac_color_spec_presets[]
52 } dirac_source_params;
53
54 int ff_dirac_parse_sequence_header(AVCodecContext *avctx, GetBitContext *gb,
55                                    dirac_source_params *source);
56
57 #endif /* AVCODEC_DIRAC_H */