libvips/libsrc/format/format.c

/* VIPS function dispatch tables for image format load/save.
 */

/*

    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

/*

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

 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>

#include <stdio.h>

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

#ifdef WITH_DMALLOC
#include <dmalloc.h>
#endif /*WITH_DMALLOC*/

/* List of loaded formats.
 */
static GSList *format_list = NULL;

static gint
format_compare( im_format_t *a, im_format_t *b )
{
        return( b->priority - a->priority );
}

/* Sort the format list after a change.
 */
static void
format_sort( void )
{
	format_list = g_slist_sort( format_list, 
		(GCompareFunc) format_compare );
}

/* Register/unregister formats.
 */
im_format_t *
im_format_register( 
	const char *name, const char *name_user, const char **suffs,
	im_format_is_a_fn is_a, im_format_header_fn header,
	im_format_load_fn load, im_format_save_fn save,
	im_format_flags_fn flags )
{
	im_format_t *format;

	if( !(format = IM_NEW( NULL, im_format_t )) )
		return( NULL );
	format->name = name;
	format->name_user = name_user;
	format->priority = 0;
	format->suffs = suffs; 
	format->is_a = is_a;
	format->header = header;
	format->load = load;
	format->save = save;
	format->flags = flags;

	/* Append, so we keep the ordering where possible.
	 */
	format_list = g_slist_append( format_list, format );
	format_sort();

	return( format );
}

void 
im_format_set_priority( im_format_t *format, int priority )
{
	g_assert( format );

	format->priority = priority;
	format_sort();
}

void 
im_format_unregister( im_format_t *format )
{
	format_list = g_slist_remove( format_list, format );
	IM_FREE( format );
}

static const char *vips_suffs[] = { ".v", NULL };

static int
file2vips( const char *filename, IMAGE *out )
{
	IMAGE *im;

	if( !(im = im_open_local( out, filename, "r" )) ||
		im_copy( im, out ) )
		return( -1 );

	return( 0 );
}

static int
vips2file( IMAGE *im, const char *filename )
{
	IMAGE *out;

	if( !(out = im_open_local( im, filename, "w" )) ||
		im_copy( im, out ) )
		return( -1 );

	return( 0 );
}

static im_format_flags
vips_flags( const char *filename )
{
	return( IM_FORMAT_FLAG_PARTIAL );
}

/* Called on startup: register the base vips formats.
 */
void
im__format_init( void )
{
	im_format_register( 
		"vips",			/* internal name */
		_( "VIPS" ),		/* i18n'd visible name */
		vips_suffs,		/* Allowed suffixes */
		im_isvips,		/* is_a */
		file2vips,		/* Load header only */
		file2vips,		/* Load */
		vips2file,		/* Save */
		vips_flags		/* Flags */
	);

#ifdef HAVE_JPEG
	im__jpeg_register();
#endif /*HAVE_JPEG*/
#ifdef HAVE_PNG
	im__png_register();
#endif /*HAVE_PNG*/
	im__csv_register();
	im__ppm_register();
	im__analyze_register();
#ifdef HAVE_OPENEXR
	im__exr_register();
#endif /*HAVE_OPENEXR*/
#ifdef HAVE_MAGICK
	im__magick_register();
#endif /*HAVE_MAGICK*/
#ifdef HAVE_TIFF
	im__tiff_register();
#endif /*HAVE_TIFF*/
}

/* Map a function over all formats. 
 */
void *
im_format_map( VSListMap2Fn fn, void *a, void *b )
{
	return( im_slist_map2( format_list, fn, a, b ) );
}

/* Can this format open this file?
 */
static void *
format_for_file_sub( im_format_t *format, 
	const char *name, const char *filename )
{
	if( format->is_a ) {
		if( format->is_a( filename ) ) 
			return( format );
	}
	else if( im_filename_suffix_match( filename, format->suffs ) )
		return( format );

	return( NULL );
}

im_format_t *
im_format_for_file( const char *name )
{
	char filename[FILENAME_MAX];
	char options[FILENAME_MAX];
	im_format_t *format;

	/* Break any options off the name ... eg. "fred.tif:jpeg,tile" 
	 * etc.
	 */
	im_filename_split( name, filename, options );

	if( !im_existsf( "%s", filename ) ) {
		im_error( "im_format_for_file", 
			_( "\"%s\" is not readable" ), filename );
		return( NULL );
	}

	if( !(format = (im_format_t *) im_format_map( 
		(VSListMap2Fn) format_for_file_sub, 
		(void *) name, (void *) filename )) ) {
		im_error( "im_format_for_file", 
			_( "\"%s\" is not in a supported format" ), filename );
		return( NULL );
	}

	return( format );
}

/* Can we write this filename with this format? Ignore formats without a save
 * method.
 */
static void *
format_for_name_sub( im_format_t *format, const char *name )
{
	if( format->save &&
		im_filename_suffix_match( name, format->suffs ) )
		return( format );

	return( NULL );
}

im_format_t *
im_format_for_name( const char *name )
{
	im_format_t *format;

	if( !(format = (im_format_t *) im_format_map( 
		(VSListMap2Fn) format_for_name_sub, (void *) name, NULL )) ) {
		char suffix[FILENAME_MAX];

		im_filename_suffix( name, suffix );
		im_error( "im_format_for_name",
			_( "\"%s\" is not a supported image format." ), 
			suffix );

		return( NULL );
	}

	return( format );
}

int
im_format_read( const char *name, IMAGE *out )
{
	im_format_t *format;

	if( !(format = im_format_for_file( name )) || 
		format->load( name, out ) )
		return( -1 );

	return( 0 );
}

int
im_format_write( IMAGE *im, const char *name )
{
	im_format_t *format;

	if( !(format = im_format_for_name( name )) || 
		format->save( im, name ) ) 
		return( -1 );

	return( 0 );
}