2017-01-03 19:36:22 +01:00
|
|
|
/* LIBGIMPBASE - The GIMP Basic Library
|
|
|
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
|
|
|
|
*
|
|
|
|
|
* gimpmetadata.h
|
|
|
|
|
* Copyright (C) 2013 Hartmut Kuhse <hartmutkuhse@src.gnome.org>
|
|
|
|
|
*
|
|
|
|
|
* This library 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 3 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This library 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 library. If not, see
|
2018-07-11 23:27:07 +02:00
|
|
|
* <https://www.gnu.org/licenses/>.
|
2017-01-03 19:36:22 +01:00
|
|
|
*/
|
2013-10-19 18:38:01 +02:00
|
|
|
|
2017-01-03 19:36:22 +01:00
|
|
|
#ifndef __GIMP_METADATA_H__
|
|
|
|
|
#define __GIMP_METADATA_H__
|
2013-10-19 18:38:01 +02:00
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2024-07-24 16:20:34 +02:00
|
|
|
#include <gexiv2/gexiv2.h>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#define GIMP_TYPE_METADATA (gimp_metadata_get_type ())
|
|
|
|
|
G_DECLARE_FINAL_TYPE (GimpMetadata, gimp_metadata, GIMP, METADATA, GExiv2Metadata)
|
2017-01-30 16:42:27 +01:00
|
|
|
|
2018-05-20 16:37:04 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GimpMetadataLoadFlags:
|
2023-08-05 18:58:57 +02:00
|
|
|
* @GIMP_METADATA_LOAD_NONE: Do not load the metadata
|
2018-05-20 16:37:04 +02:00
|
|
|
* @GIMP_METADATA_LOAD_COMMENT: Load the comment
|
|
|
|
|
* @GIMP_METADATA_LOAD_RESOLUTION: Load the resolution
|
|
|
|
|
* @GIMP_METADATA_LOAD_ORIENTATION: Load the orientation (rotation)
|
|
|
|
|
* @GIMP_METADATA_LOAD_COLORSPACE: Load the colorspace
|
|
|
|
|
* @GIMP_METADATA_LOAD_ALL: Load all of the above
|
|
|
|
|
*
|
|
|
|
|
* What metadata to load when importing images.
|
|
|
|
|
**/
|
2013-10-27 15:22:35 +01:00
|
|
|
typedef enum
|
|
|
|
|
{
|
2023-08-05 18:58:57 +02:00
|
|
|
GIMP_METADATA_LOAD_NONE = 0,
|
2013-10-27 15:22:35 +01:00
|
|
|
GIMP_METADATA_LOAD_COMMENT = 1 << 0,
|
|
|
|
|
GIMP_METADATA_LOAD_RESOLUTION = 1 << 1,
|
|
|
|
|
GIMP_METADATA_LOAD_ORIENTATION = 1 << 2,
|
2015-08-20 15:05:04 +02:00
|
|
|
GIMP_METADATA_LOAD_COLORSPACE = 1 << 3,
|
2013-10-27 15:22:35 +01:00
|
|
|
|
2013-10-27 15:38:42 +01:00
|
|
|
GIMP_METADATA_LOAD_ALL = 0xffffffff
|
2013-10-27 15:22:35 +01:00
|
|
|
} GimpMetadataLoadFlags;
|
2013-10-19 18:38:01 +02:00
|
|
|
|
2018-05-20 16:37:04 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GimpMetadataSaveFlags:
|
2018-12-04 17:28:24 +01:00
|
|
|
* @GIMP_METADATA_SAVE_EXIF: Save EXIF
|
|
|
|
|
* @GIMP_METADATA_SAVE_XMP: Save XMP
|
|
|
|
|
* @GIMP_METADATA_SAVE_IPTC: Save IPTC
|
|
|
|
|
* @GIMP_METADATA_SAVE_THUMBNAIL: Save a thumbnail of the image
|
|
|
|
|
* @GIMP_METADATA_SAVE_COLOR_PROFILE: Save the image's color profile
|
|
|
|
|
* Since: 2.10.10
|
2019-10-10 01:30:29 +02:00
|
|
|
* @GIMP_METADATA_SAVE_COMMENT: Save the image's comment
|
|
|
|
|
* Since: 3.0
|
2018-12-04 17:28:24 +01:00
|
|
|
* @GIMP_METADATA_SAVE_ALL: Save all of the above
|
2018-05-20 16:37:04 +02:00
|
|
|
*
|
|
|
|
|
* What kinds of metadata to save when exporting images.
|
|
|
|
|
**/
|
2013-10-19 18:38:01 +02:00
|
|
|
typedef enum
|
|
|
|
|
{
|
2018-12-04 17:28:24 +01:00
|
|
|
GIMP_METADATA_SAVE_EXIF = 1 << 0,
|
|
|
|
|
GIMP_METADATA_SAVE_XMP = 1 << 1,
|
|
|
|
|
GIMP_METADATA_SAVE_IPTC = 1 << 2,
|
|
|
|
|
GIMP_METADATA_SAVE_THUMBNAIL = 1 << 3,
|
|
|
|
|
GIMP_METADATA_SAVE_COLOR_PROFILE = 1 << 4,
|
2019-10-10 01:30:29 +02:00
|
|
|
GIMP_METADATA_SAVE_COMMENT = 1 << 5,
|
2013-10-19 18:38:01 +02:00
|
|
|
|
2013-10-27 15:38:42 +01:00
|
|
|
GIMP_METADATA_SAVE_ALL = 0xffffffff
|
2013-10-19 18:38:01 +02:00
|
|
|
} GimpMetadataSaveFlags;
|
|
|
|
|
|
2018-05-20 16:37:04 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GimpMetadataColorspace:
|
|
|
|
|
* @GIMP_METADATA_COLORSPACE_UNSPECIFIED: Unspecified
|
|
|
|
|
* @GIMP_METADATA_COLORSPACE_UNCALIBRATED: Uncalibrated
|
|
|
|
|
* @GIMP_METADATA_COLORSPACE_SRGB: sRGB
|
|
|
|
|
* @GIMP_METADATA_COLORSPACE_ADOBERGB: Adobe RGB
|
|
|
|
|
*
|
|
|
|
|
* Well-defined colorspace information available from metadata
|
|
|
|
|
**/
|
2015-09-30 20:47:52 +02:00
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
GIMP_METADATA_COLORSPACE_UNSPECIFIED,
|
|
|
|
|
GIMP_METADATA_COLORSPACE_UNCALIBRATED,
|
|
|
|
|
GIMP_METADATA_COLORSPACE_SRGB,
|
|
|
|
|
GIMP_METADATA_COLORSPACE_ADOBERGB
|
|
|
|
|
} GimpMetadataColorspace;
|
|
|
|
|
|
2018-05-20 16:37:04 +02:00
|
|
|
|
2017-01-03 19:36:22 +01:00
|
|
|
GimpMetadata * gimp_metadata_new (void);
|
|
|
|
|
GimpMetadata * gimp_metadata_duplicate (GimpMetadata *metadata);
|
|
|
|
|
|
|
|
|
|
GimpMetadata * gimp_metadata_deserialize (const gchar *metadata_xml);
|
|
|
|
|
gchar * gimp_metadata_serialize (GimpMetadata *metadata);
|
2017-07-05 19:24:54 -04:00
|
|
|
gchar * gimp_metadata_get_guid (void);
|
|
|
|
|
|
|
|
|
|
void gimp_metadata_add_xmp_history (GimpMetadata *metadata,
|
|
|
|
|
gchar *state_status);
|
2017-01-03 19:36:22 +01:00
|
|
|
|
|
|
|
|
GimpMetadata * gimp_metadata_load_from_file (GFile *file,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean gimp_metadata_save_to_file (GimpMetadata *metadata,
|
|
|
|
|
GFile *file,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
gboolean gimp_metadata_set_from_exif (GimpMetadata *metadata,
|
|
|
|
|
const guchar *exif_data,
|
|
|
|
|
gint exif_data_length,
|
|
|
|
|
GError **error);
|
2017-07-05 19:24:54 -04:00
|
|
|
gboolean gimp_metadata_set_from_iptc (GimpMetadata *metadata,
|
|
|
|
|
const guchar *iptc_data,
|
|
|
|
|
gint iptc_data_length,
|
|
|
|
|
GError **error);
|
2017-01-03 19:36:22 +01:00
|
|
|
gboolean gimp_metadata_set_from_xmp (GimpMetadata *metadata,
|
|
|
|
|
const guchar *xmp_data,
|
|
|
|
|
gint xmp_data_length,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
void gimp_metadata_set_pixel_size (GimpMetadata *metadata,
|
|
|
|
|
gint width,
|
|
|
|
|
gint height);
|
|
|
|
|
void gimp_metadata_set_bits_per_sample (GimpMetadata *metadata,
|
|
|
|
|
gint bits_per_sample);
|
|
|
|
|
|
|
|
|
|
gboolean gimp_metadata_get_resolution (GimpMetadata *metadata,
|
|
|
|
|
gdouble *xres,
|
|
|
|
|
gdouble *yres,
|
Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!
Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.
As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.
Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.
Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-07-25 20:55:21 +02:00
|
|
|
GimpUnit **unit);
|
2017-01-03 19:36:22 +01:00
|
|
|
void gimp_metadata_set_resolution (GimpMetadata *metadata,
|
|
|
|
|
gdouble xres,
|
|
|
|
|
gdouble yres,
|
Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!
Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.
As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.
Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.
Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-07-25 20:55:21 +02:00
|
|
|
GimpUnit *unit);
|
2025-01-13 16:15:27 -05:00
|
|
|
void gimp_metadata_set_creation_date (GimpMetadata *metadata,
|
|
|
|
|
GDateTime *datetime);
|
2017-01-03 19:36:22 +01:00
|
|
|
|
|
|
|
|
GimpMetadataColorspace
|
|
|
|
|
gimp_metadata_get_colorspace (GimpMetadata *metadata);
|
|
|
|
|
void gimp_metadata_set_colorspace (GimpMetadata *metadata,
|
|
|
|
|
GimpMetadataColorspace colorspace);
|
|
|
|
|
|
|
|
|
|
gboolean gimp_metadata_is_tag_supported (const gchar *tag,
|
|
|
|
|
const gchar *mime_type);
|
2013-10-19 18:38:01 +02:00
|
|
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
|
|
2017-01-03 19:36:22 +01:00
|
|
|
#endif /* __GIMP_METADATA_H__ */
|