metadata.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010, 2012 johannes hanika.
    Copyright (C) 2010, 2014, 2016 Tobias Ellinghaus.
    Copyright (C) 2011 Henrik Andersson.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2019-2020 Pascal Obry.
    Copyright (C) 2019-2022 Philippe Weyland.
    Copyright (C) 2020 Aldric Renaudin.
    Copyright (C) 2020 Chris Elston.
    Copyright (C) 2021 Hubert Kowalski.
    Copyright (C) 2022-2023, 2026 Aurélien PIERRE.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025 Alynx Zhou.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    darktable 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 General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_METADATA_METADATA_H
#define DT_METADATA_METADATA_H
 
// Types this header's own declarations use. They used to arrive through gui/gtk.h, which
// this file included without using a single GTK symbol -- and which it then propagated to
// all 16 of its includers.
#include <glib.h>
#include <stdint.h>
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum dt_metadata_t
{
  // do change the order. Must match with dt_metadata_def[] in metadata.c.
  // just add new metadata before DT_METADATA_NUMBER when needed
  // and this must also be synchronized with the collect.c module (legacy_presets).
  DT_METADATA_XMP_DC_CREATOR,
  DT_METADATA_XMP_DC_PUBLISHER,
  DT_METADATA_XMP_DC_TITLE,
  DT_METADATA_XMP_DC_DESCRIPTION,
  DT_METADATA_XMP_DC_RIGHTS,
  DT_METADATA_XMP_ACDSEE_NOTES,
  DT_METADATA_XMP_VERSION_NAME,
  DT_METADATA_XMP_IMAGE_ID,
  DT_METADATA_NUMBER
}
dt_metadata_t;
 
typedef enum dt_metadata_type_t
{
  DT_METADATA_TYPE_USER,     // metadata for users
  DT_METADATA_TYPE_OPTIONAL, // metadata hidden by default
  DT_METADATA_TYPE_INTERNAL  // metadata for dt internal usage - the user cannot see it
}
dt_metadata_type_t;
 
typedef enum dt_metadata_signal_t
{
  DT_METADATA_SIGNAL_SHOWN,       // metadata set as shown
  DT_METADATA_SIGNAL_HIDDEN,      // metadata set as hidden
  DT_METADATA_SIGNAL_NEW_VALUE    // metadata value changed
}
dt_metadata_signal_t;
 
typedef enum dt_metadata_flag_t
{
  DT_METADATA_FLAG_HIDDEN = 1 << 0,     // metadata set as shown
  DT_METADATA_FLAG_PRIVATE = 1 << 1,    // metadata set as hidden
  DT_METADATA_FLAG_IMPORTED = 1 << 2    // metadata value changed
}
dt_metadata_flag_t;
 
unsigned int dt_metadata_get_nb_user_metadata();
 
const char *dt_metadata_get_name_by_display_order(const uint32_t order);
 
dt_metadata_t dt_metadata_get_keyid_by_display_order(const uint32_t order);
 
dt_metadata_t dt_metadata_get_keyid_by_name(const char* name);
 
int dt_metadata_get_type_by_display_order(const uint32_t order);
 
const char *dt_metadata_get_name(const uint32_t keyid);
 
dt_metadata_t dt_metadata_get_keyid(const char* key);
 
const char *dt_metadata_get_key(const uint32_t keyid);
 
const char *dt_metadata_get_subkey(const uint32_t keyid);
 
const char *dt_metadata_get_key_by_subkey(const char *subkey);
 
int dt_metadata_get_type(const uint32_t keyid);
 
void dt_metadata_init();
 
void dt_metadata_set(int id, const char *key, const char *value, const gboolean undo_on); // duplicate.c, lua/image.c
 
void dt_metadata_set_import(int id, const char *key, const char *value); // exif.cc, ligthroom.c
 
void dt_metadata_set_list(const GList *imgs, GList *key_value, const gboolean undo_on); // libs/metadata.c
 
void dt_metadata_set_list_id(const GList *img, const GList *metadata, const gboolean clear_on,
                             const gboolean undo_on);
GList *dt_metadata_get(int id, const char *key, uint32_t *count); // exif.cc, variables.c, gallery.c, watermark.c, metadata_view.c, libs/metadata.c, print_settings.c
 
GList *dt_metadata_get_list_id(int id); // libs/image.c
 
void dt_metadata_clear(const GList *imgs, const gboolean undo_on); // libs/metadata.c
 
int dt_metadata_already_imported(const char *filename, const char *datetime);
 
void dt_metadata_cleanup(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_METADATA_METADATA_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on