libvips/libvips/include/vips/type.h

306 lines
7.5 KiB
C

/* the GTypes we define
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
*/
/*
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
*/
#ifndef VIPS_TYPE_H
#define VIPS_TYPE_H
#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/
/* A very simple boxed type for testing. Just holds an int.
*/
typedef struct _VipsThing {
int i;
} VipsThing;
/**
* VIPS_TYPE_THING:
*
* The #GType for a #VipsThing.
*/
#define VIPS_TYPE_THING (vips_thing_get_type())
VIPS_API
GType vips_thing_get_type(void);
VIPS_API
VipsThing *vips_thing_new( int i );
/* 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 and lock.
*
* We could use an atomic int, but this is not a high-traffic data
* structure, so a simple GMutex is OK.
*/
int count;
GMutex *lock;
/* Things like ICC profiles need their own free functions.
*
* Set client to anything you like -- VipsArea doesn't use this.
*/
VipsCallbackFn free_fn;
void *client;
/* If we are holding an array (for example, 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;
VIPS_API
VipsArea *vips_area_copy( VipsArea *area );
VIPS_API
int vips_area_free_cb( void *mem, VipsArea *area );
VIPS_API
void vips_area_unref( VipsArea *area );
VIPS_API
VipsArea *vips_area_new( VipsCallbackFn free_fn, void *data );
VIPS_API
VipsArea *vips_area_new_array( GType type, size_t sizeof_type, int n );
VIPS_API
VipsArea *vips_area_new_array_object( int n );
VIPS_API
void *vips_area_get_data( VipsArea *area,
size_t *length, int *n, GType *type, size_t *sizeof_type );
#ifdef VIPS_DEBUG
#define VIPS_ARRAY_ADDR( X, I ) \
(((I) >= 0 && (I) < VIPS_AREA( X )->n) ? \
(void *) ((VipsPel *) VIPS_AREA( X )->data + \
VIPS_AREA( X )->sizeof_type * (I)) : \
(fprintf( stderr, \
"VIPS_ARRAY_ADDR: index out of bounds, " \
"file \"%s\", line %d\n" \
"(index %d should have been within [0,%d])\n", \
__FILE__, __LINE__, \
(I), VIPS_AREA( X )->n ), NULL ))
#else /*!VIPS_DEBUG*/
#define VIPS_ARRAY_ADDR( X, I ) \
((void *) \
((VipsPel *) VIPS_AREA( X )->data + VIPS_AREA( X )->sizeof_type * (I)))
#endif /*VIPS_DEBUG*/
/**
* VIPS_TYPE_AREA:
*
* The #GType for a #VipsArea.
*/
#define VIPS_TYPE_AREA (vips_area_get_type())
#define VIPS_AREA( X ) ((VipsArea *) (X))
VIPS_API
GType vips_area_get_type(void);
/**
* VIPS_TYPE_SAVE_STRING:
*
* The #GType for a #VipsSaveString.
*/
#define VIPS_TYPE_SAVE_STRING (vips_save_string_get_type())
VIPS_API
GType vips_save_string_get_type(void);
/**
* VIPS_TYPE_REF_STRING:
*
* The #GType for a #VipsRefString.
*/
#define VIPS_TYPE_REF_STRING (vips_ref_string_get_type())
typedef struct _VipsRefString {
VipsArea area;
} VipsRefString;
VIPS_API
VipsRefString *vips_ref_string_new( const char *str );
VIPS_API
const char *vips_ref_string_get( VipsRefString *refstr, size_t *length );
VIPS_API
GType vips_ref_string_get_type(void);
/**
* VIPS_TYPE_BLOB:
*
* The %GType for a #VipsBlob.
*/
#define VIPS_TYPE_BLOB (vips_blob_get_type())
typedef struct _VipsBlob {
VipsArea area;
} VipsBlob;
VIPS_API
VipsBlob *vips_blob_new( VipsCallbackFn free_fn,
const void *data, size_t length );
VIPS_API
VipsBlob *vips_blob_copy( const void *data, size_t length );
VIPS_API
const void *vips_blob_get( VipsBlob *blob, size_t *length );
VIPS_API
void vips_blob_set( VipsBlob *blob,
VipsCallbackFn free_fn, const void *data, size_t length );
VIPS_API
GType vips_blob_get_type(void);
/**
* VIPS_TYPE_ARRAY_DOUBLE:
*
* The #GType for a #VipsArrayDouble.
*/
#define VIPS_TYPE_ARRAY_DOUBLE (vips_array_double_get_type())
typedef struct _VipsArrayDouble {
VipsArea area;
} VipsArrayDouble;
VIPS_API
VipsArrayDouble *vips_array_double_new( const double *array, int n );
VIPS_API
VipsArrayDouble *vips_array_double_newv( int n, ... );
VIPS_API
double *vips_array_double_get( VipsArrayDouble *array, int *n );
VIPS_API
GType vips_array_double_get_type(void);
/**
* VIPS_TYPE_ARRAY_INT:
*
* The #GType for a #VipsArrayInt.
*/
#define VIPS_TYPE_ARRAY_INT (vips_array_int_get_type())
typedef struct _VipsArrayInt {
VipsArea area;
} VipsArrayInt;
VIPS_API
VipsArrayInt *vips_array_int_new( const int *array, int n );
VIPS_API
VipsArrayInt *vips_array_int_newv( int n, ... );
VIPS_API
int *vips_array_int_get( VipsArrayInt *array, int *n );
VIPS_API
GType vips_array_int_get_type(void);
/**
* VIPS_TYPE_ARRAY_IMAGE:
*
* The #GType for a #VipsArrayImage.
*/
#define VIPS_TYPE_ARRAY_IMAGE (vips_array_image_get_type())
typedef struct _VipsArrayImage {
VipsArea area;
} VipsArrayImage;
/* See image.h for vips_array_image_new() etc., they need to be declared after
* VipsImage.
*/
VIPS_API
GType vips_array_image_get_type(void);
VIPS_API
void vips_value_set_area( GValue *value, VipsCallbackFn free_fn, void *data );
VIPS_API
void *vips_value_get_area( const GValue *value, size_t *length );
VIPS_API
const char *vips_value_get_save_string( const GValue *value );
VIPS_API
void vips_value_set_save_string( GValue *value, const char *str );
VIPS_API
void vips_value_set_save_stringf( GValue *value, const char *fmt, ... )
G_GNUC_PRINTF( 2, 3 );
VIPS_API
const char *vips_value_get_ref_string( const GValue *value, size_t *length );
VIPS_API
void vips_value_set_ref_string( GValue *value, const char *str );
VIPS_API
void *vips_value_get_blob( const GValue *value, size_t *length );
VIPS_API
void vips_value_set_blob( GValue *value,
VipsCallbackFn free_fn, const void *data, size_t length );
VIPS_API
void vips_value_set_blob_free( GValue *value, void *data, size_t length );
VIPS_API
void vips_value_set_array( GValue *value,
int n, GType type, size_t sizeof_type );
VIPS_API
void *vips_value_get_array( const GValue *value,
int *n, GType *type, size_t *sizeof_type );
VIPS_API
double *vips_value_get_array_double( const GValue *value, int *n );
VIPS_API
void vips_value_set_array_double( GValue *value, const double *array, int n );
VIPS_API
int *vips_value_get_array_int( const GValue *value, int *n );
VIPS_API
void vips_value_set_array_int( GValue *value, const int *array, int n );
VIPS_API
GObject **vips_value_get_array_object( const GValue *value, int *n );
VIPS_API
void vips_value_set_array_object( GValue *value, int n );
/* See also image.h, that has vips_array_image_get(), vips_array_image_new(),
* vips_value_get_array_image() and vips_value_set_array_image(). They need
* to be declared after VipsImage.
*/
#ifdef __cplusplus
}
#endif /*__cplusplus*/
#endif /*VIPS_TYPE_H*/