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"
36 #define SHL(a, n) ((n) >= 0 ? (a) << (n) : (a) >> -(n))
38 /* tag tree routines */
40 /* allocate the memory for tag tree */
41 static int32_t tag_tree_size(int w, int h)
44 while (w > 1 || h > 1) {
45 res += w * (int64_t)h;
46 av_assert0(res + 1 < INT32_MAX);
50 return (int32_t)(res + 1);
53 static Jpeg2000TgtNode *ff_jpeg2000_tag_tree_init(int w, int h)
56 Jpeg2000TgtNode *res, *t, *t2;
59 tt_size = tag_tree_size(w, h);
61 t = res = av_mallocz_array(tt_size, sizeof(*t));
65 while (w > 1 || h > 1) {
74 for (i = 0; i < ph; i++)
75 for (j = 0; j < pw; j++)
76 t[i * pw + j].parent = &t2[(i >> 1) * w + (j >> 1)];
84 static void tag_tree_zero(Jpeg2000TgtNode *t, int w, int h)
86 int i, siz = tag_tree_size(w, h);
88 for (i = 0; i < siz; i++) {
94 uint8_t ff_jpeg2000_sigctxno_lut[256][4];
96 static int getsigctxno(int flag, int bandno)
100 h = ((flag & JPEG2000_T1_SIG_E) ? 1 : 0) +
101 ((flag & JPEG2000_T1_SIG_W) ? 1 : 0);
102 v = ((flag & JPEG2000_T1_SIG_N) ? 1 : 0) +
103 ((flag & JPEG2000_T1_SIG_S) ? 1 : 0);
104 d = ((flag & JPEG2000_T1_SIG_NE) ? 1 : 0) +
105 ((flag & JPEG2000_T1_SIG_NW) ? 1 : 0) +
106 ((flag & JPEG2000_T1_SIG_SE) ? 1 : 0) +
107 ((flag & JPEG2000_T1_SIG_SW) ? 1 : 0);
112 if (h == 2) return 8;
114 if (v >= 1) return 7;
115 if (d >= 1) return 6;
118 if (v == 2) return 4;
119 if (v == 1) return 3;
120 if (d >= 2) return 2;
121 if (d == 1) return 1;
123 if (d >= 3) return 8;
125 if (h+v >= 1) return 7;
129 if (h+v >= 2) return 5;
130 if (h+v == 1) return 4;
133 if (h+v >= 2) return 2;
134 if (h+v == 1) return 1;
139 uint8_t ff_jpeg2000_sgnctxno_lut[16][16], ff_jpeg2000_xorbit_lut[16][16];
141 static const int contribtab[3][3] = { { 0, -1, 1 }, { -1, -1, 0 }, { 1, 0, 1 } };
142 static const int ctxlbltab[3][3] = { { 13, 12, 11 }, { 10, 9, 10 }, { 11, 12, 13 } };
143 static const int xorbittab[3][3] = { { 1, 1, 1 }, { 1, 0, 0 }, { 0, 0, 0 } };
145 static int getsgnctxno(int flag, uint8_t *xorbit)
147 int vcontrib, hcontrib;
149 hcontrib = contribtab[flag & JPEG2000_T1_SIG_E ? flag & JPEG2000_T1_SGN_E ? 1 : 2 : 0]
150 [flag & JPEG2000_T1_SIG_W ? flag & JPEG2000_T1_SGN_W ? 1 : 2 : 0] + 1;
151 vcontrib = contribtab[flag & JPEG2000_T1_SIG_S ? flag & JPEG2000_T1_SGN_S ? 1 : 2 : 0]
152 [flag & JPEG2000_T1_SIG_N ? flag & JPEG2000_T1_SGN_N ? 1 : 2 : 0] + 1;
153 *xorbit = xorbittab[hcontrib][vcontrib];
155 return ctxlbltab[hcontrib][vcontrib];
158 void av_cold ff_jpeg2000_init_tier1_luts(void)
161 for (i = 0; i < 256; i++)
162 for (j = 0; j < 4; j++)
163 ff_jpeg2000_sigctxno_lut[i][j] = getsigctxno(i, j);
164 for (i = 0; i < 16; i++)
165 for (j = 0; j < 16; j++)
166 ff_jpeg2000_sgnctxno_lut[i][j] =
167 getsgnctxno(i + (j << 8), &ff_jpeg2000_xorbit_lut[i][j]);
170 void ff_jpeg2000_set_significance(Jpeg2000T1Context *t1, int x, int y,
175 t1->flags[(y) * t1->stride + x] |= JPEG2000_T1_SIG;
177 t1->flags[(y) * t1->stride + x + 1] |= JPEG2000_T1_SIG_W | JPEG2000_T1_SGN_W;
178 t1->flags[(y) * t1->stride + x - 1] |= JPEG2000_T1_SIG_E | JPEG2000_T1_SGN_E;
179 t1->flags[(y + 1) * t1->stride + x] |= JPEG2000_T1_SIG_N | JPEG2000_T1_SGN_N;
180 t1->flags[(y - 1) * t1->stride + x] |= JPEG2000_T1_SIG_S | JPEG2000_T1_SGN_S;
182 t1->flags[(y) * t1->stride + x + 1] |= JPEG2000_T1_SIG_W;
183 t1->flags[(y) * t1->stride + x - 1] |= JPEG2000_T1_SIG_E;
184 t1->flags[(y + 1) * t1->stride + x] |= JPEG2000_T1_SIG_N;
185 t1->flags[(y - 1) * t1->stride + x] |= JPEG2000_T1_SIG_S;
187 t1->flags[(y + 1) * t1->stride + x + 1] |= JPEG2000_T1_SIG_NW;
188 t1->flags[(y + 1) * t1->stride + x - 1] |= JPEG2000_T1_SIG_NE;
189 t1->flags[(y - 1) * t1->stride + x + 1] |= JPEG2000_T1_SIG_SW;
190 t1->flags[(y - 1) * t1->stride + x - 1] |= JPEG2000_T1_SIG_SE;
193 // static const uint8_t lut_gain[2][4] = { { 0, 0, 0, 0 }, { 0, 1, 1, 2 } }; (unused)
195 static void init_band_stepsize(AVCodecContext *avctx,
197 Jpeg2000CodingStyle *codsty,
198 Jpeg2000QuantStyle *qntsty,
199 int bandno, int gbandno, int reslevelno,
202 /* TODO: Implementation of quantization step not finished,
203 * see ISO/IEC 15444-1:2002 E.1 and A.6.4. */
204 switch (qntsty->quantsty) {
206 case JPEG2000_QSTY_NONE:
207 /* TODO: to verify. No quantization in this case */
208 band->f_stepsize = 1;
210 case JPEG2000_QSTY_SI:
211 /*TODO: Compute formula to implement. */
213 // lut_gain[codsty->transform == FF_DWT53][bandno + (reslevelno > 0)];
214 // band->f_stepsize = SHL(2048 + qntsty->mant[gbandno],
215 // 2 + numbps - qntsty->expn[gbandno]);
217 case JPEG2000_QSTY_SE:
218 /* Exponent quantization step.
220 * delta_b = 2 ^ (R_b - expn_b) * (1 + (mant_b / 2 ^ 11))
221 * R_b = R_I + log2 (gain_b )
222 * see ISO/IEC 15444-1:2002 E.1.1 eqn. E-3 and E-4 */
224 band->f_stepsize = pow(2.0, gain - qntsty->expn[gbandno]);
225 band->f_stepsize *= qntsty->mant[gbandno] / 2048.0 + 1.0;
228 band->f_stepsize = 0;
229 av_log(avctx, AV_LOG_ERROR, "Unknown quantization format\n");
232 if (codsty->transform != FF_DWT53) {
234 switch (bandno + (reslevelno > 0)) {
237 band->f_stepsize *= F_LFTG_X * 2;
241 band->f_stepsize *= F_LFTG_X * F_LFTG_X * 4;
244 if (codsty->transform == FF_DWT97) {
245 band->f_stepsize *= pow(F_LFTG_K, 2*(codsty->nreslevels2decode - reslevelno) + lband - 2);
249 band->i_stepsize = band->f_stepsize * (1 << 15);
251 /* FIXME: In openjepg code stespize = stepsize * 0.5. Why?
252 * If not set output of entropic decoder is not correct. */
253 if (!av_codec_is_encoder(avctx->codec))
254 band->f_stepsize *= 0.5;
257 static int init_prec(Jpeg2000Band *band,
258 Jpeg2000ResLevel *reslevel,
259 Jpeg2000Component *comp,
260 int precno, int bandno, int reslevelno,
261 int log2_band_prec_width,
262 int log2_band_prec_height)
264 Jpeg2000Prec *prec = band->prec + precno;
265 int nb_codeblocks, cblkno;
267 prec->decoded_layers = 0;
269 /* TODO: Explain formula for JPEG200 DCINEMA. */
270 /* TODO: Verify with previous count of codeblocks per band */
273 prec->coord[0][0] = ((band->coord[0][0] >> log2_band_prec_width) + precno % reslevel->num_precincts_x) *
274 (1 << log2_band_prec_width);
277 prec->coord[1][0] = ((band->coord[1][0] >> log2_band_prec_height) + precno / reslevel->num_precincts_x) *
278 (1 << log2_band_prec_height);
281 prec->coord[0][1] = prec->coord[0][0] +
282 (1 << log2_band_prec_width);
283 prec->coord[0][0] = FFMAX(prec->coord[0][0], band->coord[0][0]);
284 prec->coord[0][1] = FFMIN(prec->coord[0][1], band->coord[0][1]);
287 prec->coord[1][1] = prec->coord[1][0] +
288 (1 << log2_band_prec_height);
289 prec->coord[1][0] = FFMAX(prec->coord[1][0], band->coord[1][0]);
290 prec->coord[1][1] = FFMIN(prec->coord[1][1], band->coord[1][1]);
292 prec->nb_codeblocks_width =
293 ff_jpeg2000_ceildivpow2(prec->coord[0][1],
294 band->log2_cblk_width)
295 - (prec->coord[0][0] >> band->log2_cblk_width);
296 prec->nb_codeblocks_height =
297 ff_jpeg2000_ceildivpow2(prec->coord[1][1],
298 band->log2_cblk_height)
299 - (prec->coord[1][0] >> band->log2_cblk_height);
302 /* Tag trees initialization */
304 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
305 prec->nb_codeblocks_height);
307 return AVERROR(ENOMEM);
310 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
311 prec->nb_codeblocks_height);
313 return AVERROR(ENOMEM);
315 if (prec->nb_codeblocks_width * (uint64_t)prec->nb_codeblocks_height > INT_MAX) {
317 return AVERROR(ENOMEM);
319 nb_codeblocks = prec->nb_codeblocks_width * prec->nb_codeblocks_height;
320 prec->cblk = av_mallocz_array(nb_codeblocks, sizeof(*prec->cblk));
322 return AVERROR(ENOMEM);
323 for (cblkno = 0; cblkno < nb_codeblocks; cblkno++) {
324 Jpeg2000Cblk *cblk = prec->cblk + cblkno;
327 /* Compute coordinates of codeblocks */
329 Cx0 = ((prec->coord[0][0]) >> band->log2_cblk_width) << band->log2_cblk_width;
330 Cx0 = Cx0 + ((cblkno % prec->nb_codeblocks_width) << band->log2_cblk_width);
331 cblk->coord[0][0] = FFMAX(Cx0, prec->coord[0][0]);
334 Cy0 = ((prec->coord[1][0]) >> band->log2_cblk_height) << band->log2_cblk_height;
335 Cy0 = Cy0 + ((cblkno / prec->nb_codeblocks_width) << band->log2_cblk_height);
336 cblk->coord[1][0] = FFMAX(Cy0, prec->coord[1][0]);
339 cblk->coord[0][1] = FFMIN(Cx0 + (1 << band->log2_cblk_width),
343 cblk->coord[1][1] = FFMIN(Cy0 + (1 << band->log2_cblk_height),
345 /* Update code-blocks coordinates according sub-band position */
346 if ((bandno + !!reslevelno) & 1) {
347 cblk->coord[0][0] += comp->reslevel[reslevelno-1].coord[0][1] -
348 comp->reslevel[reslevelno-1].coord[0][0];
349 cblk->coord[0][1] += comp->reslevel[reslevelno-1].coord[0][1] -
350 comp->reslevel[reslevelno-1].coord[0][0];
352 if ((bandno + !!reslevelno) & 2) {
353 cblk->coord[1][0] += comp->reslevel[reslevelno-1].coord[1][1] -
354 comp->reslevel[reslevelno-1].coord[1][0];
355 cblk->coord[1][1] += comp->reslevel[reslevelno-1].coord[1][1] -
356 comp->reslevel[reslevelno-1].coord[1][0];
362 memset(cblk->lengthinc, 0, sizeof(cblk->lengthinc));
369 static int init_band(AVCodecContext *avctx,
370 Jpeg2000ResLevel *reslevel,
371 Jpeg2000Component *comp,
372 Jpeg2000CodingStyle *codsty,
373 Jpeg2000QuantStyle *qntsty,
374 int bandno, int gbandno, int reslevelno,
375 int cbps, int dx, int dy)
377 Jpeg2000Band *band = reslevel->band + bandno;
378 uint8_t log2_band_prec_width, log2_band_prec_height;
379 int declvl = codsty->nreslevels - reslevelno; // N_L -r see ISO/IEC 15444-1:2002 B.5
384 init_band_stepsize(avctx, band, codsty, qntsty, bandno, gbandno, reslevelno, cbps);
386 /* computation of tbx_0, tbx_1, tby_0, tby_1
387 * see ISO/IEC 15444-1:2002 B.5 eq. B-15 and tbl B.1
388 * codeblock width and height is computed for
389 * DCI JPEG 2000 codeblock_width = codeblock_width = 32 = 2 ^ 5 */
390 if (reslevelno == 0) {
391 /* for reslevelno = 0, only one band, x0_b = y0_b = 0 */
392 for (i = 0; i < 2; i++)
393 for (j = 0; j < 2; j++)
395 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j],
397 log2_band_prec_width = reslevel->log2_prec_width;
398 log2_band_prec_height = reslevel->log2_prec_height;
399 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
400 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
401 reslevel->log2_prec_width);
402 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
403 reslevel->log2_prec_height);
405 /* 3 bands x0_b = 1 y0_b = 0; x0_b = 0 y0_b = 1; x0_b = y0_b = 1 */
406 /* x0_b and y0_b are computed with ((bandno + 1 >> i) & 1) */
407 for (i = 0; i < 2; i++)
408 for (j = 0; j < 2; j++)
409 /* Formula example for tbx_0 = ceildiv((tcx_0 - 2 ^ (declvl - 1) * x0_b) / declvl) */
411 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j] -
412 (((bandno + 1 >> i) & 1LL) << declvl - 1),
414 /* TODO: Manage case of 3 band offsets here or
415 * in coding/decoding function? */
417 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
418 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
419 reslevel->log2_prec_width - 1);
420 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
421 reslevel->log2_prec_height - 1);
423 log2_band_prec_width = reslevel->log2_prec_width - 1;
424 log2_band_prec_height = reslevel->log2_prec_height - 1;
427 if (reslevel->num_precincts_x * (uint64_t)reslevel->num_precincts_y > INT_MAX) {
429 return AVERROR(ENOMEM);
431 nb_precincts = reslevel->num_precincts_x * reslevel->num_precincts_y;
432 band->prec = av_mallocz_array(nb_precincts, sizeof(*band->prec));
434 return AVERROR(ENOMEM);
436 for (precno = 0; precno < nb_precincts; precno++) {
437 ret = init_prec(band, reslevel, comp,
438 precno, bandno, reslevelno,
439 log2_band_prec_width, log2_band_prec_height);
447 int ff_jpeg2000_init_component(Jpeg2000Component *comp,
448 Jpeg2000CodingStyle *codsty,
449 Jpeg2000QuantStyle *qntsty,
450 int cbps, int dx, int dy,
451 AVCodecContext *avctx)
453 int reslevelno, bandno, gbandno = 0, ret, i, j;
456 if (codsty->nreslevels2decode <= 0) {
457 av_log(avctx, AV_LOG_ERROR, "nreslevels2decode %d invalid or uninitialized\n", codsty->nreslevels2decode);
458 return AVERROR_INVALIDDATA;
461 if (ret = ff_jpeg2000_dwt_init(&comp->dwt, comp->coord,
462 codsty->nreslevels2decode - 1,
466 if (av_image_check_size(comp->coord[0][1] - comp->coord[0][0],
467 comp->coord[1][1] - comp->coord[1][0], 0, avctx))
468 return AVERROR_INVALIDDATA;
469 csize = (comp->coord[0][1] - comp->coord[0][0]) *
470 (comp->coord[1][1] - comp->coord[1][0]);
471 if (comp->coord[0][1] - comp->coord[0][0] > 32768 ||
472 comp->coord[1][1] - comp->coord[1][0] > 32768) {
473 av_log(avctx, AV_LOG_ERROR, "component size too large\n");
474 return AVERROR_PATCHWELCOME;
477 if (codsty->transform == FF_DWT97) {
478 csize += AV_INPUT_BUFFER_PADDING_SIZE / sizeof(*comp->f_data);
480 comp->f_data = av_mallocz_array(csize, sizeof(*comp->f_data));
482 return AVERROR(ENOMEM);
484 csize += AV_INPUT_BUFFER_PADDING_SIZE / sizeof(*comp->i_data);
486 comp->i_data = av_mallocz_array(csize, sizeof(*comp->i_data));
488 return AVERROR(ENOMEM);
490 comp->reslevel = av_mallocz_array(codsty->nreslevels, sizeof(*comp->reslevel));
492 return AVERROR(ENOMEM);
493 /* LOOP on resolution levels */
494 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
495 int declvl = codsty->nreslevels - reslevelno; // N_L -r see ISO/IEC 15444-1:2002 B.5
496 Jpeg2000ResLevel *reslevel = comp->reslevel + reslevelno;
498 /* Compute borders for each resolution level.
499 * Computation of trx_0, trx_1, try_0 and try_1.
500 * see ISO/IEC 15444-1:2002 eq. B.5 and B-14 */
501 for (i = 0; i < 2; i++)
502 for (j = 0; j < 2; j++)
503 reslevel->coord[i][j] =
504 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j], declvl - 1);
505 // update precincts size: 2^n value
506 reslevel->log2_prec_width = codsty->log2_prec_widths[reslevelno];
507 reslevel->log2_prec_height = codsty->log2_prec_heights[reslevelno];
509 /* Number of bands for each resolution level */
511 reslevel->nbands = 1;
513 reslevel->nbands = 3;
515 /* Number of precincts which span the tile for resolution level reslevelno
516 * see B.6 in ISO/IEC 15444-1:2002 eq. B-16
517 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -| - (trx_0 / 2 ^ log2_prec_width)
518 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| - (try_0 / 2 ^ log2_prec_width)
519 * for Dcinema profiles in JPEG 2000
520 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -|
521 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| */
522 if (reslevel->coord[0][1] == reslevel->coord[0][0])
523 reslevel->num_precincts_x = 0;
525 reslevel->num_precincts_x =
526 ff_jpeg2000_ceildivpow2(reslevel->coord[0][1],
527 reslevel->log2_prec_width) -
528 (reslevel->coord[0][0] >> reslevel->log2_prec_width);
530 if (reslevel->coord[1][1] == reslevel->coord[1][0])
531 reslevel->num_precincts_y = 0;
533 reslevel->num_precincts_y =
534 ff_jpeg2000_ceildivpow2(reslevel->coord[1][1],
535 reslevel->log2_prec_height) -
536 (reslevel->coord[1][0] >> reslevel->log2_prec_height);
538 reslevel->band = av_mallocz_array(reslevel->nbands, sizeof(*reslevel->band));
540 return AVERROR(ENOMEM);
542 for (bandno = 0; bandno < reslevel->nbands; bandno++, gbandno++) {
543 ret = init_band(avctx, reslevel,
544 comp, codsty, qntsty,
545 bandno, gbandno, reslevelno,
554 void ff_jpeg2000_reinit(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
556 int reslevelno, bandno, cblkno, precno;
557 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
558 Jpeg2000ResLevel *rlevel = comp->reslevel + reslevelno;
559 for (bandno = 0; bandno < rlevel->nbands; bandno++) {
560 Jpeg2000Band *band = rlevel->band + bandno;
561 for(precno = 0; precno < rlevel->num_precincts_x * rlevel->num_precincts_y; precno++) {
562 Jpeg2000Prec *prec = band->prec + precno;
563 tag_tree_zero(prec->zerobits, prec->nb_codeblocks_width, prec->nb_codeblocks_height);
564 tag_tree_zero(prec->cblkincl, prec->nb_codeblocks_width, prec->nb_codeblocks_height);
565 for (cblkno = 0; cblkno < prec->nb_codeblocks_width * prec->nb_codeblocks_height; cblkno++) {
566 Jpeg2000Cblk *cblk = prec->cblk + cblkno;
575 void ff_jpeg2000_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
577 int reslevelno, bandno, precno;
579 comp->reslevel && reslevelno < codsty->nreslevels;
581 Jpeg2000ResLevel *reslevel;
586 reslevel = comp->reslevel + reslevelno;
587 for (bandno = 0; bandno < reslevel->nbands; bandno++) {
593 band = reslevel->band + bandno;
594 for (precno = 0; precno < reslevel->num_precincts_x * reslevel->num_precincts_y; precno++) {
596 Jpeg2000Prec *prec = band->prec + precno;
597 av_freep(&prec->zerobits);
598 av_freep(&prec->cblkincl);
599 av_freep(&prec->cblk);
603 av_freep(&band->prec);
605 av_freep(&reslevel->band);
608 ff_dwt_destroy(&comp->dwt);
609 av_freep(&comp->reslevel);
610 av_freep(&comp->i_data);
611 av_freep(&comp->f_data);