| 1 |
/* |
| 2 |
* jdatasrc.c |
| 3 |
* |
| 4 |
* Copyright (C) 1994-1996, Thomas G. Lane. |
| 5 |
* This file is part of the Independent JPEG Group's software. |
| 6 |
* For conditions of distribution and use, see the accompanying README file. |
| 7 |
* |
| 8 |
* This file contains decompression data source routines for the case of |
| 9 |
* reading JPEG data from a file (or any stdio stream). While these routines |
| 10 |
* are sufficient for most applications, some will want to use a different |
| 11 |
* source manager. |
| 12 |
* IMPORTANT: we assume that fread() will correctly transcribe an array of |
| 13 |
* JOCTETs from 8-bit-wide elements on external storage. If char is wider |
| 14 |
* than 8 bits on your machine, you may need to do some tweaking. |
| 15 |
*/ |
| 16 |
|
| 17 |
/* this is not a core library module, so it doesn't define JPEG_INTERNALS */ |
| 18 |
#include "jinclude.h" |
| 19 |
#include "jpeglib.h" |
| 20 |
#include "jerror.h" |
| 21 |
|
| 22 |
#include "cpl_port.h" |
| 23 |
|
| 24 |
/* Expanded data source object for stdio input */ |
| 25 |
|
| 26 |
typedef struct { |
| 27 |
struct jpeg_source_mgr pub; /* public fields */ |
| 28 |
|
| 29 |
FILE * infile; /* source stream */ |
| 30 |
JOCTET * buffer; /* start of buffer */ |
| 31 |
boolean start_of_file; /* have we gotten any data yet? */ |
| 32 |
} my_source_mgr; |
| 33 |
|
| 34 |
typedef my_source_mgr * my_src_ptr; |
| 35 |
|
| 36 |
#define INPUT_BUF_SIZE 4096 /* choose an efficiently fread'able size */ |
| 37 |
|
| 38 |
|
| 39 |
/* |
| 40 |
* Initialize source --- called by jpeg_read_header |
| 41 |
* before any data is actually read. |
| 42 |
*/ |
| 43 |
|
| 44 |
METHODDEF(void) |
| 45 |
init_source (j_decompress_ptr cinfo) |
| 46 |
{ |
| 47 |
my_src_ptr src = (my_src_ptr) cinfo->src; |
| 48 |
|
| 49 |
/* We reset the empty-input-file flag for each image, |
| 50 |
* but we don't clear the input buffer. |
| 51 |
* This is correct behavior for reading a series of images from one source. |
| 52 |
*/ |
| 53 |
src->start_of_file = TRUE; |
| 54 |
} |
| 55 |
|
| 56 |
|
| 57 |
/* |
| 58 |
* Fill the input buffer --- called whenever buffer is emptied. |
| 59 |
* |
| 60 |
* In typical applications, this should read fresh data into the buffer |
| 61 |
* (ignoring the current state of next_input_byte & bytes_in_buffer), |
| 62 |
* reset the pointer & count to the start of the buffer, and return TRUE |
| 63 |
* indicating that the buffer has been reloaded. It is not necessary to |
| 64 |
* fill the buffer entirely, only to obtain at least one more byte. |
| 65 |
* |
| 66 |
* There is no such thing as an EOF return. If the end of the file has been |
| 67 |
* reached, the routine has a choice of ERREXIT() or inserting fake data into |
| 68 |
* the buffer. In most cases, generating a warning message and inserting a |
| 69 |
* fake EOI marker is the best course of action --- this will allow the |
| 70 |
* decompressor to output however much of the image is there. However, |
| 71 |
* the resulting error message is misleading if the real problem is an empty |
| 72 |
* input file, so we handle that case specially. |
| 73 |
* |
| 74 |
* In applications that need to be able to suspend compression due to input |
| 75 |
* not being available yet, a FALSE return indicates that no more data can be |
| 76 |
* obtained right now, but more may be forthcoming later. In this situation, |
| 77 |
* the decompressor will return to its caller (with an indication of the |
| 78 |
* number of scanlines it has read, if any). The application should resume |
| 79 |
* decompression after it has loaded more data into the input buffer. Note |
| 80 |
* that there are substantial restrictions on the use of suspension --- see |
| 81 |
* the documentation. |
| 82 |
* |
| 83 |
* When suspending, the decompressor will back up to a convenient restart point |
| 84 |
* (typically the start of the current MCU). next_input_byte & bytes_in_buffer |
| 85 |
* indicate where the restart point will be if the current call returns FALSE. |
| 86 |
* Data beyond this point must be rescanned after resumption, so move it to |
| 87 |
* the front of the buffer rather than discarding it. |
| 88 |
*/ |
| 89 |
|
| 90 |
METHODDEF(boolean) |
| 91 |
fill_input_buffer (j_decompress_ptr cinfo) |
| 92 |
{ |
| 93 |
my_src_ptr src = (my_src_ptr) cinfo->src; |
| 94 |
size_t nbytes; |
| 95 |
|
| 96 |
nbytes = JFREAD(src->infile, src->buffer, INPUT_BUF_SIZE); |
| 97 |
|
| 98 |
if (nbytes <= 0) { |
| 99 |
if (src->start_of_file) /* Treat empty input file as fatal error */ |
| 100 |
ERREXIT(cinfo, JERR_INPUT_EMPTY); |
| 101 |
WARNMS(cinfo, JWRN_JPEG_EOF); |
| 102 |
/* Insert a fake EOI marker */ |
| 103 |
src->buffer[0] = (JOCTET) 0xFF; |
| 104 |
src->buffer[1] = (JOCTET) JPEG_EOI; |
| 105 |
nbytes = 2; |
| 106 |
} |
| 107 |
|
| 108 |
src->pub.next_input_byte = src->buffer; |
| 109 |
src->pub.bytes_in_buffer = nbytes; |
| 110 |
src->start_of_file = FALSE; |
| 111 |
|
| 112 |
return TRUE; |
| 113 |
} |
| 114 |
|
| 115 |
|
| 116 |
/* |
| 117 |
* Skip data --- used to skip over a potentially large amount of |
| 118 |
* uninteresting data (such as an APPn marker). |
| 119 |
* |
| 120 |
* Writers of suspendable-input applications must note that skip_input_data |
| 121 |
* is not granted the right to give a suspension return. If the skip extends |
| 122 |
* beyond the data currently in the buffer, the buffer can be marked empty so |
| 123 |
* that the next read will cause a fill_input_buffer call that can suspend. |
| 124 |
* Arranging for additional bytes to be discarded before reloading the input |
| 125 |
* buffer is the application writer's problem. |
| 126 |
*/ |
| 127 |
|
| 128 |
METHODDEF(void) |
| 129 |
skip_input_data (j_decompress_ptr cinfo, long num_bytes) |
| 130 |
{ |
| 131 |
my_src_ptr src = (my_src_ptr) cinfo->src; |
| 132 |
|
| 133 |
/* Just a dumb implementation for now. Could use fseek() except |
| 134 |
* it doesn't work on pipes. Not clear that being smart is worth |
| 135 |
* any trouble anyway --- large skips are infrequent. |
| 136 |
*/ |
| 137 |
if (num_bytes > 0) { |
| 138 |
while (num_bytes > (long) src->pub.bytes_in_buffer) { |
| 139 |
num_bytes -= (long) src->pub.bytes_in_buffer; |
| 140 |
(void) fill_input_buffer(cinfo); |
| 141 |
/* note we assume that fill_input_buffer will never return FALSE, |
| 142 |
* so suspension need not be handled. |
| 143 |
*/ |
| 144 |
} |
| 145 |
src->pub.next_input_byte += (size_t) num_bytes; |
| 146 |
src->pub.bytes_in_buffer -= (size_t) num_bytes; |
| 147 |
} |
| 148 |
} |
| 149 |
|
| 150 |
|
| 151 |
/* |
| 152 |
* An additional method that can be provided by data source modules is the |
| 153 |
* resync_to_restart method for error recovery in the presence of RST markers. |
| 154 |
* For the moment, this source module just uses the default resync method |
| 155 |
* provided by the JPEG library. That method assumes that no backtracking |
| 156 |
* is possible. |
| 157 |
*/ |
| 158 |
|
| 159 |
|
| 160 |
/* |
| 161 |
* Terminate source --- called by jpeg_finish_decompress |
| 162 |
* after all data has been read. Often a no-op. |
| 163 |
* |
| 164 |
* NB: *not* called by jpeg_abort or jpeg_destroy; surrounding |
| 165 |
* application must deal with any cleanup that should happen even |
| 166 |
* for error exit. |
| 167 |
*/ |
| 168 |
|
| 169 |
METHODDEF(void) |
| 170 |
term_source (CPL_UNUSED j_decompress_ptr cinfo) |
| 171 |
{ |
| 172 |
/* no work necessary here */ |
| 173 |
} |
| 174 |
|
| 175 |
|
| 176 |
/* |
| 177 |
* Prepare for input from a stdio stream. |
| 178 |
* The caller must have already opened the stream, and is responsible |
| 179 |
* for closing it after finishing decompression. |
| 180 |
*/ |
| 181 |
|
| 182 |
GLOBAL(void) |
| 183 |
jpeg_stdio_src (j_decompress_ptr cinfo, FILE * infile) |
| 184 |
{ |
| 185 |
my_src_ptr src; |
| 186 |
|
| 187 |
/* The source object and input buffer are made permanent so that a series |
| 188 |
* of JPEG images can be read from the same file by calling jpeg_stdio_src |
| 189 |
* only before the first one. (If we discarded the buffer at the end of |
| 190 |
* one image, we'd likely lose the start of the next one.) |
| 191 |
* This makes it unsafe to use this manager and a different source |
| 192 |
* manager serially with the same JPEG object. Caveat programmer. |
| 193 |
*/ |
| 194 |
if (cinfo->src == NULL) { /* first time for this JPEG object? */ |
| 195 |
cinfo->src = (struct jpeg_source_mgr *) |
| 196 |
(*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT, |
| 197 |
SIZEOF(my_source_mgr)); |
| 198 |
src = (my_src_ptr) cinfo->src; |
| 199 |
src->buffer = (JOCTET *) |
| 200 |
(*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT, |
| 201 |
INPUT_BUF_SIZE * SIZEOF(JOCTET)); |
| 202 |
} |
| 203 |
|
| 204 |
src = (my_src_ptr) cinfo->src; |
| 205 |
src->pub.init_source = init_source; |
| 206 |
src->pub.fill_input_buffer = fill_input_buffer; |
| 207 |
src->pub.skip_input_data = skip_input_data; |
| 208 |
src->pub.resync_to_restart = jpeg_resync_to_restart; /* use default method */ |
| 209 |
src->pub.term_source = term_source; |
| 210 |
src->infile = infile; |
| 211 |
src->pub.bytes_in_buffer = 0; /* forces fill_input_buffer on first read */ |
| 212 |
src->pub.next_input_byte = NULL; /* until buffer loaded */ |
| 213 |
} |