libvips/libvips/conversion/autorot.c

/* autorot
 *
 * 19/10/14
 * 	- from jpegload
 * 12/4/16
 * 	- test and remove orientation from every ifd
 * 6/10/18
 * 	- don't remove orientation if it's one of the cases we don't handle
 * 10/5/20
 * 	- handle mirrored images
 * 	- deprecate vips_autorot_get_angle()
 * 24/10/20
 * 	- only remove main image orientation, since we don't rotate the
 * 	  embedded thumbnail
 */

/*

    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 <string.h>

#include <vips/vips.h>

#include "pconversion.h"

typedef struct _VipsAutorot {
	VipsConversion parent_instance;

	VipsImage *in;

	VipsAngle angle;
	gboolean flip;

} VipsAutorot;

typedef VipsConversionClass VipsAutorotClass;

G_DEFINE_TYPE( VipsAutorot, vips_autorot, VIPS_TYPE_CONVERSION );

static void *
vips_autorot_remove_angle_sub( VipsImage *image, 
	const char *field, GValue *value, void *my_data )
{
	if( strcmp( field, "exif-ifd0-Orientation" ) == 0 ) {
#ifdef DEBUG
		printf( "vips_autorot_remove_angle: %s\n", field ); 
#endif /*DEBUG*/

		(void) vips_image_remove( image, field );
	}

	return( NULL );
}

/**
 * vips_autorot_remove_angle: (method)
 * @image: image to remove orientation from
 *
 * Remove the orientation tag on @image. Also remove any exif orientation tags.
 * You must vips_copy() the image before calling this function since it
 * modifies metadata.
 */
void
vips_autorot_remove_angle( VipsImage *image )
{
	(void) vips_image_remove( image, VIPS_META_ORIENTATION );
	(void) vips_image_map( image, vips_autorot_remove_angle_sub, NULL );
}

static int
vips_autorot_build( VipsObject *object )
{
	VipsConversion *conversion = VIPS_CONVERSION( object );
	VipsAutorot *autorot = (VipsAutorot *) object;
	VipsImage **t = (VipsImage **) vips_object_local_array( object, 3 );

	if( VIPS_OBJECT_CLASS( vips_autorot_parent_class )->build( object ) )
		return( -1 );
	
	VipsAngle angle;
	gboolean flip;
	VipsImage *in;

	in = autorot->in;

	switch( vips_image_get_orientation( in ) ) {
	case 2:
		angle = VIPS_ANGLE_D0;
		flip = TRUE;
		break;

	case 3:
		angle = VIPS_ANGLE_D180;
		flip = FALSE;
		break;

	case 4:
		angle = VIPS_ANGLE_D180;
		flip = TRUE;
		break;

	case 5:
		angle = VIPS_ANGLE_D90;
		flip = TRUE;
		break;

	case 6:
		angle = VIPS_ANGLE_D90;
		flip = FALSE;
		break;

	case 7:
		angle = VIPS_ANGLE_D270;
		flip = TRUE;
		break;

	case 8:
		angle = VIPS_ANGLE_D270;
		flip = FALSE;
		break;

	case 1:
	default:
		angle = VIPS_ANGLE_D0;
		flip = FALSE;
		break;

	}

	g_object_set( object,
		"angle", angle,
		"flip", flip,
		NULL );

	if( angle != VIPS_ANGLE_D0 ) {
		if( vips_rot( in, &t[0], angle, NULL ) )
			return( -1 );
		in = t[0];
	}

	if( flip ) { 
		if( vips_flip( in, &t[1], VIPS_DIRECTION_HORIZONTAL, NULL ) )
			return( -1 );
		in = t[1];
	}

	/* We must copy before modifying metadata.
	 */
	if( vips_copy( in, &t[2], NULL ) )
		return( -1 );
	in = t[2];

	vips_autorot_remove_angle( in );

	if( vips_image_write( in, conversion->out ) )
		return( -1 );

	return( 0 );
}

static void
vips_autorot_class_init( VipsAutorotClass *class )
{
	GObjectClass *gobject_class = G_OBJECT_CLASS( class );
	VipsObjectClass *vobject_class = VIPS_OBJECT_CLASS( class );

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

	vobject_class->nickname = "autorot";
	vobject_class->description = _( "autorotate image by exif tag" );
	vobject_class->build = vips_autorot_build;

	VIPS_ARG_IMAGE( class, "in", 1, 
		_( "Input" ), 
		_( "Input image" ),
		VIPS_ARGUMENT_REQUIRED_INPUT,
		G_STRUCT_OFFSET( VipsAutorot, in ) );

	VIPS_ARG_ENUM( class, "angle", 6, 
		_( "Angle" ), 
		_( "Angle image was rotated by" ),
		VIPS_ARGUMENT_OPTIONAL_OUTPUT,
		G_STRUCT_OFFSET( VipsAutorot, angle ),
		VIPS_TYPE_ANGLE, VIPS_ANGLE_D0 );

    VIPS_ARG_BOOL( class, "flip", 7,
		_( "Flip" ),
		_( "Whether the image was flipped or not" ),
		VIPS_ARGUMENT_OPTIONAL_OUTPUT,
		G_STRUCT_OFFSET( VipsAutorot, flip ),
		FALSE );
}

static void
vips_autorot_init( VipsAutorot *autorot )
{
	autorot->angle = VIPS_ANGLE_D0;
	autorot->flip = FALSE;
}

/**
 * vips_autorot: (method)
 * @in: input image
 * @out: (out): output image
 * @...: %NULL-terminated list of optional named arguments
 *
 * Optional arguments:
 *
 * * @angle: output #VipsAngle the image was rotated by
 * * @flip: output %gboolean whether the image was flipped 
 *
 * Look at the image metadata and rotate and flip the image to make it 
 * upright. The #VIPS_META_ORIENTATION tag is removed from @out to prevent 
 * accidental double rotation. 
 *
 * Read @angle to find the amount the image was rotated by. Read @flip to 
 * see if the image was also flipped.
 *
 * Returns: 0 on success, -1 on error
 */
int
vips_autorot( VipsImage *in, VipsImage **out, ... )
{
	va_list ap;
	int result;

	va_start( ap, out );
	result = vips_call_split( "autorot", ap, in, out );
	va_end( ap );

	return( result );
}