Coverage Report

Created: 2026-05-16 07:22

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libtiff/libtiff/tif_compress.c
Line
Count
Source
1
/*
2
 * Copyright (c) 1988-1997 Sam Leffler
3
 * Copyright (c) 1991-1997 Silicon Graphics, Inc.
4
 *
5
 * Permission to use, copy, modify, distribute, and sell this software and
6
 * its documentation for any purpose is hereby granted without fee, provided
7
 * that (i) the above copyright notices and this permission notice appear in
8
 * all copies of the software and related documentation, and (ii) the names of
9
 * Sam Leffler and Silicon Graphics may not be used in any advertising or
10
 * publicity relating to the software without the specific, prior written
11
 * permission of Sam Leffler and Silicon Graphics.
12
 *
13
 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
14
 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
15
 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
16
 *
17
 * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
18
 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
19
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
20
 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
21
 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
22
 * OF THIS SOFTWARE.
23
 */
24
25
/*
26
 * TIFF Library
27
 *
28
 * Compression Scheme Configuration Support.
29
 */
30
#include "tiffiop.h"
31
32
static int TIFFNoEncode(TIFF *tif, const char *method)
33
0
{
34
0
    const TIFFCodec *c = TIFFFindCODEC(tif->tif_dir.td_compression);
35
36
0
    if (c)
37
0
    {
38
0
        TIFFErrorExtR(tif, tif->tif_name, "%s %s encoding is not implemented",
39
0
                      c->name, method);
40
0
    }
41
0
    else
42
0
    {
43
0
        TIFFErrorExtR(tif, tif->tif_name,
44
0
                      "Compression scheme %" PRIu16
45
0
                      " %s encoding is not implemented",
46
0
                      tif->tif_dir.td_compression, method);
47
0
    }
48
0
    return (-1);
49
0
}
50
51
int _TIFFNoRowEncode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
52
0
{
53
0
    (void)pp;
54
0
    (void)cc;
55
0
    (void)s;
56
0
    return (TIFFNoEncode(tif, "scanline"));
57
0
}
58
59
int _TIFFNoStripEncode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
60
0
{
61
0
    (void)pp;
62
0
    (void)cc;
63
0
    (void)s;
64
0
    return (TIFFNoEncode(tif, "strip"));
65
0
}
66
67
int _TIFFNoTileEncode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
68
0
{
69
0
    (void)pp;
70
0
    (void)cc;
71
0
    (void)s;
72
0
    return (TIFFNoEncode(tif, "tile"));
73
0
}
74
75
static int TIFFNoDecode(TIFF *tif, const char *method)
76
5
{
77
5
    const TIFFCodec *c = TIFFFindCODEC(tif->tif_dir.td_compression);
78
79
5
    if (c)
80
5
        TIFFErrorExtR(tif, tif->tif_name, "%s %s decoding is not implemented",
81
5
                      c->name, method);
82
0
    else
83
0
        TIFFErrorExtR(tif, tif->tif_name,
84
0
                      "Compression scheme %" PRIu16
85
0
                      " %s decoding is not implemented",
86
0
                      tif->tif_dir.td_compression, method);
87
5
    return (0);
88
5
}
89
90
static int _TIFFNoFixupTags(TIFF *tif)
91
3.56k
{
92
3.56k
    (void)tif;
93
3.56k
    return (1);
94
3.56k
}
95
96
int _TIFFNoRowDecode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
97
0
{
98
0
    (void)pp;
99
0
    (void)cc;
100
0
    (void)s;
101
0
    return (TIFFNoDecode(tif, "scanline"));
102
0
}
103
104
int _TIFFNoStripDecode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
105
0
{
106
0
    (void)pp;
107
0
    (void)cc;
108
0
    (void)s;
109
0
    return (TIFFNoDecode(tif, "strip"));
110
0
}
111
112
int _TIFFNoTileDecode(TIFF *tif, uint8_t *pp, tmsize_t cc, uint16_t s)
113
5
{
114
5
    (void)pp;
115
5
    (void)cc;
116
5
    (void)s;
117
5
    return (TIFFNoDecode(tif, "tile"));
118
5
}
119
120
int _TIFFNoSeek(TIFF *tif, uint32_t off)
121
0
{
122
0
    (void)off;
123
0
    TIFFErrorExtR(tif, tif->tif_name,
124
0
                  "Compression algorithm does not support random access");
125
0
    return (0);
126
0
}
127
128
int _TIFFNoPreCode(TIFF *tif, uint16_t s)
129
873k
{
130
873k
    (void)tif;
131
873k
    (void)s;
132
873k
    return (1);
133
873k
}
134
135
static int _TIFFtrue(TIFF *tif)
136
31.2k
{
137
31.2k
    (void)tif;
138
31.2k
    return (1);
139
31.2k
}
140
352k
static void _TIFFvoid(TIFF *tif) { (void)tif; }
141
142
void _TIFFSetDefaultPostDecode(TIFF *tif)
143
587k
{
144
587k
    tif->tif_postdecode = _TIFFNoPostDecode;
145
    /*
146
     * If the data require post-decoding processing to byte-swap
147
     * samples, set it up here.  Note that since tags are required
148
     * to be ordered, compression code can override this behavior
149
     * in the setup method if it wants to roll the post decoding
150
     * work in with its normal work.
151
     */
152
587k
    if (tif->tif_flags & TIFF_SWAB)
153
159k
    {
154
159k
        TIFFDirectory *td = &tif->tif_dir;
155
159k
        if (td->td_bitspersample == 16)
156
1.96k
            tif->tif_postdecode = _TIFFSwab16BitData;
157
157k
        else if (td->td_bitspersample == 24)
158
932
            tif->tif_postdecode = _TIFFSwab24BitData;
159
156k
        else if (td->td_bitspersample == 32)
160
1.57k
            tif->tif_postdecode = _TIFFSwab32BitData;
161
154k
        else if (td->td_bitspersample == 64)
162
686
            tif->tif_postdecode = _TIFFSwab64BitData;
163
154k
        else if (td->td_bitspersample == 128)
164
21
        {
165
            // Used for Complex 64-bit floating point.
166
            // The real and imaginary parts are byte-swapped separately.
167
21
            tif->tif_postdecode = _TIFFSwab64BitData;
168
21
        }
169
159k
    }
170
587k
}
171
172
static uint64_t _TIFFDefaultGetMaxCompressionRatio(TIFF *tif)
173
0
{
174
0
    (void)tif;
175
0
    return 0; /* unknown */
176
0
}
177
178
static uint64_t _TIFFGetMaxCompressionRatioOne(TIFF *tif)
179
0
{
180
0
    (void)tif;
181
0
    return 1; /* no compression */
182
0
}
183
184
void _TIFFSetDefaultCompressionState(TIFF *tif)
185
498k
{
186
498k
    tif->tif_fixuptags = _TIFFNoFixupTags;
187
498k
    tif->tif_decodestatus = TRUE;
188
498k
    tif->tif_setupdecode = _TIFFtrue;
189
498k
    tif->tif_predecode = _TIFFNoPreCode;
190
498k
    _TIFFSetDefaultPostDecode(tif);
191
498k
    tif->tif_decoderow = _TIFFNoRowDecode;
192
498k
    tif->tif_decodestrip = _TIFFNoStripDecode;
193
498k
    tif->tif_decodetile = _TIFFNoTileDecode;
194
498k
    tif->tif_encodestatus = TRUE;
195
498k
    tif->tif_setupencode = _TIFFtrue;
196
498k
    tif->tif_preencode = _TIFFNoPreCode;
197
498k
    tif->tif_postencode = _TIFFtrue;
198
498k
    tif->tif_encoderow = _TIFFNoRowEncode;
199
498k
    tif->tif_encodestrip = _TIFFNoStripEncode;
200
498k
    tif->tif_encodetile = _TIFFNoTileEncode;
201
498k
    tif->tif_close = _TIFFvoid;
202
498k
    tif->tif_seek = _TIFFNoSeek;
203
498k
    tif->tif_cleanup = _TIFFvoid;
204
498k
    tif->tif_defstripsize = _TIFFDefaultStripSize;
205
498k
    tif->tif_deftilesize = _TIFFDefaultTileSize;
206
498k
    tif->tif_getmaxcompressionratio = _TIFFDefaultGetMaxCompressionRatio;
207
498k
    tif->tif_flags &= ~(TIFF_NOBITREV | TIFF_NOREADRAW);
208
498k
}
209
210
int TIFFSetCompressionScheme(TIFF *tif, int scheme)
211
287k
{
212
287k
    const TIFFCodec *c = TIFFFindCODEC((uint16_t)scheme);
213
214
287k
    _TIFFSetDefaultCompressionState(tif);
215
287k
    if (scheme == COMPRESSION_NONE)
216
206k
        tif->tif_getmaxcompressionratio = _TIFFGetMaxCompressionRatioOne;
217
    /*
218
     * Don't treat an unknown compression scheme as an error.
219
     * This permits applications to open files with data that
220
     * the library does not have builtin support for, but which
221
     * may still be meaningful.
222
     */
223
287k
    return (c ? (*c->init)(tif, scheme) : 1);
224
287k
}
225
226
uint64_t TIFFGetMaxCompressionRatio(TIFF *tif)
227
16
{
228
16
    if (tif->tif_getmaxcompressionratio)
229
16
        return tif->tif_getmaxcompressionratio(tif);
230
0
    return 0;
231
16
}
232
233
/*
234
 * Other compression schemes may be registered.  Registered
235
 * schemes can also override the builtin versions provided
236
 * by this library.
237
 */
