2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "image-overlay.h"
29 #include "histogram.h"
30 #include "image-load.h"
35 #include "main-defines.h"
37 #include "pixbuf-renderer.h"
38 #include "pixbuf-util.h"
39 #include "slideshow.h"
40 #include "ui-fileops.h"
43 *----------------------------------------------------------------------------
45 *----------------------------------------------------------------------------
49 struct OverlayStateData {
51 ImageState changed_states;
57 OverlayRendererFlags origin;
64 gint icon_time[IMAGE_OSD_COUNT];
65 gint icon_id[IMAGE_OSD_COUNT];
67 guint idle_id; /* event source id */
68 guint timer_id; /* event source id */
74 gboolean reset; /* reset on new image */
75 gint x; /* x, y offset */
77 gchar *key; /* inline pixbuf */
80 static OSDIcon osd_icons[] = {
81 { TRUE, 0, 0, nullptr }, /* none */
82 { TRUE, -10, -10, nullptr }, /* auto rotated */
83 { TRUE, -10, -10, nullptr }, /* user rotated */
84 { TRUE, -40, -10, nullptr }, /* color embedded */
85 { TRUE, -70, -10, nullptr }, /* first image */
86 { TRUE, -70, -10, nullptr }, /* last image */
87 { FALSE, -70, -10, nullptr }, /* osd enabled */
88 { FALSE, 0, 0, nullptr }
91 #define OSD_DATA "overlay-data"
94 IMAGE_OSD_DEFAULT_DURATION = 30
98 HISTOGRAM_HEIGHT = 140,
102 static void image_osd_timer_schedule(OverlayStateData *osd);
104 void set_image_overlay_template_string(gchar **template_string, const gchar *value)
106 g_assert(template_string);
108 g_free(*template_string);
109 *template_string = g_strdup(value);
113 void set_default_image_overlay_template_string(gchar **template_string)
115 set_image_overlay_template_string(template_string, DEFAULT_OVERLAY_INFO);
118 void set_image_overlay_font_string(gchar **font_string, const gchar *value)
120 g_assert(font_string);
122 g_free(*font_string);
123 *font_string = g_strdup(value);
126 static OverlayStateData *image_get_osd_data(ImageWindow *imd)
128 OverlayStateData *osd;
130 if (!imd) return nullptr;
134 osd = static_cast<OverlayStateData *>(g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA"));
138 static void image_set_osd_data(ImageWindow *imd, OverlayStateData *osd)
142 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
146 *----------------------------------------------------------------------------
148 *----------------------------------------------------------------------------
152 void image_osd_histogram_toggle_channel(ImageWindow *imd)
154 OverlayStateData *osd = image_get_osd_data(imd);
156 if (!osd || !osd->histogram) return;
158 histogram_toggle_channel(osd->histogram);
159 image_osd_update(imd);
162 void image_osd_histogram_toggle_mode(ImageWindow *imd)
164 OverlayStateData *osd = image_get_osd_data(imd);
166 if (!osd || !osd->histogram) return;
168 histogram_toggle_mode(osd->histogram);
169 image_osd_update(imd);
172 void image_osd_histogram_set_channel(ImageWindow *imd, gint chan)
174 OverlayStateData *osd = image_get_osd_data(imd);
176 if (!osd || !osd->histogram) return;
178 histogram_set_channel(osd->histogram, chan);
179 image_osd_update(imd);
182 void image_osd_histogram_set_mode(ImageWindow *imd, gint mode)
184 OverlayStateData *osd = image_get_osd_data(imd);
186 if (!osd || !osd->histogram) return;
188 histogram_set_mode(osd->histogram, mode);
189 image_osd_update(imd);
192 gint image_osd_histogram_get_channel(ImageWindow *imd)
194 OverlayStateData *osd = image_get_osd_data(imd);
196 if (!osd || !osd->histogram) return HCHAN_DEFAULT;
198 return histogram_get_channel(osd->histogram);
201 gint image_osd_histogram_get_mode(ImageWindow *imd)
203 OverlayStateData *osd = image_get_osd_data(imd);
205 if (!osd || !osd->histogram) return 0;
207 return histogram_get_mode(osd->histogram);
210 void image_osd_toggle(ImageWindow *imd)
215 show = image_osd_get(imd);
216 if (show == OSD_SHOW_NOTHING)
218 image_osd_set(imd, static_cast<OsdShowFlags>(OSD_SHOW_INFO | OSD_SHOW_STATUS));
222 if (show & OSD_SHOW_HISTOGRAM)
224 image_osd_set(imd, OSD_SHOW_NOTHING);
228 image_osd_set(imd, static_cast<OsdShowFlags>(show | OSD_SHOW_HISTOGRAM));
232 static GdkPixbuf *image_osd_info_render(OverlayStateData *osd)
234 GdkPixbuf *pixbuf = nullptr;
241 const HistMap *histmap = nullptr;
242 ImageWindow *imd = osd->imd;
243 FileData *fd = image_get_fd(imd);
244 PangoFontDescription *font_desc;
246 if (!fd) return nullptr;
248 name = image_get_name(imd);
257 vars = g_hash_table_new_full(g_str_hash, g_str_equal, nullptr, g_free);
259 cd = image_get_collection(imd, &info);
262 t = g_list_length(cd->list);
263 n = g_list_index(cd->list, info) + 1;
266 if (file_extension_match(cd->name, GQ_COLLECTION_EXT))
267 osd_template_insert(vars, "collection", remove_extension_from_path(cd->name), OSDT_FREE);
269 osd_template_insert(vars, "collection", cd->name, OSDT_NONE);
273 osd_template_insert(vars, "collection", _("Untitled"), OSDT_NONE);
278 LayoutWindow *lw = layout_find_by_image(imd);
283 n = g_list_length(lw->slideshow->list_done);
284 t = n + g_list_length(lw->slideshow->list);
289 t = layout_list_count(lw, nullptr);
290 n = layout_list_get_index(lw, image_get_fd(lw->image)) + 1;
293 else if (view_window_find_image(imd, &n, &t))
306 osd_template_insert(vars, "collection", nullptr, OSDT_NONE);
309 osd_template_insert(vars, "number", g_strdup_printf("%d", n), OSDT_NO_DUP);
310 osd_template_insert(vars, "total", g_strdup_printf("%d", t), OSDT_NO_DUP);
311 osd_template_insert(vars, "name", const_cast<gchar *>(name), OSDT_NONE);
312 osd_template_insert(vars, "path", const_cast<gchar *>(image_get_path(imd)), OSDT_NONE);
313 osd_template_insert(vars, "date", imd->image_fd ? (const_cast<gchar *>(text_from_time(imd->image_fd->date))) : "", OSDT_NONE);
314 osd_template_insert(vars, "size", imd->image_fd ? (text_from_size_abrev(imd->image_fd->size)) : g_strdup(""), OSDT_FREE);
315 osd_template_insert(vars, "zoom", image_zoom_get_as_text(imd), OSDT_FREE);
321 GdkPixbuf *load_pixbuf = image_loader_get_pixbuf(imd->il);
323 if (imd->delay_flip &&
324 imd->il && load_pixbuf &&
325 image_get_pixbuf(imd) != load_pixbuf)
327 w = gdk_pixbuf_get_width(load_pixbuf);
328 h = gdk_pixbuf_get_height(load_pixbuf);
332 image_get_image_size(imd, &w, &h);
336 osd_template_insert(vars, "width", g_strdup_printf("%d", w), OSDT_NO_DUP);
337 osd_template_insert(vars, "height", g_strdup_printf("%d", h), OSDT_NO_DUP);
338 osd_template_insert(vars, "res", g_strdup_printf("%d × %d", w, h), OSDT_FREE);
342 osd_template_insert(vars, "width", nullptr, OSDT_NONE);
343 osd_template_insert(vars, "height", nullptr, OSDT_NONE);
344 osd_template_insert(vars, "res", nullptr, OSDT_NONE);
347 text = image_osd_mkinfo(options->image_overlay.template_string, imd->image_fd, vars);
348 g_hash_table_destroy(vars);
351 /* When does this occur ?? */
352 text = g_markup_escape_text(_("Untitled"), -1);
355 with_hist = ((osd->show & OSD_SHOW_HISTOGRAM) && osd->histogram);
358 histmap = histmap_get(imd->image_fd);
361 histmap_start_idle(imd->image_fd);
368 gint active_marks = 0;
372 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
374 active_marks += file_data_get_mark(fd, mark);
377 if (active_marks > 0)
379 GString *buf = g_string_sized_new(strlen(text) + 1 + FILEDATA_MARKS_SIZE * 2);
383 g_string_append_printf(buf, "%s\n", text);
386 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
388 g_string_append_printf(buf, file_data_get_mark(fd, mark) ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + (mark < 9 ? mark : -1) );
392 text = g_string_free(buf, FALSE);
397 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(osd->histogram), -1);
399 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
401 text2 = g_strdup(escaped_histogram_label);
402 g_free(escaped_histogram_label);
408 font_desc = pango_font_description_from_string(options->image_overlay.font);
409 layout = gtk_widget_create_pango_layout(imd->pr, nullptr);
410 pango_layout_set_font_description(layout, font_desc);
412 pango_layout_set_markup(layout, text, -1);
415 pango_layout_get_pixel_size(layout, &width, &height);
416 /* with empty text width is set to 0, but not height) */
419 else if (height == 0)
421 if (width > 0) width += 10;
422 if (height > 0) height += 10;
426 if (width < HISTOGRAM_WIDTH + 10) width = HISTOGRAM_WIDTH + 10;
427 height += HISTOGRAM_HEIGHT + 5;
430 if (width > 0 && height > 0)
432 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
433 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, options->image_overlay.background_red, options->image_overlay.background_green,
434 options->image_overlay.background_blue, options->image_overlay.background_alpha);
435 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
436 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
437 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
438 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
439 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
440 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
441 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
446 gint y = height - HISTOGRAM_HEIGHT - 5;
449 pixbuf_set_rect_fill(pixbuf, x, y, w, HISTOGRAM_HEIGHT, 220, 220, 220, 210);
450 histogram_draw(osd->histogram, histmap, pixbuf, x, y, w, HISTOGRAM_HEIGHT);
452 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, options->image_overlay.text_red, options->image_overlay.text_green,
453 options->image_overlay.text_blue, options->image_overlay.text_alpha);
456 g_object_unref(G_OBJECT(layout));
462 * @brief Create non-standard icons for the OSD
467 * \image html image-osd-color.png
469 * \image html image-osd-first.png
471 * \image html image-osd-icon.png
473 * \image html image-osd-last.png
474 * IMAGE_OSD_ROTATE_AUTO
475 * \image html image-osd-rotate-auto.png
478 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
480 static GdkPixbuf **icons = nullptr;
481 GdkPixbuf *icon = nullptr;
483 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
484 if (icons[flag]) return icons[flag];
486 if (osd_icons[flag].key)
488 icon = pixbuf_inline(osd_icons[flag].key);
493 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
494 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
495 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
498 case IMAGE_OSD_ROTATE_AUTO:
499 pixbuf_set_rect(icon, 3, 8, 11, 12,
502 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
503 20, 9, 14, 15, 14, 3,
506 case IMAGE_OSD_ROTATE_USER:
508 case IMAGE_OSD_COLOR:
509 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
510 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
511 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
513 case IMAGE_OSD_FIRST:
514 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
515 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
516 12, 5, 18, 11, 6, 11,
520 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
521 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
522 12, 18, 6, 12, 18, 12,
526 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
527 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
539 static gint image_overlay_add(ImageWindow *imd, GdkPixbuf *pixbuf, gint x, gint y,
540 OverlayRendererFlags flags)
542 return pixbuf_renderer_overlay_add(reinterpret_cast<PixbufRenderer *>(imd->pr), pixbuf, x, y, flags);
545 static void image_overlay_set(ImageWindow *imd, gint id, GdkPixbuf *pixbuf, gint x, gint y)
547 pixbuf_renderer_overlay_set(reinterpret_cast<PixbufRenderer *>(imd->pr), id, pixbuf, x, y);
550 static void image_overlay_remove(ImageWindow *imd, gint id)
552 pixbuf_renderer_overlay_remove(reinterpret_cast<PixbufRenderer *>(imd->pr), id);
555 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
559 if (osd->icon_id[flag]) return;
561 pixbuf = image_osd_icon_pixbuf(flag);
564 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
565 osd_icons[flag].x, osd_icons[flag].y,
569 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
571 if (osd->icon_id[flag])
573 image_overlay_remove(osd->imd, osd->icon_id[flag]);
574 osd->icon_id[flag] = 0;
578 static void image_osd_icons_reset_time(OverlayStateData *osd)
582 for (i = 0; i < IMAGE_OSD_COUNT; i++)
584 if (osd_icons[i].reset)
586 osd->icon_time[i] = 0;
591 static void image_osd_icons_update(OverlayStateData *osd)
595 for (i = 0; i < IMAGE_OSD_COUNT; i++)
597 if (osd->icon_time[i] > 0)
599 image_osd_icon_show(osd, static_cast<ImageOSDFlag>(i));
603 image_osd_icon_hide(osd, static_cast<ImageOSDFlag>(i));
608 static void image_osd_icons_hide(OverlayStateData *osd)
612 for (i = 0; i < IMAGE_OSD_COUNT; i++)
614 image_osd_icon_hide(osd, static_cast<ImageOSDFlag>(i));
618 static void image_osd_info_show(OverlayStateData *osd, GdkPixbuf *pixbuf)
620 if (osd->ovl_info == 0)
622 osd->ovl_info = image_overlay_add(osd->imd, pixbuf, osd->x, osd->y, osd->origin);
626 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, osd->x, osd->y);
630 static void image_osd_info_hide(OverlayStateData *osd)
632 if (osd->ovl_info == 0) return;
634 image_overlay_remove(osd->imd, osd->ovl_info);
638 static gboolean image_osd_update_cb(gpointer data)
640 auto osd = static_cast<OverlayStateData *>(data);
642 if (osd->show & OSD_SHOW_INFO)
644 /* redraw when the image was changed,
645 with histogram we have to redraw also when loading is finished */
646 if (osd->changed_states & IMAGE_STATE_IMAGE ||
647 (osd->changed_states & IMAGE_STATE_LOADING && osd->show & OSD_SHOW_HISTOGRAM) ||
648 osd->notify & NOTIFY_HISTMAP)
652 pixbuf = image_osd_info_render(osd);
655 image_osd_info_show(osd, pixbuf);
656 g_object_unref(pixbuf);
660 image_osd_info_hide(osd);
666 image_osd_info_hide(osd);
669 if (osd->show & OSD_SHOW_STATUS)
671 if (osd->changed_states & IMAGE_STATE_IMAGE)
672 image_osd_icons_reset_time(osd);
674 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
676 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
677 image_osd_timer_schedule(osd);
680 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
684 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
687 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
690 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
691 image_osd_timer_schedule(osd);
694 image_osd_icons_update(osd);
698 image_osd_icons_hide(osd);
701 osd->changed_states = IMAGE_STATE_NONE;
702 osd->notify = static_cast<NotifyType>(0);
704 return G_SOURCE_REMOVE;
707 static void image_osd_update_schedule(OverlayStateData *osd, gboolean force)
709 if (force) osd->changed_states = static_cast<ImageState>(osd->changed_states | IMAGE_STATE_IMAGE);
713 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, nullptr);
717 void image_osd_update(ImageWindow *imd)
719 OverlayStateData *osd = image_get_osd_data(imd);
723 image_osd_update_schedule(osd, TRUE);
726 static gboolean image_osd_timer_cb(gpointer data)
728 auto osd = static_cast<OverlayStateData *>(data);
729 gboolean done = TRUE;
730 gboolean changed = FALSE;
733 for (i = 0; i < IMAGE_OSD_COUNT; i++)
735 if (osd->icon_time[i] > 1)
738 if (osd->icon_time[i] < 2)
740 osd->icon_time[i] = 0;
750 if (changed) image_osd_update_schedule(osd, FALSE);
761 static void image_osd_timer_schedule(OverlayStateData *osd)
765 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
769 static void image_osd_state_cb(ImageWindow *, ImageState state, gpointer data)
771 auto osd = static_cast<OverlayStateData *>(data);
773 osd->changed_states = static_cast<ImageState>(osd->changed_states | state);
774 image_osd_update_schedule(osd, FALSE);
777 static void image_osd_notify_cb(FileData *fd, NotifyType type, gpointer data)
779 auto osd = static_cast<OverlayStateData *>(data);
781 if ((type & (NOTIFY_HISTMAP)) && osd->imd && fd == osd->imd->image_fd)
783 DEBUG_1("Notify osd: %s %04x", fd->path, type);
784 osd->notify = static_cast<NotifyType>(osd->notify | type);
785 image_osd_update_schedule(osd, FALSE);
790 static void image_osd_free(OverlayStateData *osd)
794 if (osd->idle_id) g_source_remove(osd->idle_id);
795 if (osd->timer_id) g_source_remove(osd->timer_id);
797 file_data_unregister_notify_func(image_osd_notify_cb, osd);
801 image_set_osd_data(osd->imd, nullptr);
802 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
804 image_set_state_func(osd->imd, nullptr, nullptr);
806 image_osd_info_hide(osd);
807 image_osd_icons_hide(osd);
810 if (osd->histogram) histogram_free(osd->histogram);
815 static void image_osd_destroy_cb(GtkWidget *, gpointer data)
817 auto osd = static_cast<OverlayStateData *>(data);
823 static void image_osd_enable(ImageWindow *imd, OsdShowFlags show)
825 OverlayStateData *osd = image_get_osd_data(imd);
829 osd = g_new0(OverlayStateData, 1);
831 osd->show = OSD_SHOW_NOTHING;
832 osd->x = options->image_overlay.x;
833 osd->y = options->image_overlay.y;
834 osd->origin = OVL_RELATIVE;
836 osd->histogram = histogram_new();
838 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
839 G_CALLBACK(image_osd_destroy_cb), osd);
840 image_set_osd_data(imd, osd);
842 image_set_state_func(osd->imd, image_osd_state_cb, osd);
843 file_data_register_notify_func(image_osd_notify_cb, osd, NOTIFY_PRIORITY_LOW);
846 if (show & OSD_SHOW_STATUS)
847 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
849 if (show != osd->show)
850 image_osd_update_schedule(osd, TRUE);
855 void image_osd_set(ImageWindow *imd, OsdShowFlags show)
859 image_osd_enable(imd, show);
862 OsdShowFlags image_osd_get(ImageWindow *imd)
864 OverlayStateData *osd = image_get_osd_data(imd);
866 return osd ? osd->show : OSD_SHOW_NOTHING;
869 Histogram *image_osd_get_histogram(ImageWindow *imd)
871 OverlayStateData *osd = image_get_osd_data(imd);
873 return osd ? osd->histogram : nullptr;
876 void image_osd_copy_status(ImageWindow *src, ImageWindow *dest)
880 image_osd_set(dest, image_osd_get(src));
882 h_src = image_osd_get_histogram(src);
883 h_dest = image_osd_get_histogram(dest);
885 h_dest->histogram_mode = h_src->histogram_mode;
886 h_dest->histogram_channel = h_src->histogram_channel;
893 2+ = show for duration tenths of a second
894 -1 = use default duration
896 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
898 OverlayStateData *osd = image_get_osd_data(imd);
902 if (flag >= IMAGE_OSD_COUNT) return;
903 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
904 if (duration > 1) duration += 1;
906 osd->icon_time[flag] = duration;
908 image_osd_update_schedule(osd, FALSE);
909 image_osd_timer_schedule(osd);
911 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */