ed0ea9ff04ac97199a745952789272f60a37c727
[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 #include "dirac.h"
30 #include "avcodec.h"
31 #include "golomb.h"
32 #include "internal.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
47     { 1280, 720,  1, 0, 1, 7,  1, 1280, 720,  0, 0, 3, 3 },
48     { 1280, 720,  1, 0, 1, 6,  1, 1280, 720,  0, 0, 3, 3 },
49     { 1920, 1080, 1, 1, 1, 4,  1, 1920, 1080, 0, 0, 3, 3 },
50     { 1920, 1080, 1, 1, 1, 3,  1, 1920, 1080, 0, 0, 3, 3 },
51     { 1920, 1080, 1, 0, 1, 7,  1, 1920, 1080, 0, 0, 3, 3 },
52     { 1920, 1080, 1, 0, 1, 6,  1, 1920, 1080, 0, 0, 3, 3 },
53     { 2048, 1080, 0, 0, 1, 2,  1, 2048, 1080, 0, 0, 4, 4 },
54     { 4096, 2160, 0, 0, 1, 2,  1, 4096, 2160, 0, 0, 4, 4 },
55
56     { 3840, 2160, 1, 0, 1, 7,  1, 3840, 2160, 0, 0, 3, 3 },
57     { 3840, 2160, 1, 0, 1, 6,  1, 3840, 2160, 0, 0, 3, 3 },
58     { 7680, 4320, 1, 0, 1, 7,  1, 3840, 2160, 0, 0, 3, 3 },
59     { 7680, 4320, 1, 0, 1, 6,  1, 3840, 2160, 0, 0, 3, 3 },
60 };
61
62 /* [DIRAC_STD] Table 10.4 - Available preset pixel aspect ratio values */
63 static const AVRational dirac_preset_aspect_ratios[] = {
64     {1, 1},
65     {10, 11},
66     {12, 11},
67     {40, 33},
68     {16, 11},
69     {4, 3},
70 };
71
72 /* [DIRAC_STD] Values 9,10 of 10.3.5 Frame Rate.
73  * Table 10.3 Available preset frame rate values
74  */
75 static const AVRational dirac_frame_rate[] = {
76     {15000, 1001},
77     {25, 2},
78 };
79
80 /* [DIRAC_STD] This should be equivalent to Table 10.5 Available signal
81  * range presets */
82 static const struct {
83     uint8_t             bitdepth;
84     enum AVColorRange   color_range;
85 } pixel_range_presets[] = {
86     {8,  AVCOL_RANGE_JPEG},
87     {8,  AVCOL_RANGE_MPEG},
88     {10, AVCOL_RANGE_MPEG},
89     {12, AVCOL_RANGE_MPEG},
90 };
91
92 static const enum AVColorPrimaries dirac_primaries[] = {
93     AVCOL_PRI_BT709,
94     AVCOL_PRI_SMPTE170M,
95     AVCOL_PRI_BT470BG,
96 };
97
98 static const struct {
99     enum AVColorPrimaries color_primaries;
100     enum AVColorSpace colorspace;
101     enum AVColorTransferCharacteristic color_trc;
102 } dirac_color_presets[] = {
103     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_BT709 },
104     { AVCOL_PRI_SMPTE170M, AVCOL_SPC_BT470BG, AVCOL_TRC_BT709 },
105     { AVCOL_PRI_BT470BG,   AVCOL_SPC_BT470BG, AVCOL_TRC_BT709 },
106     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_BT709 },
107     { AVCOL_PRI_BT709,     AVCOL_SPC_BT709,   AVCOL_TRC_UNSPECIFIED /* DCinema */ },
108 };
109
110 /* [DIRAC_STD] Table 10.2 Supported chroma sampling formats + luma Offset */
111 static const enum AVPixelFormat dirac_pix_fmt[2][3] = {
112     { AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P  },
113     { AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P },
114 };
115
116 /* [DIRAC_STD] 10.3 Parse Source Parameters.
117  * source_parameters(base_video_format) */
118 static int parse_source_parameters(AVCodecContext *avctx, GetBitContext *gb,
119                                    dirac_source_params *source)
120 {
121     AVRational frame_rate = {0,0};
122     unsigned luma_depth = 8, luma_offset = 16;
123     int idx;
124
125     /* [DIRAC_STD] 10.3.2 Frame size. frame_size(video_params) */
126     /* [DIRAC_STD] custom_dimensions_flag */
127     if (get_bits1(gb)) {
128         source->width  = svq3_get_ue_golomb(gb); /* [DIRAC_STD] FRAME_WIDTH  */
129         source->height = svq3_get_ue_golomb(gb); /* [DIRAC_STD] FRAME_HEIGHT */
130     }
131
132     /* [DIRAC_STD] 10.3.3 Chroma Sampling Format.
133      *  chroma_sampling_format(video_params) */
134     /* [DIRAC_STD] custom_chroma_format_flag */
135     if (get_bits1(gb))
136         /* [DIRAC_STD] CHROMA_FORMAT_INDEX */
137         source->chroma_format = svq3_get_ue_golomb(gb);
138     if (source->chroma_format > 2) {
139         av_log(avctx, AV_LOG_ERROR, "Unknown chroma format %d\n",
140                source->chroma_format);
141         return AVERROR_INVALIDDATA;
142     }
143
144     /* [DIRAC_STD] 10.3.4 Scan Format. scan_format(video_params) */
145     /* [DIRAC_STD] custom_scan_format_flag */
146     if (get_bits1(gb))
147         /* [DIRAC_STD] SOURCE_SAMPLING */
148         source->interlaced = svq3_get_ue_golomb(gb);
149     if (source->interlaced > 1)
150         return AVERROR_INVALIDDATA;
151
152     /* [DIRAC_STD] 10.3.5 Frame Rate. frame_rate(video_params) */
153     if (get_bits1(gb)) { /* [DIRAC_STD] custom_frame_rate_flag */
154         source->frame_rate_index = svq3_get_ue_golomb(gb);
155
156         if (source->frame_rate_index > 10)
157             return AVERROR_INVALIDDATA;
158
159         if (!source->frame_rate_index) {
160             /* [DIRAC_STD] FRAME_RATE_NUMER */
161             frame_rate.num = svq3_get_ue_golomb(gb);
162             /* [DIRAC_STD] FRAME_RATE_DENOM */
163             frame_rate.den = svq3_get_ue_golomb(gb);
164         }
165     }
166     /* [DIRAC_STD] preset_frame_rate(video_params, index) */
167     if (source->frame_rate_index > 0) {
168         if (source->frame_rate_index <= 8)
169             frame_rate = ff_mpeg12_frame_rate_tab[source->frame_rate_index];
170         else
171              /* [DIRAC_STD] Table 10.3 values 9-10 */
172             frame_rate = dirac_frame_rate[source->frame_rate_index-9];
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.
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 : AVCOL_RANGE_JPEG;
226         }
227     }
228     /* [DIRAC_STD] Table 10.5
229      * Available signal range presets <--> pixel_range_presets */
230     if (source->pixel_range_index > 0) {
231         idx                = source->pixel_range_index-1;
232         luma_depth         = pixel_range_presets[idx].bitdepth;
233         avctx->color_range = pixel_range_presets[idx].color_range;
234     }
235
236     if (luma_depth > 8)
237         av_log(avctx, AV_LOG_WARNING, "Bitdepth greater than 8");
238
239     avctx->pix_fmt = dirac_pix_fmt[!luma_offset][source->chroma_format];
240
241     /* [DIRAC_STD] 10.3.9 Colour specification. colour_spec(video_params) */
242     if (get_bits1(gb)) { /* [DIRAC_STD] custom_colour_spec_flag */
243          /* [DIRAC_STD] index */
244         idx = source->color_spec_index = svq3_get_ue_golomb(gb);
245
246         if (source->color_spec_index > 4)
247             return AVERROR_INVALIDDATA;
248
249         avctx->color_primaries = dirac_color_presets[idx].color_primaries;
250         avctx->colorspace      = dirac_color_presets[idx].colorspace;
251         avctx->color_trc       = dirac_color_presets[idx].color_trc;
252
253         if (!source->color_spec_index) {
254             /* [DIRAC_STD] 10.3.9.1 Colour primaries */
255             if (get_bits1(gb)) {
256                 idx = svq3_get_ue_golomb(gb);
257                 if (idx < 3)
258                     avctx->color_primaries = dirac_primaries[idx];
259             }
260             /* [DIRAC_STD] 10.3.9.2 Colour matrix */
261             if (get_bits1(gb)) {
262                 idx = svq3_get_ue_golomb(gb);
263                 if (!idx)
264                     avctx->colorspace = AVCOL_SPC_BT709;
265                 else if (idx == 1)
266                     avctx->colorspace = AVCOL_SPC_BT470BG;
267             }
268             /* [DIRAC_STD] 10.3.9.3 Transfer function */
269             if (get_bits1(gb) && !svq3_get_ue_golomb(gb))
270                 avctx->color_trc = AVCOL_TRC_BT709;
271         }
272     } else {
273         idx = source->color_spec_index;
274         avctx->color_primaries = dirac_color_presets[idx].color_primaries;
275         avctx->colorspace      = dirac_color_presets[idx].colorspace;
276         avctx->color_trc       = dirac_color_presets[idx].color_trc;
277     }
278
279     return 0;
280 }
281
282 /* [DIRAC_STD] 10. Sequence Header. sequence_header() */
283 int avpriv_dirac_parse_sequence_header(AVCodecContext *avctx, GetBitContext *gb,
284                                    dirac_source_params *source)
285 {
286     unsigned version_major;
287     unsigned video_format, picture_coding_mode;
288     int ret;
289
290     /* [DIRAC_SPEC] 10.1 Parse Parameters. parse_parameters() */
291     version_major  = svq3_get_ue_golomb(gb);
292     svq3_get_ue_golomb(gb); /* version_minor */
293     avctx->profile = svq3_get_ue_golomb(gb);
294     avctx->level   = svq3_get_ue_golomb(gb);
295     /* [DIRAC_SPEC] sequence_header() -> base_video_format as defined in
296      * 10.2 Base Video Format, table 10.1 Dirac predefined video formats */
297     video_format   = svq3_get_ue_golomb(gb);
298
299     if (version_major < 2)
300         av_log(avctx, AV_LOG_WARNING, "Stream is old and may not work\n");
301     else if (version_major > 2)
302         av_log(avctx, AV_LOG_WARNING, "Stream may have unhandled features\n");
303
304     if (video_format > 20)
305         return AVERROR_INVALIDDATA;
306
307     // Fill in defaults for the source parameters.
308     *source = dirac_source_parameters_defaults[video_format];
309
310     /* [DIRAC_STD] 10.3 Source Parameters
311      * Override the defaults. */
312     if (ret = parse_source_parameters(avctx, gb, source))
313         return ret;
314
315     ret = ff_set_dimensions(avctx, source->width, source->height);
316     if (ret < 0)
317         return ret;
318
319     ff_set_sar(avctx, avctx->sample_aspect_ratio);
320
321     /* [DIRAC_STD] picture_coding_mode shall be 0 for fields and 1 for frames
322      * currently only used to signal field coding */
323     picture_coding_mode = svq3_get_ue_golomb(gb);
324     if (picture_coding_mode != 0) {
325         av_log(avctx, AV_LOG_ERROR, "Unsupported picture coding mode %d",
326                picture_coding_mode);
327         return AVERROR_INVALIDDATA;
328     }
329     return 0;
330 }