238
typedef struct _codec
239
{
240
    struct _codec *next;
241
    TIFFCodec *info;
242
} codec_t;
243
static codec_t *registeredCODECS = NULL;
244
245
const TIFFCodec *TIFFFindCODEC(uint16_t scheme)
246
489k
{
247
489k
    const TIFFCodec *c;
248
489k
    codec_t *cd;
249
250
489k
    for (cd = registeredCODECS; cd; cd = cd->next)
251
0
        if (cd->info->scheme == scheme)
252
0
            return ((const TIFFCodec *)cd->info);
253
2.18M
    for (c = _TIFFBuiltinCODECS; c->name; c++)
254
2.18M
        if (c->scheme == scheme)
255
486k
            return (c);
256
3.18k
    return NULL;
257
489k
}
258
259
TIFFCodec *TIFFRegisterCODEC(uint16_t scheme, const char *name,
260
                             TIFFInitMethod init)
261
0
{
262
0
    codec_t *cd = (codec_t *)_TIFFmallocExt(
263
0
        NULL,
264
0
        (tmsize_t)(sizeof(codec_t) + sizeof(TIFFCodec) + strlen(name) + 1));
265
266
0
    if (cd != NULL)
267
0
    {
268
0
        char *codec_name;
269
0
        cd->info = (TIFFCodec *)((uint8_t *)cd + sizeof(codec_t));
270
0
        codec_name = (char *)((uint8_t *)cd->info + sizeof(TIFFCodec));
271
0
        strcpy(codec_name, name);
272
0
        cd->info->name = codec_name;
273
0
        cd->info->scheme = scheme;
274
0
        cd->info->init = init;
275
0
        cd->next = registeredCODECS;
276
0
        registeredCODECS = cd;
277
0
    }
278
0
    else
279
0
    {
280
0
        TIFFErrorExt(0, "TIFFRegisterCODEC",
281
0
                     "No space to register compression scheme %s", name);
282
0
        return NULL;
283
0
    }
284
0
    return (cd->info);
285
0
}
286
287
void TIFFUnRegisterCODEC(TIFFCodec *c)
288
0
{
289
0
    codec_t *cd;
290
0
    codec_t **pcd;
291
292
0
    for (pcd = &registeredCODECS; (cd = *pcd) != NULL; pcd = &cd->next)
293
0
        if (cd->info == c)
294
0
        {
295
0
            *pcd = cd->next;
296
0
            _TIFFfreeExt(NULL, cd);
297
0
            return;
298
0
        }
299
0
    TIFFErrorExt(0, "TIFFUnRegisterCODEC",
300
0
                 "Cannot remove compression scheme %s; not registered",
301
0
                 c->name);
302
0
}
303
304
/************************************************************************/
305
/*                      TIFFGetConfiguredCODECs()                       */
306
/************************************************************************/
307
308
/**
309
 * Get list of configured codecs, both built-in and registered by user.
310
 * Caller is responsible to free this structure.
311
 *
312
 * @return returns array of TIFFCodec records (the last record should be NULL)
313
 * or NULL if function failed.
314
 */
