4 * Copyright (C) 2008 The Geeqie Team
8 * This software is released under the GNU General Public License (GNU GPL).
9 * Please read the included file COPYING for more information.
10 * This software comes with no warranty of any kind, use at your own risk!
14 #include "image-overlay.h"
22 #include "pixbuf-renderer.h"
23 #include "pixbuf_util.h"
24 #include "histogram.h"
28 *----------------------------------------------------------------------------
30 *----------------------------------------------------------------------------
33 typedef struct _OverlayStateData OverlayStateData;
34 struct _OverlayStateData {
36 ImageState changed_states;
43 gint icon_time[IMAGE_OSD_COUNT];
44 gint icon_id[IMAGE_OSD_COUNT];
52 typedef struct _OSDIcon OSDIcon;
54 gint reset; /* reset on new image */
55 gint x; /* x, y offset */
57 gchar *key; /* inline pixbuf */
60 static OSDIcon osd_icons[] = {
61 { TRUE, 0, 0, NULL }, /* none */
62 { TRUE, -10, -10, NULL }, /* auto rotated */
63 { TRUE, -10, -10, NULL }, /* user rotated */
64 { TRUE, -40, -10, NULL }, /* color embedded */
65 { TRUE, -70, -10, NULL }, /* first image */
66 { TRUE, -70, -10, NULL }, /* last image */
67 { FALSE, -70, -10, NULL }, /* osd enabled */
71 #define OSD_DATA "overlay-data"
74 #define OSD_INFO_Y -10
76 #define IMAGE_OSD_DEFAULT_DURATION 30
78 #define HISTOGRAM_HEIGHT 140
80 static void image_osd_timer_schedule(OverlayStateData *osd);
83 void set_default_image_overlay_template_string(ConfOptions *options)
85 if (options->image_overlay.common.template_string) g_free(options->image_overlay.common.template_string);
86 options->image_overlay.common.template_string = g_strdup(DEFAULT_OVERLAY_INFO);
90 *----------------------------------------------------------------------------
92 *----------------------------------------------------------------------------
96 static void image_osd_histogram_onoff_toggle(ImageWindow *imd, gint x)
98 imd->histogram_enabled = !!(x);
99 if (imd->histogram_enabled && !imd->histogram)
100 imd->histogram = histogram_new();
103 static gint image_osd_histogram_onoff_status(ImageWindow *imd)
105 return imd->histogram_enabled;
108 void image_osd_histogram_chan_toggle(ImageWindow *imd)
110 if (!imd->histogram) return;
112 histogram_set_channel(imd->histogram, (histogram_get_channel(imd->histogram) +1)%HCHAN_COUNT);
113 image_osd_update(imd);
116 void image_osd_histogram_log_toggle(ImageWindow *imd)
118 if (!imd->histogram) return;
120 histogram_set_mode(imd->histogram, !histogram_get_mode(imd->histogram));
121 image_osd_update(imd);
124 void image_osd_toggle(ImageWindow *imd)
128 if (image_osd_get(imd, &info, NULL) && info)
130 if (image_osd_histogram_onoff_status(imd))
132 image_osd_histogram_onoff_toggle(imd, 0);
133 image_osd_update(imd);
137 image_osd_set(imd, FALSE, FALSE);
142 image_osd_set(imd, TRUE, TRUE);
143 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
144 image_osd_histogram_onoff_toggle(imd, 1);
145 image_osd_update(imd);
149 static gchar *image_osd_mkinfo(const gchar *str, ImageWindow *imd, GHashTable *vars)
151 gchar delim = '%', imp = '|', sep[] = " - ";
160 if (!str || !*str) return g_strdup("");
162 new = g_string_new(str);
164 exif = exif_read_fd(imd->image_fd);
175 start = strchr(new->str, delim);
178 end = strchr(start+1, delim);
182 for (p = end; p > start; p--)
184 if (*p == ':' && was_digit)
189 was_digit = g_ascii_isdigit(*p);
192 if (trunc) limit = atoi(trunc+1);
194 name = g_strndup(start+1, ((limit > 0) ? trunc : end)-start-1);
196 pos = start-new->str;
197 data = g_strdup(g_hash_table_lookup(vars, name));
198 if (data && strcmp(name, "zoom") == 0) imd->overlay_show_zoom = TRUE;
200 data = exif_get_data_as_text(exif, name);
201 if (data && *data && limit > 0 && strlen(data) > limit + 3)
203 gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
209 /* Since we use pango markup to display, we need to escape here */
210 gchar *escaped = g_markup_escape_text(data, -1);
214 g_string_erase(new, pos, end-start+1);
216 g_string_insert(new, pos, data);
217 if (pos-prev == 2 && new->str[pos-1] == imp)
219 g_string_erase(new, --pos, 1);
222 g_string_insert(new, pos, sep);
227 prev = data ? pos+strlen(data)-1 : pos-1;
228 last = data ? TRUE : last;
234 /* search and destroy empty lines */
236 while ((start = strchr(end, '\n')))
239 while (*++(end) == '\n')
241 g_string_erase(new, start-new->str, end-start-1);
244 g_strchomp(new->str);
247 g_string_free(new, FALSE);
252 static GdkPixbuf *image_osd_info_render(ImageWindow *imd)
254 GdkPixbuf *pixbuf = NULL;
264 GdkPixbuf *imgpixbuf = NULL;
265 LayoutWindow *lw = NULL;
271 vars = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
273 name = image_get_name(imd);
276 name_escaped = g_markup_escape_text(name, -1);
283 cd = image_get_collection(imd, &info);
288 t = g_list_length(cd->list);
289 n = g_list_index(cd->list, info) + 1;
290 buf = g_markup_escape_text((cd->name) ? cd->name : _("Untitled"), -1);
291 ct = g_strdup_printf("<i>%s</i>\n", buf);
296 lw = layout_find_by_image(imd);
301 n = g_list_length(lw->slideshow->list_done);
302 t = n + g_list_length(lw->slideshow->list);
307 t = layout_list_count(lw, NULL);
308 n = layout_list_get_index(lw, image_get_path(lw->image)) + 1;
311 else if (view_window_find_image(imd, &n, &t))
327 size = text_from_size_abrev(imd->size);
330 if (imd->delay_flip &&
331 imd->il && imd->il->pixbuf &&
332 image_get_pixbuf(imd) != imd->il->pixbuf)
334 w = gdk_pixbuf_get_width(imd->il->pixbuf);
335 h = gdk_pixbuf_get_height(imd->il->pixbuf);
336 imgpixbuf = imd->il->pixbuf;
340 image_get_image_size(imd, &w, &h);
341 imgpixbuf = (PIXBUF_RENDERER(imd->pr))->pixbuf;
344 if (imgpixbuf && imd->histogram_enabled && imd->histogram
345 && (!imd->il || imd->il->done))
348 g_hash_table_insert(vars, "width", g_strdup_printf("%d", w));
349 g_hash_table_insert(vars, "height", g_strdup_printf("%d", h));
350 g_hash_table_insert(vars, "res", g_strdup_printf("%d × %d", w, h));
353 g_hash_table_insert(vars, "collection", g_strdup(ct));
354 g_hash_table_insert(vars, "number", g_strdup_printf("%d", n));
355 g_hash_table_insert(vars, "total", g_strdup_printf("%d", t));
356 g_hash_table_insert(vars, "name", g_strdup(name_escaped));
357 g_hash_table_insert(vars, "date", g_strdup(text_from_time(imd->mtime)));
358 g_hash_table_insert(vars, "size", g_strdup(size));
359 g_hash_table_insert(vars, "zoom", image_zoom_get_as_text(imd));
363 text = g_strdup_printf(_("Untitled"));
367 text = image_osd_mkinfo(options->image_overlay.common.template_string, imd, vars);
372 g_free(name_escaped);
373 g_hash_table_destroy(vars);
376 FileData *fd = image_get_fd(imd);
378 if (fd) /* fd may be null after file deletion */
380 gint active_marks = 0;
384 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
386 active_marks += fd->marks[mark];
389 if (active_marks > 0)
391 GString *buf = g_string_sized_new(FILEDATA_MARKS_SIZE * 2);
393 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
395 g_string_append_printf(buf, fd->marks[mark] ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + mark);
399 text2 = g_strdup_printf("%s\n%s", text, buf->str);
401 text2 = g_strdup(buf->str);
402 g_string_free(buf, TRUE);
409 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(imd->histogram), -1);
411 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
413 text2 = g_strdup(escaped_histogram_label);
414 g_free(escaped_histogram_label);
421 layout = gtk_widget_create_pango_layout(imd->pr, NULL);
422 pango_layout_set_markup(layout, text, -1);
425 pango_layout_get_pixel_size(layout, &width, &height);
426 /* with empty text width is set to 0, but not height) */
429 else if (height == 0)
431 if (width > 0) width += 10;
432 if (height > 0) height += 10;
436 histogram_read(imd->histogram, imgpixbuf);
437 if (width < 266) width = 266;
438 height += HISTOGRAM_HEIGHT + 5;
441 if (width > 0 && height > 0)
443 /* TODO: make osd color configurable --Zas */
444 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
445 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, 240, 240, 240, 210);
446 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
447 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
448 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
449 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
450 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
451 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
452 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
455 histogram_draw(imd->histogram, pixbuf, 5, height - HISTOGRAM_HEIGHT - 5 , width - 10, HISTOGRAM_HEIGHT);
457 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, 0, 0, 0, 255);
460 g_object_unref(G_OBJECT(layout));
465 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
467 static GdkPixbuf **icons = NULL;
468 GdkPixbuf *icon = NULL;
470 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
471 if (icons[flag]) return icons[flag];
473 if (osd_icons[flag].key)
475 icon = pixbuf_inline(osd_icons[flag].key);
480 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
481 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
482 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
485 case IMAGE_OSD_ROTATE_AUTO:
486 pixbuf_set_rect(icon, 3, 8, 11, 12,
489 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
490 20, 9, 14, 15, 14, 3,
493 case IMAGE_OSD_ROTATE_USER:
495 case IMAGE_OSD_COLOR:
496 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
497 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
498 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
500 case IMAGE_OSD_FIRST:
501 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
502 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
503 12, 5, 18, 11, 6, 11,
507 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
508 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
509 12, 18, 6, 12, 18, 12,
513 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
514 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
526 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
530 if (osd->icon_id[flag]) return;
532 pixbuf = image_osd_icon_pixbuf(flag);
535 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
536 osd_icons[flag].x, osd_icons[flag].y,
540 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
542 if (osd->icon_id[flag])
544 image_overlay_remove(osd->imd, osd->icon_id[flag]);
545 osd->icon_id[flag] = 0;
549 static gint image_osd_update_cb(gpointer data)
551 OverlayStateData *osd = data;
553 osd->imd->overlay_show_zoom = FALSE;
557 if (osd->changed_states & IMAGE_STATE_IMAGE)
561 pixbuf = image_osd_info_render(osd->imd);
564 if (osd->ovl_info == 0)
566 osd->ovl_info = image_overlay_add(osd->imd, pixbuf,
567 OSD_INFO_X, OSD_INFO_Y, TRUE, FALSE);
571 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, OSD_INFO_X, OSD_INFO_Y);
573 g_object_unref(pixbuf);
575 else if (osd->ovl_info)
577 image_overlay_remove(osd->imd, osd->ovl_info);
586 image_overlay_remove(osd->imd, osd->ovl_info);
591 if (osd->show_status)
595 if (osd->changed_states & IMAGE_STATE_IMAGE)
597 for (i = 0; i < IMAGE_OSD_COUNT; i++)
599 if (osd_icons[i].reset) osd->icon_time[i] = 0;
603 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
605 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
606 image_osd_timer_schedule(osd);
609 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
613 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
616 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
619 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
620 image_osd_timer_schedule(osd);
623 for (i = 0; i < IMAGE_OSD_COUNT; i++)
625 if (osd->icon_time[i] > 0)
627 image_osd_icon_show(osd, i);
631 image_osd_icon_hide(osd, i);
639 for (i = 0; i < IMAGE_OSD_COUNT; i++)
641 image_osd_icon_hide(osd, i);
645 if (osd->imd->il && osd->imd->il->done)
646 osd->changed_states = IMAGE_STATE_NONE;
651 static void image_osd_update_schedule(OverlayStateData *osd, gint force)
653 if (force) osd->changed_states |= IMAGE_STATE_IMAGE;
655 if (osd->idle_id == -1)
657 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, NULL);
661 void image_osd_update(ImageWindow *imd)
663 OverlayStateData *osd;
667 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
670 image_osd_update_schedule(osd, TRUE);
673 static gint image_osd_timer_cb(gpointer data)
675 OverlayStateData *osd = data;
677 gint changed = FALSE;
680 for (i = 0; i < IMAGE_OSD_COUNT; i++)
682 if (osd->icon_time[i] > 1)
685 if (osd->icon_time[i] < 2)
687 osd->icon_time[i] = 0;
697 if (changed) image_osd_update_schedule(osd, FALSE);
708 static void image_osd_timer_schedule(OverlayStateData *osd)
710 if (osd->timer_id == -1)
712 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
716 static void image_osd_state_cb(ImageWindow *imd, ImageState state, gpointer data)
718 OverlayStateData *osd = data;
720 osd->changed_states |= state;
721 image_osd_update_schedule(osd, FALSE);
724 static void image_osd_free(OverlayStateData *osd)
728 if (osd->idle_id != -1) g_source_remove(osd->idle_id);
729 if (osd->timer_id != -1) g_source_remove(osd->timer_id);
735 g_object_set_data(G_OBJECT(osd->imd->pr), "IMAGE_OVERLAY_DATA", NULL);
736 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
738 image_set_state_func(osd->imd, NULL, NULL);
739 image_overlay_remove(osd->imd, osd->ovl_info);
741 for (i = 0; i < IMAGE_OSD_COUNT; i++)
743 image_osd_icon_hide(osd, i);
750 static void image_osd_remove(ImageWindow *imd)
752 OverlayStateData *osd;
754 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
758 static void image_osd_destroy_cb(GtkWidget *widget, gpointer data)
760 OverlayStateData *osd = data;
766 static void image_osd_enable(ImageWindow *imd, gint info, gint status)
768 OverlayStateData *osd;
770 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
773 osd = g_new0(OverlayStateData, 1);
778 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
779 G_CALLBACK(image_osd_destroy_cb), osd);
780 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
782 image_set_state_func(osd->imd, image_osd_state_cb, osd);
785 if (osd->show_info != info ||
786 osd->show_status != status)
788 osd->show_info = info;
789 osd->show_status = status;
791 image_osd_update_schedule(osd, TRUE);
795 void image_osd_set(ImageWindow *imd, gint info, gint status)
799 if (!info && !status)
801 image_osd_remove(imd);
805 image_osd_enable(imd, info, status);
808 gint image_osd_get(ImageWindow *imd, gint *info, gint *status)
810 OverlayStateData *osd;
812 if (!imd) return FALSE;
814 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
815 if (!osd) return FALSE;
817 if (info) *info = osd->show_info;
818 if (status) *status = osd->show_status;
826 2+ = show for duration tenths of a second
827 -1 = use default duration
829 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
831 OverlayStateData *osd;
835 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
838 if (flag < IMAGE_OSD_NONE || flag >= IMAGE_OSD_COUNT) return;
839 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
840 if (duration > 1) duration += 1;
842 osd->icon_time[flag] = duration;
844 image_osd_update_schedule(osd, FALSE);
845 image_osd_timer_schedule(osd);