#include "common/image.h"
#include "system/atomic.h"
#include "system/dtpthread.h"
#include "history/history.h"
#include "common/cups_print.h"
#include "common/printing.h"
#include "metadata/geo.h"
#include "metadata/map_locations.h"
#include <osm-gps-map.h>
#include <cairo.h>
#include <gmodule.h>
#include <inttypes.h>
#include <sqlite3.h>
#include "views/view_api.h"

Include dependency graph for view.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	dt_view_image_surface_fetcher_t
	Track one asynchronous Cairo surface fetch request for a GUI widget. More...

struct	dt_view_t

struct	dt_view_manager_t

Macros
#define	DT_VIEW_ALL

#define	DT_LIGHTTABLE_MAX_ZOOM 12

#define	INCLUDE_API_FROM_MODULE_H

Typedefs
typedef enum dt_view_flags_t	dt_view_flags_t

typedef enum dt_darkroom_layout_t	dt_darkroom_layout_t

typedef enum dt_view_surface_value_t	dt_view_surface_value_t

typedef struct _dt_job_t	dt_job_t

typedef struct dt_view_image_surface_fetcher_t	dt_view_image_surface_fetcher_t
	Track one asynchronous Cairo surface fetch request for a GUI widget.

typedef struct dt_view_t	dt_view_t

typedef struct dt_view_manager_t	dt_view_manager_t

Enumerations
enum	dt_view_type_flags_t { DT_VIEW_LIGHTTABLE = 1 << 0 , DT_VIEW_STUDIO_CAPTURE = 1 << 1 , DT_VIEW_DARKROOM = 1 << 2 , DT_VIEW_MAP = 1 << 3 , DT_VIEW_SLIDESHOW = 1 << 4 , DT_VIEW_PRINT = 1 << 5 }

enum	dt_view_flags_t { VIEW_FLAGS_NONE = 0 , VIEW_FLAGS_HIDDEN = 1 << 0 , VIEW_FLAGS_PAINTS_WHOLE_AREA = 1 << 1 }

enum	dt_darkroom_layout_t { DT_DARKROOM_LAYOUT_FIRST = -1 , DT_DARKROOM_LAYOUT_EDITING = 0 , DT_DARKROOM_LAYOUT_COLOR_ASSESMENT = 1 , DT_DARKROOM_LAYOUT_LAST = 3 }

enum	dt_view_surface_value_t { DT_VIEW_SURFACE_OK = 0 , DT_VIEW_SURFACE_KO }

Functions
char *	dt_view_extend_modes_str (const char *name, const gboolean is_hdr, const gboolean is_bw, const gboolean is_bw_flow)

dt_view_surface_value_t	dt_view_image_get_surface (int32_t imgid, int width, int height, cairo_surface_t **surface, int zoom)

void	dt_view_image_surface_fetcher_init (dt_view_image_surface_fetcher_t *fetcher)

void	dt_view_image_surface_fetcher_cleanup (dt_view_image_surface_fetcher_t *fetcher)

void	dt_view_image_surface_fetcher_invalidate (dt_view_image_surface_fetcher_t fetcher, cairo_surface_t *target)

dt_view_surface_value_t	dt_view_image_get_surface_async (dt_view_image_surface_fetcher_t fetcher, int32_t imgid, int width, int height, cairo_surface_t target, GtkWidget widget, int zoom)

struct dt_view_manager_t *	dt_view_manager_get_global (void)

void	dt_view_manager_init (dt_view_manager_t *vm)

void	dt_view_manager_gui_init (dt_view_manager_t *vm)

void	dt_view_manager_cleanup (dt_view_manager_t *vm)

const char *	dt_view_manager_name (dt_view_manager_t *vm)

int	dt_view_manager_switch (dt_view_manager_t vm, const char view_name)

int	dt_view_manager_switch_by_view (dt_view_manager_t vm, const dt_view_t new_view)

uint32_t	dt_view_manager_current_flags (const dt_view_manager_t *vm)

void	dt_view_manager_expose (dt_view_manager_t vm, cairo_t cr, int32_t width, int32_t height, int32_t pointerx, int32_t pointery)

void	dt_view_manager_reset (dt_view_manager_t *vm)

const dt_view_t *	dt_view_manager_get_current_view (dt_view_manager_t *vm)

void	dt_view_manager_mouse_enter (dt_view_manager_t *vm)

void	dt_view_manager_mouse_leave (dt_view_manager_t *vm)

void	dt_view_manager_mouse_moved (dt_view_manager_t *vm, double x, double y, double pressure, int which)

int	dt_view_manager_button_released (dt_view_manager_t *vm, double x, double y, int which, uint32_t state)

int	dt_view_manager_button_pressed (dt_view_manager_t *vm, double x, double y, double pressure, int which, int type, uint32_t state)

int	dt_view_manager_key_pressed (dt_view_manager_t vm, GdkEventKey event)

void	dt_view_manager_configure (dt_view_manager_t *vm, int width, int height)

int	dt_view_manager_scrolled (dt_view_manager_t *vm, double x, double y, int up, int state, int delta_y)

void	dt_view_manager_module_toolbox_add (dt_view_manager_t vm, GtkWidget tool, dt_view_type_flags_t view)

void	dt_view_image_info_update (const int32_t imgid)

void	dt_view_active_images_reset (gboolean raise)

void	dt_view_active_images_set (GList *images, gboolean raise)

void	dt_view_active_images_add (int32_t imgid, gboolean raise)

void	dt_view_active_images_remove (int32_t imgid, gboolean raise)

gboolean	dt_view_active_images_has_imgid (int32_t imgid)

GList *	dt_view_active_images_get_all ()

int32_t	dt_view_active_images_get_first ()

cairo_surface_t *	dt_cairo_rescale_surface (cairo_surface_t *src, int dst_w, int dst_h)

void	dt_cairo_sharpen_surface_rgb24 (cairo_surface_t *surface)

dt_darkroom_layout_t	dt_view_darkroom_get_layout (dt_view_manager_t *vm)

void	dt_view_audio_start (dt_view_manager_t *vm, int32_t imgid)

void	dt_view_audio_stop (dt_view_manager_t *vm)

void	dt_view_map_center_on_location (const dt_view_manager_t *vm, gdouble lon, gdouble lat, gdouble zoom)

void	dt_view_map_center_on_bbox (const dt_view_manager_t *vm, gdouble lon1, gdouble lat1, gdouble lon2, gdouble lat2)

void	dt_view_map_show_osd (const dt_view_manager_t *vm)

void	dt_view_map_set_map_source (const dt_view_manager_t *vm, OsmGpsMapSource_t map_source)

GObject *	dt_view_map_add_marker (const dt_view_manager_t vm, dt_geo_map_display_t type, GList points)

gboolean	dt_view_map_remove_marker (const dt_view_manager_t vm, dt_geo_map_display_t type, GObject marker)

void	dt_view_map_add_location (const dt_view_manager_t vm, dt_map_location_data_t p, const guint posid)

void	dt_view_map_location_action (const dt_view_manager_t *vm, const int action)

void	dt_view_map_redraw (const dt_view_manager_t *vm)

void	dt_view_print_settings (const dt_view_manager_t vm, dt_print_info_t pinfo, dt_images_box *imgs)

Macro Definition Documentation

◆ DT_LIGHTTABLE_MAX_ZOOM

#define DT_LIGHTTABLE_MAX_ZOOM 12

Definition at line 145 of file view.h.

◆ DT_VIEW_ALL

#define DT_VIEW_ALL

Value:

DT_VIEW_PRINT)

DT_VIEW_LIGHTTABLE

@ DT_VIEW_LIGHTTABLE

Definition view.h:77

DT_VIEW_PRINT

@ DT_VIEW_PRINT

Definition view.h:82

DT_VIEW_STUDIO_CAPTURE

@ DT_VIEW_STUDIO_CAPTURE

Definition view.h:78

DT_VIEW_SLIDESHOW

@ DT_VIEW_SLIDESHOW

Definition view.h:81

DT_VIEW_MAP

@ DT_VIEW_MAP

Definition view.h:80

DT_VIEW_DARKROOM

@ DT_VIEW_DARKROOM

Definition view.h:79

Definition at line 140 of file view.h.

◆ INCLUDE_API_FROM_MODULE_H

#define INCLUDE_API_FROM_MODULE_H

