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.
23 #include "image-overlay.h"
27 #include "histogram.h"
29 #include "image-load.h"
33 #include "pixbuf-renderer.h"
34 #include "pixbuf-util.h"
35 #include "slideshow.h"
36 #include "ui-fileops.h"
39 *----------------------------------------------------------------------------
41 *----------------------------------------------------------------------------
45 struct OverlayStateData {
47 ImageState changed_states;
53 OverlayRendererFlags origin;
60 gint icon_time[IMAGE_OSD_COUNT];
61 gint icon_id[IMAGE_OSD_COUNT];
63 guint idle_id; /* event source id */
64 guint timer_id; /* event source id */
70 gboolean reset; /* reset on new image */
71 gint x; /* x, y offset */
73 gchar *key; /* inline pixbuf */
76 static OSDIcon osd_icons[] = {
77 { TRUE, 0, 0, nullptr }, /* none */
78 { TRUE, -10, -10, nullptr }, /* auto rotated */
79 { TRUE, -10, -10, nullptr }, /* user rotated */
80 { TRUE, -40, -10, nullptr }, /* color embedded */
81 { TRUE, -70, -10, nullptr }, /* first image */
82 { TRUE, -70, -10, nullptr }, /* last image */
83 { FALSE, -70, -10, nullptr }, /* osd enabled */
84 { FALSE, 0, 0, nullptr }
87 #define OSD_DATA "overlay-data"
89 #define IMAGE_OSD_DEFAULT_DURATION 30
91 #define HISTOGRAM_HEIGHT 140
92 #define HISTOGRAM_WIDTH 256
94 static void image_osd_timer_schedule(OverlayStateData *osd);
96 void set_image_overlay_template_string(gchar **template_string, const gchar *value)
98 g_assert(template_string);
100 g_free(*template_string);
101 *template_string = g_strdup(value);
105 void set_default_image_overlay_template_string(gchar **template_string)
107 set_image_overlay_template_string(template_string, DEFAULT_OVERLAY_INFO);
110 void set_image_overlay_font_string(gchar **font_string, const gchar *value)
112 g_assert(font_string);
114 g_free(*font_string);
115 *font_string = g_strdup(value);
118 static OverlayStateData *image_get_osd_data(ImageWindow *imd)
120 OverlayStateData *osd;
122 if (!imd) return nullptr;
126 osd = static_cast<OverlayStateData *>(g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA"));
130 static void image_set_osd_data(ImageWindow *imd, OverlayStateData *osd)
134 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
138 *----------------------------------------------------------------------------
140 *----------------------------------------------------------------------------
144 void image_osd_histogram_toggle_channel(ImageWindow *imd)
146 OverlayStateData *osd = image_get_osd_data(imd);
148 if (!osd || !osd->histogram) return;
150 histogram_toggle_channel(osd->histogram);
151 image_osd_update(imd);
154 void image_osd_histogram_toggle_mode(ImageWindow *imd)
156 OverlayStateData *osd = image_get_osd_data(imd);
158 if (!osd || !osd->histogram) return;
160 histogram_toggle_mode(osd->histogram);
161 image_osd_update(imd);
164 void image_osd_histogram_set_channel(ImageWindow *imd, gint chan)
166 OverlayStateData *osd = image_get_osd_data(imd);
168 if (!osd || !osd->histogram) return;
170 histogram_set_channel(osd->histogram, chan);
171 image_osd_update(imd);
174 void image_osd_histogram_set_mode(ImageWindow *imd, gint mode)
176 OverlayStateData *osd = image_get_osd_data(imd);
178 if (!osd || !osd->histogram) return;
180 histogram_set_mode(osd->histogram, mode);
181 image_osd_update(imd);
184 gint image_osd_histogram_get_channel(ImageWindow *imd)
186 OverlayStateData *osd = image_get_osd_data(imd);
188 if (!osd || !osd->histogram) return HCHAN_DEFAULT;
190 return histogram_get_channel(osd->histogram);
193 gint image_osd_histogram_get_mode(ImageWindow *imd)
195 OverlayStateData *osd = image_get_osd_data(imd);
197 if (!osd || !osd->histogram) return 0;
199 return histogram_get_mode(osd->histogram);
202 void image_osd_toggle(ImageWindow *imd)
207 show = image_osd_get(imd);
208 if (show == OSD_SHOW_NOTHING)
210 image_osd_set(imd, static_cast<OsdShowFlags>(OSD_SHOW_INFO | OSD_SHOW_STATUS));
214 if (show & OSD_SHOW_HISTOGRAM)
216 image_osd_set(imd, OSD_SHOW_NOTHING);
220 image_osd_set(imd, static_cast<OsdShowFlags>(show | OSD_SHOW_HISTOGRAM));
224 static GdkPixbuf *image_osd_info_render(OverlayStateData *osd)
226 GdkPixbuf *pixbuf = nullptr;
232 const HistMap *histmap = nullptr;
233 ImageWindow *imd = osd->imd;
234 FileData *fd = image_get_fd(imd);
235 PangoFontDescription *font_desc;
237 if (!fd) return nullptr;
239 name = image_get_name(imd);
247 vars = g_hash_table_new_full(g_str_hash, g_str_equal, nullptr, g_free);
249 cd = image_get_collection(imd, &info);
252 t = g_list_length(cd->list);
253 n = g_list_index(cd->list, info) + 1;
256 if (file_extension_match(cd->name, GQ_COLLECTION_EXT))
257 osd_template_insert(vars, "collection", remove_extension_from_path(cd->name), OSDT_FREE);
259 osd_template_insert(vars, "collection", cd->name, OSDT_NONE);
263 osd_template_insert(vars, "collection", _("Untitled"), OSDT_NONE);
268 LayoutWindow *lw = layout_find_by_image(imd);
273 n = g_list_length(lw->slideshow->list_done);
274 t = n + g_list_length(lw->slideshow->list);
279 t = layout_list_count(lw, nullptr);
280 n = layout_list_get_index(lw, image_get_fd(lw->image)) + 1;
283 else if (view_window_find_image(imd, &n, &t))
296 osd_template_insert(vars, "collection", nullptr, OSDT_NONE);
299 osd_template_insert(vars, "number", g_strdup_printf("%d", n), OSDT_NO_DUP);
300 osd_template_insert(vars, "total", g_strdup_printf("%d", t), OSDT_NO_DUP);
301 osd_template_insert(vars, "name", const_cast<gchar *>(name), OSDT_NONE);
302 osd_template_insert(vars, "path", const_cast<gchar *>(image_get_path(imd)), OSDT_NONE);
303 osd_template_insert(vars, "date", imd->image_fd ? (const_cast<gchar *>(text_from_time(imd->image_fd->date))) : "", OSDT_NONE);
304 osd_template_insert(vars, "size", imd->image_fd ? (text_from_size_abrev(imd->image_fd->size)) : g_strdup(""), OSDT_FREE);
305 osd_template_insert(vars, "zoom", image_zoom_get_as_text(imd), OSDT_FREE);
310 GdkPixbuf *load_pixbuf = image_loader_get_pixbuf(imd->il);
312 if (imd->delay_flip &&
313 imd->il && load_pixbuf &&
314 image_get_pixbuf(imd) != load_pixbuf)
316 w = gdk_pixbuf_get_width(load_pixbuf);
317 h = gdk_pixbuf_get_height(load_pixbuf);
321 image_get_image_size(imd, &w, &h);
325 osd_template_insert(vars, "width", g_strdup_printf("%d", w), OSDT_NO_DUP);
326 osd_template_insert(vars, "height", g_strdup_printf("%d", h), OSDT_NO_DUP);
327 osd_template_insert(vars, "res", g_strdup_printf("%d × %d", w, h), OSDT_FREE);
331 osd_template_insert(vars, "width", nullptr, OSDT_NONE);
332 osd_template_insert(vars, "height", nullptr, OSDT_NONE);
333 osd_template_insert(vars, "res", nullptr, OSDT_NONE);
336 text = image_osd_mkinfo(options->image_overlay.template_string, imd->image_fd, vars);
337 g_hash_table_destroy(vars);
340 /* When does this occur ?? */
341 text = g_markup_escape_text(_("Untitled"), -1);
344 with_hist = ((osd->show & OSD_SHOW_HISTOGRAM) && osd->histogram);
347 histmap = histmap_get(imd->image_fd);
350 histmap_start_idle(imd->image_fd);
357 gint active_marks = 0;
361 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
363 active_marks += file_data_get_mark(fd, mark);
366 if (active_marks > 0)
368 GString *buf = g_string_sized_new(strlen(text) + 1 + FILEDATA_MARKS_SIZE * 2);
372 g_string_append_printf(buf, "%s\n", text);
375 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
377 g_string_append_printf(buf, file_data_get_mark(fd, mark) ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + (mark < 9 ? mark : -1) );
381 text = g_string_free(buf, FALSE);
386 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(osd->histogram), -1);
388 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
390 text2 = g_strdup(escaped_histogram_label);
391 g_free(escaped_histogram_label);
397 font_desc = pango_font_description_from_string(options->image_overlay.font);
398 layout = gtk_widget_create_pango_layout(imd->pr, nullptr);
399 pango_layout_set_font_description(layout, font_desc);
401 pango_layout_set_markup(layout, text, -1);
404 pango_layout_get_pixel_size(layout, &width, &height);
405 /* with empty text width is set to 0, but not height) */
408 else if (height == 0)
410 if (width > 0) width += 10;
411 if (height > 0) height += 10;
415 if (width < HISTOGRAM_WIDTH + 10) width = HISTOGRAM_WIDTH + 10;
416 height += HISTOGRAM_HEIGHT + 5;
419 if (width > 0 && height > 0)
421 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
422 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, options->image_overlay.background_red, options->image_overlay.background_green,
423 options->image_overlay.background_blue, options->image_overlay.background_alpha);
424 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
425 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
426 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
427 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
428 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
429 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
430 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
435 gint y = height - HISTOGRAM_HEIGHT - 5;
438 pixbuf_set_rect_fill(pixbuf, x, y, w, HISTOGRAM_HEIGHT, 220, 220, 220, 210);
439 histogram_draw(osd->histogram, histmap, pixbuf, x, y, w, HISTOGRAM_HEIGHT);
441 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, options->image_overlay.text_red, options->image_overlay.text_green,
442 options->image_overlay.text_blue, options->image_overlay.text_alpha);
445 g_object_unref(G_OBJECT(layout));
451 * @brief Create non-standard icons for the OSD
456 * \image html image-osd-color.png
458 * \image html image-osd-first.png
460 * \image html image-osd-icon.png
462 * \image html image-osd-last.png
463 * IMAGE_OSD_ROTATE_AUTO
464 * \image html image-osd-rotate-auto.png
467 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
469 static GdkPixbuf **icons = nullptr;
470 GdkPixbuf *icon = nullptr;
472 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
473 if (icons[flag]) return icons[flag];
475 if (osd_icons[flag].key)
477 icon = pixbuf_inline(osd_icons[flag].key);
482 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
483 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
484 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
487 case IMAGE_OSD_ROTATE_AUTO:
488 pixbuf_set_rect(icon, 3, 8, 11, 12,
491 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
492 20, 9, 14, 15, 14, 3,
495 case IMAGE_OSD_ROTATE_USER:
497 case IMAGE_OSD_COLOR:
498 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
499 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
500 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
502 case IMAGE_OSD_FIRST:
503 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
504 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
505 12, 5, 18, 11, 6, 11,
509 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
510 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
511 12, 18, 6, 12, 18, 12,
515 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
516 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
528 static gint image_overlay_add(ImageWindow *imd, GdkPixbuf *pixbuf, gint x, gint y,
529 OverlayRendererFlags flags)
531 return pixbuf_renderer_overlay_add(reinterpret_cast<PixbufRenderer *>(imd->pr), pixbuf, x, y, flags);
534 static void image_overlay_set(ImageWindow *imd, gint id, GdkPixbuf *pixbuf, gint x, gint y)
536 pixbuf_renderer_overlay_set(reinterpret_cast<PixbufRenderer *>(imd->pr), id, pixbuf, x, y);
539 static void image_overlay_remove(ImageWindow *imd, gint id)
541 pixbuf_renderer_overlay_remove(reinterpret_cast<PixbufRenderer *>(imd->pr), id);
544 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
548 if (osd->icon_id[flag]) return;
550 pixbuf = image_osd_icon_pixbuf(flag);
553 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
554 osd_icons[flag].x, osd_icons[flag].y,
558 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
560 if (osd->icon_id[flag])
562 image_overlay_remove(osd->imd, osd->icon_id[flag]);
563 osd->icon_id[flag] = 0;
567 static void image_osd_icons_reset_time(OverlayStateData *osd)
571 for (i = 0; i < IMAGE_OSD_COUNT; i++)
573 if (osd_icons[i].reset)
575 osd->icon_time[i] = 0;
580 static void image_osd_icons_update(OverlayStateData *osd)
584 for (i = 0; i < IMAGE_OSD_COUNT; i++)
586 if (osd->icon_time[i] > 0)
588 image_osd_icon_show(osd, static_cast<ImageOSDFlag>(i));
592 image_osd_icon_hide(osd, static_cast<ImageOSDFlag>(i));
597 static void image_osd_icons_hide(OverlayStateData *osd)
601 for (i = 0; i < IMAGE_OSD_COUNT; i++)
603 image_osd_icon_hide(osd, static_cast<ImageOSDFlag>(i));
607 static void image_osd_info_show(OverlayStateData *osd, GdkPixbuf *pixbuf)
609 if (osd->ovl_info == 0)
611 osd->ovl_info = image_overlay_add(osd->imd, pixbuf, osd->x, osd->y, osd->origin);
615 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, osd->x, osd->y);
619 static void image_osd_info_hide(OverlayStateData *osd)
621 if (osd->ovl_info == 0) return;
623 image_overlay_remove(osd->imd, osd->ovl_info);
627 static gboolean image_osd_update_cb(gpointer data)
629 auto osd = static_cast<OverlayStateData *>(data);
631 if (osd->show & OSD_SHOW_INFO)
633 /* redraw when the image was changed,
634 with histogram we have to redraw also when loading is finished */
635 if (osd->changed_states & IMAGE_STATE_IMAGE ||
636 (osd->changed_states & IMAGE_STATE_LOADING && osd->show & OSD_SHOW_HISTOGRAM) ||
637 osd->notify & NOTIFY_HISTMAP)
641 pixbuf = image_osd_info_render(osd);
644 image_osd_info_show(osd, pixbuf);
645 g_object_unref(pixbuf);
649 image_osd_info_hide(osd);
655 image_osd_info_hide(osd);
658 if (osd->show & OSD_SHOW_STATUS)
660 if (osd->changed_states & IMAGE_STATE_IMAGE)
661 image_osd_icons_reset_time(osd);
663 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
665 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
666 image_osd_timer_schedule(osd);
669 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
673 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
676 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
679 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
680 image_osd_timer_schedule(osd);
683 image_osd_icons_update(osd);
687 image_osd_icons_hide(osd);
690 osd->changed_states = IMAGE_STATE_NONE;
691 osd->notify = static_cast<NotifyType>(0);
693 return G_SOURCE_REMOVE;
696 static void image_osd_update_schedule(OverlayStateData *osd, gboolean force)
698 if (force) osd->changed_states = static_cast<ImageState>(osd->changed_states | IMAGE_STATE_IMAGE);
702 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, nullptr);
706 void image_osd_update(ImageWindow *imd)
708 OverlayStateData *osd = image_get_osd_data(imd);
712 image_osd_update_schedule(osd, TRUE);
715 static gboolean image_osd_timer_cb(gpointer data)
717 auto osd = static_cast<OverlayStateData *>(data);
718 gboolean done = TRUE;
719 gboolean changed = FALSE;
722 for (i = 0; i < IMAGE_OSD_COUNT; i++)
724 if (osd->icon_time[i] > 1)
727 if (osd->icon_time[i] < 2)
729 osd->icon_time[i] = 0;
739 if (changed) image_osd_update_schedule(osd, FALSE);
750 static void image_osd_timer_schedule(OverlayStateData *osd)
754 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
758 static void image_osd_state_cb(ImageWindow *, ImageState state, gpointer data)
760 auto osd = static_cast<OverlayStateData *>(data);
762 osd->changed_states = static_cast<ImageState>(osd->changed_states | state);
763 image_osd_update_schedule(osd, FALSE);
766 static void image_osd_notify_cb(FileData *fd, NotifyType type, gpointer data)
768 auto osd = static_cast<OverlayStateData *>(data);
770 if ((type & (NOTIFY_HISTMAP)) && osd->imd && fd == osd->imd->image_fd)
772 DEBUG_1("Notify osd: %s %04x", fd->path, type);
773 osd->notify = static_cast<NotifyType>(osd->notify | type);
774 image_osd_update_schedule(osd, FALSE);
779 static void image_osd_free(OverlayStateData *osd)
783 if (osd->idle_id) g_source_remove(osd->idle_id);
784 if (osd->timer_id) g_source_remove(osd->timer_id);
786 file_data_unregister_notify_func(image_osd_notify_cb, osd);
790 image_set_osd_data(osd->imd, nullptr);
791 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
793 image_set_state_func(osd->imd, nullptr, nullptr);
795 image_osd_info_hide(osd);
796 image_osd_icons_hide(osd);
799 if (osd->histogram) histogram_free(osd->histogram);
804 static void image_osd_destroy_cb(GtkWidget *, gpointer data)
806 auto osd = static_cast<OverlayStateData *>(data);
812 static void image_osd_enable(ImageWindow *imd, OsdShowFlags show)
814 OverlayStateData *osd = image_get_osd_data(imd);
818 osd = g_new0(OverlayStateData, 1);
820 osd->show = OSD_SHOW_NOTHING;
821 osd->x = options->image_overlay.x;
822 osd->y = options->image_overlay.y;
823 osd->origin = OVL_RELATIVE;
825 osd->histogram = histogram_new();
827 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
828 G_CALLBACK(image_osd_destroy_cb), osd);
829 image_set_osd_data(imd, osd);
831 image_set_state_func(osd->imd, image_osd_state_cb, osd);
832 file_data_register_notify_func(image_osd_notify_cb, osd, NOTIFY_PRIORITY_LOW);
835 if (show & OSD_SHOW_STATUS)
836 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
838 if (show != osd->show)
839 image_osd_update_schedule(osd, TRUE);
844 void image_osd_set(ImageWindow *imd, OsdShowFlags show)
848 image_osd_enable(imd, show);
851 OsdShowFlags image_osd_get(ImageWindow *imd)
853 OverlayStateData *osd = image_get_osd_data(imd);
855 return osd ? osd->show : OSD_SHOW_NOTHING;
858 Histogram *image_osd_get_histogram(ImageWindow *imd)
860 OverlayStateData *osd = image_get_osd_data(imd);
862 return osd ? osd->histogram : nullptr;
865 void image_osd_copy_status(ImageWindow *src, ImageWindow *dest)
867 Histogram *h_src, *h_dest;
868 image_osd_set(dest, image_osd_get(src));
870 h_src = image_osd_get_histogram(src);
871 h_dest = image_osd_get_histogram(dest);
873 h_dest->histogram_mode = h_src->histogram_mode;
874 h_dest->histogram_channel = h_src->histogram_channel;
881 2+ = show for duration tenths of a second
882 -1 = use default duration
884 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
886 OverlayStateData *osd = image_get_osd_data(imd);
890 if (flag >= IMAGE_OSD_COUNT) return;
891 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
892 if (duration > 1) duration += 1;
894 osd->icon_time[flag] = duration;
896 image_osd_update_schedule(osd, FALSE);
897 image_osd_timer_schedule(osd);
899 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */