starting to factor out VipsArea

This commit is contained in:
John Cupitt 2011-10-27 22:13:21 +01:00
parent 5821f6cb40
commit 7dcda5c0c9
5 changed files with 796 additions and 35 deletions

4
TODO
View File

@ -1,3 +1,7 @@
- started factoring VipsArea out into area.[hc]
- bandjoin needs testing
see vips_bandjoin() .. ugly!

View File

@ -0,0 +1,79 @@
/* area.h
*
* 27/10/11
* - from header.h
*/
/*
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
*/
#ifndef VIPS_AREA_H
#define VIPS_AREA_H
#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/
/* Also used for eg. vips_local() and friends.
*/
typedef int (*VipsCallbackFn)( void *a, void *b );
/* A ref-counted area of memory. Can hold arrays of things as well.
*/
typedef struct _VipsArea {
void *data;
size_t length; /* 0 if not known */
/* If this area represents an array, the number of elements in the
* array. Equal to length / sizeof(element).
*/
int n;
/*< private >*/
/* Reference count.
*/
int count;
/* Things like ICC profiles need their own free functions.
*/
VipsCallbackFn free_fn;
/* If we are holding an array (for exmaple, an array of double), the
* GType of the elements and their size. 0 for not known.
*
* n is always length / sizeof_type, we keep it as a member for
* convenience.
*/
GType type;
size_t sizeof_type;
} VipsArea;
#ifdef __cplusplus
}
#endif /*__cplusplus*/
#endif /*VIPS_AREA_H*/

View File