Definition at line 152 of file view.h.

Typedef Documentation

◆ dt_darkroom_layout_t

typedef enum dt_darkroom_layout_t dt_darkroom_layout_t

◆ dt_job_t

typedef struct _dt_job_t dt_job_t

Definition at line 109 of file view.h.

◆ dt_view_flags_t

typedef enum dt_view_flags_t dt_view_flags_t

◆ dt_view_image_surface_fetcher_t

typedef struct dt_view_image_surface_fetcher_t dt_view_image_surface_fetcher_t

Track one asynchronous Cairo surface fetch request for a GUI widget.

The fetcher owns the background job bookkeeping and the current cached surface metadata. The actual Cairo surface remains owned by the caller through the target pointer passed to dt_view_image_get_surface_async().

◆ dt_view_manager_t

typedef struct dt_view_manager_t dt_view_manager_t

holds all relevant data needed to manage the view modules.

◆ dt_view_surface_value_t

typedef enum dt_view_surface_value_t dt_view_surface_value_t

◆ dt_view_t

typedef struct dt_view_t dt_view_t

main dt view module (as lighttable or darkroom)

Enumeration Type Documentation

◆ dt_darkroom_layout_t

enum dt_darkroom_layout_t

Enumerator
DT_DARKROOM_LAYOUT_FIRST
DT_DARKROOM_LAYOUT_EDITING
DT_DARKROOM_LAYOUT_COLOR_ASSESMENT
DT_DARKROOM_LAYOUT_LAST

Definition at line 93 of file view.h.

◆ dt_view_flags_t

enum dt_view_flags_t

Enumerator
VIEW_FLAGS_NONE
VIEW_FLAGS_HIDDEN
VIEW_FLAGS_PAINTS_WHOLE_AREA

Definition at line 86 of file view.h.

◆ dt_view_surface_value_t

enum dt_view_surface_value_t

Enumerator
DT_VIEW_SURFACE_OK
DT_VIEW_SURFACE_KO

Definition at line 103 of file view.h.

◆ dt_view_type_flags_t

enum dt_view_type_flags_t

available views flags, a view should return its type and is also used in modules flags available in src/libs to control which view the module should be available in also which placement in the panels the module have.

Enumerator
DT_VIEW_LIGHTTABLE
DT_VIEW_STUDIO_CAPTURE
DT_VIEW_DARKROOM
DT_VIEW_MAP
DT_VIEW_SLIDESHOW
DT_VIEW_PRINT

Definition at line 75 of file view.h.

Function Documentation

◆ dt_cairo_rescale_surface()

cairo_surface_t * dt_cairo_rescale_surface	(	cairo_surface_t *	src,
		int	dst_w,
		int	dst_h
	)

rescale the image surface pending the real updated image availability

Definition at line 933 of file view.c.

References double(), and MIN.

◆ dt_cairo_sharpen_surface_rgb24()

void dt_cairo_sharpen_surface_rgb24 ( cairo_surface_t * surface )

Definition at line 982 of file view.c.

References __OMP_PARALLEL_FOR__, copy(), dt_alloc_align(), dt_free_align, height, i, out, v, width, and x.

◆ dt_view_active_images_add()

void dt_view_active_images_add	(	int32_t	imgid,
		gboolean	raise
	)

Definition at line 1276 of file view.c.

References dt_view_manager_t::active_images, dt_control_signal_get_global(), DT_DEBUG_CONTROL_SIGNAL_RAISE, DT_SIGNAL_ACTIVE_IMAGES_CHANGE, and dt_view_manager_get_global().

Referenced by _darkroom_image_loaded_callback(), _step_state(), _studio_set_image(), and enter().

◆ dt_view_active_images_get_all()

GList * dt_view_active_images_get_all ( )

Definition at line 1302 of file view.c.

References dt_view_manager_t::active_images, and dt_view_manager_get_global().

Referenced by _view_map_display_selected(), dt_act_on_get_images(), dt_act_on_get_images_nb(), dt_view_active_images_has_imgid(), enter(), leave(), and try_enter().

◆ dt_view_active_images_get_first()

int32_t dt_view_active_images_get_first ( )

Definition at line 1307 of file view.c.

