home *** CD-ROM | disk | FTP | other *** search
/ PC World Plus! (NZ) 2001 June / HDC50.iso / Info / Extras / Jpeg / SRC / JDAPIMIN.C < prev    next >
C/C++ Source or Header  |  1999-08-11  |  13KB  |  411 lines
  1. /*
  2.  * jdapimin.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 application interface code for the decompression half
  9.  * of the JPEG library.  These are the "minimum" API routines that may be
  10.  * needed in either the normal full-decompression case or the
  11.  * transcoding-only case.
  12.  *
  13.  * Most of the routines intended to be called directly by an application
  14.  * are in this file or in jdapistd.c.  But also see jcomapi.c for routines
  15.  * shared by compression and decompression, and jdtrans.c for the transcoding
  16.  * case.
  17.  */
  18.  
  19. #define JPEG_INTERNALS
  20. #include "jinclude.h"
  21. #include "jpeglib.h"
  22.  
  23.  
  24. /*
  25.  * Initialization of a JPEG decompression object.
  26.  * The error manager must already be set up (in case memory manager fails).
  27.  */
  28.  
  29. GLOBAL(void)
  30. jpeg_CreateDecompress (j_decompress_ptr cinfo, int version, size_t structsize)
  31. {
  32.   int i;
  33.  
  34.   /* Guard against version mismatches between library and caller. */
  35.   cinfo->mem = NULL;        /* so jpeg_destroy knows mem mgr not called */
  36.   if (version != JPEG_LIB_VERSION)
  37.     ERREXIT2(cinfo, JERR_BAD_LIB_VERSION, JPEG_LIB_VERSION, version);
  38.   if (structsize != SIZEOF(struct jpeg_decompress_struct))
  39.     ERREXIT2(cinfo, JERR_BAD_STRUCT_SIZE,
  40.          (int) SIZEOF(struct jpeg_decompress_struct), (int) structsize);
  41.  
  42.   /* For debugging purposes, zero the whole master structure.
  43.    * But error manager pointer is already there, so save and restore it.
  44.    */
  45.   {
  46.     struct jpeg_error_mgr * err = cinfo->err;
  47.     MEMZERO(cinfo, SIZEOF(struct jpeg_decompress_struct));
  48.     cinfo->err = err;
  49.   }
  50.   cinfo->is_decompressor = TRUE;
  51.  
  52.   /* Initialize a memory manager instance for this object */
  53.   jinit_memory_mgr((j_common_ptr) cinfo);
  54.  
  55.   /* Zero out pointers to permanent structures. */
  56.   cinfo->progress = NULL;
  57.   cinfo->src = NULL;
  58.  
  59.   MEMZERO(cinfo->quant_tbl_ptrs, SIZEOF(cinfo->quant_tbl_ptrs));
  60. /*  for (i = 0; i < NUM_QUANT_TBLS; i++)
  61.     cinfo->quant_tbl_ptrs[i] = NULL;
  62. */
  63.  
  64.   MEMZERO(cinfo->dc_huff_tbl_ptrs, SIZEOF(cinfo->dc_huff_tbl_ptrs));
  65.   MEMZERO(cinfo->ac_huff_tbl_ptrs, SIZEOF(cinfo->ac_huff_tbl_ptrs));
  66. /*  for (i = 0; i < NUM_HUFF_TBLS; i++) {
  67.     cinfo->dc_huff_tbl_ptrs[i] = NULL;
  68.     cinfo->ac_huff_tbl_ptrs[i] = NULL;
  69.   }
  70. */
  71.   /* Initialize marker processor so application can override methods
  72.    * for COM, APPn markers before calling jpeg_read_header.
  73.    */
  74.   jinit_marker_reader(cinfo);
  75.  
  76.   /* And initialize the overall input controller. */
  77.   jinit_input_controller(cinfo);
  78.  
  79.   /* OK, I'm ready */
  80.   cinfo->global_state = DSTATE_START;
  81. }
  82.  
  83.  
  84. /*
  85.  * Destruction of a JPEG decompression object
  86.  */
  87.  
  88. GLOBAL(void)
  89. jpeg_destroy_decompress (j_decompress_ptr cinfo)
  90. {
  91.   jpeg_destroy((j_common_ptr) cinfo); /* use common routine */
  92. }
  93.  
  94.  
  95. /*
  96.  * Abort processing of a JPEG decompression operation,
  97.  * but don't destroy the object itself.
  98.  */
  99.  
  100. GLOBAL(void)
  101. jpeg_abort_decompress (j_decompress_ptr cinfo)
  102. {
  103.   jpeg_abort((j_common_ptr) cinfo); /* use common routine */
  104. }
  105.  
  106.  
  107. /*
  108.  * Install a special processing method for COM or APPn markers.
  109.  */
  110.  
  111. GLOBAL(void)
  112. jpeg_set_marker_processor (j_decompress_ptr cinfo, int marker_code,
  113.                jpeg_marker_parser_method routine)
  114. {
  115.   if (marker_code == JPEG_COM)
  116.     cinfo->marker->process_COM = routine;
  117.   else if (marker_code >= JPEG_APP0 && marker_code <= JPEG_APP0+15)
  118.     cinfo->marker->process_APPn[marker_code-JPEG_APP0] = routine;
  119.   else
  120.     ERREXIT1(cinfo, JERR_UNKNOWN_MARKER, marker_code);
  121. }
  122.  
  123.  
  124. /*
  125.  * Set default decompression parameters.
  126.  */
  127.  
  128. LOCAL(void)
  129. default_decompress_parms (j_decompress_ptr cinfo)
  130. {
  131.   /* Guess the input colorspace, and set output colorspace accordingly. */
  132.   /* (Wish JPEG committee had provided a real way to specify this...) */
  133.   /* Note application may override our guesses. */
  134.   switch (cinfo->num_components) {
  135.   case 1:
  136.     cinfo->jpeg_color_space = JCS_GRAYSCALE;
  137.     cinfo->out_color_space = JCS_GRAYSCALE;
  138.     break;
  139.     
  140.   case 3:
  141.     if (cinfo->saw_JFIF_marker) {
  142.       cinfo->jpeg_color_space = JCS_YCbCr; /* JFIF implies YCbCr */
  143.     } else if (cinfo->saw_Adobe_marker) {
  144.       switch (cinfo->Adobe_transform) {
  145.       case 0:
  146.     cinfo->jpeg_color_space = JCS_RGB;
  147.     break;
  148.       case 1:
  149.     cinfo->jpeg_color_space = JCS_YCbCr;
  150.     break;
  151.       default:
  152.     WARNMS1(cinfo, JWRN_ADOBE_XFORM, cinfo->Adobe_transform);
  153.     cinfo->jpeg_color_space = JCS_YCbCr; /* assume it's YCbCr */
  154.     break;
  155.       }
  156.     } else {
  157.       /* Saw no special markers, try to guess from the component IDs */
  158.       int cid0 = cinfo->comp_info[0].component_id;
  159.       int cid1 = cinfo->comp_info[1].component_id;
  160.       int cid2 = cinfo->comp_info[2].component_id;
  161.  
  162.       if (cid0 == 1 && cid1 == 2 && cid2 == 3)
  163.     cinfo->jpeg_color_space = JCS_YCbCr; /* assume JFIF w/out marker */
  164.       else if (cid0 == 82 && cid1 == 71 && cid2 == 66)
  165.     cinfo->jpeg_color_space = JCS_RGB; /* ASCII 'R', 'G', 'B' */
  166.       else {
  167.     TRACEMS3(cinfo, 1, JTRC_UNKNOWN_IDS, cid0, cid1, cid2);
  168.     cinfo->jpeg_color_space = JCS_YCbCr; /* assume it's YCbCr */
  169.       }
  170.     }
  171.     /* Always guess RGB is proper output colorspace. */
  172.     cinfo->out_color_space = JCS_RGB;
  173.     break;
  174.     
  175.   case 4:
  176.     if (cinfo->saw_Adobe_marker) {
  177.       switch (cinfo->Adobe_transform) {
  178.       case 0:
  179.     cinfo->jpeg_color_space = JCS_CMYK;
  180.     break;
  181.       case 2:
  182.     cinfo->jpeg_color_space = JCS_YCCK;
  183.     break;
  184.       default:
  185.     WARNMS1(cinfo, JWRN_ADOBE_XFORM, cinfo->Adobe_transform);
  186.     cinfo->jpeg_color_space = JCS_YCCK; /* assume it's YCCK */
  187.     break;
  188.       }
  189.     } else {
  190.       /* No special markers, assume straight CMYK. */
  191.       cinfo->jpeg_color_space = JCS_CMYK;
  192.     }
  193.     cinfo->out_color_space = JCS_CMYK;
  194.     break;
  195.     
  196.   default:
  197.     cinfo->jpeg_color_space = JCS_UNKNOWN;
  198.     cinfo->out_color_space = JCS_UNKNOWN;
  199.     break;
  200.   }
  201.  
  202.   /* Set defaults for other decompression parameters. */
  203.   cinfo->scale_num = 1;        /* 1:1 scaling */
  204.   cinfo->scale_denom = 1;
  205.   cinfo->output_gamma = 1.0;
  206.   cinfo->buffered_image = FALSE;
  207.   cinfo->raw_data_out = FALSE;
  208.   cinfo->dct_method = JDCT_DEFAULT;
  209.   cinfo->do_fancy_upsampling = TRUE;
  210.   cinfo->do_block_smoothing = TRUE;
  211.   cinfo->quantize_colors = FALSE;
  212.   /* We set these in case application only sets quantize_colors. */
  213.   cinfo->dither_mode = JDITHER_FS;
  214. #ifdef QUANT_2PASS_SUPPORTED
  215.   cinfo->two_pass_quantize = TRUE;
  216. #else
  217.   cinfo->two_pass_quantize = FALSE;
  218. #endif
  219.   cinfo->desired_number_of_colors = 256;
  220.   cinfo->colormap = NULL;
  221.   /* Initialize for no mode change in buffered-image mode. */
  222.   cinfo->enable_1pass_quant = FALSE;
  223.   cinfo->enable_external_quant = FALSE;
  224.   cinfo->enable_2pass_quant = FALSE;
  225. }
  226.  
  227.  
  228. /*
  229.  * Decompression startup: read start of JPEG datastream to see what's there.
  230.  * Need only initialize JPEG object and supply a data source before calling.
  231.  *
  232.  * This routine will read as far as the first SOS marker (ie, actual start of
  233.  * compressed data), and will save all tables and parameters in the JPEG
  234.  * object.  It will also initialize the decompression parameters to default
  235.  * values, and finally return JPEG_HEADER_OK.  On return, the application may
  236.  * adjust the decompression parameters and then call jpeg_start_decompress.
  237.  * (Or, if the application only wanted to determine the image parameters,
  238.  * the data need not be decompressed.  In that case, call jpeg_abort or
  239.  * jpeg_destroy to release any temporary space.)
  240.  * If an abbreviated (tables only) datastream is presented, the routine will
  241.  * return JPEG_HEADER_TABLES_ONLY upon reaching EOI.  The application may then
  242.  * re-use the JPEG object to read the abbreviated image datastream(s).
  243.  * It is unnecessary (but OK) to call jpeg_abort in this case.
  244.  * The JPEG_SUSPENDED return code only occurs if the data source module
  245.  * requests suspension of the decompressor.  In this case the application
  246.  * should load more source data and then re-call jpeg_read_header to resume
  247.  * processing.
  248.  * If a non-suspending data source is used and require_image is TRUE, then the
  249.  * return code need not be inspected since only JPEG_HEADER_OK is possible.
  250.  *
  251.  * This routine is now just a front end to jpeg_consume_input, with some
  252.  * extra error checking.
  253.  */
  254.  
  255. GLOBAL(int)
  256. jpeg_read_header (j_decompress_ptr cinfo, boolean require_image)
  257. {
  258.   int retcode;
  259.  
  260.   if (cinfo->global_state != DSTATE_START &&
  261.       cinfo->global_state != DSTATE_INHEADER)
  262.     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  263.  
  264.   retcode = jpeg_consume_input(cinfo);
  265.  
  266.   switch (retcode) {
  267.   case JPEG_REACHED_SOS:
  268.     retcode = JPEG_HEADER_OK;
  269.     break;
  270.   case JPEG_REACHED_EOI:
  271.     if (require_image)        /* Complain if application wanted an image */
  272.       ERREXIT(cinfo, JERR_NO_IMAGE);
  273.     /* Reset to start state; it would be safer to require the application to
  274.      * call jpeg_abort, but we can't change it now for compatibility reasons.
  275.      * A side effect is to free any temporary memory (there shouldn't be any).
  276.      */
  277.     jpeg_abort((j_common_ptr) cinfo); /* sets state = DSTATE_START */
  278.     retcode = JPEG_HEADER_TABLES_ONLY;
  279.     break;
  280.   case JPEG_SUSPENDED:
  281.     /* no work */
  282.     break;
  283.   }
  284.  
  285.   return retcode;
  286. }
  287.  
  288.  
  289. /*
  290.  * Consume data in advance of what the decompressor requires.
  291.  * This can be called at any time once the decompressor object has
  292.  * been created and a data source has been set up.
  293.  *
  294.  * This routine is essentially a state machine that handles a couple
  295.  * of critical state-transition actions, namely initial setup and
  296.  * transition from header scanning to ready-for-start_decompress.
  297.  * All the actual input is done via the input controller's consume_input
  298.  * method.
  299.  */
  300.  
  301. GLOBAL(int)
  302. jpeg_consume_input (j_decompress_ptr cinfo)
  303. {
  304.   int retcode = JPEG_SUSPENDED;
  305.  
  306.   /* NB: every possible DSTATE value should be listed in this switch */
  307.   switch (cinfo->global_state) {
  308.   case DSTATE_START:
  309.     /* Start-of-datastream actions: reset appropriate modules */
  310.     (*cinfo->inputctl->reset_input_controller) (cinfo);
  311.     /* Initialize application's data source module */
  312.     (*cinfo->src->init_source) (cinfo);
  313.     cinfo->global_state = DSTATE_INHEADER;
  314.     /*FALLTHROUGH*/
  315.   case DSTATE_INHEADER:
  316.     retcode = (*cinfo->inputctl->consume_input) (cinfo);
  317.     if (retcode == JPEG_REACHED_SOS) { /* Found SOS, prepare to decompress */
  318.       /* Set up default parameters based on header data */
  319.       default_decompress_parms(cinfo);
  320.       /* Set global state: ready for start_decompress */
  321.       cinfo->global_state = DSTATE_READY;
  322.     }
  323.     break;
  324.   case DSTATE_READY:
  325.     /* Can't advance past first SOS until start_decompress is called */
  326.     retcode = JPEG_REACHED_SOS;
  327.     break;
  328.   case DSTATE_PRELOAD:
  329.   case DSTATE_PRESCAN:
  330.   case DSTATE_SCANNING:
  331.   case DSTATE_RAW_OK:
  332.   case DSTATE_BUFIMAGE:
  333.   case DSTATE_BUFPOST:
  334.   case DSTATE_STOPPING:
  335.     retcode = (*cinfo->inputctl->consume_input) (cinfo);
  336.     break;
  337.   default:
  338.     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  339.   }
  340.   return retcode;
  341. }
  342.  
  343.  
  344. /*
  345.  * Have we finished reading the input file?
  346.  */
  347.  
  348. GLOBAL(boolean)
  349. jpeg_input_complete (j_decompress_ptr cinfo)
  350. {
  351.   /* Check for valid jpeg object */
  352.   if (cinfo->global_state < DSTATE_START ||
  353.       cinfo->global_state > DSTATE_STOPPING)
  354.     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  355.   return cinfo->inputctl->eoi_reached;
  356. }
  357.  
  358.  
  359. /*
  360.  * Is there more than one scan?
  361.  */
  362.  
  363. GLOBAL(boolean)
  364. jpeg_has_multiple_scans (j_decompress_ptr cinfo)
  365. {
  366.   /* Only valid after jpeg_read_header completes */
  367.   if (cinfo->global_state < DSTATE_READY ||
  368.       cinfo->global_state > DSTATE_STOPPING)
  369.     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  370.   return cinfo->inputctl->has_multiple_scans;
  371. }
  372.  
  373.  
  374. /*
  375.  * Finish JPEG decompression.
  376.  *
  377.  * This will normally just verify the file trailer and release temp storage.
  378.  *
  379.  * Returns FALSE if suspended.  The return value need be inspected only if
  380.  * a suspending data source is used.
  381.  */
  382.  
  383. GLOBAL(boolean)
  384. jpeg_finish_decompress (j_decompress_ptr cinfo)
  385. {
  386.   if ((cinfo->global_state == DSTATE_SCANNING ||
  387.        cinfo->global_state == DSTATE_RAW_OK) && ! cinfo->buffered_image) {
  388.     /* Terminate final pass of non-buffered mode */
  389.     if (cinfo->output_scanline < cinfo->output_height)
  390.       ERREXIT(cinfo, JERR_TOO_LITTLE_DATA);
  391.     (*cinfo->master->finish_output_pass) (cinfo);
  392.     cinfo->global_state = DSTATE_STOPPING;
  393.   } else if (cinfo->global_state == DSTATE_BUFIMAGE) {
  394.     /* Finishing after a buffered-image operation */
  395.     cinfo->global_state = DSTATE_STOPPING;
  396.   } else if (cinfo->global_state != DSTATE_STOPPING) {
  397.     /* STOPPING = repeat call after a suspension, anything else is error */
  398.     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  399.   }
  400.   /* Read until EOI */
  401.   while (! cinfo->inputctl->eoi_reached) {
  402.     if ((*cinfo->inputctl->consume_input) (cinfo) == JPEG_SUSPENDED)
  403.       return FALSE;        /* Suspend, come back later */
  404.   }
  405.   /* Do final cleanup */
  406.   (*cinfo->src->term_source) (cinfo);
  407.   /* We can use jpeg_abort to release memory and reset global_state */
  408.   jpeg_abort((j_common_ptr) cinfo);
  409.   return TRUE;
  410. }
  411.