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