References dt_view_manager_t::active_images, dt_view_manager_get_global(), and IS_NULL_PTR.

Referenced by _print_setup_initial_image(), _studio_style_apply_callback(), dt_act_on_get_first_image(), dt_act_on_get_images(), dt_act_on_get_images_nb(), dt_ui_panel_show(), enter(), and leave().

◆ dt_view_active_images_has_imgid()

gboolean dt_view_active_images_has_imgid ( int32_t imgid )

Definition at line 1297 of file view.c.

References dt_view_active_images_get_all().

Referenced by _filmstrip_is_thumb_highlighted().

◆ dt_view_active_images_remove()

void dt_view_active_images_remove	(	int32_t	imgid,
		gboolean	raise
	)

Definition at line 1284 of file view.c.

References dt_view_manager_t::active_images, dt_control_signal_get_global(), DT_DEBUG_CONTROL_SIGNAL_RAISE, DT_SIGNAL_ACTIVE_IMAGES_CHANGE, and dt_view_manager_get_global().

◆ dt_view_active_images_reset()

void dt_view_active_images_reset ( gboolean raise )

Definition at line 1266 of file view.c.

References dt_view_manager_t::active_images, dt_control_signal_get_global(), DT_DEBUG_CONTROL_SIGNAL_RAISE, DT_SIGNAL_ACTIVE_IMAGES_CHANGE, dt_view_manager_get_global(), and IS_NULL_PTR.

Referenced by _darkroom_image_loaded_callback(), _step_state(), _studio_set_image(), _view_map_selection_changed(), enter(), leave(), and try_enter().

◆ dt_view_active_images_set()

void dt_view_active_images_set	(	GList *	images,
		gboolean	raise
	)

Definition at line 1314 of file view.c.

References dt_view_manager_t::active_images, dt_control_signal_get_global(), DT_DEBUG_CONTROL_SIGNAL_RAISE, DT_SIGNAL_ACTIVE_IMAGES_CHANGE, dt_view_manager_get_global(), and IS_NULL_PTR.

Referenced by _view_map_selection_changed(), and enter().

◆ dt_view_audio_start()

void dt_view_audio_start	(	dt_view_manager_t *	vm,
		int32_t	imgid
	)

Definition at line 1417 of file view.c.

References _audio_child_watch(), dt_view_manager_t::audio, dt_view_manager_t::audio_player_event_source, dt_view_manager_t::audio_player_id, dt_view_manager_t::audio_player_pid, dt_conf_get_string(), dt_free, and dt_image_get_audio_path().

Referenced by _event_audio_release().

◆ dt_view_audio_stop()

void dt_view_audio_stop ( dt_view_manager_t * vm )

Todo:: : add Windows code to actually kill the process

Definition at line 1449 of file view.c.

References dt_view_manager_t::audio, dt_view_manager_t::audio_player_event_source, dt_view_manager_t::audio_player_id, and dt_view_manager_t::audio_player_pid.

Referenced by _event_audio_release().

◆ dt_view_darkroom_get_layout()

dt_darkroom_layout_t dt_view_darkroom_get_layout ( dt_view_manager_t * vm )

get the darkroom current layout

Definition at line 1335 of file view.c.

References dt_view_manager_t::darkroom, DT_DARKROOM_LAYOUT_EDITING, dt_view_manager_t::get_layout, dt_view_manager_t::proxy, and dt_view_manager_t::view.

Referenced by _conf_get_path(), _get_lib_view_path(), and panels_get_view_path().

◆ dt_view_extend_modes_str()

char * dt_view_extend_modes_str	(	const char *	name,
		const gboolean	is_hdr,
		const gboolean	is_bw,
		const gboolean	is_bw_flow
	)

returns an uppercase string of file extension plus some flag information

Definition at line 1220 of file view.c.

References dt_free, and name.

Referenced by _thumb_write_extension().

◆ dt_view_image_get_surface()

dt_view_surface_value_t dt_view_image_get_surface	(	int32_t	imgid,
		int	width,
		int	height,
		cairo_surface_t **	surface,
		int	zoom
	)

expose an image and return a cair0_surface.

Definition at line 1214 of file view.c.

References _view_image_get_surface_internal(), height, and width.

Referenced by _draw_transient_image(), and _get_image_buffer().

