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