imageio_module.c

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010-2011 Henrik Andersson.
    Copyright (C) 2010-2012 johannes hanika.
    Copyright (C) 2011-2016, 2020 Tobias Ellinghaus.
    Copyright (C) 2012-2014 Jérémy Rosen.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013-2016 Roman Lebedev.
    Copyright (C) 2013 Ulrich Pegelow.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2019 jakubfi.
    Copyright (C) 2019-2021 Pascal Obry.
    Copyright (C) 2020 a.
    Copyright (C) 2020 Andreas Schneider.
    Copyright (C) 2020 Chris Elston.
    Copyright (C) 2020-2021 Diederik Ter Rahe.
    Copyright (C) 2020 Hubert Kowalski.
    Copyright (C) 2021 Bill Ferguson.
    Copyright (C) 2021 Ralf Brown.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2023 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/>.
*/
 
#include "common/module_versioning.h"
#include "common/module.h"
#include "imageio/imageio_module.h"
#include "system/macros.h"
#include "system/mem_alloc.h"
#include "common/paths.h"
#include "gui/application.h"
#include "common/file_location.h"
#include "imageio/imageio_core.h"
#include "common/conf.h"
#include "control/signal.h"
#include <stdlib.h>
#include "widgets/widget_settings.h"
static gint dt_imageio_sort_modules_storage(gconstpointer a, gconstpointer b)
{
  const dt_imageio_module_storage_t *am = (const dt_imageio_module_storage_t *)a;
  const dt_imageio_module_storage_t *bm = (const dt_imageio_module_storage_t *)b;
  return strcmp(am->name(am), bm->name(bm));
}
 
static gint dt_imageio_sort_modules_format(gconstpointer a, gconstpointer b)
{
  const dt_imageio_module_format_t *am = (const dt_imageio_module_format_t *)a;
  const dt_imageio_module_format_t *bm = (const dt_imageio_module_format_t *)b;
  return strcmp(am->name(), bm->name());
}
 
static int _default_format_dimension(dt_imageio_module_format_t *module, dt_imageio_module_data_t *data,
                                     uint32_t *width, uint32_t *height)
{
  // assume no limits
  *width = 0;
  *height = 0;
  return 0;
}
static int _default_format_flags(dt_imageio_module_data_t *data)
{
  return 0;
}
static int _default_format_levels(dt_imageio_module_data_t *data)
{
  return IMAGEIO_RGB | IMAGEIO_INT8;
}
static void _default_format_gui_init(struct dt_imageio_module_format_t *self)
{
}
 
static int dt_imageio_load_module_format(dt_imageio_module_format_t *module, const char *libname,
                                         const char *module_name)
{
  g_strlcpy(module->plugin_name, module_name, sizeof(module->plugin_name));
 
#define INCLUDE_API_FROM_MODULE_LOAD "imageio_load_module_format"
#include "imageio/format/imageio_format_api.h"
 
  if(dt_gui_get_global())
  {
    if(IS_NULL_PTR(module->gui_init)) goto api_h_error;
  }
  else
  {
    module->gui_init = _default_format_gui_init;
  }
  if(IS_NULL_PTR(module->dimension)) module->dimension = _default_format_dimension;
  if(IS_NULL_PTR(module->flags)) module->flags = _default_format_flags;
  if(IS_NULL_PTR(module->levels)) module->levels = _default_format_levels;
 
  module->widget = NULL;
  // Can by set by the module function to false if something went wrong.
  module->ready = TRUE;
 
  module->init(module);
  if (!module->ready)
  {
    goto api_h_error;
  }
 
  return 0;
}
 
 
static int dt_imageio_load_modules_format(dt_imageio_t *iio)
{
  iio->plugins_format = NULL;
  GList *res = NULL;
  dt_imageio_module_format_t *module;
  char moduledir[DT_PATH_MAX] = { 0 };
 
  gchar **plugin_names = dt_module_read_manifest("/plugins/imageio/format", moduledir);
  if(IS_NULL_PTR(plugin_names)) return 1;
 
  for(gchar **name = plugin_names; !IS_NULL_PTR(*name); name++)
  {
    const char *plugin_name = *name;
    module = (dt_imageio_module_format_t *)malloc(sizeof(dt_imageio_module_format_t));
    gchar *libname = g_module_build_path(moduledir, plugin_name);
    if(dt_imageio_load_module_format(module, libname, plugin_name))
    {
      dt_free(libname);
      dt_free(module);
      continue;
    }
    dt_free(libname);
    module->gui_data = NULL;
    if(dt_gui_get_global()) dt_gui_freeze_begin();
    module->gui_init(module);
    if(dt_gui_get_global()) dt_gui_freeze_end();
    if(module->widget) g_object_ref_sink(module->widget);
    res = g_list_insert_sorted(res, module, dt_imageio_sort_modules_format);
  }
  g_strfreev(plugin_names);
 
  iio->plugins_format = res;
  return 0;
}
 
static gboolean default_supported(struct dt_imageio_module_storage_t *self,
                                  struct dt_imageio_module_format_t *format)
{
  return TRUE;
}
static int _default_storage_dimension(struct dt_imageio_module_storage_t *self, dt_imageio_module_data_t *data,
                                      uint32_t *width, uint32_t *height)
{
  return 0;
}
static void _default_storage_nop(struct dt_imageio_module_storage_t *self)
{
}
 
static int dt_imageio_load_module_storage(dt_imageio_module_storage_t *module, const char *libname,
                                          const char *module_name)
{
  g_strlcpy(module->plugin_name, module_name, sizeof(module->plugin_name));
 
#define INCLUDE_API_FROM_MODULE_LOAD "imageio_load_module_storage"
#include "imageio/storage/imageio_storage_api.h"
 
  if(dt_gui_get_global())
  {
    if(IS_NULL_PTR(module->gui_init)) goto api_h_error;
  }
  else
  {
    module->gui_init = _default_storage_nop;
  }
  if(IS_NULL_PTR(module->dimension)) module->dimension = _default_storage_dimension;
  if(IS_NULL_PTR(module->recommended_dimension)) module->recommended_dimension = _default_storage_dimension;
  if(!module->export_dispatched) module->export_dispatched = _default_storage_nop;
 
  module->widget = NULL;
  module->init(module);
  return 0;
}
 
static int dt_imageio_load_modules_storage(dt_imageio_t *iio)
{
  iio->plugins_storage = NULL;
  dt_imageio_module_storage_t *module;
  char moduledir[DT_PATH_MAX] = { 0 };
 
  gchar **plugin_names = dt_module_read_manifest("/plugins/imageio/storage", moduledir);
  if(IS_NULL_PTR(plugin_names)) return 1;
 
  for(gchar **name = plugin_names; !IS_NULL_PTR(*name); name++)
  {
    const char *plugin_name = *name;
    module = (dt_imageio_module_storage_t *)malloc(sizeof(dt_imageio_module_storage_t));
    gchar *libname = g_module_build_path(moduledir, plugin_name);
    if(dt_imageio_load_module_storage(module, libname, plugin_name))
    {
      dt_free(libname);
      dt_free(module);
      continue;
    }
    dt_free(libname);
    module->gui_data = NULL;
    module->gui_init(module);
    if(module->widget) g_object_ref_sink(module->widget);
    dt_imageio_insert_storage(module);
  }
  g_strfreev(plugin_names);
 
  return 0;
}
 
void dt_imageio_init(dt_imageio_t *iio)
{
  iio->plugins_format = NULL;
  iio->plugins_storage = NULL;
 
  dt_imageio_load_modules_format(iio);
  dt_imageio_load_modules_storage(iio);
}
 
void dt_imageio_cleanup(dt_imageio_t *iio)
{
  while(iio->plugins_format)
  {
    dt_imageio_module_format_t *module = (dt_imageio_module_format_t *)(iio->plugins_format->data);
    module->gui_cleanup(module);
    module->cleanup(module);
    if(module->widget) g_object_unref(module->widget);
    if(module->module) g_module_close(module->module);
    dt_free(module);
    iio->plugins_format = g_list_delete_link(iio->plugins_format, iio->plugins_format);
  }
  while(iio->plugins_storage)
  {
    dt_imageio_module_storage_t *module = (dt_imageio_module_storage_t *)(iio->plugins_storage->data);
    module->gui_cleanup(module);
    if(module->widget) g_object_unref(module->widget);
    if(module->module) g_module_close(module->module);
    dt_free(module);
    iio->plugins_storage = g_list_delete_link(iio->plugins_storage, iio->plugins_storage);
  }
}
 
dt_imageio_module_format_t *dt_imageio_get_format()
{
  dt_imageio_t *iio = dt_imageio_get_global();
  const char *format_name = dt_conf_get_string_const("plugins/lighttable/export/format_name");
  dt_imageio_module_format_t *format = dt_imageio_get_format_by_name(format_name);
  // if the format from the config isn't available default to jpeg, if that's not available either just use
  // the first we have
  if(IS_NULL_PTR(format)) format = dt_imageio_get_format_by_name("jpeg");
  if(IS_NULL_PTR(format)) format = iio->plugins_format->data;
  return format;
}
 
dt_imageio_module_storage_t *dt_imageio_get_storage()
{
  dt_imageio_t *iio = dt_imageio_get_global();
  const char *storage_name = dt_conf_get_string_const("plugins/lighttable/export/storage_name");
  dt_imageio_module_storage_t *storage = dt_imageio_get_storage_by_name(storage_name);
  // if the storage from the config isn't available default to disk, if that's not available either just use
  // the first we have
  if(IS_NULL_PTR(storage)) storage = dt_imageio_get_storage_by_name("disk");
  if(IS_NULL_PTR(storage)) storage = iio->plugins_storage->data;
  return storage;
}
 
dt_imageio_module_format_t *dt_imageio_get_format_by_name(const char *name)
{
  if(IS_NULL_PTR(name)) return NULL;
  dt_imageio_t *iio = dt_imageio_get_global();
  for(GList *it = iio->plugins_format; it; it = g_list_next(it))
  {
    dt_imageio_module_format_t *module = (dt_imageio_module_format_t *)it->data;
    if(!strcmp(module->plugin_name, name)) return module;
  }
  return NULL;
}
 
dt_imageio_module_storage_t *dt_imageio_get_storage_by_name(const char *name)
{
  if(IS_NULL_PTR(name)) return NULL;
  dt_imageio_t *iio = dt_imageio_get_global();
  for(GList *it = iio->plugins_storage; it; it = g_list_next(it))
  {
    dt_imageio_module_storage_t *module = (dt_imageio_module_storage_t *)it->data;
    if(!strcmp(module->plugin_name, name)) return module;
  }
  return NULL;
}
 
dt_imageio_module_format_t *dt_imageio_get_format_by_index(int index)
{
  dt_imageio_t *iio = dt_imageio_get_global();
  GList *it = g_list_nth(iio->plugins_format, index);
  if(IS_NULL_PTR(it)) it = iio->plugins_format;
  return (dt_imageio_module_format_t *)it->data;
}
 
dt_imageio_module_storage_t *dt_imageio_get_storage_by_index(int index)
{
  dt_imageio_t *iio = dt_imageio_get_global();
  GList *it = g_list_nth(iio->plugins_storage, index);
  if(IS_NULL_PTR(it)) it = iio->plugins_storage;
  return (dt_imageio_module_storage_t *)it->data;
}
 
int dt_imageio_get_index_of_format(dt_imageio_module_format_t *format)
{
  dt_imageio_t *iio = dt_imageio_get_global();
  return g_list_index(iio->plugins_format, format);
}
int dt_imageio_get_index_of_storage(dt_imageio_module_storage_t *storage)
{
  dt_imageio_t *iio = dt_imageio_get_global();
  return g_list_index(iio->plugins_storage, storage);
}
 
void dt_imageio_insert_storage(dt_imageio_module_storage_t *storage)
{
  dt_imageio_get_global()->plugins_storage
      = g_list_insert_sorted(dt_imageio_get_global()->plugins_storage, storage, dt_imageio_sort_modules_storage);
  DT_DEBUG_CONTROL_SIGNAL_RAISE(dt_control_signal_get_global(), DT_SIGNAL_IMAGEIO_STORAGE_CHANGE);
}
 
void dt_imageio_remove_storage(dt_imageio_module_storage_t *storage)
{
  dt_imageio_get_global()->plugins_storage  = g_list_remove(dt_imageio_get_global()->plugins_storage, storage);
  DT_DEBUG_CONTROL_SIGNAL_RAISE(dt_control_signal_get_global(), DT_SIGNAL_IMAGEIO_STORAGE_CHANGE);
}
 
void dt_imageio_resizing_factor_parse(const char *str, double *num, double *denum)
{
  // a decimal separator is accepted as '.' or ',' whatever the locale, so parse with the C locale
  gchar *scale_str = g_strdup(IS_NULL_PTR(str) ? "" : str);
  g_strdelimit(scale_str, ",", '.');
 
  const gchar *pdiv = strchr(scale_str, '/');
  double _num = 1.0;
  double _denum = 1.0;
  if(IS_NULL_PTR(pdiv))
    _num = g_ascii_strtod(scale_str, NULL);
  else
  {
    if(pdiv != scale_str) _num = g_ascii_strtod(scale_str, NULL);
    _denum = g_ascii_strtod(pdiv + 1, NULL);
  }
 
  // an absent or zero part reads as 1
  *num = (_num == 0.0) ? 1.0 : _num;
  *denum = (_denum == 0.0) ? 1.0 : _denum;
 
  dt_free(scale_str);
}
 
// 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