src/image-overlay.c

   1 /*
   2  * Geeqie
   3  * (C) 2006 John Ellis
   4  *
   5  * Author: John Ellis
   6  *
   7  * This software is released under the GNU General Public License (GNU GPL).
   8  * Please read the included file COPYING for more information.
   9  * This software comes with no warranty of any kind, use at your own risk!
  10  */
  11
  12 #include "gqview.h"
  13 #include "image-overlay.h"
  14
  15 #include "collect.h"
  16 #include "exif.h"
  17 #include "filelist.h"
  18 #include "image.h"
  19 #include "img-view.h"
  20 #include "layout.h"
  21 #include "pixbuf-renderer.h"
  22 #include "pixbuf_util.h"
  23
  24
  25 /*
  26  *----------------------------------------------------------------------------
  27  * image overlay
  28  *----------------------------------------------------------------------------
  29  */
  30
  31 typedef struct _OverlayStateData OverlayStateData;
  32 struct _OverlayStateData {
  33         ImageWindow *imd;
  34         ImageState changed_states;
  35
  36         gint show_info;
  37         gint show_status;
  38
  39         gint ovl_info;
  40
  41         gint icon_time[IMAGE_OSD_COUNT];
  42         gint icon_id[IMAGE_OSD_COUNT];
  43
  44         gint idle_id;
  45         gint timer_id;
  46         gulong destroy_id;
  47 };
  48
  49
  50 typedef struct _OSDIcon OSDIcon;
  51 struct _OSDIcon {
  52         gint reset;     /* reset on new image */
  53         gint x;         /* x, y offset */
  54         gint y;
  55         gchar *key;     /* inline pixbuf */
  56 };
  57
  58 static OSDIcon osd_icons[] = {
  59         {  TRUE,   0,   0, NULL },                      /* none */
  60         {  TRUE, -10, -10, NULL },                      /* auto rotated */
  61         {  TRUE, -10, -10, NULL },                      /* user rotated */
  62         {  TRUE, -40, -10, NULL },                      /* color embedded */
  63         {  TRUE, -70, -10, NULL },                      /* first image */
  64         {  TRUE, -70, -10, NULL },                      /* last image */
  65         { FALSE, -70, -10, NULL },                      /* osd enabled */
  66         { FALSE, 0, 0, NULL }
  67 };
  68
  69 #define OSD_DATA "overlay-data"
  70
  71 #define OSD_INFO_X 10
  72 #define OSD_INFO_Y -10
  73
  74 #define IMAGE_OSD_DEFAULT_DURATION 30
  75
  76
  77 static void image_osd_timer_schedule(OverlayStateData *osd);
  78
  79 static gchar *image_osd_mkinfo(const gchar *str, ImageWindow *imd, GHashTable *vars)
  80 {
  81         gchar delim = '%', imp = '|', sep[] = " - ";
  82         gchar *start, *end;
  83         gint pos, prev;
  84         gint last;
  85         gchar *name, *data;
  86         GString *new = g_string_new(str);
  87         gchar *ret;
  88         ExifData *exif;
  89
  90         exif = exif_read_fd(imd->image_fd, FALSE);
  91         prev = 0;
  92         last = FALSE;
  93
  94         while (TRUE)
  95                 {
  96                 start = strchr(new->str, delim);
  97                 if (!start)
  98                         break;
  99                 end = strchr(start+1, delim);
 100                 if (!end)
 101                         break;
 102
 103                 name = g_strndup(start+1, end-start-1);
 104                 pos = start-new->str;
 105                 data = g_strdup(g_hash_table_lookup(vars, name));
 106                 if (!data && exif)
 107                         data = exif_get_data_as_text(exif, name);
 108
 109                 g_string_erase(new, pos, end-start+1);
 110                 if (data)
 111                         g_string_insert(new, pos, data);
 112                 if (pos-prev == 2 && new->str[pos-1] == imp)
 113                         {
 114                         g_string_erase(new, --pos, 1);
 115                         if (last && data)
 116                                 {
 117                                 g_string_insert(new, pos, sep);
 118                                 pos += strlen(sep);
 119                                 }
 120                         }
 121
 122                 prev = data ? pos+strlen(data)-1 : pos-1;
 123                 last = data ? TRUE : last;
 124                 g_free(name);
 125                 g_free(data);
 126                 }
 127
 128         /* search and destroy empty lines */
 129         end = new->str;
 130         while ((start = strchr(end, '\n')))
 131                 {
 132                 end = start;
 133                 while (*++(end) == '\n')
 134                         ;
 135                 g_string_erase(new, start-new->str, end-start-1);
 136                 }
 137
 138         g_strchomp(new->str);
 139
 140         ret = new->str;
 141         g_string_free(new, FALSE);
 142
 143         return ret;
 144 }
 145
 146 static GdkPixbuf *image_osd_info_render(ImageWindow *imd)
 147 {
 148         GdkPixbuf *pixbuf;
 149         gint width, height;
 150         PangoLayout *layout;
 151         const gchar *name;
 152         gchar *name_escaped;
 153         gchar *text, *text2;
 154         gchar *size;
 155         gint n, t;
 156         CollectionData *cd;
 157         CollectInfo *info;
 158         gchar *ct;
 159         gint w, h;
 160         GHashTable *vars;
 161
 162         vars = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
 163
 164         name = image_get_name(imd);
 165         if (name)
 166                 {
 167                 name_escaped = g_markup_escape_text(name, -1);
 168                 }
 169         else
 170                 {
 171                 name_escaped = NULL;
 172                 }
 173
 174         cd = image_get_collection(imd, &info);
 175         if (cd)
 176                 {
 177                 gchar *buf;
 178
 179                 t = g_list_length(cd->list);
 180                 n = g_list_index(cd->list, info) + 1;
 181                 buf = g_markup_escape_text((cd->name) ? cd->name : _("Untitled"), -1);
 182                 ct = g_strdup_printf("<i>%s</i>\n", buf);
 183                 g_free(buf);
 184                 }
 185         else
 186                 {
 187                 LayoutWindow *lw;
 188
 189                 lw = layout_find_by_image(imd);
 190                 if (lw)
 191                         {
 192                         if (lw->slideshow)
 193                                 {
 194                                 n = g_list_length(lw->slideshow->list_done);
 195                                 t = n + g_list_length(lw->slideshow->list);
 196                                 if (n == 0) n = t;
 197                                 }
 198                         else
 199                                 {
 200                                 t = layout_list_count(lw, NULL);
 201                                 n = layout_list_get_index(lw, image_get_path(lw->image)) + 1;
 202                                 }
 203                         }
 204                 else if (view_window_find_image(imd, &n, &t))
 205                         {
 206                         n++;
 207                         }
 208                 else
 209                         {
 210                         t = 1;
 211                         n = 1;
 212                         }
 213
 214                 if (n < 1) n = 1;
 215                 if (t < 1) t = 1;
 216
 217                 ct = g_strdup("");
 218                 }
 219
 220         size = text_from_size_abrev(imd->size);
 221         if (!imd->unknown)
 222                 {
 223                 if (imd->delay_flip &&
 224                     imd->il && imd->il->pixbuf &&
 225                     image_get_pixbuf(imd) != imd->il->pixbuf)
 226                         {
 227                         w = gdk_pixbuf_get_width(imd->il->pixbuf);
 228                         h = gdk_pixbuf_get_height(imd->il->pixbuf);
 229                         }
 230                 else
 231                         {
 232                         pixbuf_renderer_get_image_size(PIXBUF_RENDERER(imd->pr), &w, &h);
 233                         }
 234
 235                 g_hash_table_insert(vars, "width", g_strdup_printf("%d", w));
 236                 g_hash_table_insert(vars, "height", g_strdup_printf("%d", h));
 237                 g_hash_table_insert(vars, "res", g_strdup_printf("%d × %d", w, h));
 238                 }
 239
 240         g_hash_table_insert(vars, "collection", g_strdup(ct));
 241         g_hash_table_insert(vars, "number", g_strdup_printf("%d", n));
 242         g_hash_table_insert(vars, "total", g_strdup_printf("%d", t));
 243         g_hash_table_insert(vars, "name", g_strdup(name_escaped));
 244         g_hash_table_insert(vars, "date", g_strdup(text_from_time(imd->mtime)));
 245         g_hash_table_insert(vars, "size", g_strdup(size));
 246
 247         if (!name_escaped)
 248                 {
 249                 text = g_strdup_printf(_("Untitled"));
 250                 }
 251         else
 252                 {
 253                 text = image_osd_mkinfo(fullscreen_info, imd, vars);
 254                 }
 255
 256         g_free(size);
 257         g_free(ct);
 258         g_free(name_escaped);
 259         g_hash_table_destroy(vars);
 260
 261         {
 262         FileData *fd = image_get_fd(imd);
 263         gint active_marks = 0;
 264         gint mark;
 265
 266         for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
 267                 {
 268                 active_marks += fd->marks[mark];
 269                 }
 270
 271         if (active_marks > 0)
 272                 {
 273                 GString *buf = g_string_sized_new(FILEDATA_MARKS_SIZE * 2);
 274
 275                 for (mark = 0; mark < FILEDATA_MARKS_SIZE; mark++)
 276                         {
 277                         g_string_append_printf(buf, fd->marks[mark] ? " <span background='#FF00FF'>%c</span>" : " %c", '1' + mark);
 278                         }
 279
 280                 text2 = g_strdup_printf("%s\n%s", text, buf->str);
 281                 g_string_free(buf, TRUE);
 282                 g_free(text);
 283                 }
 284         else
 285                 {
 286                 text2 = text;
 287                 }
 288         }
 289
 290         layout = gtk_widget_create_pango_layout(imd->pr, NULL);
 291         pango_layout_set_markup(layout, text2, -1);
 292         g_free(text2);
 293
 294         pango_layout_get_pixel_size(layout, &width, &height);
 295
 296         width += 10;
 297         height += 10;
 298
 299         /* TODO: make osd color configurable --Zas */
 300         pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, width, height);
 301         pixbuf_set_rect_fill(pixbuf, 3, 3, width-6, height-6, 240, 240, 240, 210);
 302         pixbuf_set_rect(pixbuf, 0, 0, width, height, 240, 240, 240, 80, 1, 1, 1, 1);
 303         pixbuf_set_rect(pixbuf, 1, 1, width-2, height-2, 240, 240, 240, 130, 1, 1, 1, 1);
 304         pixbuf_set_rect(pixbuf, 2, 2, width-4, height-4, 240, 240, 240, 180, 1, 1, 1, 1);
 305         pixbuf_pixel_set(pixbuf, 0, 0, 0, 0, 0, 0);
 306         pixbuf_pixel_set(pixbuf, width - 1, 0, 0, 0, 0, 0);
 307         pixbuf_pixel_set(pixbuf, 0, height - 1, 0, 0, 0, 0);
 308         pixbuf_pixel_set(pixbuf, width - 1, height - 1, 0, 0, 0, 0);
 309
 310         pixbuf_draw_layout(pixbuf, layout, imd->pr, 5, 5, 0, 0, 0, 255);
 311
 312         g_object_unref(G_OBJECT(layout));
 313
 314         return pixbuf;
 315 }
 316
 317 static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag)
 318 {
 319         static GdkPixbuf **icons = NULL;
 320         GdkPixbuf *icon = NULL;
 321
 322         if (!icons) icons = g_new0(GdkPixbuf *, IMAGE_OSD_COUNT);
 323         if (icons[flag]) return icons[flag];
 324
 325         if (osd_icons[flag].key)
 326                 {
 327                 icon = pixbuf_inline(osd_icons[flag].key);
 328                 }
 329
 330         if (!icon)
 331                 {
 332                 icon = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 24, 24);
 333                 pixbuf_set_rect_fill(icon, 1, 1, 22, 22, 255, 255, 255, 200);
 334                 pixbuf_set_rect(icon, 0, 0, 24, 24, 0, 0, 0, 128, 1, 1, 1, 1);
 335                 switch (flag)
 336                         {
 337                         case IMAGE_OSD_ROTATE_AUTO:
 338                                 pixbuf_set_rect(icon, 3, 8, 11, 12,
 339                                                 0, 0, 0, 255,
 340                                                 3, 0, 3, 0);
 341                                 pixbuf_draw_triangle(icon, 14, 3, 6, 12,
 342                                                      20, 9, 14, 15, 14, 3,
 343                                                      0, 0, 0, 255);
 344                                 break;
 345                         case IMAGE_OSD_ROTATE_USER:
 346                                 break;
 347                         case IMAGE_OSD_COLOR:
 348                                 pixbuf_set_rect_fill(icon, 3, 3, 18, 6, 200, 0, 0, 255);
 349                                 pixbuf_set_rect_fill(icon, 3, 9, 18, 6, 0, 200, 0, 255);
 350                                 pixbuf_set_rect_fill(icon, 3, 15, 18, 6, 0, 0, 200, 255);
 351                                 break;
 352                         case IMAGE_OSD_FIRST:
 353                                 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 3, 0);
 354                                 pixbuf_draw_triangle(icon, 6, 5, 12, 6,
 355                                                      12, 5, 18, 11, 6, 11,
 356                                                      0, 0, 0, 255);
 357                                 break;
 358                         case IMAGE_OSD_LAST:
 359                                 pixbuf_set_rect(icon, 3, 3, 18, 18, 0, 0, 0, 200, 3, 3, 0, 3);
 360                                 pixbuf_draw_triangle(icon, 6, 12, 12, 6,
 361                                                      12, 18, 6, 12, 18, 12,
 362                                                      0, 0, 0, 255);
 363                                 break;
 364                         case IMAGE_OSD_ICON:
 365                                 pixbuf_set_rect_fill(icon, 11, 3, 3, 12, 0, 0, 0, 255);
 366                                 pixbuf_set_rect_fill(icon, 11, 17, 3, 3, 0, 0, 0, 255);
 367                                 break;
 368                         default:
 369                                 break;
 370                         }
 371                 }
 372
 373         icons[flag] = icon;
 374
 375         return icon;
 376 }
 377
 378 static void image_osd_icon_show(OverlayStateData *osd, ImageOSDFlag flag)
 379 {
 380         GdkPixbuf *pixbuf;
 381
 382         if (osd->icon_id[flag]) return;
 383
 384         pixbuf = image_osd_icon_pixbuf(flag);
 385         if (!pixbuf) return;
 386
 387         osd->icon_id[flag] = image_overlay_add(osd->imd, pixbuf,
 388                                                osd_icons[flag].x, osd_icons[flag].y,
 389                                                TRUE, FALSE);
 390 }
 391
 392 static void image_osd_icon_hide(OverlayStateData *osd, ImageOSDFlag flag)
 393 {
 394         if (osd->icon_id[flag])
 395                 {
 396                 image_overlay_remove(osd->imd, osd->icon_id[flag]);
 397                 osd->icon_id[flag] = 0;
 398                 }
 399 }
 400
 401 static gint image_osd_update_cb(gpointer data)
 402 {
 403         OverlayStateData *osd = data;
 404
 405         if (osd->show_info)
 406                 {
 407                 if (osd->changed_states & IMAGE_STATE_IMAGE)
 408                         {
 409                         GdkPixbuf *pixbuf;
 410
 411                         pixbuf = image_osd_info_render(osd->imd);
 412                         if (osd->ovl_info == 0)
 413                                 {
 414                                 osd->ovl_info = image_overlay_add(osd->imd, pixbuf,
 415                                                                   OSD_INFO_X, OSD_INFO_Y, TRUE, FALSE);
 416                                 }
 417                         else
 418                                 {
 419                                 image_overlay_set(osd->imd, osd->ovl_info, pixbuf, OSD_INFO_X, OSD_INFO_Y);
 420                                 }
 421                         g_object_unref(pixbuf);
 422                         }
 423                 }
 424         else
 425                 {
 426                 if (osd->ovl_info)
 427                         {
 428                         image_overlay_remove(osd->imd, osd->ovl_info);
 429                         osd->ovl_info = 0;
 430                         }
 431                 }
 432
 433         if (osd->show_status)
 434                 {
 435                 gint i;
 436
 437                 if (osd->changed_states & IMAGE_STATE_IMAGE)
 438                         {
 439                         for (i = 0; i < IMAGE_OSD_COUNT; i++)
 440                                 {
 441                                 if (osd_icons[i].reset) osd->icon_time[i] = 0;
 442                                 }
 443                         }
 444
 445                 if (osd->changed_states & IMAGE_STATE_COLOR_ADJ)
 446                         {
 447                         osd->icon_time[IMAGE_OSD_COLOR] = IMAGE_OSD_DEFAULT_DURATION + 1;
 448                         image_osd_timer_schedule(osd);
 449                         }
 450
 451                 if (osd->changed_states & IMAGE_STATE_ROTATE_AUTO)
 452                         {
 453                         gint n = 0;
 454
 455                         if (osd->imd->state & IMAGE_STATE_ROTATE_AUTO)
 456                                 {
 457                                 n = 1;
 458                                 if (!osd->imd->cm) n += IMAGE_OSD_DEFAULT_DURATION;
 459                                 }
 460
 461                         osd->icon_time[IMAGE_OSD_ROTATE_AUTO] = n;
 462                         image_osd_timer_schedule(osd);
 463                         }
 464
 465                 for (i = 0; i < IMAGE_OSD_COUNT; i++)
 466                         {
 467                         if (osd->icon_time[i] > 0)
 468                                 {
 469                                 image_osd_icon_show(osd, i);
 470                                 }
 471                         else
 472                                 {
 473                                 image_osd_icon_hide(osd, i);
 474                                 }
 475                         }
 476                 }
 477         else
 478                 {
 479                 gint i;
 480
 481                 for (i = 0; i < IMAGE_OSD_COUNT; i++)
 482                         {
 483                         image_osd_icon_hide(osd, i);
 484                         }
 485                 }
 486
 487         osd->changed_states = IMAGE_STATE_NONE;
 488         osd->idle_id = -1;
 489         return FALSE;
 490 }
 491
 492 static void image_osd_update_schedule(OverlayStateData *osd, gint force)
 493 {
 494         if (force) osd->changed_states |= IMAGE_STATE_IMAGE;
 495
 496         if (osd->idle_id == -1)
 497                 {
 498                 osd->idle_id = g_idle_add_full(G_PRIORITY_HIGH, image_osd_update_cb, osd, NULL);
 499                 }
 500 }
 501
 502 void image_osd_update(ImageWindow *imd)
 503 {
 504         OverlayStateData *osd;
 505
 506         if (!imd) return;
 507
 508         osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
 509         if (!osd) return;
 510
 511         image_osd_update_schedule(osd, TRUE);
 512 }
 513
 514 static gint image_osd_timer_cb(gpointer data)
 515 {
 516         OverlayStateData *osd = data;
 517         gint done = TRUE;
 518         gint changed = FALSE;
 519         gint i;
 520
 521         for (i = 0; i < IMAGE_OSD_COUNT; i++)
 522                 {
 523                 if (osd->icon_time[i] > 1)
 524                         {
 525                         osd->icon_time[i]--;
 526                         if (osd->icon_time[i] < 2)
 527                                 {
 528                                 osd->icon_time[i] = 0;
 529                                 changed = TRUE;
 530                                 }
 531                         else
 532                                 {
 533                                 done = FALSE;
 534                                 }
 535                         }
 536                 }
 537
 538         if (changed) image_osd_update_schedule(osd, FALSE);
 539
 540         if (done)
 541                 {
 542                 osd->timer_id = -1;
 543                 return FALSE;
 544                 }
 545
 546         return TRUE;
 547 }
 548
 549 static void image_osd_timer_schedule(OverlayStateData *osd)
 550 {
 551         if (osd->timer_id == -1)
 552                 {
 553                 osd->timer_id = g_timeout_add(100, image_osd_timer_cb, osd);
 554                 }
 555 }
 556
 557 static void image_osd_state_cb(ImageWindow *imd, ImageState state, gpointer data)
 558 {
 559         OverlayStateData *osd = data;
 560
 561         osd->changed_states |= state;
 562         image_osd_update_schedule(osd, FALSE);
 563 }
 564
 565 static void image_osd_free(OverlayStateData *osd)
 566 {
 567         if (!osd) return;
 568
 569         if (osd->idle_id != -1) g_source_remove(osd->idle_id);
 570         if (osd->timer_id != -1) g_source_remove(osd->timer_id);
 571
 572         if (osd->imd)
 573                 {
 574                 gint i;
 575
 576                 g_object_set_data(G_OBJECT(osd->imd->pr), "IMAGE_OVERLAY_DATA", NULL);
 577                 g_signal_handler_disconnect(osd->imd->pr, osd->destroy_id);
 578
 579                 image_set_state_func(osd->imd, NULL, NULL);
 580                 image_overlay_remove(osd->imd, osd->ovl_info);
 581
 582                 for (i = 0; i < IMAGE_OSD_COUNT; i++)
 583                         {
 584                         image_osd_icon_hide(osd, i);
 585                         }
 586                 }
 587
 588         g_free(osd);
 589 }
 590
 591 static void image_osd_remove(ImageWindow *imd)
 592 {
 593         OverlayStateData *osd;
 594
 595         osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
 596         image_osd_free(osd);
 597 }
 598
 599 static void image_osd_destroy_cb(GtkWidget *widget, gpointer data)
 600 {
 601         OverlayStateData *osd = data;
 602
 603         osd->imd = NULL;
 604         image_osd_free(osd);
 605 }
 606
 607 static void image_osd_enable(ImageWindow *imd, gint info, gint status)
 608 {
 609         OverlayStateData *osd;
 610
 611         osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
 612         if (!osd)
 613                 {
 614                 osd = g_new0(OverlayStateData, 1);
 615                 osd->imd = imd;
 616                 osd->idle_id = -1;
 617                 osd->timer_id = -1;
 618
 619                 osd->destroy_id = g_signal_connect(G_OBJECT(imd->pr), "destroy",
 620                                                    G_CALLBACK(image_osd_destroy_cb), osd);
 621                 g_object_set_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA", osd);
 622
 623                 image_set_state_func(osd->imd, image_osd_state_cb, osd);
 624                 }
 625
 626         if (osd->show_info != info ||
 627             osd->show_status != status)
 628                 {
 629                 osd->show_info = info;
 630                 osd->show_status = status;
 631
 632                 image_osd_update_schedule(osd, TRUE);
 633                 }
 634 }
 635
 636 void image_osd_set(ImageWindow *imd, gint info, gint status)
 637 {
 638         if (!imd) return;
 639
 640         if (!info && !status)
 641                 {
 642                 image_osd_remove(imd);
 643                 return;
 644                 }
 645
 646         image_osd_enable(imd, info, status);
 647 }
 648
 649 gint image_osd_get(ImageWindow *imd, gint *info, gint *status)
 650 {
 651         OverlayStateData *osd;
 652
 653         if (!imd) return FALSE;
 654
 655         osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
 656         if (!osd) return FALSE;
 657
 658         if (info) *info = osd->show_info;
 659         if (status) *status = osd->show_status;
 660
 661         return TRUE;
 662 }
 663
 664 /* duration:
 665     0 = hide
 666     1 = show
 667    2+ = show for duration tenths of a second
 668    -1 = use default duration
 669  */
 670 void image_osd_icon(ImageWindow *imd, ImageOSDFlag flag, gint duration)
 671 {
 672         OverlayStateData *osd;
 673
 674         if (!imd) return;
 675
 676         osd = g_object_get_data(G_OBJECT(imd->pr), "IMAGE_OVERLAY_DATA");
 677         if (!osd) return;
 678
 679         if (flag < IMAGE_OSD_NONE || flag >= IMAGE_OSD_COUNT) return;
 680         if (duration < 0) duration = IMAGE_OSD_DEFAULT_DURATION;
 681         if (duration > 1) duration += 1;
 682
 683         osd->icon_time[flag] = duration;
 684
 685         image_osd_update_schedule(osd, FALSE);
 686         image_osd_timer_schedule(osd);
 687 }