weston/shared/image-loader.c

/*
 * Copyright © 2008-2012 Kristian Høgsberg
 * Copyright © 2012 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include "config.h"

#include <errno.h>
#include <stdbool.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <sys/mman.h>
#include <png.h>
#include <pixman.h>

#include "shared/helpers.h"
#include "shared/os-compatibility.h"
#include "shared/xalloc.h"
#include "image-loader.h"

#ifdef HAVE_JPEG
#include <jpeglib.h>
#endif

#ifdef HAVE_WEBP
#include <webp/decode.h>
#endif

static int
stride_for_width(int width)
{
	return width * 4;
}

static void
pixman_image_destroy_func(pixman_image_t *image, void *data)
{
	free(data);
}

static struct icc_profile_data *
icc_profile_data_create(void *profdata, uint32_t proflen)
{
	struct icc_profile_data *icc_profile_data;
	int fd;
	void *data;

	fd = os_create_anonymous_file(proflen);
	if (fd < 0) {
		fprintf(stderr, "failed to create anonymous file: %s\n",
				strerror(errno));
		return NULL;
	}

	data = mmap(NULL, proflen, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
	if (data == MAP_FAILED) {
		close(fd);
		fprintf(stderr, "mmap failed: %s\n", strerror(errno));
		return NULL;
	}
	memcpy(data, profdata, proflen);
	munmap(data, proflen);

	icc_profile_data = xzalloc(sizeof(*icc_profile_data));
	icc_profile_data->fd = fd;
	icc_profile_data->length = proflen;
	icc_profile_data->offset = 0;

	return icc_profile_data;
}

#ifdef HAVE_JPEG

static void
swizzle_row(JSAMPLE *row, JDIMENSION width)
{
	JSAMPLE *s;
	uint32_t *d;

	s = row + (width - 1) * 3;
	d = (uint32_t *) (row + (width - 1) * 4);
	while (s >= row) {
		*d = 0xff000000 | (s[0] << 16) | (s[1] << 8) | (s[2] << 0);
		s -= 3;
		d--;
	}
}

struct jpeg_image_data {
	JSAMPLE *volatile data;
	bool volatile all_data_read;
};

static pixman_image_t *
load_jpeg_image(struct jpeg_decompress_struct *cinfo,
		struct jpeg_image_data *jpeg_image_data)
{
	JSAMPLE *rows[4];
	int stride, first;
	unsigned int i;
	pixman_image_t *pixman_image;

	stride = cinfo->output_width * 4;
	jpeg_image_data->data = malloc(stride * cinfo->output_height);
	if (jpeg_image_data->data == NULL) {
		fprintf(stderr, "couldn't allocate image data\n");
		return NULL;
	}

	while (cinfo->output_scanline < cinfo->output_height) {
		first = cinfo->output_scanline;
		for (i = 0; i < ARRAY_LENGTH(rows); i++)
			rows[i] = jpeg_image_data->data + (first + i) * stride;

		jpeg_read_scanlines(cinfo, rows, ARRAY_LENGTH(rows));
		for (i = 0; first + i < cinfo->output_scanline; i++)
			swizzle_row(rows[i], cinfo->output_width);
	}
	jpeg_image_data->all_data_read = true;

	pixman_image = pixman_image_create_bits(PIXMAN_a8r8g8b8,
						cinfo->output_width,
						cinfo->output_height,
						(uint32_t *)jpeg_image_data->data,
						stride);
	pixman_image_set_destroy_function(pixman_image, pixman_image_destroy_func,
					  jpeg_image_data->data);
	jpeg_image_data->data = NULL;

	return pixman_image;
}

static int
load_jpeg_icc(struct jpeg_decompress_struct *cinfo,
	      struct icc_profile_data **icc_profile_data)
{
	JOCTET *profdata;
	uint32_t proflen;

	if (!jpeg_read_icc_profile(cinfo, &profdata, &proflen)) {
		/* Not an error, the file simply does not have an ICC embedded. */
		*icc_profile_data = NULL;
		return 0;
	}

	*icc_profile_data = icc_profile_data_create(profdata, proflen);
	free(profdata);
	if (*icc_profile_data == NULL)
		return -1;

	return 0;
}

static void
error_exit(j_common_ptr cinfo)
{
	longjmp(cinfo->client_data, 1);
}

