Coverage Report

Created: 2025-11-24 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qpdf/libqpdf/Pl_DCT.cc
Line
Count
Source
1
#include <qpdf/Pl_DCT.hh>
2
3
#include <qpdf/QIntC.hh>
4
#include <qpdf/QTC.hh>
5
#include <qpdf/Util.hh>
6
7
#include <csetjmp>
8
#include <stdexcept>
9
#include <string>
10
11
#if BITS_IN_JSAMPLE != 8
12
# error "qpdf does not support libjpeg built with BITS_IN_JSAMPLE != 8"
13
#endif
14
15
using namespace qpdf;
16
17
namespace
18
{
19
    class FunctionCallbackConfig: public Pl_DCT::CompressConfig
20
    {
21
      public:
22
        explicit FunctionCallbackConfig(std::function<void(jpeg_compress_struct*)> f) :
23
0
            f(std::move(f))
24
0
        {
25
0
        }
26
0
        ~FunctionCallbackConfig() override = default;
27
        void
28
        apply(jpeg_compress_struct* config) override
29
0
        {
30
0
            f(config);
31
0
        };
32
33
        std::function<void(jpeg_compress_struct*)> f;
34
    };
35
36
    struct qpdf_jpeg_error_mgr
37
    {
38
        struct jpeg_error_mgr pub;
39
        jmp_buf jmpbuf;
40
        std::string msg;
41
    };
42
43
    long memory_limit{0};
44
    int scan_limit{0};
45
    bool throw_on_corrupt_data{true};
46
} // namespace
47
48
static void
49
error_handler(j_common_ptr cinfo)
50
0
{
51
0
    auto* jerr = reinterpret_cast<qpdf_jpeg_error_mgr*>(cinfo->err);
52
0
    char buf[JMSG_LENGTH_MAX];
53
0
    (*cinfo->err->format_message)(cinfo, buf);
54
0
    jerr->msg = buf;
55
0
    longjmp(jerr->jmpbuf, 1);
56
0
}
57
58
static void
59
emit_message(j_common_ptr cinfo, int msg_level)
60
0
{
61
0
    if (msg_level == -1) {
62
0
        auto* jerr = reinterpret_cast<qpdf_jpeg_error_mgr*>(cinfo->err);
63
0
        jerr->msg = "Pl_DCT::decompress: JPEG data is corrupt";
64
0
        longjmp(jerr->jmpbuf, 1);
65
0
    }
66
0
}
67
68
static void
69
progress_monitor(j_common_ptr cinfo)
70
0
{
71
0
    if (cinfo->is_decompressor &&
72
0
        reinterpret_cast<jpeg_decompress_struct*>(cinfo)->input_scan_number > scan_limit) {
73
0
        auto* jerr = reinterpret_cast<qpdf_jpeg_error_mgr*>(cinfo->err);
74
0
        jerr->msg = "Pl_DCT::decompress: JPEG data has too many scans";
75
0
        longjmp(jerr->jmpbuf, 1);
76
0
    }
77
0
}
78
79
class Pl_DCT::Members
80
{
81
  public:
82
    // For compression
83
    Members(
84
        JDIMENSION image_width,
85
        JDIMENSION image_height,
86
        int components,
87
        J_COLOR_SPACE color_space,
88
        CompressConfig* config_callback) :
89
0
        action(a_compress),
90
0
        image_width(image_width),
91
0
        image_height(image_height),
92
0
        components(components),
93
0
        color_space(color_space),
94
0
        config_callback(config_callback)
95
0
    {
96
0
    }
97
98
    // For decompression
99
    Members() :
100
0
        action(a_decompress)
101
0
    {
102
0
    }
103
104
    Members(Members const&) = delete;
105
106
0
    ~Members() = default;
107
108
    action_e action;
109
    std::string buf;
110
111
    // Used for compression
112
    JDIMENSION image_width{0};
113
    JDIMENSION image_height{0};
114
    int components{1};
115
    J_COLOR_SPACE color_space{JCS_GRAYSCALE};
116
117
    CompressConfig* config_callback{nullptr};
118
};
119
120
Pl_DCT::Pl_DCT(char const* identifier, Pipeline* next) :
121
0
    Pipeline(identifier, next),
122
0
    m(std::make_unique<Members>())
