/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/* pngrtran.c - transforms the data in a row for PNG readers

 *

 * This file is available under and governed by the GNU General Public

 * License version 2 only, as published by the Free Software Foundation.

 * However, the following notice accompanied the original version of this

 * file and, per its terms, should not be removed:

 *

 * Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson

 *

 * This code is released under the libpng license.

 * For conditions of distribution and use, see the disclaimer

 * and license in png.h

 *

 * This file contains functions optionally called by an application

 * in order to tell libpng how to handle data when reading a PNG.

 * Transformations that are used in both reading and writing are

 * in pngtrans.c.

 */

#include "pngpriv.h"

#ifdef PNG_READ_SUPPORTED

/* Set the action on getting a CRC error for an ancillary or critical chunk. */

void PNGAPI

png_set_crc_action(png_structrp png_ptr, int crit_action, int ancil_action)

{

   png_debug(1, "in png_set_crc_action");

   if (png_ptr == NULL)

      return;

   /* Tell libpng how we react to CRC errors in critical chunks */

   switch (crit_action)

   {

      case PNG_CRC_NO_CHANGE:                        /* Leave setting as is */

         break;

      case PNG_CRC_WARN_USE:                               /* Warn/use data */

         png_ptr->flags &= ~PNG_FLAG_CRC_CRITICAL_MASK;

         png_ptr->flags |= PNG_FLAG_CRC_CRITICAL_USE;

         break;

      case PNG_CRC_QUIET_USE:                             /* Quiet/use data */

         png_ptr->flags &= ~PNG_FLAG_CRC_CRITICAL_MASK;

         png_ptr->flags |= PNG_FLAG_CRC_CRITICAL_USE |

                           PNG_FLAG_CRC_CRITICAL_IGNORE;

         break;

      case PNG_CRC_WARN_DISCARD:    /* Not a valid action for critical data */

         png_warning(png_ptr,

             "Can't discard critical data on CRC error");

         /* FALLTHROUGH */

      case PNG_CRC_ERROR_QUIT:                                /* Error/quit */

      case PNG_CRC_DEFAULT:

      default:

         png_ptr->flags &= ~PNG_FLAG_CRC_CRITICAL_MASK;

         break;

   }

   /* Tell libpng how we react to CRC errors in ancillary chunks */

   switch (ancil_action)

   {

      case PNG_CRC_NO_CHANGE:                       /* Leave setting as is */

         break;

      case PNG_CRC_WARN_USE:                              /* Warn/use data */

         png_ptr->flags &= ~PNG_FLAG_CRC_ANCILLARY_MASK;

         png_ptr->flags |= PNG_FLAG_CRC_ANCILLARY_USE;

         break;

      case PNG_CRC_QUIET_USE:                            /* Quiet/use data */

         png_ptr->flags &= ~PNG_FLAG_CRC_ANCILLARY_MASK;

         png_ptr->flags |= PNG_FLAG_CRC_ANCILLARY_USE |

                           PNG_FLAG_CRC_ANCILLARY_NOWARN;

         break;

      case PNG_CRC_ERROR_QUIT:                               /* Error/quit */

         png_ptr->flags &= ~PNG_FLAG_CRC_ANCILLARY_MASK;

         png_ptr->flags |= PNG_FLAG_CRC_ANCILLARY_NOWARN;

         break;

      case PNG_CRC_WARN_DISCARD:                      /* Warn/discard data */

      case PNG_CRC_DEFAULT:

      default:

         png_ptr->flags &= ~PNG_FLAG_CRC_ANCILLARY_MASK;

         break;

   }

}

#ifdef PNG_READ_TRANSFORMS_SUPPORTED

/* Is it OK to set a transformation now?  Only if png_start_read_image or

 * png_read_update_info have not been called.  It is not necessary for the IHDR

 * to have been read in all cases; the need_IHDR parameter allows for this

 * check too.

 */

static int

png_rtran_ok(png_structrp png_ptr, int need_IHDR)

