src/thumb.c

   1 /*
   2  * Geeqie
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 - 2009 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, const gchar *path);
  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, "Exif.Image.Orientation", 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->path);
 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 gint thumb_loader_done_delay_cb(gpointer data)
 250 {
 251         ThumbLoader *tl = data;
 252
 253         tl->idle_done_id = -1;
 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 == -1) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
 263 }
 264
 265 static void thumb_loader_setup(ThumbLoader *tl, const gchar *path)
 266 {
 267         FileData *fd = file_data_new_simple(path);
 268         image_loader_free(tl->il);
 269         tl->il = image_loader_new(fd);
 270         file_data_unref(fd);
 271         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
 272
 273         if (options->thumbnails.fast)
 274                 {
 275                 /* this will speed up jpegs by up to 3x in some cases */
 276                 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
 277                 }
 278
 279         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
 280         if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
 281 }
 282
 283 void thumb_loader_set_callbacks(ThumbLoader *tl,
 284                                 ThumbLoaderFunc func_done,
 285                                 ThumbLoaderFunc func_error,
 286                                 ThumbLoaderFunc func_progress,
 287                                 gpointer data)
 288 {
 289         if (!tl) return;
 290
 291         if (tl->standard_loader)
 292                 {
 293                 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
 294                                                (ThumbLoaderStdFunc) func_done,
 295                                                (ThumbLoaderStdFunc) func_error,
 296                                                (ThumbLoaderStdFunc) func_progress,
 297                                                data);
 298                 return;
 299                 }
 300
 301         tl->func_done = func_done;
 302         tl->func_error = func_error;
 303         tl->func_progress = func_progress;
 304
 305         tl->data = data;
 306 }
 307
 308 void thumb_loader_set_cache(ThumbLoader *tl, gint enable_cache, gint local, gint retry_failed)
 309 {
 310         if (!tl) return;
 311
 312         if (tl->standard_loader)
 313                 {
 314                 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
 315                 return;
 316                 }
 317
 318         tl->cache_enable = enable_cache;
 319 #if 0
 320         tl->cache_local = local;
 321         tl->cache_retry = retry_failed;
 322 #endif
 323 }
 324
 325
 326 gint thumb_loader_start(ThumbLoader *tl, FileData *fd)
 327 {
 328         gchar *cache_path = NULL;
 329
 330         if (!tl) return FALSE;
 331
 332         if (tl->standard_loader)
 333                 {
 334                 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
 335                 }
 336
 337         if (!tl->fd && !fd) return FALSE;
 338
 339         if (!tl->fd) tl->fd = file_data_ref(fd);
 340
 341
 342         if (tl->cache_enable)
 343                 {
 344                 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
 345
 346                 if (cache_path)
 347                         {
 348                         if (cache_time_valid(cache_path, tl->fd->path))
 349                                 {
 350                                 DEBUG_1("Found in cache:%s", tl->fd->path);
 351
 352                                 if (filesize(cache_path) == 0)
 353                                         {
 354                                         DEBUG_1("Broken image mark found:%s", cache_path);
 355                                         g_free(cache_path);
 356                                         thumb_loader_set_fallback(tl);
 357                                         return FALSE;
 358                                         }
 359
 360                                 DEBUG_1("Cache location:%s", cache_path);
 361                                 }
 362                         else
 363                                 {
 364                                 g_free(cache_path);
 365                                 cache_path = NULL;
 366                                 }
 367                         }
 368                 }
 369
 370         if (!cache_path && options->thumbnails.use_xvpics)
 371                 {
 372                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 373                 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
 374                 if (tl->fd->thumb_pixbuf)
 375                         {
 376                         thumb_loader_delay_done(tl);
 377                         return TRUE;
 378                         }
 379                 }
 380
 381         if (cache_path)
 382                 {
 383                 thumb_loader_setup(tl, cache_path);
 384                 g_free(cache_path);
 385                 tl->cache_hit = TRUE;
 386                 }
 387         else
 388                 {
 389                 thumb_loader_setup(tl, tl->fd->path);
 390                 }
 391
 392         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 393         if (!image_loader_start(tl->il))
 394                 {
 395                 /* try from original if cache attempt */
 396                 if (tl->cache_hit)
 397                         {
 398                         tl->cache_hit = FALSE;
 399                         log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
 400
 401                         thumb_loader_setup(tl, tl->fd->path);
 402                         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 403                         if (image_loader_start(tl->il)) return TRUE;
 404                         }
 405                 /* mark failed thumbnail in cache with 0 byte file */
 406                 if (tl->cache_enable)
 407                         {
 408                         thumb_loader_save_thumbnail(tl, TRUE);
 409                         }
 410
 411                 image_loader_free(tl->il);
 412                 tl->il = NULL;
 413                 thumb_loader_set_fallback(tl);
 414                 return FALSE;
 415                 }
 416
 417         return TRUE;
 418 }
 419
 420 #if 0
 421 gint thumb_loader_to_pixmap(ThumbLoader *tl, GdkPixmap **pixmap, GdkBitmap **mask)
 422 {
 423         if (!tl || !tl->pixbuf) return -1;
 424
 425         gdk_pixbuf_render_pixmap_and_mask(tl->pixbuf, pixmap, mask, 128);
 426
 427         return thumb_loader_get_space(tl);
 428 }
 429 #endif
 430
 431 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
 432 {
 433         GdkPixbuf *pixbuf;
 434
 435         if (tl && tl->standard_loader)
 436                 {
 437                 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
 438                 }
 439
 440         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 441                 {
 442                 pixbuf = tl->fd->thumb_pixbuf;
 443                 g_object_ref(pixbuf);
 444                 }
 445         else
 446                 {
 447                 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
 448                 }
 449
 450         return pixbuf;
 451 }
 452
 453 #if 0
 454 gint thumb_loader_get_space(ThumbLoader *tl)
 455 {
 456         if (!tl) return 0;
 457
 458         if (tl->pixbuf) return (tl->max_w - gdk_pixbuf_get_width(tl->pixbuf));
 459
 460         return tl->max_w;
 461 }
 462 #endif
 463
 464 ThumbLoader *thumb_loader_new(gint width, gint height)
 465 {
 466         ThumbLoader *tl;
 467
 468         /* non-std thumb loader is more effective for configurations with disabled caching
 469            because it loads the thumbnails at the required size. loader_std loads
 470            the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
 471            and then performs one additional scaling */
 472         if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
 473                 {
 474                 return (ThumbLoader *)thumb_loader_std_new(width, height);
 475                 }
 476
 477         tl = g_new0(ThumbLoader, 1);
 478         tl->standard_loader = FALSE;
 479         tl->fd = NULL;
 480         tl->cache_enable = options->thumbnails.enable_caching;
 481         tl->cache_hit = FALSE;
 482         tl->percent_done = 0.0;
 483         tl->max_w = width;
 484         tl->max_h = height;
 485
 486         tl->il = NULL;
 487
 488         tl->idle_done_id = -1;
 489
 490         return tl;
 491 }
 492
 493 void thumb_loader_free(ThumbLoader *tl)
 494 {
 495         if (!tl) return;
 496
 497         if (tl->standard_loader)
 498                 {
 499                 thumb_loader_std_free((ThumbLoaderStd *)tl);
 500                 return;
 501                 }
 502
 503         image_loader_free(tl->il);
 504         file_data_unref(tl->fd);
 505
 506         if (tl->idle_done_id != -1) g_source_remove(tl->idle_done_id);
 507
 508         g_free(tl);
 509 }
 510
 511 #if 0
 512 gint thumb_from_xpm_d(const gchar **data, gint max_w, gint max_h, GdkPixmap **pixmap, GdkBitmap **mask)
 513 {
 514         GdkPixbuf *pixbuf;
 515         gint w, h;
 516
 517         pixbuf = gdk_pixbuf_new_from_xpm_data(data);
 518         w = gdk_pixbuf_get_width(pixbuf);
 519         h = gdk_pixbuf_get_height(pixbuf);
 520
 521         if (pixbuf_scale_aspect(w, h, max_w, max_h, &w, &h))
 522                 {
 523                 /* scale */
 524                 GdkPixbuf *tmp;
 525
 526                 tmp = pixbuf;
 527                 pixbuf = gdk_pixbuf_scale_simple(tmp, w, h, GDK_INTERP_NEAREST);
 528                 gdk_pixbuf_unref(tmp);
 529                 }
 530
 531         gdk_pixbuf_render_pixmap_and_mask(pixbuf, pixmap, mask, 128);
 532         gdk_pixbuf_unref(pixbuf);
 533
 534         return w;
 535 }
 536 #endif
 537
 538
 539 /* release thumb_pixbuf on file change - this forces reload. */
 540 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
 541 {
 542         if (type != NOTIFY_TYPE_INTERNAL && fd->thumb_pixbuf)
 543                 {
 544                 g_object_unref(fd->thumb_pixbuf);
 545                 fd->thumb_pixbuf = NULL;
 546                 }
 547 }
 548
 549
 550 /*
 551  *-----------------------------------------------------------------------------
 552  * xvpics thumbnail support, read-only (private)
 553  *-----------------------------------------------------------------------------
 554  */
 555
 556 /*
 557  * xvpics code originally supplied by:
 558  * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
 559  *
 560  * Note: Code has been modified to fit the style of the other code, and to use
 561  *       a few more glib-isms.
 562  * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
 563  */
 564
 565 #define XV_BUFFER 2048
 566 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
 567 {
 568         FILE *file;
 569         gchar buffer[XV_BUFFER];
 570         guchar *data = NULL;
 571
 572         file = fopen(filename, "rt");
 573         if (!file) return NULL;
 574
 575         if (fgets(buffer, XV_BUFFER, file) != NULL
 576             && strncmp(buffer, "P7 332", 6) == 0)
 577                 {
 578                 gint width, height, depth;
 579
 580                 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
 581
 582                 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
 583                         {
 584                         gsize size = width * height;
 585
 586                         data = g_new(guchar, size);
 587                         if (data && fread(data, 1, size, file) == size)
 588                                 {
 589                                 *widthp = width;
 590                                 *heightp = height;
 591                                 }
 592                         }
 593                 }
 594
 595         fclose(file);
 596         return data;
 597 }
 598 #undef XV_BUFFER
 599
 600 static void free_rgb_buffer(guchar *pixels, gpointer data)
 601 {
 602         g_free(pixels);
 603 }
 604
 605 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
 606 {
 607         gint width, height;
 608         gchar *thumb_name;
 609         gchar *path;
 610         gchar *directory;
 611         gchar *name;
 612         guchar *packed_data;
 613
 614         path = path_from_utf8(thumb_filename);
 615         directory = g_path_get_dirname(path);
 616         name = g_path_get_basename(path);
 617
 618         thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
 619
 620         g_free(name);
 621         g_free(directory);
 622         g_free(path);
 623
 624         packed_data = load_xv_thumbnail(thumb_name, &width, &height);
 625         g_free(thumb_name);
 626
 627         if (packed_data)
 628                 {
 629                 guchar *rgb_data;
 630                 GdkPixbuf *pixbuf;
 631                 gint i;
 632
 633                 rgb_data = g_new(guchar, width * height * 3);
 634                 for (i = 0; i < width * height; i++)
 635                         {
 636                         rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
 637                         rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
 638                         rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
 639                         }
 640                 g_free(packed_data);
 641
 642                 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
 643                                                   width, height, 3 * width, free_rgb_buffer, NULL);
 644
 645                 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
 646                         {
 647                         /* scale */
 648                         GdkPixbuf *tmp;
 649
 650                         tmp = pixbuf;
 651                         pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
 652                         g_object_unref(tmp);
 653                         }
 654
 655                 return pixbuf;
 656                 }
 657
 658         return NULL;
 659 }
 660 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */