tiffload.c

/* load tiff from a file
 *
 * 5/12/11
 * 	- from tiffload.c
 * 27/1/17
 * 	- add get_flags for buffer loader
 */

/*

	This file is part of VIPS.

	VIPS is free software; you can redistribute it and/or modify
	it under the terms of the GNU Lesser General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program 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 Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	02110-1301  USA

 */

/*

	These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk

 */

/*
#define DEBUG
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <glib/gi18n-lib.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <vips/vips.h>
#include <vips/buf.h>
#include <vips/internal.h>

#include "pforeign.h"

#ifdef HAVE_TIFF

typedef struct _VipsForeignLoadTiff {
	VipsForeignLoad parent_object;

	/* Set by subclasses.
	 */
	VipsSource *source;

	/* Load this page.
	 */
	int page;

	/* Load this many pages.
	 */
	int n;

	/* Select subifd index. -1 for main image.
	 */
	int subifd;

	/* Autorotate using orientation tag.
	 */
	gboolean autorotate;

} VipsForeignLoadTiff;

typedef VipsForeignLoadClass VipsForeignLoadTiffClass;

G_DEFINE_ABSTRACT_TYPE(VipsForeignLoadTiff, vips_foreign_load_tiff,
	VIPS_TYPE_FOREIGN_LOAD);

static void
vips_foreign_load_tiff_dispose(GObject *gobject)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) gobject;

	VIPS_UNREF(tiff->source);

	G_OBJECT_CLASS(vips_foreign_load_tiff_parent_class)->dispose(gobject);
}

static VipsForeignFlags
vips_foreign_load_tiff_get_flags_source(VipsSource *source)
{
	VipsForeignFlags flags;

	flags = 0;
	if (vips__istifftiled_source(source))
		flags |= VIPS_FOREIGN_PARTIAL;
	else
		flags |= VIPS_FOREIGN_SEQUENTIAL;

	return flags;
}

static VipsForeignFlags
vips_foreign_load_tiff_get_flags_filename(const char *filename)
{
	VipsSource *source;
	VipsForeignFlags flags;

	if (!(source = vips_source_new_from_file(filename)))
		return 0;
	flags = vips_foreign_load_tiff_get_flags_source(source);
	VIPS_UNREF(source);

	return flags;
}

static VipsForeignFlags
vips_foreign_load_tiff_get_flags(VipsForeignLoad *load)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) load;

	return vips_foreign_load_tiff_get_flags_source(tiff->source);
}

static int
vips_foreign_load_tiff_header(VipsForeignLoad *load)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) load;

	if (vips__tiff_read_header_source(tiff->source, load->out,
			tiff->page, tiff->n, tiff->autorotate, tiff->subifd,
			load->fail_on))
		return -1;

	return 0;
}

static int
vips_foreign_load_tiff_load(VipsForeignLoad *load)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) load;

	if (vips__tiff_read_source(tiff->source, load->real,
			tiff->page, tiff->n, tiff->autorotate, tiff->subifd,
			load->fail_on))
		return -1;

	return 0;
}

static void
vips_foreign_load_tiff_class_init(VipsForeignLoadTiffClass *class)
{
	GObjectClass *gobject_class = G_OBJECT_CLASS(class);
	VipsObjectClass *object_class = (VipsObjectClass *) class;
	VipsForeignClass *foreign_class = (VipsForeignClass *) class;
	VipsForeignLoadClass *load_class = (VipsForeignLoadClass *) class;

	/* Other libraries may be using libtiff, we want to capture tiff
	 * warning and error as soon as we can.
	 *
	 * This class init will be triggered during startup.
	 */
	vips__tiff_init();

	gobject_class->dispose = vips_foreign_load_tiff_dispose;
	gobject_class->set_property = vips_object_set_property;
	gobject_class->get_property = vips_object_get_property;

	object_class->nickname = "tiffload_base";
	object_class->description = _("load tiff");

	/* We are fast, but must test after openslideload.
	 */
	foreign_class->priority = 50;

	load_class->get_flags_filename =
		vips_foreign_load_tiff_get_flags_filename;
	load_class->get_flags = vips_foreign_load_tiff_get_flags;
	load_class->header = vips_foreign_load_tiff_header;
	load_class->load = vips_foreign_load_tiff_load;

	VIPS_ARG_INT(class, "page", 20,
		_("Page"),
		_("First page to load"),
		VIPS_ARGUMENT_OPTIONAL_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiff, page),
		0, 100000, 0);

	VIPS_ARG_INT(class, "n", 21,
		_("n"),
		_("Number of pages to load, -1 for all"),
		VIPS_ARGUMENT_OPTIONAL_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiff, n),
		-1, 100000, 1);

	VIPS_ARG_BOOL(class, "autorotate", 22,
		_("Autorotate"),
		_("Rotate image using orientation tag"),
		VIPS_ARGUMENT_OPTIONAL_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiff, autorotate),
		FALSE);

	VIPS_ARG_INT(class, "subifd", 21,
		_("subifd"),
		_("Subifd index"),
		VIPS_ARGUMENT_OPTIONAL_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiff, subifd),
		-1, 100000, -1);
}

static void
vips_foreign_load_tiff_init(VipsForeignLoadTiff *tiff)
{
	tiff->page = 0;
	tiff->n = 1;
	tiff->subifd = -1;
}

typedef struct _VipsForeignLoadTiffSource {
	VipsForeignLoadTiff parent_object;

	/* Load from a source.
	 */
	VipsSource *source;

} VipsForeignLoadTiffSource;

typedef VipsForeignLoadTiffClass VipsForeignLoadTiffSourceClass;

G_DEFINE_TYPE(VipsForeignLoadTiffSource, vips_foreign_load_tiff_source,
	vips_foreign_load_tiff_get_type());

static int
vips_foreign_load_tiff_source_build(VipsObject *object)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) object;
	VipsForeignLoadTiffSource *source =
		(VipsForeignLoadTiffSource *) object;

	if (source->source) {
		tiff->source = source->source;
		g_object_ref(tiff->source);
	}

	if (VIPS_OBJECT_CLASS(vips_foreign_load_tiff_source_parent_class)
			->build(object))
		return -1;

	return 0;
}

static gboolean
vips_foreign_load_tiff_source_is_a_source(VipsSource *source)
{
	return vips__istiff_source(source);
}

static void
vips_foreign_load_tiff_source_class_init(
	VipsForeignLoadTiffSourceClass *class)
{
	GObjectClass *gobject_class = G_OBJECT_CLASS(class);
	VipsObjectClass *object_class = (VipsObjectClass *) class;
	VipsOperationClass *operation_class = VIPS_OPERATION_CLASS(class);
	VipsForeignLoadClass *load_class = (VipsForeignLoadClass *) class;

	gobject_class->set_property = vips_object_set_property;
	gobject_class->get_property = vips_object_get_property;

	object_class->nickname = "tiffload_source";
	object_class->description = _("load tiff from source");
	object_class->build = vips_foreign_load_tiff_source_build;

	operation_class->flags |= VIPS_OPERATION_NOCACHE;

	load_class->is_a_source = vips_foreign_load_tiff_source_is_a_source;

	VIPS_ARG_OBJECT(class, "source", 1,
		_("Source"),
		_("Source to load from"),
		VIPS_ARGUMENT_REQUIRED_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiffSource, source),
		VIPS_TYPE_SOURCE);
}

static void
vips_foreign_load_tiff_source_init(VipsForeignLoadTiffSource *source)
{
}

typedef struct _VipsForeignLoadTiffFile {
	VipsForeignLoadTiff parent_object;

	/* Filename for load.
	 */
	char *filename;

} VipsForeignLoadTiffFile;

typedef VipsForeignLoadTiffClass VipsForeignLoadTiffFileClass;

G_DEFINE_TYPE(VipsForeignLoadTiffFile, vips_foreign_load_tiff_file,
	vips_foreign_load_tiff_get_type());

static int
vips_foreign_load_tiff_file_build(VipsObject *object)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) object;
	VipsForeignLoadTiffFile *file = (VipsForeignLoadTiffFile *) object;

	if (file->filename &&
		!(tiff->source =
				vips_source_new_from_file(file->filename)))
		return -1;

	if (VIPS_OBJECT_CLASS(vips_foreign_load_tiff_file_parent_class)
			->build(object))
		return -1;

	return 0;
}

static gboolean
vips_foreign_load_tiff_file_is_a(const char *filename)
{
	VipsSource *source;
	gboolean result;

	if (!(source = vips_source_new_from_file(filename)))
		return FALSE;
	result = vips_foreign_load_tiff_source_is_a_source(source);
	VIPS_UNREF(source);

	return result;
}

const char *vips__foreign_tiff_suffs[] = { ".tif", ".tiff", NULL };

static void
vips_foreign_load_tiff_file_class_init(VipsForeignLoadTiffFileClass *class)
{
	GObjectClass *gobject_class = G_OBJECT_CLASS(class);
	VipsObjectClass *object_class = (VipsObjectClass *) class;
	VipsForeignClass *foreign_class = (VipsForeignClass *) class;
	VipsForeignLoadClass *load_class = (VipsForeignLoadClass *) class;

	gobject_class->set_property = vips_object_set_property;
	gobject_class->get_property = vips_object_get_property;

	object_class->nickname = "tiffload";
	object_class->description = _("load tiff from file");
	object_class->build = vips_foreign_load_tiff_file_build;

	foreign_class->suffs = vips__foreign_tiff_suffs;

	load_class->is_a = vips_foreign_load_tiff_file_is_a;

	VIPS_ARG_STRING(class, "filename", 1,
		_("Filename"),
		_("Filename to load from"),
		VIPS_ARGUMENT_REQUIRED_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiffFile, filename),
		NULL);
}

static void
vips_foreign_load_tiff_file_init(VipsForeignLoadTiffFile *file)
{
}

typedef struct _VipsForeignLoadTiffBuffer {
	VipsForeignLoadTiff parent_object;

	/* Load from a buffer.
	 */
	VipsBlob *blob;

} VipsForeignLoadTiffBuffer;

typedef VipsForeignLoadTiffClass VipsForeignLoadTiffBufferClass;

G_DEFINE_TYPE(VipsForeignLoadTiffBuffer, vips_foreign_load_tiff_buffer,
	vips_foreign_load_tiff_get_type());

static int
vips_foreign_load_tiff_buffer_build(VipsObject *object)
{
	VipsForeignLoadTiff *tiff = (VipsForeignLoadTiff *) object;
	VipsForeignLoadTiffBuffer *buffer =
		(VipsForeignLoadTiffBuffer *) object;

	if (buffer->blob &&
		!(tiff->source = vips_source_new_from_memory(
			  VIPS_AREA(buffer->blob)->data,
			  VIPS_AREA(buffer->blob)->length)))
		return -1;

	if (VIPS_OBJECT_CLASS(vips_foreign_load_tiff_buffer_parent_class)
			->build(object))
		return -1;

	return 0;
}

static gboolean
vips_foreign_load_tiff_buffer_is_a_buffer(const void *buf, size_t len)
{
	VipsSource *source;
	gboolean result;

	if (!(source = vips_source_new_from_memory(buf, len)))
		return FALSE;
	result = vips_foreign_load_tiff_source_is_a_source(source);
	VIPS_UNREF(source);

	return result;
}

static void
vips_foreign_load_tiff_buffer_class_init(
	VipsForeignLoadTiffBufferClass *class)
{
	GObjectClass *gobject_class = G_OBJECT_CLASS(class);
	VipsObjectClass *object_class = (VipsObjectClass *) class;
	VipsForeignLoadClass *load_class = (VipsForeignLoadClass *) class;

	gobject_class->set_property = vips_object_set_property;
	gobject_class->get_property = vips_object_get_property;

	object_class->nickname = "tiffload_buffer";
	object_class->description = _("load tiff from buffer");
	object_class->build = vips_foreign_load_tiff_buffer_build;

	load_class->is_a_buffer = vips_foreign_load_tiff_buffer_is_a_buffer;

	VIPS_ARG_BOXED(class, "buffer", 1,
		_("Buffer"),
		_("Buffer to load from"),
		VIPS_ARGUMENT_REQUIRED_INPUT,
		G_STRUCT_OFFSET(VipsForeignLoadTiffBuffer, blob),
		VIPS_TYPE_BLOB);
}

static void
vips_foreign_load_tiff_buffer_init(VipsForeignLoadTiffBuffer *buffer)
{
}

#endif /*HAVE_TIFF*/

