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"
26 #include "histogram.h"
31 #include "pixbuf-renderer.h"
32 #include "pixbuf_util.h"
33 #include "ui_fileops.h"
34 #include "image-load.h"
37 *----------------------------------------------------------------------------
39 *----------------------------------------------------------------------------
43 typedef struct _OverlayStateData OverlayStateData;
44 struct _OverlayStateData {
46 ImageState changed_states;
52 OverlayRendererFlags origin;
59 gint icon_time[IMAGE_OSD_COUNT];
60 gint icon_id[IMAGE_OSD_COUNT];
62 guint idle_id; /* event source id */
63 guint timer_id; /* event source id */
68 typedef struct _OSDIcon OSDIcon;
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, NULL }, /* none */
78 { TRUE, -10, -10, NULL }, /* auto rotated */
79 { TRUE, -10, -10, NULL }, /* user rotated */
80 { TRUE, -40, -10, NULL }, /* color embedded */
81 { TRUE, -70, -10, NULL }, /* first image */
82 { TRUE, -70, -10, NULL }, /* last image */
83 { FALSE, -70, -10, NULL }, /* osd enabled */
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 NULL;
126 osd = 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, OSD_SHOW_INFO | OSD_SHOW_STATUS);
215 if (show & OSD_SHOW_HISTOGRAM)
217 image_osd_set(imd, OSD_SHOW_NOTHING);
221 image_osd_set(imd, show | OSD_SHOW_HISTOGRAM);
226 static GdkPixbuf *image_osd_info_render(OverlayStateData *osd)
228 GdkPixbuf *pixbuf = NULL;
234 const HistMap *histmap = NULL;
235 ImageWindow *imd = osd->imd;
236 FileData *fd = image_get_fd(imd);
237 PangoFontDescription *font_desc;
239 if (!fd) return NULL;
241 name = image_get_name(imd);
249 vars = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
251 cd = image_get_collection(imd, &info);
254 t = g_list_length(cd->list);
255 n = g_list_index(cd->list, info) + 1;
258 if (file_extension_match(cd->name, GQ_COLLECTION_EXT))
259 osd_template_insert(vars, "collection", remove_extension_from_path(cd->name), OSDT_FREE);
261 osd_template_insert(vars, "collection", cd->name, OSDT_NONE);
265 osd_template_insert(vars, "collection", _("Untitled"), OSDT_NONE);
270 LayoutWindow *lw = layout_find_by_image(imd);
275 n = g_list_length(lw->slideshow->list_done);
276 t = n + g_list_length(lw->slideshow->list);
281 t = layout_list_count(lw, NULL);
282 n = layout_list_get_index(lw, image_get_fd(lw->image)) + 1;
285 else if (view_window_find_image(imd, &n, &t))
298 osd_template_insert(vars, "collection", NULL, OSDT_NONE);
301 osd_template_insert(vars, "number", g_strdup_printf("%d", n), OSDT_NO_DUP);
302 osd_template_insert(vars, "total", g_strdup_printf("%d", t), OSDT_NO_DUP);
303 osd_template_insert(vars, "name", (gchar *) name, OSDT_NONE);
304 osd_template_insert(vars, "path", (gchar *) image_get_path(imd), OSDT_NONE);
305 osd_template_insert(vars, "date", imd->image_fd ? ((gchar *) text_from_time(imd->image_fd->date)) : "", OSDT_NONE);
306 osd_template_insert(vars, "size", imd->image_fd ? (text_from_size_abrev(imd->image_fd->size)) : g_strdup(""), OSDT_FREE);
307 osd_template_insert(vars, "zoom", image_zoom_get_as_text(imd), OSDT_FREE);
312 GdkPixbuf *load_pixbuf = image_loader_get_pixbuf(imd->il);
314 if (imd->delay_flip &&
315 imd->il && load_pixbuf &&
316 image_get_pixbuf(imd) != load_pixbuf)
318 w = gdk_pixbuf_get_width(load_pixbuf);
319 h = gdk_pixbuf_get_height(load_pixbuf);
323 image_get_image_size(imd, &w, &h);
327 osd_template_insert(vars, "width", g_strdup_printf("%d", w), OSDT_NO_DUP);
328 osd_template_insert(vars, "height", g_strdup_printf("%d", h), OSDT_NO_DUP);
329 osd_template_insert(vars, "res", g_strdup_printf("%d × %d", w, h), OSDT_FREE);
333 osd_template_insert(vars, "width", NULL, OSDT_NONE);
334 osd_template_insert(vars, "height", NULL, OSDT_NONE);
335 osd_template_insert(vars, "res", NULL, OSDT_NONE);
338 text = image_osd_mkinfo(options->image_overlay.template_string, imd->image_fd, vars);
339 g_hash_table_destroy(vars);
342 /* When does this occur ?? */
343 text = g_markup_escape_text(_("Untitled"), -1);
346 with_hist = ((osd->show & OSD_SHOW_HISTOGRAM) && osd->histogram);
349 histmap = histmap_get(imd->image_fd);
352 histmap_start_idle(imd->image_fd);
359 gint active_marks = 0;
363 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
365 active_marks += file_data_get_mark(fd, mark);
368 if (active_marks > 0)
370 GString *buf = g_string_sized_new(FILEDATA_MARKS_SIZE * 2);
372 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
374 g_string_append_printf(buf, file_data_get_mark(fd, mark) ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + (mark < 9 ? mark : -1) );
378 text2 = g_strdup_printf("%s\n%s", text, buf->str);
380 text2 = g_strdup(buf->str);
381 g_string_free(buf, TRUE);
388 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(osd->histogram), -1);
390 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
392 text2 = g_strdup(escaped_histogram_label);
393 g_free(escaped_histogram_label);
399 font_desc = pango_font_description_from_string(options->image_overlay.font);
400 layout = gtk_widget_create_pango_layout(imd->pr, NULL);
401 pango_layout_set_font_description(layout, font_desc);
403 pango_layout_set_markup(layout, text, -1);
406 pango_layout_get_pixel_size(layout, &width, &height);
407 /* with empty text width is set to 0, but not height) */
410 else if (height == 0)
412 if (width > 0) width += 10;
413 if (height > 0) height += 10;
417 if (width < HISTOGRAM_WIDTH + 10) width = HISTOGRAM_WIDTH + 10;
418 height += HISTOGRAM_HEIGHT + 5;
421 if (width > 0 && height > 0)
423 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
424 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, options->image_overlay.background_red, options->image_overlay.background_green,
425 options->image_overlay.background_blue, options->image_overlay.background_alpha);
426 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
427 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
428 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
429 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
430 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
431 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
432 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
437 gint y = height - HISTOGRAM_HEIGHT - 5;
440 pixbuf_set_rect_fill(pixbuf, x, y, w, HISTOGRAM_HEIGHT, 220, 220, 220, 210);
441 histogram_draw(osd->histogram, histmap, pixbuf, x, y, w, HISTOGRAM_HEIGHT);
443 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, options->image_overlay.text_red, options->image_overlay.text_green,
444 options->image_overlay.text_blue, options->image_overlay.text_alpha);
447 g_object_unref(G_OBJECT(layout));
452 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
454 static GdkPixbuf **icons = NULL;
455 GdkPixbuf *icon = NULL;
457 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
458 if (icons[flag]) return icons[flag];
460 if (osd_icons[flag].key)
462 icon = pixbuf_inline(osd_icons[flag].key);
467 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
468 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
469 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
472 case IMAGE_OSD_ROTATE_AUTO:
473 pixbuf_set_rect(icon, 3, 8, 11, 12,
476 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
477 20, 9, 14, 15, 14, 3,
480 case IMAGE_OSD_ROTATE_USER:
482 case IMAGE_OSD_COLOR:
483 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
484 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
485 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
487 case IMAGE_OSD_FIRST:
488 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
489 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
490 12, 5, 18, 11, 6, 11,
494 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
495 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
496 12, 18, 6, 12, 18, 12,
500 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
501 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
513 static gint image_overlay_add(ImageWindow *imd, GdkPixbuf *pixbuf, gint x, gint y,
514 OverlayRendererFlags flags)
516 return pixbuf_renderer_overlay_add((PixbufRenderer *)imd->pr, pixbuf, x, y, flags);
519 static void image_overlay_set(ImageWindow *imd, gint id, GdkPixbuf *pixbuf, gint x, gint y)
521 pixbuf_renderer_overlay_set((PixbufRenderer *)imd->pr, id, pixbuf, x, y);
524 static void image_overlay_remove(ImageWindow *imd, gint id)
526 pixbuf_renderer_overlay_remove((PixbufRenderer *)imd->pr, id);
529 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
533 if (osd->icon_id[flag]) return;
535 pixbuf = image_osd_icon_pixbuf(flag);
538 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
539 osd_icons[flag].x, osd_icons[flag].y,
543 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
545 if (osd->icon_id[flag])
547 image_overlay_remove(osd->imd, osd->icon_id[flag]);
548 osd->icon_id[flag] = 0;
552 static void image_osd_icons_reset_time(OverlayStateData *osd)
556 for (i = 0; i < IMAGE_OSD_COUNT; i++)
558 if (osd_icons[i].reset)
560 osd->icon_time[i] = 0;
565 static void image_osd_icons_update(OverlayStateData *osd)
569 for (i = 0; i < IMAGE_OSD_COUNT; i++)
571 if (osd->icon_time[i] > 0)
573 image_osd_icon_show(osd, i);
577 image_osd_icon_hide(osd, i);
582 static void image_osd_icons_hide(OverlayStateData *osd)
586 for (i = 0; i < IMAGE_OSD_COUNT; i++)
588 image_osd_icon_hide(osd, i);
592 static void image_osd_info_show(OverlayStateData *osd, GdkPixbuf *pixbuf)
594 if (osd->ovl_info == 0)
596 osd->ovl_info = image_overlay_add(osd->imd, pixbuf, osd->x, osd->y, osd->origin);
600 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, osd->x, osd->y);
604 static void image_osd_info_hide(OverlayStateData *osd)
606 if (osd->ovl_info == 0) return;
608 image_overlay_remove(osd->imd, osd->ovl_info);
612 static gboolean image_osd_update_cb(gpointer data)
614 OverlayStateData *osd = data;
616 if (osd->show & OSD_SHOW_INFO)
618 /* redraw when the image was changed,
619 with histogram we have to redraw also when loading is finished */
620 if (osd->changed_states & IMAGE_STATE_IMAGE ||
621 (osd->changed_states & IMAGE_STATE_LOADING && osd->show & OSD_SHOW_HISTOGRAM) ||
622 osd->notify & NOTIFY_HISTMAP)
626 pixbuf = image_osd_info_render(osd);
629 image_osd_info_show(osd, pixbuf);
630 g_object_unref(pixbuf);
634 image_osd_info_hide(osd);
640 image_osd_info_hide(osd);
643 if (osd->show & OSD_SHOW_STATUS)
645 if (osd->changed_states & IMAGE_STATE_IMAGE)
646 image_osd_icons_reset_time(osd);
648 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
650 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
651 image_osd_timer_schedule(osd);
654 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
658 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
661 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
664 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
665 image_osd_timer_schedule(osd);
668 image_osd_icons_update(osd);
672 image_osd_icons_hide(osd);
675 osd->changed_states = IMAGE_STATE_NONE;
681 static void image_osd_update_schedule(OverlayStateData *osd, gboolean force)
683 if (force) osd->changed_states |= IMAGE_STATE_IMAGE;
687 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, NULL);
691 void image_osd_update(ImageWindow *imd)
693 OverlayStateData *osd = image_get_osd_data(imd);
697 image_osd_update_schedule(osd, TRUE);
700 static gboolean image_osd_timer_cb(gpointer data)
702 OverlayStateData *osd = data;
703 gboolean done = TRUE;
704 gboolean changed = FALSE;
707 for (i = 0; i < IMAGE_OSD_COUNT; i++)
709 if (osd->icon_time[i] > 1)
712 if (osd->icon_time[i] < 2)
714 osd->icon_time[i] = 0;
724 if (changed) image_osd_update_schedule(osd, FALSE);
735 static void image_osd_timer_schedule(OverlayStateData *osd)
739 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
743 static void image_osd_state_cb(ImageWindow *imd, ImageState state, gpointer data)
745 OverlayStateData *osd = data;
747 osd->changed_states |= state;
748 image_osd_update_schedule(osd, FALSE);
751 static void image_osd_notify_cb(FileData *fd, NotifyType type, gpointer data)
753 OverlayStateData *osd = data;
755 if ((type & (NOTIFY_HISTMAP)) && osd->imd && fd == osd->imd->image_fd)
757 DEBUG_1("Notify osd: %s %04x", fd->path, type);
759 image_osd_update_schedule(osd, FALSE);
764 static void image_osd_free(OverlayStateData *osd)
768 if (osd->idle_id) g_source_remove(osd->idle_id);
769 if (osd->timer_id) g_source_remove(osd->timer_id);
771 file_data_unregister_notify_func(image_osd_notify_cb, osd);
775 image_set_osd_data(osd->imd, NULL);
776 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
778 image_set_state_func(osd->imd, NULL, NULL);
780 image_osd_info_hide(osd);
781 image_osd_icons_hide(osd);
784 if (osd->histogram) histogram_free(osd->histogram);
789 static void image_osd_destroy_cb(GtkWidget *widget, gpointer data)
791 OverlayStateData *osd = data;
797 static void image_osd_enable(ImageWindow *imd, OsdShowFlags show)
799 OverlayStateData *osd = image_get_osd_data(imd);
803 osd = g_new0(OverlayStateData, 1);
805 osd->show = OSD_SHOW_NOTHING;
806 osd->x = options->image_overlay.x;
807 osd->y = options->image_overlay.y;
808 osd->origin = OVL_RELATIVE;
810 osd->histogram = histogram_new();
812 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
813 G_CALLBACK(image_osd_destroy_cb), osd);
814 image_set_osd_data(imd, osd);
816 image_set_state_func(osd->imd, image_osd_state_cb, osd);
817 file_data_register_notify_func(image_osd_notify_cb, osd, NOTIFY_PRIORITY_LOW);
820 if (show & OSD_SHOW_STATUS)
821 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
823 if (show != osd->show)
824 image_osd_update_schedule(osd, TRUE);
829 void image_osd_set(ImageWindow *imd, OsdShowFlags show)
833 image_osd_enable(imd, show);
836 OsdShowFlags image_osd_get(ImageWindow *imd)
838 OverlayStateData *osd = image_get_osd_data(imd);
840 return osd ? osd->show : OSD_SHOW_NOTHING;
843 Histogram *image_osd_get_histogram(ImageWindow *imd)
845 OverlayStateData *osd = image_get_osd_data(imd);
847 return osd ? osd->histogram : NULL;
850 void image_osd_copy_status(ImageWindow *src, ImageWindow *dest)
852 Histogram *h_src, *h_dest;
853 image_osd_set(dest, image_osd_get(src));
855 h_src = image_osd_get_histogram(src);
856 h_dest = image_osd_get_histogram(dest);
858 h_dest->histogram_mode = h_src->histogram_mode;
859 h_dest->histogram_channel = h_src->histogram_channel;
866 2+ = show for duration tenths of a second
867 -1 = use default duration
869 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
871 OverlayStateData *osd = image_get_osd_data(imd);
875 if (flag >= IMAGE_OSD_COUNT) return;
876 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
877 if (duration > 1) duration += 1;
879 osd->icon_time[flag] = duration;
881 image_osd_update_schedule(osd, FALSE);
882 image_osd_timer_schedule(osd);
884 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */