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