◆ dt_view_image_get_surface_async()

dt_view_surface_value_t dt_view_image_get_surface_async	(	dt_view_image_surface_fetcher_t *	fetcher,
		int32_t	imgid,
		int	width,
		int	height,
		cairo_surface_t **	target,
		GtkWidget *	widget,
		int	zoom
	)

Definition at line 892 of file view.c.

Referenced by _draw_image(), _slideshow_request_slot(), _thumb_draw_image(), expose(), and expose().

◆ dt_view_image_info_update()

void dt_view_image_info_update ( const int32_t imgid )

◆ dt_view_image_surface_fetcher_cleanup()

void dt_view_image_surface_fetcher_cleanup ( dt_view_image_surface_fetcher_t * fetcher )

◆ dt_view_image_surface_fetcher_init()

void dt_view_image_surface_fetcher_init ( dt_view_image_surface_fetcher_t * fetcher )

Definition at line 836 of file view.c.

References dt_view_image_surface_fetcher_t::cached_imgid, dt_view_image_surface_fetcher_t::cond, dt_atomic_set_int(), dt_pthread_mutex_init(), FALSE, dt_view_image_surface_fetcher_t::imgid, dt_view_image_surface_fetcher_t::lock, dt_view_image_surface_fetcher_t::shutdown, UNKNOWN_IMAGE, and dt_view_image_surface_fetcher_t::widget_ref.

Referenced by _view_map_changed_callback_delayed(), dt_preview_window_spawn(), and init().

◆ dt_view_image_surface_fetcher_invalidate()

void dt_view_image_surface_fetcher_invalidate	(	dt_view_image_surface_fetcher_t *	fetcher,
		cairo_surface_t **	target
	)

◆ dt_view_manager_button_pressed()

int dt_view_manager_button_pressed	(	dt_view_manager_t *	vm,
		double	x,
		double	y,
		double	pressure,
		int	which,
		int	type,
		uint32_t	state
	)

Definition at line 601 of file view.c.

References dt_view_manager_t::current_view, dt_gui_main_window(), dt_lib_get_global(), dt_lib_is_visible_in_view(), dt_widget_set_scroll_focus(), FALSE, IS_NULL_PTR, state, TRUE, type, v, and x.

Referenced by dt_control_button_pressed().

◆ dt_view_manager_button_released()

int dt_view_manager_button_released	(	dt_view_manager_t *	vm,
		double	x,
		double	y,
		int	which,
		uint32_t	state
	)

Definition at line 574 of file view.c.

References dt_view_manager_t::current_view, dt_lib_get_global(), dt_lib_is_visible_in_view(), FALSE, IS_NULL_PTR, state, TRUE, v, and x.

Referenced by dt_control_button_released().

◆ dt_view_manager_cleanup()

void dt_view_manager_cleanup ( dt_view_manager_t * vm )

Definition at line 130 of file view.c.

References dt_view_manager_t::active_images, dt_free_gpointer(), dt_view_unload_module(), and dt_view_manager_t::views.

Referenced by dt_cleanup().

◆ dt_view_manager_configure()

void dt_view_manager_configure	(	dt_view_manager_t *	vm,
		int	width,
		int	height
	)

Definition at line 633 of file view.c.

References dt_view_t::data, height, v, dt_view_manager_t::views, and width.

Referenced by dt_control_configure(), and dt_gui_gtk_run().

◆ dt_view_manager_current_flags()

uint32_t dt_view_manager_current_flags ( const dt_view_manager_t * vm )

expose current module. the current view's flags(), or 0 when there is no view

Definition at line 444 of file view.c.

References dt_view_manager_t::current_view, and IS_NULL_PTR.

Referenced by dt_control_expose().

◆ dt_view_manager_expose()

void dt_view_manager_expose	(	dt_view_manager_t *	vm,
		cairo_t *	cr,
		int32_t	width,
		int32_t	height,
		int32_t	pointerx,
		int32_t	pointery
	)

Definition at line 450 of file view.c.

References dt_view_manager_t::current_view, DT_GUI_COLOR_BG, dt_lib_get_global(), dt_lib_is_visible_in_view(), dt_widget_set_source_rgb(), height, dt_view_t::height, IS_NULL_PTR, width, and dt_view_t::width.

