summaryrefslogtreecommitdiff
path: root/libavcodec/dirac.h (plain)
blob: e6d9d346d9cc13c23092f5e1f4501d20157e1def
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 * The spec limits the number of wavelet decompositions to 4 for both
38 * level 1 (VC-2) and 128 (long-gop default).
39 * 5 decompositions is the maximum before >16-bit buffers are needed.
40 * Schroedinger allows this for DD 9,7 and 13,7 wavelets only, limiting
41 * the others to 4 decompositions (or 3 for the fidelity filter).
42 *
43 * We use this instead of MAX_DECOMPOSITIONS to save some memory.
44 */
45#define MAX_DWT_LEVELS 5
46
47/**
48 * Parse code values:
49 *
50 * Dirac Specification ->
51 * 9.6.1 Table 9.1
52 *
53 * VC-2 Specification ->
54 * 10.4.1 Table 10.1
55 */
56
57enum DiracParseCodes {
58 DIRAC_PCODE_SEQ_HEADER = 0x00,
59 DIRAC_PCODE_END_SEQ = 0x10,
60 DIRAC_PCODE_AUX = 0x20,
61 DIRAC_PCODE_PAD = 0x30,
62 DIRAC_PCODE_PICTURE_CODED = 0x08,
63 DIRAC_PCODE_PICTURE_RAW = 0x48,
64 DIRAC_PCODE_PICTURE_LOW_DEL = 0xC8,
65 DIRAC_PCODE_PICTURE_HQ = 0xE8,
66 DIRAC_PCODE_INTER_NOREF_CO1 = 0x0A,
67 DIRAC_PCODE_INTER_NOREF_CO2 = 0x09,
68 DIRAC_PCODE_INTER_REF_CO1 = 0x0D,
69 DIRAC_PCODE_INTER_REF_CO2 = 0x0E,
70 DIRAC_PCODE_INTRA_REF_CO = 0x0C,
71 DIRAC_PCODE_INTRA_REF_RAW = 0x4C,
72 DIRAC_PCODE_INTRA_REF_PICT = 0xCC,
73 DIRAC_PCODE_MAGIC = 0x42424344,
74};
75
76typedef struct DiracVersionInfo {
77 int major;
78 int minor;
79} DiracVersionInfo;
80
81typedef struct AVDiracSeqHeader {
82 unsigned width;
83 unsigned height;
84 uint8_t chroma_format; ///< 0: 444 1: 422 2: 420
85
86 uint8_t interlaced;
87 uint8_t top_field_first;
88
89 uint8_t frame_rate_index; ///< index into dirac_frame_rate[]
90 uint8_t aspect_ratio_index; ///< index into dirac_aspect_ratio[]
91
92 uint16_t clean_width;
93 uint16_t clean_height;
94 uint16_t clean_left_offset;
95 uint16_t clean_right_offset;
96
97 uint8_t pixel_range_index; ///< index into dirac_pixel_range_presets[]
98 uint8_t color_spec_index; ///< index into dirac_color_spec_presets[]
99
100 int profile;
101 int level;
102
103 AVRational framerate;
104 AVRational sample_aspect_ratio;
105
106 enum AVPixelFormat pix_fmt;
107 enum AVColorRange color_range;
108 enum AVColorPrimaries color_primaries;
109 enum AVColorTransferCharacteristic color_trc;
110 enum AVColorSpace colorspace;
111
112 DiracVersionInfo version;
113 int bit_depth;
114} AVDiracSeqHeader;
115
116/**
117 * Parse a Dirac sequence header.
118 *
119 * @param dsh this function will allocate and fill an AVDiracSeqHeader struct
120 * and write it into this pointer. The caller must free it with
121 * av_free().
122 * @param buf the data buffer
123 * @param buf_size the size of the data buffer in bytes
124 * @param log_ctx if non-NULL, this function will log errors here
125 * @return 0 on success, a negative AVERROR code on failure
126 */
127int av_dirac_parse_sequence_header(AVDiracSeqHeader **dsh,
128 const uint8_t *buf, size_t buf_size,
129 void *log_ctx);
130
131#endif /* AVCODEC_DIRAC_H */
132