2 * JPEG 2000 encoder and decoder common functions
3 * Copyright (c) 2007 Kamil Nowosad
4 * Copyright (c) 2013 Nicolas Bertrand <nicoinattendu@gmail.com>
6 * This file is part of FFmpeg.
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.
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.
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
25 * JPEG 2000 image encoder and decoder common functions
28 #include "libavutil/attributes.h"
29 #include "libavutil/avassert.h"
30 #include "libavutil/common.h"
31 #include "libavutil/mem.h"
35 #define SHL(a, n) ((n) >= 0 ? (a) << (n) : (a) >> -(n))
37 /* tag tree routines */
39 /* allocate the memory for tag tree */
40 static int32_t tag_tree_size(uint16_t w
, uint16_t h
)
43 while (w
> 1 || h
> 1) {
45 av_assert0(res
+ 1 < INT32_MAX
);
49 return (int32_t)(res
+ 1);
52 static Jpeg2000TgtNode
*ff_jpeg2000_tag_tree_init(int w
, int h
)
55 Jpeg2000TgtNode
*res
, *t
, *t2
;
58 tt_size
= tag_tree_size(w
, h
);
60 t
= res
= av_mallocz_array(tt_size
, sizeof(*t
));
64 while (w
> 1 || h
> 1) {
73 for (i
= 0; i
< ph
; i
++)
74 for (j
= 0; j
< pw
; j
++)
75 t
[i
* pw
+ j
].parent
= &t2
[(i
>> 1) * w
+ (j
>> 1)];
83 static void tag_tree_zero(Jpeg2000TgtNode
*t
, int w
, int h
)
85 int i
, siz
= tag_tree_size(w
, h
);
87 for (i
= 0; i
< siz
; i
++) {
93 uint8_t ff_jpeg2000_sigctxno_lut
[256][4];
95 static int getsigctxno(int flag
, int bandno
)
99 h
= ((flag
& JPEG2000_T1_SIG_E
) ? 1 : 0) +
100 ((flag
& JPEG2000_T1_SIG_W
) ? 1 : 0);
101 v
= ((flag
& JPEG2000_T1_SIG_N
) ? 1 : 0) +
102 ((flag
& JPEG2000_T1_SIG_S
) ? 1 : 0);
103 d
= ((flag
& JPEG2000_T1_SIG_NE
) ? 1 : 0) +
104 ((flag
& JPEG2000_T1_SIG_NW
) ? 1 : 0) +
105 ((flag
& JPEG2000_T1_SIG_SE
) ? 1 : 0) +
106 ((flag
& JPEG2000_T1_SIG_SW
) ? 1 : 0);
111 if (h
== 2) return 8;
113 if (v
>= 1) return 7;
114 if (d
>= 1) return 6;
117 if (v
== 2) return 4;
118 if (v
== 1) return 3;
119 if (d
>= 2) return 2;
120 if (d
== 1) return 1;
122 if (d
>= 3) return 8;
124 if (h
+v
>= 1) return 7;
128 if (h
+v
>= 2) return 5;
129 if (h
+v
== 1) return 4;
132 if (h
+v
>= 2) return 2;
133 if (h
+v
== 1) return 1;
138 uint8_t ff_jpeg2000_sgnctxno_lut
[16][16], ff_jpeg2000_xorbit_lut
[16][16];
140 static const int contribtab
[3][3] = { { 0, -1, 1 }, { -1, -1, 0 }, { 1, 0, 1 } };
141 static const int ctxlbltab
[3][3] = { { 13, 12, 11 }, { 10, 9, 10 }, { 11, 12, 13 } };
142 static const int xorbittab
[3][3] = { { 1, 1, 1 }, { 1, 0, 0 }, { 0, 0, 0 } };
144 static int getsgnctxno(int flag
, uint8_t *xorbit
)
146 int vcontrib
, hcontrib
;
148 hcontrib
= contribtab
[flag
& JPEG2000_T1_SIG_E
? flag
& JPEG2000_T1_SGN_E
? 1 : 2 : 0]
149 [flag
& JPEG2000_T1_SIG_W
? flag
& JPEG2000_T1_SGN_W
? 1 : 2 : 0] + 1;
150 vcontrib
= contribtab
[flag
& JPEG2000_T1_SIG_S
? flag
& JPEG2000_T1_SGN_S
? 1 : 2 : 0]
151 [flag
& JPEG2000_T1_SIG_N
? flag
& JPEG2000_T1_SGN_N
? 1 : 2 : 0] + 1;
152 *xorbit
= xorbittab
[hcontrib
][vcontrib
];
154 return ctxlbltab
[hcontrib
][vcontrib
];
157 void av_cold
ff_jpeg2000_init_tier1_luts(void)
160 for (i
= 0; i
< 256; i
++)
161 for (j
= 0; j
< 4; j
++)
162 ff_jpeg2000_sigctxno_lut
[i
][j
] = getsigctxno(i
, j
);
163 for (i
= 0; i
< 16; i
++)
164 for (j
= 0; j
< 16; j
++)
165 ff_jpeg2000_sgnctxno_lut
[i
][j
] =
166 getsgnctxno(i
+ (j
<< 8), &ff_jpeg2000_xorbit_lut
[i
][j
]);
169 void ff_jpeg2000_set_significance(Jpeg2000T1Context
*t1
, int x
, int y
,
174 t1
->flags
[y
][x
] |= JPEG2000_T1_SIG
;
176 t1
->flags
[y
][x
+ 1] |= JPEG2000_T1_SIG_W
| JPEG2000_T1_SGN_W
;
177 t1
->flags
[y
][x
- 1] |= JPEG2000_T1_SIG_E
| JPEG2000_T1_SGN_E
;
178 t1
->flags
[y
+ 1][x
] |= JPEG2000_T1_SIG_N
| JPEG2000_T1_SGN_N
;
179 t1
->flags
[y
- 1][x
] |= JPEG2000_T1_SIG_S
| JPEG2000_T1_SGN_S
;
181 t1
->flags
[y
][x
+ 1] |= JPEG2000_T1_SIG_W
;
182 t1
->flags
[y
][x
- 1] |= JPEG2000_T1_SIG_E
;
183 t1
->flags
[y
+ 1][x
] |= JPEG2000_T1_SIG_N
;
184 t1
->flags
[y
- 1][x
] |= JPEG2000_T1_SIG_S
;
186 t1
->flags
[y
+ 1][x
+ 1] |= JPEG2000_T1_SIG_NW
;
187 t1
->flags
[y
+ 1][x
- 1] |= JPEG2000_T1_SIG_NE
;
188 t1
->flags
[y
- 1][x
+ 1] |= JPEG2000_T1_SIG_SW
;
189 t1
->flags
[y
- 1][x
- 1] |= JPEG2000_T1_SIG_SE
;
192 static const uint8_t lut_gain
[2][4] = { { 0, 0, 0, 0 }, { 0, 1, 1, 2 } };
194 int ff_jpeg2000_init_component(Jpeg2000Component
*comp
,
195 Jpeg2000CodingStyle
*codsty
,
196 Jpeg2000QuantStyle
*qntsty
,
197 int cbps
, int dx
, int dy
,
198 AVCodecContext
*avctx
)
200 uint8_t log2_band_prec_width
, log2_band_prec_height
;
201 int reslevelno
, bandno
, gbandno
= 0, ret
, i
, j
;
204 if (codsty
->nreslevels2decode
<= 0) {
205 av_log(avctx
, AV_LOG_ERROR
, "nreslevels2decode %d invalid or uninitialized\n", codsty
->nreslevels2decode
);
206 return AVERROR_INVALIDDATA
;
209 if (ret
= ff_jpeg2000_dwt_init(&comp
->dwt
, comp
->coord
,
210 codsty
->nreslevels2decode
- 1,
213 // component size comp->coord is uint16_t so ir cannot overflow
214 csize
= (comp
->coord
[0][1] - comp
->coord
[0][0]) *
215 (comp
->coord
[1][1] - comp
->coord
[1][0]);
217 if (codsty
->transform
== FF_DWT97
) {
219 comp
->f_data
= av_mallocz_array(csize
, sizeof(*comp
->f_data
));
221 return AVERROR(ENOMEM
);
224 comp
->i_data
= av_mallocz_array(csize
, sizeof(*comp
->i_data
));
226 return AVERROR(ENOMEM
);
228 comp
->reslevel
= av_mallocz_array(codsty
->nreslevels
, sizeof(*comp
->reslevel
));
230 return AVERROR(ENOMEM
);
231 /* LOOP on resolution levels */
232 for (reslevelno
= 0; reslevelno
< codsty
->nreslevels
; reslevelno
++) {
233 int declvl
= codsty
->nreslevels
- reslevelno
; // N_L -r see ISO/IEC 15444-1:2002 B.5
234 Jpeg2000ResLevel
*reslevel
= comp
->reslevel
+ reslevelno
;
236 /* Compute borders for each resolution level.
237 * Computation of trx_0, trx_1, try_0 and try_1.
238 * see ISO/IEC 15444-1:2002 eq. B.5 and B-14 */
239 for (i
= 0; i
< 2; i
++)
240 for (j
= 0; j
< 2; j
++)
241 reslevel
->coord
[i
][j
] =
242 ff_jpeg2000_ceildivpow2(comp
->coord_o
[i
][j
], declvl
- 1);
243 // update precincts size: 2^n value
244 reslevel
->log2_prec_width
= codsty
->log2_prec_widths
[reslevelno
];
245 reslevel
->log2_prec_height
= codsty
->log2_prec_heights
[reslevelno
];
247 /* Number of bands for each resolution level */
249 reslevel
->nbands
= 1;
251 reslevel
->nbands
= 3;
253 /* Number of precincts which span the tile for resolution level reslevelno
254 * see B.6 in ISO/IEC 15444-1:2002 eq. B-16
255 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -| - (trx_0 / 2 ^ log2_prec_width)
256 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| - (try_0 / 2 ^ log2_prec_width)
257 * for Dcinema profiles in JPEG 2000
258 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -|
259 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| */
260 if (reslevel
->coord
[0][1] == reslevel
->coord
[0][0])
261 reslevel
->num_precincts_x
= 0;
263 reslevel
->num_precincts_x
=
264 ff_jpeg2000_ceildivpow2(reslevel
->coord
[0][1],
265 reslevel
->log2_prec_width
) -
266 (reslevel
->coord
[0][0] >> reslevel
->log2_prec_width
);
268 if (reslevel
->coord
[1][1] == reslevel
->coord
[1][0])
269 reslevel
->num_precincts_y
= 0;
271 reslevel
->num_precincts_y
=
272 ff_jpeg2000_ceildivpow2(reslevel
->coord
[1][1],
273 reslevel
->log2_prec_height
) -
274 (reslevel
->coord
[1][0] >> reslevel
->log2_prec_height
);
276 reslevel
->band
= av_mallocz_array(reslevel
->nbands
, sizeof(*reslevel
->band
));
278 return AVERROR(ENOMEM
);
280 for (bandno
= 0; bandno
< reslevel
->nbands
; bandno
++, gbandno
++) {
281 Jpeg2000Band
*band
= reslevel
->band
+ bandno
;
285 /* TODO: Implementation of quantization step not finished,
286 * see ISO/IEC 15444-1:2002 E.1 and A.6.4. */
287 switch (qntsty
->quantsty
) {
290 case JPEG2000_QSTY_NONE
:
291 /* TODO: to verify. No quantization in this case */
292 band
->f_stepsize
= 1;
294 case JPEG2000_QSTY_SI
:
295 /*TODO: Compute formula to implement. */
297 lut_gain
[codsty
->transform
== FF_DWT53
][bandno
+ (reslevelno
> 0)];
298 band
->f_stepsize
= SHL(2048 + qntsty
->mant
[gbandno
],
299 2 + numbps
- qntsty
->expn
[gbandno
]);
301 case JPEG2000_QSTY_SE
:
302 /* Exponent quantization step.
304 * delta_b = 2 ^ (R_b - expn_b) * (1 + (mant_b / 2 ^ 11))
305 * R_b = R_I + log2 (gain_b )
306 * see ISO/IEC 15444-1:2002 E.1.1 eqn. E-3 and E-4 */
307 /* TODO/WARN: value of log2 (gain_b ) not taken into account
308 * but it works (compared to OpenJPEG). Why?
309 * Further investigation needed. */
311 band
->f_stepsize
= pow(2.0, gain
- qntsty
->expn
[gbandno
]);
312 band
->f_stepsize
*= qntsty
->mant
[gbandno
] / 2048.0 + 1.0;
315 band
->f_stepsize
= 0;
316 av_log(avctx
, AV_LOG_ERROR
, "Unknown quantization format\n");
319 /* FIXME: In openjepg code stespize = stepsize * 0.5. Why?
320 * If not set output of entropic decoder is not correct. */
321 if (!av_codec_is_encoder(avctx
->codec
))
322 band
->f_stepsize
*= 0.5;
324 band
->i_stepsize
= band
->f_stepsize
* (1 << 15);
326 /* computation of tbx_0, tbx_1, tby_0, tby_1
327 * see ISO/IEC 15444-1:2002 B.5 eq. B-15 and tbl B.1
328 * codeblock width and height is computed for
329 * DCI JPEG 2000 codeblock_width = codeblock_width = 32 = 2 ^ 5 */
330 if (reslevelno
== 0) {
331 /* for reslevelno = 0, only one band, x0_b = y0_b = 0 */
332 for (i
= 0; i
< 2; i
++)
333 for (j
= 0; j
< 2; j
++)
335 ff_jpeg2000_ceildivpow2(comp
->coord_o
[i
][j
] - comp
->coord_o
[i
][0],
337 log2_band_prec_width
= reslevel
->log2_prec_width
;
338 log2_band_prec_height
= reslevel
->log2_prec_height
;
339 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
340 band
->log2_cblk_width
= FFMIN(codsty
->log2_cblk_width
,
341 reslevel
->log2_prec_width
);
342 band
->log2_cblk_height
= FFMIN(codsty
->log2_cblk_height
,
343 reslevel
->log2_prec_height
);
345 /* 3 bands x0_b = 1 y0_b = 0; x0_b = 0 y0_b = 1; x0_b = y0_b = 1 */
346 /* x0_b and y0_b are computed with ((bandno + 1 >> i) & 1) */
347 for (i
= 0; i
< 2; i
++)
348 for (j
= 0; j
< 2; j
++)
349 /* Formula example for tbx_0 = ceildiv((tcx_0 - 2 ^ (declvl - 1) * x0_b) / declvl) */
351 ff_jpeg2000_ceildivpow2(comp
->coord_o
[i
][j
] - comp
->coord_o
[i
][0] -
352 (((bandno
+ 1 >> i
) & 1) << declvl
- 1),
354 /* TODO: Manage case of 3 band offsets here or
355 * in coding/decoding function? */
357 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
358 band
->log2_cblk_width
= FFMIN(codsty
->log2_cblk_width
,
359 reslevel
->log2_prec_width
- 1);
360 band
->log2_cblk_height
= FFMIN(codsty
->log2_cblk_height
,
361 reslevel
->log2_prec_height
- 1);
363 log2_band_prec_width
= reslevel
->log2_prec_width
- 1;
364 log2_band_prec_height
= reslevel
->log2_prec_height
- 1;
367 for (j
= 0; j
< 2; j
++)
368 band
->coord
[0][j
] = ff_jpeg2000_ceildiv(band
->coord
[0][j
], dx
);
369 for (j
= 0; j
< 2; j
++)
370 band
->coord
[1][j
] = ff_jpeg2000_ceildiv(band
->coord
[1][j
], dy
);
372 if (reslevel
->num_precincts_x
* (uint64_t)reslevel
->num_precincts_y
> INT_MAX
) {
374 return AVERROR(ENOMEM
);
376 nb_precincts
= reslevel
->num_precincts_x
* reslevel
->num_precincts_y
;
377 band
->prec
= av_mallocz_array(nb_precincts
, sizeof(*band
->prec
));
379 return AVERROR(ENOMEM
);
381 for (precno
= 0; precno
< nb_precincts
; precno
++) {
382 Jpeg2000Prec
*prec
= band
->prec
+ precno
;
385 /* TODO: Explain formula for JPEG200 DCINEMA. */
386 /* TODO: Verify with previous count of codeblocks per band */
389 prec
->coord
[0][0] = (precno
% reslevel
->num_precincts_x
) *
390 (1 << log2_band_prec_width
);
391 prec
->coord
[0][0] = FFMAX(prec
->coord
[0][0], band
->coord
[0][0]);
394 prec
->coord
[1][0] = (precno
/ reslevel
->num_precincts_x
) *
395 (1 << log2_band_prec_height
);
396 prec
->coord
[1][0] = FFMAX(prec
->coord
[1][0], band
->coord
[1][0]);
399 prec
->coord
[0][1] = prec
->coord
[0][0] +
400 (1 << log2_band_prec_width
);
401 prec
->coord
[0][1] = FFMIN(prec
->coord
[0][1], band
->coord
[0][1]);
404 prec
->coord
[1][1] = prec
->coord
[1][0] +
405 (1 << log2_band_prec_height
);
406 prec
->coord
[1][1] = FFMIN(prec
->coord
[1][1], band
->coord
[1][1]);
408 prec
->nb_codeblocks_width
=
409 ff_jpeg2000_ceildivpow2(prec
->coord
[0][1] -
411 band
->log2_cblk_width
);
412 prec
->nb_codeblocks_height
=
413 ff_jpeg2000_ceildivpow2(prec
->coord
[1][1] -
415 band
->log2_cblk_height
);
417 /* Tag trees initialization */
419 ff_jpeg2000_tag_tree_init(prec
->nb_codeblocks_width
,
420 prec
->nb_codeblocks_height
);
422 return AVERROR(ENOMEM
);
425 ff_jpeg2000_tag_tree_init(prec
->nb_codeblocks_width
,
426 prec
->nb_codeblocks_height
);
428 return AVERROR(ENOMEM
);
430 if (prec
->nb_codeblocks_width
* (uint64_t)prec
->nb_codeblocks_height
> INT_MAX
) {
432 return AVERROR(ENOMEM
);
434 nb_codeblocks
= prec
->nb_codeblocks_width
* prec
->nb_codeblocks_height
;
435 prec
->cblk
= av_mallocz_array(nb_codeblocks
, sizeof(*prec
->cblk
));
437 return AVERROR(ENOMEM
);
438 for (cblkno
= 0; cblkno
< nb_codeblocks
; cblkno
++) {
439 Jpeg2000Cblk
*cblk
= prec
->cblk
+ cblkno
;
442 /* Compute coordinates of codeblocks */
444 Cx0
= (prec
->coord
[0][0] >> band
->log2_cblk_width
) << band
->log2_cblk_width
;
445 Cx0
= Cx0
+ ((cblkno
% prec
->nb_codeblocks_width
) << band
->log2_cblk_width
);
446 cblk
->coord
[0][0] = FFMAX(Cx0
, prec
->coord
[0][0]);
449 Cy0
= (prec
->coord
[1][0] >> band
->log2_cblk_height
) << band
->log2_cblk_height
;
450 Cy0
= Cy0
+ ((cblkno
/ prec
->nb_codeblocks_width
) << band
->log2_cblk_height
);
451 cblk
->coord
[1][0] = FFMAX(Cy0
, prec
->coord
[1][0]);
454 cblk
->coord
[0][1] = FFMIN(Cx0
+ (1 << band
->log2_cblk_width
),
458 cblk
->coord
[1][1] = FFMIN(Cy0
+ (1 << band
->log2_cblk_height
),
460 /* Update code-blocks coordinates according sub-band position */
461 if ((bandno
+ !!reslevelno
) & 1) {
462 cblk
->coord
[0][0] += comp
->reslevel
[reslevelno
-1].coord
[0][1] -
463 comp
->reslevel
[reslevelno
-1].coord
[0][0];
464 cblk
->coord
[0][1] += comp
->reslevel
[reslevelno
-1].coord
[0][1] -
465 comp
->reslevel
[reslevelno
-1].coord
[0][0];
467 if ((bandno
+ !!reslevelno
) & 2) {
468 cblk
->coord
[1][0] += comp
->reslevel
[reslevelno
-1].coord
[1][1] -
469 comp
->reslevel
[reslevelno
-1].coord
[1][0];
470 cblk
->coord
[1][1] += comp
->reslevel
[reslevelno
-1].coord
[1][1] -
471 comp
->reslevel
[reslevelno
-1].coord
[1][0];
486 void ff_jpeg2000_reinit(Jpeg2000Component
*comp
, Jpeg2000CodingStyle
*codsty
)
488 int reslevelno
, bandno
, cblkno
, precno
;
489 for (reslevelno
= 0; reslevelno
< codsty
->nreslevels
; reslevelno
++) {
490 Jpeg2000ResLevel
*rlevel
= comp
->reslevel
+ reslevelno
;
491 for (bandno
= 0; bandno
< rlevel
->nbands
; bandno
++) {
492 Jpeg2000Band
*band
= rlevel
->band
+ bandno
;
493 for(precno
= 0; precno
< rlevel
->num_precincts_x
* rlevel
->num_precincts_y
; precno
++) {
494 Jpeg2000Prec
*prec
= band
->prec
+ precno
;
495 tag_tree_zero(prec
->zerobits
, prec
->nb_codeblocks_width
, prec
->nb_codeblocks_height
);
496 tag_tree_zero(prec
->cblkincl
, prec
->nb_codeblocks_width
, prec
->nb_codeblocks_height
);
497 for (cblkno
= 0; cblkno
< prec
->nb_codeblocks_width
* prec
->nb_codeblocks_height
; cblkno
++) {
498 Jpeg2000Cblk
*cblk
= prec
->cblk
+ cblkno
;
507 void ff_jpeg2000_cleanup(Jpeg2000Component
*comp
, Jpeg2000CodingStyle
*codsty
)
509 int reslevelno
, bandno
, precno
;
511 comp
->reslevel
&& reslevelno
< codsty
->nreslevels
;
513 Jpeg2000ResLevel
*reslevel
;
518 reslevel
= comp
->reslevel
+ reslevelno
;
519 for (bandno
= 0; bandno
< reslevel
->nbands
; bandno
++) {
525 band
= reslevel
->band
+ bandno
;
526 for (precno
= 0; precno
< reslevel
->num_precincts_x
* reslevel
->num_precincts_y
; precno
++) {
528 Jpeg2000Prec
*prec
= band
->prec
+ precno
;
529 av_freep(&prec
->zerobits
);
530 av_freep(&prec
->cblkincl
);
531 av_freep(&prec
->cblk
);
535 av_freep(&band
->prec
);
537 av_freep(&reslevel
->band
);
540 ff_dwt_destroy(&comp
->dwt
);
541 av_freep(&comp
->reslevel
);
542 av_freep(&comp
->i_data
);
543 av_freep(&comp
->f_data
);