Coverage Report

Created: 2026-05-16 06:41

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/work/openjpeg/src/lib/openjp2/mqc_inl.h
Line
Count
Source
1
/*
2
 * The copyright in this software is being made available under the 2-clauses
3
 * BSD License, included below. This software may be subject to other third
4
 * party and contributor rights, including patent rights, and no such rights
5
 * are granted under this license.
6
 *
7
 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8
 * Copyright (c) 2002-2014, Professor Benoit Macq
9
 * Copyright (c) 2001-2003, David Janssens
10
 * Copyright (c) 2002-2003, Yannick Verschueren
11
 * Copyright (c) 2003-2007, Francois-Olivier Devaux
12
 * Copyright (c) 2003-2014, Antonin Descampe
13
 * Copyright (c) 2005, Herve Drolon, FreeImage Team
14
 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
15
 * All rights reserved.
16
 *
17
 * Redistribution and use in source and binary forms, with or without
18
 * modification, are permitted provided that the following conditions
19
 * are met:
20
 * 1. Redistributions of source code must retain the above copyright
21
 *    notice, this list of conditions and the following disclaimer.
22
 * 2. Redistributions in binary form must reproduce the above copyright
23
 *    notice, this list of conditions and the following disclaimer in the
24
 *    documentation and/or other materials provided with the distribution.
25
 *
26
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
27
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36
 * POSSIBILITY OF SUCH DAMAGE.
37
 */
38
39
#ifndef OPJ_MQC_INL_H
40
#define OPJ_MQC_INL_H
41
42
/* For internal use of opj_mqc_decode_macro() */
43
0
#define opj_mqc_mpsexchange_macro(d, curctx, a) \
44
0
{ \
45
0
    if (a < (*curctx)->qeval) { \
46
0
        d = !((*curctx)->mps); \
47
0
        *curctx = (*curctx)->nlps; \
48
0
    } else { \
49
0
        d = (*curctx)->mps; \
50
0
        *curctx = (*curctx)->nmps; \
51
0
    } \
52
0
}
53
54
/* For internal use of opj_mqc_decode_macro() */
55
0
#define opj_mqc_lpsexchange_macro(d, curctx, a) \
56
0
{ \
57
0
    if (a < (*curctx)->qeval) { \
58
0
        a = (*curctx)->qeval; \
59
0
        d = (*curctx)->mps; \
60
0
        *curctx = (*curctx)->nmps; \
61
0
    } else { \
62
0
        a = (*curctx)->qeval; \
63
0
        d = !((*curctx)->mps); \
64
0
        *curctx = (*curctx)->nlps; \
65
0
    } \
66
0
}
67
68
69
/**
70
Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
71
@param mqc MQC handle
72
@return Returns the decoded symbol (0 or 1)
73
*/
74
static INLINE OPJ_UINT32 opj_mqc_raw_decode(opj_mqc_t *mqc)
75
0
{
76
0
    OPJ_UINT32 d;
77
0
    if (mqc->ct == 0) {
78
        /* Given opj_mqc_raw_init_dec() we know that at some point we will */
79
        /* have a 0xFF 0xFF artificial marker */
80
0
        if (mqc->c == 0xff) {
81
0
            if (*mqc->bp  > 0x8f) {
82
0
                mqc->c = 0xff;
83
0
                mqc->ct = 8;
84
0
            } else {
85
0
                mqc->c = *mqc->bp;
86
0
                mqc->bp ++;
87
0
                mqc->ct = 7;
88
0
            }
89
0
        } else {
90
0
            mqc->c = *mqc->bp;
91
0
            mqc->bp ++;
92
0
            mqc->ct = 8;
93
0
        }
94
0
    }
95
0
    mqc->ct--;
96
0
    d = ((OPJ_UINT32)mqc->c >> mqc->ct) & 0x01U;
97
98
0
    return d;
99
0
}
Unexecuted instantiation: cio.c:opj_mqc_raw_decode
Unexecuted instantiation: event.c:opj_mqc_raw_decode
Unexecuted instantiation: image.c:opj_mqc_raw_decode
Unexecuted instantiation: openjpeg.c:opj_mqc_raw_decode
Unexecuted instantiation: opj_malloc.c:opj_mqc_raw_decode
Unexecuted instantiation: j2k.c:opj_mqc_raw_decode
Unexecuted instantiation: jp2.c:opj_mqc_raw_decode
Unexecuted instantiation: mct.c:opj_mqc_raw_decode
Unexecuted instantiation: pi.c:opj_mqc_raw_decode
Unexecuted instantiation: tcd.c:opj_mqc_raw_decode
Unexecuted instantiation: tgt.c:opj_mqc_raw_decode
Unexecuted instantiation: function_list.c:opj_mqc_raw_decode
Unexecuted instantiation: thread.c:opj_mqc_raw_decode
Unexecuted instantiation: bio.c:opj_mqc_raw_decode
Unexecuted instantiation: dwt.c:opj_mqc_raw_decode
Unexecuted instantiation: invert.c:opj_mqc_raw_decode
Unexecuted instantiation: t1.c:opj_mqc_raw_decode
Unexecuted instantiation: t2.c:opj_mqc_raw_decode
Unexecuted instantiation: sparse_array.c:opj_mqc_raw_decode
Unexecuted instantiation: ht_dec.c:opj_mqc_raw_decode
Unexecuted instantiation: mqc.c:opj_mqc_raw_decode
100
101
102
0
#define opj_mqc_bytein_macro(mqc, c, ct) \
103
0
{ \
104
0
        OPJ_UINT32 l_c;  \
105
0
        /* Given opj_mqc_init_dec() we know that at some point we will */ \
106
0
        /* have a 0xFF 0xFF artificial marker */ \
107
0
        l_c = *(mqc->bp + 1); \
108
0
        if (*mqc->bp == 0xff) { \
109
0
            if (l_c > 0x8f) { \
110
0
                c += 0xff00; \
111
0
                ct = 8; \
112
0
                mqc->end_of_byte_stream_counter ++; \
113
0
            } else { \
114
0
                mqc->bp++; \
115
0
                c += l_c << 9; \
116
0
                ct = 7; \
117
0
            } \
118
0
        } else { \
119
0
            mqc->bp++; \
120
0
            c += l_c << 8; \
121
0
            ct = 8; \
122
0
        } \
123
0
}
124
125
/* For internal use of opj_mqc_decode_macro() */
126
0
#define opj_mqc_renormd_macro(mqc, a, c, ct) \
127
0
{ \
128
0
    do { \
129
0
        if (ct == 0) { \
130
0
            opj_mqc_bytein_macro(mqc, c, ct); \
131
0
        } \
132
0
        a <<= 1; \
133
0
        c <<= 1; \
134
0
        ct--; \
135
0
    } while (a < 0x8000); \
136
0
}
137
138
0
#define opj_mqc_decode_macro(d, mqc, curctx, a, c, ct) \
139
0
{ \
140
0
    /* Implements ISO 15444-1 C.3.2 Decoding a decision (DECODE) */ \
141
0
    /* Note: alternate "J.2 - Decoding an MPS or an LPS in the */ \
142
0
    /* software-conventions decoder" has been tried, but does not bring any */ \
143
0
    /* improvement. See https://github.com/uclouvain/openjpeg/issues/921 */ \
144
0
    a -= (*curctx)->qeval;  \
145
0
    if ((c >> 16) < (*curctx)->qeval) {  \
146
0
        opj_mqc_lpsexchange_macro(d, curctx, a);  \
147
0
        opj_mqc_renormd_macro(mqc, a, c, ct);  \
148
0
    } else {  \
149
0
        c -= (*curctx)->qeval << 16;  \
150
0
        if ((a & 0x8000) == 0) { \
151
0
            opj_mqc_mpsexchange_macro(d, curctx, a); \
152
0
            opj_mqc_renormd_macro(mqc, a, c, ct); \
153
0
        } else { \
154
0
            d = (*curctx)->mps; \
155
0
        } \
156
0
    } \
157
0
}
158
159
#define DOWNLOAD_MQC_VARIABLES(mqc, curctx, a, c, ct) \
160
24.1k
        register const opj_mqc_state_t **curctx = mqc->curctx; \
