git.sesse.net Git - ffmpeg/blob - libavcodec/jpeg2000.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_JPEG2000_H
  24 #define AVCODEC_JPEG2000_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 "jpeg2000dwt.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, // tile-part length, main header
  44     JPEG2000_PLM = 0xff57, // packet length, main header
  45     JPEG2000_PLT,          // packet length, tile-part 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,          // packed packet headers, main header
  51     JPEG2000_PPT,          // packed packet headers, tile-part 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 #define JPEG2000_SOP_FIXED_BYTES 0xFF910004
  62 #define JPEG2000_SOP_BYTE_LENGTH 6
  63
  64 enum Jpeg2000Quantsty { // quantization style
  65     JPEG2000_QSTY_NONE, // no quantization
  66     JPEG2000_QSTY_SI,   // scalar derived
  67     JPEG2000_QSTY_SE    // scalar expounded
  68 };
  69
  70 #define JPEG2000_MAX_DECLEVELS 33
  71 #define JPEG2000_MAX_RESLEVELS (JPEG2000_MAX_DECLEVELS + 1)
  72
  73 #define JPEG2000_MAX_PASSES 100
  74
  75 // T1 flags
  76 // flags determining significance of neighbor coefficients
  77 #define JPEG2000_T1_SIG_N  0x0001
  78 #define JPEG2000_T1_SIG_E  0x0002
  79 #define JPEG2000_T1_SIG_W  0x0004
  80 #define JPEG2000_T1_SIG_S  0x0008
  81 #define JPEG2000_T1_SIG_NE 0x0010
  82 #define JPEG2000_T1_SIG_NW 0x0020
  83 #define JPEG2000_T1_SIG_SE 0x0040
  84 #define JPEG2000_T1_SIG_SW 0x0080
  85 #define JPEG2000_T1_SIG_NB (JPEG2000_T1_SIG_N  | JPEG2000_T1_SIG_E  |   \
  86                             JPEG2000_T1_SIG_S  | JPEG2000_T1_SIG_W  |   \
  87                             JPEG2000_T1_SIG_NE | JPEG2000_T1_SIG_NW |   \
  88                             JPEG2000_T1_SIG_SE | JPEG2000_T1_SIG_SW)
  89 // flags determining sign bit of neighbor coefficients
  90 #define JPEG2000_T1_SGN_N  0x0100
  91 #define JPEG2000_T1_SGN_S  0x0200
  92 #define JPEG2000_T1_SGN_W  0x0400
  93 #define JPEG2000_T1_SGN_E  0x0800
  94
  95 #define JPEG2000_T1_VIS    0x1000
  96 #define JPEG2000_T1_SIG    0x2000
  97 #define JPEG2000_T1_REF    0x4000
  98
  99 #define JPEG2000_T1_SGN    0x8000
 100
 101 // Codeblock coding styles
 102 #define JPEG2000_CBLK_BYPASS    0x01 // Selective arithmetic coding bypass
 103 #define JPEG2000_CBLK_RESET     0x02 // Reset context probabilities
 104 #define JPEG2000_CBLK_TERMALL   0x04 // Terminate after each coding pass
 105 #define JPEG2000_CBLK_VSC       0x08 // Vertical stripe causal context formation
 106 #define JPEG2000_CBLK_PREDTERM  0x10 // Predictable termination
 107 #define JPEG2000_CBLK_SEGSYM    0x20 // Segmentation symbols present
 108
 109 // Coding styles
 110 #define JPEG2000_CSTY_PREC      0x01 // Precincts defined in coding style
 111 #define JPEG2000_CSTY_SOP       0x02 // SOP marker present
 112 #define JPEG2000_CSTY_EPH       0x04 // EPH marker present
 113
 114 // Progression orders
 115 #define JPEG2000_PGOD_LRCP      0x00  // Layer-resolution level-component-position progression
 116 #define JPEG2000_PGOD_RLCP      0x01  // Resolution level-layer-component-position progression
 117 #define JPEG2000_PGOD_RPCL      0x02  // Resolution level-position-component-layer progression
 118 #define JPEG2000_PGOD_PCRL      0x03  // Position-component-resolution level-layer progression
 119 #define JPEG2000_PGOD_CPRL      0x04  // Component-position-resolution level-layer progression
 120
 121 typedef struct Jpeg2000T1Context {
 122     int data[6144];
 123     uint16_t flags[6156];
 124     MqcState mqc;
 125     int stride;
 126 } Jpeg2000T1Context;
 127
 128 typedef struct Jpeg2000TgtNode {
 129     uint8_t val;
 130     uint8_t temp_val;
 131     uint8_t vis;
 132     struct Jpeg2000TgtNode *parent;
 133 } Jpeg2000TgtNode;
 134
 135 typedef struct Jpeg2000CodingStyle {
 136     int nreslevels;           // number of resolution levels
 137     int nreslevels2decode;    // number of resolution levels to decode
 138     uint8_t log2_cblk_width,
 139             log2_cblk_height; // exponent of codeblock size
 140     uint8_t transform;        // DWT type
 141     uint8_t csty;             // coding style
 142     uint8_t nlayers;          // number of layers
 143     uint8_t mct;              // multiple component transformation
 144     uint8_t cblk_style;       // codeblock coding style
 145     uint8_t prog_order;       // progression order
 146     uint8_t log2_prec_widths[JPEG2000_MAX_RESLEVELS];  // precincts size according resolution levels
 147     uint8_t log2_prec_heights[JPEG2000_MAX_RESLEVELS]; // TODO: initialize prec_size array with 0?
 148     uint8_t init;
 149 } Jpeg2000CodingStyle;
 150
 151 typedef struct Jpeg2000QuantStyle {
 152     uint8_t expn[JPEG2000_MAX_DECLEVELS * 3];  // quantization exponent
 153     uint16_t mant[JPEG2000_MAX_DECLEVELS * 3]; // quantization mantissa
 154     uint8_t quantsty;      // quantization style
 155     uint8_t nguardbits;    // number of guard bits
 156 } Jpeg2000QuantStyle;
 157
 158 typedef struct Jpeg2000Pass {
 159     uint16_t rate;
 160     int64_t disto;
 161     uint8_t flushed[4];
 162     int flushed_len;
 163 } Jpeg2000Pass;
 164
 165 typedef struct Jpeg2000Layer {
 166     uint8_t *data_start;
 167     int data_len;
 168     int npasses;
 169     double disto;
 170     int cum_passes;
 171 } Jpeg2000Layer;
 172
 173 typedef struct Jpeg2000Cblk {
 174     uint8_t npasses;
 175     uint8_t ninclpasses; // number coding of passes included in codestream
 176     uint8_t nonzerobits;
 177     uint8_t incl;
 178     uint16_t length;
 179     uint16_t *lengthinc;
 180     uint8_t nb_lengthinc;
 181     uint8_t lblock;
 182     uint8_t *data;
 183     size_t data_allocated;
 184     int nb_terminations;
 185     int nb_terminationsinc;
 186     int *data_start;
 187     Jpeg2000Pass *passes;
 188     Jpeg2000Layer *layers;
 189     int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
 190 } Jpeg2000Cblk; // code block
 191
 192 typedef struct Jpeg2000Prec {
 193     int nb_codeblocks_width;
 194     int nb_codeblocks_height;
 195     Jpeg2000TgtNode *zerobits;
 196     Jpeg2000TgtNode *cblkincl;
 197     Jpeg2000Cblk *cblk;
 198     int decoded_layers;
 199     int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
 200 } Jpeg2000Prec; // precinct
 201
 202 typedef struct Jpeg2000Band {
 203     int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
 204     uint16_t log2_cblk_width, log2_cblk_height;
 205     int i_stepsize; // quantization stepsize
 206     float f_stepsize; // quantization stepsize
 207     Jpeg2000Prec *prec;
 208 } Jpeg2000Band; // subband
 209
 210 typedef struct Jpeg2000ResLevel {
 211     uint8_t nbands;
 212     int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
 213     int num_precincts_x, num_precincts_y; // number of precincts in x/y direction
 214     uint8_t log2_prec_width, log2_prec_height; // exponent of precinct size
 215     Jpeg2000Band *band;
 216 } Jpeg2000ResLevel; // resolution level
 217
 218 typedef struct Jpeg2000Component {
 219     Jpeg2000ResLevel *reslevel;
 220     DWTContext dwt;
 221     float *f_data;
 222     int *i_data;
 223     int coord[2][2];   // border coordinates {{x0, x1}, {y0, y1}} -- can be reduced with lowres option
 224     int coord_o[2][2]; // border coordinates {{x0, x1}, {y0, y1}} -- original values from jpeg2000 headers
 225     uint8_t roi_shift; // ROI scaling value for the component
 226 } Jpeg2000Component;
 227
 228 /* misc tools */
 229 static inline int ff_jpeg2000_ceildivpow2(int a, int b)
 230 {
 231     return -((-(int64_t)a) >> b);
 232 }
 233
 234 static inline int ff_jpeg2000_ceildiv(int a, int64_t b)
 235 {
 236     return (a + b - 1) / b;
 237 }
 238
 239 /* TIER-1 routines */
 240
 241 /* Set up lookup tables used in TIER-1. */
 242 void ff_jpeg2000_init_tier1_luts(void);
 243
 244 /* Update significance of a coefficient at current position (x,y) and
 245  * for neighbors. */
 246 void ff_jpeg2000_set_significance(Jpeg2000T1Context *t1,
 247                                   int x, int y, int negative);
 248
 249 extern uint8_t ff_jpeg2000_sigctxno_lut[256][4];
 250
 251 /* Get context label (number in range[0..8]) of a coefficient for significance
 252  * propagation and cleanup coding passes. */
 253 static inline int ff_jpeg2000_getsigctxno(int flag, int bandno)
 254 {
 255     return ff_jpeg2000_sigctxno_lut[flag & 255][bandno];
 256 }
 257
 258 static const uint8_t refctxno_lut[2][2] = { { 14, 15 }, { 16, 16 } };
 259
 260 /* Get context label (number in range[14..16]) of a coefficient for magnitude
 261  * refinement pass. */
 262 static inline int ff_jpeg2000_getrefctxno(int flag)
 263 {
 264     return refctxno_lut[(flag >> 14) & 1][(flag & 255) != 0];
 265 }
 266
 267 extern uint8_t ff_jpeg2000_sgnctxno_lut[16][16];
 268 extern uint8_t ff_jpeg2000_xorbit_lut[16][16];
 269
 270 /* Get context label (number in range[9..13]) for sign decoding. */
 271 static inline int ff_jpeg2000_getsgnctxno(int flag, int *xorbit)
 272 {
 273     *xorbit = ff_jpeg2000_xorbit_lut[flag & 15][(flag >> 8) & 15];
 274     return ff_jpeg2000_sgnctxno_lut[flag & 15][(flag >> 8) & 15];
 275 }
 276
 277 int ff_jpeg2000_init_component(Jpeg2000Component *comp,
 278                                Jpeg2000CodingStyle *codsty,
 279                                Jpeg2000QuantStyle *qntsty,
 280                                int cbps, int dx, int dy,
 281                                AVCodecContext *ctx);
 282
 283 void ff_jpeg2000_reinit(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty);
 284
 285 void ff_jpeg2000_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty);
 286
 287 static inline int needs_termination(int style, int passno) {
 288     if (style & JPEG2000_CBLK_BYPASS) {
 289         int type = passno % 3;
 290         passno /= 3;
 291         if (type == 0 && passno > 2)
 292             return 2;
 293         if (type == 2 && passno > 2)
 294             return 1;
 295         if (style & JPEG2000_CBLK_TERMALL) {
 296             return passno > 2 ? 2 : 1;
 297         }
 298     }
 299     if (style & JPEG2000_CBLK_TERMALL)
 300         return 1;
 301     return 0;
 302 }
 303
 304 int32_t ff_tag_tree_size(int w, int h);
 305 void ff_tag_tree_zero(Jpeg2000TgtNode *t, int w, int h, int val);
 306
 307 #endif /* AVCODEC_JPEG2000_H */