#include "gui/dtgtk/thumbnail.h"
#include "gui/dtgtk/thumbtable.h"
#include "gui/dtgtk/thumbtable_info.h"
#include "widgets/bauhaus.h"
#include "widgets/accelerators.h"
#include "caches/pixelpipe_cache_alloc.h"
#include "database/history_repository.h"
#include "database/image_repository.h"
#include "gui/dtgtk/focus.h"
#include "widgets/focus_peaking.h"
#include "common/grouping.h"
#include "metadata/ratings.h"
#include "common/selection.h"
#include "common/utility.h"
#include "common/variables.h"
#include "control/control.h"
#include "gui/dtgtk/preview_window.h"
#include "widgets/thumbnail_btn.h"
#include "gui/drag_and_drop.h"
#include "views/view.h"
#include <glib-object.h>
#include "gui/application.h"
#include "widgets/label.h"
#include "widgets/widget_style.h"
#include "control/signal.h"

Include dependency graph for thumbnail.c:

Macros
#define	thumb_return_if_fails(thumb, ...) { if(!thumb \|\| !thumb->widget \|\| !thumb->w_main) return __VA_ARGS__; }

#define	DEBUG 0

Functions
static void	_set_flag (GtkWidget *w, GtkStateFlags flag, gboolean activate)

static void	_image_update_group_tooltip (dt_thumbnail_t *thumb)

static void	_thumb_update_rating_class (dt_thumbnail_t *thumb)

static void	_thumb_write_extension (dt_thumbnail_t *thumb)

static GtkWidget *	_gtk_menu_item_new_with_markup (const char label, GtkWidget menu, void(activate_callback)(GtkWidget widget, dt_thumbnail_t thumb), dt_thumbnail_t thumb)

static GtkWidget *	_menuitem_from_text (const char label, const char value, GtkWidget menu, void(activate_callback)(GtkWidget widget, dt_thumbnail_t thumb), dt_thumbnail_t *thumb)

static void	_color_label_callback (GtkWidget widget, dt_thumbnail_t thumb)

static void	_preview_window_open (GtkWidget widget, dt_thumbnail_t thumb)

static void	_active_module_row (void user_data, const int num, const char op, const char *multi)

static void	_active_modules_popup (GtkWidget widget, dt_thumbnail_t thumb)

static GtkWidget *	_create_menu (dt_thumbnail_t *thumb)

static gboolean	_event_cursor_draw (GtkWidget widget, cairo_t cr, gpointer user_data)

static void	_free_image_surface (dt_thumbnail_t *thumb)

static void	_thumbnail_free (dt_thumbnail_t *thumb)

static void	_thumbnail_release (void *data)

static gboolean	_main_context_queue_draw (GtkWidget *widget)

static void	_thumb_job_state_changed (dt_job_t *job, dt_job_state_t state)

static int	_finish_buffer_thread (dt_thumbnail_t thumb, dt_job_t job, gboolean success)

int32_t	_get_image_buffer (dt_job_t *job)

int	dt_thumbnail_get_image_buffer (dt_thumbnail_t *thumb)

static gboolean	_thumb_draw_image (GtkWidget widget, cairo_t cr, gpointer user_data)

static void	_thumb_update_icons (dt_thumbnail_t *thumb)

static gboolean	_event_main_press (GtkWidget widget, GdkEventButton event, gpointer user_data)

static gboolean	_event_main_release (GtkWidget widget, GdkEventButton event, gpointer user_data)

static gboolean	_event_rating_release (GtkWidget widget, GdkEventButton event, gpointer user_data)

static gboolean	_event_grouping_release (GtkWidget widget, GdkEventButton event, gpointer user_data)

static gboolean	_event_audio_release (GtkWidget widget, GdkEventButton event, gpointer user_data)

void	dt_thumbnail_update_selection (dt_thumbnail_t *thumb, gboolean selected)

void	_create_alternative_view (dt_thumbnail_t *thumb)

void	dt_thumbnail_alternative_mode (dt_thumbnail_t *thumb, gboolean enable)

