src/jdatasrc.cxx

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