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 *----------------------------------------------------------------------------
34 typedef struct _OverlayStateData OverlayStateData;
35 struct _OverlayStateData {
37 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);
89 static OverlayStateData *image_get_osd_data(ImageWindow *imd)
91 OverlayStateData *osd;
93 if (!imd) return NULL;
97 osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
101 static void image_set_osd_data(ImageWindow *imd, OverlayStateData *osd)
105 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
109 *----------------------------------------------------------------------------
111 *----------------------------------------------------------------------------
115 static void image_osd_histogram_onoff_toggle(ImageWindow *imd, gint x)
117 imd->histogram_enabled = !!(x);
118 if (imd->histogram_enabled && !imd->histogram)
119 imd->histogram = histogram_new();
122 static gint image_osd_histogram_onoff_status(ImageWindow *imd)
124 return imd->histogram_enabled;
127 void image_osd_histogram_chan_toggle(ImageWindow *imd)
129 if (!imd->histogram) return;
131 histogram_set_channel(imd->histogram, (histogram_get_channel(imd->histogram) +1)%HCHAN_COUNT);
132 image_osd_update(imd);
135 void image_osd_histogram_log_toggle(ImageWindow *imd)
137 if (!imd->histogram) return;
139 histogram_set_mode(imd->histogram, !histogram_get_mode(imd->histogram));
140 image_osd_update(imd);
143 void image_osd_toggle(ImageWindow *imd)
147 if (image_osd_get(imd, &show) && (show & OSD_SHOW_INFO))
149 if (image_osd_histogram_onoff_status(imd))
151 image_osd_histogram_onoff_toggle(imd, 0);
152 image_osd_update(imd);
156 image_osd_set(imd, OSD_SHOW_NOTHING);
161 image_osd_set(imd, OSD_SHOW_INFO | OSD_SHOW_STATUS);
162 image_osd_icon(imd, IMAGE_OSD_ICON, -1);
163 image_osd_histogram_onoff_toggle(imd, 1);
164 image_osd_update(imd);
168 static gchar *image_osd_mkinfo(const gchar *str, ImageWindow *imd, GHashTable *vars)
170 gchar delim = '%', imp = '|', sep[] = " - ";
179 if (!str || !*str) return g_strdup("");
181 new = g_string_new(str);
183 exif = exif_read_fd(imd->image_fd);
194 start = strchr(new->str, delim);
197 end = strchr(start+1, delim);
201 for (p = end; p > start; p--)
203 if (*p == ':' && was_digit)
208 was_digit = g_ascii_isdigit(*p);
211 if (trunc) limit = atoi(trunc+1);
213 name = g_strndup(start+1, ((limit > 0) ? trunc : end)-start-1);
215 pos = start-new->str;
216 data = g_strdup(g_hash_table_lookup(vars, name));
217 if (data && strcmp(name, "zoom") == 0) imd->overlay_show_zoom = TRUE;
219 data = exif_get_data_as_text(exif, name);
220 if (data && *data && limit > 0 && strlen(data) > limit + 3)
222 gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
228 /* Since we use pango markup to display, we need to escape here */
229 gchar *escaped = g_markup_escape_text(data, -1);
233 g_string_erase(new, pos, end-start+1);
235 g_string_insert(new, pos, data);
236 if (pos-prev == 2 && new->str[pos-1] == imp)
238 g_string_erase(new, --pos, 1);
241 g_string_insert(new, pos, sep);
246 prev = data ? pos+strlen(data)-1 : pos-1;
247 last = data ? TRUE : last;
253 /* search and destroy empty lines */
255 while ((start = strchr(end, '\n')))
258 while (*++(end) == '\n')
260 g_string_erase(new, start-new->str, end-start-1);
263 g_strchomp(new->str);
266 g_string_free(new, FALSE);
271 static GdkPixbuf *image_osd_info_render(ImageWindow *imd)
273 GdkPixbuf *pixbuf = NULL;
283 GdkPixbuf *imgpixbuf = NULL;
284 LayoutWindow *lw = NULL;
290 vars = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
292 name = image_get_name(imd);
295 name_escaped = g_markup_escape_text(name, -1);
302 cd = image_get_collection(imd, &info);
307 t = g_list_length(cd->list);
308 n = g_list_index(cd->list, info) + 1;
309 buf = g_markup_escape_text((cd->name) ? cd->name : _("Untitled"), -1);
310 ct = g_strdup_printf("<i>%s</i>\n", buf);
315 lw = layout_find_by_image(imd);
320 n = g_list_length(lw->slideshow->list_done);
321 t = n + g_list_length(lw->slideshow->list);
326 t = layout_list_count(lw, NULL);
327 n = layout_list_get_index(lw, image_get_path(lw->image)) + 1;
330 else if (view_window_find_image(imd, &n, &t))
346 size = text_from_size_abrev(imd->size);
349 if (imd->delay_flip &&
350 imd->il && imd->il->pixbuf &&
351 image_get_pixbuf(imd) != imd->il->pixbuf)
353 w = gdk_pixbuf_get_width(imd->il->pixbuf);
354 h = gdk_pixbuf_get_height(imd->il->pixbuf);
355 imgpixbuf = imd->il->pixbuf;
359 image_get_image_size(imd, &w, &h);
360 imgpixbuf = (PIXBUF_RENDERER(imd->pr))->pixbuf;
363 if (imgpixbuf && imd->histogram_enabled && imd->histogram
364 && (!imd->il || imd->il->done))
367 g_hash_table_insert(vars, "width", g_strdup_printf("%d", w));
368 g_hash_table_insert(vars, "height", g_strdup_printf("%d", h));
369 g_hash_table_insert(vars, "res", g_strdup_printf("%d × %d", w, h));
372 g_hash_table_insert(vars, "collection", g_strdup(ct));
373 g_hash_table_insert(vars, "number", g_strdup_printf("%d", n));
374 g_hash_table_insert(vars, "total", g_strdup_printf("%d", t));
375 g_hash_table_insert(vars, "name", g_strdup(name_escaped));
376 g_hash_table_insert(vars, "date", g_strdup(text_from_time(imd->mtime)));
377 g_hash_table_insert(vars, "size", g_strdup(size));
378 g_hash_table_insert(vars, "zoom", image_zoom_get_as_text(imd));
382 text = g_strdup_printf(_("Untitled"));
386 text = image_osd_mkinfo(options->image_overlay.common.template_string, imd, vars);
391 g_free(name_escaped);
392 g_hash_table_destroy(vars);
395 FileData *fd = image_get_fd(imd);
397 if (fd) /* fd may be null after file deletion */
399 gint active_marks = 0;
403 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
405 active_marks += fd->marks[mark];
408 if (active_marks > 0)
410 GString *buf = g_string_sized_new(FILEDATA_MARKS_SIZE * 2);
412 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
414 g_string_append_printf(buf, fd->marks[mark] ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + mark);
418 text2 = g_strdup_printf("%s\n%s", text, buf->str);
420 text2 = g_strdup(buf->str);
421 g_string_free(buf, TRUE);
428 gchar *escaped_histogram_label = g_markup_escape_text(histogram_label(imd->histogram), -1);
430 text2 = g_strdup_printf("%s\n%s", text, escaped_histogram_label);
432 text2 = g_strdup(escaped_histogram_label);
433 g_free(escaped_histogram_label);
440 layout = gtk_widget_create_pango_layout(imd->pr, NULL);
441 pango_layout_set_markup(layout, text, -1);
444 pango_layout_get_pixel_size(layout, &width, &height);
445 /* with empty text width is set to 0, but not height) */
448 else if (height == 0)
450 if (width > 0) width += 10;
451 if (height > 0) height += 10;
455 histogram_read(imd->histogram, imgpixbuf);
456 if (width < 266) width = 266;
457 height += HISTOGRAM_HEIGHT + 5;
460 if (width > 0 && height > 0)
462 /* TODO: make osd color configurable --Zas */
463 pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
464 pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, 240, 240, 240, 210);
465 pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
466 pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
467 pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
468 pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
469 pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
470 pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
471 pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
474 histogram_draw(imd->histogram, pixbuf, 5, height - HISTOGRAM_HEIGHT - 5 , width - 10, HISTOGRAM_HEIGHT);
476 pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, 0, 0, 0, 255);
479 g_object_unref(G_OBJECT(layout));
484 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
486 static GdkPixbuf **icons = NULL;
487 GdkPixbuf *icon = NULL;
489 if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
490 if (icons[flag]) return icons[flag];
492 if (osd_icons[flag].key)
494 icon = pixbuf_inline(osd_icons[flag].key);
499 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
500 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
501 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
504 case IMAGE_OSD_ROTATE_AUTO:
505 pixbuf_set_rect(icon, 3, 8, 11, 12,
508 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
509 20, 9, 14, 15, 14, 3,
512 case IMAGE_OSD_ROTATE_USER:
514 case IMAGE_OSD_COLOR:
515 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
516 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
517 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
519 case IMAGE_OSD_FIRST:
520 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
521 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
522 12, 5, 18, 11, 6, 11,
526 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
527 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
528 12, 18, 6, 12, 18, 12,
532 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
533 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
545 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
549 if (osd->icon_id[flag]) return;
551 pixbuf = image_osd_icon_pixbuf(flag);
554 osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
555 osd_icons[flag].x, osd_icons[flag].y,
559 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
561 if (osd->icon_id[flag])
563 image_overlay_remove(osd->imd, osd->icon_id[flag]);
564 osd->icon_id[flag] = 0;
568 static gint image_osd_update_cb(gpointer data)
570 OverlayStateData *osd = data;
572 osd->imd->overlay_show_zoom = FALSE;
574 if (osd->show & OSD_SHOW_INFO)
576 if (osd->changed_states & IMAGE_STATE_IMAGE)
580 pixbuf = image_osd_info_render(osd->imd);
583 if (osd->ovl_info == 0)
585 osd->ovl_info = image_overlay_add(osd->imd, pixbuf,
586 OSD_INFO_X, OSD_INFO_Y, TRUE, FALSE);
590 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, OSD_INFO_X, OSD_INFO_Y);
592 g_object_unref(pixbuf);
594 else if (osd->ovl_info)
596 image_overlay_remove(osd->imd, osd->ovl_info);
605 image_overlay_remove(osd->imd, osd->ovl_info);
610 if (osd->show & OSD_SHOW_STATUS)
614 if (osd->changed_states & IMAGE_STATE_IMAGE)
616 for (i = 0; i < IMAGE_OSD_COUNT; i++)
618 if (osd_icons[i].reset) osd->icon_time[i] = 0;
622 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
624 osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
625 image_osd_timer_schedule(osd);
628 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
632 if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
635 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
638 osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
639 image_osd_timer_schedule(osd);
642 for (i = 0; i < IMAGE_OSD_COUNT; i++)
644 if (osd->icon_time[i] > 0)
646 image_osd_icon_show(osd, i);
650 image_osd_icon_hide(osd, i);
658 for (i = 0; i < IMAGE_OSD_COUNT; i++)
660 image_osd_icon_hide(osd, i);
664 if (osd->imd->il && osd->imd->il->done)
665 osd->changed_states = IMAGE_STATE_NONE;
670 static void image_osd_update_schedule(OverlayStateData *osd, gint force)
672 if (force) osd->changed_states |= IMAGE_STATE_IMAGE;
674 if (osd->idle_id == -1)
676 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, NULL);
680 void image_osd_update(ImageWindow *imd)
682 OverlayStateData *osd = image_get_osd_data(imd);
686 image_osd_update_schedule(osd, TRUE);
689 static gint image_osd_timer_cb(gpointer data)
691 OverlayStateData *osd = data;
693 gint changed = FALSE;
696 for (i = 0; i < IMAGE_OSD_COUNT; i++)
698 if (osd->icon_time[i] > 1)
701 if (osd->icon_time[i] < 2)
703 osd->icon_time[i] = 0;
713 if (changed) image_osd_update_schedule(osd, FALSE);
724 static void image_osd_timer_schedule(OverlayStateData *osd)
726 if (osd->timer_id == -1)
728 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
732 static void image_osd_state_cb(ImageWindow *imd, ImageState state, gpointer data)
734 OverlayStateData *osd = data;
736 osd->changed_states |= state;
737 image_osd_update_schedule(osd, FALSE);
740 static void image_osd_free(OverlayStateData *osd)
744 if (osd->idle_id != -1) g_source_remove(osd->idle_id);
745 if (osd->timer_id != -1) g_source_remove(osd->timer_id);
751 image_set_osd_data(osd->imd, NULL);
752 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
754 image_set_state_func(osd->imd, NULL, NULL);
755 image_overlay_remove(osd->imd, osd->ovl_info);
757 for (i = 0; i < IMAGE_OSD_COUNT; i++)
759 image_osd_icon_hide(osd, i);
766 static void image_osd_remove(ImageWindow *imd)
768 OverlayStateData *osd = image_get_osd_data(imd);
774 static void image_osd_destroy_cb(GtkWidget *widget, gpointer data)
776 OverlayStateData *osd = data;
782 static void image_osd_enable(ImageWindow *imd, OsdShowFlags show)
784 OverlayStateData *osd = image_get_osd_data(imd);
788 osd = g_new0(OverlayStateData, 1);
793 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
794 G_CALLBACK(image_osd_destroy_cb), osd);
795 image_set_osd_data(imd, osd);
797 image_set_state_func(osd->imd, image_osd_state_cb, osd);
800 if (show != osd->show)
801 image_osd_update_schedule(osd, TRUE);
806 void image_osd_set(ImageWindow *imd, OsdShowFlags show)
810 if (show == OSD_SHOW_NOTHING)
812 image_osd_remove(imd);
816 image_osd_enable(imd, show);
819 gint image_osd_get(ImageWindow *imd, OsdShowFlags *show)
821 OverlayStateData *osd = image_get_osd_data(imd);
823 if (!osd) return FALSE;
825 if (show) *show = osd->show;
833 2+ = show for duration tenths of a second
834 -1 = use default duration
836 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
838 OverlayStateData *osd = image_get_osd_data(imd);
842 if (flag < IMAGE_OSD_NONE || flag >= IMAGE_OSD_COUNT) return;
843 if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
844 if (duration > 1) duration += 1;
846 osd->icon_time[flag] = duration;
848 image_osd_update_schedule(osd, FALSE);
849 image_osd_timer_schedule(osd);