cde/lib/DtHelp/jpeg/jdatasrc.c

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