123
0
{
124
0
    util::assertion(next, "Attempt to create Pl_DCT with nullptr as next");
125
0
}
126
127
void
128
Pl_DCT::setMemoryLimit(long limit)
129
18.8k
{
130
18.8k
    memory_limit = limit;
131
18.8k
}
132
133
void
134
Pl_DCT::setScanLimit(int limit)
135
18.8k
{
136
18.8k
    scan_limit = limit;
137
18.8k
}
138
139
void
140
Pl_DCT::setThrowOnCorruptData(bool treat_as_error)
141
18.8k
{
142
18.8k
    throw_on_corrupt_data = treat_as_error;
143
18.8k
}
144
145
Pl_DCT::Pl_DCT(
146
    char const* identifier,
147
    Pipeline* next,
148
    JDIMENSION image_width,
149
    JDIMENSION image_height,
150
    int components,
151
    J_COLOR_SPACE color_space,
152
    CompressConfig* compress_callback) :
153
0
    Pipeline(identifier, next),
154
0
    m(std::make_unique<Members>(
155
0
        image_width, image_height, components, color_space, compress_callback))
156
0
{
157
0
}
158
159
// Must be explicit and not inline -- see QPDF_DLL_CLASS in README-maintainer
160
0
Pl_DCT::~Pl_DCT() = default;
161
162
void
163
Pl_DCT::write(unsigned char const* data, size_t len)
164
0
{
165
0
    if (len > 0) {
166
0
        m->buf.append(reinterpret_cast<char const*>(data), len);
167
0
    }
168
0
}
169
170
void
171
Pl_DCT::finish()
172
0
{
173
0
    if (m->buf.empty()) {
174
        // Special case: empty data will never succeed and probably means we're calling finish a
175
        // second time from an exception handler.
176
0
        next()->finish();
177
0
        return;
178
0
    }
179
180
0
    struct jpeg_compress_struct cinfo_compress;
181
0
    struct jpeg_decompress_struct cinfo_decompress;
182
0
    struct qpdf_jpeg_error_mgr jerr;
183
184
0
    cinfo_compress.err = jpeg_std_error(&(jerr.pub));
185
0
    cinfo_decompress.err = jpeg_std_error(&(jerr.pub));
186
0
    jerr.pub.error_exit = error_handler;
187
0
    if (m->action == a_decompress && throw_on_corrupt_data) {
188
0
        jerr.pub.emit_message = emit_message;
189
0
    }
190
191
0
    bool error = false;
192
    // The jpeg library is a "C" library, so we use setjmp and longjmp for exception handling.
193
0
    if (setjmp(jerr.jmpbuf) == 0) {
194
0
        try {
195
0
            if (m->action == a_compress) {
196
0
                compress(reinterpret_cast<void*>(&cinfo_compress));
197
0
            } else {
198
0
                decompress(reinterpret_cast<void*>(&cinfo_decompress));
199
0
            }
200
0
        } catch (std::exception& e) {
201
            // Convert an exception back to a longjmp so we can ensure that the right cleanup
202
            // happens. This will get converted back to an exception.
203
0
            jerr.msg = e.what();
204
0
            longjmp(jerr.jmpbuf, 1);
205
0
        }
206
0
    } else {
207
0
        error = true;
208
0
    }
209
210
0
    if (m->action == a_compress) {
211
0
        jpeg_destroy_compress(&cinfo_compress);
212
0
    }
213
0
    if (m->action == a_decompress) {
214
0
        jpeg_destroy_decompress(&cinfo_decompress);
215
0
    }
216
0
    if (error) {
217
0
        throw std::runtime_error(jerr.msg);
218
0
    }
219
0
}
220
221
namespace
222
{
223
    struct dct_pipeline_dest
224
    {
225
        struct jpeg_destination_mgr pub; /* public fields */
226
        unsigned char* buffer;
227
        size_t size;
228
        Pipeline* next;
229
    };
230
} // namespace
231
232
static void
233
init_pipeline_destination(j_compress_ptr)
234
0
{
235
0
}
236
237
static boolean
238
empty_pipeline_output_buffer(j_compress_ptr cinfo)
239
0
{
240
0
    QTC::TC("libtests", "Pl_DCT empty_pipeline_output_buffer");
241
0
    auto* dest = reinterpret_cast<dct_pipeline_dest*>(cinfo->dest);
242
0
    dest->next->write(dest->buffer, dest->size);
243
0
    dest->pub.next_output_byte = dest->buffer;
244
0
    dest->pub.free_in_buffer = dest->size;
245
0
    return TRUE;
246
0
}
247
248
static void
249
term_pipeline_destination(j_compress_ptr cinfo)
250
0
{
251
0
    QTC::TC("libtests", "Pl_DCT term_pipeline_destination");
252
0
    auto* dest = reinterpret_cast<dct_pipeline_dest*>(cinfo->dest);
253
0
    dest->next->write(dest->buffer, dest->size - dest->pub.free_in_buffer);
254
0
}
255
256
static void
257
jpeg_pipeline_dest(j_compress_ptr cinfo, unsigned char* outbuffer, size_t size, Pipeline* next)
258
0
{
259
0
    cinfo->dest = static_cast<struct jpeg_destination_mgr*>(
260
        // line-break
261
0
        (*cinfo->mem->alloc_small)(
262
0
            reinterpret_cast<j_common_ptr>(cinfo), JPOOL_PERMANENT, sizeof(dct_pipeline_dest)));
263
0
    auto* dest = reinterpret_cast<dct_pipeline_dest*>(cinfo->dest);
264
0
    dest->pub.init_destination = init_pipeline_destination;
265
0
    dest->pub.empty_output_buffer = empty_pipeline_output_buffer;
266
0
    dest->pub.term_destination = term_pipeline_destination;
267
0
    dest->pub.next_output_byte = dest->buffer = outbuffer;
268
0
    dest->pub.free_in_buffer = dest->size = size;
269
0
    dest->next = next;
270
0
}
271
272
static void
273
init_buffer_source(j_decompress_ptr)
274
0
{
275
0
}
276
277
static boolean
278
fill_buffer_input_buffer(j_decompress_ptr)
279
0
{
280
    // The whole JPEG data is expected to reside in the supplied memory buffer, so any request for
281
    // more data beyond the given buffer size is treated as an error.
282
0
    throw std::runtime_error("invalid jpeg data reading from buffer");
283
0
    return TRUE;
284
0
}
285
286
static void
287
skip_buffer_input_data(j_decompress_ptr cinfo, long num_bytes)
288
0
{
289
0
    util::no_ci_rt_error_if(
290
0
        num_bytes < 0, "reading jpeg: jpeg library requested skipping a negative number of bytes");
291
0
    size_t to_skip = QIntC::to_size(num_bytes);
292
0
    if (to_skip > 0 && to_skip <= cinfo->src->bytes_in_buffer) {
293
0
        cinfo->src->next_input_byte += to_skip;
294
0
        cinfo->src->bytes_in_buffer -= to_skip;
295
0
    } else if (to_skip != 0) {
296
0
        cinfo->src->next_input_byte += cinfo->src->bytes_in_buffer;
297
0
        cinfo->src->bytes_in_buffer = 0;
298
0
    }
299
0
}
300
301
static void
302
term_buffer_source(j_decompress_ptr)
303
0
{
304
0
}
305
306
static void
307
jpeg_buffer_src(j_decompress_ptr cinfo, std::string& buffer)
308
0
{
309
0
    cinfo->src = reinterpret_cast<jpeg_source_mgr*>(
310
        // line-break
311
0
        (*cinfo->mem->alloc_small)(
312
0
            reinterpret_cast<j_common_ptr>(cinfo), JPOOL_PERMANENT, sizeof(jpeg_source_mgr)));
313
314
0
    jpeg_source_mgr* src = cinfo->src;
315
0
    src->init_source = init_buffer_source;
316
0
    src->fill_input_buffer = fill_buffer_input_buffer;
317
0
    src->skip_input_data = skip_buffer_input_data;
318
0
    src->resync_to_restart = jpeg_resync_to_restart; /* use default method */
319
0
    src->term_source = term_buffer_source;
320
0
    src->bytes_in_buffer = buffer.size();
321
0
    src->next_input_byte = reinterpret_cast<unsigned char*>(buffer.data());
322
0
}
323
324
void
325
Pl_DCT::compress(void* cinfo_p)
326
0
{
327
0
    auto* cinfo = reinterpret_cast<jpeg_compress_struct*>(cinfo_p);
328
329
0
#if ((defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406) || defined(__clang__))
330
0
# pragma GCC diagnostic push
331
0
# pragma GCC diagnostic ignored "-Wold-style-cast"
332
0
#endif
333
0
    jpeg_create_compress(cinfo);
334
0
#if ((defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406) || defined(__clang__))
335
0
# pragma GCC diagnostic pop
336
0
#endif
337
0
    static int const BUF_SIZE = 65536;
338
0
    auto outbuffer_ph = std::make_unique<unsigned char[]>(BUF_SIZE);
339
0
    unsigned char* outbuffer = outbuffer_ph.get();
340
0
    jpeg_pipeline_dest(cinfo, outbuffer, BUF_SIZE, next());
341
342
0
    cinfo->image_width = m->image_width;
343
0
    cinfo->image_height = m->image_height;
344
0
    cinfo->input_components = m->components;
345
0
    cinfo->in_color_space = m->color_space;
346
0
    jpeg_set_defaults(cinfo);
347
0
    if (m->config_callback) {
348
0
        m->config_callback->apply(cinfo);
349
0
    }
350
351
0
    jpeg_start_compress(cinfo, TRUE);
352
353
0
    unsigned int width = cinfo->image_width * QIntC::to_uint(cinfo->input_components);
354
0
    size_t expected_size = QIntC::to_size(cinfo->image_height) *
355
0
        QIntC::to_size(cinfo->image_width) * QIntC::to_size(cinfo->input_components);
356
0
    util::no_ci_rt_error_if(
357
0
        m->buf.size() != expected_size,
358
0
        "Pl_DCT: image buffer size = " + std::to_string(m->buf.size()) +
359
0
            "; expected size = " + std::to_string(expected_size));
360
0
    JSAMPROW row_pointer[1];
361
0
    auto buffer = reinterpret_cast<unsigned char*>(m->buf.data());
362
0
    while (cinfo->next_scanline < cinfo->image_height) {
363
        // We already verified that the buffer is big enough.
364
0
        row_pointer[0] = &buffer[cinfo->next_scanline * width];
365
0
        (void)jpeg_write_scanlines(cinfo, row_pointer, 1);
366
0
    }
367
0
    jpeg_finish_compress(cinfo);
368
0
    next()->finish();
369
0
}
370
371
void
372
Pl_DCT::decompress(void* cinfo_p)
373
0
{
374
0
    auto* cinfo = reinterpret_cast<jpeg_decompress_struct*>(cinfo_p);
375
376
0
#if ((defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406) || defined(__clang__))
377
0
# pragma GCC diagnostic push
378
0
# pragma GCC diagnostic ignored "-Wold-style-cast"
379
0
#endif
380
0
    jpeg_create_decompress(cinfo);
381
0
#if ((defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406) || defined(__clang__))
382
0
# pragma GCC diagnostic pop
383
0
#endif
384
385
0
    if (memory_limit > 0) {
386
0
        cinfo->mem->max_memory_to_use = memory_limit;
387
0
    }
388
389
0
    jpeg_buffer_src(cinfo, m->buf);
390
391
0
    (void)jpeg_read_header(cinfo, TRUE);
392
0
    jpeg_calc_output_dimensions(cinfo);
393
0
    unsigned int width = cinfo->output_width * QIntC::to_uint(cinfo->output_components);
394
0
    if (memory_limit > 0 &&
395
0
        width > (static_cast<unsigned long>(memory_limit) / (20U * cinfo->output_height))) {
396
        // Even if jpeglib does not run out of memory, qpdf will while buffering the data before
397
        // writing it. Furthermore, for very large images runtime can be significant before the
398
        // first warning is encountered causing a timeout in oss-fuzz.
399
0
        throw std::runtime_error("Pl_DCT::decompress: JPEG data large - may be too slow");
400
0
    }
401
0
    jpeg_progress_mgr progress_mgr;
402
0
    if (scan_limit > 0) {
403
0
        progress_mgr.progress_monitor = &progress_monitor;
404
0
        cinfo->progress = &progress_mgr;
405
0
    }
406
0
    JSAMPARRAY buffer =
407
0
        (*cinfo->mem->alloc_sarray)(reinterpret_cast<j_common_ptr>(cinfo), JPOOL_IMAGE, width, 1);
408
409
0
    (void)jpeg_start_decompress(cinfo);
410
0
    while (cinfo->output_scanline < cinfo->output_height) {
411
0
        (void)jpeg_read_scanlines(cinfo, buffer, 1);
412
0
        next()->write(buffer[0], width * sizeof(buffer[0][0]));
413
0
    }
414
0
    (void)jpeg_finish_decompress(cinfo);
415
0
    next()->finish();
416
0
}
417
418
std::unique_ptr<Pl_DCT::CompressConfig>
419
Pl_DCT::make_compress_config(std::function<void(jpeg_compress_struct*)> f)
420
0
{
421
0
    return std::make_unique<FunctionCallbackConfig>(f);
422
0
}