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