kc3-lang/libjpeg-turbo/jcapimin.c

• Show log

  Commit

• Hash : fc01f467
  Author :
  Date : 2023-01-05T06:36:46
  

  TurboJPEG 3 API overhaul
  
  (ChangeLog update forthcoming)
  
  - Prefix all function names with "tj3" and remove version suffixes from
    function names.  (Future API overhauls will increment the prefix to
    "tj4", etc., thus retaining backward API/ABI compatibility without
    versioning each individual function.)
  
  - Replace stateless boolean flags (including TJ*FLAG_ARITHMETIC and
    TJ*FLAG_LOSSLESS, which were never released) with stateful integer
    parameters, the value of which persists between function calls.
    * Use parameters for the JPEG quality and subsampling as well, in
      order to eliminate the awkwardness of specifying function arguments
      that weren't relevant for lossless compression.
    * tj3DecompressHeader() now stores all relevant information about the
      JPEG image, including the width, height, subsampling type, entropy
      coding type, etc. in parameters rather than returning that
      information in its arguments.
    * TJ*FLAG_LIMITSCANS has been reimplemented as an integer parameter
      (TJ*PARAM_SCANLIMIT) that allows the number of scans to be
      specified.
  
  - Use the const keyword for all pointer arguments to unmodified
    buffers, as well as for both dimensions of 2D pointers.  Addresses
    #395.
  
  - Use size_t rather than unsigned long to represent buffer sizes, since
    unsigned long is a 32-bit type on Windows.  Addresses #24.
  
  - Return 0 from all buffer size functions if an error occurs, rather
    than awkwardly trying to return -1 in an unsigned data type.
  
  - Implement 12-bit and 16-bit data precision using dedicated
    compression, decompression, and image I/O functions/methods.
    * Suffix the names of all data-precision-specific functions with 8,
      12, or 16.
    * Because the YUV functions are intended to be used for video, they
      are currently only implemented with 8-bit data precision, but they
      can be expanded to 12-bit data precision in the future, if
      necessary.
    * Extend TJUnitTest and TJBench to test 12-bit and 16-bit data
      precision, using a new -precision option.
    * Add appropriate regression tests for all of the above to the 'test'
      target.
    * Extend tjbenchtest to test 12-bit and 16-bit data precision, and
      add separate 'tjtest12' and 'tjtest16' targets.
    * BufferedImage I/O in the Java API is currently limited to 8-bit
      data precision, since the BufferedImage class does not
      straightforwardly support higher data precisions.
    * Extend the PPM reader to convert 12-bit and 16-bit PBMPLUS files
      to grayscale or CMYK pixels, as it already does for 8-bit files.
  
  - Properly accommodate lossless JPEG using dedicated parameters
    (TJ*PARAM_LOSSLESS, TJ*PARAM_LOSSLESSPSV, and TJ*PARAM_LOSSLESSPT),
    rather than using a flag and awkwardly repurposing the JPEG quality.
    Update TJBench to properly reflect whether a JPEG image is lossless.
  
  - Re-organize the TJBench usage screen.
  
  - Update the Java docs using Java 11, to improve the formatting and
    eliminate HTML frames.
  
  - Use the accurate integer DCT algorithm by default for both
    compression and decompression, since the "fast" algorithm is a legacy
    feature, it does not pass the ISO compliance tests, and it is not
    actually faster on modern x86 CPUs.
    * Remove the -accuratedct option from TJBench and TJExample.
  
  - Re-implement the 'tjtest' target using a CMake script that enables
    the appropriate tests, depending on the data precision and whether or
    not the Java API is part of the build.
  
  - Consolidate the C and Java versions of tjbenchtest into one script.
  
  - Consolidate the C and Java versions of tjexampletest into one script.
  
  - Combine all initialization functions into a single function
    (tj3Init()) that accepts an integer parameter specifying the
    subsystems to initialize.
  
  - Enable decompression scaling explicitly, using a new function/method
    (tj3SetScalingFactor()/TJDecompressor.setScalingFactor()), rather
    than implicitly using awkward "desired width"/"desired height"
    parameters.
  
  - Introduce a new macro/constant (TJUNSCALED/TJ.UNSCALED) that maps to
    a scaling factor of 1/1.
  
  - Implement partial image decompression, using a new function/method
    (tj3SetCroppingRegion()/TJDecompressor.setCroppingRegion()) and
    TJBench option (-crop).  Extend tjbenchtest to test the new feature.
    Addresses #1.
  
  - Allow the JPEG colorspace to be specified explicitly when
    compressing, using a new parameter (TJ*PARAM_COLORSPACE).  This
    allows JPEG images with the RGB and CMYK colorspaces to be created.
  
  - Remove the error/difference image feature from TJBench.  Identical
    images to the ones that TJBench created can be generated using
    ImageMagick with
    'magick composite <original_image> <output_image> -compose difference <diff_image>'
  
  - Handle JPEG images with unknown subsampling types.  TJ*PARAM_SUBSAMP
    is set to TJ*SAMP_UNKNOWN (== -1) for such images, but they can still
    be decompressed fully into packed-pixel images or losslessly
    transformed (with the exception of lossless cropping.)  They cannot
    be partially decompressed or decompressed into planar YUV images.
    Note also that TJBench, due to its lack of support for imperfect
    transforms, requires that the subsampling type be known when
    rotating, flipping, or transversely transposing an image.  Addresses
    #436
  
  - The Java version of TJBench now has identical functionality to the C
    version.  This was accomplished by (somewhat hackishly) calling the
    TurboJPEG C image I/O functions through JNI and copying the pixels
    between the C heap and the Java heap.
  
  - Add parameters (TJ*PARAM_RESTARTROWS and TJ*PARAM_RESTARTBLOCKS) and
    a TJBench option (-restart) to allow the restart marker interval to
    be specified when compressing.  Eliminate the undocumented TJ_RESTART
    environment variable.
  
  - Add a parameter (TJ*PARAM_OPTIMIZE), a transform option
    (TJ*OPT_OPTIMIZE), and a TJBench option (-optimize) to allow
    optimized baseline Huffman coding to be specified when compressing.
    Eliminate the undocumented TJ_OPTIMIZE environment variable.
  
  - Add parameters (TJ*PARAM_XDENSITY, TJ*PARAM_DENSITY, and
    TJ*DENSITYUNITS) to allow the pixel density to be specified when
    compressing or saving a Windows BMP image and to be queried when
    decompressing or loading a Windows BMP image.  Addresses #77.
  
  - Refactor the fuzz targets to use the new API.
    * Extend decompression coverage to 12-bit and 16-bit data precision.
    * Replace the awkward cjpeg12 and cjpeg16 targets with proper
      TurboJPEG-based compress12, compress12-lossless, and
      compress16-lossless targets
  
  - Fix innocuous UBSan warnings uncovered by the new fuzzers.
  
  - Implement previous versions of the TurboJPEG API by wrapping the new
    functions (tested by running the 2.1.x versions of TJBench, via
    tjbenchtest, and TJUnitTest against the new implementation.)
    * Remove all JNI functions for deprecated Java methods and implement
      the deprecated methods using pure Java wrappers.  It should be
      understood that backward API compatibility in Java applies only to
      the Java classes and that one cannot mix and match a JAR file from
      one version of libjpeg-turbo with a JNI library from another
      version.
  
  - tj3Destroy() now silently accepts a NULL handle.
  
  - tj3Alloc() and tj3Free() now return/accept void pointers, as malloc()
    and free() do.
  
  - The image I/O functions now accept a TurboJPEG instance handle, which
    is used to transmit/receive parameters and to receive error
    information.
  
  Closes #517
  

Download

• jcapimin.c

• /*
   * jcapimin.c
   *
   * This file was part of the Independent JPEG Group's software:
   * Copyright (C) 1994-1998, Thomas G. Lane.
   * Modified 2003-2010 by Guido Vollbeding.
   * libjpeg-turbo Modifications:
   * Copyright (C) 2022-2023, D. R. Commander.
   * For conditions of distribution and use, see the accompanying README.ijg
   * file.
   *
   * This file contains application interface code for the compression half
   * of the JPEG library.  These are the "minimum" API routines that may be
   * needed in either the normal full-compression case or the transcoding-only
   * case.
   *
   * Most of the routines intended to be called directly by an application
   * are in this file or in jcapistd.c.  But also see jcparam.c for
   * parameter-setup helper routines, jcomapi.c for routines shared by
   * compression and decompression, and jctrans.c for the transcoding case.
   */
  
  #define JPEG_INTERNALS
  #include "jinclude.h"
  #include "jpeglib.h"
  #include "jcmaster.h"
  
  
  /*
   * Initialization of a JPEG compression object.
   * The error manager must already be set up (in case memory manager fails).
   */
  
  GLOBAL(void)
  jpeg_CreateCompress(j_compress_ptr cinfo, int version, size_t structsize)
  {
    int i;
  
    /* Guard against version mismatches between library and caller. */
    cinfo->mem = NULL;            /* so jpeg_destroy knows mem mgr not called */
    if (version != JPEG_LIB_VERSION)
      ERREXIT2(cinfo, JERR_BAD_LIB_VERSION, JPEG_LIB_VERSION, version);
    if (structsize != sizeof(struct jpeg_compress_struct))
      ERREXIT2(cinfo, JERR_BAD_STRUCT_SIZE,
               (int)sizeof(struct jpeg_compress_struct), (int)structsize);
  
    /* For debugging purposes, we zero the whole master structure.
     * But the application has already set the err pointer, and may have set
     * client_data, so we have to save and restore those fields.
     * Note: if application hasn't set client_data, tools like Purify may
     * complain here.
     */
    {
      struct jpeg_error_mgr *err = cinfo->err;
      void *client_data = cinfo->client_data; /* ignore Purify complaint here */
      memset(cinfo, 0, sizeof(struct jpeg_compress_struct));
      cinfo->err = err;
      cinfo->client_data = client_data;
    }
    cinfo->is_decompressor = FALSE;
  
    /* Initialize a memory manager instance for this object */
    jinit_memory_mgr((j_common_ptr)cinfo);
  
    /* Zero out pointers to permanent structures. */
    cinfo->progress = NULL;
    cinfo->dest = NULL;
  
    cinfo->comp_info = NULL;
  
    for (i = 0; i < NUM_QUANT_TBLS; i++) {
      cinfo->quant_tbl_ptrs[i] = NULL;
  #if JPEG_LIB_VERSION >= 70
      cinfo->q_scale_factor[i] = 100;
  #endif
    }
  
    for (i = 0; i < NUM_HUFF_TBLS; i++) {
      cinfo->dc_huff_tbl_ptrs[i] = NULL;
      cinfo->ac_huff_tbl_ptrs[i] = NULL;
    }
  
  #if JPEG_LIB_VERSION >= 80
    /* Must do it here for emit_dqt in case jpeg_write_tables is used */
    cinfo->block_size = DCTSIZE;
    cinfo->natural_order = jpeg_natural_order;
    cinfo->lim_Se = DCTSIZE2 - 1;
  #endif
  
    cinfo->script_space = NULL;
  
    cinfo->input_gamma = 1.0;     /* in case application forgets */
  
    cinfo->data_precision = BITS_IN_JSAMPLE;
  
    /* OK, I'm ready */
    cinfo->global_state = CSTATE_START;
  
    /* The master struct is used to store extension parameters, so we allocate it
     * here.
     */
    cinfo->master = (struct jpeg_comp_master *)
        (*cinfo->mem->alloc_small) ((j_common_ptr)cinfo, JPOOL_PERMANENT,
                                    sizeof(my_comp_master));
    memset(cinfo->master, 0, sizeof(my_comp_master));
  }
  
  
  /*
   * Destruction of a JPEG compression object
   */
  
  GLOBAL(void)
  jpeg_destroy_compress(j_compress_ptr cinfo)
  {
    jpeg_destroy((j_common_ptr)cinfo); /* use common routine */
  }
  
  
  /*
   * Abort processing of a JPEG compression operation,
   * but don't destroy the object itself.
   */
  
  GLOBAL(void)
  jpeg_abort_compress(j_compress_ptr cinfo)
  {
    jpeg_abort((j_common_ptr)cinfo); /* use common routine */
  }
  
  
  /*
   * Forcibly suppress or un-suppress all quantization and Huffman tables.
   * Marks all currently defined tables as already written (if suppress)
   * or not written (if !suppress).  This will control whether they get emitted
   * by a subsequent jpeg_start_compress call.
   *
   * This routine is exported for use by applications that want to produce
   * abbreviated JPEG datastreams.  It logically belongs in jcparam.c, but
   * since it is called by jpeg_start_compress, we put it here --- otherwise
   * jcparam.o would be linked whether the application used it or not.
   */
  
  GLOBAL(void)
  jpeg_suppress_tables(j_compress_ptr cinfo, boolean suppress)
  {
    int i;
    JQUANT_TBL *qtbl;
    JHUFF_TBL *htbl;
  
    for (i = 0; i < NUM_QUANT_TBLS; i++) {
      if ((qtbl = cinfo->quant_tbl_ptrs[i]) != NULL)
        qtbl->sent_table = suppress;
    }
  
    for (i = 0; i < NUM_HUFF_TBLS; i++) {
      if ((htbl = cinfo->dc_huff_tbl_ptrs[i]) != NULL)
        htbl->sent_table = suppress;
      if ((htbl = cinfo->ac_huff_tbl_ptrs[i]) != NULL)
        htbl->sent_table = suppress;
    }
  }
  
  
  /*
   * Finish JPEG compression.
   *
   * If a multipass operating mode was selected, this may do a great deal of
   * work including most of the actual output.
   */
  
  GLOBAL(void)
  jpeg_finish_compress(j_compress_ptr cinfo)
  {
    JDIMENSION iMCU_row;
  
    if (cinfo->global_state == CSTATE_SCANNING ||
        cinfo->global_state == CSTATE_RAW_OK) {
      /* Terminate first pass */
      if (cinfo->next_scanline < cinfo->image_height)
        ERREXIT(cinfo, JERR_TOO_LITTLE_DATA);
      (*cinfo->master->finish_pass) (cinfo);
    } else if (cinfo->global_state != CSTATE_WRCOEFS)
      ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
    /* Perform any remaining passes */
    while (!cinfo->master->is_last_pass) {
      (*cinfo->master->prepare_for_pass) (cinfo);
      for (iMCU_row = 0; iMCU_row < cinfo->total_iMCU_rows; iMCU_row++) {
        if (cinfo->progress != NULL) {
          cinfo->progress->pass_counter = (long)iMCU_row;
          cinfo->progress->pass_limit = (long)cinfo->total_iMCU_rows;
          (*cinfo->progress->progress_monitor) ((j_common_ptr)cinfo);
        }
        /* We bypass the main controller and invoke coef controller directly;
         * all work is being done from the coefficient buffer.
         */
        if (cinfo->data_precision == 16) {
  #ifdef C_LOSSLESS_SUPPORTED
          if (!(*cinfo->coef->compress_data_16) (cinfo, (J16SAMPIMAGE)NULL))
            ERREXIT(cinfo, JERR_CANT_SUSPEND);
  #else
          ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
  #endif
        } else if (cinfo->data_precision == 12) {
          if (!(*cinfo->coef->compress_data_12) (cinfo, (J12SAMPIMAGE)NULL))
            ERREXIT(cinfo, JERR_CANT_SUSPEND);
        } else {
          if (!(*cinfo->coef->compress_data) (cinfo, (JSAMPIMAGE)NULL))
            ERREXIT(cinfo, JERR_CANT_SUSPEND);
        }
      }
      (*cinfo->master->finish_pass) (cinfo);
    }
    /* Write EOI, do final cleanup */
    (*cinfo->marker->write_file_trailer) (cinfo);
    (*cinfo->dest->term_destination) (cinfo);
    /* We can use jpeg_abort to release memory and reset global_state */
    jpeg_abort((j_common_ptr)cinfo);
  }
  
  
  /*
   * Write a special marker.
   * This is only recommended for writing COM or APPn markers.
   * Must be called after jpeg_start_compress() and before
   * first call to jpeg_write_scanlines() or jpeg_write_raw_data().
   */
  
  GLOBAL(void)
  jpeg_write_marker(j_compress_ptr cinfo, int marker, const JOCTET *dataptr,
                    unsigned int datalen)
  {
    void (*write_marker_byte) (j_compress_ptr info, int val);
  
    if (cinfo->next_scanline != 0 ||
        (cinfo->global_state != CSTATE_SCANNING &&
         cinfo->global_state != CSTATE_RAW_OK &&
         cinfo->global_state != CSTATE_WRCOEFS))
      ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  
    (*cinfo->marker->write_marker_header) (cinfo, marker, datalen);
    write_marker_byte = cinfo->marker->write_marker_byte; /* copy for speed */
    do {
      (*write_marker_byte) (cinfo, *dataptr);
      dataptr++;
    }
    while (--datalen);
  }
  
  /* Same, but piecemeal. */
  
  GLOBAL(void)
  jpeg_write_m_header(j_compress_ptr cinfo, int marker, unsigned int datalen)
  {
    if (cinfo->next_scanline != 0 ||
        (cinfo->global_state != CSTATE_SCANNING &&
         cinfo->global_state != CSTATE_RAW_OK &&
         cinfo->global_state != CSTATE_WRCOEFS))
      ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  
    (*cinfo->marker->write_marker_header) (cinfo, marker, datalen);
  }
  
  GLOBAL(void)
  jpeg_write_m_byte(j_compress_ptr cinfo, int val)
  {
    (*cinfo->marker->write_marker_byte) (cinfo, val);
  }
  
  
  /*
   * Alternate compression function: just write an abbreviated table file.
   * Before calling this, all parameters and a data destination must be set up.
   *
   * To produce a pair of files containing abbreviated tables and abbreviated
   * image data, one would proceed as follows:
   *
   *              initialize JPEG object
   *              set JPEG parameters
   *              set destination to table file
   *              jpeg_write_tables(cinfo);
   *              set destination to image file
   *              jpeg_start_compress(cinfo, FALSE);
   *              write data...
   *              jpeg_finish_compress(cinfo);
   *
   * jpeg_write_tables has the side effect of marking all tables written
   * (same as jpeg_suppress_tables(..., TRUE)).  Thus a subsequent start_compress
   * will not re-emit the tables unless it is passed write_all_tables=TRUE.
   */
  
  GLOBAL(void)
  jpeg_write_tables(j_compress_ptr cinfo)
  {
    if (cinfo->global_state != CSTATE_START)
      ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
  
    /* (Re)initialize error mgr and destination modules */
    (*cinfo->err->reset_error_mgr) ((j_common_ptr)cinfo);
    (*cinfo->dest->init_destination) (cinfo);
    /* Initialize the marker writer ... bit of a crock to do it here. */
    jinit_marker_writer(cinfo);
    /* Write them tables! */
    (*cinfo->marker->write_tables_only) (cinfo);
    /* And clean up. */
    (*cinfo->dest->term_destination) (cinfo);
    /*
     * In library releases up through v6a, we called jpeg_abort() here to free
     * any working memory allocated by the destination manager and marker
     * writer.  Some applications had a problem with that: they allocated space
     * of their own from the library memory manager, and didn't want it to go
     * away during write_tables.  So now we do nothing.  This will cause a
     * memory leak if an app calls write_tables repeatedly without doing a full
     * compression cycle or otherwise resetting the JPEG object.  However, that
     * seems less bad than unexpectedly freeing memory in the normal case.
     * An app that prefers the old behavior can call jpeg_abort for itself after
     * each call to jpeg_write_tables().
     */
  }
  

Download