imageio_storage_api.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2016-2017, 2020 Tobias Ellinghaus.
    Copyright (C) 2019 Denis Dyakov.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2019 Philippe Weyland.
    Copyright (C) 2020-2021 Pascal Obry.
    Copyright (C) 2021 Diederik Ter Rahe.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025 Aurélien PIERRE.
    
    darktable 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.
    
    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 Lesser General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "common/module_api.h"
 
#ifdef FULL_API_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <glib.h>
#include <stdint.h>
 
struct dt_imageio_module_storage_t;
struct dt_imageio_module_format_t;
struct dt_imageio_module_data_t;
struct dt_export_metadata_t;
enum dt_colorspaces_color_profile_type_t;
enum dt_iop_color_intent_t;
 
/* early definition of modules to do type checking */
 
#pragma GCC visibility push(default)
 
#endif // FULL_API_H
 
/* get translated module name */
REQUIRED(const char *, name, const struct dt_imageio_module_storage_t *self);
/* construct widget above */
REQUIRED(void, gui_init, struct dt_imageio_module_storage_t *self);
/* destroy resources */
REQUIRED(void, gui_cleanup, struct dt_imageio_module_storage_t *self);
/* reset options to defaults */
REQUIRED(void, gui_reset, struct dt_imageio_module_storage_t *self);
/* allow the module to initialize itself */
REQUIRED(void, init, struct dt_imageio_module_storage_t *self);
/* try and see if this format is supported? */
DEFAULT(gboolean, supported, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_format_t *format);
/* get storage max supported image dimension, return 0 if no dimension restrictions exists. */
OPTIONAL(int, dimension, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *data,
              uint32_t *width, uint32_t *height);
/* get storage recommended image dimension, return 0 if no recommendation exists. */
OPTIONAL(int, recommended_dimension, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *data,
                                     uint32_t *width, uint32_t *height);
 
/* called once at the beginning (before exporting image), if implemented
   * can change the list of exported images (including a NULL list)
 */
OPTIONAL(int, initialize_store, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *data,
                                struct dt_imageio_module_format_t **format, struct dt_imageio_module_data_t **fdata,
                                GList **images, const gboolean high_quality);
/* this actually does the work */
REQUIRED(int, store, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *self_data, const int32_t imgid,
                     struct dt_imageio_module_format_t *format, struct dt_imageio_module_data_t *fdata, const int num,
                     const int total, const gboolean high_quality, const gboolean export_masks,
                     const enum dt_colorspaces_color_profile_type_t icc_type, const gchar *icc_filename,
                     enum dt_iop_color_intent_t icc_intent, struct dt_export_metadata_t *metadata);
/* called once at the end (after exporting all images), if implemented. */
OPTIONAL(void, finalize_store, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *data);
 
OPTIONAL(void *, legacy_params, struct dt_imageio_module_storage_t *self, const void *const old_params,
                 const size_t old_params_size, const int old_version, const int new_version,
                 size_t *new_size);
REQUIRED(size_t, params_size, struct dt_imageio_module_storage_t *self);
REQUIRED(void *, get_params, struct dt_imageio_module_storage_t *self);
REQUIRED(void, free_params, struct dt_imageio_module_storage_t *self, struct dt_imageio_module_data_t *data);
REQUIRED(int, set_params, struct dt_imageio_module_storage_t *self, const void *params, const int size);
 
OPTIONAL(void, export_dispatched, struct dt_imageio_module_storage_t *self);
 
OPTIONAL(char *, ask_user_confirmation, struct dt_imageio_module_storage_t *self);
 
#ifdef FULL_API_H
 
#pragma GCC visibility pop
 
#ifdef __cplusplus
}
#endif
 
#endif // FULL_API_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