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