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 }
 315
 316
 317 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
 318 {
 319         gchar *cache_path = NULL;
 320
 321         if (!tl) return FALSE;
 322
 323         if (tl->standard_loader)
 324                 {
 325                 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
 326                 }
 327
 328         if (!tl->fd && !fd) return FALSE;
 329
 330         if (!tl->fd) tl->fd = file_data_ref(fd);
 331
 332
 333         if (tl->cache_enable)
 334                 {
 335                 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
 336
 337                 if (cache_path)
 338                         {
 339                         if (cache_time_valid(cache_path, tl->fd->path))
 340                                 {
 341                                 DEBUG_1("Found in cache:%s", tl->fd->path);
 342
 343                                 if (filesize(cache_path) == 0)
 344                                         {
 345                                         DEBUG_1("Broken image mark found:%s", cache_path);
 346                                         g_free(cache_path);
 347                                         thumb_loader_set_fallback(tl);
 348                                         return FALSE;
 349                                         }
 350
 351                                 DEBUG_1("Cache location:%s", cache_path);
 352                                 }
 353                         else
 354                                 {
 355                                 g_free(cache_path);
 356                                 cache_path = NULL;
 357                                 }
 358                         }
 359                 }
 360
 361         if (!cache_path && options->thumbnails.use_xvpics)
 362                 {
 363                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 364                 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
 365                 if (tl->fd->thumb_pixbuf)
 366                         {
 367                         thumb_loader_delay_done(tl);
 368                         return TRUE;
 369                         }
 370                 }
 371
 372         if (cache_path)
 373                 {
 374                 FileData *fd = file_data_new_no_grouping(cache_path);
 375                 thumb_loader_setup(tl, fd);
 376                 file_data_unref(fd);
 377                 g_free(cache_path);
 378                 tl->cache_hit = TRUE;
 379                 }
 380         else
 381                 {
 382                 thumb_loader_setup(tl, tl->fd);
 383                 }
 384
 385         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 386         if (!image_loader_start(tl->il))
 387                 {
 388                 /* try from original if cache attempt */
 389                 if (tl->cache_hit)
 390                         {
 391                         tl->cache_hit = FALSE;
 392                         log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
 393
 394                         thumb_loader_setup(tl, tl->fd);
 395                         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 396                         if (image_loader_start(tl->il)) return TRUE;
 397                         }
 398                 /* mark failed thumbnail in cache with 0 byte file */
 399                 if (tl->cache_enable)
 400                         {
 401                         thumb_loader_save_thumbnail(tl, TRUE);
 402                         }
 403
 404                 image_loader_free(tl->il);
 405                 tl->il = NULL;
 406                 thumb_loader_set_fallback(tl);
 407                 return FALSE;
 408                 }
 409
 410         return TRUE;
 411 }
 412
 413 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
 414 {
 415         GdkPixbuf *pixbuf;
 416
 417         if (tl && tl->standard_loader)
 418                 {
 419                 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
 420                 }
 421
 422         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 423                 {
 424                 pixbuf = tl->fd->thumb_pixbuf;
 425                 g_object_ref(pixbuf);
 426                 }
 427         else
 428                 {
 429                 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
 430                 }
 431
 432         return pixbuf;
 433 }
 434
 435 ThumbLoader *thumb_loader_new(gint width, gint height)
 436 {
 437         ThumbLoader *tl;
 438
 439         /* non-std thumb loader is more effective for configurations with disabled caching
 440            because it loads the thumbnails at the required size. loader_std loads
 441            the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
 442            and then performs one additional scaling */
 443         if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
 444                 {
 445                 return (ThumbLoader *)thumb_loader_std_new(width, height);
 446                 }
 447
 448         tl = g_new0(ThumbLoader, 1);
 449
 450         tl->cache_enable = options->thumbnails.enable_caching;
 451         tl->percent_done = 0.0;
 452         tl->max_w = width;
 453         tl->max_h = height;
 454
 455         return tl;
 456 }
 457
 458 void thumb_loader_free(ThumbLoader *tl)
 459 {
 460         if (!tl) return;
 461
 462         if (tl->standard_loader)
 463                 {
 464                 thumb_loader_std_free((ThumbLoaderStd *)tl);
 465                 return;
 466                 }
 467
 468         image_loader_free(tl->il);
 469         file_data_unref(tl->fd);
 470
 471         if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
 472
 473         g_free(tl);
 474 }
 475
 476 /* release thumb_pixbuf on file change - this forces reload. */
 477 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
 478 {
 479         if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
 480                 {
 481                 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
 482                 g_object_unref(fd->thumb_pixbuf);
 483                 fd->thumb_pixbuf = NULL;
 484                 }
 485 }
 486
 487
 488 /*
 489  *-----------------------------------------------------------------------------
 490  * xvpics thumbnail support, read-only (private)
 491  *-----------------------------------------------------------------------------
 492  */
 493
 494 /*
 495  * xvpics code originally supplied by:
 496  * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
 497  *
 498  * Note: Code has been modified to fit the style of the other code, and to use
 499  *       a few more glib-isms.
 500  * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
 501  */
 502
 503 #define XV_BUFFER 2048
 504 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
 505 {
 506         FILE *file;
 507         gchar buffer[XV_BUFFER];
 508         guchar *data = NULL;
 509
 510         file = fopen(filename, "rt");
 511         if (!file) return NULL;
 512
 513         if (fgets(buffer, XV_BUFFER, file) != NULL
 514             && strncmp(buffer, "P7 332", 6) == 0)
 515                 {
 516                 gint width, height, depth;
 517
 518                 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
 519
 520                 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
 521                         {
 522                         gsize size = width * height;
 523
 524                         data = g_new(guchar, size);
 525                         if (data && fread(data, 1, size, file) == size)
 526                                 {
 527                                 *widthp = width;
 528                                 *heightp = height;
 529                                 }
 530                         }
 531                 }
 532
 533         fclose(file);
 534         return data;
 535 }
 536 #undef XV_BUFFER
 537
 538 static void free_rgb_buffer(guchar *pixels, gpointer data)
 539 {
 540         g_free(pixels);
 541 }
 542
 543 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
 544 {
 545         gint width, height;
 546         gchar *thumb_name;
 547         gchar *path;
 548         gchar *directory;
 549         gchar *name;
 550         guchar *packed_data;
 551
 552         path = path_from_utf8(thumb_filename);
 553         directory = g_path_get_dirname(path);
 554         name = g_path_get_basename(path);
 555
 556         thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
 557
 558         g_free(name);
 559         g_free(directory);
 560         g_free(path);
 561
 562         packed_data = load_xv_thumbnail(thumb_name, &width, &height);
 563         g_free(thumb_name);
 564
 565         if (packed_data)
 566                 {
 567                 guchar *rgb_data;
 568                 GdkPixbuf *pixbuf;
 569                 gint i;
 570
 571                 rgb_data = g_new(guchar, width * height * 3);
 572                 for (i = 0; i < width * height; i++)
 573                         {
 574                         rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
 575                         rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
 576                         rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
 577                         }
 578                 g_free(packed_data);
 579
 580                 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
 581                                                   width, height, 3 * width, free_rgb_buffer, NULL);
 582
 583                 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
 584                         {
 585                         /* scale */
 586                         GdkPixbuf *tmp;
 587
 588                         tmp = pixbuf;
 589                         pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
 590                         g_object_unref(tmp);
 591                         }
 592
 593                 return pixbuf;
 594                 }
 595
 596         return NULL;
 597 }
 598 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */