src/thumb.cc

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include "thumb.h"
  23
  24 #include <config.h>
  25
  26 #include "cache.h"
  27 #include "debug.h"
  28 #include "exif.h"
  29 #include "filedata.h"
  30 #include "image-load.h"
  31 #include "intl.h"
  32 #include "metadata.h"
  33 #include "options.h"
  34 #include "pixbuf-util.h"
  35 #include "thumb-standard.h"
  36 #include "ui-fileops.h"
  37
  38 #include <utime.h>
  39
  40
  41 static void thumb_loader_error_cb(ImageLoader *il, gpointer data);
  42 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd);
  43
  44 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h);
  45
  46
  47 /*
  48  *-----------------------------------------------------------------------------
  49  * thumbnail routines: creation, caching, and maintenance (public)
  50  *-----------------------------------------------------------------------------
  51  */
  52
  53 /* Save thumbnail to disk
  54  * or just mark failed thumbnail with 0 byte file (mark_failure = TRUE) */
  55 static gboolean thumb_loader_save_thumbnail(ThumbLoader *tl, gboolean mark_failure)
  56 {
  57         gchar *cache_dir;
  58         gboolean success = FALSE;
  59         mode_t mode = 0755;
  60
  61         if (!tl || !tl->fd) return FALSE;
  62         if (!mark_failure && !tl->fd->thumb_pixbuf) return FALSE;
  63
  64         cache_dir = cache_get_location(CACHE_TYPE_THUMB, tl->fd->path, FALSE, &mode);
  65
  66         if (recursive_mkdir_if_not_exists(cache_dir, mode))
  67                 {
  68                 gchar *cache_path;
  69                 gchar *pathl;
  70                 gchar *name = g_strconcat(filename_from_path(tl->fd->path), GQ_CACHE_EXT_THUMB, NULL);
  71
  72                 cache_path = g_build_filename(cache_dir, name, NULL);
  73                 g_free(name);
  74
  75                 pathl = path_from_utf8(cache_path);
  76
  77                 if (mark_failure)
  78                         {
  79                         FILE *f = fopen(pathl, "w"); ;
  80
  81                         DEBUG_1("Marking thumb failure: %s", cache_path);
  82                         if (f)
  83                                 {
  84                                 fclose(f);
  85                                 success = TRUE;
  86                                 }
  87                         }
  88                 else
  89                         {
  90                         DEBUG_1("Saving thumb: %s", cache_path);
  91                         success = pixbuf_to_file_as_png(tl->fd->thumb_pixbuf, pathl);
  92                         }
  93
  94                 if (success)
  95                         {
  96                         struct utimbuf ut;
  97                         /* set thumb time to that of source file */
  98
  99                         ut.actime = ut.modtime = filetime(tl->fd->path);
 100                         if (ut.modtime > 0)
 101                                 {
 102                                 utime(pathl, &ut);
 103                                 }
 104                         }
 105                 else
 106                         {
 107                         DEBUG_1("Saving failed: %s", pathl);
 108                         }
 109
 110                 g_free(pathl);
 111                 g_free(cache_path);
 112                 }
 113
 114         g_free(cache_dir);
 115
 116         return success;
 117 }
 118
 119 static void thumb_loader_percent_cb(ImageLoader *, gdouble percent, gpointer data)
 120 {
 121         auto tl = static_cast<ThumbLoader *>(data);
 122
 123         tl->percent_done = percent;
 124
 125         if (tl->func_progress) tl->func_progress(tl, tl->data);
 126 }
 127
 128 static void thumb_loader_set_fallback(ThumbLoader *tl)
 129 {
 130         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 131         tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->max_w, tl->max_h);
 132 }
 133
 134 static void thumb_loader_done_cb(ImageLoader *il, gpointer data)
 135 {
 136         auto tl = static_cast<ThumbLoader *>(data);
 137         GdkPixbuf *pixbuf;
 138         gint pw;
 139         gint ph;
 140         gint save;
 141         GdkPixbuf *rotated = nullptr;
 142
 143         DEBUG_1("thumb done: %s", tl->fd->path);
 144
 145         pixbuf = image_loader_get_pixbuf(tl->il);
 146         if (!pixbuf)
 147                 {
 148                 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
 149                 thumb_loader_error_cb(tl->il, tl);
 150                 return;
 151                 }
 152
 153         if(!tl->cache_hit)
 154                 {
 155                         // apply color correction, if required
 156                         thumb_loader_std_calibrate_pixbuf(tl->fd, pixbuf);
 157                 }
 158
 159         if (!tl->cache_hit && options->image.exif_rotate_enable)
 160                 {
 161                 if (!tl->fd->exif_orientation)
 162                         {
 163                         if (g_strcmp0(il->fd->format_name, "heif") != 0)
 164                                 {
 165                                 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
 166                                 }
 167                         else
 168                                 {
 169                                 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
 170                                 }
 171                         }
 172
 173                 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
 174                         {
 175                         rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
 176                         pixbuf = rotated;
 177                         }
 178                 }
 179
 180         pw = gdk_pixbuf_get_width(pixbuf);
 181         ph = gdk_pixbuf_get_height(pixbuf);
 182
 183         if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
 184                 {
 185                 /* requested thumbnail size may have changed, load original */
 186                 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
 187                 tl->cache_hit = FALSE;
 188
 189                 thumb_loader_setup(tl, tl->fd);
 190
 191                 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 192
 193                 if (!image_loader_start(tl->il))
 194                         {
 195                         image_loader_free(tl->il);
 196                         tl->il = nullptr;
 197
 198                         DEBUG_1("regeneration failure: %s", tl->fd->path);
 199                         thumb_loader_error_cb(tl->il, tl);
 200                         }
 201                 return;
 202                 }
 203
 204         /* scale ?? */
 205
 206         if (pw > tl->max_w || ph > tl->max_h)
 207                 {
 208                 gint w;
 209                 gint h;
 210
 211                 if ((static_cast<gdouble>(tl->max_w) / pw) < (static_cast<gdouble>(tl->max_h) / ph))
 212                         {
 213                         w = tl->max_w;
 214                         h = static_cast<gdouble>(w) / pw * ph;
 215                         if (h < 1) h = 1;
 216                         }
 217                 else
 218                         {
 219                         h = tl->max_h;
 220                         w = static_cast<gdouble>(h) / ph * pw;
 221                         if (w < 1) w = 1;
 222                         }
 223
 224                 if (tl->fd)
 225                         {
 226                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 227                         tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, static_cast<GdkInterpType>(options->thumbnails.quality));
 228                         }
 229                 save = TRUE;
 230                 }
 231         else
 232                 {
 233                 if (tl->fd)
 234                         {
 235                         if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 236                         tl->fd->thumb_pixbuf = pixbuf;
 237
 238                         g_object_ref(tl->fd->thumb_pixbuf);
 239                         }
 240                 save = image_loader_get_shrunk(il);
 241                 }
 242
 243         if (rotated) g_object_unref(rotated);
 244
 245         /* save it ? */
 246         if (tl->cache_enable && save)
 247                 {
 248                 thumb_loader_save_thumbnail(tl, FALSE);
 249                 }
 250
 251         if (tl->func_done) tl->func_done(tl, tl->data);
 252 }
 253
 254 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
 255 {
 256         auto tl = static_cast<ThumbLoader *>(data);
 257
 258         /* if at least some of the image is available, go to done_cb */
 259         if (image_loader_get_pixbuf(tl->il) != nullptr)
 260                 {
 261                 thumb_loader_done_cb(il, data);
 262                 return;
 263                 }
 264
 265         DEBUG_1("thumb error: %s", tl->fd->path);
 266
 267         image_loader_free(tl->il);
 268         tl->il = nullptr;
 269
 270         thumb_loader_set_fallback(tl);
 271
 272         if (tl->func_error) tl->func_error(tl, tl->data);
 273 }
 274
 275 static gboolean thumb_loader_done_delay_cb(gpointer data)
 276 {
 277         auto tl = static_cast<ThumbLoader *>(data);
 278
 279         tl->idle_done_id = 0;
 280
 281         if (tl->func_done) tl->func_done(tl, tl->data);
 282
 283         return G_SOURCE_REMOVE;
 284 }
 285
 286 static void thumb_loader_delay_done(ThumbLoader *tl)
 287 {
 288         if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
 289 }
 290
 291 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
 292 {
 293         image_loader_free(tl->il);
 294         tl->il = image_loader_new(fd);
 295         image_loader_set_priority(tl->il, G_PRIORITY_LOW);
 296
 297         /* this will speed up jpegs by up to 3x in some cases */
 298         image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
 299
 300         g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
 301         if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
 302 }
 303
 304 void thumb_loader_set_callbacks(ThumbLoader *tl,
 305                                 ThumbLoader::Func func_done,
 306                                 ThumbLoader::Func func_error,
 307                                 ThumbLoader::Func func_progress,
 308                                 gpointer data)
 309 {
 310         if (!tl) return;
 311
 312         if (tl->standard_loader)
 313                 {
 314                 thumb_loader_std_set_callbacks(reinterpret_cast<ThumbLoaderStd *>(tl),
 315                                                reinterpret_cast<ThumbLoaderStd::Func>(func_done),
 316                                                reinterpret_cast<ThumbLoaderStd::Func>(func_error),
 317                                                reinterpret_cast<ThumbLoaderStd::Func>(func_progress),
 318                                                data);
 319                 return;
 320                 }
 321
 322         tl->func_done = func_done;
 323         tl->func_error = func_error;
 324         tl->func_progress = func_progress;
 325
 326         tl->data = data;
 327 }
 328
 329 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
 330 {
 331         if (!tl) return;
 332
 333         if (tl->standard_loader)
 334                 {
 335                 thumb_loader_std_set_cache(reinterpret_cast<ThumbLoaderStd *>(tl), enable_cache, local, retry_failed);
 336                 return;
 337                 }
 338
 339         tl->cache_enable = enable_cache;
 340 }
 341
 342
 343 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
 344 {
 345         gchar *cache_path = nullptr;
 346
 347         if (!tl) return FALSE;
 348
 349         if (tl->standard_loader)
 350                 {
 351                 return thumb_loader_std_start(reinterpret_cast<ThumbLoaderStd *>(tl), fd);
 352                 }
 353
 354         if (!tl->fd && !fd) return FALSE;
 355
 356         if (!tl->fd) tl->fd = file_data_ref(fd);
 357
 358         if (tl->fd->format_class != FORMAT_CLASS_IMAGE && tl->fd->format_class != FORMAT_CLASS_RAWIMAGE && tl->fd->format_class != FORMAT_CLASS_COLLECTION && tl->fd->format_class != FORMAT_CLASS_VIDEO && tl->fd->format_class != FORMAT_CLASS_DOCUMENT && !options->file_filter.disable)
 359                 {
 360                 thumb_loader_set_fallback(tl);
 361                 return FALSE;
 362                 }
 363
 364         if (tl->cache_enable)
 365                 {
 366                 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
 367
 368                 if (cache_path)
 369                         {
 370                         if (cache_time_valid(cache_path, tl->fd->path))
 371                                 {
 372                                 DEBUG_1("Found in cache:%s", tl->fd->path);
 373
 374                                 if (filesize(cache_path) == 0)
 375                                         {
 376                                         DEBUG_1("Broken image mark found:%s", cache_path);
 377                                         g_free(cache_path);
 378                                         thumb_loader_set_fallback(tl);
 379                                         return FALSE;
 380                                         }
 381
 382                                 DEBUG_1("Cache location:%s", cache_path);
 383                                 }
 384                         else
 385                                 {
 386                                 g_free(cache_path);
 387                                 cache_path = nullptr;
 388                                 }
 389                         }
 390                 }
 391
 392         if (!cache_path && options->thumbnails.use_xvpics)
 393                 {
 394                 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
 395                 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
 396                 if (tl->fd->thumb_pixbuf)
 397                         {
 398                         thumb_loader_delay_done(tl);
 399                         return TRUE;
 400                         }
 401                 }
 402
 403         if (cache_path)
 404                 {
 405                 FileData *fd = file_data_new_no_grouping(cache_path);
 406                 thumb_loader_setup(tl, fd);
 407                 file_data_unref(fd);
 408                 g_free(cache_path);
 409                 tl->cache_hit = TRUE;
 410                 }
 411         else
 412                 {
 413                 thumb_loader_setup(tl, tl->fd);
 414                 }
 415
 416         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 417         if (!image_loader_start(tl->il))
 418                 {
 419                 /* try from original if cache attempt */
 420                 if (tl->cache_hit)
 421                         {
 422                         tl->cache_hit = FALSE;
 423                         log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
 424
 425                         thumb_loader_setup(tl, tl->fd);
 426                         g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
 427                         if (image_loader_start(tl->il)) return TRUE;
 428                         }
 429                 /* mark failed thumbnail in cache with 0 byte file */
 430                 if (tl->cache_enable)
 431                         {
 432                         thumb_loader_save_thumbnail(tl, TRUE);
 433                         }
 434
 435                 image_loader_free(tl->il);
 436                 tl->il = nullptr;
 437                 thumb_loader_set_fallback(tl);
 438                 return FALSE;
 439                 }
 440
 441         return TRUE;
 442 }
 443
 444 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
 445 {
 446         GdkPixbuf *pixbuf;
 447
 448         if (tl && tl->standard_loader)
 449                 {
 450                 return thumb_loader_std_get_pixbuf(reinterpret_cast<ThumbLoaderStd *>(tl));
 451                 }
 452
 453         if (tl && tl->fd && tl->fd->thumb_pixbuf)
 454                 {
 455                 pixbuf = tl->fd->thumb_pixbuf;
 456                 g_object_ref(pixbuf);
 457                 }
 458         else
 459                 {
 460                 pixbuf = pixbuf_fallback(nullptr, tl->max_w, tl->max_h);
 461                 }
 462
 463         return pixbuf;
 464 }
 465
 466 ThumbLoader *thumb_loader_new(gint width, gint height)
 467 {
 468         ThumbLoader *tl;
 469
 470         /* non-std thumb loader is more effective for configurations with disabled caching
 471            because it loads the thumbnails at the required size. loader_std loads
 472            the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
 473            and then performs one additional scaling */
 474         if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
 475                 {
 476                 return reinterpret_cast<ThumbLoader *>(thumb_loader_std_new(width, height));
 477                 }
 478
 479         tl = g_new0(ThumbLoader, 1);
 480
 481         tl->cache_enable = options->thumbnails.enable_caching;
 482         tl->percent_done = 0.0;
 483         tl->max_w = width;
 484         tl->max_h = height;
 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(reinterpret_cast<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) g_source_remove(tl->idle_done_id);
 503
 504         g_free(tl);
 505 }
 506
 507 /* release thumb_pixbuf on file change - this forces reload. */
 508 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer)
 509 {
 510         if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
 511                 {
 512                 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
 513                 g_object_unref(fd->thumb_pixbuf);
 514                 fd->thumb_pixbuf = nullptr;
 515                 }
 516 }
 517
 518
 519 /*
 520  *-----------------------------------------------------------------------------
 521  * xvpics thumbnail support, read-only (private)
 522  *-----------------------------------------------------------------------------
 523  */
 524
 525 /*
 526  * xvpics code originally supplied by:
 527  * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
 528  *
 529  * Note: Code has been modified to fit the style of the other code, and to use
 530  *       a few more glib-isms.
 531  * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dying a death here.
 532  */
 533
 534 #define XV_BUFFER 2048
 535 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
 536 {
 537         FILE *file;
 538         gchar buffer[XV_BUFFER];
 539         guchar *data = nullptr;
 540
 541         file = fopen(filename, "rt");
 542         if (!file) return nullptr;
 543
 544         if (fgets(buffer, XV_BUFFER, file) != nullptr
 545             && strncmp(buffer, "P7 332", 6) == 0)
 546                 {
 547                 gint width;
 548                 gint height;
 549                 gint depth;
 550
 551                 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
 552
 553                 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
 554                         {
 555                         gsize size = width * height;
 556
 557                         data = g_new(guchar, size);
 558                         if (data && fread(data, 1, size, file) == size)
 559                                 {
 560                                 *widthp = width;
 561                                 *heightp = height;
 562                                 }
 563                         }
 564                 }
 565
 566         fclose(file);
 567         return data;
 568 }
 569 #undef XV_BUFFER
 570
 571 static void free_rgb_buffer(guchar *pixels, gpointer)
 572 {
 573         g_free(pixels);
 574 }
 575
 576 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
 577 {
 578         gint width;
 579         gint height;
 580         gchar *thumb_name;
 581         gchar *path;
 582         gchar *directory;
 583         gchar *name;
 584         guchar *packed_data;
 585
 586         path = path_from_utf8(thumb_filename);
 587         directory = g_path_get_dirname(path);
 588         name = g_path_get_basename(path);
 589
 590         thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
 591
 592         g_free(name);
 593         g_free(directory);
 594         g_free(path);
 595
 596         packed_data = load_xv_thumbnail(thumb_name, &width, &height);
 597         g_free(thumb_name);
 598
 599         if (packed_data)
 600                 {
 601                 guchar *rgb_data;
 602                 GdkPixbuf *pixbuf;
 603                 gint i;
 604
 605                 rgb_data = g_new(guchar, width * height * 3);
 606                 for (i = 0; i < width * height; i++)
 607                         {
 608                         rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
 609                         rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
 610                         rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
 611                         }
 612                 g_free(packed_data);
 613
 614                 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
 615                                                   width, height, 3 * width, free_rgb_buffer, nullptr);
 616
 617                 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
 618                         {
 619                         /* scale */
 620                         GdkPixbuf *tmp;
 621
 622                         tmp = pixbuf;
 623                         pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
 624                         g_object_unref(tmp);
 625                         }
 626
 627                 return pixbuf;
 628                 }
 629
 630         return nullptr;
 631 }
 632 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */