src/thumb.c

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