Coverage Report

Created: 2026-07-25 06:50

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gdal/frmts/gtiff/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
0
{
77
0
    const TIFFCodec *c = TIFFFindCODEC(tif->tif_dir.td_compression);
78
79
0
    if (c)
80
0
        TIFFErrorExtR(tif, tif->tif_name, "%s %s decoding is not implemented",
81
0
                      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
0
    return (0);
88
0
}
89
90
static int _TIFFNoFixupTags(TIFF *tif)
91
0
{
92
0
    (void)tif;
93
0
    return (1);
94
0
}
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
0
{
114
0
    (void)pp;
115
0
    (void)cc;
116
0
    (void)s;
117
0
    return (TIFFNoDecode(tif, "tile"));
118
0
}
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
0
{
130
0
    (void)tif;
131
0
    (void)s;
132
0
    return (1);
133
0
}
134
135
static int _TIFFtrue(TIFF *tif)
136
0
{
137
0
    (void)tif;
138
0
    return (1);
139
0
}
140
0
static void _TIFFvoid(TIFF *tif) { (void)tif; }
141
142
static uint64_t _TIFFDefaultGetMaxCompressionRatio(TIFF *tif)
143
0
{
144
0
    (void)tif;
145
0
    return 0; /* unknown */
146
0
}
147
148
static uint64_t _TIFFGetMaxCompressionRatioOne(TIFF *tif)
149
0
{
150
0
    (void)tif;
151
0
    return 1; /* no compression */
152
0
}
153
154
void _TIFFSetDefaultCompressionState(TIFF *tif)
155
0
{
156
0
    tif->tif_fixuptags = _TIFFNoFixupTags;
157
0
    tif->tif_decodestatus = TRUE;
158
0
    tif->tif_setupdecode = _TIFFtrue;
159
0
    tif->tif_predecode = _TIFFNoPreCode;
160
0
    tif->tif_decoderow = _TIFFNoRowDecode;
161
0
    tif->tif_decodestrip = _TIFFNoStripDecode;
162
0
    tif->tif_decodetile = _TIFFNoTileDecode;
163
0
    tif->tif_encodestatus = TRUE;
164
0
    tif->tif_setupencode = _TIFFtrue;
165
0
    tif->tif_preencode = _TIFFNoPreCode;
166
0
    tif->tif_postencode = _TIFFtrue;
167
0
    tif->tif_encoderow = _TIFFNoRowEncode;
168
0
    tif->tif_encodestrip = _TIFFNoStripEncode;
169
0
    tif->tif_encodetile = _TIFFNoTileEncode;
170
0
    tif->tif_close = _TIFFvoid;
171
0
    tif->tif_seek = _TIFFNoSeek;
172
0
    tif->tif_cleanup = _TIFFvoid;
173
0
    tif->tif_defstripsize = _TIFFDefaultStripSize;
174
0
    tif->tif_deftilesize = _TIFFDefaultTileSize;
175
0
    tif->tif_getmaxcompressionratio = _TIFFDefaultGetMaxCompressionRatio;
176
0
    tif->tif_flags &= ~(TIFF_NOBITREV | TIFF_NOREADRAW);
177
0
}
178
179
int TIFFSetCompressionScheme(TIFF *tif, int scheme)
180
0
{
181
0
    const TIFFCodec *c = TIFFFindCODEC((uint16_t)scheme);
182
183
0
    _TIFFSetDefaultCompressionState(tif);
184
0
    if (scheme == COMPRESSION_NONE)
185
0
        tif->tif_getmaxcompressionratio = _TIFFGetMaxCompressionRatioOne;
186
    /*
187
     * Don't treat an unknown compression scheme as an error.
188
     * This permits applications to open files with data that
189
     * the library does not have builtin support for, but which
190
     * may still be meaningful.
191
     */
192
0
    return (c ? (*c->init)(tif, scheme) : 1);
193
0
}
194
195
uint64_t TIFFGetMaxCompressionRatio(TIFF *tif)
196
0
{
197
0
    if (tif->tif_getmaxcompressionratio)
198
0
        return tif->tif_getmaxcompressionratio(tif);
199
0
    return 0;
200
0
}
201
202
/*
203
 * Other compression schemes may be registered.  Registered
204
 * schemes can also override the builtin versions provided
205
 * by this library.
206
 */
207
typedef struct _codec
208
{
209
    struct _codec *next;
210
    TIFFCodec *info;
211
} codec_t;
212
static codec_t *registeredCODECS = NULL;
213
214
const TIFFCodec *TIFFFindCODEC(uint16_t scheme)
215
0
{
216
0
    const TIFFCodec *c;
217
0
    codec_t *cd;
218
219
0
    for (cd = registeredCODECS; cd; cd = cd->next)
220
0
        if (cd->info->scheme == scheme)
221
0
            return ((const TIFFCodec *)cd->info);
222
0
    for (c = _TIFFBuiltinCODECS; c->name; c++)
223
0
        if (c->scheme == scheme)
224
0
            return (c);
225
0
    return NULL;
226
0
}
227
228
TIFFCodec *TIFFRegisterCODEC(uint16_t scheme, const char *name,
229
                             TIFFInitMethod init)
230
0
{
231
0
    codec_t *cd = (codec_t *)_TIFFmallocExt(
232
0
        NULL,
233
0
        (tmsize_t)(sizeof(codec_t) + sizeof(TIFFCodec) + strlen(name) + 1));
234
235
0
    if (cd != NULL)
236
0
    {
237
0
        char *codec_name;
238
0
        cd->info = (TIFFCodec *)((uint8_t *)cd + sizeof(codec_t));
239
0
        codec_name = (char *)((uint8_t *)cd->info + sizeof(TIFFCodec));
240
0
        strcpy(codec_name, name);
241
0
        cd->info->name = codec_name;
242
0
        cd->info->scheme = scheme;
243
0
        cd->info->init = init;
244
0
        cd->next = registeredCODECS;
245
0
        registeredCODECS = cd;
246
0
    }
247
0
    else
248
0
    {
249
0
        TIFFErrorExt(0, "TIFFRegisterCODEC",
250
0
                     "No space to register compression scheme %s", name);
251
0
        return NULL;
252
0
    }
253
0
    return (cd->info);
254
0
}
255
256
void TIFFUnRegisterCODEC(TIFFCodec *c)
257
0
{
258
0
    codec_t *cd;
259
0
    codec_t **pcd;
260
261
0
    for (pcd = &registeredCODECS; (cd = *pcd) != NULL; pcd = &cd->next)
262
0
        if (cd->info == c)
263
0
        {
264
0
            *pcd = cd->next;
265
0
            _TIFFfreeExt(NULL, cd);
266
0
            return;
267
0
        }
268
0
    TIFFErrorExt(0, "TIFFUnRegisterCODEC",
269
0
                 "Cannot remove compression scheme %s; not registered",
270
0
                 c->name);
271
0
}
272
273
/************************************************************************/
274
/*                      TIFFGetConfiguredCODECs()                       */
275
/************************************************************************/
276
277
/**
278
 * Get list of configured codecs, both built-in and registered by user.
279
 * Caller is responsible to free this structure.
280
 *
281
 * @return returns array of TIFFCodec records (the last record should be NULL)
282
 * or NULL if function failed.
283
 */
284
285
TIFFCodec *TIFFGetConfiguredCODECs(void)
286
0
{
287
0
    int i = 1;
288
0
    codec_t *cd;
289
0
    const TIFFCodec *c;
290
0
    TIFFCodec *codecs = NULL;
291
0
    TIFFCodec *new_codecs;
292
293
0
    for (cd = registeredCODECS; cd; cd = cd->next)
294
0
    {
295
0
        new_codecs = (TIFFCodec *)_TIFFreallocExt(
296
0
            NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
297
0
        if (!new_codecs)
298
0
        {
299
0
            _TIFFfreeExt(NULL, codecs);
300
0
            return NULL;
301
0
        }
302
0
        codecs = new_codecs;
303
0
        _TIFFmemcpy(codecs + i - 1, cd->info, sizeof(TIFFCodec));
304
0
        i++;
305
0
    }
306
0
    for (c = _TIFFBuiltinCODECS; c->name; c++)
307
0
    {
308
0
        if (TIFFIsCODECConfigured(c->scheme))
309
0
        {
310
0
            new_codecs = (TIFFCodec *)_TIFFreallocExt(
311
0
                NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
312
0
            if (!new_codecs)
313
0
            {
314
0
                _TIFFfreeExt(NULL, codecs);
315
0
                return NULL;
316
0
            }
317
0
            codecs = new_codecs;
318
0
            _TIFFmemcpy(codecs + i - 1, c, sizeof(TIFFCodec));
319
0
            i++;
320
0
        }
321
0
    }
322
323
0
    new_codecs = (TIFFCodec *)_TIFFreallocExt(
324
0
        NULL, codecs, (tmsize_t)((size_t)i * sizeof(TIFFCodec)));
325
0
    if (!new_codecs)
326
0
    {
327
0
        _TIFFfreeExt(NULL, codecs);
328
0
        return NULL;
329
0
    }
330
0
    codecs = new_codecs;
331
0
    _TIFFmemset(codecs + i - 1, 0, sizeof(TIFFCodec));
332
333
0
    return codecs;
334
0
}