nuclear@14: /*
nuclear@14:  * jdapistd.c
nuclear@14:  *
nuclear@14:  * Copyright (C) 1994-1996, Thomas G. Lane.
nuclear@14:  * This file is part of the Independent JPEG Group's software.
nuclear@14:  * For conditions of distribution and use, see the accompanying README file.
nuclear@14:  *
nuclear@14:  * This file contains application interface code for the decompression half
nuclear@14:  * of the JPEG library.  These are the "standard" API routines that are
nuclear@14:  * used in the normal full-decompression case.  They are not used by a
nuclear@14:  * transcoding-only application.  Note that if an application links in
nuclear@14:  * jpeg_start_decompress, it will end up linking in the entire decompressor.
nuclear@14:  * We thus must separate this file from jdapimin.c to avoid linking the
nuclear@14:  * whole decompression library into a transcoder.
nuclear@14:  */
nuclear@14: 
nuclear@14: #define JPEG_INTERNALS
nuclear@14: #include "jinclude.h"
nuclear@14: #include "jpeglib.h"
nuclear@14: 
nuclear@14: 
nuclear@14: /* Forward declarations */
nuclear@14: LOCAL(boolean) output_pass_setup JPP((j_decompress_ptr cinfo));
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Decompression initialization.
nuclear@14:  * jpeg_read_header must be completed before calling this.
nuclear@14:  *
nuclear@14:  * If a multipass operating mode was selected, this will do all but the
nuclear@14:  * last pass, and thus may take a great deal of time.
nuclear@14:  *
nuclear@14:  * Returns FALSE if suspended.  The return value need be inspected only if
nuclear@14:  * a suspending data source is used.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(boolean)
nuclear@14: jpeg_start_decompress (j_decompress_ptr cinfo)
nuclear@14: {
nuclear@14:   if (cinfo->global_state == DSTATE_READY) {
nuclear@14:     /* First call: initialize master control, select active modules */
nuclear@14:     jinit_master_decompress(cinfo);
nuclear@14:     if (cinfo->buffered_image) {
nuclear@14:       /* No more work here; expecting jpeg_start_output next */
nuclear@14:       cinfo->global_state = DSTATE_BUFIMAGE;
nuclear@14:       return TRUE;
nuclear@14:     }
nuclear@14:     cinfo->global_state = DSTATE_PRELOAD;
nuclear@14:   }
nuclear@14:   if (cinfo->global_state == DSTATE_PRELOAD) {
nuclear@14:     /* If file has multiple scans, absorb them all into the coef buffer */
nuclear@14:     if (cinfo->inputctl->has_multiple_scans) {
nuclear@14: #ifdef D_MULTISCAN_FILES_SUPPORTED
nuclear@14:       for (;;) {
nuclear@14: 	int retcode;
nuclear@14: 	/* Call progress monitor hook if present */
nuclear@14: 	if (cinfo->progress != NULL)
nuclear@14: 	  (*cinfo->progress->progress_monitor) ((j_common_ptr) cinfo);
nuclear@14: 	/* Absorb some more input */
nuclear@14: 	retcode = (*cinfo->inputctl->consume_input) (cinfo);
nuclear@14: 	if (retcode == JPEG_SUSPENDED)
nuclear@14: 	  return FALSE;
nuclear@14: 	if (retcode == JPEG_REACHED_EOI)
nuclear@14: 	  break;
nuclear@14: 	/* Advance progress counter if appropriate */
nuclear@14: 	if (cinfo->progress != NULL &&
nuclear@14: 	    (retcode == JPEG_ROW_COMPLETED || retcode == JPEG_REACHED_SOS)) {
nuclear@14: 	  if (++cinfo->progress->pass_counter >= cinfo->progress->pass_limit) {
nuclear@14: 	    /* jdmaster underestimated number of scans; ratchet up one scan */
nuclear@14: 	    cinfo->progress->pass_limit += (long) cinfo->total_iMCU_rows;
nuclear@14: 	  }
nuclear@14: 	}
nuclear@14:       }
nuclear@14: #else
nuclear@14:       ERREXIT(cinfo, JERR_NOT_COMPILED);
nuclear@14: #endif /* D_MULTISCAN_FILES_SUPPORTED */
nuclear@14:     }
nuclear@14:     cinfo->output_scan_number = cinfo->input_scan_number;
nuclear@14:   } else if (cinfo->global_state != DSTATE_PRESCAN)
nuclear@14:     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
nuclear@14:   /* Perform any dummy output passes, and set up for the final pass */
nuclear@14:   return output_pass_setup(cinfo);
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Set up for an output pass, and perform any dummy pass(es) needed.
nuclear@14:  * Common subroutine for jpeg_start_decompress and jpeg_start_output.
nuclear@14:  * Entry: global_state = DSTATE_PRESCAN only if previously suspended.
nuclear@14:  * Exit: If done, returns TRUE and sets global_state for proper output mode.
nuclear@14:  *       If suspended, returns FALSE and sets global_state = DSTATE_PRESCAN.
nuclear@14:  */
nuclear@14: 
nuclear@14: LOCAL(boolean)
nuclear@14: output_pass_setup (j_decompress_ptr cinfo)
nuclear@14: {
nuclear@14:   if (cinfo->global_state != DSTATE_PRESCAN) {
nuclear@14:     /* First call: do pass setup */
nuclear@14:     (*cinfo->master->prepare_for_output_pass) (cinfo);
nuclear@14:     cinfo->output_scanline = 0;
nuclear@14:     cinfo->global_state = DSTATE_PRESCAN;
nuclear@14:   }
nuclear@14:   /* Loop over any required dummy passes */
nuclear@14:   while (cinfo->master->is_dummy_pass) {
nuclear@14: #ifdef QUANT_2PASS_SUPPORTED
nuclear@14:     /* Crank through the dummy pass */
nuclear@14:     while (cinfo->output_scanline < cinfo->output_height) {
nuclear@14:       JDIMENSION last_scanline;
nuclear@14:       /* Call progress monitor hook if present */
nuclear@14:       if (cinfo->progress != NULL) {
nuclear@14: 	cinfo->progress->pass_counter = (long) cinfo->output_scanline;
nuclear@14: 	cinfo->progress->pass_limit = (long) cinfo->output_height;
nuclear@14: 	(*cinfo->progress->progress_monitor) ((j_common_ptr) cinfo);
nuclear@14:       }
nuclear@14:       /* Process some data */
nuclear@14:       last_scanline = cinfo->output_scanline;
nuclear@14:       (*cinfo->main->process_data) (cinfo, (JSAMPARRAY) NULL,
nuclear@14: 				    &cinfo->output_scanline, (JDIMENSION) 0);
nuclear@14:       if (cinfo->output_scanline == last_scanline)
nuclear@14: 	return FALSE;		/* No progress made, must suspend */
nuclear@14:     }
nuclear@14:     /* Finish up dummy pass, and set up for another one */
nuclear@14:     (*cinfo->master->finish_output_pass) (cinfo);
nuclear@14:     (*cinfo->master->prepare_for_output_pass) (cinfo);
nuclear@14:     cinfo->output_scanline = 0;
nuclear@14: #else
nuclear@14:     ERREXIT(cinfo, JERR_NOT_COMPILED);
nuclear@14: #endif /* QUANT_2PASS_SUPPORTED */
nuclear@14:   }
nuclear@14:   /* Ready for application to drive output pass through
nuclear@14:    * jpeg_read_scanlines or jpeg_read_raw_data.
nuclear@14:    */
nuclear@14:   cinfo->global_state = cinfo->raw_data_out ? DSTATE_RAW_OK : DSTATE_SCANNING;
nuclear@14:   return TRUE;
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Read some scanlines of data from the JPEG decompressor.
nuclear@14:  *
nuclear@14:  * The return value will be the number of lines actually read.
nuclear@14:  * This may be less than the number requested in several cases,
nuclear@14:  * including bottom of image, data source suspension, and operating
nuclear@14:  * modes that emit multiple scanlines at a time.
nuclear@14:  *
nuclear@14:  * Note: we warn about excess calls to jpeg_read_scanlines() since
nuclear@14:  * this likely signals an application programmer error.  However,
nuclear@14:  * an oversize buffer (max_lines > scanlines remaining) is not an error.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(JDIMENSION)
nuclear@14: jpeg_read_scanlines (j_decompress_ptr cinfo, JSAMPARRAY scanlines,
nuclear@14: 		     JDIMENSION max_lines)
nuclear@14: {
nuclear@14:   JDIMENSION row_ctr;
nuclear@14: 
nuclear@14:   if (cinfo->global_state != DSTATE_SCANNING)
nuclear@14:     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
nuclear@14:   if (cinfo->output_scanline >= cinfo->output_height) {
nuclear@14:     WARNMS(cinfo, JWRN_TOO_MUCH_DATA);
nuclear@14:     return 0;
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Call progress monitor hook if present */
nuclear@14:   if (cinfo->progress != NULL) {
nuclear@14:     cinfo->progress->pass_counter = (long) cinfo->output_scanline;
nuclear@14:     cinfo->progress->pass_limit = (long) cinfo->output_height;
nuclear@14:     (*cinfo->progress->progress_monitor) ((j_common_ptr) cinfo);
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Process some data */
nuclear@14:   row_ctr = 0;
nuclear@14:   (*cinfo->main->process_data) (cinfo, scanlines, &row_ctr, max_lines);
nuclear@14:   cinfo->output_scanline += row_ctr;
nuclear@14:   return row_ctr;
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Alternate entry point to read raw data.
nuclear@14:  * Processes exactly one iMCU row per call, unless suspended.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(JDIMENSION)
nuclear@14: jpeg_read_raw_data (j_decompress_ptr cinfo, JSAMPIMAGE data,
nuclear@14: 		    JDIMENSION max_lines)
nuclear@14: {
nuclear@14:   JDIMENSION lines_per_iMCU_row;
nuclear@14: 
nuclear@14:   if (cinfo->global_state != DSTATE_RAW_OK)
nuclear@14:     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
nuclear@14:   if (cinfo->output_scanline >= cinfo->output_height) {
nuclear@14:     WARNMS(cinfo, JWRN_TOO_MUCH_DATA);
nuclear@14:     return 0;
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Call progress monitor hook if present */
nuclear@14:   if (cinfo->progress != NULL) {
nuclear@14:     cinfo->progress->pass_counter = (long) cinfo->output_scanline;
nuclear@14:     cinfo->progress->pass_limit = (long) cinfo->output_height;
nuclear@14:     (*cinfo->progress->progress_monitor) ((j_common_ptr) cinfo);
nuclear@14:   }
nuclear@14: 
nuclear@14:   /* Verify that at least one iMCU row can be returned. */
nuclear@14:   lines_per_iMCU_row = cinfo->max_v_samp_factor * cinfo->min_DCT_scaled_size;
nuclear@14:   if (max_lines < lines_per_iMCU_row)
nuclear@14:     ERREXIT(cinfo, JERR_BUFFER_SIZE);
nuclear@14: 
nuclear@14:   /* Decompress directly into user's buffer. */
nuclear@14:   if (! (*cinfo->coef->decompress_data) (cinfo, data))
nuclear@14:     return 0;			/* suspension forced, can do nothing more */
nuclear@14: 
nuclear@14:   /* OK, we processed one iMCU row. */
nuclear@14:   cinfo->output_scanline += lines_per_iMCU_row;
nuclear@14:   return lines_per_iMCU_row;
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /* Additional entry points for buffered-image mode. */
nuclear@14: 
nuclear@14: #ifdef D_MULTISCAN_FILES_SUPPORTED
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Initialize for an output pass in buffered-image mode.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(boolean)
nuclear@14: jpeg_start_output (j_decompress_ptr cinfo, int scan_number)
nuclear@14: {
nuclear@14:   if (cinfo->global_state != DSTATE_BUFIMAGE &&
nuclear@14:       cinfo->global_state != DSTATE_PRESCAN)
nuclear@14:     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
nuclear@14:   /* Limit scan number to valid range */
nuclear@14:   if (scan_number <= 0)
nuclear@14:     scan_number = 1;
nuclear@14:   if (cinfo->inputctl->eoi_reached &&
nuclear@14:       scan_number > cinfo->input_scan_number)
nuclear@14:     scan_number = cinfo->input_scan_number;
nuclear@14:   cinfo->output_scan_number = scan_number;
nuclear@14:   /* Perform any dummy output passes, and set up for the real pass */
nuclear@14:   return output_pass_setup(cinfo);
nuclear@14: }
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Finish up after an output pass in buffered-image mode.
nuclear@14:  *
nuclear@14:  * Returns FALSE if suspended.  The return value need be inspected only if
nuclear@14:  * a suspending data source is used.
nuclear@14:  */
nuclear@14: 
nuclear@14: GLOBAL(boolean)
nuclear@14: jpeg_finish_output (j_decompress_ptr cinfo)
nuclear@14: {
nuclear@14:   if ((cinfo->global_state == DSTATE_SCANNING ||
nuclear@14:        cinfo->global_state == DSTATE_RAW_OK) && cinfo->buffered_image) {
nuclear@14:     /* Terminate this pass. */
nuclear@14:     /* We do not require the whole pass to have been completed. */
nuclear@14:     (*cinfo->master->finish_output_pass) (cinfo);
nuclear@14:     cinfo->global_state = DSTATE_BUFPOST;
nuclear@14:   } else if (cinfo->global_state != DSTATE_BUFPOST) {
nuclear@14:     /* BUFPOST = repeat call after a suspension, anything else is error */
nuclear@14:     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
nuclear@14:   }
nuclear@14:   /* Read markers looking for SOS or EOI */
nuclear@14:   while (cinfo->input_scan_number <= cinfo->output_scan_number &&
nuclear@14: 	 ! cinfo->inputctl->eoi_reached) {
nuclear@14:     if ((*cinfo->inputctl->consume_input) (cinfo) == JPEG_SUSPENDED)
nuclear@14:       return FALSE;		/* Suspend, come back later */
nuclear@14:   }
nuclear@14:   cinfo->global_state = DSTATE_BUFIMAGE;
nuclear@14:   return TRUE;
nuclear@14: }
nuclear@14: 
nuclear@14: #endif /* D_MULTISCAN_FILES_SUPPORTED */