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 (cache_ensure_dir_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_done_cb(ImageLoader *il, gpointer data)
 116 {
 117         ThumbLoader *tl = data;
 118         GdkPixbuf *pixbuf;
 119         gint pw, ph;
 120         gint save;
 121         GdkPixbuf *rotated = NULL;
 122
 123         DEBUG_1("thumb done: %s", tl->fd->path);
 124
 125         pixbuf = image_loader_get_pixbuf(tl->il);
 126         if (!pixbuf)
 127                 {
 128                 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
 129                 thumb_loader_error_cb(tl->il, tl);
 130                 return;
 131                 }
 132
 133
 134         if (!tl->cache_hit && options->image.exif_rotate_enable)
 135                 {
 136                 if (!tl->fd->exif_orientation)
 137                         {
 138                         ExifData *exif = exif_read_fd(tl->fd);
 139                         gint orientation;
 140
 141                         if (exif && exif_get_integer(exif, "Exif.Image.Orientation", &orientation))
 142                                 tl->fd->exif_orientation = orientation;
 143                         else
 144                                 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
 145                         exif_free_fd(tl->fd, exif);
 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                 if (!image_loader_start(tl->il, thumb_loader_done_cb, tl))
 167                         {
 168                         image_loader_free(tl->il);
 169                         tl->il = NULL;
 170
 171                         DEBUG_1("regeneration failure: %s", tl->fd->path);
 172                         thumb_loader_error_cb(tl->il, tl);
 173                         }
 174                 return;
 175                 }
 176
 177         /* scale ?? */
 178
 179         if (pw > tl->max_w || ph > tl->max_h)
 180                 {
 181                 gint w, h;
 182
 183                 if (((double)tl->max_w / pw) < ((double)tl->max_h / ph))
 184                         {
 185                         w = tl->max_w;
 186                         h = (double)w / pw * ph;
 187                         if (h < 1) h = 1;
 188                         }
 189                 else
 190                         {
 191                         h = tl->max_h;
 192                         w = (double)h / ph * pw;
 193                         if (w < 1) w = 1;
 194                         }
 195
 196                 if (tl->fd)
 197                         {
 198                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 199                         tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, (GdkInterpType)options->thumbnails.quality);
 200                         }
 201                 save = TRUE;
 202                 }
 203         else
 204                 {
 205                 if (tl->fd)
 206                         {
 207                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 208                         tl->fd->thumb_pixbuf = pixbuf;
 209                         gdk_pixbuf_ref(tl->fd->thumb_pixbuf);
 210                         }
 211                 save = il->shrunk;
 212                 }
 213
 214         if (rotated) gdk_pixbuf_unref(rotated);
 215
 216         /* save it ? */
 217         if (tl->cache_enable && save)
 218                 {
 219                 thumb_loader_save_thumbnail(tl, FALSE);
 220                 }
 221
 222         if (tl->func_done) tl->func_done(tl, tl->data);
 223 }
 224
 225 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
 226 {
 227         ThumbLoader *tl = data;
 228
 229         /* if at least some of the image is available, go to done_cb */
 230         if (image_loader_get_pixbuf(tl->il) != NULL)
 231                 {
 232                 thumb_loader_done_cb(il, data);
 233                 return;
 234                 }
 235
 236         DEBUG_1("thumb error: %s", tl->fd->path);
 237
 238         image_loader_free(tl->il);
 239         tl->il = NULL;
 240
 241         if (tl->func_error) tl->func_error(tl, tl->data);
 242 }
 243
 244 static gint thumb_loader_done_delay_cb(gpointer data)
 245 {
 246         ThumbLoader *tl = data;
 247
 248         tl->idle_done_id = -1;
 249
 250         if (tl->func_done) tl->func_done(tl, tl->data);
 251
 252         return FALSE;
 253 }
 254
 255 static void thumb_loader_delay_done(ThumbLoader *tl)
 256 {
 257         if (tl->idle_done_id == -1) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
 258 }
 259
 260 static void thumb_loader_setup(ThumbLoader *tl, const gchar *path)
 261 {
 262         FileData *fd = file_data_new_simple(path);
 263         image_loader_free(tl->il);
 264         tl->il = image_loader_new(fd);
 265         file_data_unref(fd);
 266
 267         if (options->thumbnails.fast)
 268                 {
 269                 /* this will speed up jpegs by up to 3x in some cases */
 270                 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
 271                 }
 272
 273         image_loader_set_error_func(tl->il, thumb_loader_error_cb, tl);
 274         if (tl->func_progress) image_loader_set_percent_func(tl->il, thumb_loader_percent_cb, tl);
 275 }
 276
 277 void thumb_loader_set_callbacks(ThumbLoader *tl,
 278                                 ThumbLoaderFunc func_done,
 279                                 ThumbLoaderFunc func_error,
 280                                 ThumbLoaderFunc func_progress,
 281                                 gpointer data)
 282 {
 283         if (!tl) return;
 284
 285         if (tl->standard_loader)
 286                 {
 287                 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
 288                                                (ThumbLoaderStdFunc) func_done,
 289                                                (ThumbLoaderStdFunc) func_error,
 290                                                (ThumbLoaderStdFunc) func_progress,
 291                                                data);
 292                 return;
 293                 }
 294
 295         tl->func_done = func_done;
 296         tl->func_error = func_error;
 297         tl->func_progress = func_progress;
 298
 299         tl->data = data;
 300 }
 301
 302 void thumb_loader_set_cache(ThumbLoader *tl, gint enable_cache, gint local, gint retry_failed)
 303 {
 304         if (!tl) return;
 305
 306         if (tl->standard_loader)
 307                 {
 308                 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
 309                 return;
 310                 }
 311
 312         tl->cache_enable = enable_cache;
 313 #if 0
 314         tl->cache_local = local;
 315         tl->cache_retry = retry_failed;
 316 #endif
 317 }
 318
 319
 320 gint thumb_loader_start(ThumbLoader *tl, FileData *fd)
 321 {
 322         gchar *cache_path = NULL;
 323
 324         if (!tl) return FALSE;
 325
 326         if (tl->standard_loader)
 327                 {
 328                 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
 329                 }
 330
 331         if (!tl->fd && !fd) return FALSE;
 332
 333         if (!tl->fd) tl->fd = file_data_ref(fd);
 334
 335         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 336         tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->max_w, tl->max_h);
 337
 338         if (tl->cache_enable)
 339                 {
 340                 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
 341
 342                 if (cache_path)
 343                         {
 344                         if (cache_time_valid(cache_path, tl->fd->path))
 345                                 {
 346                                 DEBUG_1("Found in cache:%s", tl->fd->path);
 347
 348                                 if (filesize(cache_path) == 0)
 349                                         {
 350                                         DEBUG_1("Broken image mark found:%s", cache_path);
 351                                         g_free(cache_path);
 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                 thumb_loader_setup(tl, cache_path);
 379                 g_free(cache_path);
 380                 tl->cache_hit = TRUE;
 381                 }
 382         else
 383                 {
 384                 thumb_loader_setup(tl, tl->fd->path);
 385                 }
 386
 387         if (!image_loader_start(tl->il, thumb_loader_done_cb, tl))
 388                 {
 389                 /* try from original if cache attempt */
 390                 if (tl->cache_hit)
 391                         {
 392                         tl->cache_hit = FALSE;
 393                         log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
 394
 395                         thumb_loader_setup(tl, tl->fd->path);
 396                         if (image_loader_start(tl->il, thumb_loader_done_cb, tl)) 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                 return FALSE;
 407                 }
 408
 409         return TRUE;
 410 }
 411
 412 #if 0
 413 gint thumb_loader_to_pixmap(ThumbLoader *tl, GdkPixmap **pixmap, GdkBitmap **mask)
 414 {
 415         if (!tl || !tl->pixbuf) return -1;
 416
 417         gdk_pixbuf_render_pixmap_and_mask(tl->pixbuf, pixmap, mask, 128);
 418
 419         return thumb_loader_get_space(tl);
 420 }
 421 #endif
 422
 423 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
 424 {
 425         GdkPixbuf *pixbuf;
 426
 427         if (tl && tl->standard_loader)
 428                 {
 429                 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
 430                 }
 431
 432         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 433                 {
 434                 pixbuf = tl->fd->thumb_pixbuf;
 435                 g_object_ref(pixbuf);
 436                 }
 437         else
 438                 {
 439                 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
 440                 }
 441
 442         return pixbuf;
 443 }
 444
 445 #if 0
 446 gint thumb_loader_get_space(ThumbLoader *tl)
 447 {
 448         if (!tl) return 0;
 449
 450         if (tl->pixbuf) return (tl->max_w - gdk_pixbuf_get_width(tl->pixbuf));
 451
 452         return tl->max_w;
 453 }
 454 #endif
 455
 456 ThumbLoader *thumb_loader_new(gint width, gint height)
 457 {
 458         ThumbLoader *tl;
 459
 460         if (options->thumbnails.spec_standard)
 461                 {
 462                 return (ThumbLoader *)thumb_loader_std_new(width, height);
 463                 }
 464
 465         tl = g_new0(ThumbLoader, 1);
 466         tl->standard_loader = FALSE;
 467         tl->fd = NULL;
 468         tl->cache_enable = options->thumbnails.enable_caching;
 469         tl->cache_hit = FALSE;
 470         tl->percent_done = 0.0;
 471         tl->max_w = width;
 472         tl->max_h = height;
 473
 474         tl->il = NULL;
 475
 476         tl->idle_done_id = -1;
 477
 478         return tl;
 479 }
 480
 481 void thumb_loader_free(ThumbLoader *tl)
 482 {
 483         if (!tl) return;
 484
 485         if (tl->standard_loader)
 486                 {
 487                 thumb_loader_std_free((ThumbLoaderStd *)tl);
 488                 return;
 489                 }
 490
 491         image_loader_free(tl->il);
 492         file_data_unref(tl->fd);
 493
 494         if (tl->idle_done_id != -1) g_source_remove(tl->idle_done_id);
 495
 496         g_free(tl);
 497 }
 498
 499 #if 0
 500 gint thumb_from_xpm_d(const char **data, gint max_w, gint max_h, GdkPixmap **pixmap, GdkBitmap **mask)
 501 {
 502         GdkPixbuf *pixbuf;
 503         gint w, h;
 504
 505         pixbuf = gdk_pixbuf_new_from_xpm_data(data);
 506         w = gdk_pixbuf_get_width(pixbuf);
 507         h = gdk_pixbuf_get_height(pixbuf);
 508
 509         if (pixbuf_scale_aspect(w, h, max_w, max_h, &w, &h))
 510                 {
 511                 /* scale */
 512                 GdkPixbuf *tmp;
 513
 514                 tmp = pixbuf;
 515                 pixbuf = gdk_pixbuf_scale_simple(tmp, w, h, GDK_INTERP_NEAREST);
 516                 gdk_pixbuf_unref(tmp);
 517                 }
 518
 519         gdk_pixbuf_render_pixmap_and_mask(pixbuf, pixmap, mask, 128);
 520         gdk_pixbuf_unref(pixbuf);
 521
 522         return w;
 523 }
 524 #endif
 525
 526 /*
 527  *-----------------------------------------------------------------------------
 528  * xvpics thumbnail support, read-only (private)
 529  *-----------------------------------------------------------------------------
 530  */
 531
 532 /*
 533  * xvpics code originally supplied by:
 534  * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
 535  *
 536  * Note: Code has been modified to fit the style of the other code, and to use
 537  *       a few more glib-isms.
 538  * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
 539  */
 540
 541 #define XV_BUFFER 2048
 542 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
 543 {
 544         FILE *file;
 545         gchar buffer[XV_BUFFER];
 546         guchar *data;
 547         gint width, height, depth;
 548
 549         file = fopen(filename, "rt");
 550         if (!file) return NULL;
 551
 552         fgets(buffer, XV_BUFFER, file);
 553         if (strncmp(buffer, "P7 332", 6) != 0)
 554                 {
 555                 fclose(file);
 556                 return NULL;
 557                 }
 558
 559         while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
 560
 561         if (sscanf(buffer, "%d %d %d", &width, &height, &depth) != 3)
 562                 {
 563                 fclose(file);
 564                 return NULL;
 565                 }
 566
 567         data = g_new(guchar, width * height);
 568         fread(data, 1, width * height, file);
 569
 570         fclose(file);
 571         *widthp = width;
 572         *heightp = height;
 573         return data;
 574 }
 575 #undef XV_BUFFER
 576
 577 static void free_rgb_buffer(guchar *pixels, gpointer data)
 578 {
 579         g_free(pixels);
 580 }
 581
 582 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
 583 {
 584         gint width, height;
 585         gchar *thumb_name;
 586         gchar *path;
 587         gchar *directory;
 588         gchar *name;
 589         guchar *packed_data;
 590
 591         path = path_from_utf8(thumb_filename);
 592         directory = g_path_get_dirname(path);
 593         name = g_path_get_basename(path);
 594
 595         thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
 596
 597         g_free(name);
 598         g_free(directory);
 599         g_free(path);
 600
 601         packed_data = load_xv_thumbnail(thumb_name, &width, &height);
 602         g_free(thumb_name);
 603
 604         if (packed_data)
 605                 {
 606                 guchar *rgb_data;
 607                 GdkPixbuf *pixbuf;
 608                 gint i;
 609
 610                 rgb_data = g_new(guchar, width * height * 3);
 611                 for (i = 0; i < width * height; i++)
 612                         {
 613                         rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
 614                         rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
 615                         rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
 616                         }
 617                 g_free(packed_data);
 618
 619                 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
 620                                                   width, height, 3 * width, free_rgb_buffer, NULL);
 621
 622                 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
 623                         {
 624                         /* scale */
 625                         GdkPixbuf *tmp;
 626
 627                         tmp = pixbuf;
 628                         pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
 629                         gdk_pixbuf_unref(tmp);
 630                         }
 631
 632                 return pixbuf;
 633                 }
 634
 635         return NULL;
 636 }