run.c

Go to the documentation of this file.

/*
    This file is part of the Ansel project.
    Copyright (C) 2023-2026 Aurélien PIERRE.
    Copyright (C) 2026 Guillaume Stutin.
    
    Ansel 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.
    
    Ansel 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 Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "gui/actions/menu.h"
#include "common/paths.h"   // DT_PATH_MAX
#include "control/control.h"
#include "control/crawler.h"
#include "database/database.h"
#include "caches/mipmap_cache.h"
#include "common/selection.h"
#include "common/utility.h"
#include "control/jobs.h"
#include "develop/dev_pixelpipe.h"
#include "develop/develop.h"
#include "gui/actions/doc_screenshot.h"
#include "gui/application.h"
#include "gui/dtgtk/thumbnail.h"
#include "gui/dtgtk/thumbtable.h"
 
typedef struct _preload_cache_params_t
{
  dt_mipmap_size_t max_mipmap_size;  
} preload_cache_params_t;
 
static gboolean clear_caches_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_develop_t *const dev = dt_dev_get_global();
  dt_dev_pixelpipe_reset_all(dev);
  dt_dev_pixelpipe_resync_history_all(dev);
  return TRUE;
}
 
static gboolean optimize_database_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_database_perform_maintenance();
  return TRUE;
}
 
static gboolean backup_database_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_database_snapshot();
  return TRUE;
}
 
static gboolean crawl_xmp_changes(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  GList *changed_xmp_files = dt_control_crawler_run();
  dt_control_crawler_show_image_list(changed_xmp_files);
  return TRUE;
}
 
// A quit cancels nothing (see doc/shutdown.md): without the second test, the closing window would
// wait for the whole collection. Either way, the thumbnail being rendered is finished.
static gboolean _preload_should_stop(dt_job_t *job)
{
  return dt_control_job_get_state(job) == DT_JOB_STATE_CANCELLED || !dt_control_running();
}
 
static int32_t preload_image_cache(dt_job_t *job)
{
  // Retrieve the maximum mipmap size to generate from job parameters
  preload_cache_params_t *params = (preload_cache_params_t *)dt_control_job_get_params(job);
  const dt_mipmap_size_t max_mipmap_size = (params) ? params->max_mipmap_size : DT_MIPMAP_2;
 
  // Load the mipmap cache sizes 0 to max_mipmap_size of the current selection
  GList *selection = dt_selection_get_list(dt_selection_get_global());
  int i = 0;
  float imgs = (float)dt_selection_get_length(dt_selection_get_global()) * (max_mipmap_size + 1);
  GList *img = g_list_first(selection);
 
  while(img && !_preload_should_stop(job))
  {
    const int32_t imgid = GPOINTER_TO_INT(img->data);
 
    // Note : we generate from large scale to small,
    // because the mipmap code has a mechanism that downscales
    // higher resolution thumbnails if present, rather
    // than recomputing a pipe from scratch.
    for(int k = max_mipmap_size; k >= DT_MIPMAP_0 && !_preload_should_stop(job); k--)
    {
      char filename[DT_PATH_MAX] = { 0 };
      dt_mipmap_get_cache_filename(filename, k, imgid);
 
      // if a valid thumbnail file is already on disc - do nothing
      if(dt_util_test_image_file(filename))
      {
        i++;
        continue;
      }
 
      // else, generate thumbnail and store in mipmap cache.
      dt_mipmap_buffer_t buf;
      dt_mipmap_cache_get(&buf, imgid, k, DT_MIPMAP_BLOCKING, 'r');
      dt_mipmap_cache_release(&buf);
 
      i++;
      dt_control_job_set_progress(job, (float)i / imgs);
    }
 
    // and immediately write thumbs to disc and remove from mipmap cache.
    dt_mimap_cache_evict(imgid);
 
    img = g_list_next(img);
  }
 
  g_list_free(selection);
  selection = NULL;
  return 0;
}
 
static gboolean _preload_image_cache_with_max_size(dt_mipmap_size_t max_size, const char *description)
{
  preload_cache_params_t *params = (preload_cache_params_t *)g_malloc(sizeof(preload_cache_params_t));
  params->max_mipmap_size = max_size;
 
  dt_job_t *job = dt_control_job_create(&preload_image_cache, "preload");
  dt_control_job_set_params(job, params, g_free);
  dt_control_job_add_progress(job, description, TRUE);
  dt_control_add_job(dt_control_get_global(), DT_JOB_QUEUE_USER_BG, job);
  return TRUE;
}
 
// Callback functions for each mipmap size
static gboolean preload_to_mipmap_0_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_0, _("Preloading cache (up to 360x225 px) for current collection"));
}
 
static gboolean preload_to_mipmap_1_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_1, _("Preloading cache (up to 720x450 px) for current collection"));
}
 
static gboolean preload_to_mipmap_2_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_2, _("Preloading cache (up to 1440x900 px) for current collection"));
}
 
static gboolean preload_to_mipmap_3_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_3, _("Preloading cache (up to Full HD 1080p) for current collection"));
}
 
static gboolean preload_to_mipmap_4_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_4, _("Preloading cache (up to 2560x1440 px) for current collection"));
}
 
static gboolean preload_to_mipmap_5_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_5, _("Preloading cache (up to 4K/UHD) for current collection"));
}
 
static gboolean preload_to_mipmap_6_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_6, _("Preloading cache (up to 5K) for current collection"));
}
 
static gboolean preload_to_mipmap_7_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_7, _("Preloading cache (up to 6K) for current collection"));
}
 
static gboolean preload_to_mipmap_8_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  return _preload_image_cache_with_max_size(DT_MIPMAP_8, _("Preloading cache (up to 8K) for current collection"));
}
 
static gboolean preload_auto_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  const int width = ceilf(table->thumb_width * dt_gui_get_global()->ppd);
  const int height = ceilf(table->thumb_height * dt_gui_get_global()->ppd);
  dt_mipmap_size_t mip = dt_mipmap_cache_get_matching_size(width, height, UNKNOWN_IMAGE);
  fprintf(stdout, "mipmap %i\n", mip);
  return _preload_image_cache_with_max_size(mip, _("Preloading cache for current collection"));
}
 
static gboolean clear_image_cache(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  GList *selection = dt_selection_get_list(dt_selection_get_global());
 
  for(GList *img = g_list_first(selection); img; img = g_list_next(img))
  {
    const int32_t imgid = GPOINTER_TO_INT(img->data);
    dt_mipmap_cache_remove(imgid, TRUE);
  }
 
  g_list_free(selection);
  selection = NULL;
 
  // Redraw thumbnails
  dt_thumbtable_refresh_thumbnail(dt_gui_get_ui()->thumbtable_lighttable, UNKNOWN_IMAGE, TRUE);
  return TRUE;
}
 
static gboolean doc_screenshot_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_gui_doc_screenshot_window_show();
  return TRUE;
}
 
MAKE_ACCEL_WRAPPER(dt_control_write_sidecar_files)
MAKE_ACCEL_WRAPPER(dt_image_local_copy_synch)
 
void append_run(GtkWidget **menus, GList **lists, const dt_menus_t index)
{
  add_sub_menu_entry(menus, lists, _("Clear darkroom pipeline caches"), index, NULL, clear_caches_callback, NULL, NULL, NULL, 0, 0);
 
  // Create submenu for preloading selected thumbnails with different maximum mipmap sizes
  add_top_submenu_entry(menus, lists, _("Preload selected thumbnails in cache"), index);
  GtkWidget *parent = get_last_widget(lists);
 
  // Add mipmap size options to the submenu
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 360x225 px"), index, NULL, preload_to_mipmap_0_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 720x450 px"), index, NULL, preload_to_mipmap_1_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 1440x900 px"), index, NULL, preload_to_mipmap_2_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to Full HD 1080p"), index, NULL, preload_to_mipmap_3_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 2560x1440 px"), index, NULL, preload_to_mipmap_4_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 4K/UHD"), index, NULL, preload_to_mipmap_5_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 5K"), index, NULL, preload_to_mipmap_6_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 6K"), index, NULL, preload_to_mipmap_7_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_sub_menu_entry(menus, parent, lists, _("up to 8K"), index, NULL, preload_to_mipmap_8_callback, NULL, NULL, has_active_images, 0, 0);
  add_sub_menu_separator(parent);
  add_sub_sub_menu_entry(menus, parent, lists, _("for current grid size"), index, NULL, preload_auto_callback, NULL, NULL, has_active_images, 0, 0);
 
  add_sub_menu_entry(menus, lists, _("Purge selected thumbnails from cache"), index, NULL, clear_image_cache, NULL, NULL, has_active_images, 0, 0);
  add_menu_separator(menus[index]);
  add_sub_menu_entry(menus, lists, _("Defragment the library"), index, NULL, optimize_database_callback, NULL, NULL, NULL, 0, 0);
  add_sub_menu_entry(menus, lists, _("Backup the library"), index, NULL, backup_database_callback, NULL, NULL, NULL, 0, 0);
  add_menu_separator(menus[index]);
  add_sub_menu_entry(menus, lists, _("Synchronize developments from XMP to database"), index, NULL, crawl_xmp_changes, NULL, NULL, NULL, 0, 0);
  add_sub_menu_entry(menus, lists, _("Synchronize developments from database to XMP"), index, NULL, GET_ACCEL_WRAPPER(dt_control_write_sidecar_files), NULL, NULL, has_active_images, 0, 0);
  add_menu_separator(menus[index]);
  add_sub_menu_entry(menus, lists, _("Resynchronize local copies with distant XMP"), index, NULL, GET_ACCEL_WRAPPER(dt_image_local_copy_synch), NULL, NULL, NULL, 0, 0);
 
  // Documentation mode: the capture panel is only offered when the application was started
  // with --doc, so a regular user never sees an entry that only serves the manual.
  if(dt_gui_doc_screenshot_enabled())
  {
    add_menu_separator(menus[index]);
    add_sub_menu_entry(menus, lists, _("Capture widget screenshots..."), index, NULL, doc_screenshot_callback, NULL, NULL, NULL, 0, 0);
  }
}