@ -77,41 +77,6 @@ extern "C" {
*/
#define VIPS_META_RESOLUTION_UNIT "resolution-unit"
/* Also used for eg. vips_local() and friends.
*/
typedef int (*VipsCallbackFn)( void *a, void *b );
/* A ref-counted area of memory.
*/
typedef struct _VipsArea {
void *data;
size_t length; /* 0 if not known */
/* If this area represents an array, the number of elements in the
* array. Equal to length / sizeof(element).
*/
int n;
/*< private >*/
/* Reference count.
*/
int count;
/* Things like ICC profiles need their own free functions.
*/
VipsCallbackFn free_fn;
/* If we are holding an array (for exmaple, an array of double), the
* GType of the elements and their size. 0 for not known.
*
* n is always length / sizeof_type, we keep it as a member for
* convenience.
*/
GType type;
size_t sizeof_type;
} VipsArea;
int vips_format_sizeof( VipsBandFormat format );
int vips_image_get_width( const VipsImage *image );

View File

@ -97,6 +97,7 @@ extern "C" {
#include <vips/buf.h>
#include <vips/util.h>
#include <vips/object.h>
#include <vips/area.h>
#include <vips/pool.h>
#include <vips/version.h>

712
libvips/iofuncs/array.c Normal file
View File

@ -0,0 +1,712 @@
/* array type
*
* Unlike GArray, this has fixed length, tracks a GType for emements, and has
* a per-element free function.
*
* 27/10/11
* - from header.c
*/
/*
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
*/
/*
#define VIPS_DEBUG
#define DEBUG
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <vips/vips.h>
#include <vips/internal.h>
#include <vips/debug.h>
/**
* SECTION: VipsArea
* @short_description: an area of memory
* @stability: Stable
* @see_also: <link linkend="libvips-meta">header</link>,
* @include: vips/vips.h
*
* A VipsArea wraps a chunk of memory. It adds reference counting and a free
* function. It also keeps a count and a GType, so the area can be an array.
*
* This type is used for things like passing an array of double or an array of
* VipsObject pointers to operations.
*
*/
#ifdef DEBUG
static int vips_area_number = 0;
#endif /*DEBUG*/
VipsArea *
vips_area_copy( VipsArea *area )
{
g_assert( area->count >= 0 );
area->count += 1;
#ifdef DEBUG
printf( "vips_area_copy: %p count = %d\n", area, area->count );
#endif /*DEBUG*/
return( area );
}
void
vips_area_unref( VipsArea *area )
{
g_assert( area->count > 0 );
area->count -= 1;
#ifdef DEBUG
printf( "vips_area_unref: %p count = %d\n", area, area->count );
#endif /*DEBUG*/
if( area->count == 0 )
if( area->free_fn )
VIPS_FREEF( area->free_fn, area->data );
area->free_fn = NULL;
g_free( area );
#ifdef DEBUG
vips_area_number -= 1;
printf( "vips_area_unref: free .. total = %d\n",
vips_area_number );
#endif /*DEBUG*/
}
}
/* An area of mem with a free func. (eg. \0-terminated string, or a struct).
* Inital count == 1, so _unref() after attaching somewhere.
*/
VipsArea *
vips_area_new( VipsCallbackFn free_fn, void *data )
{
VipsArea *area;
area = g_new( VipsArea, 1 );
area->count = 1;
area->length = 0;
area->data = data;
area->free_fn = free_fn;
area->type = 0;
area->sizeof_type = 0;
#ifdef DEBUG
vips_area_number += 1;
printf( "area_new: %p count = %d (%d in total)\n",
area, area->count, vips_area_number );
#endif /*DEBUG*/
return( area );
}
/* An area of mem with a free func and a length (some sort of binary object,
* like an ICC profile).
*/
VipsArea *
vips_area_new_blob( VipsCallbackFn free_fn, void *blob, size_t blob_length )
{
VipsArea *area;
area = area_new( free_fn, blob );
area->length = blob_length;
return( area );
}
/* An area which holds an array of elements of some GType. To set the
* elements, get the pointer and write.
*/
VipsArea *
vips_area_new_array( GType type, size_t sizeof_type, int n )
{
VipsArea *area;
void *array;
array = g_malloc( n * sizeof_type );
area = area_new( (VipsCallbackFn) g_free, array );
area->n = n;
area->length = n * sizeof_type;
area->type = type;
area->sizeof_type = sizeof_type;
return( area );
}
static void
vips_area_free_array_object( VipsArea *area )
{
GObject **array = (GObject **) area->data;
int i;
for( i = 0; i < area->n; i++ )
VIPS_FREEF( g_object_unref, array[i] );
g_free( area );
}
/* An area which holds an array of GObjects.
*/
VipsArea *
vips_area_new_array_object( int n )
{
GObject **array;
VipsArea *area;
array = g_new0( GObject *, n );
area = area_new( (VipsCallbackFn) vips_array_object_free, array );
area->n = n;
area->length = n * sizeof( GObject * );
area->type = G_TYPE_OBJECT;
area->sizeof_type = sizeof( GObject * );
return( area );
}
/* Set value to be a ref-counted area of memory with a free function.
*/
int
vips_value_set_area( GValue *value, VipsCallbackFn free_fn, void *data )
{
VipsArea *area;
area = area_new( free_fn, data );
g_value_init( value, VIPS_TYPE_AREA );
g_value_set_boxed( value, area );
vips_area_unref( area );
return( 0 );
}
/* Don't touch count (area is static).
*/
void *
vips_value_get_area( const GValue *value, size_t *length )
{
VipsArea *area;
area = g_value_get_boxed( value );
if( length )
*length = area->length;
return( area->data );
}
/* Transform an area to a G_TYPE_STRING.
*/
static void
transform_area_g_string( const GValue *src_value, GValue *dest_value )
{
VipsArea *area;
char buf[256];
area = g_value_get_boxed( src_value );
vips_snprintf( buf, 256, "VIPS_TYPE_AREA, count = %d, data = %p",
area->count, area->data );
g_value_set_string( dest_value, buf );
}
GType
vips_area_get_type( void )
{
static GType type = 0;
if( !type ) {
type = g_boxed_type_register_static( "vips_area",
(GBoxedCopyFunc) vips_area_copy,
(GBoxedFreeFunc) vips_area_unref );
g_value_register_transform_func( type, G_TYPE_STRING,
transform_area_g_string );
}
return( type );
}
/**
* vips_value_get_ref_string:
* @value: GValue to get from
*
* Get the C string held internally by the GValue.
*
* Returns: The C string held by @value. This must not be freed.
*/
const char *
vips_value_get_ref_string( const GValue *value, size_t *length )
{
return( vips_value_get_area( value, length ) );
}
/**
* vips_value_set_ref_string:
* @value: GValue to set
* @str: C string to copy into the GValue
*
* Copies the C string @str into @value.
*
* vips_ref_string are immutable C strings that are copied between images by
* copying reference-counted pointers, making the much more efficient than
* regular GValue strings.
*
* Returns: 0 on success, -1 otherwise.
*/
int
vips_value_set_ref_string( GValue *value, const char *str )
{
VipsArea *area;
char *str_copy;
g_assert( G_VALUE_TYPE( value ) == VIPS_TYPE_REF_STRING );
str_copy = g_strdup( str );
area = area_new( (VipsCallbackFn) vips_free, str_copy );
/* Handy place to cache this.
*/
area->length = strlen( str );
g_value_set_boxed( value, area );
vips_area_unref( area );
return( 0 );
}
/* Transform a refstring to a G_TYPE_STRING and back.
*/
static void
transform_ref_string_g_string( const GValue *src_value, GValue *dest_value )
{
g_value_set_string( dest_value,
vips_value_get_ref_string( src_value ) );
}
static void
transform_g_string_ref_string( const GValue *src_value, GValue *dest_value )
{
vips_value_set_ref_string( dest_value,
g_value_get_string( src_value ) );
}
/* To a save string.
*/
static void
transform_ref_string_save_string( const GValue *src_value, GValue *dest_value )
{
vips_value_set_save_stringf( dest_value,
"%s", vips_value_get_ref_string( src_value, NULL ) );
}
static void
transform_save_string_ref_string( const GValue *src_value, GValue *dest_value )
{
vips_value_set_ref_string( dest_value,
vips_value_get_save_string( src_value ) );
}
GType
vips_ref_string_get_type( void )
{
static GType type = 0;
if( !type ) {
type = g_boxed_type_register_static( "vips_ref_string",
(GBoxedCopyFunc) vips_area_copy,
(GBoxedFreeFunc) vips_area_unref );
g_value_register_transform_func( type, G_TYPE_STRING,
transform_ref_string_g_string );
g_value_register_transform_func( G_TYPE_STRING, type,
transform_g_string_ref_string );
g_value_register_transform_func( type, VIPS_TYPE_SAVE_STRING,
transform_ref_string_save_string );
g_value_register_transform_func( VIPS_TYPE_SAVE_STRING, type,
transform_save_string_ref_string );
}
return( type );
}
/**
* vips_blob_set:
* @value: GValue to set
* @free_fn: free function for @data
* @data: pointer to area of memory
* @length: length of memory area
*
* Sets @value to hold a pointer to @blob. When @value is freed, @blob will be
* freed with @free_fn. @value also holds a note of the length of the memory
* area.
*
* blobs are things like ICC profiles or EXIF data. They are relocatable, and
* are saved to VIPS files for you coded as base64 inside the XML. They are
* copied by copying reference-counted pointers.
*
* See also: vips_value_get_area()
*
* Returns: 0 on success, -1 otherwise.
*/
int
vips_value_set_blob( GValue *value,
VipsCallbackFn free_fn, void *data, size_t length )
{
VipsArea *area;
g_assert( G_VALUE_TYPE( value ) == VIPS_TYPE_BLOB );
area = area_new_blob( free_fn, data, length );
g_value_set_boxed( value, area );
vips_area_unref( area );
return( 0 );
}
/* Transform a blob to a G_TYPE_STRING.
*/
static void
transform_blob_g_string( const GValue *src_value, GValue *dest_value )
{
void *blob;
size_t blob_length;
char buf[256];
blob = vips_blob_get( src_value, &blob_length );
vips_snprintf( buf, 256, "VIPS_TYPE_BLOB, data = %p, length = %zd",
blob, blob_length );
g_value_set_string( dest_value, buf );
}
/* Transform a blob to a save string and back.
*/
static void
transform_blob_save_string( const GValue *src_value, GValue *dest_value )
{
void *blob;
size_t blob_length;
char *b64;
blob = vips_value_get_area( src_value, &blob_length );
if( (b64 = vips__b64_encode( blob, blob_length )) ) {
vips_save_string_set( dest_value, b64 );
vips_free( b64 );
}
}
static void
transform_save_string_blob( const GValue *src_value, GValue *dest_value )
{
const char *b64;
void *blob;
size_t blob_length;
b64 = vips_save_string_get( src_value );
if( (blob = vips__b64_decode( b64, &blob_length )) )
vips_blob_set( dest_value,
(VipsCallbackFn) vips_free, blob, blob_length );
}
GType
vips_blob_get_type( void )
{
static GType type = 0;
if( !type ) {
type = g_boxed_type_register_static( "vips_blob",
(GBoxedCopyFunc) vips_area_copy,
(GBoxedFreeFunc) vips_area_unref );
g_value_register_transform_func( type, G_TYPE_STRING,
transform_blob_g_string );
g_value_register_transform_func( type, VIPS_TYPE_SAVE_STRING,
transform_blob_save_string );
g_value_register_transform_func( VIPS_TYPE_SAVE_STRING, type,
transform_save_string_blob );
}
return( type );
}
/* Set value to be an array of things. Don't initialise the contents: get the
* pointer and write instead.
*/
int
vips_value_set_array( GValue *value, GType type, size_t sizeof_type, int n )
{
VipsArea *area;
area = vips_area_new_array( type, sizeof_type, n );
g_value_set_boxed( value, area );
vips_area_unref( area );
return( 0 );
}
void *
vips_value_get_array( const GValue *value,
int *n, GType *type, size_t *sizeof_type )
{
VipsArea *area;
/* Can't check value type, because we may get called from
* vips_*_get_type().
*/
area = g_value_get_boxed( value );
if( n )
*n = area->n;
if( type )
*type = area->type;
if( sizeof_type )
*sizeof_type = area->sizeof_type;
return( area->data );
}
/**
* vips_value_get_array_double:
* @value: #GValue to get from
* @n: return the number of elements here, optionally
*
* Return the start of the array of doubles held by @value.
* optionally return the number of elements in @n.
*
* See also: vips_array_double_set().
*
* Returns: The array address.
*/
double *
vips_value_get_array_double( const GValue *value, int *n )
{
return( vips_array_get( value, n, NULL, NULL ) );
}
/**
* vips_value_set_array_double:
* @value: #GValue to get from
* @array: array of doubles
* @n: the number of elements
*
* Set @value to hold a copy of @array. Pass in the array length in @n.
*
* See also: vips_array_double_get().
*
* Returns: 0 on success, -1 otherwise.
*/
int
vips_value_set_array_double( GValue *value, const double *array, int n )
{
double *array_copy;
g_value_init( value, VIPS_TYPE_ARRAY_DOUBLE );
vips_array_set( value, G_TYPE_DOUBLE, sizeof( double ), n );
array_copy = vips_array_double_get( value, NULL );
memcpy( array_copy, array, n * sizeof( double ) );
return( 0 );
}
static void
transform_array_g_string( const GValue *src_value, GValue *dest_value )
{
char *array;
int n;
GType type;
size_t sizeof_type;
char txt[1024];
VipsBuf buf = VIPS_BUF_STATIC( txt );
int i;
array = (char *) vips_array_get( src_value,
&n, &type, &sizeof_type );
for( i = 0; i < n; i++ ) {
GValue value = { 0, };
char *str;
if( i > 0 )
vips_buf_appends( &buf, ", " );
g_value_init( &value, type );
g_value_set_instance( &value, array );
str = g_strdup_value_contents( &value );
vips_buf_appends( &buf, str );
g_free( str );
g_value_unset( &value );
array += sizeof_type;
}
g_value_set_string( dest_value, vips_buf_all( &buf ) );
}
/* It'd be great to be able to write a generic string->array function, but
* it doesn't seem possible.
*/
static void
transform_g_string_array_double( const GValue *src_value, GValue *dest_value )
{
const char *str = g_value_get_string( src_value );
int n;
const char *p;
int i;
double *array;
/* Walk the string to get the number of elements. Empty string is zero
* elements.
*/
for( n = 0, p = str; p && *p; n += 1 ) {
p = strchr( p, ',' );
if( p )
p += 1;
}
vips_array_set( dest_value, G_TYPE_DOUBLE, sizeof( double ), n );
array = (double *) vips_array_get( dest_value, NULL, NULL, NULL );
p = str;
for( i = 0; i < n; i++ ) {
array[i] = atof( p );
p = strchr( p, ',' );
if( p )
p += 1;
}
}
GType
vips_array_double_get_type( void )
{
static GType type = 0;
if( !type ) {
type = g_boxed_type_register_static( "vips_array_double",
(GBoxedCopyFunc) vips_area_copy,
(GBoxedFreeFunc) vips_area_unref );
g_value_register_transform_func( type, G_TYPE_STRING,
transform_array_g_string );
g_value_register_transform_func( G_TYPE_STRING, type,
transform_g_string_array_double );
}
return( type );
}
/**
* vips_array_object_get:
* @value: #GValue to get from
* @n: return the number of elements here, optionally
*
* Return the start of the array of #GObject held by @value.
* optionally return the number of elements in @n.
*
* See also: vips_array_object_set().
*
* Returns: The array address.
*/
GObject **
vips_array_object_get( const GValue *value, int *n )
{
return( vips_array_get( value, n, NULL, NULL ) );
}
/**
* vips_array_object_set:
* @value: #GValue to set
* @n: the number of elements
*
* Set @value to hold an array of GObject. Pass in the array length in @n.
*
* See also: vips_array_object_get().
*
* Returns: 0 on success, -1 otherwise.
*/
int
vips_array_object_set( GValue *value, int n )
{
VipsArea *area;
if( !(area = vips_array_object_new( n )) )
return( -1 );
g_value_set_boxed( value, area );
vips_area_unref( area );
return( 0 );
}
static void
transform_g_string_array_image( const GValue *src_value, GValue *dest_value )
{
char *str;
int n;
char *p, *q;
int i;
GObject **array;
/* We need a copy of the string, since we insert \0 during
* scan.
*/
str = g_strdup_value_contents( src_value );
for( n = 0; (q = vips_break_token( p, " " )); n++, p = q )
;
g_free( str );
vips_array_object_set( dest_value, n );
array = vips_array_object_get( dest_value, NULL );
str = g_strdup_value_contents( src_value );
for( i = 0; (q = vips_break_token( p, " " )); i++, p = q )
/* Sadly there's no error return possible here.
*/
array[i] = G_OBJECT( vips_image_new_from_file( p ) );
g_free( str );
}
GType
vips_array_image_get_type( void )
{
static GType type = 0;
if( !type ) {
type = g_boxed_type_register_static( "vips_array_image",
(GBoxedCopyFunc) vips_area_copy,
(GBoxedFreeFunc) vips_area_unref );
g_value_register_transform_func( G_TYPE_STRING, type,
transform_g_string_array_image );
}
return( type );
}