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