nuclear@26: /*
nuclear@26:  * jdatasrc.c
nuclear@26:  *
nuclear@26:  * Copyright (C) 1994-1996, Thomas G. Lane.
nuclear@26:  * This file is part of the Independent JPEG Group's software.
nuclear@26:  * For conditions of distribution and use, see the accompanying README file.
nuclear@26:  *
nuclear@26:  * This file contains decompression data source routines for the case of
nuclear@26:  * reading JPEG data from a file (or any stdio stream).  While these routines
nuclear@26:  * are sufficient for most applications, some will want to use a different
nuclear@26:  * source manager.
nuclear@26:  * IMPORTANT: we assume that fread() will correctly transcribe an array of
nuclear@26:  * JOCTETs from 8-bit-wide elements on external storage.  If char is wider
nuclear@26:  * than 8 bits on your machine, you may need to do some tweaking.
nuclear@26:  */
nuclear@26: 
nuclear@26: /* this is not a core library module, so it doesn't define JPEG_INTERNALS */
nuclear@26: #include "jinclude.h"
nuclear@26: #include "jpeglib.h"
nuclear@26: #include "jerror.h"
nuclear@26: 
nuclear@26: 
nuclear@26: /* Expanded data source object for stdio input */
nuclear@26: 
nuclear@26: typedef struct {
nuclear@26:   struct jpeg_source_mgr pub;	/* public fields */
nuclear@26: 
nuclear@26:   FILE * infile;		/* source stream */
nuclear@26:   JOCTET * buffer;		/* start of buffer */
nuclear@26:   boolean start_of_file;	/* have we gotten any data yet? */
nuclear@26: } my_source_mgr;
nuclear@26: 
nuclear@26: typedef my_source_mgr * my_src_ptr;
nuclear@26: 
nuclear@26: #define INPUT_BUF_SIZE  4096	/* choose an efficiently fread'able size */
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * Initialize source --- called by jpeg_read_header
nuclear@26:  * before any data is actually read.
nuclear@26:  */
nuclear@26: 
nuclear@26: METHODDEF(void)
nuclear@26: init_source (j_decompress_ptr cinfo)
nuclear@26: {
nuclear@26:   my_src_ptr src = (my_src_ptr) cinfo->src;
nuclear@26: 
nuclear@26:   /* We reset the empty-input-file flag for each image,
nuclear@26:    * but we don't clear the input buffer.
nuclear@26:    * This is correct behavior for reading a series of images from one source.
nuclear@26:    */
nuclear@26:   src->start_of_file = TRUE;
nuclear@26: }
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * Fill the input buffer --- called whenever buffer is emptied.
nuclear@26:  *
nuclear@26:  * In typical applications, this should read fresh data into the buffer
nuclear@26:  * (ignoring the current state of next_input_byte & bytes_in_buffer),
nuclear@26:  * reset the pointer & count to the start of the buffer, and return TRUE
nuclear@26:  * indicating that the buffer has been reloaded.  It is not necessary to
nuclear@26:  * fill the buffer entirely, only to obtain at least one more byte.
nuclear@26:  *
nuclear@26:  * There is no such thing as an EOF return.  If the end of the file has been
nuclear@26:  * reached, the routine has a choice of ERREXIT() or inserting fake data into
nuclear@26:  * the buffer.  In most cases, generating a warning message and inserting a
nuclear@26:  * fake EOI marker is the best course of action --- this will allow the
nuclear@26:  * decompressor to output however much of the image is there.  However,
nuclear@26:  * the resulting error message is misleading if the real problem is an empty
nuclear@26:  * input file, so we handle that case specially.
nuclear@26:  *
nuclear@26:  * In applications that need to be able to suspend compression due to input
nuclear@26:  * not being available yet, a FALSE return indicates that no more data can be
nuclear@26:  * obtained right now, but more may be forthcoming later.  In this situation,
nuclear@26:  * the decompressor will return to its caller (with an indication of the
nuclear@26:  * number of scanlines it has read, if any).  The application should resume
nuclear@26:  * decompression after it has loaded more data into the input buffer.  Note
nuclear@26:  * that there are substantial restrictions on the use of suspension --- see
nuclear@26:  * the documentation.
nuclear@26:  *
nuclear@26:  * When suspending, the decompressor will back up to a convenient restart point
nuclear@26:  * (typically the start of the current MCU). next_input_byte & bytes_in_buffer
nuclear@26:  * indicate where the restart point will be if the current call returns FALSE.
nuclear@26:  * Data beyond this point must be rescanned after resumption, so move it to
nuclear@26:  * the front of the buffer rather than discarding it.
nuclear@26:  */
nuclear@26: 
nuclear@26: METHODDEF(boolean)
nuclear@26: fill_input_buffer (j_decompress_ptr cinfo)
nuclear@26: {
nuclear@26:   my_src_ptr src = (my_src_ptr) cinfo->src;
nuclear@26:   size_t nbytes;
nuclear@26: 
nuclear@26:   nbytes = JFREAD(src->infile, src->buffer, INPUT_BUF_SIZE);
nuclear@26: 
nuclear@26:   if (nbytes <= 0) {
nuclear@26:     if (src->start_of_file)	/* Treat empty input file as fatal error */
nuclear@26:       ERREXIT(cinfo, JERR_INPUT_EMPTY);
nuclear@26:     WARNMS(cinfo, JWRN_JPEG_EOF);
nuclear@26:     /* Insert a fake EOI marker */
nuclear@26:     src->buffer[0] = (JOCTET) 0xFF;
nuclear@26:     src->buffer[1] = (JOCTET) JPEG_EOI;
nuclear@26:     nbytes = 2;
nuclear@26:   }
nuclear@26: 
nuclear@26:   src->pub.next_input_byte = src->buffer;
nuclear@26:   src->pub.bytes_in_buffer = nbytes;
nuclear@26:   src->start_of_file = FALSE;
nuclear@26: 
nuclear@26:   return TRUE;
nuclear@26: }
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * Skip data --- used to skip over a potentially large amount of
nuclear@26:  * uninteresting data (such as an APPn marker).
nuclear@26:  *
nuclear@26:  * Writers of suspendable-input applications must note that skip_input_data
nuclear@26:  * is not granted the right to give a suspension return.  If the skip extends
nuclear@26:  * beyond the data currently in the buffer, the buffer can be marked empty so
nuclear@26:  * that the next read will cause a fill_input_buffer call that can suspend.
nuclear@26:  * Arranging for additional bytes to be discarded before reloading the input
nuclear@26:  * buffer is the application writer's problem.
nuclear@26:  */
nuclear@26: 
nuclear@26: METHODDEF(void)
nuclear@26: skip_input_data (j_decompress_ptr cinfo, long num_bytes)
nuclear@26: {
nuclear@26:   my_src_ptr src = (my_src_ptr) cinfo->src;
nuclear@26: 
nuclear@26:   /* Just a dumb implementation for now.  Could use fseek() except
nuclear@26:    * it doesn't work on pipes.  Not clear that being smart is worth
nuclear@26:    * any trouble anyway --- large skips are infrequent.
nuclear@26:    */
nuclear@26:   if (num_bytes > 0) {
nuclear@26:     while (num_bytes > (long) src->pub.bytes_in_buffer) {
nuclear@26:       num_bytes -= (long) src->pub.bytes_in_buffer;
nuclear@26:       (void) fill_input_buffer(cinfo);
nuclear@26:       /* note we assume that fill_input_buffer will never return FALSE,
nuclear@26:        * so suspension need not be handled.
nuclear@26:        */
nuclear@26:     }
nuclear@26:     src->pub.next_input_byte += (size_t) num_bytes;
nuclear@26:     src->pub.bytes_in_buffer -= (size_t) num_bytes;
nuclear@26:   }
nuclear@26: }
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * An additional method that can be provided by data source modules is the
nuclear@26:  * resync_to_restart method for error recovery in the presence of RST markers.
nuclear@26:  * For the moment, this source module just uses the default resync method
nuclear@26:  * provided by the JPEG library.  That method assumes that no backtracking
nuclear@26:  * is possible.
nuclear@26:  */
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * Terminate source --- called by jpeg_finish_decompress
nuclear@26:  * after all data has been read.  Often a no-op.
nuclear@26:  *
nuclear@26:  * NB: *not* called by jpeg_abort or jpeg_destroy; surrounding
nuclear@26:  * application must deal with any cleanup that should happen even
nuclear@26:  * for error exit.
nuclear@26:  */
nuclear@26: 
nuclear@26: METHODDEF(void)
nuclear@26: term_source (j_decompress_ptr cinfo)
nuclear@26: {
nuclear@26:   /* no work necessary here */
nuclear@26: }
nuclear@26: 
nuclear@26: 
nuclear@26: /*
nuclear@26:  * Prepare for input from a stdio stream.
nuclear@26:  * The caller must have already opened the stream, and is responsible
nuclear@26:  * for closing it after finishing decompression.
nuclear@26:  */
nuclear@26: 
nuclear@26: GLOBAL(void)
nuclear@26: jpeg_stdio_src (j_decompress_ptr cinfo, FILE * infile)
nuclear@26: {
nuclear@26:   my_src_ptr src;
nuclear@26: 
nuclear@26:   /* The source object and input buffer are made permanent so that a series
nuclear@26:    * of JPEG images can be read from the same file by calling jpeg_stdio_src
nuclear@26:    * only before the first one.  (If we discarded the buffer at the end of
nuclear@26:    * one image, we'd likely lose the start of the next one.)
nuclear@26:    * This makes it unsafe to use this manager and a different source
nuclear@26:    * manager serially with the same JPEG object.  Caveat programmer.
nuclear@26:    */
nuclear@26:   if (cinfo->src == NULL) {	/* first time for this JPEG object? */
nuclear@26:     cinfo->src = (struct jpeg_source_mgr *)
nuclear@26:       (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
nuclear@26: 				  SIZEOF(my_source_mgr));
nuclear@26:     src = (my_src_ptr) cinfo->src;
nuclear@26:     src->buffer = (JOCTET *)
nuclear@26:       (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
nuclear@26: 				  INPUT_BUF_SIZE * SIZEOF(JOCTET));
nuclear@26:   }
nuclear@26: 
nuclear@26:   src = (my_src_ptr) cinfo->src;
nuclear@26:   src->pub.init_source = init_source;
nuclear@26:   src->pub.fill_input_buffer = fill_input_buffer;
nuclear@26:   src->pub.skip_input_data = skip_input_data;
nuclear@26:   src->pub.resync_to_restart = jpeg_resync_to_restart; /* use default method */
nuclear@26:   src->pub.term_source = term_source;
nuclear@26:   src->infile = infile;
nuclear@26:   src->pub.bytes_in_buffer = 0; /* forces fill_input_buffer on first read */
nuclear@26:   src->pub.next_input_byte = NULL; /* until buffer loaded */
nuclear@26: }