/**
 * vips_tiffload:
 * @filename: file to load
 * @out: (out): decompressed image
 * @...: %NULL-terminated list of optional named arguments
 *
 * Optional arguments:
 *
 * * @page: %gint, load this page
 * * @n: %gint, load this many pages
 * * @autorotate: %gboolean, use orientation tag to rotate the image
 *   during load
 * * @subifd: %gint, select this subifd index
 *
 * Read a TIFF file into a VIPS image. It is a full baseline TIFF 6 reader,
 * with extensions for tiled images, multipage images, XYZ and LAB colour
 * space, pyramidal images and JPEG compression, including CMYK and YCbCr.
 *
 * @page means load this page from the file. By default the first page (page
 * 0) is read.
 *
 * @n means load this many pages. By default a single page is read. All the
 * pages must have the same dimensions, and they are loaded as a tall, thin
 * "toilet roll" image. The #VIPS_META_PAGE_HEIGHT metadata
 * tag gives the height in pixels of each page. Use -1 to load all pages.
 *
 * Setting @autorotate to %TRUE will make the loader interpret the
 * orientation tag and automatically rotate the image appropriately during
 * load.
 *
 * If @autorotate is %FALSE, the metadata field #VIPS_META_ORIENTATION is set
 * to the value of the orientation tag. Applications may read and interpret
 * this field
 * as they wish later in processing. See vips_autorot(). Save
 * operations will use #VIPS_META_ORIENTATION, if present, to set the
 * orientation of output images.
 *
 * If @autorotate is TRUE, the image will be rotated upright during load and
 * no metadata attached. This can be very slow.
 *
 * If @subifd is -1 (the default), the main image is selected for each page.
 * If it is 0 or greater and there is a SUBIFD tag, the indexed SUBIFD is
 * selected. This can be used to read lower resolution layers from
 * bioformats-style image pyramids.
 *
 * Any ICC profile is read and attached to the VIPS image as
 * #VIPS_META_ICC_NAME. Any XMP metadata is read and attached to the image
 * as #VIPS_META_XMP_NAME. Any IPTC is attached as #VIPS_META_IPTC_NAME. The
 * image description is
 * attached as #VIPS_META_IMAGEDESCRIPTION. Data in the photoshop tag is
 * attached as #VIPS_META_PHOTOSHOP_NAME.
 *
 * See also: vips_image_new_from_file(), vips_autorot().
 *
 * Returns: 0 on success, -1 on error.
 */
int
vips_tiffload(const char *filename, VipsImage **out, ...)
{
	va_list ap;
	int result;

	va_start(ap, out);
	result = vips_call_split("tiffload", ap, filename, out);
	va_end(ap);

	return result;
}

/**
 * vips_tiffload_buffer:
 * @buf: (array length=len) (element-type guint8): memory area to load
 * @len: (type gsize): size of memory area
 * @out: (out): image to write
 * @...: %NULL-terminated list of optional named arguments
 *
 * Optional arguments:
 *
 * * @page: %gint, load this page
 * * @n: %gint, load this many pages
 * * @autorotate: %gboolean, use orientation tag to rotate the image
 *   during load
 * * @subifd: %gint, select this subifd index
 *
 * Read a TIFF-formatted memory block into a VIPS image. Exactly as
 * vips_tiffload(), but read from a memory source.
 *
 * You must not free the buffer while @out is active. The
 * #VipsObject::postclose signal on @out is a good place to free.
 *
 * See also: vips_tiffload().
 *
 * Returns: 0 on success, -1 on error.
 */
int
vips_tiffload_buffer(void *buf, size_t len, VipsImage **out, ...)
{
	va_list ap;
	VipsBlob *blob;
	int result;

	/* We don't take a copy of the data or free it.
	 */
	blob = vips_blob_new(NULL, buf, len);

	va_start(ap, out);
	result = vips_call_split("tiffload_buffer", ap, blob, out);
	va_end(ap);

	vips_area_unref(VIPS_AREA(blob));

	return result;
}

/**
 * vips_tiffload_source:
 * @source: source to load
 * @out: (out): image to write
 * @...: %NULL-terminated list of optional named arguments
 *
 * Optional arguments:
 *
 * * @page: %gint, load this page
 * * @n: %gint, load this many pages
 * * @autorotate: %gboolean, use orientation tag to rotate the image
 *   during load
 * * @subifd: %gint, select this subifd index
 *
 * Exactly as vips_tiffload(), but read from a source.
 *
 * See also: vips_tiffload().
 *
 * Returns: 0 on success, -1 on error.
 */
int
vips_tiffload_source(VipsSource *source, VipsImage **out, ...)
{
	va_list ap;
	int result;

	va_start(ap, out);
	result = vips_call_split("tiffload_source", ap, source, out);
	va_end(ap);

	return result;
}