315
316
TIFFCodec *TIFFGetConfiguredCODECs(void)
317
0
{
318
0
    int i = 1;
319
0
    codec_t *cd;
320
0
    const TIFFCodec *c;
321
0
    TIFFCodec *codecs = NULL;
322
0
    TIFFCodec *new_codecs;
323
324
0
    for (cd = registeredCODECS; cd; cd = cd->next)
325
0
    {
326
0
        new_codecs = (TIFFCodec *)_TIFFreallocExt(
327
0
            NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
328
0
        if (!new_codecs)
329
0
        {
330
0
            _TIFFfreeExt(NULL, codecs);
331
0
            return NULL;
332
0
        }
333
0
        codecs = new_codecs;
334
0
        _TIFFmemcpy(codecs + i - 1, cd->info, sizeof(TIFFCodec));
335
0
        i++;
336
0
    }
337
0
    for (c = _TIFFBuiltinCODECS; c->name; c++)
338
0
    {
339
0
        if (TIFFIsCODECConfigured(c->scheme))
340
0
        {
341
0
            new_codecs = (TIFFCodec *)_TIFFreallocExt(
342
0
                NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
343
0
            if (!new_codecs)
344
0
            {
345
0
                _TIFFfreeExt(NULL, codecs);
346
0
                return NULL;
347
0
            }
348
0
            codecs = new_codecs;
349
0
            _TIFFmemcpy(codecs + i - 1, c, sizeof(TIFFCodec));
350
0
            i++;
351
0
        }
352
0
    }
353
354
0
    new_codecs = (TIFFCodec *)_TIFFreallocExt(
355
0
        NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
356
0
    if (!new_codecs)
357
0
    {
358
0
        _TIFFfreeExt(NULL, codecs);
359
0
        return NULL;
360
0
    }
361
0
    codecs = new_codecs;
362
0
    _TIFFmemset(codecs + i - 1, 0, sizeof(TIFFCodec));
363
364
0
    return codecs;
365
0
}