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