static struct weston_image *
load_jpeg(FILE *fp, uint32_t image_load_flags)
{
	struct weston_image *volatile image = NULL;
	struct jpeg_decompress_struct cinfo;
	struct jpeg_error_mgr jerr;
	struct jpeg_image_data jpeg_image_data = { 0 };
	jmp_buf env;
	int ret;

	cinfo.err = jpeg_std_error(&jerr);
	jerr.error_exit = error_exit;
	cinfo.client_data = env;
	if (setjmp(env))
		goto err;

	jpeg_create_decompress(&cinfo);
	jpeg_stdio_src(&cinfo, fp);

	/**
	 * libjpeg.txt says that if we want to call jpeg_read_icc_profile(), we
	 * need to call the function below before calling jpeg_read_header().
	 */
	if (image_load_flags & WESTON_IMAGE_LOAD_ICC)
		jpeg_save_markers(&cinfo, JPEG_APP0 + 2, 0xFFFF);

	jpeg_read_header(&cinfo, TRUE);
	cinfo.out_color_space = JCS_RGB;
	jpeg_start_decompress(&cinfo);

	image = xzalloc(sizeof(*image));

	if (image_load_flags & WESTON_IMAGE_LOAD_IMAGE) {
		image->pixman_image = load_jpeg_image(&cinfo, &jpeg_image_data);
		if (!image->pixman_image)
			goto err;
	}
	if (image_load_flags & WESTON_IMAGE_LOAD_ICC) {
		ret = load_jpeg_icc(&cinfo, &image->icc_profile_data);
		if (ret < 0)
			goto err;
	}

	jpeg_finish_decompress(&cinfo);
	jpeg_destroy_decompress(&cinfo);
	return image;

err:
	free(jpeg_image_data.data);
	/**
	 * libjpeg.txt says that it is an error to call finish_decompress()
	 * before reading the total number of scanlines. But it documents that
	 * destroy_decompress() also aborts the decompression, so we can safely
	 * call that if the reading process is not finished.
	 */
	if (jpeg_image_data.all_data_read)
		jpeg_finish_decompress(&cinfo);
	jpeg_destroy_decompress(&cinfo);
	if (image)
		weston_image_destroy(image);
	return NULL;
}

#else

static struct weston_image *
load_jpeg(FILE *fp, uint32_t image_load_flags)
{
	fprintf(stderr, "JPEG support disabled at compile-time\n");
	return NULL;
}

#endif

static inline int
multiply_alpha(int alpha, int color)
{
    int temp = (alpha * color) + 0x80;

    return ((temp + (temp >> 8)) >> 8);
}

static void
premultiply_data(png_structp   png,
		 png_row_infop row_info,
		 png_bytep     data)
{
    unsigned int i;
    png_bytep p;

    for (i = 0, p = data; i < row_info->rowbytes; i += 4, p += 4) {
	uint32_t alpha = p[3];
	uint32_t w;

	if (alpha == 0) {
		w = 0;
	} else {
		uint32_t red   = p[0];
		uint32_t green = p[1];
		uint32_t blue  = p[2];

		if (alpha != 0xff) {
			red   = multiply_alpha(alpha, red);
			green = multiply_alpha(alpha, green);
			blue  = multiply_alpha(alpha, blue);
		}
		w = (alpha << 24) | (red << 16) | (green << 8) | (blue << 0);
	}

	* (uint32_t *) p = w;
    }
}

static void
read_func(png_structp png, png_bytep data, png_size_t size)
{
	FILE *fp = png_get_io_ptr(png);

	if (fread(data, 1, size, fp) != size)
		png_error(png, NULL);
}

static void
png_error_callback(png_structp png, png_const_charp error_msg)
{
    longjmp (png_jmpbuf (png), 1);
}

struct png_image_data {
	png_byte *volatile data;
	png_byte **volatile row_pointers;
};

static pixman_image_t *
load_png_image(FILE *fp, png_struct *png, png_info *info,
	       struct png_image_data *png_image_data)
{
	png_uint_32 width, height;
	int depth, color_type, interlace, stride;
	unsigned int i;
	pixman_image_t *pixman_image;

	png_get_IHDR(png, info,
		     &width, &height, &depth,
		     &color_type, &interlace, NULL, NULL);

	if (color_type == PNG_COLOR_TYPE_PALETTE)
		png_set_palette_to_rgb(png);

	if (color_type == PNG_COLOR_TYPE_GRAY)
		png_set_expand_gray_1_2_4_to_8(png);

	if (png_get_valid(png, info, PNG_INFO_tRNS))
		png_set_tRNS_to_alpha(png);

	if (depth == 16)
		png_set_strip_16(png);

	if (depth < 8)
		png_set_packing(png);

	if (color_type == PNG_COLOR_TYPE_GRAY ||
	    color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
		png_set_gray_to_rgb(png);

	if (interlace != PNG_INTERLACE_NONE)
		png_set_interlace_handling(png);

	png_set_filler(png, 0xff, PNG_FILLER_AFTER);
	png_set_read_user_transform_fn(png, premultiply_data);
	png_read_update_info(png, info);
	png_get_IHDR(png, info,
		     &width, &height, &depth,
		     &color_type, &interlace, NULL, NULL);

	stride = stride_for_width(width);
	png_image_data->data = malloc(stride * height);
	if (!png_image_data->data)
		return NULL;

	png_image_data->row_pointers = malloc(height * sizeof png_image_data->row_pointers[0]);
	if (png_image_data->row_pointers == NULL)
		return NULL;

	for (i = 0; i < height; i++)
		png_image_data->row_pointers[i] = &png_image_data->data[i * stride];

	png_read_image(png, png_image_data->row_pointers);
	png_read_end(png, info);

	free(png_image_data->row_pointers);
	png_image_data->row_pointers = NULL;

	pixman_image = pixman_image_create_bits(PIXMAN_a8r8g8b8, width, height,
						(uint32_t *) png_image_data->data,
						stride);

	pixman_image_set_destroy_function(pixman_image, pixman_image_destroy_func,
					  png_image_data->data);
	png_image_data->data = NULL;

	return pixman_image;
}

static int
load_png_icc(FILE *fp, png_struct *png, png_info *info,
	     struct icc_profile_data **icc_profile_data)
{
        png_charp name;
        int compression_type;
        png_bytep profdata;
        png_uint_32 proflen;
	png_uint_32 ret;

	ret = png_get_iCCP(png, info, &name, &compression_type, &profdata, &proflen);
	if (ret != PNG_INFO_iCCP) {
		/* Not an error, the file simply does not have an ICC embedded. */
		*icc_profile_data = NULL;
		return 0;
	}

	*icc_profile_data = icc_profile_data_create(profdata, proflen);
	if (*icc_profile_data == NULL)
		return -1;

	return 0;
}

static struct weston_image *
load_png(FILE *fp, uint32_t image_load_flags)
{
	struct weston_image *volatile image = NULL;
	struct png_image_data png_image_data = { 0 };
	png_struct *png;
	png_info *info;
	int ret;

	png = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL,
				     png_error_callback, NULL);
	if (!png)
		return NULL;

	info = png_create_info_struct(png);
	if (!info) {
		png_destroy_read_struct(&png, NULL, NULL);
		return NULL;
	}

	if (setjmp(png_jmpbuf(png)))
		goto err;

	png_set_read_fn(png, fp, read_func);
	png_read_info(png, info);

	image = xzalloc(sizeof(*image));

	if (image_load_flags & WESTON_IMAGE_LOAD_IMAGE) {
		image->pixman_image = load_png_image(fp, png, info, &png_image_data);
		if (!image->pixman_image)
			goto err;
	}
	if (image_load_flags & WESTON_IMAGE_LOAD_ICC) {
		ret = load_png_icc(fp, png, info, &image->icc_profile_data);
		if (ret < 0)
			goto err;
	}

	png_destroy_read_struct(&png, &info, NULL);
	return image;

err:
	free(png_image_data.data);
	free(png_image_data.row_pointers);
	png_destroy_read_struct(&png, &info, NULL);
	if (image)
		weston_image_destroy(image);
	return NULL;
}

#ifdef HAVE_WEBP

