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/imgutils.h"
32 #include "libavutil/mem.h"
37 #define SHL(a, n) ((n) >= 0 ? (a) << (n) : (a) >> -(n))
39 /* tag tree routines */
41 /* allocate the memory for tag tree */
42 static int32_t tag_tree_size(int w, int h)
45 while (w > 1 || h > 1) {
46 res += w * (int64_t)h;
47 av_assert0(res + 1 < INT32_MAX);
51 return (int32_t)(res + 1);
54 static Jpeg2000TgtNode *ff_jpeg2000_tag_tree_init(int w, int h)
57 Jpeg2000TgtNode *res, *t, *t2;
60 tt_size = tag_tree_size(w, h);
62 t = res = av_mallocz_array(tt_size, sizeof(*t));
66 while (w > 1 || h > 1) {
75 for (i = 0; i < ph; i++)
76 for (j = 0; j < pw; j++)
77 t[i * pw + j].parent = &t2[(i >> 1) * w + (j >> 1)];
85 static void tag_tree_zero(Jpeg2000TgtNode *t, int w, int h)
87 int i, siz = tag_tree_size(w, h);
89 for (i = 0; i < siz; i++) {
95 uint8_t ff_jpeg2000_sigctxno_lut[256][4];
97 static int getsigctxno(int flag, int bandno)
101 h = ((flag & JPEG2000_T1_SIG_E) ? 1 : 0) +
102 ((flag & JPEG2000_T1_SIG_W) ? 1 : 0);
103 v = ((flag & JPEG2000_T1_SIG_N) ? 1 : 0) +
104 ((flag & JPEG2000_T1_SIG_S) ? 1 : 0);
105 d = ((flag & JPEG2000_T1_SIG_NE) ? 1 : 0) +
106 ((flag & JPEG2000_T1_SIG_NW) ? 1 : 0) +
107 ((flag & JPEG2000_T1_SIG_SE) ? 1 : 0) +
108 ((flag & JPEG2000_T1_SIG_SW) ? 1 : 0);
113 if (h == 2) return 8;
115 if (v >= 1) return 7;
116 if (d >= 1) return 6;
119 if (v == 2) return 4;
120 if (v == 1) return 3;
121 if (d >= 2) return 2;
122 if (d == 1) return 1;
124 if (d >= 3) return 8;
126 if (h+v >= 1) return 7;
130 if (h+v >= 2) return 5;
131 if (h+v == 1) return 4;
134 if (h+v >= 2) return 2;
135 if (h+v == 1) return 1;
140 uint8_t ff_jpeg2000_sgnctxno_lut[16][16], ff_jpeg2000_xorbit_lut[16][16];
142 static const int contribtab[3][3] = { { 0, -1, 1 }, { -1, -1, 0 }, { 1, 0, 1 } };
143 static const int ctxlbltab[3][3] = { { 13, 12, 11 }, { 10, 9, 10 }, { 11, 12, 13 } };
144 static const int xorbittab[3][3] = { { 1, 1, 1 }, { 1, 0, 0 }, { 0, 0, 0 } };
146 static int getsgnctxno(int flag, uint8_t *xorbit)
148 int vcontrib, hcontrib;
150 hcontrib = contribtab[flag & JPEG2000_T1_SIG_E ? flag & JPEG2000_T1_SGN_E ? 1 : 2 : 0]
151 [flag & JPEG2000_T1_SIG_W ? flag & JPEG2000_T1_SGN_W ? 1 : 2 : 0] + 1;
152 vcontrib = contribtab[flag & JPEG2000_T1_SIG_S ? flag & JPEG2000_T1_SGN_S ? 1 : 2 : 0]
153 [flag & JPEG2000_T1_SIG_N ? flag & JPEG2000_T1_SGN_N ? 1 : 2 : 0] + 1;
154 *xorbit = xorbittab[hcontrib][vcontrib];
156 return ctxlbltab[hcontrib][vcontrib];
159 void av_cold ff_jpeg2000_init_tier1_luts(void)
162 for (i = 0; i < 256; i++)
163 for (j = 0; j < 4; j++)
164 ff_jpeg2000_sigctxno_lut[i][j] = getsigctxno(i, j);
165 for (i = 0; i < 16; i++)
166 for (j = 0; j < 16; j++)
167 ff_jpeg2000_sgnctxno_lut[i][j] =
168 getsgnctxno(i + (j << 8), &ff_jpeg2000_xorbit_lut[i][j]);
171 void ff_jpeg2000_set_significance(Jpeg2000T1Context *t1, int x, int y,
176 t1->flags[(y) * t1->stride + x] |= JPEG2000_T1_SIG;
178 t1->flags[(y) * t1->stride + x + 1] |= JPEG2000_T1_SIG_W | JPEG2000_T1_SGN_W;
179 t1->flags[(y) * t1->stride + x - 1] |= JPEG2000_T1_SIG_E | JPEG2000_T1_SGN_E;
180 t1->flags[(y + 1) * t1->stride + x] |= JPEG2000_T1_SIG_N | JPEG2000_T1_SGN_N;
181 t1->flags[(y - 1) * t1->stride + x] |= JPEG2000_T1_SIG_S | JPEG2000_T1_SGN_S;
183 t1->flags[(y) * t1->stride + x + 1] |= JPEG2000_T1_SIG_W;
184 t1->flags[(y) * t1->stride + x - 1] |= JPEG2000_T1_SIG_E;
185 t1->flags[(y + 1) * t1->stride + x] |= JPEG2000_T1_SIG_N;
186 t1->flags[(y - 1) * t1->stride + x] |= JPEG2000_T1_SIG_S;
188 t1->flags[(y + 1) * t1->stride + x + 1] |= JPEG2000_T1_SIG_NW;
189 t1->flags[(y + 1) * t1->stride + x - 1] |= JPEG2000_T1_SIG_NE;
190 t1->flags[(y - 1) * t1->stride + x + 1] |= JPEG2000_T1_SIG_SW;
191 t1->flags[(y - 1) * t1->stride + x - 1] |= JPEG2000_T1_SIG_SE;
194 // static const uint8_t lut_gain[2][4] = { { 0, 0, 0, 0 }, { 0, 1, 1, 2 } }; (unused)
196 static void init_band_stepsize(AVCodecContext *avctx,
198 Jpeg2000CodingStyle *codsty,
199 Jpeg2000QuantStyle *qntsty,
200 int bandno, int gbandno, int reslevelno,
203 /* TODO: Implementation of quantization step not finished,
204 * see ISO/IEC 15444-1:2002 E.1 and A.6.4. */
205 switch (qntsty->quantsty) {
207 case JPEG2000_QSTY_NONE:
208 /* TODO: to verify. No quantization in this case */
209 band->f_stepsize = 1;
211 case JPEG2000_QSTY_SI:
212 /*TODO: Compute formula to implement. */
214 // lut_gain[codsty->transform == FF_DWT53][bandno + (reslevelno > 0)];
215 // band->f_stepsize = SHL(2048 + qntsty->mant[gbandno],
216 // 2 + numbps - qntsty->expn[gbandno]);
218 case JPEG2000_QSTY_SE:
219 /* Exponent quantization step.
221 * delta_b = 2 ^ (R_b - expn_b) * (1 + (mant_b / 2 ^ 11))
222 * R_b = R_I + log2 (gain_b )
223 * see ISO/IEC 15444-1:2002 E.1.1 eqn. E-3 and E-4 */
225 band->f_stepsize = ff_exp2fi(gain - qntsty->expn[gbandno]);
226 band->f_stepsize *= qntsty->mant[gbandno] / 2048.0 + 1.0;
229 band->f_stepsize = 0;
230 av_log(avctx, AV_LOG_ERROR, "Unknown quantization format\n");
233 if (codsty->transform != FF_DWT53) {
235 switch (bandno + (reslevelno > 0)) {
238 band->f_stepsize *= F_LFTG_X * 2;
242 band->f_stepsize *= F_LFTG_X * F_LFTG_X * 4;
245 if (codsty->transform == FF_DWT97) {
246 band->f_stepsize *= pow(F_LFTG_K, 2*(codsty->nreslevels2decode - reslevelno) + lband - 2);
250 band->i_stepsize = band->f_stepsize * (1 << 15);
252 /* FIXME: In OpenJPEG code stepsize = stepsize * 0.5. Why?
253 * If not set output of entropic decoder is not correct. */
254 if (!av_codec_is_encoder(avctx->codec))
255 band->f_stepsize *= 0.5;
258 static int init_prec(Jpeg2000Band *band,
259 Jpeg2000ResLevel *reslevel,
260 Jpeg2000Component *comp,
261 int precno, int bandno, int reslevelno,
262 int log2_band_prec_width,
263 int log2_band_prec_height)
265 Jpeg2000Prec *prec = band->prec + precno;
266 int nb_codeblocks, cblkno;
268 prec->decoded_layers = 0;
270 /* TODO: Explain formula for JPEG200 DCINEMA. */
271 /* TODO: Verify with previous count of codeblocks per band */
274 prec->coord[0][0] = ((band->coord[0][0] >> log2_band_prec_width) + precno % reslevel->num_precincts_x) *
275 (1 << log2_band_prec_width);
278 prec->coord[1][0] = ((band->coord[1][0] >> log2_band_prec_height) + precno / reslevel->num_precincts_x) *
279 (1 << log2_band_prec_height);
282 prec->coord[0][1] = prec->coord[0][0] +
283 (1 << log2_band_prec_width);
284 prec->coord[0][0] = FFMAX(prec->coord[0][0], band->coord[0][0]);
285 prec->coord[0][1] = FFMIN(prec->coord[0][1], band->coord[0][1]);
288 prec->coord[1][1] = prec->coord[1][0] +
289 (1 << log2_band_prec_height);
290 prec->coord[1][0] = FFMAX(prec->coord[1][0], band->coord[1][0]);
291 prec->coord[1][1] = FFMIN(prec->coord[1][1], band->coord[1][1]);
293 prec->nb_codeblocks_width =
294 ff_jpeg2000_ceildivpow2(prec->coord[0][1],
295 band->log2_cblk_width)
296 - (prec->coord[0][0] >> band->log2_cblk_width);
297 prec->nb_codeblocks_height =
298 ff_jpeg2000_ceildivpow2(prec->coord[1][1],
299 band->log2_cblk_height)
300 - (prec->coord[1][0] >> band->log2_cblk_height);
303 /* Tag trees initialization */
305 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
306 prec->nb_codeblocks_height);
308 return AVERROR(ENOMEM);
311 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
312 prec->nb_codeblocks_height);
314 return AVERROR(ENOMEM);
316 if (prec->nb_codeblocks_width * (uint64_t)prec->nb_codeblocks_height > INT_MAX) {
318 return AVERROR(ENOMEM);
320 nb_codeblocks = prec->nb_codeblocks_width * prec->nb_codeblocks_height;
321 prec->cblk = av_mallocz_array(nb_codeblocks, sizeof(*prec->cblk));
323 return AVERROR(ENOMEM);
324 for (cblkno = 0; cblkno < nb_codeblocks; cblkno++) {
325 Jpeg2000Cblk *cblk = prec->cblk + cblkno;
328 /* Compute coordinates of codeblocks */
330 Cx0 = ((prec->coord[0][0]) >> band->log2_cblk_width) << band->log2_cblk_width;
331 Cx0 = Cx0 + ((cblkno % prec->nb_codeblocks_width) << band->log2_cblk_width);
332 cblk->coord[0][0] = FFMAX(Cx0, prec->coord[0][0]);
335 Cy0 = ((prec->coord[1][0]) >> band->log2_cblk_height) << band->log2_cblk_height;
336 Cy0 = Cy0 + ((cblkno / prec->nb_codeblocks_width) << band->log2_cblk_height);
337 cblk->coord[1][0] = FFMAX(Cy0, prec->coord[1][0]);
340 cblk->coord[0][1] = FFMIN(Cx0 + (1 << band->log2_cblk_width),
344 cblk->coord[1][1] = FFMIN(Cy0 + (1 << band->log2_cblk_height),
346 /* Update code-blocks coordinates according sub-band position */
347 if ((bandno + !!reslevelno) & 1) {
348 cblk->coord[0][0] += comp->reslevel[reslevelno-1].coord[0][1] -
349 comp->reslevel[reslevelno-1].coord[0][0];
350 cblk->coord[0][1] += comp->reslevel[reslevelno-1].coord[0][1] -
351 comp->reslevel[reslevelno-1].coord[0][0];
353 if ((bandno + !!reslevelno) & 2) {
354 cblk->coord[1][0] += comp->reslevel[reslevelno-1].coord[1][1] -
355 comp->reslevel[reslevelno-1].coord[1][0];
356 cblk->coord[1][1] += comp->reslevel[reslevelno-1].coord[1][1] -
357 comp->reslevel[reslevelno-1].coord[1][0];
363 memset(cblk->lengthinc, 0, sizeof(cblk->lengthinc));
370 static int init_band(AVCodecContext *avctx,
371 Jpeg2000ResLevel *reslevel,
372 Jpeg2000Component *comp,
373 Jpeg2000CodingStyle *codsty,
374 Jpeg2000QuantStyle *qntsty,
375 int bandno, int gbandno, int reslevelno,
376 int cbps, int dx, int dy)
378 Jpeg2000Band *band = reslevel->band + bandno;
379 uint8_t log2_band_prec_width, log2_band_prec_height;
380 int declvl = codsty->nreslevels - reslevelno; // N_L -r see ISO/IEC 15444-1:2002 B.5
385 init_band_stepsize(avctx, band, codsty, qntsty, bandno, gbandno, reslevelno, cbps);
387 /* computation of tbx_0, tbx_1, tby_0, tby_1
388 * see ISO/IEC 15444-1:2002 B.5 eq. B-15 and tbl B.1
389 * codeblock width and height is computed for
390 * DCI JPEG 2000 codeblock_width = codeblock_width = 32 = 2 ^ 5 */
391 if (reslevelno == 0) {
392 /* for reslevelno = 0, only one band, x0_b = y0_b = 0 */
393 for (i = 0; i < 2; i++)
394 for (j = 0; j < 2; j++)
396 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j],
398 log2_band_prec_width = reslevel->log2_prec_width;
399 log2_band_prec_height = reslevel->log2_prec_height;
400 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
401 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
402 reslevel->log2_prec_width);
403 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
404 reslevel->log2_prec_height);
406 /* 3 bands x0_b = 1 y0_b = 0; x0_b = 0 y0_b = 1; x0_b = y0_b = 1 */
407 /* x0_b and y0_b are computed with ((bandno + 1 >> i) & 1) */
408 for (i = 0; i < 2; i++)
409 for (j = 0; j < 2; j++)
410 /* Formula example for tbx_0 = ceildiv((tcx_0 - 2 ^ (declvl - 1) * x0_b) / declvl) */
412 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j] -
413 (((bandno + 1 >> i) & 1LL) << declvl - 1),
415 /* TODO: Manage case of 3 band offsets here or
416 * in coding/decoding function? */
418 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
419 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
420 reslevel->log2_prec_width - 1);
421 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
422 reslevel->log2_prec_height - 1);
424 log2_band_prec_width = reslevel->log2_prec_width - 1;
425 log2_band_prec_height = reslevel->log2_prec_height - 1;
428 if (reslevel->num_precincts_x * (uint64_t)reslevel->num_precincts_y > INT_MAX) {
430 return AVERROR(ENOMEM);
432 nb_precincts = reslevel->num_precincts_x * reslevel->num_precincts_y;
433 band->prec = av_mallocz_array(nb_precincts, sizeof(*band->prec));
435 return AVERROR(ENOMEM);
437 for (precno = 0; precno < nb_precincts; precno++) {
438 ret = init_prec(band, reslevel, comp,
439 precno, bandno, reslevelno,
440 log2_band_prec_width, log2_band_prec_height);
448 int ff_jpeg2000_init_component(Jpeg2000Component *comp,
449 Jpeg2000CodingStyle *codsty,
450 Jpeg2000QuantStyle *qntsty,
451 int cbps, int dx, int dy,
452 AVCodecContext *avctx)
454 int reslevelno, bandno, gbandno = 0, ret, i, j;
457 if (codsty->nreslevels2decode <= 0) {
458 av_log(avctx, AV_LOG_ERROR, "nreslevels2decode %d invalid or uninitialized\n", codsty->nreslevels2decode);
459 return AVERROR_INVALIDDATA;
462 if (ret = ff_jpeg2000_dwt_init(&comp->dwt, comp->coord,
463 codsty->nreslevels2decode - 1,
467 if (av_image_check_size(comp->coord[0][1] - comp->coord[0][0],
468 comp->coord[1][1] - comp->coord[1][0], 0, avctx))
469 return AVERROR_INVALIDDATA;
470 csize = (comp->coord[0][1] - comp->coord[0][0]) *
471 (comp->coord[1][1] - comp->coord[1][0]);
472 if (comp->coord[0][1] - comp->coord[0][0] > 32768 ||
473 comp->coord[1][1] - comp->coord[1][0] > 32768) {
474 av_log(avctx, AV_LOG_ERROR, "component size too large\n");
475 return AVERROR_PATCHWELCOME;
478 if (codsty->transform == FF_DWT97) {
479 csize += AV_INPUT_BUFFER_PADDING_SIZE / sizeof(*comp->f_data);
481 comp->f_data = av_mallocz_array(csize, sizeof(*comp->f_data));
483 return AVERROR(ENOMEM);
485 csize += AV_INPUT_BUFFER_PADDING_SIZE / sizeof(*comp->i_data);
487 comp->i_data = av_mallocz_array(csize, sizeof(*comp->i_data));
489 return AVERROR(ENOMEM);
491 comp->reslevel = av_mallocz_array(codsty->nreslevels, sizeof(*comp->reslevel));
493 return AVERROR(ENOMEM);
494 /* LOOP on resolution levels */
495 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
496 int declvl = codsty->nreslevels - reslevelno; // N_L -r see ISO/IEC 15444-1:2002 B.5
497 Jpeg2000ResLevel *reslevel = comp->reslevel + reslevelno;
499 /* Compute borders for each resolution level.
500 * Computation of trx_0, trx_1, try_0 and try_1.
501 * see ISO/IEC 15444-1:2002 eq. B.5 and B-14 */
502 for (i = 0; i < 2; i++)
503 for (j = 0; j < 2; j++)
504 reslevel->coord[i][j] =
505 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j], declvl - 1);
506 // update precincts size: 2^n value
507 reslevel->log2_prec_width = codsty->log2_prec_widths[reslevelno];
508 reslevel->log2_prec_height = codsty->log2_prec_heights[reslevelno];
510 /* Number of bands for each resolution level */
512 reslevel->nbands = 1;
514 reslevel->nbands = 3;
516 /* Number of precincts which span the tile for resolution level reslevelno
517 * see B.6 in ISO/IEC 15444-1:2002 eq. B-16
518 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -| - (trx_0 / 2 ^ log2_prec_width)
519 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| - (try_0 / 2 ^ log2_prec_width)
520 * for Dcinema profiles in JPEG 2000
521 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -|
522 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| */
523 if (reslevel->coord[0][1] == reslevel->coord[0][0])
524 reslevel->num_precincts_x = 0;
526 reslevel->num_precincts_x =
527 ff_jpeg2000_ceildivpow2(reslevel->coord[0][1],
528 reslevel->log2_prec_width) -
529 (reslevel->coord[0][0] >> reslevel->log2_prec_width);
531 if (reslevel->coord[1][1] == reslevel->coord[1][0])
532 reslevel->num_precincts_y = 0;
534 reslevel->num_precincts_y =
535 ff_jpeg2000_ceildivpow2(reslevel->coord[1][1],
536 reslevel->log2_prec_height) -
537 (reslevel->coord[1][0] >> reslevel->log2_prec_height);
539 reslevel->band = av_mallocz_array(reslevel->nbands, sizeof(*reslevel->band));
541 return AVERROR(ENOMEM);
543 for (bandno = 0; bandno < reslevel->nbands; bandno++, gbandno++) {
544 ret = init_band(avctx, reslevel,
545 comp, codsty, qntsty,
546 bandno, gbandno, reslevelno,
555 void ff_jpeg2000_reinit(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
557 int reslevelno, bandno, cblkno, precno;
558 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
559 Jpeg2000ResLevel *rlevel = comp->reslevel + reslevelno;
560 for (bandno = 0; bandno < rlevel->nbands; bandno++) {
561 Jpeg2000Band *band = rlevel->band + bandno;
562 for(precno = 0; precno < rlevel->num_precincts_x * rlevel->num_precincts_y; precno++) {
563 Jpeg2000Prec *prec = band->prec + precno;
564 tag_tree_zero(prec->zerobits, prec->nb_codeblocks_width, prec->nb_codeblocks_height);
565 tag_tree_zero(prec->cblkincl, prec->nb_codeblocks_width, prec->nb_codeblocks_height);
566 for (cblkno = 0; cblkno < prec->nb_codeblocks_width * prec->nb_codeblocks_height; cblkno++) {
567 Jpeg2000Cblk *cblk = prec->cblk + cblkno;
576 void ff_jpeg2000_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
578 int reslevelno, bandno, precno;
580 comp->reslevel && reslevelno < codsty->nreslevels;
582 Jpeg2000ResLevel *reslevel;
587 reslevel = comp->reslevel + reslevelno;
588 for (bandno = 0; bandno < reslevel->nbands; bandno++) {
594 band = reslevel->band + bandno;
595 for (precno = 0; precno < reslevel->num_precincts_x * reslevel->num_precincts_y; precno++) {
597 Jpeg2000Prec *prec = band->prec + precno;
598 av_freep(&prec->zerobits);
599 av_freep(&prec->cblkincl);
600 av_freep(&prec->cblk);
604 av_freep(&band->prec);
606 av_freep(&reslevel->band);
609 ff_dwt_destroy(&comp->dwt);
610 av_freep(&comp->reslevel);
611 av_freep(&comp->i_data);
612 av_freep(&comp->f_data);