161
24.1k
        register OPJ_UINT32 c = mqc->c; \
162
24.1k
        register OPJ_UINT32 a = mqc->a; \
163
24.1k
        register OPJ_UINT32 ct = mqc->ct
164
165
#define UPLOAD_MQC_VARIABLES(mqc, curctx, a, c, ct) \
166
24.1k
        mqc->curctx = curctx; \
167
24.1k
        mqc->c = c; \
168
24.1k
        mqc->a = a; \
169
24.1k
        mqc->ct = ct;
170
171
/**
172
Input a byte
173
@param mqc MQC handle
174
*/
175
static INLINE void opj_mqc_bytein(opj_mqc_t *const mqc)
176
0
{
177
0
    opj_mqc_bytein_macro(mqc, mqc->c, mqc->ct);
178
0
}
Unexecuted instantiation: cio.c:opj_mqc_bytein
Unexecuted instantiation: event.c:opj_mqc_bytein
Unexecuted instantiation: image.c:opj_mqc_bytein
Unexecuted instantiation: openjpeg.c:opj_mqc_bytein
Unexecuted instantiation: opj_malloc.c:opj_mqc_bytein
Unexecuted instantiation: j2k.c:opj_mqc_bytein
Unexecuted instantiation: jp2.c:opj_mqc_bytein
Unexecuted instantiation: mct.c:opj_mqc_bytein
Unexecuted instantiation: pi.c:opj_mqc_bytein
Unexecuted instantiation: tcd.c:opj_mqc_bytein
Unexecuted instantiation: tgt.c:opj_mqc_bytein
Unexecuted instantiation: function_list.c:opj_mqc_bytein
Unexecuted instantiation: thread.c:opj_mqc_bytein
Unexecuted instantiation: bio.c:opj_mqc_bytein
Unexecuted instantiation: dwt.c:opj_mqc_bytein
Unexecuted instantiation: invert.c:opj_mqc_bytein
Unexecuted instantiation: t1.c:opj_mqc_bytein
Unexecuted instantiation: t2.c:opj_mqc_bytein
Unexecuted instantiation: sparse_array.c:opj_mqc_bytein
Unexecuted instantiation: ht_dec.c:opj_mqc_bytein
Unexecuted instantiation: mqc.c:opj_mqc_bytein
179
180
/**
181
Renormalize mqc->a and mqc->c while decoding
182
@param mqc MQC handle
183
*/
184
#define opj_mqc_renormd(mqc) \
185
    opj_mqc_renormd_macro(mqc, mqc->a, mqc->c, mqc->ct)