static gboolean	_event_star_enter (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

static gboolean	_event_star_leave (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

gboolean	_event_expose (GtkWidget self, cairo_t cr, gpointer user_data)

static gboolean	_event_main_motion (GtkWidget widget, GdkEventMotion event, gpointer user_data)

static gboolean	_event_main_enter (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

static gboolean	_event_main_leave (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

static gboolean	_altered_enter (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

static gboolean	_group_enter (GtkWidget widget, GdkEventCrossing event, gpointer user_data)

static gboolean	_event_image_press (GtkWidget widget, GdkEventButton event, gpointer user_data)

static gboolean	_event_image_motion (GtkWidget widget, GdkEventMotion event, gpointer user_data)

static gboolean	_event_image_release (GtkWidget widget, GdkEventButton event, gpointer user_data)

GtkWidget *	dt_thumbnail_create_widget (dt_thumbnail_t *thumb)

void	dt_thumbnail_resync_info (dt_thumbnail_t thumb, const dt_image_t const info)

dt_thumbnail_t *	dt_thumbnail_new (int rowid, dt_thumbnail_overlay_t over, dt_thumbtable_t table, dt_image_t info)

int	dt_thumbnail_destroy (dt_thumbnail_t *thumb)

void	dt_thumbnail_update_gui (dt_thumbnail_t *thumb)

void	dt_thumbnail_set_overlay (dt_thumbnail_t *thumb, dt_thumbnail_overlay_t mode)

void	_widget_set_size (GtkWidget w, int parent_width, int *parent_height, const gboolean update)

static int	_thumb_resize_overlays (dt_thumbnail_t *thumb, int width, int height)

void	dt_thumbnail_resize (dt_thumbnail_t *thumb, int width, int height)

void	dt_thumbnail_set_group_border (dt_thumbnail_t *thumb, dt_thumbnail_border_t border)

void	dt_thumbnail_set_mouseover (dt_thumbnail_t *thumb, gboolean over)

void	dt_thumbnail_set_drop (dt_thumbnail_t *thumb, gboolean accept_drop)

int	dt_thumbnail_image_refresh_real (dt_thumbnail_t *thumb)

Detailed Description

this is the thumbnail class for the lighttable module.

WARNING: because we create and destroy thumbnail objects dynamically when scrolling, and we don't manually cleanup the Gtk signal handlers attached to widgets, some callbacks/handlers can be left hanging, still record events, but send them to non-existing objects. This is why we need to ensure user_data is not NULL everywhere.

Definition in file thumbnail.c.

Macro Definition Documentation

◆ DEBUG

#define DEBUG 0

Definition at line 753 of file thumbnail.c.

◆ thumb_return_if_fails

#define thumb_return_if_fails	(	thumb,
		...
	)	{ if(!thumb \|\| !thumb->widget \|\| !thumb->w_main) return __VA_ARGS__; }

Definition at line 78 of file thumbnail.c.

Function Documentation

◆ _active_module_row()

static void _active_module_row	(	void *	user_data,
		const int	num,
		const char *	op,
		const char *	multi
	)

static

Definition at line 210 of file thumbnail.c.

Referenced by _active_modules_popup().

◆ _active_modules_popup()

static void _active_modules_popup	(	GtkWidget *	widget,
		dt_thumbnail_t *	thumb
	)

static

Definition at line 221 of file thumbnail.c.

References _active_module_row(), dt_gui_main_window(), dt_gui_textview_set_padding(), dt_history_repository_foreach_active_module(), FALSE, dt_image_t::filename, dt_image_t::fullpath, dt_image_t::id, dt_thumbnail_t::info, IS_NULL_PTR, scrolled(), TRUE, view, and void().

Referenced by _create_menu().

◆ _altered_enter()

static gboolean _altered_enter	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 1082 of file thumbnail.c.

References dt_free, dt_history_get_items_as_string(), dt_thumbtable_info_is_altered(), FALSE, dt_image_t::id, dt_thumbnail_t::info, thumb_return_if_fails, tooltip, TRUE, and dt_thumbnail_t::w_altered.

Referenced by dt_thumbnail_create_widget().

◆ _color_label_callback()

static void _color_label_callback	(	GtkWidget *	widget,
		dt_thumbnail_t *	thumb
	)

static

Definition at line 197 of file thumbnail.c.

References color, dt_colorlabels_toggle_label_on_list(), dt_image_t::id, dt_thumbnail_t::info, and TRUE.

Referenced by _create_menu().

◆ _create_alternative_view()

void _create_alternative_view ( dt_thumbnail_t * thumb )

◆ _create_menu()

static GtkWidget * _create_menu ( dt_thumbnail_t * thumb )

static

image info

color labels

Definition at line 269 of file thumbnail.c.

References _active_modules_popup(), _color_label_callback(), _gtk_menu_item_new_with_markup(), _menuitem_from_text(), _preview_window_open(), dt_image_t::camera_makermodel, dt_image_t::datetime, dt_image_t::exif_lens, FALSE, dt_image_t::filename, dt_image_t::folder, and dt_thumbnail_t::info.

Referenced by _event_main_press().

◆ _event_audio_release()

static gboolean _event_audio_release	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 896 of file thumbnail.c.

References dt_view_manager_t::audio_player_id, dt_thumbnail_t::disable_actions, dt_view_audio_start(), dt_view_audio_stop(), dt_view_manager_get_global(), dtgtk_thumbnail_btn_is_hidden(), FALSE, dt_image_t::id, dt_thumbnail_t::info, thumb_return_if_fails, and TRUE.

Referenced by dt_thumbnail_create_widget().

◆ _event_cursor_draw()

static gboolean _event_cursor_draw	(	GtkWidget *	widget,
		cairo_t *	cr,
		gpointer	user_data
	)

static

Definition at line 328 of file thumbnail.c.

References state, thumb_return_if_fails, TRUE, and dt_thumbnail_t::w_cursor.

Referenced by dt_thumbnail_create_widget().

◆ _event_expose()

gboolean _event_expose	(	GtkWidget *	self,
		cairo_t *	cr,
		gpointer	user_data
	)

Definition at line 1023 of file thumbnail.c.

References FALSE, thumb_return_if_fails, and TRUE.

Referenced by dt_thumbnail_create_widget().

◆ _event_grouping_release()

static gboolean _event_grouping_release	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 886 of file thumbnail.c.

References dt_thumbnail_t::disable_actions, dt_grouping_change_representative(), dtgtk_thumbnail_btn_is_hidden(), FALSE, dt_image_t::id, dt_thumbnail_t::info, thumb_return_if_fails, and TRUE.

Referenced by dt_thumbnail_create_widget().

◆ _event_image_motion()

static gboolean _event_image_motion	(	GtkWidget *	widget,
		GdkEventMotion *	event,
		gpointer	user_data
	)

static

Definition at line 1123 of file thumbnail.c.

References dt_thumbnail_t::drag_x_start, dt_thumbnail_t::drag_y_start, dt_thumbnail_t::dragging, dt_modifier_is(), dt_thumbtable_offset_zoom(), FALSE, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, dt_thumbnail_t::w_image, dt_thumbnail_t::zoomx, and dt_thumbnail_t::zoomy.

Referenced by dt_thumbnail_create_widget().

◆ _event_image_press()

static gboolean _event_image_press	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 1108 of file thumbnail.c.

References dt_thumbnail_t::drag_x_start, dt_thumbnail_t::drag_y_start, dt_thumbnail_t::dragging, DT_THUMBTABLE_ZOOM_FIT, FALSE, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, and dt_thumbtable_t::zoom.

Referenced by dt_thumbnail_create_widget().

◆ _event_image_release()

static gboolean _event_image_release	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 1157 of file thumbnail.c.

References dt_thumbnail_t::dragging, FALSE, thumb_return_if_fails, and TRUE.

Referenced by dt_thumbnail_create_widget().

◆ _event_main_enter()

static gboolean _event_main_enter	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 1051 of file thumbnail.c.

References dt_control_set_mouse_over_id(), dt_thumbnail_set_mouseover(), dt_thumbtable_dispatch_over(), FALSE, dt_image_t::id, dt_thumbnail_t::info, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, and dt_thumbnail_t::widget.

Referenced by dt_thumbnail_create_widget().

◆ _event_main_leave()

static gboolean _event_main_leave	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 1066 of file thumbnail.c.

References dt_control_set_mouse_over_id(), dt_thumbnail_set_mouseover(), dt_thumbtable_dispatch_over(), FALSE, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, and dt_thumbnail_t::widget.

Referenced by dt_thumbnail_create_widget().

◆ _event_main_motion()

static gboolean _event_main_motion	(	GtkWidget *	widget,
		GdkEventMotion *	event,
		gpointer	user_data
	)

static

Definition at line 1030 of file thumbnail.c.

References dt_control_set_mouse_over_id(), dt_thumbnail_set_mouseover(), dt_thumbtable_dispatch_over(), FALSE, dt_image_t::id, dt_thumbnail_t::info, dt_thumbnail_t::mouse_over, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, and dt_thumbnail_t::widget.

Referenced by dt_thumbnail_create_widget().

◆ _event_main_press()

static gboolean _event_main_press	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 798 of file thumbnail.c.

References _create_menu(), dt_thumbnail_t::dragging, dt_control_set_mouse_over_id(), dt_control_signal_get_global(), DT_DEBUG_CONTROL_SIGNAL_RAISE, DT_SIGNAL_VIEWMANAGER_THUMBTABLE_ACTIVATE, dt_thumbtable_dispatch_over(), FALSE, dt_image_t::id, dt_thumbnail_t::info, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, and dt_thumbnail_t::widget.

Referenced by dt_thumbnail_create_widget().

◆ _event_main_release()

static gboolean _event_main_release	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

◆ _event_rating_release()

static gboolean _event_rating_release	(	GtkWidget *	widget,
		GdkEventButton *	event,
		gpointer	user_data
	)

static

Definition at line 857 of file thumbnail.c.

References dt_thumbnail_t::disable_actions, dt_ratings_apply_on_image(), DT_VIEW_DESERT, DT_VIEW_REJECT, DT_VIEW_STAR_1, DT_VIEW_STAR_2, DT_VIEW_STAR_3, DT_VIEW_STAR_4, DT_VIEW_STAR_5, dtgtk_thumbnail_btn_is_hidden(), FALSE, dt_image_t::id, dt_thumbnail_t::info, thumb_return_if_fails, TRUE, dt_thumbnail_t::w_reject, and dt_thumbnail_t::w_stars.

Referenced by dt_thumbnail_create_widget().

◆ _event_star_enter()

static gboolean _event_star_enter	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 983 of file thumbnail.c.

References _set_flag(), dt_thumbnail_t::disable_actions, FALSE, i, MAX_STARS, thumb_return_if_fails, TRUE, dt_thumbnail_t::w_bottom_eb, and dt_thumbnail_t::w_stars.

Referenced by dt_thumbnail_create_widget().

◆ _event_star_leave()

static gboolean _event_star_leave	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 1006 of file thumbnail.c.

References _set_flag(), dt_thumbnail_t::disable_actions, DT_VIEW_REJECT, FALSE, i, dt_thumbnail_t::info, MAX_STARS, dt_image_t::rating, thumb_return_if_fails, TRUE, and dt_thumbnail_t::w_stars.

Referenced by dt_thumbnail_create_widget().

◆ _finish_buffer_thread()

static int _finish_buffer_thread	(	dt_thumbnail_t *	thumb,
		dt_job_t *	job,
		gboolean	success
	)

static

Definition at line 434 of file thumbnail.c.

References _main_context_queue_draw(), dt_thumbnail_t::destroying, dt_atomic_get_int(), dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), dt_thumbnail_t::image_inited, IS_NULL_PTR, dt_thumbnail_t::job, dt_thumbnail_t::lock, thumb_return_if_fails, and dt_thumbnail_t::w_image.

Referenced by _get_image_buffer().

◆ _free_image_surface()

static void _free_image_surface ( dt_thumbnail_t * thumb )

static

Definition at line 349 of file thumbnail.c.

References dt_thumbnail_t::img_surf.

Referenced by _get_image_buffer(), and _thumbnail_free().

◆ _get_image_buffer()

int32_t _get_image_buffer ( dt_job_t * job )

Definition at line 470 of file thumbnail.c.

References _finish_buffer_thread(), _free_image_surface(), color_space, dt_thumbnail_t::destroying, double(), dt_atomic_get_int(), dt_control_job_get_params(), dt_control_job_get_state(), DT_DEBUG_LIGHTTABLE, dt_focus_create_clusters(), dt_focus_draw_clusters(), dt_focuspeaking(), dt_imageio_large_thumbnail(), DT_JOB_STATE_CANCELLED, dt_pixelpipe_cache_free_align, dt_print(), dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), DT_THUMBTABLE_ZOOM_FIT, dt_view_image_get_surface(), DT_VIEW_SURFACE_OK, FALSE, dt_thumbtable_t::focus_peaking, dt_thumbtable_t::focus_regions, dt_image_t::fullpath, dt_image_t::id, dt_thumbnail_t::img_h, dt_thumbnail_t::img_height, dt_thumbnail_t::img_surf, dt_thumbnail_t::img_w, dt_thumbnail_t::img_width, dt_thumbnail_t::info, IS_NULL_PTR, dt_thumbnail_t::job, dt_thumbnail_t::lock, res, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, dt_thumbnail_t::w_image, dt_thumbtable_t::zoom, dt_thumbnail_t::zoomx, and dt_thumbnail_t::zoomy.

Referenced by dt_thumbnail_get_image_buffer().

◆ _group_enter()

static gboolean _group_enter	(	GtkWidget *	widget,
		GdkEventCrossing *	event,
		gpointer	user_data
	)

static

Definition at line 1099 of file thumbnail.c.

References _image_update_group_tooltip(), FALSE, thumb_return_if_fails, and TRUE.

Referenced by dt_thumbnail_create_widget().

◆ _gtk_menu_item_new_with_markup()

static GtkWidget * _gtk_menu_item_new_with_markup	(	const char *	label,
		GtkWidget *	menu,
		void()(GtkWidget widget, dt_thumbnail_t *thumb)	activate_callback,
		dt_thumbnail_t *	thumb
	)

static

Definition at line 171 of file thumbnail.c.

References FALSE.

Referenced by _create_menu(), and _menuitem_from_text().

◆ _image_update_group_tooltip()

static void _image_update_group_tooltip ( dt_thumbnail_t * thumb )

static

◆ _main_context_queue_draw()

static gboolean _main_context_queue_draw ( GtkWidget * widget )

static

Definition at line 424 of file thumbnail.c.

Referenced by _finish_buffer_thread(), and _thumb_job_state_changed().

◆ _menuitem_from_text()

static GtkWidget * _menuitem_from_text	(	const char *	label,
		const char *	value,
		GtkWidget *	menu,
		void()(GtkWidget widget, dt_thumbnail_t *thumb)	activate_callback,
		dt_thumbnail_t *	thumb
	)

static

Definition at line 187 of file thumbnail.c.

References _gtk_menu_item_new_with_markup(), dt_free, and value.

Referenced by _create_menu().

◆ _preview_window_open()

static void _preview_window_open	(	GtkWidget *	widget,
		dt_thumbnail_t *	thumb
	)

static

Definition at line 205 of file thumbnail.c.

References dt_preview_window_spawn(), dt_image_t::id, and dt_thumbnail_t::info.

Referenced by _create_menu().

◆ _set_flag()

static void _set_flag	(	GtkWidget *	w,
		GtkStateFlags	flag,
		gboolean	activate
	)

static

Definition at line 81 of file thumbnail.c.

References FALSE, and flag.

Referenced by _event_star_enter(), _event_star_leave(), _thumb_resize_overlays(), _thumb_update_icons(), and dt_thumbnail_set_mouseover().

◆ _thumb_draw_image()

static gboolean _thumb_draw_image	(	GtkWidget *	widget,
		cairo_t *	cr,
		gpointer	user_data
	)

static

thumb->image_inited is the validity flag for the image surface. While it is FALSE, pending a new thumbnail, we may still hold an outdated thumbnail that can be painted into the widget, pending the new one.

can_draw means we have a size mismatch between the surface and the widget.

Definition at line 691 of file thumbnail.c.

References dt_control_draw_busy_msg(), DT_DEBUG_LIGHTTABLE, dt_print(), dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), dt_thumbnail_get_image_buffer(), DT_THUMBTABLE_ZOOM_FIT, dt_image_t::id, dt_thumbnail_t::image_inited, dt_thumbnail_t::img_height, dt_thumbnail_t::img_surf, dt_thumbnail_t::img_width, dt_thumbnail_t::info, IS_NULL_PTR, dt_thumbnail_t::lock, dt_thumbnail_t::table, thumb_return_if_fails, TRUE, dt_thumbnail_t::w_image, dt_thumbtable_t::zoom, dt_thumbnail_t::zoomx, and dt_thumbnail_t::zoomy.

Referenced by dt_thumbnail_create_widget().

◆ _thumb_job_state_changed()

static void _thumb_job_state_changed	(	dt_job_t *	job,
		dt_job_state_t	state
	)

static

The widget re-requests a render only while thumb->job is NULL, so every way a job can stop existing without committing its surface must clear thumb->job, or the widget stays on the "Working..." overlay forever with an idle CPU (issue #972). The render thread handles the nominal paths, but the job system can also kill a job behind the widget's back: dt_control_add_job() silently disposes a job it deems a duplicate (equality is the description string, i.e. the image id, so two widgets or a refresh-orphaned job collide), the DT_JOB_QUEUE_SYSTEM_FG stack drops its oldest entries past DT_CONTROL_MAX_JOBS, and queue flushes cancel jobs that then get disposed without ever running. This state hook fires on every terminal transition (params are still valid on DISPOSED: dt_control_job_dispose() sets the state before destroying params), re-arms the widget when the dying job is still the gating one, and queues a redraw so the next expose re-requests.

Definition at line 390 of file thumbnail.c.

References _main_context_queue_draw(), dt_thumbnail_t::destroying, dt_atomic_get_int(), dt_control_job_get_params(), DT_JOB_STATE_CANCELLED, DT_JOB_STATE_DISCARDED, DT_JOB_STATE_DISPOSED, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), IS_NULL_PTR, dt_thumbnail_t::job, dt_thumbnail_t::lock, state, and dt_thumbnail_t::w_image.