Referenced by dt_control_expose().

◆ dt_view_manager_get_current_view()

const dt_view_t * dt_view_manager_get_current_view ( dt_view_manager_t * vm )

get current view of the view manager.

Definition at line 139 of file view.c.

References dt_view_manager_t::current_view.

Referenced by _conf_get_path(), _darkroom_edge_pan_update_state(), _dt_ctl_open_image_in_darkroom(), _folder_survey_styles_for_import(), _get_lib_view_path(), _grid_grab_focus(), _is_darkroom(), _is_lighttable(), _shape_manager_is_active(), _toggle_expanded(), available_in_lighttable_callback(), configure(), configure(), dt_collection_get_browsed_folder(), dt_collection_load_filmroll(), dt_control_delete_image(), dt_control_delete_images(), dt_control_remove_images(), dt_ctl_switch_mode_to(), dt_ctl_switch_mode_to_by_view(), dt_dev_undo_end_record(), dt_dev_undo_start_record(), dt_gui_refocus_center(), dt_image_flip(), dt_lib_gui_get_expanded(), dt_lib_gui_set_expanded(), panels_get_view_path(), redo_callback(), redo_sensitive_callback(), undo_callback(), undo_sensitive_callback(), views_active_callback(), and views_sensitive_callback().

◆ dt_view_manager_get_global()

struct dt_view_manager_t * dt_view_manager_get_global ( void )

The application's single view manager, owned by the orchestrator. Declared here so consumers do not need darktable.h for it. Implemented in darktable.c.

Definition at line 599 of file darktable.c.

References darktable, and darktable_t::view_manager.

Referenced by _all_tracks_toggled(), _clear_markers(), _commit_quiet(), _conf_get_path(), _create_one_button(), _darkroom_edge_pan_update_state(), _darkroom_image_loaded_callback(), _dev_change_image(), _dt_image_info_changed_callback(), _en_folders_lighttable(), _event_audio_release(), _folder_survey_styles_for_import(), _get_lib_view_path(), _grid_grab_focus(), _guides_add_guide(), _is_darkroom(), _is_lighttable(), _map_source_changed(), _media_changed(), _name_editing_done(), _paper_changed(), _parameter_changed(), _pop_menu_delete_location(), _pop_menu_goto_collection(), _refresh_display_all_tracks(), _refresh_display_track(), _refresh_images_displayed_on_track(), _remove_images_from_map(), _remove_tracks_from_map(), _selection_changed(), _self(), _set_orientation(), _set_printer(), _settings_flip_changed(), _settings_flip_update(), _settings_guides_changed(), _settings_update_visibility(), _shape_manager_add_popup_button_idle(), _shape_manager_is_active(), _show_all_button_clicked(), _show_location(), _show_location(), _show_osd_toggled(), _toggle_expanded(), _track_seg_toggled(), _update_slider(), _view_lighttable_activate_callback(), _view_map_collection_changed(), _view_map_geotag_changed(), _view_map_selection_changed(), append_views(), available_in_lighttable_callback(), cleanup(), configure(), configure(), dt_collection_get_browsed_folder(), dt_collection_load_filmroll(), dt_control_delete_image(), dt_control_delete_images(), dt_control_remove_images(), dt_dev_undo_end_record(), dt_dev_undo_start_record(), dt_film_open(), dt_folder_survey_propose_resume(), dt_guides_add_guide(), dt_guides_popover(), dt_guides_update_button_state(), dt_guides_update_popover_values(), dt_image_flip(), dt_lib_gui_get_expanded(), dt_lib_gui_set_expanded(), dt_lib_load_module(), dt_view_active_images_add(), dt_view_active_images_get_all(), dt_view_active_images_get_first(), dt_view_active_images_remove(), dt_view_active_images_reset(), dt_view_active_images_set(), dt_view_image_info_update(), enter(), geotag_changed(), gui_cleanup(), gui_init(), gui_init(), gui_post_expose(), init(), key_pressed(), leave(), panels_get_view_path(), redo_callback(), redo_sensitive_callback(), tag_changed(), undo_callback(), undo_sensitive_callback(), view_enter(), views_active_callback(), and views_sensitive_callback().