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