8d7953d9b4c58ea59858d03212f403ded793e542
[ffmpeg.git] / libavcodec / dirac.h
1 /*
2  * Copyright (C) 2007 Marco Gerards <marco@gnu.org>
3  * Copyright (C) 2009 David Conrad
4  * Copyright (C) 2011 Jordi Ortiz
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef AVCODEC_DIRAC_H
24 #define AVCODEC_DIRAC_H
25
26 /**
27  * @file
28  * Interface to Dirac Decoder/Encoder
29  * @author Marco Gerards <marco@gnu.org>
30  * @author David Conrad
31  * @author Jordi Ortiz
32  */
33
34 #include "avcodec.h"
35
36 /**
37  * Parse code values:
38  *
39  * Dirac Specification ->
40  * 9.6.1  Table 9.1
41  *
42  * VC-2 Specification  ->
43  * 10.4.1 Table 10.1
44  */
45
46 enum DiracParseCodes {
47     DIRAC_PCODE_SEQ_HEADER      = 0x00,
48     DIRAC_PCODE_END_SEQ         = 0x10,
49     DIRAC_PCODE_AUX             = 0x20,
50     DIRAC_PCODE_PAD             = 0x30,
51     DIRAC_PCODE_PICTURE_CODED   = 0x08,
52     DIRAC_PCODE_PICTURE_RAW     = 0x48,
53     DIRAC_PCODE_PICTURE_LOW_DEL = 0xC8,
54     DIRAC_PCODE_PICTURE_HQ      = 0xE8,
55     DIRAC_PCODE_MAGIC           = 0x42424344,
56 };
57
58 typedef struct DiracVersionInfo {
59     int major;
60     int minor;
61 } DiracVersionInfo;
62
63 typedef struct AVDiracSeqHeader {
64     unsigned width;
65     unsigned height;
66     uint8_t chroma_format;          ///< 0: 444  1: 422  2: 420
67
68     uint8_t interlaced;
69     uint8_t top_field_first;
70
71     uint8_t frame_rate_index;       ///< index into dirac_frame_rate[]
72     uint8_t aspect_ratio_index;     ///< index into dirac_aspect_ratio[]
73
74     uint16_t clean_width;
75     uint16_t clean_height;
76     uint16_t clean_left_offset;
77     uint16_t clean_right_offset;
78
79     uint8_t pixel_range_index;      ///< index into dirac_pixel_range_presets[]
80     uint8_t color_spec_index;       ///< index into dirac_color_spec_presets[]
81
82     int profile;
83     int level;
84
85     AVRational framerate;
86     AVRational sample_aspect_ratio;
87
88     enum AVPixelFormat pix_fmt;
89     enum AVColorRange color_range;
90     enum AVColorPrimaries color_primaries;
91     enum AVColorTransferCharacteristic color_trc;
92     enum AVColorSpace colorspace;
93
94     DiracVersionInfo version;
95     int bit_depth;
96 } AVDiracSeqHeader;
97
98 /**
99  * Parse a Dirac sequence header.
100  *
101  * @param dsh this function will allocate and fill an AVDiracSeqHeader struct
102  *            and write it into this pointer. The caller must free it with
103  *            av_free().
104  * @param buf the data buffer
105  * @param buf_size the size of the data buffer in bytes
106  * @param log_ctx if non-NULL, this function will log errors here
107  * @return 0 on success, a negative AVERROR code on failure
108  */
109 int av_dirac_parse_sequence_header(AVDiracSeqHeader **dsh,
110                                    const uint8_t *buf, size_t buf_size,
111                                    void *log_ctx);
112
113 #endif /* AVCODEC_DIRAC_H */