gimp/libgimp/gimpimagemetadata.h

60 lines
2.6 KiB
C
Raw Normal View History

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-2000 Peter Mattis and Spencer Kimball
*
* gimpimagemetadata.h
*
* 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
* <https://www.gnu.org/licenses/>.
*/
libgimp: better organization of gimp_image_metadata_*() API. gimpimagemetadata.[ch] was built into libgimpui because GTK+ was used for dialog query for rotation metadata. gimpimagemetadata-save.c only was built into libgimp, which made no sense as the declaration for its public function was inside gimpimagemetadata.h! That was a weird situation and somehow only made visible in the build system because GIR build was complaining about missing annotations to gimp_image_metadata_save_prepare() (the annotation was actually present but in the implementation which was not in the same library as the header, how weird!): > Warning: GimpUi: gimp_image_metadata_save_prepare: return value: Missing (transfer) annotation Moreover it means that only plug-ins linking libgimpui had access to the gimp_image_metadata*() API, which is obviously not cool (that should be a core API). Instead I moved everything into libgimp and replaced gimp_image_metadata_load_finish() with gimp_image_metadata_load_finish_batch(), which is essentially the same function except that it's not interactive (it will proceed to rotate the image without user confirmation, provided the right flag is present). Then I add gimpimagemetadata-interactive.[ch] which contains only gimp_image_metadata_load_finish() and is the alternative interactive version of gimp_image_metadata_load_finish_batch(). Most plug-ins won't even have to be changed (at least none in core GIMP) and would still work as before, whereas now a non-interactive version exists, which doesn't mandate to link GTK+.
2020-09-13 19:09:59 +08:00
#if !defined (__GIMP_H_INSIDE__) && !defined (GIMP_COMPILATION)
#error "Only <libgimp/gimp.h> can be included directly."
#endif
libgimp: better organization of gimp_image_metadata_*() API. gimpimagemetadata.[ch] was built into libgimpui because GTK+ was used for dialog query for rotation metadata. gimpimagemetadata-save.c only was built into libgimp, which made no sense as the declaration for its public function was inside gimpimagemetadata.h! That was a weird situation and somehow only made visible in the build system because GIR build was complaining about missing annotations to gimp_image_metadata_save_prepare() (the annotation was actually present but in the implementation which was not in the same library as the header, how weird!): > Warning: GimpUi: gimp_image_metadata_save_prepare: return value: Missing (transfer) annotation Moreover it means that only plug-ins linking libgimpui had access to the gimp_image_metadata*() API, which is obviously not cool (that should be a core API). Instead I moved everything into libgimp and replaced gimp_image_metadata_load_finish() with gimp_image_metadata_load_finish_batch(), which is essentially the same function except that it's not interactive (it will proceed to rotate the image without user confirmation, provided the right flag is present). Then I add gimpimagemetadata-interactive.[ch] which contains only gimp_image_metadata_load_finish() and is the alternative interactive version of gimp_image_metadata_load_finish_batch(). Most plug-ins won't even have to be changed (at least none in core GIMP) and would still work as before, whereas now a non-interactive version exists, which doesn't mandate to link GTK+.
2020-09-13 19:09:59 +08:00
#ifndef __GIMP_IMAGE_METADATA_H__
#define __GIMP_IMAGE_METADATA_H__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
GimpMetadata * gimp_image_metadata_load_prepare (GimpImage *image,
const gchar *mime_type,
GFile *file,
GError **error);
app, libgimp, plug-ins: move Orientation metadata handling into core. Orientation is now handled by core code, just next to profile conversion handling. One of the first consequence is that we don't need to have a non-GUI version gimp_image_metadata_load_finish_batch() in libgimp, next to a GUI version of the gimp_image_metadata_load_finish() function in libgimpui. This makes for simpler API. Also a plug-in which wishes to get access to the rotation dialog provided by GIMP without loading ligimpui/GTK+ (for whatever reason) will still have the feature. The main advantage is that the "Don't ask me again" feature is now handled by a settings in `Preferences > Image Import & Export` as the "Metadata rotation policy". Until now it was saved as a global parasite, which made it virtually non-editable once you checked it once (no easy way to edit parasites except by scripts). So say you refused the rotation once while checking "Don't ask again", and GIMP will forever discard the rotation metadata without giving you a sane way to change your mind. Of course, I could have passed the settings to plug-ins through the PDB, but I find it a lot better to simply handle such settings core-side. The dialog code is basically the same as an app/dialogs/ as it was in libgimp, with the minor improvement that it now takes the scale ratio into account (basically the maximum thumbnail size will be bigger on higher density displays). Only downside of the move to the core is that this rotation dialog is raised only when you open an image from the core, not as a PDB call. So a plug-in which makes say a "file-jpeg-load" PDB call, even in INTERACTIVE run mode, won't have rotation processed. Note that this was already the same for embedded color profile conversion. This can be wanted or not. Anyway some additional libgimp calls might be of interest to explicitly call the core dialogs.
2020-09-24 01:59:09 +08:00
void gimp_image_metadata_load_finish (GimpImage *image,
const gchar *mime_type,
GimpMetadata *metadata,
GimpMetadataLoadFlags flags);
GimpMetadata * gimp_image_metadata_save_prepare (GimpImage *image,
const gchar *mime_type,
GimpMetadataSaveFlags *suggested_flags);
gboolean gimp_image_metadata_save_finish (GimpImage *image,
const gchar *mime_type,
GimpMetadata *metadata,
GimpMetadataSaveFlags flags,
GFile *file,
GError **error);
GimpImage * gimp_image_metadata_load_thumbnail (GFile *file,
GError **error);
G_END_DECLS
#endif /* __GIMP_IMAGE_METADATA_H__ */