186
187
/**
188
Decode a symbol
189
@param d OPJ_UINT32 value where to store the decoded symbol
190
@param mqc MQC handle
191
@return Returns the decoded symbol (0 or 1) in d
192
*/
193
#define opj_mqc_decode(d, mqc) \
194
0
    opj_mqc_decode_macro(d, mqc, mqc->curctx, mqc->a, mqc->c, mqc->ct)
195
196
/**
197
Output a byte, doing bit-stuffing if necessary.
198
After a 0xff byte, the next byte must be smaller than 0x90.
199
@param mqc MQC handle
200
*/
201
void opj_mqc_byteout(opj_mqc_t *mqc);
202
203
/**
204
Renormalize mqc->a and mqc->c while encoding, so that mqc->a stays between 0x8000 and 0x10000
205
@param mqc MQC handle
206
@param a_ value of mqc->a
207
@param c_ value of mqc->c_
208
@param ct_ value of mqc->ct_
209
*/
210
57.3k
#define opj_mqc_renorme_macro(mqc, a_, c_, ct_) \
211
57.3k
{ \
212
81.8k
    do { \
213
81.8k
        a_ <<= 1; \
214
81.8k
        c_ <<= 1; \
215
81.8k
        ct_--; \
216
81.8k
        if (ct_ == 0) { \
217
9.51k
            mqc->c = c_; \
218
9.51k
            opj_mqc_byteout(mqc); \
219
9.51k
            c_ = mqc->c; \
220
9.51k
            ct_ = mqc->ct; \
221
9.51k
        } \
222
81.8k
    } while( (a_ & 0x8000) == 0); \
223
57.3k
}
224
225
229k
#define opj_mqc_codemps_macro(mqc, curctx, a, c, ct) \
226
229k
{ \
227
229k
    a -= (*curctx)->qeval; \
228
229k
    if ((a & 0x8000) == 0) { \
229
35.7k
        if (a < (*curctx)->qeval) { \
230
2.97k
            a = (*curctx)->qeval; \
231
32.7k
        } else { \
232
32.7k
            c += (*curctx)->qeval; \
233
32.7k
        } \
234
35.7k
        *curctx = (*curctx)->nmps; \
235
35.7k
        opj_mqc_renorme_macro(mqc, a, c, ct); \
236
194k
    } else { \
237
194k
        c += (*curctx)->qeval; \
238
194k
    } \
239
229k
}
240
241
21.5k
#define opj_mqc_codelps_macro(mqc, curctx, a, c, ct) \
242
21.5k
{ \
243
21.5k
    a -= (*curctx)->qeval; \
244
21.5k
    if (a < (*curctx)->qeval) { \
245
3.99k
        c += (*curctx)->qeval; \
246
17.5k
    } else { \
247
17.5k
        a = (*curctx)->qeval; \
248
17.5k
    } \
249
21.5k
    *curctx = (*curctx)->nlps; \
250
21.5k
    opj_mqc_renorme_macro(mqc, a, c, ct); \
251
21.5k
}
252
253
251k
#define opj_mqc_encode_macro(mqc, curctx, a, c, ct, d) \
254
251k
{ \
255
251k
    if ((*curctx)->mps == (d)) { \
256
229k
        opj_mqc_codemps_macro(mqc, curctx, a, c, ct); \
257
229k
    } else { \
258
21.5k
        opj_mqc_codelps_macro(mqc, curctx, a, c, ct); \
259
21.5k
    } \
260
251k
}
261
262
263
0
#define opj_mqc_bypass_enc_macro(mqc, c, ct, d) \
264
0
{\
265
0
    if (ct == BYPASS_CT_INIT) {\
266
0
        ct = 8;\
267
0
    }\
268
0
    ct--;\
269
0
    c = c + ((d) << ct);\
270
0
    if (ct == 0) {\
271
0
        *mqc->bp = (OPJ_BYTE)c;\
272
0
        ct = 8;\
273
0
        /* If the previous byte was 0xff, make sure that the next msb is 0 */ \
274
0
        if (*mqc->bp == 0xff) {\
275
0
            ct = 7;\
276
0
        }\
277
0
        mqc->bp++;\
278
0
        c = 0;\
279
0
    }\
280
0
}
281
282
#endif /* OPJ_MQC_INL_H */