git.sesse.net Git - ffmpeg/blob - libavcodec/j2k.h

   1 /*
   2  * JPEG 2000 common defines, structures and functions
   3  * Copyright (c) 2007 Kamil Nowosad
   4  * Copyright (c) 2013 Nicolas Bertrand <nicoinattendu@gmail.com>
   5  *
   6  * This file is part of FFmpeg.
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #ifndef AVCODEC_J2K_H
  24 #define AVCODEC_J2K_H
  25
  26 /**
  27  * @file
  28  * JPEG 2000 structures and defines common
  29  * to encoder and decoder
  30  */
  31
  32 #include <stdint.h>
  33
  34 #include "avcodec.h"
  35 #include "mqc.h"
  36 #include "j2k_dwt.h"
  37
  38 enum Jpeg2000Markers {
  39     JPEG2000_SOC = 0xff4f, // start of codestream
  40     JPEG2000_SIZ = 0xff51, // image and tile size
  41     JPEG2000_COD,          // coding style default
  42     JPEG2000_COC,          // coding style component
  43     JPEG2000_TLM = 0xff55, // packed packet headers, tile-part header
  44     JPEG2000_PLM = 0xff57, // tile-part lengths
  45     JPEG2000_PLT,          // packet length, main header
  46     JPEG2000_QCD = 0xff5c, // quantization default
  47     JPEG2000_QCC,          // quantization component
  48     JPEG2000_RGN,          // region of interest
  49     JPEG2000_POC,          // progression order change
  50     JPEG2000_PPM,          // packet length, tile-part header
  51     JPEG2000_PPT,          // packed packet headers, main header
  52     JPEG2000_CRG = 0xff63, // component registration
  53     JPEG2000_COM,          // comment
  54     JPEG2000_SOT = 0xff90, // start of tile-part
  55     JPEG2000_SOP,          // start of packet
  56     JPEG2000_EPH,          // end of packet header
  57     JPEG2000_SOD,          // start of data
  58     JPEG2000_EOC = 0xffd9, // end of codestream
  59 };
  60
  61 enum Jpeg2000Quantsty { // quantization style
  62     JPEG2000_QSTY_NONE, // no quantization
  63     JPEG2000_QSTY_SI,   // scalar derived
  64     JPEG2000_QSTY_SE    // scalar expounded
  65 };
  66
  67 #define JPEG2000_MAX_CBLKW 64
  68 #define JPEG2000_MAX_CBLKH 64
  69
  70 #define JPEG2000_MAX_RESLEVELS 33
  71
  72 // T1 flags
  73 // flags determining significance of neighbor coefficients
  74 #define JPEG2000_T1_SIG_N  0x0001
  75 #define JPEG2000_T1_SIG_E  0x0002
  76 #define JPEG2000_T1_SIG_W  0x0004
  77 #define JPEG2000_T1_SIG_S  0x0008
  78 #define JPEG2000_T1_SIG_NE 0x0010
  79 #define JPEG2000_T1_SIG_NW 0x0020
  80 #define JPEG2000_T1_SIG_SE 0x0040
  81 #define JPEG2000_T1_SIG_SW 0x0080
  82 #define JPEG2000_T1_SIG_NB (JPEG2000_T1_SIG_N  | JPEG2000_T1_SIG_E  |   \
  83                             JPEG2000_T1_SIG_S  | JPEG2000_T1_SIG_W  |   \
  84                             JPEG2000_T1_SIG_NE | JPEG2000_T1_SIG_NW |   \
  85                             JPEG2000_T1_SIG_SE | JPEG2000_T1_SIG_SW)
  86 // flags determining sign bit of neighbor coefficients
  87 #define JPEG2000_T1_SGN_N  0x0100
  88 #define JPEG2000_T1_SGN_S  0x0200
  89 #define JPEG2000_T1_SGN_W  0x0400
  90 #define JPEG2000_T1_SGN_E  0x0800
  91
  92 #define JPEG2000_T1_VIS    0x1000
  93 #define JPEG2000_T1_SIG    0x2000
  94 #define JPEG2000_T1_REF    0x4000
  95
  96 #define JPEG2000_T1_SGN    0x8000
  97
  98 // Codeblock coding styles
  99 #define JPEG2000_CBLK_BYPASS    0x01 // Selective arithmetic coding bypass
 100 #define JPEG2000_CBLK_RESET     0x02 // Reset context probabilities
 101 #define JPEG2000_CBLK_TERMALL   0x04 // Terminate after each coding pass
 102 #define JPEG2000_CBLK_VSC       0x08 // Vertical stripe causal context formation
 103 #define JPEG2000_CBLK_PREDTERM  0x10 // Predictable termination
 104 #define JPEG2000_CBLK_SEGSYM    0x20 // Segmentation symbols present
 105
 106 // Coding styles
 107 #define JPEG2000_CSTY_PREC      0x01 // Precincts defined in coding style
 108 #define JPEG2000_CSTY_SOP       0x02 // SOP marker present
 109 #define JPEG2000_CSTY_EPH       0x04 // EPH marker present
 110
 111 // Progression orders
 112 #define JPEG2000_PGOD_LRCP      0x00  // Layer-resolution level-component-position progression
 113 #define JPEG2000_PGOD_RLCP      0x01  // Resolution level-layer-component-position progression
 114 #define JPEG2000_PGOD_RPCL      0x02  // Resolution level-position-component-layer progression
 115 #define JPEG2000_PGOD_PCRL      0x03  // Position-component-resolution level-layer progression
 116 #define JPEG2000_PGOD_CPRL      0x04  // Component-position-resolution level-layer progression
 117
 118 typedef struct Jpeg2000T1Context {
 119     int data[JPEG2000_MAX_CBLKW][JPEG2000_MAX_CBLKH];
 120     int flags[JPEG2000_MAX_CBLKW + 2][JPEG2000_MAX_CBLKH + 2];
 121     MqcState mqc;
 122 } Jpeg2000T1Context;
 123
 124 typedef struct Jpeg2000TgtNode {
 125     uint8_t val;
 126     uint8_t vis;
 127     struct Jpeg2000TgtNode *parent;
 128 } Jpeg2000TgtNode;
 129
 130 typedef struct Jpeg2000CodingStyle {
 131     uint8_t nreslevels;       // number of resolution levels
 132     uint8_t log2_cblk_width,
 133             log2_cblk_height; // exponent of codeblock size
 134     uint8_t transform;        // DWT type
 135     uint8_t csty;             // coding style
 136     uint8_t nlayers;          // number of layers
 137     uint8_t mct;              // multiple component transformation
 138     uint8_t cblk_style;       // codeblock coding style
 139     uint8_t prog_order;       // progression order
 140     uint8_t log2_prec_widths[JPEG2000_MAX_RESLEVELS];  // precincts size according resolution levels
 141     uint8_t log2_prec_heights[JPEG2000_MAX_RESLEVELS]; // TODO: initialize prec_size array with 0?
 142 } Jpeg2000CodingStyle;
 143
 144 typedef struct Jpeg2000QuantStyle {
 145     uint8_t expn[32 * 3];  // quantization exponent
 146     uint16_t mant[32 * 3]; // quantization mantissa
 147     uint8_t quantsty;      // quantization style
 148     uint8_t nguardbits;    // number of guard bits
 149 } Jpeg2000QuantStyle;
 150
 151 typedef struct Jpeg2000Pass {
 152     uint16_t rate;
 153     int64_t disto;
 154 } Jpeg2000Pass;
 155
 156 typedef struct Jpeg2000Cblk {
 157     uint8_t npasses;
 158     uint8_t ninclpasses; // number coding of passes included in codestream
 159     uint8_t nonzerobits;
 160     uint16_t length;
 161     uint16_t lengthinc;
 162     uint8_t lblock;
 163     uint8_t zero;
 164     uint8_t data[8192];
 165     Jpeg2000Pass passes[100];
 166 } Jpeg2000Cblk; // code block
 167
 168 typedef struct Jpeg2000Prec {
 169     uint16_t xi0, xi1, yi0, yi1; // codeblock indexes ([xi0, xi1))
 170     uint16_t nb_codeblocks_width;
 171     uint16_t nb_codeblocks_height;
 172     Jpeg2000TgtNode *zerobits;
 173     Jpeg2000TgtNode *cblkincl;
 174     Jpeg2000Cblk *cblk;
 175 } Jpeg2000Prec; // precinct
 176
 177 typedef struct Jpeg2000Band {
 178     uint16_t coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
 179     uint16_t log2_cblk_width, log2_cblk_height;
 180     uint16_t cblknx, cblkny;
 181     uint32_t stepsize; // quantization stepsize (* 2^13)
 182     Jpeg2000Prec *prec;
 183     Jpeg2000Cblk *cblk;
 184 } Jpeg2000Band; // subband
 185
 186 typedef struct Jpeg2000ResLevel {
 187     uint8_t nbands;
 188     uint16_t coord[2][2];   // border coordinates {{x0, x1}, {y0, y1}}
 189     uint16_t num_precincts_x, num_precincts_y; // number of precincts in x/y direction
 190     uint8_t log2_prec_width, log2_prec_height; // exponent of precinct size
 191     Jpeg2000Band *band;
 192 } Jpeg2000ResLevel; // resolution level
 193
 194 typedef struct Jpeg2000Component {
 195     Jpeg2000ResLevel *reslevel;
 196     DWTContext dwt;
 197     int *data;
 198     uint16_t coord[2][2];   // border coordinates {{x0, x1}, {y0, y1}}
 199 } Jpeg2000Component;
 200
 201 /* misc tools */
 202 static inline int ff_jpeg2000_ceildivpow2(int a, int b)
 203 {
 204     return (a + (1 << b) - 1) >> b;
 205 }
 206
 207 static inline int ff_jpeg2000_ceildiv(int a, int b)
 208 {
 209     return (a + b - 1) / b;
 210 }
 211
 212 /* tag tree routines */
 213 Jpeg2000TgtNode *ff_j2k_tag_tree_init(int w, int h);
 214
 215 /* TIER-1 routines */
 216
 217 /* Set up lookup tables used in TIER-1. */
 218 void ff_jpeg2000_init_tier1_luts(void);
 219
 220 /* Update significance of a coefficient at current position (x,y) and
 221  * for neighbors. */
 222 void ff_j2k_set_significant(Jpeg2000T1Context *t1,
 223                             int x, int y, int negative);
 224
 225 extern uint8_t ff_jpeg2000_sigctxno_lut[256][4];
 226
 227 /* Get context label (number in range[0..8]) of a coefficient for significance
 228  * propagation and cleanup coding passes. */
 229 static inline int ff_jpeg2000_getsigctxno(int flag, int bandno)
 230 {
 231     return ff_jpeg2000_sigctxno_lut[flag & 255][bandno];
 232 }
 233
 234 static const uint8_t refctxno_lut[2][2] = { { 14, 15 }, { 16, 16 } };
 235
 236 /* Get context label (number in range[14..16]) of a coefficient for magnitude
 237  * refinement pass. */
 238 static inline int ff_jpeg2000_getrefctxno(int flag)
 239 {
 240     return refctxno_lut[(flag >> 14) & 1][(flag & 255) != 0];
 241 }
 242
 243 extern uint8_t ff_jpeg2000_sgnctxno_lut[16][16];
 244 extern uint8_t ff_jpeg2000_xorbit_lut[16][16];
 245
 246 /* Get context label (number in range[9..13]) for sign decoding. */
 247 static inline int ff_jpeg2000_getsgnctxno(int flag, int *xorbit)
 248 {
 249     *xorbit = ff_jpeg2000_xorbit_lut[flag & 15][(flag >> 8) & 15];
 250     return ff_jpeg2000_sgnctxno_lut[flag & 15][(flag >> 8) & 15];
 251 }
 252
 253 int ff_j2k_init_component(Jpeg2000Component *comp,
 254                           Jpeg2000CodingStyle *codsty,
 255                           Jpeg2000QuantStyle *qntsty,
 256                           int cbps, int dx, int dy);
 257 void ff_j2k_reinit(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty);
 258 void ff_j2k_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty);
 259
 260 #endif /* AVCODEC_J2K_H */