FFmpeg
jpeg2000.h
Go to the documentation of this file.
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 
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];
125  int stride;
127 
128 typedef struct Jpeg2000TgtNode {
133 
134 typedef struct Jpeg2000CodingStyle {
135  int nreslevels; // number of resolution levels
136  int nreslevels2decode; // number of resolution levels to decode
138  log2_cblk_height; // exponent of codeblock size
139  uint8_t transform; // DWT type
140  uint8_t csty; // coding style
141  uint8_t nlayers; // number of layers
142  uint8_t mct; // multiple component transformation
143  uint8_t cblk_style; // codeblock coding style
144  uint8_t prog_order; // progression order
145  uint8_t log2_prec_widths[JPEG2000_MAX_RESLEVELS]; // precincts size according resolution levels
146  uint8_t log2_prec_heights[JPEG2000_MAX_RESLEVELS]; // TODO: initialize prec_size array with 0?
149 
150 typedef struct Jpeg2000QuantStyle {
151  uint8_t expn[JPEG2000_MAX_DECLEVELS * 3]; // quantization exponent
152  uint16_t mant[JPEG2000_MAX_DECLEVELS * 3]; // quantization mantissa
153  uint8_t quantsty; // quantization style
154  uint8_t nguardbits; // number of guard bits
156 
157 typedef struct Jpeg2000Pass {
158  uint16_t rate;
159  int64_t disto;
160  uint8_t flushed[4];
162 } Jpeg2000Pass;
163 
164 typedef struct Jpeg2000Cblk {
166  uint8_t ninclpasses; // number coding of passes included in codestream
168  uint16_t length;
169  uint16_t *lengthinc;
178  int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
179 } Jpeg2000Cblk; // code block
180 
181 typedef struct Jpeg2000Prec {
188  int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
189 } Jpeg2000Prec; // precinct
190 
191 typedef struct Jpeg2000Band {
192  int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
193  uint16_t log2_cblk_width, log2_cblk_height;
194  int i_stepsize; // quantization stepsize
195  float f_stepsize; // quantization stepsize
197 } Jpeg2000Band; // subband
198 
199 typedef struct Jpeg2000ResLevel {
201  int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}}
202  int num_precincts_x, num_precincts_y; // number of precincts in x/y direction
203  uint8_t log2_prec_width, log2_prec_height; // exponent of precinct size
205 } Jpeg2000ResLevel; // resolution level
206 
207 typedef struct Jpeg2000Component {
210  float *f_data;
211  int *i_data;
212  int coord[2][2]; // border coordinates {{x0, x1}, {y0, y1}} -- can be reduced with lowres option
213  int coord_o[2][2]; // border coordinates {{x0, x1}, {y0, y1}} -- original values from jpeg2000 headers
214  uint8_t roi_shift; // ROI scaling value for the component
216 
217 /* misc tools */
218 static inline int ff_jpeg2000_ceildivpow2(int a, int b)
219 {
220  return -((-(int64_t)a) >> b);
221 }
222 
223 static inline int ff_jpeg2000_ceildiv(int a, int64_t b)
224 {
225  return (a + b - 1) / b;
226 }
227 
228 /* TIER-1 routines */
229 
230 /* Set up lookup tables used in TIER-1. */
231 void ff_jpeg2000_init_tier1_luts(void);
232 
233 /* Update significance of a coefficient at current position (x,y) and
234  * for neighbors. */
236  int x, int y, int negative);
237 
238 extern uint8_t ff_jpeg2000_sigctxno_lut[256][4];
239 
240 /* Get context label (number in range[0..8]) of a coefficient for significance
241  * propagation and cleanup coding passes. */
242 static inline int ff_jpeg2000_getsigctxno(int flag, int bandno)
243 {
244  return ff_jpeg2000_sigctxno_lut[flag & 255][bandno];
245 }
246 
247 static const uint8_t refctxno_lut[2][2] = { { 14, 15 }, { 16, 16 } };
248 
249 /* Get context label (number in range[14..16]) of a coefficient for magnitude
250  * refinement pass. */
251 static inline int ff_jpeg2000_getrefctxno(int flag)
252 {
253  return refctxno_lut[(flag >> 14) & 1][(flag & 255) != 0];
254 }
255 
256 extern uint8_t ff_jpeg2000_sgnctxno_lut[16][16];
257 extern uint8_t ff_jpeg2000_xorbit_lut[16][16];
258 
259 /* Get context label (number in range[9..13]) for sign decoding. */
260 static inline int ff_jpeg2000_getsgnctxno(int flag, int *xorbit)
261 {
262  *xorbit = ff_jpeg2000_xorbit_lut[flag & 15][(flag >> 8) & 15];
263  return ff_jpeg2000_sgnctxno_lut[flag & 15][(flag >> 8) & 15];
264 }
265 
267  Jpeg2000CodingStyle *codsty,
268  Jpeg2000QuantStyle *qntsty,
269  int cbps, int dx, int dy,
271 
273 
275 
276 static inline int needs_termination(int style, int passno) {
277  if (style & JPEG2000_CBLK_BYPASS) {
278  int type = passno % 3;
279  passno /= 3;
280  if (type == 0 && passno > 2)
281  return 2;
282  if (type == 2 && passno > 2)
283  return 1;
284  if (style & JPEG2000_CBLK_TERMALL) {
285  return passno > 2 ? 2 : 1;
286  }
287  }
288  if (style & JPEG2000_CBLK_TERMALL)
289  return 1;
290  return 0;
291 }
292 
293 #endif /* AVCODEC_JPEG2000_H */
uint8_t nguardbits
Definition: jpeg2000.h:154
Discrete wavelet transform.
DWTContext dwt
Definition: jpeg2000.h:209
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
Jpeg2000TgtNode * cblkincl
Definition: jpeg2000.h:185
float * f_data
Definition: jpeg2000.h:210
uint8_t ninclpasses
Definition: jpeg2000.h:166
int nb_codeblocks_width
Definition: jpeg2000.h:182
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:36
GLint GLenum type
Definition: opengl_enc.c:104
void ff_jpeg2000_cleanup(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
Definition: jpeg2000.c:582
float f_stepsize
Definition: jpeg2000.h:195
uint8_t npasses
Definition: jpeg2000.h:165
uint16_t log2_cblk_width
Definition: jpeg2000.h:193
MQ-coder.
int * data_start
Definition: jpeg2000.h:176
uint8_t
uint8_t nb_lengthinc
Definition: jpeg2000.h:170
Jpeg2000TgtNode * zerobits
Definition: jpeg2000.h:184
int64_t disto
Definition: jpeg2000.h:159
Jpeg2000Band * band
Definition: jpeg2000.h:204
uint8_t val
Definition: jpeg2000.h:129
#define JPEG2000_CBLK_TERMALL
Definition: jpeg2000.h:104
uint16_t flags[6156]
Definition: jpeg2000.h:123
void ff_jpeg2000_set_significance(Jpeg2000T1Context *t1, int x, int y, int negative)
Definition: jpeg2000.c:171
uint8_t nonzerobits
Definition: jpeg2000.h:167
uint16_t * lengthinc
Definition: jpeg2000.h:169
int nb_terminations
Definition: jpeg2000.h:174
int nb_codeblocks_height
Definition: jpeg2000.h:183
#define t1
Definition: regdef.h:29
int ff_jpeg2000_init_component(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty, Jpeg2000QuantStyle *qntsty, int cbps, int dx, int dy, AVCodecContext *ctx)
Definition: jpeg2000.c:451
Jpeg2000Quantsty
Definition: jpeg2000.h:64
Jpeg2000Cblk * cblk
Definition: jpeg2000.h:186
uint8_t cblk_style
Definition: jpeg2000.h:143
static const uint8_t refctxno_lut[2][2]
Definition: jpeg2000.h:247
static int ff_jpeg2000_ceildiv(int a, int64_t b)
Definition: jpeg2000.h:223
uint8_t lblock
Definition: jpeg2000.h:171
int flushed_len
Definition: jpeg2000.h:161
#define b
Definition: input.c:41
struct Jpeg2000TgtNode * parent
Definition: jpeg2000.h:131
uint8_t roi_shift
Definition: jpeg2000.h:214
int i_stepsize
Definition: jpeg2000.h:194
int nb_terminationsinc
Definition: jpeg2000.h:175
#define JPEG2000_MAX_RESLEVELS
Definition: jpeg2000.h:71
uint8_t ff_jpeg2000_sigctxno_lut[256][4]
Definition: jpeg2000.c:95
AVFormatContext * ctx
Definition: movenc.c:48
static int needs_termination(int style, int passno)
Definition: jpeg2000.h:276
static int ff_jpeg2000_getsigctxno(int flag, int bandno)
Definition: jpeg2000.h:242
#define JPEG2000_MAX_DECLEVELS
Definition: jpeg2000.h:70
size_t data_allocated
Definition: jpeg2000.h:173
uint8_t * data
Definition: jpeg2000.h:172
static int ff_jpeg2000_ceildivpow2(int a, int b)
Definition: jpeg2000.h:218
static void comp(unsigned char *dst, ptrdiff_t dst_stride, unsigned char *src, ptrdiff_t src_stride, int add)
Definition: eamad.c:83
Jpeg2000Markers
Definition: jpeg2000.h:38
Libavcodec external API header.
main external API structure.
Definition: avcodec.h:526
uint8_t vis
Definition: jpeg2000.h:130
uint16_t length
Definition: jpeg2000.h:168
uint8_t nbands
Definition: jpeg2000.h:200
int decoded_layers
Definition: jpeg2000.h:187
void ff_jpeg2000_init_tier1_luts(void)
Definition: jpeg2000.c:159
Jpeg2000ResLevel * reslevel
Definition: jpeg2000.h:208
uint8_t prog_order
Definition: jpeg2000.h:144
uint8_t quantsty
Definition: jpeg2000.h:153
#define flag(name)
Definition: cbs_av1.c:552
uint8_t log2_cblk_width
Definition: jpeg2000.h:137
#define JPEG2000_CBLK_BYPASS
Definition: jpeg2000.h:102
uint8_t ff_jpeg2000_xorbit_lut[16][16]
Definition: jpeg2000.c:140
uint16_t rate
Definition: jpeg2000.h:158
void ff_jpeg2000_reinit(Jpeg2000Component *comp, Jpeg2000CodingStyle *codsty)
Definition: jpeg2000.c:561
Jpeg2000Prec * prec
Definition: jpeg2000.h:196
MqcState mqc
Definition: jpeg2000.h:124
static int ff_jpeg2000_getrefctxno(int flag)
Definition: jpeg2000.h:251
Definition: mqc.h:40
uint8_t log2_prec_width
Definition: jpeg2000.h:203
uint8_t ff_jpeg2000_sgnctxno_lut[16][16]
Definition: jpeg2000.c:140
Jpeg2000Pass * passes
Definition: jpeg2000.h:177
static int ff_jpeg2000_getsgnctxno(int flag, int *xorbit)
Definition: jpeg2000.h:260