lavc: deprecate the use of AVCodecContext.time_base for decoding
[ffmpeg.git] / libavcodec / dirac.c
1 /*
2  * Copyright (C) 2007 Marco Gerards <marco@gnu.org>
3  * Copyright (C) 2009 David Conrad
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Dirac Decoder
25  * @author Marco Gerards <marco@gnu.org>
26  */
27
28 #include "libavutil/imgutils.h"
29
30 #include "avcodec.h"
31 #include "dirac.h"
32 #include "golomb.h"
33 #include "internal.h"
34 #include "mpeg12data.h"
35
36 // defaults for source parameters
37 static const dirac_source_params dirac_source_parameters_defaults[] = {
38     {  640,  480, 2, 0, 0,  1, 1,  640,  480, 0, 0, 1, 0 },
39     {  176,  120, 2, 0, 0,  9, 2,  176,  120, 0, 0, 1, 1 },
40     {  176,  144, 2, 0, 1, 10, 3,  176,  144, 0, 0, 1, 2 },
41     {  352,  240, 2, 0, 0,  9, 2,  352,  240, 0, 0, 1, 1 },
42     {  352,  288, 2, 0, 1, 10, 3,  352,  288, 0, 0, 1, 2 },
43     {  704,  480, 2, 0, 0,  9, 2,  704,  480, 0, 0, 1, 1 },
44     {  704,  576, 2, 0, 1, 10, 3,  704,  576, 0, 0, 1, 2 },
45     {  720,  480, 1, 1, 0,  4, 2,  704,  480, 8, 0, 3, 1 },
46     {  720,  576, 1, 1, 1,  3, 3,  704,  576, 8, 0, 3, 2 },
47
48     { 1280,  720, 1, 0, 1,  7, 1, 1280,  720, 0, 0, 3, 3 },
49     { 1280,  720, 1, 0, 1,  6, 1, 1280,  720, 0, 0, 3, 3 },
50     { 1920, 1080, 1, 1, 1,  4, 1, 1920, 1080, 0, 0, 3, 3 },
51     { 1920, 1080, 1, 1, 1,  3, 1, 1920, 1080, 0, 0, 3, 3 },
52     { 1920, 1080, 1, 0, 1,  7, 1, 1920, 1080, 0, 0, 3, 3 },
53     { 1920, 1080, 1, 0, 1,  6, 1, 1920, 1080, 0, 0, 3, 3 },
54     { 2048, 1080, 0, 0, 1,  2, 1, 2048, 1080, 0, 0, 4, 4 },
55     { 4096, 2160, 0, 0, 1,  2, 1, 4096, 2160, 0, 0, 4, 4 },
56
57     { 3840, 2160, 1, 0, 1,  7, 1, 3840, 2160, 0, 0, 3, 3 },
58     { 3840, 2160, 1, 0, 1,  6, 1, 3840, 2160, 0, 0, 3, 3 },
59     { 7680, 4320, 1, 0, 1,  7, 1, 3840, 2160, 0, 0, 3, 3 },
60     { 7680, 4320, 1, 0, 1,  6, 1, 3840, 2160, 0, 0, 3, 3 },
61 };
62
63 /* [DIRAC_STD] Table 10.4 - Available preset pixel aspect ratio values */
64 static const AVRational dirac_preset_aspect_ratios[] = {
65     {  1,  1 },
66     { 10, 11 },
67     { 12, 11 },
68     { 40, 33 },
69     { 16, 11 },
70     {  4,  3 },
71 };
72
73 /* [DIRAC_STD] Values 9,10 of 10.3.5 Frame Rate.
74  * Table 10.3 Available preset frame rate values
75  */
76 static const AVRational dirac_frame_rate[] = {
77     { 15000, 1001 },
78     {    25,    2 },
79 };
80
81 /* [DIRAC_STD] This should be equivalent to Table 10.5 Available signal
82  * range presets */
83 static const struct {
84     uint8_t             bitdepth;
85     enum AVColorRange   color_range;
86 } pixel_range_presets[] = {
87     {  8, AVCOL_RANGE_JPEG },
88     {  8, AVCOL_RANGE_MPEG },
89     { 10, AVCOL_RANGE_MPEG },
90     { 12, AVCOL_RANGE_MPEG },
91 };
92
93 static const enum AVColorPrimaries dirac_primaries[] = {
94     AVCOL_PRI_BT709,
95     AVCOL_PRI_SMPTE170M,
96     AVCOL_PRI_BT470BG,
97 };
98
99 static const struct {
100     enum AVColorPrimaries color_primaries;
101     enum AVColorSpace colorspace;
102     enum AVColorTransferCharacteristic color_trc;
103 } dirac_color_presets[] = {
104     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_BT709 },
105     { AVCOL_PRI_SMPTE170M, AVCOL_SPC_BT470BG, AVCOL_TRC_BT709 },
106     { AVCOL_PRI_BT470BG,   AVCOL_SPC_BT470BG, AVCOL_TRC_BT709 },
107     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_BT709 },
108     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_UNSPECIFIED /* DCinema */ },
109 };
110
111 /* [DIRAC_STD] Table 10.2 Supported chroma sampling formats + luma Offset */
112 static const enum AVPixelFormat dirac_pix_fmt[2][3] = {
113     { AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P  },
114     { AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P },
115 };
116
117 /* [DIRAC_STD] 10.3 Parse Source Parameters.
118  * source_parameters(base_video_format) */
119 static int parse_source_parameters(AVCodecContext *avctx, GetBitContext *gb,
120                                    dirac_source_params *source)
121 {
122     AVRational frame_rate = { 0, 0 };
123     unsigned luma_depth = 8, luma_offset = 16;
124     int idx;
125
126     /* [DIRAC_STD] 10.3.2 Frame size. frame_size(video_params) */
127     /* [DIRAC_STD] custom_dimensions_flag */
128     if (get_bits1(gb)) {
129         source->width  = svq3_get_ue_golomb(gb); /* [DIRAC_STD] FRAME_WIDTH  */
130         source->height = svq3_get_ue_golomb(gb); /* [DIRAC_STD] FRAME_HEIGHT */
131     }
132
133     /* [DIRAC_STD] 10.3.3 Chroma Sampling Format.
134      *  chroma_sampling_format(video_params) */
135     /* [DIRAC_STD] custom_chroma_format_flag */
136     if (get_bits1(gb))
137         /* [DIRAC_STD] CHROMA_FORMAT_INDEX */
138         source->chroma_format = svq3_get_ue_golomb(gb);
139     if (source->chroma_format > 2) {
140         av_log(avctx, AV_LOG_ERROR, "Unknown chroma format %d\n",
141                source->chroma_format);
142         return AVERROR_INVALIDDATA;
143     }
144
145     /* [DIRAC_STD] 10.3.4 Scan Format. scan_format(video_params) */
146     /* [DIRAC_STD] custom_scan_format_flag */
147     if (get_bits1(gb))
148         /* [DIRAC_STD] SOURCE_SAMPLING */
149         source->interlaced = svq3_get_ue_golomb(gb);
150     if (source->interlaced > 1)
151         return AVERROR_INVALIDDATA;
152
153     /* [DIRAC_STD] 10.3.5 Frame Rate. frame_rate(video_params) */
154     if (get_bits1(gb)) { /* [DIRAC_STD] custom_frame_rate_flag */
155         source->frame_rate_index = svq3_get_ue_golomb(gb);
156
157         if (source->frame_rate_index > 10)
158             return AVERROR_INVALIDDATA;
159
160         if (!source->frame_rate_index) {
161             /* [DIRAC_STD] FRAME_RATE_NUMER */
162             frame_rate.num = svq3_get_ue_golomb(gb);
163             /* [DIRAC_STD] FRAME_RATE_DENOM */
164             frame_rate.den = svq3_get_ue_golomb(gb);
165         }
166     }
167     /* [DIRAC_STD] preset_frame_rate(video_params, index) */
168     if (source->frame_rate_index > 0) {
169         if (source->frame_rate_index <= 8)
170             frame_rate = ff_mpeg12_frame_rate_tab[source->frame_rate_index];
171         else
172             /* [DIRAC_STD] Table 10.3 values 9-10 */
173             frame_rate = dirac_frame_rate[source->frame_rate_index - 9];
174     }
175     avctx->framerate = frame_rate;
176
177     /* [DIRAC_STD] 10.3.6 Pixel Aspect Ratio.
178      * pixel_aspect_ratio(video_params) */
179     if (get_bits1(gb)) { /* [DIRAC_STD] custom_pixel_aspect_ratio_flag */
180         /* [DIRAC_STD] index */
181         source->aspect_ratio_index = svq3_get_ue_golomb(gb);
182
183         if (source->aspect_ratio_index > 6)
184             return AVERROR_INVALIDDATA;
185
186         if (!source->aspect_ratio_index) {
187             avctx->sample_aspect_ratio.num = svq3_get_ue_golomb(gb);
188             avctx->sample_aspect_ratio.den = svq3_get_ue_golomb(gb);
189         }
190     }
191     /* [DIRAC_STD] Take value from Table 10.4 Available preset pixel
192      *  aspect ratio values */
193     if (source->aspect_ratio_index > 0)
194         avctx->sample_aspect_ratio =
195             dirac_preset_aspect_ratios[source->aspect_ratio_index - 1];
196
197     /* [DIRAC_STD] 10.3.7 Clean area. clean_area(video_params) */
198     if (get_bits1(gb)) { /* [DIRAC_STD] custom_clean_area_flag */
199         /* [DIRAC_STD] CLEAN_WIDTH */
200         source->clean_width = svq3_get_ue_golomb(gb);
201         /* [DIRAC_STD] CLEAN_HEIGHT */
202         source->clean_height = svq3_get_ue_golomb(gb);
203         /* [DIRAC_STD] CLEAN_LEFT_OFFSET */
204         source->clean_left_offset = svq3_get_ue_golomb(gb);
205         /* [DIRAC_STD] CLEAN_RIGHT_OFFSET */
206         source->clean_right_offset = svq3_get_ue_golomb(gb);
207     }
208
209     /* [DIRAC_STD] 10.3.8 Signal range. signal_range(video_params)
210      * WARNING: Some adaptation seems to be done using the
211      * AVCOL_RANGE_MPEG/JPEG values */
212     if (get_bits1(gb)) { /* [DIRAC_STD] custom_signal_range_flag */
213         /* [DIRAC_STD] index */
214         source->pixel_range_index = svq3_get_ue_golomb(gb);
215
216         if (source->pixel_range_index > 4)
217             return AVERROR_INVALIDDATA;
218
219         // This assumes either fullrange or MPEG levels only
220         if (!source->pixel_range_index) {
221             luma_offset = svq3_get_ue_golomb(gb);
222             luma_depth  = av_log2(svq3_get_ue_golomb(gb)) + 1;
223             svq3_get_ue_golomb(gb); /* chroma offset    */
224             svq3_get_ue_golomb(gb); /* chroma excursion */
225             avctx->color_range = luma_offset ? AVCOL_RANGE_MPEG
226                                              : AVCOL_RANGE_JPEG;
227         }
228     }
229     /* [DIRAC_STD] Table 10.5
230      * Available signal range presets <--> pixel_range_presets */
231     if (source->pixel_range_index > 0) {
232         idx                = source->pixel_range_index - 1;
233         luma_depth         = pixel_range_presets[idx].bitdepth;
234         avctx->color_range = pixel_range_presets[idx].color_range;
235     }
236
237     if (luma_depth > 8)
238         av_log(avctx, AV_LOG_WARNING, "Bitdepth greater than 8");
239
240     avctx->pix_fmt = dirac_pix_fmt[!luma_offset][source->chroma_format];
241
242     /* [DIRAC_STD] 10.3.9 Colour specification. colour_spec(video_params) */
243     if (get_bits1(gb)) { /* [DIRAC_STD] custom_colour_spec_flag */
244         /* [DIRAC_STD] index */
245         idx = source->color_spec_index = svq3_get_ue_golomb(gb);
246
247         if (source->color_spec_index > 4)
248             return AVERROR_INVALIDDATA;
249
250         avctx->color_primaries = dirac_color_presets[idx].color_primaries;
251         avctx->colorspace      = dirac_color_presets[idx].colorspace;
252         avctx->color_trc       = dirac_color_presets[idx].color_trc;
253
254         if (!source->color_spec_index) {
255             /* [DIRAC_STD] 10.3.9.1 Colour primaries */
256             if (get_bits1(gb)) {
257                 idx = svq3_get_ue_golomb(gb);
258                 if (idx < 3)
259                     avctx->color_primaries = dirac_primaries[idx];
260             }
261             /* [DIRAC_STD] 10.3.9.2 Colour matrix */
262             if (get_bits1(gb)) {
263                 idx = svq3_get_ue_golomb(gb);
264                 if (!idx)
265                     avctx->colorspace = AVCOL_SPC_BT709;
266                 else if (idx == 1)
267                     avctx->colorspace = AVCOL_SPC_BT470BG;
268             }
269             /* [DIRAC_STD] 10.3.9.3 Transfer function */
270             if (get_bits1(gb) && !svq3_get_ue_golomb(gb))
271                 avctx->color_trc = AVCOL_TRC_BT709;
272         }
273     } else {
274         idx                    = source->color_spec_index;
275         avctx->color_primaries = dirac_color_presets[idx].color_primaries;
276         avctx->colorspace      = dirac_color_presets[idx].colorspace;
277         avctx->color_trc       = dirac_color_presets[idx].color_trc;
278     }
279
280     return 0;
281 }
282
283 /* [DIRAC_STD] 10. Sequence Header. sequence_header() */
284 int avpriv_dirac_parse_sequence_header(AVCodecContext *avctx, GetBitContext *gb,
285                                        dirac_source_params *source)
286 {
287     unsigned version_major;
288     unsigned video_format, picture_coding_mode;
289     int ret;
290
291     /* [DIRAC_SPEC] 10.1 Parse Parameters. parse_parameters() */
292     version_major  = svq3_get_ue_golomb(gb);
293     svq3_get_ue_golomb(gb); /* version_minor */
294     avctx->profile = svq3_get_ue_golomb(gb);
295     avctx->level   = svq3_get_ue_golomb(gb);
296     /* [DIRAC_SPEC] sequence_header() -> base_video_format as defined in
297      * 10.2 Base Video Format, table 10.1 Dirac predefined video formats */
298     video_format   = svq3_get_ue_golomb(gb);
299
300     if (version_major < 2)
301         av_log(avctx, AV_LOG_WARNING, "Stream is old and may not work\n");
302     else if (version_major > 2)
303         av_log(avctx, AV_LOG_WARNING, "Stream may have unhandled features\n");
304
305     if (video_format > 20)
306         return AVERROR_INVALIDDATA;
307
308     // Fill in defaults for the source parameters.
309     *source = dirac_source_parameters_defaults[video_format];
310
311     /* [DIRAC_STD] 10.3 Source Parameters
312      * Override the defaults. */
313     if (ret = parse_source_parameters(avctx, gb, source))
314         return ret;
315
316     ret = ff_set_dimensions(avctx, source->width, source->height);
317     if (ret < 0)
318         return ret;
319
320     ff_set_sar(avctx, avctx->sample_aspect_ratio);
321
322     /* [DIRAC_STD] picture_coding_mode shall be 0 for fields and 1 for frames
323      * currently only used to signal field coding */
324     picture_coding_mode = svq3_get_ue_golomb(gb);
325     if (picture_coding_mode != 0) {
326         av_log(avctx, AV_LOG_ERROR, "Unsupported picture coding mode %d",
327                picture_coding_mode);
328         return AVERROR_INVALIDDATA;
329     }
330     return 0;
331 }