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/avassert.h"
29 #include "libavutil/common.h"
30 #include "libavutil/mem.h"
34 #define SHL(a, n) ((n) >= 0 ? (a) << (n) : (a) >> -(n))
36 /* tag tree routines */
38 /* allocate the memory for tag tree */
39 static int32_t tag_tree_size(uint16_t w, uint16_t h)
42 while (w > 1 || h > 1) {
44 av_assert0(res + 1 < INT32_MAX);
48 return (int32_t)(res + 1);
51 static Jpeg2000TgtNode *ff_jpeg2000_tag_tree_init(int w, int h)
54 Jpeg2000TgtNode *res, *t, *t2;
57 tt_size = tag_tree_size(w, h);
59 t = res = av_mallocz_array(tt_size, sizeof(*t));
63 while (w > 1 || h > 1) {
72 for (i = 0; i < ph; i++)
73 for (j = 0; j < pw; j++)
74 t[i * pw + j].parent = &t2[(i >> 1) * w + (j >> 1)];
82 uint8_t ff_jpeg2000_sigctxno_lut[256][4];
84 static int getsigctxno(int flag, int bandno)
88 h = ((flag & JPEG2000_T1_SIG_E) ? 1 : 0) +
89 ((flag & JPEG2000_T1_SIG_W) ? 1 : 0);
90 v = ((flag & JPEG2000_T1_SIG_N) ? 1 : 0) +
91 ((flag & JPEG2000_T1_SIG_S) ? 1 : 0);
92 d = ((flag & JPEG2000_T1_SIG_NE) ? 1 : 0) +
93 ((flag & JPEG2000_T1_SIG_NW) ? 1 : 0) +
94 ((flag & JPEG2000_T1_SIG_SE) ? 1 : 0) +
95 ((flag & JPEG2000_T1_SIG_SW) ? 1 : 0);
100 if (h == 2) return 8;
102 if (v >= 1) return 7;
103 if (d >= 1) return 6;
106 if (v == 2) return 4;
107 if (v == 1) return 3;
108 if (d >= 2) return 2;
109 if (d == 1) return 1;
111 if (d >= 3) return 8;
113 if (h+v >= 1) return 7;
117 if (h+v >= 2) return 5;
118 if (h+v == 1) return 4;
121 if (h+v >= 2) return 2;
122 if (h+v == 1) return 1;
127 uint8_t ff_jpeg2000_sgnctxno_lut[16][16], ff_jpeg2000_xorbit_lut[16][16];
129 static const int contribtab[3][3] = { { 0, -1, 1 }, { -1, -1, 0 }, { 1, 0, 1 } };
130 static const int ctxlbltab[3][3] = { { 13, 12, 11 }, { 10, 9, 10 }, { 11, 12, 13 } };
131 static const int xorbittab[3][3] = { { 1, 1, 1 }, { 1, 0, 0 }, { 0, 0, 0 } };
133 static int getsgnctxno(int flag, uint8_t *xorbit)
135 int vcontrib, hcontrib;
137 hcontrib = contribtab[flag & JPEG2000_T1_SIG_E ? flag & JPEG2000_T1_SGN_E ? 1 : 2 : 0]
138 [flag & JPEG2000_T1_SIG_W ? flag & JPEG2000_T1_SGN_W ? 1 : 2 : 0] + 1;
139 vcontrib = contribtab[flag & JPEG2000_T1_SIG_S ? flag & JPEG2000_T1_SGN_S ? 1 : 2 : 0]
140 [flag & JPEG2000_T1_SIG_N ? flag & JPEG2000_T1_SGN_N ? 1 : 2 : 0] + 1;
141 *xorbit = xorbittab[hcontrib][vcontrib];
143 return ctxlbltab[hcontrib][vcontrib];
146 void ff_jpeg2000_init_tier1_luts(void)
149 for (i = 0; i < 256; i++)
150 for (j = 0; j < 4; j++)
151 ff_jpeg2000_sigctxno_lut[i][j] = getsigctxno(i, j);
152 for (i = 0; i < 16; i++)
153 for (j = 0; j < 16; j++)
154 ff_jpeg2000_sgnctxno_lut[i][j] =
155 getsgnctxno(i + (j << 8), &ff_jpeg2000_xorbit_lut[i][j]);
158 void ff_jpeg2000_set_significance(Jpeg2000T1Context *t1, int x, int y,
163 t1->flags[y][x] |= JPEG2000_T1_SIG;
165 t1->flags[y][x + 1] |= JPEG2000_T1_SIG_W | JPEG2000_T1_SGN_W;
166 t1->flags[y][x - 1] |= JPEG2000_T1_SIG_E | JPEG2000_T1_SGN_E;
167 t1->flags[y + 1][x] |= JPEG2000_T1_SIG_N | JPEG2000_T1_SGN_N;
168 t1->flags[y - 1][x] |= JPEG2000_T1_SIG_S | JPEG2000_T1_SGN_S;
170 t1->flags[y][x + 1] |= JPEG2000_T1_SIG_W;
171 t1->flags[y][x - 1] |= JPEG2000_T1_SIG_E;
172 t1->flags[y + 1][x] |= JPEG2000_T1_SIG_N;
173 t1->flags[y - 1][x] |= JPEG2000_T1_SIG_S;
175 t1->flags[y + 1][x + 1] |= JPEG2000_T1_SIG_NW;
176 t1->flags[y + 1][x - 1] |= JPEG2000_T1_SIG_NE;
177 t1->flags[y - 1][x + 1] |= JPEG2000_T1_SIG_SW;
178 t1->flags[y - 1][x - 1] |= JPEG2000_T1_SIG_SE;
181 static const uint8_t lut_gain[2][4] = { { 0, 0, 0, 0 }, { 0, 1, 1, 2 } };
183 int ff_jpeg2000_init_component(Jpeg2000Component *comp,
184 Jpeg2000CodingStyle *codsty,
185 Jpeg2000QuantStyle *qntsty,
186 int cbps, int dx, int dy,
187 AVCodecContext *avctx)
189 uint8_t log2_band_prec_width, log2_band_prec_height;
190 int reslevelno, bandno, gbandno = 0, ret, i, j;
193 if (ret = ff_jpeg2000_dwt_init(&comp->dwt, comp->coord,
194 codsty->nreslevels2decode - 1,
197 // component size comp->coord is uint16_t so ir cannot overflow
198 csize = (comp->coord[0][1] - comp->coord[0][0]) *
199 (comp->coord[1][1] - comp->coord[1][0]);
201 if (codsty->transform == FF_DWT97) {
203 comp->f_data = av_malloc_array(csize, sizeof(*comp->f_data));
205 return AVERROR(ENOMEM);
208 comp->i_data = av_malloc_array(csize, sizeof(*comp->i_data));
210 return AVERROR(ENOMEM);
212 comp->reslevel = av_malloc_array(codsty->nreslevels, sizeof(*comp->reslevel));
214 return AVERROR(ENOMEM);
215 /* LOOP on resolution levels */
216 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
217 int declvl = codsty->nreslevels - reslevelno; // N_L -r see ISO/IEC 15444-1:2002 B.5
218 Jpeg2000ResLevel *reslevel = comp->reslevel + reslevelno;
220 /* Compute borders for each resolution level.
221 * Computation of trx_0, trx_1, try_0 and try_1.
222 * see ISO/IEC 15444-1:2002 eq. B.5 and B-14 */
223 for (i = 0; i < 2; i++)
224 for (j = 0; j < 2; j++)
225 reslevel->coord[i][j] =
226 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j], declvl - 1);
227 // update precincts size: 2^n value
228 reslevel->log2_prec_width = codsty->log2_prec_widths[reslevelno];
229 reslevel->log2_prec_height = codsty->log2_prec_heights[reslevelno];
231 /* Number of bands for each resolution level */
233 reslevel->nbands = 1;
235 reslevel->nbands = 3;
237 /* Number of precincts wich span the tile for resolution level reslevelno
238 * see B.6 in ISO/IEC 15444-1:2002 eq. B-16
239 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -| - (trx_0 / 2 ^ log2_prec_width)
240 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| - (try_0 / 2 ^ log2_prec_width)
241 * for Dcinema profiles in JPEG 2000
242 * num_precincts_x = |- trx_1 / 2 ^ log2_prec_width) -|
243 * num_precincts_y = |- try_1 / 2 ^ log2_prec_width) -| */
244 if (reslevel->coord[0][1] == reslevel->coord[0][0])
245 reslevel->num_precincts_x = 0;
247 reslevel->num_precincts_x =
248 ff_jpeg2000_ceildivpow2(reslevel->coord[0][1],
249 reslevel->log2_prec_width) -
250 (reslevel->coord[0][0] >> reslevel->log2_prec_width);
252 if (reslevel->coord[1][1] == reslevel->coord[1][0])
253 reslevel->num_precincts_y = 0;
255 reslevel->num_precincts_y =
256 ff_jpeg2000_ceildivpow2(reslevel->coord[1][1],
257 reslevel->log2_prec_height) -
258 (reslevel->coord[1][0] >> reslevel->log2_prec_height);
260 reslevel->band = av_malloc_array(reslevel->nbands, sizeof(*reslevel->band));
262 return AVERROR(ENOMEM);
264 for (bandno = 0; bandno < reslevel->nbands; bandno++, gbandno++) {
265 Jpeg2000Band *band = reslevel->band + bandno;
269 /* TODO: Implementation of quantization step not finished,
270 * see ISO/IEC 15444-1:2002 E.1 and A.6.4. */
271 switch (qntsty->quantsty) {
274 case JPEG2000_QSTY_NONE:
275 /* TODO: to verify. No quantization in this case */
276 band->f_stepsize = 1;
278 case JPEG2000_QSTY_SI:
279 /*TODO: Compute formula to implement. */
281 lut_gain[codsty->transform == FF_DWT53][bandno + (reslevelno > 0)];
282 band->f_stepsize = (float)SHL(2048 + qntsty->mant[gbandno],
283 2 + numbps - qntsty->expn[gbandno]);
285 case JPEG2000_QSTY_SE:
286 /* Exponent quantization step.
288 * delta_b = 2 ^ (R_b - expn_b) * (1 + (mant_b / 2 ^ 11))
289 * R_b = R_I + log2 (gain_b )
290 * see ISO/IEC 15444-1:2002 E.1.1 eqn. E-3 and E-4 */
291 /* TODO/WARN: value of log2 (gain_b ) not taken into account
292 * but it works (compared to OpenJPEG). Why?
293 * Further investigation needed. */
295 band->f_stepsize = pow(2.0, gain - qntsty->expn[gbandno]);
296 band->f_stepsize *= (float)qntsty->mant[gbandno] / 2048.0 + 1.0;
299 band->f_stepsize = 0;
300 av_log(avctx, AV_LOG_ERROR, "Unknown quantization format\n");
303 /* FIXME: In openjepg code stespize = stepsize * 0.5. Why?
304 * If not set output of entropic decoder is not correct. */
305 if (!av_codec_is_encoder(avctx->codec))
306 band->f_stepsize *= 0.5;
308 band->i_stepsize = (int32_t)(band->f_stepsize * (1 << 16));
310 /* computation of tbx_0, tbx_1, tby_0, tby_1
311 * see ISO/IEC 15444-1:2002 B.5 eq. B-15 and tbl B.1
312 * codeblock width and height is computed for
313 * DCI JPEG 2000 codeblock_width = codeblock_width = 32 = 2 ^ 5 */
314 if (reslevelno == 0) {
315 /* for reslevelno = 0, only one band, x0_b = y0_b = 0 */
316 for (i = 0; i < 2; i++)
317 for (j = 0; j < 2; j++)
319 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j],
322 log2_band_prec_width = reslevel->log2_prec_width;
323 log2_band_prec_height = reslevel->log2_prec_height;
324 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
325 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
326 reslevel->log2_prec_width);
327 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
328 reslevel->log2_prec_height);
330 /* 3 bands x0_b = 1 y0_b = 0; x0_b = 0 y0_b = 1; x0_b = y0_b = 1 */
331 /* x0_b and y0_b are computed with ((bandno + 1 >> i) & 1) */
332 for (i = 0; i < 2; i++)
333 for (j = 0; j < 2; j++)
334 /* Formula example for tbx_0 = ceildiv((tcx_0 - 2 ^ (declvl - 1) * x0_b) / declvl) */
336 ff_jpeg2000_ceildivpow2(comp->coord_o[i][j] -
337 (((bandno + 1 >> i) & 1) << declvl - 1),
339 /* TODO: Manage case of 3 band offsets here or
340 * in coding/decoding function? */
342 /* see ISO/IEC 15444-1:2002 eq. B-17 and eq. B-15 */
343 band->log2_cblk_width = FFMIN(codsty->log2_cblk_width,
344 reslevel->log2_prec_width - 1);
345 band->log2_cblk_height = FFMIN(codsty->log2_cblk_height,
346 reslevel->log2_prec_height - 1);
348 log2_band_prec_width = reslevel->log2_prec_width - 1;
349 log2_band_prec_height = reslevel->log2_prec_height - 1;
352 band->prec = av_malloc_array(reslevel->num_precincts_x *
353 reslevel->num_precincts_y,
354 sizeof(*band->prec));
356 return AVERROR(ENOMEM);
358 nb_precincts = reslevel->num_precincts_x * reslevel->num_precincts_y;
360 for (precno = 0; precno < nb_precincts; precno++) {
361 Jpeg2000Prec *prec = band->prec + precno;
363 /* TODO: Explain formula for JPEG200 DCINEMA. */
364 /* TODO: Verify with previous count of codeblocks per band */
367 prec->coord[0][0] = (precno % reslevel->num_precincts_x) *
368 (1 << log2_band_prec_width);
369 prec->coord[0][0] = FFMAX(prec->coord[0][0], band->coord[0][0]);
372 prec->coord[1][0] = (precno / reslevel->num_precincts_x) *
373 (1 << log2_band_prec_height);
374 prec->coord[1][0] = FFMAX(prec->coord[1][0], band->coord[1][0]);
377 prec->coord[0][1] = prec->coord[0][0] +
378 (1 << log2_band_prec_width);
379 prec->coord[0][1] = FFMIN(prec->coord[0][1], band->coord[0][1]);
382 prec->coord[1][1] = prec->coord[1][0] +
383 (1 << log2_band_prec_height);
384 prec->coord[1][1] = FFMIN(prec->coord[1][1], band->coord[1][1]);
386 prec->nb_codeblocks_width =
387 ff_jpeg2000_ceildivpow2(prec->coord[0][1] -
389 band->log2_cblk_width);
390 prec->nb_codeblocks_height =
391 ff_jpeg2000_ceildivpow2(prec->coord[1][1] -
393 band->log2_cblk_height);
395 /* Tag trees initialization */
397 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
398 prec->nb_codeblocks_height);
400 return AVERROR(ENOMEM);
403 ff_jpeg2000_tag_tree_init(prec->nb_codeblocks_width,
404 prec->nb_codeblocks_height);
406 return AVERROR(ENOMEM);
408 prec->cblk = av_malloc_array(prec->nb_codeblocks_width *
409 prec->nb_codeblocks_height,
410 sizeof(*prec->cblk));
412 return AVERROR(ENOMEM);
413 for (cblkno = 0; cblkno < prec->nb_codeblocks_width * prec->nb_codeblocks_height; cblkno++) {
414 Jpeg2000Cblk *cblk = prec->cblk + cblkno;
417 /* Compute coordinates of codeblocks */
419 Cx0 = (prec->coord[0][0] >> band->log2_cblk_width) << band->log2_cblk_width;
420 Cx0 = Cx0 + ((cblkno % prec->nb_codeblocks_width) << band->log2_cblk_width);
421 cblk->coord[0][0] = FFMAX(Cx0, prec->coord[0][0]);
424 Cy0 = (prec->coord[1][0] >> band->log2_cblk_height) << band->log2_cblk_height;
425 Cy0 = Cy0 + ((cblkno / prec->nb_codeblocks_width) << band->log2_cblk_height);
426 cblk->coord[1][0] = FFMAX(Cy0, prec->coord[1][0]);
429 cblk->coord[0][1] = FFMIN(Cx0 + (1 << band->log2_cblk_width),
433 cblk->coord[1][1] = FFMIN(Cy0 + (1 << band->log2_cblk_height),
436 if((bandno + !!reslevelno) & 1) {
437 cblk->coord[0][0] += comp->reslevel[reslevelno-1].coord[0][1] - comp->reslevel[reslevelno-1].coord[0][0];
438 cblk->coord[0][1] += comp->reslevel[reslevelno-1].coord[0][1] - comp->reslevel[reslevelno-1].coord[0][0];
440 if((bandno + !!reslevelno) & 2) {
441 cblk->coord[1][0] += comp->reslevel[reslevelno-1].coord[1][1] - comp->reslevel[reslevelno-1].coord[1][0];
442 cblk->coord[1][1] += comp->reslevel[reslevelno-1].coord[1][1] - comp->reslevel[reslevelno-1].coord[1][0];
457 void ff_jpeg2000_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
459 int reslevelno, bandno, precno;
460 for (reslevelno = 0; reslevelno < codsty->nreslevels; reslevelno++) {
461 Jpeg2000ResLevel *reslevel = comp->reslevel + reslevelno;
463 for (bandno = 0; bandno < reslevel->nbands; bandno++) {
464 Jpeg2000Band *band = reslevel->band + bandno;
465 for (precno = 0; precno < reslevel->num_precincts_x * reslevel->num_precincts_y; precno++) {
466 Jpeg2000Prec *prec = band->prec + precno;
467 av_freep(&prec->zerobits);
468 av_freep(&prec->cblkincl);
469 av_freep(&prec->cblk);
472 av_freep(&band->prec);
474 av_freep(&reslevel->band);
477 ff_dwt_destroy(&comp->dwt);
478 av_freep(&comp->reslevel);
479 av_freep(&comp->i_data);
480 av_freep(&comp->f_data);