static struct weston_image *
load_webp(FILE *fp, uint32_t image_load_flags)
{
	struct weston_image *image;
	pixman_image_t *pixman_image;
	WebPDecoderConfig config;
	uint8_t buffer[16 * 1024];
	int len;
	VP8StatusCode status;
	WebPIDecoder *idec;

	if (image_load_flags & WESTON_IMAGE_LOAD_ICC)
		fprintf(stderr, "We still don't support reading ICC profile from WebP\n");

	if (!(image_load_flags & WESTON_IMAGE_LOAD_IMAGE))
		return NULL;

	if (!WebPInitDecoderConfig(&config)) {
		fprintf(stderr, "Library version mismatch!\n");
		return NULL;
	}

	/* webp decoding api doesn't seem to specify a min size that's
	   usable for GetFeatures, but 256 works... */
	len = fread(buffer, 1, 256, fp);
	status = WebPGetFeatures(buffer, len, &config.input);
	if (status != VP8_STATUS_OK) {
		fprintf(stderr, "failed to parse webp header\n");
		WebPFreeDecBuffer(&config.output);
		return NULL;
	}

	config.output.colorspace = MODE_BGRA;
	config.output.u.RGBA.stride = stride_for_width(config.input.width);
	config.output.u.RGBA.size =
		config.output.u.RGBA.stride * config.input.height;
	config.output.u.RGBA.rgba =
		malloc(config.output.u.RGBA.stride * config.input.height);
	config.output.is_external_memory = 1;
	if (!config.output.u.RGBA.rgba) {
		WebPFreeDecBuffer(&config.output);
		return NULL;
	}

	rewind(fp);
	idec = WebPINewDecoder(&config.output);
	if (!idec) {
		WebPFreeDecBuffer(&config.output);
		return NULL;
	}

	while (!feof(fp)) {
		len = fread(buffer, 1, sizeof buffer, fp);
		status = WebPIAppend(idec, buffer, len);
		if (status != VP8_STATUS_OK) {
			fprintf(stderr, "webp decode status %d\n", status);
			WebPIDelete(idec);
			WebPFreeDecBuffer(&config.output);
			return NULL;
		}
	}

	WebPIDelete(idec);
	WebPFreeDecBuffer(&config.output);

	pixman_image = pixman_image_create_bits(PIXMAN_a8r8g8b8,
						config.input.width, config.input.height,
						(uint32_t *) config.output.u.RGBA.rgba,
						config.output.u.RGBA.stride);

	image = xzalloc(sizeof(*image));
	image->pixman_image = pixman_image;

	return image;
}

#else

static struct weston_image *
load_webp(FILE *fp, uint32_t image_load_flags)
{
	fprintf(stderr, "WebP support disabled at compile-time\n");
	return NULL;
}

#endif


struct image_loader {
	unsigned char header[4];
	int header_size;
	struct weston_image *(*load)(FILE *fp, uint32_t image_load_flags);
};

static const struct image_loader loaders[] = {
	{ { 0x89, 'P', 'N', 'G' }, 4, load_png },
	{ { 0xff, 0xd8 }, 2, load_jpeg },
	{ { 'R', 'I', 'F', 'F' }, 4, load_webp }
};

/**
 * Given a filename, loads the associated image.
 *
 * \param filename The full image filename, i.e. the path plus filename.
 * \param image_load_flags Combination of enum weston_image_load_flags.
 * \return A struct weston_image on success, NULL on failure.
 *
 * To normally load the image, use the flag WESTON_IMAGE_LOAD_IMAGE. If this
 * function fails to load the image, it returns NULL. Otherwise the image will
 * be stored in weston_image::pixman_image.
 *
 * As ICC profiles are not always embedded on image files, even if
 * WESTON_IMAGE_LOAD_ICC is one of the given flags, the returned
 * weston_image::icc_profile_data may be NULL. But if something fails, this
 * function returns NULL.
 */
struct weston_image *
weston_image_load(const char *filename, uint32_t image_load_flags)
{
	struct weston_image *image = NULL;
	unsigned char header[4];
	FILE *fp;
	unsigned int i;

	if (!filename || !*filename)
		return NULL;

	fp = fopen(filename, "rb");
	if (!fp) {
		fprintf(stderr, "%s: %s\n", filename, strerror(errno));
		return NULL;
	}

	if (fread(header, sizeof header, 1, fp) != 1) {
		fclose(fp);
		fprintf(stderr, "%s: unable to read file header\n", filename);
		return NULL;
	}

	rewind(fp);
	for (i = 0; i < ARRAY_LENGTH(loaders); i++) {
		if (memcmp(header, loaders[i].header,
			   loaders[i].header_size) == 0) {
			image = loaders[i].load(fp, image_load_flags);
			break;
		}
	}

	fclose(fp);

	if (i == ARRAY_LENGTH(loaders)) {
		fprintf(stderr, "%s: unrecognized file header "
			"0x%02x 0x%02x 0x%02x 0x%02x\n",
			filename, header[0], header[1], header[2], header[3]);
	} else if (!image) {
		/* load probably printed something, but just in case */
		fprintf(stderr, "%s: error reading image\n", filename);
	}

	return image;
}

/**
 * Destroy a struct weston_image object.
 *
 * \param image The struct weston_image to destroy.
 */
void
weston_image_destroy(struct weston_image *image)
{
	if (image->pixman_image)
		pixman_image_unref(image->pixman_image);

	if (image->icc_profile_data) {
		close(image->icc_profile_data->fd);
		free(image->icc_profile_data);
	}

	free(image);
}