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