/*
This file is part of darktable,
Copyright (C) 2009-2025 darktable developers.
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 .
*/
#pragma once
#include "common/image.h"
#include "common/mipmap_cache.h"
#include "common/tags.h"
#include "imageio/imageio_module.h"
#include
#include
#include
#include
#define FILTERS_ARE_CYGM(filters) \
((filters) == 0xb4b4b4b4 || (filters) == 0x4b4b4b4b || (filters) == 0x1e1e1e1e || (filters) == 0xe1e1e1e1)
#define FILTERS_ARE_RGBE(filters) \
((filters) == 0x63636363 || (filters) == 0x36363636 || (filters) == 0x9c9c9c9c || (filters) == 0xc9c9c9c9)
// FIXME: kill this pls.
#define FILTERS_ARE_4BAYER(filters) (FILTERS_ARE_CYGM(filters) || FILTERS_ARE_RGBE(filters))
G_BEGIN_DECLS
typedef enum dt_imageio_levels_t
{
IMAGEIO_INT8 = 0x0,
IMAGEIO_INT12 = 0x1,
IMAGEIO_INT16 = 0x2,
IMAGEIO_INT32 = 0x3,
IMAGEIO_FLOAT = 0x4,
IMAGEIO_BW = 0x5,
IMAGEIO_INT10 = 0x6,
IMAGEIO_PREC_MASK = 0xFF,
IMAGEIO_RGB = 0x100,
IMAGEIO_GRAY = 0x200,
IMAGEIO_CHANNEL_MASK = 0xFF00
} dt_imageio_levels_t;
// Check that the image is raw by file extension
gboolean dt_imageio_is_raw_by_extension(const char *extension);
// Checks that the image is indeed an ldr image
gboolean dt_imageio_is_ldr(const char *filename);
// checks that the image has a monochrome preview attached
gboolean dt_imageio_has_mono_preview(const char *filename);
// Set the darktable/mode/hdr tag
void dt_imageio_set_hdr_tag(dt_image_t *img);
// HDR10 content light levels in nits of a PQ encoded RGBA float buffer:
// MaxCLL is the brightest RGB component, MaxFALL the mean of each pixel's
// brightest component (for a still, the only frame is the brightest one)
void dt_imageio_pq_light_level(const float *const rgba,
const size_t npixels,
float *const max_cll,
float *const max_fall);
// Update the tag for b&w workflow
void dt_imageio_update_monochrome_workflow_tag(int32_t id, int mask);
// opens the file using pfm, hdr, exr.
dt_imageio_retval_t dt_imageio_open_hdr(dt_image_t *img,
const char *filename,
dt_mipmap_buffer_t *buf);
// opens file using imagemagick
dt_imageio_retval_t dt_imageio_open_ldr(dt_image_t *img,
const char *filename,
dt_mipmap_buffer_t *buf);
// try all the options in sequence
dt_imageio_retval_t dt_imageio_open(dt_image_t *img,
const char *filename,
dt_mipmap_buffer_t *buf);
// tries to open the files not opened by the other routines using
// GraphicsMagick (if supported)
dt_imageio_retval_t dt_imageio_open_exotic(dt_image_t *img, const char *filename,
dt_mipmap_buffer_t *buf);
struct dt_imageio_module_format_t;
struct dt_imageio_module_data_t;
gboolean dt_imageio_export(const dt_imgid_t imgid,
const char *filename,
struct dt_imageio_module_format_t *format,
struct dt_imageio_module_data_t *format_params,
const gboolean high_quality,
const gboolean upscale,
const gboolean is_scaling,
const double scale_factor,
const gboolean copy_metadata,
const gboolean export_masks,
dt_colorspaces_color_profile_type_t icc_type,
const gchar *icc_filename,
dt_iop_color_intent_t icc_intent,
dt_imageio_module_storage_t *storage,
dt_imageio_module_data_t *storage_params,
int num,
const int total,
dt_export_metadata_t *metadata);
gboolean dt_imageio_export_with_flags(const dt_imgid_t imgid, const char *filename,
struct dt_imageio_module_format_t *format,
struct dt_imageio_module_data_t *format_params,
const gboolean ignore_exif,
const gboolean display_byteorder,
const gboolean high_quality,
const gboolean upscale,
const gboolean is_scaling,
const double scale_factor,
const gboolean thumbnail_export,
const char *filter,
const gboolean copy_metadata,
const gboolean export_masks,
dt_colorspaces_color_profile_type_t icc_type,
const gchar *icc_filename,
dt_iop_color_intent_t icc_intent,
dt_imageio_module_storage_t *storage,
dt_imageio_module_data_t *storage_params,
int num,
const int total,
dt_export_metadata_t *metadata,
const int history_end);
// general, efficient buffer flipping function using memcopies
void dt_imageio_flip_buffers(char *out,
const char *in,
const size_t bpp, // bytes per pixel
const int wd,
const int ht,
const int fwd,
const int fht,
const int stride,
const dt_image_orientation_t orientation);
void dt_imageio_flip_buffers_ui8_to_float(float *out,
const uint8_t *in,
const float black,
const float white,
const int ch,
const int wd,
const int ht,
const int fwd,
const int fht,
const int stride,
const dt_image_orientation_t orientation);
// allocate buffer and return 0 on success along with largest jpg thumbnail from raw.
gboolean dt_imageio_large_thumbnail(const char *filename,
uint8_t **buffer,
int32_t *width,
int32_t *height,
dt_colorspaces_color_profile_type_t *color_space);
// lookup maker and model, dispatch lookup to rawspeed or libraw
gboolean dt_imageio_lookup_makermodel(const char *maker,
const char *model,
char *mk,
const int mk_len,
char *md,
const int md_len,
char *al,
const int al_len);
// get the type of image from its extension
dt_image_flags_t dt_imageio_get_type_from_extension(const char *extension);
cairo_surface_t *dt_imageio_preview(const dt_imgid_t imgid,
const size_t width,
const size_t height,
const int history_end,
const char *style_name);
G_END_DECLS
// 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