Blame imageio/pngdec.c

Packit 9c6abc
// Copyright 2012 Google Inc. All Rights Reserved.
Packit 9c6abc
//
Packit 9c6abc
// Use of this source code is governed by a BSD-style license
Packit 9c6abc
// that can be found in the COPYING file in the root of the source
Packit 9c6abc
// tree. An additional intellectual property rights grant can be found
Packit 9c6abc
// in the file PATENTS. All contributing project authors may
Packit 9c6abc
// be found in the AUTHORS file in the root of the source tree.
Packit 9c6abc
// -----------------------------------------------------------------------------
Packit 9c6abc
//
Packit 9c6abc
// PNG decode.
Packit 9c6abc
Packit 9c6abc
#include "./pngdec.h"
Packit 9c6abc
Packit 9c6abc
#ifdef HAVE_CONFIG_H
Packit 9c6abc
#include "webp/config.h"
Packit 9c6abc
#endif
Packit 9c6abc
Packit 9c6abc
#include <stdio.h>
Packit 9c6abc
Packit 9c6abc
#ifdef WEBP_HAVE_PNG
Packit 9c6abc
#include <png.h>
Packit 9c6abc
#include <setjmp.h>   // note: this must be included *after* png.h
Packit 9c6abc
#include <stdlib.h>
Packit 9c6abc
#include <string.h>
Packit 9c6abc
Packit 9c6abc
#include "webp/encode.h"
Packit 9c6abc
#include "./imageio_util.h"
Packit 9c6abc
#include "./metadata.h"
Packit 9c6abc
Packit 9c6abc
static void PNGAPI error_function(png_structp png, png_const_charp error) {
Packit 9c6abc
  if (error != NULL) fprintf(stderr, "libpng error: %s\n", error);
Packit 9c6abc
  longjmp(png_jmpbuf(png), 1);
Packit 9c6abc
}
Packit 9c6abc
Packit 9c6abc
// Converts the NULL terminated 'hexstring' which contains 2-byte character
Packit 9c6abc
// representations of hex values to raw data.
Packit 9c6abc
// 'hexstring' may contain values consisting of [A-F][a-f][0-9] in pairs,
Packit 9c6abc
// e.g., 7af2..., separated by any number of newlines.
Packit 9c6abc
// 'expected_length' is the anticipated processed size.
Packit 9c6abc
// On success the raw buffer is returned with its length equivalent to
Packit 9c6abc
// 'expected_length'. NULL is returned if the processed length is less than
Packit 9c6abc
// 'expected_length' or any character aside from those above is encountered.
Packit 9c6abc
// The returned buffer must be freed by the caller.
Packit 9c6abc
static uint8_t* HexStringToBytes(const char* hexstring,
Packit 9c6abc
                                 size_t expected_length) {
Packit 9c6abc
  const char* src = hexstring;
Packit 9c6abc
  size_t actual_length = 0;
Packit 9c6abc
  uint8_t* const raw_data = (uint8_t*)malloc(expected_length);
Packit 9c6abc
  uint8_t* dst;
Packit 9c6abc
Packit 9c6abc
  if (raw_data == NULL) return NULL;
Packit 9c6abc
Packit 9c6abc
  for (dst = raw_data; actual_length < expected_length && *src != '\0'; ++src) {
Packit 9c6abc
    char* end;
Packit 9c6abc
    char val[3];
Packit 9c6abc
    if (*src == '\n') continue;
Packit 9c6abc
    val[0] = *src++;
Packit 9c6abc
    val[1] = *src;
Packit 9c6abc
    val[2] = '\0';
Packit 9c6abc
    *dst++ = (uint8_t)strtol(val, &end, 16);
Packit 9c6abc
    if (end != val + 2) break;
Packit 9c6abc
    ++actual_length;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  if (actual_length != expected_length) {
Packit 9c6abc
    free(raw_data);
Packit 9c6abc
    return NULL;
Packit 9c6abc
  }
Packit 9c6abc
  return raw_data;
Packit 9c6abc
}
Packit 9c6abc
Packit 9c6abc
static int ProcessRawProfile(const char* profile, size_t profile_len,
Packit 9c6abc
                             MetadataPayload* const payload) {
Packit 9c6abc
  const char* src = profile;
Packit 9c6abc
  char* end;
Packit 9c6abc
  int expected_length;
Packit 9c6abc
Packit 9c6abc
  if (profile == NULL || profile_len == 0) return 0;
Packit 9c6abc
Packit 9c6abc
  // ImageMagick formats 'raw profiles' as
Packit 9c6abc
  // '\n<name>\n<length>(%8lu)\n<hex payload>\n'.
Packit 9c6abc
  if (*src != '\n') {
Packit 9c6abc
    fprintf(stderr, "Malformed raw profile, expected '\\n' got '\\x%.2X'\n",
Packit 9c6abc
            *src);
Packit 9c6abc
    return 0;
Packit 9c6abc
  }
Packit 9c6abc
  ++src;
Packit 9c6abc
  // skip the profile name and extract the length.
Packit 9c6abc
  while (*src != '\0' && *src++ != '\n') {}
Packit 9c6abc
  expected_length = (int)strtol(src, &end, 10);
Packit 9c6abc
  if (*end != '\n') {
Packit 9c6abc
    fprintf(stderr, "Malformed raw profile, expected '\\n' got '\\x%.2X'\n",
Packit 9c6abc
            *end);
Packit 9c6abc
    return 0;
Packit 9c6abc
  }
Packit 9c6abc
  ++end;
Packit 9c6abc
Packit 9c6abc
  // 'end' now points to the profile payload.
Packit 9c6abc
  payload->bytes = HexStringToBytes(end, expected_length);
Packit 9c6abc
  if (payload->bytes == NULL) return 0;
Packit 9c6abc
  payload->size = expected_length;
Packit 9c6abc
  return 1;
Packit 9c6abc
}
Packit 9c6abc
Packit 9c6abc
static const struct {
Packit 9c6abc
  const char* name;
Packit 9c6abc
  int (*process)(const char* profile, size_t profile_len,
Packit 9c6abc
                 MetadataPayload* const payload);
Packit 9c6abc
  size_t storage_offset;
Packit 9c6abc
} kPNGMetadataMap[] = {
Packit 9c6abc
  // http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/PNG.html#TextualData
Packit 9c6abc
  // See also: ExifTool on CPAN.
Packit 9c6abc
  { "Raw profile type exif", ProcessRawProfile, METADATA_OFFSET(exif) },
Packit 9c6abc
  { "Raw profile type xmp",  ProcessRawProfile, METADATA_OFFSET(xmp) },
Packit 9c6abc
  // Exiftool puts exif data in APP1 chunk, too.
Packit 9c6abc
  { "Raw profile type APP1", ProcessRawProfile, METADATA_OFFSET(exif) },
Packit 9c6abc
  // XMP Specification Part 3, Section 3 #PNG
Packit 9c6abc
  { "XML:com.adobe.xmp",     MetadataCopy,      METADATA_OFFSET(xmp) },
Packit 9c6abc
  { NULL, NULL, 0 },
Packit 9c6abc
};
Packit 9c6abc
Packit 9c6abc
// Looks for metadata at both the beginning and end of the PNG file, giving
Packit 9c6abc
// preference to the head.
Packit 9c6abc
// Returns true on success. The caller must use MetadataFree() on 'metadata' in
Packit 9c6abc
// all cases.
Packit 9c6abc
static int ExtractMetadataFromPNG(png_structp png,
Packit 9c6abc
                                  png_infop const head_info,
Packit 9c6abc
                                  png_infop const end_info,
Packit 9c6abc
                                  Metadata* const metadata) {
Packit 9c6abc
  int p;
Packit 9c6abc
Packit 9c6abc
  for (p = 0; p < 2; ++p)  {
Packit 9c6abc
    png_infop const info = (p == 0) ? head_info : end_info;
Packit 9c6abc
    png_textp text = NULL;
Packit 9c6abc
    const png_uint_32 num = png_get_text(png, info, &text, NULL);
Packit 9c6abc
    png_uint_32 i;
Packit 9c6abc
    // Look for EXIF / XMP metadata.
Packit 9c6abc
    for (i = 0; i < num; ++i, ++text) {
Packit 9c6abc
      int j;
Packit 9c6abc
      for (j = 0; kPNGMetadataMap[j].name != NULL; ++j) {
Packit 9c6abc
        if (!strcmp(text->key, kPNGMetadataMap[j].name)) {
Packit 9c6abc
          MetadataPayload* const payload =
Packit 9c6abc
              (MetadataPayload*)((uint8_t*)metadata +
Packit 9c6abc
                                 kPNGMetadataMap[j].storage_offset);
Packit 9c6abc
          png_size_t text_length;
Packit 9c6abc
          switch (text->compression) {
Packit 9c6abc
#ifdef PNG_iTXt_SUPPORTED
Packit 9c6abc
            case PNG_ITXT_COMPRESSION_NONE:
Packit 9c6abc
            case PNG_ITXT_COMPRESSION_zTXt:
Packit 9c6abc
              text_length = text->itxt_length;
Packit 9c6abc
              break;
Packit 9c6abc
#endif
Packit 9c6abc
            case PNG_TEXT_COMPRESSION_NONE:
Packit 9c6abc
            case PNG_TEXT_COMPRESSION_zTXt:
Packit 9c6abc
            default:
Packit 9c6abc
              text_length = text->text_length;
Packit 9c6abc
              break;
Packit 9c6abc
          }
Packit 9c6abc
          if (payload->bytes != NULL) {
Packit 9c6abc
            fprintf(stderr, "Ignoring additional '%s'\n", text->key);
Packit 9c6abc
          } else if (!kPNGMetadataMap[j].process(text->text, text_length,
Packit 9c6abc
                                                 payload)) {
Packit 9c6abc
            fprintf(stderr, "Failed to process: '%s'\n", text->key);
Packit 9c6abc
            return 0;
Packit 9c6abc
          }
Packit 9c6abc
          break;
Packit 9c6abc
        }
Packit 9c6abc
      }
Packit 9c6abc
    }
Packit 9c6abc
    // Look for an ICC profile.
Packit 9c6abc
    {
Packit 9c6abc
      png_charp name;
Packit 9c6abc
      int comp_type;
Packit 9c6abc
#if ((PNG_LIBPNG_VER_MAJOR << 8) | PNG_LIBPNG_VER_MINOR << 0) < \
Packit 9c6abc
    ((1 << 8) | (5 << 0))
Packit 9c6abc
      png_charp profile;
Packit 9c6abc
#else  // >= libpng 1.5.0
Packit 9c6abc
      png_bytep profile;
Packit 9c6abc
#endif
Packit 9c6abc
      png_uint_32 len;
Packit 9c6abc
Packit 9c6abc
      if (png_get_iCCP(png, info,
Packit 9c6abc
                       &name, &comp_type, &profile, &len) == PNG_INFO_iCCP) {
Packit 9c6abc
        if (!MetadataCopy((const char*)profile, len, &metadata->iccp)) return 0;
Packit 9c6abc
      }
Packit 9c6abc
    }
Packit 9c6abc
  }
Packit 9c6abc
  return 1;
Packit 9c6abc
}
Packit 9c6abc
Packit 9c6abc
typedef struct {
Packit 9c6abc
  const uint8_t* data;
Packit 9c6abc
  size_t data_size;
Packit 9c6abc
  png_size_t offset;
Packit 9c6abc
} PNGReadContext;
Packit 9c6abc
Packit 9c6abc
static void ReadFunc(png_structp png_ptr, png_bytep data, png_size_t length) {
Packit 9c6abc
  PNGReadContext* const ctx = (PNGReadContext*)png_get_io_ptr(png_ptr);
Packit 9c6abc
  if (ctx->data_size - ctx->offset < length) {
Packit 9c6abc
    png_error(png_ptr, "ReadFunc: invalid read length (overflow)!");
Packit 9c6abc
  }
Packit 9c6abc
  memcpy(data, ctx->data + ctx->offset, length);
Packit 9c6abc
  ctx->offset += length;
Packit 9c6abc
}
Packit 9c6abc
Packit 9c6abc
int ReadPNG(const uint8_t* const data, size_t data_size,
Packit 9c6abc
            struct WebPPicture* const pic,
Packit 9c6abc
            int keep_alpha, struct Metadata* const metadata) {
Packit 9c6abc
  volatile png_structp png = NULL;
Packit 9c6abc
  volatile png_infop info = NULL;
Packit 9c6abc
  volatile png_infop end_info = NULL;
Packit 9c6abc
  PNGReadContext context = { NULL, 0, 0 };
Packit 9c6abc
  int color_type, bit_depth, interlaced;
Packit 9c6abc
  int has_alpha;
Packit 9c6abc
  int num_passes;
Packit 9c6abc
  int p;
Packit 9c6abc
  volatile int ok = 0;
Packit 9c6abc
  png_uint_32 width, height, y;
Packit 9c6abc
  int64_t stride;
Packit 9c6abc
  uint8_t* volatile rgb = NULL;
Packit 9c6abc
Packit 9c6abc
  if (data == NULL || data_size == 0 || pic == NULL) return 0;
Packit 9c6abc
Packit 9c6abc
  context.data = data;
Packit 9c6abc
  context.data_size = data_size;
Packit 9c6abc
Packit 9c6abc
  png = png_create_read_struct(PNG_LIBPNG_VER_STRING, 0, 0, 0);
Packit 9c6abc
  if (png == NULL) goto End;
Packit 9c6abc
Packit 9c6abc
  png_set_error_fn(png, 0, error_function, NULL);
Packit 9c6abc
  if (setjmp(png_jmpbuf(png))) {
Packit 9c6abc
 Error:
Packit 9c6abc
    MetadataFree(metadata);
Packit 9c6abc
    goto End;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  info = png_create_info_struct(png);
Packit 9c6abc
  if (info == NULL) goto Error;
Packit 9c6abc
  end_info = png_create_info_struct(png);
Packit 9c6abc
  if (end_info == NULL) goto Error;
Packit 9c6abc
Packit 9c6abc
  png_set_read_fn(png, &context, ReadFunc);
Packit 9c6abc
  png_read_info(png, info);
Packit 9c6abc
  if (!png_get_IHDR(png, info,
Packit 9c6abc
                    &width, &height, &bit_depth, &color_type, &interlaced,
Packit 9c6abc
                    NULL, NULL)) goto Error;
Packit 9c6abc
Packit 9c6abc
  png_set_strip_16(png);
Packit 9c6abc
  png_set_packing(png);
Packit 9c6abc
  if (color_type == PNG_COLOR_TYPE_PALETTE) {
Packit 9c6abc
    png_set_palette_to_rgb(png);
Packit 9c6abc
  }
Packit 9c6abc
  if (color_type == PNG_COLOR_TYPE_GRAY ||
Packit 9c6abc
      color_type == PNG_COLOR_TYPE_GRAY_ALPHA) {
Packit 9c6abc
    if (bit_depth < 8) {
Packit 9c6abc
      png_set_expand_gray_1_2_4_to_8(png);
Packit 9c6abc
    }
Packit 9c6abc
    png_set_gray_to_rgb(png);
Packit 9c6abc
  }
Packit 9c6abc
  if (png_get_valid(png, info, PNG_INFO_tRNS)) {
Packit 9c6abc
    png_set_tRNS_to_alpha(png);
Packit 9c6abc
    has_alpha = 1;
Packit 9c6abc
  } else {
Packit 9c6abc
    has_alpha = !!(color_type & PNG_COLOR_MASK_ALPHA);
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  // Apply gamma correction if needed.
Packit 9c6abc
  {
Packit 9c6abc
    double image_gamma = 1 / 2.2, screen_gamma = 2.2;
Packit 9c6abc
    int srgb_intent;
Packit 9c6abc
    if (png_get_sRGB(png, info, &srgb_intent) ||
Packit 9c6abc
        png_get_gAMA(png, info, &image_gamma)) {
Packit 9c6abc
      png_set_gamma(png, screen_gamma, image_gamma);
Packit 9c6abc
    }
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  if (!keep_alpha) {
Packit 9c6abc
    png_set_strip_alpha(png);
Packit 9c6abc
    has_alpha = 0;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  num_passes = png_set_interlace_handling(png);
Packit 9c6abc
  png_read_update_info(png, info);
Packit 9c6abc
Packit 9c6abc
  stride = (int64_t)(has_alpha ? 4 : 3) * width * sizeof(*rgb);
Packit 9c6abc
  if (stride != (int)stride ||
Packit 9c6abc
      !ImgIoUtilCheckSizeArgumentsOverflow(stride, height)) {
Packit 9c6abc
    goto Error;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  rgb = (uint8_t*)malloc((size_t)stride * height);
Packit 9c6abc
  if (rgb == NULL) goto Error;
Packit 9c6abc
  for (p = 0; p < num_passes; ++p) {
Packit 9c6abc
    png_bytep row = rgb;
Packit 9c6abc
    for (y = 0; y < height; ++y) {
Packit 9c6abc
      png_read_rows(png, &row, NULL, 1);
Packit 9c6abc
      row += stride;
Packit 9c6abc
    }
Packit 9c6abc
  }
Packit 9c6abc
  png_read_end(png, end_info);
Packit 9c6abc
Packit 9c6abc
  if (metadata != NULL &&
Packit 9c6abc
      !ExtractMetadataFromPNG(png, info, end_info, metadata)) {
Packit 9c6abc
    fprintf(stderr, "Error extracting PNG metadata!\n");
Packit 9c6abc
    goto Error;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
  pic->width = (int)width;
Packit 9c6abc
  pic->height = (int)height;
Packit 9c6abc
  ok = has_alpha ? WebPPictureImportRGBA(pic, rgb, (int)stride)
Packit 9c6abc
                 : WebPPictureImportRGB(pic, rgb, (int)stride);
Packit 9c6abc
Packit 9c6abc
  if (!ok) {
Packit 9c6abc
    goto Error;
Packit 9c6abc
  }
Packit 9c6abc
Packit 9c6abc
 End:
Packit 9c6abc
  if (png != NULL) {
Packit 9c6abc
    png_destroy_read_struct((png_structpp)&png,
Packit 9c6abc
                            (png_infopp)&info, (png_infopp)&end_info);
Packit 9c6abc
  }
Packit 9c6abc
  free(rgb);
Packit 9c6abc
  return ok;
Packit 9c6abc
}
Packit 9c6abc
#else  // !WEBP_HAVE_PNG
Packit 9c6abc
int ReadPNG(const uint8_t* const data, size_t data_size,
Packit 9c6abc
            struct WebPPicture* const pic,
Packit 9c6abc
            int keep_alpha, struct Metadata* const metadata) {
Packit 9c6abc
  (void)data;
Packit 9c6abc
  (void)data_size;
Packit 9c6abc
  (void)pic;
Packit 9c6abc
  (void)keep_alpha;
Packit 9c6abc
  (void)metadata;
Packit 9c6abc
  fprintf(stderr, "PNG support not compiled. Please install the libpng "
Packit 9c6abc
          "development package before building.\n");
Packit 9c6abc
  return 0;
Packit 9c6abc
}
Packit 9c6abc
#endif  // WEBP_HAVE_PNG
Packit 9c6abc
Packit 9c6abc
// -----------------------------------------------------------------------------