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 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 gint image_osd_histogram_onoff_status(ImageWindow *imd)
105 return imd->histogram_enabled;
108 void image_osd_histogram_chan_toggle(ImageWindow *imd)
112 histogram_set_channel(imd->histogram, (histogram_get_channel(imd->histogram) +1)%HCHAN_COUNT);
113 image_osd_update(imd);
117 void image_osd_histogram_log_toggle(ImageWindow *imd)
121 histogram_set_mode(imd->histogram, !histogram_get_mode(imd->histogram));
122 image_osd_update(imd);
126 void image_osd_toggle(ImageWindow *imd)
130 if (image_osd_get(imd, &info, NULL) && info)
132 if (image_osd_histogram_onoff_status(imd))
134 image_osd_histogram_onoff_toggle(imd, 0);
135 image_osd_update(imd);
139 image_osd_set(imd, FALSE, FALSE);
144 image_osd_set(imd, TRUE, TRUE);
145 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
146 image_osd_histogram_onoff_toggle(imd, 1);
147 image_osd_update(imd);
151 static gchar *image_osd_mkinfo(const gchar *str, ImageWindow *imd, GHashTable *vars)
153 gchar delim = '%', imp = '|', sep[] = " - ";
162 if (!str || !*str) return g_strdup("");
164 new = g_string_new(str);
166 exif = exif_read_fd(imd->image_fd);
177 start = strchr(new->str, delim);
180 end = strchr(start+1, delim);
184 for (p = end; p > start; p--)
186 if (*p == ':' && was_digit)
191 was_digit = g_ascii_isdigit(*p);
194 if (trunc) limit = atoi(trunc+1);
196 name = g_strndup(start+1, ((limit > 0) ? trunc : end)-start-1);
198 pos = start-new->str;
199 data = g_strdup(g_hash_table_lookup(vars, name));
200 if (data && strcmp(name, "zoom") == 0) imd->overlay_show_zoom = TRUE;
202 data = exif_get_data_as_text(exif, name);
203 if (data && *data && limit > 0 && strlen(data) > limit + 3)
205 gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
211 /* Since we use pango markup to display, we need to escape here */
212 gchar *escaped = g_markup_escape_text(data, -1);
216 g_string_erase(new, pos, end-start+1);
218 g_string_insert(new, pos, data);
219 if (pos-prev == 2 && new->str[pos-1] == imp)
221 g_string_erase(new, --pos, 1);
224 g_string_insert(new, pos, sep);
229 prev = data ? pos+strlen(data)-1 : pos-1;
230 last = data ? TRUE : last;
235 /* search and destroy empty lines */
237 while ((start = strchr(end, '\n')))
240 while (*++(end) == '\n')
242 g_string_erase(new, start-new->str, end-start-1);
245 g_strchomp(new->str);
248 g_string_free(new, FALSE);
253 static GdkPixbuf *image_osd_info_render(ImageWindow *imd)
255 GdkPixbuf *pixbuf = NULL;
265 GdkPixbuf *imgpixbuf = NULL;
266 LayoutWindow *lw = NULL;
272 vars = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
274 name = image_get_name(imd);
277 name_escaped = g_markup_escape_text(name, -1);
284 cd = image_get_collection(imd, &info);
289 t = g_list_length(cd->list);
290 n = g_list_index(cd->list, info) + 1;
291 buf = g_markup_escape_text((cd->name) ? cd->name : _("Untitled"), -1);
292 ct = g_strdup_printf("<i>%s</i>\n", buf);
297 lw = layout_find_by_image(imd);
302 n = g_list_length(lw->slideshow->list_done);
303 t = n + g_list_length(lw->slideshow->list);
308 t = layout_list_count(lw, NULL);
309 n = layout_list_get_index(lw, image_get_path(lw->image)) + 1;
312 else if (view_window_find_image(imd, &n, &t))
328 size = text_from_size_abrev(imd->size);
331 if (imd->delay_flip &&
332 imd->il && imd->il->pixbuf &&
333 image_get_pixbuf(imd) != imd->il->pixbuf)
335 w = gdk_pixbuf_get_width(imd->il->pixbuf);
336 h = gdk_pixbuf_get_height(imd->il->pixbuf);
337 imgpixbuf = imd->il->pixbuf;
341 pixbuf_renderer_get_image_size(PIXBUF_RENDERER(imd->pr), &w, &h);
342 imgpixbuf = (PIXBUF_RENDERER(imd->pr))->pixbuf;
345 if (imgpixbuf && imd->histogram_enabled && imd->histogram
346 && (!imd->il || imd->il->done))
349 g_hash_table_insert(vars, "width", g_strdup_printf("%d", w));
350 g_hash_table_insert(vars, "height", g_strdup_printf("%d", h));
351 g_hash_table_insert(vars, "res", g_strdup_printf("%d × %d", w, h));
354 g_hash_table_insert(vars, "collection", g_strdup(ct));
355 g_hash_table_insert(vars, "number", g_strdup_printf("%d", n));
356 g_hash_table_insert(vars, "total", g_strdup_printf("%d", t));
357 g_hash_table_insert(vars, "name", g_strdup(name_escaped));
358 g_hash_table_insert(vars, "date", g_strdup(text_from_time(imd->mtime)));
359 g_hash_table_insert(vars, "size", g_strdup(size));
360 g_hash_table_insert(vars, "zoom", image_zoom_get_as_text(imd));
364 text = g_strdup_printf(_("Untitled"));
368 text = image_osd_mkinfo(options->image_overlay.common.template_string, imd, vars);
373 g_free(name_escaped);
374 g_hash_table_destroy(vars);
377 FileData *fd = image_get_fd(imd);
379 if (fd) /* fd may be null after file deletion */
381 gint active_marks = 0;
385 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
387 active_marks += fd->marks[mark];
390 if (active_marks > 0)
392 GString *buf = g_string_sized_new(FILEDATA_MARKS_SIZE * 2);
394 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
396 g_string_append_printf(buf, fd->marks[mark] ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + mark);
400 text2 = g_strdup_printf("%s\n%s", text, buf->str);
402 text2 = g_strdup(buf->str);
403 g_string_free(buf, TRUE);
410 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(imd->histogram), -1);
412 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
414 text2 = g_strdup(escaped_histogram_label);
415 g_free(escaped_histogram_label);
422 layout = gtk_widget_create_pango_layout(imd->pr, NULL);
423 pango_layout_set_markup(layout, text, -1);
426 pango_layout_get_pixel_size(layout, &width, &height);
427 /* with empty text width is set to 0, but not height) */
430 else if (height == 0)
432 if (width > 0) width += 10;
433 if (height > 0) height += 10;
437 histogram_read(imd->histogram, imgpixbuf);
438 if (width < 266) width = 266;
439 height += HISTOGRAM_HEIGHT + 5;
442 if (width > 0 && height > 0)
444 /* TODO: make osd color configurable --Zas */
445 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
446 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, 240, 240, 240, 210);
447 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
448 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
449 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
450 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
451 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
452 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
453 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
456 histogram_draw(imd->histogram, pixbuf, 5, height - HISTOGRAM_HEIGHT - 5 , width - 10, HISTOGRAM_HEIGHT);
458 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, 0, 0, 0, 255);
461 g_object_unref(G_OBJECT(layout));
466 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
468 static GdkPixbuf **icons = NULL;
469 GdkPixbuf *icon = NULL;
471 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
472 if (icons[flag]) return icons[flag];
474 if (osd_icons[flag].key)
476 icon = pixbuf_inline(osd_icons[flag].key);
481 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
482 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
483 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
486 case IMAGE_OSD_ROTATE_AUTO:
487 pixbuf_set_rect(icon, 3, 8, 11, 12,
490 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
491 20, 9, 14, 15, 14, 3,
494 case IMAGE_OSD_ROTATE_USER:
496 case IMAGE_OSD_COLOR:
497 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
498 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
499 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
501 case IMAGE_OSD_FIRST:
502 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
503 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
504 12, 5, 18, 11, 6, 11,
508 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
509 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
510 12, 18, 6, 12, 18, 12,
514 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
515 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
527 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
531 if (osd->icon_id[flag]) return;
533 pixbuf = image_osd_icon_pixbuf(flag);
536 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
537 osd_icons[flag].x, osd_icons[flag].y,
541 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
543 if (osd->icon_id[flag])
545 image_overlay_remove(osd->imd, osd->icon_id[flag]);
546 osd->icon_id[flag] = 0;
550 static gint image_osd_update_cb(gpointer data)
552 OverlayStateData *osd = data;
554 osd->imd->overlay_show_zoom = FALSE;
558 if (osd->changed_states & IMAGE_STATE_IMAGE)
562 pixbuf = image_osd_info_render(osd->imd);
565 if (osd->ovl_info == 0)
567 osd->ovl_info = image_overlay_add(osd->imd, pixbuf,
568 OSD_INFO_X, OSD_INFO_Y, TRUE, FALSE);
572 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, OSD_INFO_X, OSD_INFO_Y);
574 g_object_unref(pixbuf);
576 else if (osd->ovl_info)
578 image_overlay_remove(osd->imd, osd->ovl_info);
587 image_overlay_remove(osd->imd, osd->ovl_info);
592 if (osd->show_status)
596 if (osd->changed_states & IMAGE_STATE_IMAGE)
598 for (i = 0; i < IMAGE_OSD_COUNT; i++)
600 if (osd_icons[i].reset) osd->icon_time[i] = 0;
604 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
606 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
607 image_osd_timer_schedule(osd);
610 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
614 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
617 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
620 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
621 image_osd_timer_schedule(osd);
624 for (i = 0; i < IMAGE_OSD_COUNT; i++)
626 if (osd->icon_time[i] > 0)
628 image_osd_icon_show(osd, i);
632 image_osd_icon_hide(osd, i);
640 for (i = 0; i < IMAGE_OSD_COUNT; i++)
642 image_osd_icon_hide(osd, i);
646 if (osd->imd->il && osd->imd->il->done)
647 osd->changed_states = IMAGE_STATE_NONE;
652 static void image_osd_update_schedule(OverlayStateData *osd, gint force)
654 if (force) osd->changed_states |= IMAGE_STATE_IMAGE;
656 if (osd->idle_id == -1)
658 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, NULL);
662 void image_osd_update(ImageWindow *imd)
664 OverlayStateData *osd;
668 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
671 image_osd_update_schedule(osd, TRUE);
674 static gint image_osd_timer_cb(gpointer data)
676 OverlayStateData *osd = data;
678 gint changed = FALSE;
681 for (i = 0; i < IMAGE_OSD_COUNT; i++)
683 if (osd->icon_time[i] > 1)
686 if (osd->icon_time[i] < 2)
688 osd->icon_time[i] = 0;
698 if (changed) image_osd_update_schedule(osd, FALSE);
709 static void image_osd_timer_schedule(OverlayStateData *osd)
711 if (osd->timer_id == -1)
713 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
717 static void image_osd_state_cb(ImageWindow *imd, ImageState state, gpointer data)
719 OverlayStateData *osd = data;
721 osd->changed_states |= state;
722 image_osd_update_schedule(osd, FALSE);
725 static void image_osd_free(OverlayStateData *osd)
729 if (osd->idle_id != -1) g_source_remove(osd->idle_id);
730 if (osd->timer_id != -1) g_source_remove(osd->timer_id);
736 g_object_set_data(G_OBJECT(osd->imd->pr), "IMAGE_OVERLAY_DATA", NULL);
737 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
739 image_set_state_func(osd->imd, NULL, NULL);
740 image_overlay_remove(osd->imd, osd->ovl_info);
742 for (i = 0; i < IMAGE_OSD_COUNT; i++)
744 image_osd_icon_hide(osd, i);
751 static void image_osd_remove(ImageWindow *imd)
753 OverlayStateData *osd;
755 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
759 static void image_osd_destroy_cb(GtkWidget *widget, gpointer data)
761 OverlayStateData *osd = data;
767 static void image_osd_enable(ImageWindow *imd, gint info, gint status)
769 OverlayStateData *osd;
771 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
774 osd = g_new0(OverlayStateData, 1);
779 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
780 G_CALLBACK(image_osd_destroy_cb), osd);
781 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
783 image_set_state_func(osd->imd, image_osd_state_cb, osd);
786 if (osd->show_info != info ||
787 osd->show_status != status)
789 osd->show_info = info;
790 osd->show_status = status;
792 image_osd_update_schedule(osd, TRUE);
796 void image_osd_set(ImageWindow *imd, gint info, gint status)
800 if (!info && !status)
802 image_osd_remove(imd);
806 image_osd_enable(imd, info, status);
809 gint image_osd_get(ImageWindow *imd, gint *info, gint *status)
811 OverlayStateData *osd;
813 if (!imd) return FALSE;
815 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
816 if (!osd) return FALSE;
818 if (info) *info = osd->show_info;
819 if (status) *status = osd->show_status;
827 2+ = show for duration tenths of a second
828 -1 = use default duration
830 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
832 OverlayStateData *osd;
836 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
839 if (flag < IMAGE_OSD_NONE || flag >= IMAGE_OSD_COUNT) return;
840 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
841 if (duration > 1) duration += 1;
843 osd->icon_time[flag] = duration;
845 image_osd_update_schedule(osd, FALSE);
846 image_osd_timer_schedule(osd);