src/thumb.c

   1 /*
   2  * Geeqie
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 - 2012 The Geeqie Team
   5  *
   6  * Author: John Ellis
   7  *
   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!
  11  */
  12
  13
  14 #include "main.h"
  15 #include "thumb.h"
  16
  17 #include "cache.h"
  18 #include "image-load.h"
  19 #include "filedata.h"
  20 #include "pixbuf_util.h"
  21 #include "thumb_standard.h"
  22 #include "ui_fileops.h"
  23 #include "exif.h"
  24 #include "metadata.h"
  25
  26 #include <utime.h>
  27
  28
  29 static void thumb_loader_error_cb(ImageLoader *il, gpointer data);
  30 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd);
  31
  32 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h);
  33
  34
  35 /*
  36  *-----------------------------------------------------------------------------
  37  * thumbnail routines: creation, caching, and maintenance (public)
  38  *-----------------------------------------------------------------------------
  39  */
  40
  41 /* Save thumbnail to disk
  42  * or just mark failed thumbnail with 0 byte file (mark_failure = TRUE) */
  43 static gboolean thumb_loader_save_thumbnail(ThumbLoader *tl, gboolean mark_failure)
  44 {
  45         gchar *cache_dir;
  46         gboolean success = FALSE;
  47         mode_t mode = 0755;
  48
  49         if (!tl || !tl->fd) return FALSE;
  50         if (!mark_failure && !tl->fd->thumb_pixbuf) return FALSE;
  51
  52         cache_dir = cache_get_location(CACHE_TYPE_THUMB, tl->fd->path, FALSE, &mode);
  53
  54         if (recursive_mkdir_if_not_exists(cache_dir, mode))
  55                 {
  56                 gchar *cache_path;
  57                 gchar *pathl;
  58                 gchar *name = g_strconcat(filename_from_path(tl->fd->path), GQ_CACHE_EXT_THUMB, NULL);
  59
  60                 cache_path = g_build_filename(cache_dir, name, NULL);
  61                 g_free(name);
  62
  63                 pathl = path_from_utf8(cache_path);
  64
  65                 if (mark_failure)
  66                         {
  67                         FILE *f = fopen(pathl, "w"); ;
  68
  69                         DEBUG_1("Marking thumb failure: %s", cache_path);
  70                         if (f)
  71                                 {
  72                                 fclose(f);
  73                                 success = TRUE;
  74                                 }
  75                         }
  76                 else
  77                         {
  78                         DEBUG_1("Saving thumb: %s", cache_path);
  79                         success = pixbuf_to_file_as_png(tl->fd->thumb_pixbuf, pathl);
  80                         }
  81
  82                 if (success)
  83                         {
  84                         struct utimbuf ut;
  85                         /* set thumb time to that of source file */
  86
  87                         ut.actime = ut.modtime = filetime(tl->fd->path);
  88                         if (ut.modtime > 0)
  89                                 {
  90                                 utime(pathl, &ut);
  91                                 }
  92                         }
  93                 else
  94                         {
  95                         DEBUG_1("Saving failed: %s", pathl);
  96                         }
  97
  98                 g_free(pathl);
  99                 g_free(cache_path);
 100                 }
 101
 102         g_free(cache_dir);
 103
 104         return success;
 105 }
 106
 107 static void thumb_loader_percent_cb(ImageLoader *il, gdouble percent, gpointer data)
 108 {
 109         ThumbLoader *tl = data;
 110
 111         tl->percent_done = percent;
 112
 113         if (tl->func_progress) tl->func_progress(tl, tl->data);
 114 }
 115
 116 static void thumb_loader_set_fallback(ThumbLoader *tl)
 117 {
 118         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 119         tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->max_w, tl->max_h);
 120 }
 121
 122 static void thumb_loader_done_cb(ImageLoader *il, gpointer data)
 123 {
 124         ThumbLoader *tl = data;
 125         GdkPixbuf *pixbuf;
 126         gint pw, ph;
 127         gint save;
 128         GdkPixbuf *rotated = NULL;
 129
 130         DEBUG_1("thumb done: %s", tl->fd->path);
 131
 132         pixbuf = image_loader_get_pixbuf(tl->il);
 133         if (!pixbuf)
 134                 {
 135                 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
 136                 thumb_loader_error_cb(tl->il, tl);
 137                 return;
 138                 }
 139
 140
 141         if (!tl->cache_hit && options->image.exif_rotate_enable)
 142                 {
 143                 if (!tl->fd->exif_orientation)
 144                         {
 145                         tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
 146                         }
 147
 148                 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
 149                         {
 150                         rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
 151                         pixbuf = rotated;
 152                         }
 153                 }
 154
 155         pw = gdk_pixbuf_get_width(pixbuf);
 156         ph = gdk_pixbuf_get_height(pixbuf);
 157
 158         if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
 159                 {
 160                 /* requested thumbnail size may have changed, load original */
 161                 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
 162                 tl->cache_hit = FALSE;
 163
 164                 thumb_loader_setup(tl, tl->fd);
 165
 166                 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 167
 168                 if (!image_loader_start(tl->il))
 169                         {
 170                         image_loader_free(tl->il);
 171                         tl->il = NULL;
 172
 173                         DEBUG_1("regeneration failure: %s", tl->fd->path);
 174                         thumb_loader_error_cb(tl->il, tl);
 175                         }
 176                 return;
 177                 }
 178
 179         /* scale ?? */
 180
 181         if (pw > tl->max_w || ph > tl->max_h)
 182                 {
 183                 gint w, h;
 184
 185                 if (((gdouble)tl->max_w / pw) < ((gdouble)tl->max_h / ph))
 186                         {
 187                         w = tl->max_w;
 188                         h = (gdouble)w / pw * ph;
 189                         if (h < 1) h = 1;
 190                         }
 191                 else
 192                         {
 193                         h = tl->max_h;
 194                         w = (gdouble)h / ph * pw;
 195                         if (w < 1) w = 1;
 196                         }
 197
 198                 if (tl->fd)
 199                         {
 200                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 201                         tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, (GdkInterpType)options->thumbnails.quality);
 202                         }
 203                 save = TRUE;
 204                 }
 205         else
 206                 {
 207                 if (tl->fd)
 208                         {
 209                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 210                         tl->fd->thumb_pixbuf = pixbuf;
 211
 212                         g_object_ref(tl->fd->thumb_pixbuf);
 213                         }
 214                 save = image_loader_get_shrunk(il);
 215                 }
 216
 217         if (rotated) g_object_unref(rotated);
 218
 219         /* save it ? */
 220         if (tl->cache_enable && save)
 221                 {
 222                 thumb_loader_save_thumbnail(tl, FALSE);
 223                 }
 224
 225         if (tl->func_done) tl->func_done(tl, tl->data);
 226 }
 227
 228 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
 229 {
 230         ThumbLoader *tl = data;
 231
 232         /* if at least some of the image is available, go to done_cb */
 233         if (image_loader_get_pixbuf(tl->il) != NULL)
 234                 {
 235                 thumb_loader_done_cb(il, data);
 236                 return;
 237                 }
 238
 239         DEBUG_1("thumb error: %s", tl->fd->path);
 240
 241         image_loader_free(tl->il);
 242         tl->il = NULL;
 243
 244         thumb_loader_set_fallback(tl);
 245
 246         if (tl->func_error) tl->func_error(tl, tl->data);
 247 }
 248
 249 static gboolean thumb_loader_done_delay_cb(gpointer data)
 250 {
 251         ThumbLoader *tl = data;
 252
 253         tl->idle_done_id = 0;
 254
 255         if (tl->func_done) tl->func_done(tl, tl->data);
 256
 257         return FALSE;
 258 }
 259
 260 static void thumb_loader_delay_done(ThumbLoader *tl)
 261 {
 262         if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
 263 }
 264
 265 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
 266 {
 267         image_loader_free(tl->il);
 268         tl->il = image_loader_new(fd);
 269         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
 270
 271         /* this will speed up jpegs by up to 3x in some cases */
 272         image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
 273
 274         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
 275         if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
 276 }
 277
 278 void thumb_loader_set_callbacks(ThumbLoader *tl,
 279                                 ThumbLoaderFunc func_done,
 280                                 ThumbLoaderFunc func_error,
 281                                 ThumbLoaderFunc func_progress,
 282                                 gpointer data)
 283 {
 284         if (!tl) return;
 285
 286         if (tl->standard_loader)
 287                 {
 288                 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
 289                                                (ThumbLoaderStdFunc) func_done,
 290                                                (ThumbLoaderStdFunc) func_error,
 291                                                (ThumbLoaderStdFunc) func_progress,
 292                                                data);
 293                 return;
 294                 }
 295
 296         tl->func_done = func_done;
 297         tl->func_error = func_error;
 298         tl->func_progress = func_progress;
 299
 300         tl->data = data;
 301 }
 302
 303 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
 304 {
 305         if (!tl) return;
 306
 307         if (tl->standard_loader)
 308                 {
 309                 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
 310                 return;
 311                 }
 312
 313         tl->cache_enable = enable_cache;
 314 #if 0
 315         tl->cache_local = local;
 316         tl->cache_retry = retry_failed;
 317 #endif
 318 }
 319
 320
 321 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
 322 {
 323         gchar *cache_path = NULL;
 324
 325         if (!tl) return FALSE;
 326
 327         if (tl->standard_loader)
 328                 {
 329                 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
 330                 }
 331
 332         if (!tl->fd && !fd) return FALSE;
 333
 334         if (!tl->fd) tl->fd = file_data_ref(fd);
 335
 336
 337         if (tl->cache_enable)
 338                 {
 339                 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
 340
 341                 if (cache_path)
 342                         {
 343                         if (cache_time_valid(cache_path, tl->fd->path))
 344                                 {
 345                                 DEBUG_1("Found in cache:%s", tl->fd->path);
 346
 347                                 if (filesize(cache_path) == 0)
 348                                         {
 349                                         DEBUG_1("Broken image mark found:%s", cache_path);
 350                                         g_free(cache_path);
 351                                         thumb_loader_set_fallback(tl);
 352                                         return FALSE;
 353                                         }
 354
 355                                 DEBUG_1("Cache location:%s", cache_path);
 356                                 }
 357                         else
 358                                 {
 359                                 g_free(cache_path);
 360                                 cache_path = NULL;
 361                                 }
 362                         }
 363                 }
 364
 365         if (!cache_path && options->thumbnails.use_xvpics)
 366                 {
 367                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 368                 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
 369                 if (tl->fd->thumb_pixbuf)
 370                         {
 371                         thumb_loader_delay_done(tl);
 372                         return TRUE;
 373                         }
 374                 }
 375
 376         if (cache_path)
 377                 {
 378                 FileData *fd = file_data_new_no_grouping(cache_path);
 379                 thumb_loader_setup(tl, fd);
 380                 file_data_unref(fd);
 381                 g_free(cache_path);
 382                 tl->cache_hit = TRUE;
 383                 }
 384         else
 385                 {
 386                 thumb_loader_setup(tl, tl->fd);
 387                 }
 388
 389         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 390         if (!image_loader_start(tl->il))
 391                 {
 392                 /* try from original if cache attempt */
 393                 if (tl->cache_hit)
 394                         {
 395                         tl->cache_hit = FALSE;
 396                         log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
 397
 398                         thumb_loader_setup(tl, tl->fd);
 399                         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 400                         if (image_loader_start(tl->il)) return TRUE;
 401                         }
 402                 /* mark failed thumbnail in cache with 0 byte file */
 403                 if (tl->cache_enable)
 404                         {
 405                         thumb_loader_save_thumbnail(tl, TRUE);
 406                         }
 407
 408                 image_loader_free(tl->il);
 409                 tl->il = NULL;
 410                 thumb_loader_set_fallback(tl);
 411                 return FALSE;
 412                 }
 413
 414         return TRUE;
 415 }
 416
 417 #if 0
 418 gint thumb_loader_to_pixmap(ThumbLoader *tl, GdkPixmap **pixmap, GdkBitmap **mask)
 419 {
 420         if (!tl || !tl->pixbuf) return -1;
 421
 422         gdk_pixbuf_render_pixmap_and_mask(tl->pixbuf, pixmap, mask, 128);
 423
 424         return thumb_loader_get_space(tl);
 425 }
 426 #endif
 427
 428 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
 429 {
 430         GdkPixbuf *pixbuf;
 431
 432         if (tl && tl->standard_loader)
 433                 {
 434                 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
 435                 }
 436
 437         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 438                 {
 439                 pixbuf = tl->fd->thumb_pixbuf;
 440                 g_object_ref(pixbuf);
 441                 }
 442         else
 443                 {
 444                 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
 445                 }
 446
 447         return pixbuf;
 448 }
 449
 450 #if 0
 451 gint thumb_loader_get_space(ThumbLoader *tl)
 452 {
 453         if (!tl) return 0;
 454
 455         if (tl->pixbuf) return (tl->max_w - gdk_pixbuf_get_width(tl->pixbuf));
 456
 457         return tl->max_w;
 458 }
 459 #endif
 460
 461 ThumbLoader *thumb_loader_new(gint width, gint height)
 462 {
 463         ThumbLoader *tl;
 464
 465         /* non-std thumb loader is more effective for configurations with disabled caching
 466            because it loads the thumbnails at the required size. loader_std loads
 467            the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
 468            and then performs one additional scaling */
 469         if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
 470                 {
 471                 return (ThumbLoader *)thumb_loader_std_new(width, height);
 472                 }
 473
 474         tl = g_new0(ThumbLoader, 1);
 475
 476         tl->cache_enable = options->thumbnails.enable_caching;
 477         tl->percent_done = 0.0;
 478         tl->max_w = width;
 479         tl->max_h = height;
 480
 481         return tl;
 482 }
 483
 484 void thumb_loader_free(ThumbLoader *tl)
 485 {
 486         if (!tl) return;
 487
 488         if (tl->standard_loader)
 489                 {
 490                 thumb_loader_std_free((ThumbLoaderStd *)tl);
 491                 return;
 492                 }
 493
 494         image_loader_free(tl->il);
 495         file_data_unref(tl->fd);
 496
 497         if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
 498
 499         g_free(tl);
 500 }
 501
 502 #if 0
 503 gint thumb_from_xpm_d(const gchar **data, gint max_w, gint max_h, GdkPixmap **pixmap, GdkBitmap **mask)
 504 {
 505         GdkPixbuf *pixbuf;
 506         gint w, h;
 507
 508         pixbuf = gdk_pixbuf_new_from_xpm_data(data);
 509         w = gdk_pixbuf_get_width(pixbuf);
 510         h = gdk_pixbuf_get_height(pixbuf);
 511
 512         if (pixbuf_scale_aspect(w, h, max_w, max_h, &w, &h))
 513                 {
 514                 /* scale */
 515                 GdkPixbuf *tmp;
 516
 517                 tmp = pixbuf;
 518                 pixbuf = gdk_pixbuf_scale_simple(tmp, w, h, GDK_INTERP_NEAREST);
 519                 gdk_pixbuf_unref(tmp);
 520                 }
 521
 522         gdk_pixbuf_render_pixmap_and_mask(pixbuf, pixmap, mask, 128);
 523         gdk_pixbuf_unref(pixbuf);
 524
 525         return w;
 526 }
 527 #endif
 528
 529
 530 /* release thumb_pixbuf on file change - this forces reload. */
 531 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
 532 {
 533         if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
 534                 {
 535                 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
 536                 g_object_unref(fd->thumb_pixbuf);
 537                 fd->thumb_pixbuf = NULL;
 538                 }
 539 }
 540
 541
 542 /*
 543  *-----------------------------------------------------------------------------
 544  * xvpics thumbnail support, read-only (private)
 545  *-----------------------------------------------------------------------------
 546  */
 547
 548 /*
 549  * xvpics code originally supplied by:
 550  * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
 551  *
 552  * Note: Code has been modified to fit the style of the other code, and to use
 553  *       a few more glib-isms.
 554  * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
 555  */
 556
 557 #define XV_BUFFER 2048
 558 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
 559 {
 560         FILE *file;
 561         gchar buffer[XV_BUFFER];
 562         guchar *data = NULL;
 563
 564         file = fopen(filename, "rt");
 565         if (!file) return NULL;
 566
 567         if (fgets(buffer, XV_BUFFER, file) != NULL
 568             && strncmp(buffer, "P7 332", 6) == 0)
 569                 {
 570                 gint width, height, depth;
 571
 572                 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
 573
 574                 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
 575                         {
 576                         gsize size = width * height;
 577
 578                         data = g_new(guchar, size);
 579                         if (data && fread(data, 1, size, file) == size)
 580                                 {
 581                                 *widthp = width;
 582                                 *heightp = height;
 583                                 }
 584                         }
 585                 }
 586
 587         fclose(file);
 588         return data;
 589 }
 590 #undef XV_BUFFER
 591
 592 static void free_rgb_buffer(guchar *pixels, gpointer data)
 593 {
 594         g_free(pixels);
 595 }
 596
 597 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
 598 {
 599         gint width, height;
 600         gchar *thumb_name;
 601         gchar *path;
 602         gchar *directory;
 603         gchar *name;
 604         guchar *packed_data;
 605
 606         path = path_from_utf8(thumb_filename);
 607         directory = g_path_get_dirname(path);
 608         name = g_path_get_basename(path);
 609
 610         thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
 611
 612         g_free(name);
 613         g_free(directory);
 614         g_free(path);
 615
 616         packed_data = load_xv_thumbnail(thumb_name, &width, &height);
 617         g_free(thumb_name);
 618
 619         if (packed_data)
 620                 {
 621                 guchar *rgb_data;
 622                 GdkPixbuf *pixbuf;
 623                 gint i;
 624
 625                 rgb_data = g_new(guchar, width * height * 3);
 626                 for (i = 0; i < width * height; i++)
 627                         {
 628                         rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
 629                         rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
 630                         rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
 631                         }
 632                 g_free(packed_data);
 633
 634                 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
 635                                                   width, height, 3 * width, free_rgb_buffer, NULL);
 636
 637                 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
 638                         {
 639                         /* scale */
 640                         GdkPixbuf *tmp;
 641
 642                         tmp = pixbuf;
 643                         pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
 644                         g_object_unref(tmp);
 645                         }
 646
 647                 return pixbuf;
 648                 }
 649
 650         return NULL;
 651 }
 652 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */