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