{

   if (png_ptr != NULL)

   {

      if ((png_ptr->flags & PNG_FLAG_ROW_INIT) != 0)

         png_app_error(png_ptr,

             "invalid after png_start_read_image or png_read_update_info");

      else if (need_IHDR && (png_ptr->mode & PNG_HAVE_IHDR) == 0)

         png_app_error(png_ptr, "invalid before the PNG header has been read");

      else

      {

         /* Turn on failure to initialize correctly for all transforms. */

         png_ptr->flags |= PNG_FLAG_DETECT_UNINITIALIZED;

         return 1; /* Ok */

      }

   }

   return 0; /* no png_error possible! */

}

#endif

#ifdef PNG_READ_BACKGROUND_SUPPORTED

/* Handle alpha and tRNS via a background color */

void PNGFAPI

png_set_background_fixed(png_structrp png_ptr,

    png_const_color_16p background_color, int background_gamma_code,

    int need_expand, png_fixed_point background_gamma)

{

   png_debug(1, "in png_set_background_fixed");

   if (png_rtran_ok(png_ptr, 0) == 0 || background_color == NULL)

      return;

   if (background_gamma_code == PNG_BACKGROUND_GAMMA_UNKNOWN)

   {

      png_warning(png_ptr, "Application must supply a known background gamma");

      return;

   }

   png_ptr->transformations |= PNG_COMPOSE | PNG_STRIP_ALPHA;

   png_ptr->transformations &= ~PNG_ENCODE_ALPHA;

   png_ptr->flags &= ~PNG_FLAG_OPTIMIZE_ALPHA;

   png_ptr->background = *background_color;

   png_ptr->background_gamma = background_gamma;

   png_ptr->background_gamma_type = (png_byte)(background_gamma_code);

   if (need_expand != 0)

      png_ptr->transformations |= PNG_BACKGROUND_EXPAND;

   else

      png_ptr->transformations &= ~PNG_BACKGROUND_EXPAND;

}

#  ifdef PNG_FLOATING_POINT_SUPPORTED

void PNGAPI

png_set_background(png_structrp png_ptr,

    png_const_color_16p background_color, int background_gamma_code,

    int need_expand, double background_gamma)

{

   png_set_background_fixed(png_ptr, background_color, background_gamma_code,

      need_expand, png_fixed(png_ptr, background_gamma, "png_set_background"));

}

#  endif /* FLOATING_POINT */

#endif /* READ_BACKGROUND */

/* Scale 16-bit depth files to 8-bit depth.  If both of these are set then the

 * one that pngrtran does first (scale) happens.  This is necessary to allow the

 * TRANSFORM and API behavior to be somewhat consistent, and it's simpler.

 */

#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED

void PNGAPI

png_set_scale_16(png_structrp png_ptr)

{

   png_debug(1, "in png_set_scale_16");

   if (png_rtran_ok(png_ptr, 0) == 0)

      return;

   png_ptr->transformations |= PNG_SCALE_16_TO_8;

}

#endif

#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED

/* Chop 16-bit depth files to 8-bit depth */

void PNGAPI

png_set_strip_16(png_structrp png_ptr)

{

   png_debug(1, "in png_set_strip_16");

   if (png_rtran_ok(png_ptr, 0) == 0)

      return;

   png_ptr->transformations |= PNG_16_TO_8;

}

#endif

#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED

void PNGAPI

png_set_strip_alpha(png_structrp png_ptr)

{

   png_debug(1, "in png_set_strip_alpha");

   if (png_rtran_ok(png_ptr, 0) == 0)

      return;

   png_ptr->transformations |= PNG_STRIP_ALPHA;

}

#endif

#if defined(PNG_READ_ALPHA_MODE_SUPPORTED) || defined(PNG_READ_GAMMA_SUPPORTED)

static png_fixed_point

translate_gamma_flags(png_structrp png_ptr, png_fixed_point output_gamma,

    int is_screen)

{

   /* Check for flag values.  The main reason for having the old Mac value as a

    * flag is that it is pretty near impossible to work out what the correct

    * value is from Apple documentation - a working Mac system is needed to

    * discover the value!

    */

   if (output_gamma == PNG_DEFAULT_sRGB ||

      output_gamma == PNG_FP_1 / PNG_DEFAULT_sRGB)

   {

      /* If there is no sRGB support this just sets the gamma to the standard

       * sRGB value.  (This is a side effect of using this function!)

       */

#     ifdef PNG_READ_sRGB_SUPPORTED

         png_ptr->flags |= PNG_FLAG_ASSUME_sRGB;

#     else

         PNG_UNUSED(png_ptr)

#     endif

      if (is_screen != 0)

         output_gamma = PNG_GAMMA_sRGB;

      else

         output_gamma = PNG_GAMMA_sRGB_INVERSE;

   }

   else if (output_gamma == PNG_GAMMA_MAC_18 ||

      output_gamma == PNG_FP_1 / PNG_GAMMA_MAC_18)

   {

      if (is_screen != 0)

         output_gamma = PNG_GAMMA_MAC_OLD;

      else

         output_gamma = PNG_GAMMA_MAC_INVERSE;

   }

   return output_gamma;

}

#  ifdef PNG_FLOATING_POINT_SUPPORTED

static png_fixed_point

convert_gamma_value(png_structrp png_ptr, double output_gamma)

{

   /* The following silently ignores cases where fixed point (times 100,000)

    * gamma values are passed to the floating point API.  This is safe and it

    * means the fixed point constants work just fine with the floating point

    * API.  The alternative would just lead to undetected errors and spurious

    * bug reports.  Negative values fail inside the _fixed API unless they

    * correspond to the flag values.

    */

   if (output_gamma > 0 && output_gamma < 128)

      output_gamma *= PNG_FP_1;

   /* This preserves -1 and -2 exactly: */

   output_gamma = floor(output_gamma + .5);

   if (output_gamma > PNG_FP_MAX || output_gamma < PNG_FP_MIN)

      png_fixed_error(png_ptr, "gamma value");

   return (png_fixed_point)output_gamma;

}

#  endif

#endif /* READ_ALPHA_MODE || READ_GAMMA */

#ifdef PNG_READ_ALPHA_MODE_SUPPORTED

void PNGFAPI

png_set_alpha_mode_fixed(png_structrp png_ptr, int mode,

    png_fixed_point output_gamma)

{

   int compose = 0;

   png_fixed_point file_gamma;

   png_debug(1, "in png_set_alpha_mode");

   if (png_rtran_ok(png_ptr, 0) == 0)

      return;

   output_gamma = translate_gamma_flags(png_ptr, output_gamma, 1/*screen*/);

   /* Validate the value to ensure it is in a reasonable range. The value

    * is expected to be 1 or greater, but this range test allows for some

    * viewing correction values.  The intent is to weed out users of this API

    * who use the inverse of the gamma value accidentally!  Since some of these

    * values are reasonable this may have to be changed:

    *

    * 1.6.x: changed from 0.07..3 to 0.01..100 (to accommodate the optimal 16-bit

    * gamma of 36, and its reciprocal.)

    */

   if (output_gamma < 1000 || output_gamma > 10000000)

      png_error(png_ptr, "output gamma out of expected range");

   /* The default file gamma is the inverse of the output gamma; the output

    * gamma may be changed below so get the file value first:

    */

   file_gamma = png_reciprocal(output_gamma);

   /* There are really 8 possibilities here, composed of any combination

    * of:

    *

    *    premultiply the color channels

    *    do not encode non-opaque pixels

    *    encode the alpha as well as the color channels

    *

    * The differences disappear if the input/output ('screen') gamma is 1.0,

    * because then the encoding is a no-op and there is only the choice of

    * premultiplying the color channels or not.

    *

    * png_set_alpha_mode and png_set_background interact because both use

    * png_compose to do the work.  Calling both is only useful when

    * png_set_alpha_mode is used to set the default mode - PNG_ALPHA_PNG - along

    * with a default gamma value.  Otherwise PNG_COMPOSE must not be set.

    */

   switch (mode)

   {

      case PNG_ALPHA_PNG:        /* default: png standard */

         /* No compose, but it may be set by png_set_background! */

         png_ptr->transformations &= ~PNG_ENCODE_ALPHA;

         png_ptr->flags &= ~PNG_FLAG_OPTIMIZE_ALPHA;

         break;

      case PNG_ALPHA_ASSOCIATED: /* color channels premultiplied */

         compose = 1;

         png_ptr->transformations &= ~PNG_ENCODE_ALPHA;

         png_ptr->flags &= ~PNG_FLAG_OPTIMIZE_ALPHA;

         /* The output is linear: */

         output_gamma = PNG_FP_1;

         break;

      case PNG_ALPHA_OPTIMIZED:  /* associated, non-opaque pixels linear */

         compose = 1;

         png_ptr->transformations &= ~PNG_ENCODE_ALPHA;

         png_ptr->flags |= PNG_FLAG_OPTIMIZE_ALPHA;

         /* output_gamma records the encoding of opaque pixels! */

         break;

      case PNG_ALPHA_BROKEN:     /* associated, non-linear, alpha encoded */

         compose = 1;

         png_ptr->transformations |= PNG_ENCODE_ALPHA;

         png_ptr->flags &= ~PNG_FLAG_OPTIMIZE_ALPHA;

         break;

      default:

         png_error(png_ptr, "invalid alpha mode");

   }

   /* Only set the default gamma if the file gamma has not been set (this has

    * the side effect that the gamma in a second call to png_set_alpha_mode will

    * be ignored.)

    */

   if (png_ptr->colorspace.gamma == 0)

   {

      png_ptr->colorspace.gamma = file_gamma;

      png_ptr->colorspace.flags |= PNG_COLORSPACE_HAVE_GAMMA;

   }

   /* But always set the output gamma: */

   png_ptr->screen_gamma = output_gamma;

   /* Finally, if pre-multiplying, set the background fields to achieve the

    * desired result.

    */

   if (compose != 0)

   {

      /* And obtain alpha pre-multiplication by composing on black: */

      memset(&png_ptr->background, 0, (sizeof png_ptr->background));

      png_ptr->background_gamma = png_ptr->colorspace.gamma; /* just in case */

      png_ptr->background_gamma_type = PNG_BACKGROUND_GAMMA_FILE;

      png_ptr->transformations &= ~PNG_BACKGROUND_EXPAND;

      if ((png_ptr->transformations & PNG_COMPOSE) != 0)

         png_error(png_ptr,

             "conflicting calls to set alpha mode and background");

      png_ptr->transformations |= PNG_COMPOSE;

   }

}

#  ifdef PNG_FLOATING_POINT_SUPPORTED

void PNGAPI

png_set_alpha_mode(png_structrp png_ptr, int mode, double output_gamma)

{

   png_set_alpha_mode_fixed(png_ptr, mode, convert_gamma_value(png_ptr,

       output_gamma));

}

#  endif

#endif

#ifdef PNG_READ_QUANTIZE_SUPPORTED

/* Dither file to 8-bit.  Supply a palette, the current number

 * of elements in the palette, the maximum number of elements

 * allowed, and a histogram if possible.  If the current number

 * of colors is greater than the maximum number, the palette will be

 * modified to fit in the maximum number.  "full_quantize" indicates

 * whether we need a quantizing cube set up for RGB images, or if we

 * simply are reducing the number of colors in a paletted image.

 */

typedef struct png_dsort_struct

{

   struct png_dsort_struct * next;

   png_byte left;

   png_byte right;

} png_dsort;

typedef png_dsort *   png_dsortp;

typedef png_dsort * * png_dsortpp;

void PNGAPI

png_set_quantize(png_structrp png_ptr, png_colorp palette,

    int num_palette, int maximum_colors, png_const_uint_16p histogram,

    int full_quantize)

{

   png_debug(1, "in png_set_quantize");

   if (png_rtran_ok(png_ptr, 0) == 0)

      return;

   png_ptr->transformations |= PNG_QUANTIZE;

   if (full_quantize == 0)

   {

      int i;

      png_ptr->quantize_index = (png_bytep)png_malloc(png_ptr,

          (png_alloc_size_t)((png_uint_32)num_palette * (sizeof (png_byte))));

      for (i = 0; i < num_palette; i++)

         png_ptr->quantize_index[i] = (png_byte)i;

   }

   if (num_palette > maximum_colors)

   {

      if (histogram != NULL)

      {

         /* This is easy enough, just throw out the least used colors.

          * Perhaps not the best solution, but good enough.

          */

         int i;

         /* Initialize an array to sort colors */

         png_ptr->quantize_sort = (png_bytep)png_malloc(png_ptr,

             (png_alloc_size_t)((png_uint_32)num_palette * (sizeof (png_byte))));

         /* Initialize the quantize_sort array */

         for (i = 0; i < num_palette; i++)

            png_ptr->quantize_sort[i] = (png_byte)i;