Let image loader backend decide how to process image buffer
[geeqie.git] / src / exif-common.cc
1 /*
2  * Copyright (C) 2006 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 #include <config.h>
21
22 #ifdef __linux__
23 #define _XOPEN_SOURCE
24 #endif
25
26 #include <sys/stat.h>
27
28 #include <cmath>
29 #include <cstdlib>
30 #include <cstring>
31 #include <ctime>
32
33 #include <glib.h>
34
35 #if HAVE_LCMS
36 /*** color support enabled ***/
37 #  if HAVE_LCMS2
38 #    include <lcms2.h>
39 #  else
40 #    include <lcms.h>
41 #  endif
42 #endif
43
44 #include "cache.h"
45 #include "debug.h"
46 #include "exif.h"
47 #include "filecache.h"
48 #include "filedata.h"
49 #include "glua.h"
50 #include "intl.h"
51 #include "jpeg-parser.h"
52 #include "main-defines.h"
53 #include "misc.h"
54 #include "typedefs.h"
55 #include "ui-fileops.h"
56 #include "zonedetect.h"
57
58 struct ExifData;
59 struct ExifItem;
60 struct FileCacheData;
61 struct ZoneDetect;
62
63
64 static gdouble exif_rational_to_double(ExifRational *r, gint sign)
65 {
66         if (!r || r->den == 0.0) return 0.0;
67
68         if (sign) return static_cast<gdouble>(static_cast<gint>(r->num)) / static_cast<gdouble>(static_cast<gint>(r->den));
69         return static_cast<gdouble>(r->num) / r->den;
70 }
71
72 static gdouble exif_get_rational_as_double(ExifData *exif, const gchar *key)
73 {
74         ExifRational *r;
75         gint sign;
76
77         r = exif_get_rational(exif, key, &sign);
78         return exif_rational_to_double(r, sign);
79 }
80
81 static GString *append_comma_text(GString *string, const gchar *text)
82 {
83         string = g_string_append(string, ", ");
84         string = g_string_append(string, text);
85
86         return string;
87 }
88
89 static gchar *remove_common_prefix(gchar *s, gchar *t)
90 {
91         gint i;
92
93         if (!s || !t) return t;
94
95         for (i = 0; s[i] && t[i] && s[i] == t[i]; i++)
96                 ;
97         if (!i)
98                 return t;
99         if (s[i-1] == ' ' || !s[i])
100                 {
101                 while (t[i] == ' ')
102                         i++;
103                 return t + i;
104                 }
105         return s;
106 }
107
108 static gdouble get_crop_factor(ExifData *exif)
109 {
110         gdouble res_unit_tbl[] = {0.0, 25.4, 25.4, 10.0, 1.0, 0.001 };
111         gdouble xres = exif_get_rational_as_double(exif, "Exif.Photo.FocalPlaneXResolution");
112         gdouble yres = exif_get_rational_as_double(exif, "Exif.Photo.FocalPlaneYResolution");
113         gint res_unit;
114         gint w;
115         gint h;
116         gdouble xsize;
117         gdouble ysize;
118         gdouble size;
119         gdouble ratio;
120
121         if (xres == 0.0 || yres == 0.0) return 0.0;
122
123         if (!exif_get_integer(exif, "Exif.Photo.FocalPlaneResolutionUnit", &res_unit)) return 0.0;
124         if (res_unit < 1 || res_unit > 5) return 0.0;
125
126         if (!exif_get_integer(exif, "Exif.Photo.PixelXDimension", &w)) return 0.0;
127         if (!exif_get_integer(exif, "Exif.Photo.PixelYDimension", &h)) return 0.0;
128
129         xsize = w * res_unit_tbl[res_unit] / xres;
130         ysize = h * res_unit_tbl[res_unit] / yres;
131
132         ratio = xsize / ysize;
133
134         if (ratio < 0.5 || ratio > 2.0) return 0.0; /* reasonable ratio */
135
136         size = hypot(xsize, ysize);
137
138         if (size < 1.0 || size > 100.0) return 0.0; /* reasonable sensor size in mm */
139
140         return hypot(36, 24) / size;
141 }
142
143 static gboolean remove_suffix(gchar *str, const gchar *suffix, gint suffix_len)
144 {
145         gint str_len = strlen(str);
146
147         if (suffix_len < 0) suffix_len = strlen(suffix);
148         if (str_len < suffix_len) return FALSE;
149
150         if (strcmp(str + str_len - suffix_len, suffix) != 0) return FALSE;
151         str[str_len - suffix_len] = '\0';
152
153         return TRUE;
154 }
155
156 static gchar *exif_build_formatted_Camera(ExifData *exif)
157 {
158         gchar *text;
159         gchar *make = exif_get_data_as_text(exif, "Exif.Image.Make");
160         gchar *model = exif_get_data_as_text(exif, "Exif.Image.Model");
161         gchar *software = exif_get_data_as_text(exif, "Exif.Image.Software");
162         gchar *model2;
163         gchar *software2;
164
165         if (make)
166                 {
167                 g_strstrip(make);
168
169                 if (remove_suffix(make, " CORPORATION", 12)) { /* Nikon */ }
170                 else if (remove_suffix(make, " Corporation", 12)) { /* Pentax */ }
171                 else if (remove_suffix(make, " OPTICAL CO.,LTD", 16)) { /* OLYMPUS */ };
172                 }
173
174         if (model)
175                 g_strstrip(model);
176
177         if (software)
178                 {
179                 gint i;
180                 gint j;
181
182                 g_strstrip(software);
183
184                 /* remove superfluous spaces (pentax K100D) */
185                 for (i = 0, j = 0; software[i]; i++, j++)
186                         {
187                         if (software[i] == ' ' && software[i + 1] == ' ')
188                                 i++;
189                         if (i != j) software[j] = software[i];
190                         }
191                 software[j] = '\0';
192                 }
193
194         model2 = remove_common_prefix(make, model);
195         software2 = remove_common_prefix(model2, software);
196
197         text = g_strdup_printf("%s%s%s%s%s%s", (make) ? make : "", (make && model2) ? " " : "",
198                                                (model2) ? model2 : "",
199                                                (software2 && (make || model2)) ? " (" : "",
200                                                (software2) ? software2 : "",
201                                                (software2 && (make || model2)) ? ")" : "");
202
203         g_free(make);
204         g_free(model);
205         g_free(software);
206         return text;
207 }
208
209 static gchar *exif_build_formatted_DateTime(ExifData *exif)
210 {
211         gchar *text = exif_get_data_as_text(exif, "Exif.Photo.DateTimeOriginal");
212         gchar *subsec = nullptr;
213         gchar buf[128];
214         gchar *tmp;
215         gint buflen;
216         struct tm tm;
217         GError *error = nullptr;
218
219         if (text)
220                 {
221                 subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTimeOriginal");
222                 }
223         else
224                 {
225                 text = exif_get_data_as_text(exif, "Exif.Image.DateTime");
226                 if (text) subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTime");
227                 }
228
229         /* Convert the stuff into a tm struct */
230         memset(&tm, 0, sizeof(tm)); /* Uh, strptime could let garbage in tm! */
231         if (text && strptime(text, "%Y:%m:%d %H:%M:%S", &tm))
232                 {
233                 buflen = strftime(buf, sizeof(buf), "%x %X", &tm);
234                 if (buflen > 0)
235                         {
236                         tmp = g_locale_to_utf8(buf, buflen, nullptr, nullptr, &error);
237                         if (error)
238                                 {
239                                 log_printf("Error converting locale strftime to UTF-8: %s\n", error->message);
240                                 g_error_free(error);
241                                 }
242                         else
243                                 {
244                                 g_free(text);
245                                 text = g_strdup(tmp);
246                                 }
247                         }
248                 }
249
250         if (subsec)
251                 {
252                 tmp = text;
253                 text = g_strconcat(tmp, ".", subsec, NULL);
254                 g_free(tmp);
255                 g_free(subsec);
256                 }
257         return text;
258 }
259
260 static gchar *exif_build_formatted_DateTimeDigitized(ExifData *exif)
261 {
262         gchar *text = exif_get_data_as_text(exif, "Exif.Photo.DateTimeDigitized");
263         gchar *subsec = nullptr;
264         gchar buf[128];
265         gchar *tmp;
266         gint buflen;
267         struct tm tm;
268         GError *error = nullptr;
269
270         if (text)
271                 {
272                 subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTimeDigitized");
273                 }
274         else
275                 {
276                 text = exif_get_data_as_text(exif, "Exif.Image.DateTime");
277                 if (text) subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTime");
278                 }
279
280         /* Convert the stuff into a tm struct */
281         memset(&tm, 0, sizeof(tm)); /* Uh, strptime could let garbage in tm! */
282         if (text && strptime(text, "%Y:%m:%d %H:%M:%S", &tm))
283                 {
284                 buflen = strftime(buf, sizeof(buf), "%x %X", &tm);
285                 if (buflen > 0)
286                         {
287                         tmp = g_locale_to_utf8(buf, buflen, nullptr, nullptr, &error);
288                         if (error)
289                                 {
290                                 log_printf("Error converting locale strftime to UTF-8: %s\n", error->message);
291                                 g_error_free(error);
292                                 }
293                         else
294                                 {
295                                 g_free(text);
296                                 text = g_strdup(tmp);
297                                 }
298                         }
299                 }
300
301         if (subsec)
302                 {
303                 tmp = text;
304                 text = g_strconcat(tmp, ".", subsec, NULL);
305                 g_free(tmp);
306                 g_free(subsec);
307                 }
308         return text;
309 }
310
311 static gchar *exif_build_formatted_ShutterSpeed(ExifData *exif)
312 {
313         ExifRational *r;
314
315         r = exif_get_rational(exif, "Exif.Photo.ExposureTime", nullptr);
316         if (r && r->num && r->den)
317                 {
318                 gdouble n = static_cast<gdouble>(r->den) / static_cast<gdouble>(r->num);
319                 return g_strdup_printf("%s%.0fs", n > 1.0 ? "1/" : "",
320                                                   n > 1.0 ? n : 1.0 / n);
321                 }
322         r = exif_get_rational(exif, "Exif.Photo.ShutterSpeedValue", nullptr);
323         if (r && r->num  && r->den)
324                 {
325                 gdouble n = pow(2.0, exif_rational_to_double(r, TRUE));
326
327                 /* Correct exposure time to avoid values like 1/91s (seen on Minolta DImage 7) */
328                 if (n > 1.0 && static_cast<gint>(n) - (static_cast<gint>(n/10))*10 == 1) n--;
329
330                 return g_strdup_printf("%s%.0fs", n > 1.0 ? "1/" : "",
331                                                   n > 1.0 ? floor(n) : 1.0 / n);
332                 }
333         return nullptr;
334 }
335
336 static gchar *exif_build_formatted_Aperture(ExifData *exif)
337 {
338         gdouble n;
339
340         n = exif_get_rational_as_double(exif, "Exif.Photo.FNumber");
341         if (n == 0.0) n = exif_get_rational_as_double(exif, "Exif.Photo.ApertureValue");
342         if (n == 0.0) return nullptr;
343
344         return g_strdup_printf("f/%.1f", n);
345 }
346
347 static gchar *exif_build_formatted_ExposureBias(ExifData *exif)
348 {
349         ExifRational *r;
350         gint sign;
351         gdouble n;
352
353         r = exif_get_rational(exif, "Exif.Photo.ExposureBiasValue", &sign);
354         if (!r) return nullptr;
355
356         n = exif_rational_to_double(r, sign);
357         return g_strdup_printf("%+.1f", n);
358 }
359
360 static gchar *exif_build_formatted_FocalLength(ExifData *exif)
361 {
362         gdouble n;
363
364         n = exif_get_rational_as_double(exif, "Exif.Photo.FocalLength");
365         if (n == 0.0) return nullptr;
366         return g_strdup_printf("%.0f mm", n);
367 }
368
369 static gchar *exif_build_formatted_FocalLength35mmFilm(ExifData *exif)
370 {
371         gint n;
372         gdouble f;
373         gdouble c;
374
375         if (exif_get_integer(exif, "Exif.Photo.FocalLengthIn35mmFilm", &n) && n != 0)
376                 {
377                 return g_strdup_printf("%d mm", n);
378                 }
379
380         f = exif_get_rational_as_double(exif, "Exif.Photo.FocalLength");
381         if (f == 0.0) return nullptr;
382
383         c = get_crop_factor(exif);
384         if (c == 0.0) return nullptr;
385
386         return g_strdup_printf("%.0f mm", f * c);
387 }
388
389 static gchar *exif_build_formatted_ISOSpeedRating(ExifData *exif)
390 {
391         gchar *text;
392
393         text = exif_get_data_as_text(exif, "Exif.Photo.ISOSpeedRatings");
394         /* old canon may set this instead */
395         if (!text) text = exif_get_data_as_text(exif, "Exif.CanonSi.ISOSpeed");
396         /* kodak may set this instead */
397         if (!text) text = exif_get_data_as_text(exif, "Exif.Photo.ExposureIndex");
398         return text;
399 }
400
401 static gchar *exif_build_formatted_SubjectDistance(ExifData *exif)
402 {
403         ExifRational *r;
404         gint sign;
405         gdouble n;
406
407         r = exif_get_rational(exif, "Exif.Photo.SubjectDistance", &sign);
408         if (!r) return nullptr;
409
410         if (static_cast<glong>(r->num) == static_cast<glong>(0xffffffff)) return g_strdup(_("infinity"));
411         if (static_cast<glong>(r->num) == 0) return g_strdup(_("unknown"));
412
413         n = exif_rational_to_double(r, sign);
414         if (n == 0.0) return _("unknown");
415         return g_strdup_printf("%.3f m", n);
416 }
417
418 static gchar *exif_build_formatted_Flash(ExifData *exif)
419 {
420         /* grr, flash is a bitmask... */
421         GString *string;
422         gint n;
423         gint v;
424
425         if (!exif_get_integer(exif, "Exif.Photo.Flash", &n)) return nullptr;
426
427         /* Exif 2.1 only defines first 3 bits */
428         if (n <= 0x07) return exif_get_data_as_text(exif, "Exif.Photo.Flash");
429
430         /* must be Exif 2.2 */
431         string = g_string_new("");
432
433         /* flash fired (bit 0) */
434         string = g_string_append(string, (n & 0x01) ? _("yes") : _("no"));
435
436         /* flash mode (bits 3, 4) */
437         v = (n >> 3) & 0x03;
438         if (v) string = append_comma_text(string, _("mode:"));
439         switch (v)
440                 {
441                 case 1:
442                         string = g_string_append(string, _("on"));
443                         break;
444                 case 2:
445                         string = g_string_append(string, _("off"));
446                         break;
447                 case 3:
448                         string = g_string_append(string, _("auto"));
449                         break;
450                 }
451
452         /* return light (bits 1, 2) */
453         v = (n >> 1) & 0x03;
454         if (v == 2) string = append_comma_text(string, _("not detected by strobe"));
455         if (v == 3) string = append_comma_text(string, _("detected by strobe"));
456
457         /* we ignore flash function (bit 5) */
458
459         /* red-eye (bit 6) */
460         if ((n >> 5) & 0x01) string = append_comma_text(string, _("red-eye reduction"));
461
462         return g_string_free(string, FALSE);
463 }
464
465 static gchar *exif_build_formatted_Resolution(ExifData *exif)
466 {
467         ExifRational *rx;
468         ExifRational *ry;
469         gchar *units;
470         gchar *text;
471
472         rx = exif_get_rational(exif, "Exif.Image.XResolution", nullptr);
473         ry = exif_get_rational(exif, "Exif.Image.YResolution", nullptr);
474         if (!rx || !ry) return nullptr;
475
476         units = exif_get_data_as_text(exif, "Exif.Image.ResolutionUnit");
477         text = g_strdup_printf("%0.f x %0.f (%s/%s)", rx->den ? static_cast<gdouble>(rx->num) / rx->den : 1.0,
478                                                       ry->den ? static_cast<gdouble>(ry->num) / ry->den : 1.0,
479                                                       _("dot"), (units) ? units : _("unknown"));
480
481         g_free(units);
482         return text;
483 }
484
485 static gchar *exif_build_formatted_ColorProfile(ExifData *exif)
486 {
487 #if HAVE_LCMS2
488         cmsUInt8Number profileID[17];
489 #endif
490         const gchar *name = "";
491         const gchar *source = "";
492         guchar *profile_data;
493         guint profile_len;
494
495         profile_data = exif_get_color_profile(exif, &profile_len);
496         if (!profile_data)
497                 {
498                 gint cs;
499                 gchar *interop_index;
500
501                 /* ColorSpace == 1 specifies sRGB per EXIF 2.2 */
502                 if (!exif_get_integer(exif, "Exif.Photo.ColorSpace", &cs)) cs = 0;
503                 interop_index = exif_get_data_as_text(exif, "Exif.Iop.InteroperabilityIndex");
504
505                 if (cs == 1)
506                         {
507                         name = _("sRGB");
508                         source = "ColorSpace";
509                         }
510                 else if (cs == 2 || (interop_index && !strcmp(interop_index, "R03")))
511                         {
512                         name = _("AdobeRGB");
513                         source = (cs == 2) ? "ColorSpace" : "Iop";
514                         }
515
516                 g_free(interop_index);
517                 }
518         else
519                 {
520                 source = _("embedded");
521 #if HAVE_LCMS
522
523                         {
524                         cmsHPROFILE profile;
525
526                         profile = cmsOpenProfileFromMem(profile_data, profile_len);
527                         if (profile)
528                                 {
529 #if HAVE_LCMS2
530                                 profileID[16] = '\0';
531                                 cmsGetHeaderProfileID(profile, profileID);
532                                 name = reinterpret_cast<gchar *>(profileID);
533 #else
534                                 name = (gchar *) cmsTakeProductName(profile);
535 #endif
536                                 cmsCloseProfile(profile);
537                                 }
538                         g_free(profile_data);
539                         }
540 #endif
541                 }
542         if (name[0] == 0 && source[0] == 0) return nullptr;
543         return g_strdup_printf("%s (%s)", name, source);
544 }
545
546 static gchar *exif_build_formatted_GPSPosition(ExifData *exif)
547 {
548         GString *string;
549         gchar *ref;
550         ExifRational *value;
551         ExifItem *item;
552         guint i;
553         gdouble p;
554         gdouble p3;
555         gulong p1;
556         gulong p2;
557
558         string = g_string_new("");
559
560         item = exif_get_item(exif, "Exif.GPSInfo.GPSLatitude");
561         ref = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLatitudeRef");
562         if (item && ref)
563                 {
564                 p = 0;
565                 for (i = 0; i < exif_item_get_elements(item); i++)
566                         {
567                         value = exif_item_get_rational(item, nullptr, i);
568                         if (value && value->num && value->den)
569                                 p += static_cast<gdouble>(value->num) / static_cast<gdouble>(value->den) / pow(60.0, static_cast<gdouble>(i));
570                         }
571                 p1 = static_cast<gint>(p);
572                 p2 = static_cast<gint>((p - p1)*60);
573                 p3 = ((p - p1)*60 - p2)*60;
574
575                 g_string_append_printf(string, "%0lu° %0lu' %0.2f\" %.1s", p1, p2, p3, ref);
576                 } // if (item && ref)
577
578         item = exif_get_item(exif, "Exif.GPSInfo.GPSLongitude");
579         ref = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLongitudeRef");
580         if (item && ref)
581                 {
582                 p = 0;
583                 for (i = 0; i < exif_item_get_elements(item); i++)
584                         {
585                         value = exif_item_get_rational(item, nullptr, i);
586                         if (value && value->num && value->den)
587                         p += static_cast<gdouble>(value->num) / static_cast<gdouble>(value->den) / pow(60.0, static_cast<gdouble>(i));
588                         }
589                 p1 = static_cast<gint>(p);
590                 p2 = static_cast<gint>((p - p1)*60);
591                 p3 = ((p - p1)*60 - p2)*60;
592
593                 g_string_append_printf(string, ", %0lu° %0lu' %0.2f\" %.1s", p1, p2, p3, ref);
594                 } // if (item && ref)
595
596         return g_string_free(string, FALSE);
597 } // static gchar *exif_build_forma...
598
599 static gchar *exif_build_formatted_GPSAltitude(ExifData *exif)
600 {
601         ExifRational *r;
602         ExifItem *item;
603         gdouble alt;
604         gint ref;
605
606         item = exif_get_item(exif, "Exif.GPSInfo.GPSAltitudeRef");
607         r = exif_get_rational(exif, "Exif.GPSInfo.GPSAltitude", nullptr);
608
609         if (!r || !item) return nullptr;
610
611         alt = exif_rational_to_double(r, 0);
612         exif_item_get_integer(item, &ref);
613
614         return g_strdup_printf("%0.f m %s", alt, (ref==0)?_("Above Sea Level"):_("Below Sea Level"));
615 }
616
617 /**
618  * @brief Extracts timezone data from a ZoneDetect search structure
619  * @param[in] results ZoneDetect search structure
620  * @param[out] timezone in the form "Europe/London"
621  * @param[out] countryname in the form "United Kingdom"
622  * @param[out] countryalpha2 in the form "GB"
623  * 
624  * Refer to https://github.com/BertoldVdb/ZoneDetect
625  * for structure details
626  */
627 static void zd_tz(ZoneDetectResult *results, gchar **timezone, gchar **countryname, gchar **countryalpha2)
628 {
629         gchar *timezone_pre = nullptr;
630         gchar *timezone_id = nullptr;
631         unsigned int index = 0;
632
633         while(results[index].lookupResult != ZD_LOOKUP_END)
634                 {
635                 if(results[index].data)
636                         {
637                         for(unsigned int i=0; i<results[index].numFields; i++)
638                                 {
639                                 if (g_strstr_len(results[index].fieldNames[i], -1, "TimezoneIdPrefix"))
640                                         {
641                                         timezone_pre = g_strdup(results[index].data[i]);
642                                         }
643                                 if (g_strstr_len(results[index].fieldNames[i], -1, "TimezoneId"))
644                                         {
645                                         timezone_id = g_strdup(results[index].data[i]);
646                                         }
647                                 if (g_strstr_len(results[index].fieldNames[i], -1, "CountryName"))
648                                         {
649                                         *countryname = g_strdup(results[index].data[i]);
650                                         }
651                                 if (g_strstr_len(results[index].fieldNames[i], -1, "CountryAlpha2"))
652                                         {
653                                         *countryalpha2 = g_strdup(results[index].data[i]);
654                                         }
655                                 }
656                         }
657                 index++;
658                 }
659
660         *timezone = g_strconcat(timezone_pre, timezone_id, NULL);
661         g_free(timezone_pre);
662         g_free(timezone_id);
663 }
664
665 void ZoneDetect_onError(int errZD, int errNative)
666 {
667         log_printf("Error: ZoneDetect %s (0x%08X)\n", ZDGetErrorString(errZD), (unsigned)errNative);
668 }
669
670 /**
671  * @brief Gets timezone data from an exif structure
672  * @param[in] exif
673  * @returns TRUE if timezone data found AND GPS date and time found
674  * @param[out] exif_date_time exif date/time in the form 2018:11:30:17:05:04
675  * @param[out] timezone in the form "Europe/London"
676  * @param[out] countryname in the form "United Kingdom"
677  * @param[out] countryalpha2 in the form "GB"
678  *
679  *
680  */
681 static gboolean exif_build_tz_data(ExifData *exif, gchar **exif_date_time, gchar **timezone, gchar **countryname, gchar **countryalpha2)
682 {
683         gfloat latitude;
684         gfloat longitude;
685         gchar *text_latitude;
686         gchar *text_longitude;
687         gchar *text_latitude_ref;
688         gchar *text_longitude_ref;
689         gchar *text_date;
690         gchar *text_time;
691         gchar *lat_deg;
692         gchar *lat_min;
693         gchar *lon_deg;
694         gchar *lon_min;
695         gchar *timezone_path;
696         ZoneDetect *cd;
697         ZoneDetectResult *results;
698         gboolean ret = FALSE;
699
700         text_latitude = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLatitude");
701         text_longitude = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLongitude");
702         text_latitude_ref = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLatitudeRef");
703         text_longitude_ref = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSLongitudeRef");
704         text_date = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSDateStamp");
705         text_time = exif_get_data_as_text(exif, "Exif.GPSInfo.GPSTimeStamp");
706
707         if (text_latitude && text_longitude && text_latitude_ref && text_longitude_ref)
708                 {
709                 lat_deg = strtok(text_latitude, "deg'");
710                 lat_min = strtok(nullptr, "deg'");
711                 if (!lat_deg || !lat_min)
712                         {
713                         return FALSE;
714                         }
715                 latitude = atof(lat_deg) + atof(lat_min) / 60;
716                 if (!g_strcmp0(text_latitude_ref, "South"))
717                         {
718                         latitude = -latitude;
719                         }
720                 lon_deg = strtok(text_longitude, "deg'");
721                 lon_min = strtok(nullptr, "deg'");
722                 if (!lon_deg || !lon_min)
723                         {
724                         return FALSE;
725                         }
726                 longitude = atof(lon_deg) + atof(lon_min) / 60;
727                 if (!g_strcmp0(text_longitude_ref, "West"))
728                         {
729                         longitude = -longitude;
730                         }
731
732                 timezone_path = g_build_filename(get_rc_dir(), TIMEZONE_DATABASE_FILE, NULL);
733                 if (g_file_test(timezone_path, G_FILE_TEST_EXISTS))
734                         {
735                         ZDSetErrorHandler(ZoneDetect_onError);
736                         cd = ZDOpenDatabase(timezone_path);
737                         if (cd)
738                                 {
739                                 results = ZDLookup(cd, latitude, longitude, nullptr);
740                                 if (results)
741                                         {
742                                         zd_tz(results, timezone, countryname, countryalpha2);
743                                         ret = TRUE;
744                                         }
745                                 }
746                         else
747                                 {
748                                 log_printf("Error: Init of timezone database %s failed\n", timezone_path);
749                                 }
750                         ZDCloseDatabase(cd);
751                         }
752                 g_free(timezone_path);
753                 }
754
755         if (ret && text_date && text_time)
756                 {
757                 *exif_date_time = g_strconcat(text_date, ":", text_time, NULL);
758                 }
759         else
760                 {
761                 ret = FALSE;
762                 }
763         return ret;
764 }
765
766 /**
767  * @brief Creates local time from GPS lat/long
768  * @param[in] exif
769  * @returns Localised time and date
770  *
771  * GPS lat/long is translated to timezone using ZoneDetect.
772  * GPS UTC is converted to Unix time stamp (seconds since 1970).
773  * The TZ environment variable is set to the relevant timezone
774  * and the Unix timestamp converted to local time using locale.
775  * If the conversion fails, unformatted UTC is returned.
776  */
777 static gchar *exif_build_formatted_localtime(ExifData *exif)
778 {
779         gchar buf[128];
780         gchar *tmp;
781         gint buflen;
782         GError *error = nullptr;
783         gchar *time_zone_image;
784         gchar *time_zone_org;
785         struct tm *tm_local;
786         struct tm tm_utc;
787         time_t stamp;
788         gchar *exif_date_time = nullptr;
789         gchar *timezone = nullptr;
790         gchar *countryname = nullptr;
791         gchar *countryalpha2 = nullptr;
792
793         if (exif_build_tz_data(exif, &exif_date_time, &timezone, &countryname, &countryalpha2))
794                 {
795                 time_zone_image = g_strconcat("TZ=", timezone, NULL);
796                 time_zone_org = g_strconcat("TZ=", getenv("TZ"), NULL);
797                 setenv("TZ", "UTC", TRUE);
798
799                 memset(&tm_utc, 0, sizeof(tm_utc));
800                 if (exif_date_time && strptime(exif_date_time, "%Y:%m:%d:%H:%M:%S", &tm_utc))
801                         {
802                         stamp = mktime(&tm_utc);        // Convert the struct to a Unix timestamp
803                         putenv(time_zone_image);        // Switch to destination time zone
804
805                         tm_local = localtime(&stamp);
806
807                         /* Convert to localtime using locale */
808                         buflen = strftime(buf, sizeof(buf), "%x %X", tm_local);
809                         if (buflen > 0)
810                                 {
811                                 tmp = g_locale_to_utf8(buf, buflen, nullptr, nullptr, &error);
812                                 if (error)
813                                         {
814                                         log_printf("Error converting locale strftime to UTF-8: %s\n", error->message);
815                                         g_error_free(error);
816                                         }
817                                 else
818                                         {
819                                         g_free(exif_date_time);
820                                         exif_date_time = tmp;
821                                         }
822                                 }
823                         }
824                 putenv(time_zone_org);
825
826                 g_free(time_zone_image);
827                 g_free(time_zone_org);
828                 }
829
830         g_free(timezone);
831         g_free(countryname);
832         g_free(countryalpha2);
833
834         return exif_date_time;
835 }
836
837 /**
838  * @brief Gets timezone from GPS lat/long
839  * @param[in] exif
840  * @returns Timezone string in the form "Europe/London"
841  *
842  *
843  */
844 static gchar *exif_build_formatted_timezone(ExifData *exif)
845 {
846         gchar *exif_date_time = nullptr;
847         gchar *timezone = nullptr;
848         gchar *countryname = nullptr;
849         gchar *countryalpha2 = nullptr;
850
851         exif_build_tz_data(exif, &exif_date_time, &timezone, &countryname, &countryalpha2);
852
853         g_free(exif_date_time);
854         g_free(countryname);
855         g_free(countryalpha2);
856
857         return timezone;
858 }
859
860 /**
861  * @brief Gets countryname from GPS lat/long
862  * @param[in] exif
863  * @returns Countryname string
864  *
865  *
866  */
867 static gchar *exif_build_formatted_countryname(ExifData *exif)
868 {
869         gchar *exif_date_time = nullptr;
870         gchar *timezone = nullptr;
871         gchar *countryname = nullptr;
872         gchar *countryalpha2 = nullptr;
873
874         exif_build_tz_data(exif, &exif_date_time, &timezone, &countryname, &countryalpha2);
875
876         g_free(exif_date_time);
877         g_free(timezone);
878         g_free(countryalpha2);
879
880         return countryname;
881 }
882
883 /**
884  * @brief Gets two-letter country code from GPS lat/long
885  * @param[in] exif
886  * @returns Countryalpha2 string
887  *
888  *
889  */
890 static gchar *exif_build_formatted_countrycode(ExifData *exif)
891 {
892         gchar *exif_date_time = nullptr;
893         gchar *timezone = nullptr;
894         gchar *countryname = nullptr;
895         gchar *countryalpha2 = nullptr;
896
897         exif_build_tz_data(exif, &exif_date_time, &timezone, &countryname, &countryalpha2);
898
899         g_free(exif_date_time);
900         g_free(timezone);
901         g_free(countryname);
902
903         return countryalpha2;
904 }
905
906 static gchar *exif_build_formatted_star_rating(ExifData *exif)
907 {
908         gint n = 0;
909
910         exif_get_integer(exif, "Xmp.xmp.Rating", &n);
911
912         return convert_rating_to_stars(n);
913 }
914
915 /* List of custom formatted pseudo-exif tags */
916 #define EXIF_FORMATTED_TAG(name, label) { EXIF_FORMATTED()#name, label, exif_build_formatted##_##name }
917
918 ExifFormattedText ExifFormattedList[] = {
919         EXIF_FORMATTED_TAG(Camera,              N_("Camera")),
920         EXIF_FORMATTED_TAG(DateTime,            N_("Date")),
921         EXIF_FORMATTED_TAG(DateTimeDigitized,   N_("DateDigitized")),
922         EXIF_FORMATTED_TAG(ShutterSpeed,        N_("Shutter speed")),
923         EXIF_FORMATTED_TAG(Aperture,            N_("Aperture")),
924         EXIF_FORMATTED_TAG(ExposureBias,        N_("Exposure bias")),
925         EXIF_FORMATTED_TAG(ISOSpeedRating,      N_("ISO sensitivity")),
926         EXIF_FORMATTED_TAG(FocalLength,         N_("Focal length")),
927         EXIF_FORMATTED_TAG(FocalLength35mmFilm, N_("Focal length 35mm")),
928         EXIF_FORMATTED_TAG(SubjectDistance,     N_("Subject distance")),
929         EXIF_FORMATTED_TAG(Flash,               N_("Flash")),
930         EXIF_FORMATTED_TAG(Resolution,          N_("Resolution")),
931         EXIF_FORMATTED_TAG(ColorProfile,        N_("Color profile")),
932         EXIF_FORMATTED_TAG(GPSPosition,         N_("GPS position")),
933         EXIF_FORMATTED_TAG(GPSAltitude,         N_("GPS altitude")),
934         EXIF_FORMATTED_TAG(localtime,           N_("Local time")),
935         EXIF_FORMATTED_TAG(timezone,            N_("Time zone")),
936         EXIF_FORMATTED_TAG(countryname,         N_("Country name")),
937         EXIF_FORMATTED_TAG(countrycode,         N_("Country code")),
938         EXIF_FORMATTED_TAG(star_rating,         N_("Star rating")),
939         {"file.size",                           N_("File size"),        nullptr},
940         {"file.date",                           N_("File date"),        nullptr},
941         {"file.mode",                           N_("File mode"),        nullptr},
942         {"file.ctime",                          N_("File ctime"),       nullptr},
943         {"file.owner",                          N_("File owner"),       nullptr},
944         {"file.group",                          N_("File group"),       nullptr},
945         {"file.link",                           N_("File link"),        nullptr},
946         {"file.class",                          N_("File class"),       nullptr},
947         {"file.page_no",                        N_("Page no."),         nullptr},
948         {"lua.lensID",                          N_("Lens"),             nullptr},
949         { nullptr, nullptr, nullptr }
950 };
951
952 gchar *exif_get_formatted_by_key(ExifData *exif, const gchar *key, gboolean *key_valid)
953 {
954         if (strncmp(key, EXIF_FORMATTED(), EXIF_FORMATTED_LEN) == 0)
955                 {
956                 gint i;
957
958                 if (key_valid) *key_valid = TRUE;
959
960                 key += EXIF_FORMATTED_LEN;
961                 for (i = 0; ExifFormattedList[i].key; i++)
962                         if (ExifFormattedList[i].build_func && strcmp(key, ExifFormattedList[i].key + EXIF_FORMATTED_LEN) == 0)
963                                 return ExifFormattedList[i].build_func(exif);
964                 }
965
966         if (key_valid) *key_valid = FALSE;
967         return nullptr;
968 }
969
970 gchar *exif_get_description_by_key(const gchar *key)
971 {
972         if (!key) return nullptr;
973
974         if (strncmp(key, EXIF_FORMATTED(), EXIF_FORMATTED_LEN) == 0 || strncmp(key, "file.", 5) == 0 || strncmp(key, "lua.", 4) == 0)
975                 {
976                 gint i;
977
978                 for (i = 0; ExifFormattedList[i].key; i++)
979                         if (strcmp(key, ExifFormattedList[i].key) == 0)
980                                 return g_strdup(_(ExifFormattedList[i].description));
981                 }
982
983         return exif_get_tag_description_by_key(key);
984 }
985
986 gint exif_get_integer(ExifData *exif, const gchar *key, gint *value)
987 {
988         ExifItem *item;
989
990         item = exif_get_item(exif, key);
991         return exif_item_get_integer(item, value);
992 }
993
994 ExifRational *exif_get_rational(ExifData *exif, const gchar *key, gint *sign)
995 {
996         ExifItem *item;
997
998         item = exif_get_item(exif, key);
999         return exif_item_get_rational(item, sign, 0);
1000 }
1001
1002 gchar *exif_get_data_as_text(ExifData *exif, const gchar *key)
1003 {
1004         ExifItem *item;
1005         gchar *text;
1006         gboolean key_valid;
1007
1008         if (!key) return nullptr;
1009
1010         text = exif_get_formatted_by_key(exif, key, &key_valid);
1011         if (key_valid) return text;
1012
1013         item = exif_get_item(exif, key);
1014         if (item) return exif_item_get_data_as_text(item, exif);
1015
1016         return nullptr;
1017 }
1018
1019
1020 static FileCacheData *exif_cache;
1021
1022 void exif_release_cb(FileData *fd)
1023 {
1024         exif_free(fd->exif);
1025         fd->exif = nullptr;
1026 }
1027
1028 void exif_init_cache()
1029 {
1030         g_assert(!exif_cache);
1031         exif_cache = file_cache_new(exif_release_cb, 4);
1032 }
1033
1034 ExifData *exif_read_fd(FileData *fd)
1035 {
1036         gchar *sidecar_path;
1037
1038         if (!exif_cache) exif_init_cache();
1039
1040         if (!fd) return nullptr;
1041
1042         if (file_cache_get(exif_cache, fd)) return fd->exif;
1043         g_assert(fd->exif == nullptr);
1044
1045         /* CACHE_TYPE_XMP_METADATA file should exist only if the metadata are
1046          * not writable directly, thus it should contain the most up-to-date version */
1047         sidecar_path = nullptr;
1048
1049 #if HAVE_EXIV2
1050         /* we are not able to handle XMP sidecars without exiv2 */
1051         sidecar_path = cache_find_location(CACHE_TYPE_XMP_METADATA, fd->path);
1052
1053         if (!sidecar_path) sidecar_path = file_data_get_sidecar_path(fd, TRUE);
1054 #endif
1055
1056         fd->exif = exif_read(fd->path, sidecar_path, fd->modified_xmp);
1057
1058         g_free(sidecar_path);
1059         file_cache_put(exif_cache, fd, 1);
1060         return fd->exif;
1061 }
1062
1063
1064 void exif_free_fd(FileData *fd, ExifData *exif)
1065 {
1066         if (!fd) return;
1067         g_assert(fd->exif == exif);
1068 }
1069
1070 /* embedded icc in jpeg */
1071
1072 gboolean exif_jpeg_parse_color(ExifData *exif, guchar *data, guint size)
1073 {
1074         guint seg_offset = 0;
1075         guint seg_length = 0;
1076         guint chunk_offset[255];
1077         guint chunk_length[255];
1078         guint chunk_count = 0;
1079
1080         /* For jpeg/jfif, ICC color profile data can be in more than one segment.
1081            the data is in APP2 data segments that start with "ICC_PROFILE\x00\xNN\xTT"
1082            NN = segment number for data
1083            TT = total number of ICC segments (TT in each ICC segment should match)
1084          */
1085
1086         while (jpeg_segment_find(data + seg_offset + seg_length,
1087                                       size - seg_offset - seg_length,
1088                                       JPEG_MARKER_APP2,
1089                                       "ICC_PROFILE\x00", 12,
1090                                       &seg_offset, &seg_length))
1091                 {
1092                 guchar chunk_num;
1093                 guchar chunk_tot;
1094
1095                 if (seg_length < 14) return FALSE;
1096
1097                 chunk_num = data[seg_offset + 12];
1098                 chunk_tot = data[seg_offset + 13];
1099
1100                 if (chunk_num == 0 || chunk_tot == 0) return FALSE;
1101
1102                 if (chunk_count == 0)
1103                         {
1104                         guint i;
1105
1106                         chunk_count = static_cast<guint>(chunk_tot);
1107                         for (i = 0; i < chunk_count; i++) chunk_offset[i] = 0;
1108                         for (i = 0; i < chunk_count; i++) chunk_length[i] = 0;
1109                         }
1110
1111                 if (chunk_tot != chunk_count ||
1112                     chunk_num > chunk_count) return FALSE;
1113
1114                 chunk_num--;
1115                 chunk_offset[chunk_num] = seg_offset + 14;
1116                 chunk_length[chunk_num] = seg_length - 14;
1117                 }
1118
1119         if (chunk_count > 0)
1120                 {
1121                 guchar *cp_data;
1122                 guint cp_length = 0;
1123                 guint i;
1124
1125                 for (i = 0; i < chunk_count; i++) cp_length += chunk_length[i];
1126                 cp_data = static_cast<guchar *>(g_malloc(cp_length));
1127
1128                 for (i = 0; i < chunk_count; i++)
1129                         {
1130                         if (chunk_offset[i] == 0)
1131                                 {
1132                                 /* error, we never saw this chunk */
1133                                 g_free(cp_data);
1134                                 return FALSE;
1135                                 }
1136                         memcpy(cp_data, data + chunk_offset[i], chunk_length[i]);
1137                         }
1138                 DEBUG_1("Found embedded icc profile in jpeg");
1139                 exif_add_jpeg_color_profile(exif, cp_data, cp_length);
1140
1141                 return TRUE;
1142                 }
1143
1144         return FALSE;
1145 }
1146
1147 /*
1148  *-------------------------------------------------------------------
1149  * file info
1150  * it is here because it shares tag neming infrastructure with exif
1151  * we should probably not invest too much effort into this because
1152  * new exiv2 will support the same functionality
1153  * https://dev.exiv2.org/issues/505
1154  *-------------------------------------------------------------------
1155  */
1156
1157 static gchar *mode_number(mode_t m)
1158 {
1159         gint mb;
1160         gint mu;
1161         gint mg;
1162         gint mo;
1163         gchar pbuf[12];
1164
1165         mb = mu = mg = mo = 0;
1166
1167         if (m & S_ISUID) mb |= 4;
1168         if (m & S_ISGID) mb |= 2;
1169         if (m & S_ISVTX) mb |= 1;
1170
1171         if (m & S_IRUSR) mu |= 4;
1172         if (m & S_IWUSR) mu |= 2;
1173         if (m & S_IXUSR) mu |= 1;
1174
1175         if (m & S_IRGRP) mg |= 4;
1176         if (m & S_IWGRP) mg |= 2;
1177         if (m & S_IXGRP) mg |= 1;
1178
1179         if (m & S_IROTH) mo |= 4;
1180         if (m & S_IWOTH) mo |= 2;
1181         if (m & S_IXOTH) mo |= 1;
1182
1183         pbuf[0] = (m & S_IRUSR) ? 'r' : '-';
1184         pbuf[1] = (m & S_IWUSR) ? 'w' : '-';
1185         pbuf[2] = (m & S_IXUSR) ? 'x' : '-';
1186         pbuf[3] = (m & S_IRGRP) ? 'r' : '-';
1187         pbuf[4] = (m & S_IWGRP) ? 'w' : '-';
1188         pbuf[5] = (m & S_IXGRP) ? 'x' : '-';
1189         pbuf[6] = (m & S_IROTH) ? 'r' : '-';
1190         pbuf[7] = (m & S_IWOTH) ? 'w' : '-';
1191         pbuf[8] = (m & S_IXOTH) ? 'x' : '-';
1192         pbuf[9] = '\0';
1193
1194         return g_strdup_printf("%s (%d%d%d%d)", pbuf, mb, mu, mg, mo);
1195 }
1196
1197 gchar *metadata_file_info(FileData *fd, const gchar *key, MetadataFormat)
1198 {
1199         gchar *page_n_of_m;
1200
1201         if (strcmp(key, "file.size") == 0)
1202                 {
1203                 return g_strdup_printf("%ld", static_cast<long>(fd->size));
1204                 }
1205         if (strcmp(key, "file.date") == 0)
1206                 {
1207                 return g_strdup(text_from_time(fd->date));
1208                 }
1209         if (strcmp(key, "file.mode") == 0)
1210                 {
1211                 return mode_number(fd->mode);
1212                 }
1213         if (strcmp(key, "file.ctime") == 0)
1214                 {
1215                 return g_strdup(text_from_time(fd->cdate));
1216                 }
1217         if (strcmp(key, "file.class") == 0)
1218                 {
1219                 return g_strdup(format_class_list[fd->format_class]);
1220                 }
1221         if (strcmp(key, "file.owner") == 0)
1222                 {
1223                 return g_strdup(fd->owner);
1224                 }
1225         if (strcmp(key, "file.group") == 0)
1226                 {
1227                 return g_strdup(fd->group);
1228                 }
1229         if (strcmp(key, "file.link") == 0)
1230                 {
1231                 return g_strdup(fd->sym_link);
1232                 }
1233         if (strcmp(key, "file.page_no") == 0)
1234                 {
1235                 if (fd->page_total > 1)
1236                         {
1237                         page_n_of_m = g_strdup_printf("[%d/%d]", fd->page_num + 1, fd->page_total);
1238                         return page_n_of_m;
1239                         }
1240
1241                 return nullptr;
1242                 }
1243         return g_strdup("");
1244 }
1245
1246 #if HAVE_LUA
1247 gchar *metadata_lua_info(FileData *fd, const gchar *key, MetadataFormat)
1248 {
1249         gchar *script_name;
1250         gchar *script_name_utf8;
1251         gchar *data;
1252         gchar *raw_data;
1253         gchar *valid_data;
1254
1255         script_name_utf8 = g_strdup(key + 4);
1256         script_name = path_from_utf8(script_name_utf8);
1257
1258         raw_data = lua_callvalue(fd, script_name, nullptr);
1259         valid_data = g_utf8_make_valid(raw_data, -1);
1260         data = g_utf8_substring(valid_data, 0, 150);
1261
1262         g_free(script_name);
1263         g_free(script_name_utf8);
1264         g_free(raw_data);
1265         g_free(valid_data);
1266
1267         return data;
1268 }
1269 #endif
1270 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */