film.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2013 johannes hanika.
    Copyright (C) 2010 Henrik Andersson.
    Copyright (C) 2011, 2014, 2016 Tobias Ellinghaus.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013 Jérémy Rosen.
    Copyright (C) 2013 Simon Spannagel.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2020 Pascal Obry.
    Copyright (C) 2021 Philippe Weyland.
    Copyright (C) 2022 HansBull.
    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 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_COMMON_FILM_H
#define DT_COMMON_FILM_H
 
#include "system/dtpthread.h"
 
#include <glib.h>
#include <inttypes.h>
 
typedef struct dt_film_t
{
  int32_t id;
  char dirname[512];
  dt_pthread_mutex_t images_mutex;
  GDir *dir;
  int32_t num_images, last_loaded;
  int32_t ref;
} dt_film_t;
 
void dt_film_init(dt_film_t *film);
void dt_film_cleanup(dt_film_t *film);
int dt_film_open(const int32_t id);
 
int dt_film_import(const char *dirname);
void dt_film_set_query(const int32_t id);
int32_t dt_film_get_id(const char *folder);
void dt_film_remove(const int id);
gboolean dt_film_is_empty(const int id);
int dt_film_new(dt_film_t *film, const char *directory);
void dt_film_remove_empty();
GList *dt_film_get_image_ids(const int filmid);
// initialize film folder status
void dt_film_set_folder_status();
void dt_film_relocate(const char *old_path, const char *new_path);
 
/* Removing an empty film roll leaves an empty DIRECTORY on disk, and the "ask_before_rmdir"
 * preference says the user must be asked before it goes. Asking is a dialog, which is not
 * this layer's business -- so the backend hands the list to whoever can ask, and does the
 * deleting itself once told to.
 *
 * With no handler registered (ansel-cli, ansel-generate-cache, any headless run) the list is
 * simply freed and nothing is deleted. That is the safe default: "ask first" cannot be
 * honoured when there is nobody to ask, so the directories stay. */
 
typedef void (*dt_film_confirm_rmdir_handler_t)(GList *empty_dirs);
 
void dt_film_set_confirm_rmdir_handler(dt_film_confirm_rmdir_handler_t handler);
 
void dt_film_remove_directories(const GList *dirs);
 
 
/* Whoever is showing the film-roll list wants to know when that list changed -- a roll
 * removed, or one brought back by an undo. Raising DT_SIGNAL_FILMROLLS_CHANGED here would
 * be a call into control/ (layer 3) from layer 1, which is what the include-graph ratchet
 * counts; the fact travels the other way instead, exactly as common/image_notify.h and
 * common/thumbnail_notify.h already do for theirs. With no handler installed -- ansel-cli,
 * a unit test -- it is dropped, which is correct for both. */
 
typedef void (*dt_film_rolls_changed_handler_t)(void);
 
void dt_film_set_rolls_changed_handler(dt_film_rolls_changed_handler_t handler);
 
void dt_film_notify_rolls_changed(void);
 
#endif // DT_COMMON_FILM_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