Replace GQView by Geeqie.
[geeqie.git] / src / exif-common.c
1 /*
2  * Geeqie
3  * (C) 2006 John Ellis
4  * Copyright (C) 2008 The Geeqie Team
5  *
6 */
7
8 #ifdef HAVE_CONFIG_H
9 #  include "config.h"
10 #endif
11
12 #include <stdio.h>
13 #include <string.h>
14 #include <fcntl.h>
15 #include <unistd.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18 #include <sys/mman.h>
19 #include <math.h>
20
21 #ifdef HAVE_LCMS
22 /*** color support enabled ***/
23
24 #ifdef HAVE_LCMS_LCMS_H
25   #include <lcms/lcms.h>
26 #else
27   #include <lcms.h>
28 #endif
29 #endif
30
31 #include <glib.h>
32
33 #include "intl.h"
34
35 #include "main.h"
36 #include "exif.h"
37
38 #include "debug.h"
39 #include "filelist.h"
40 #include "format_raw.h"
41 #include "ui_fileops.h"
42
43
44 /* human readable key list */
45
46 ExifFormattedText ExifFormattedList[] = {
47         { "fCamera",            N_("Camera") },
48         { "fDateTime",          N_("Date") },
49         { "fShutterSpeed",      N_("Shutter speed") },
50         { "fAperture",          N_("Aperture") },
51         { "fExposureBias",      N_("Exposure bias") },
52         { "fISOSpeedRating",    N_("ISO sensitivity") },
53         { "fFocalLength",       N_("Focal length") },
54         { "fFocalLength35mmFilm",N_("Focal length 35mm") },
55         { "fSubjectDistance",   N_("Subject distance") },
56         { "fFlash",             N_("Flash") },
57         { "fResolution",        N_("Resolution") },
58         { "fColorProfile",      N_("Color profile") },
59         { NULL, NULL }
60 };
61
62 double exif_rational_to_double(ExifRational *r, gint sign)
63 {
64         if (!r || r->den == 0.0) return 0.0;
65
66         if (sign) return (double)((int)r->num) / (double)((int)r->den);
67         return (double)r->num / r->den;
68 }
69
70 double exif_get_rational_as_double(ExifData *exif, const gchar *key)
71 {
72         ExifRational *r;
73         gint sign;
74
75         r = exif_get_rational(exif, key, &sign);
76         return exif_rational_to_double(r, sign);
77 }
78
79 static GString *append_comma_text(GString *string, const gchar *text)
80 {
81         string = g_string_append(string, ", ");
82         string = g_string_append(string, text);
83
84         return string;
85 }
86
87 static gchar *remove_common_prefix(gchar *s, gchar *t)
88 {
89         gint i;
90
91         if (!s || !t) return t;
92
93         for (i = 0; s[i] && t[i] && s[i] == t[i]; i++)
94                 ;
95         if (!i)
96                 return t;
97         if (s[i-1] == ' ' || !s[i])
98                 {
99                 while (t[i] == ' ')
100                         i++;
101                 return t + i;
102                 }
103         return s;
104 }
105
106 static double get_crop_factor(ExifData *exif)
107 {
108         double res_unit_tbl[] = {0.0, 25.4, 25.4, 10.0, 1.0, 0.001 };
109
110         double xres = exif_get_rational_as_double(exif, "Exif.Photo.FocalPlaneXResolution");
111         double yres = exif_get_rational_as_double(exif, "Exif.Photo.FocalPlaneYResolution");
112         int res_unit;
113         int w, h;
114         double xsize, ysize, size, ratio;
115
116         if (xres == 0.0 || yres == 0.0) return 0.0;
117
118         if (!exif_get_integer(exif, "Exif.Photo.FocalPlaneResolutionUnit", &res_unit)) return 0.0;
119         if (res_unit < 1 || res_unit > 5) return 0.0;
120
121         if (!exif_get_integer(exif, "Exif.Photo.PixelXDimension", &w)) return 0.0;
122         if (!exif_get_integer(exif, "Exif.Photo.PixelYDimension", &h)) return 0.0;
123
124         xsize = w * res_unit_tbl[res_unit] / xres;
125         ysize = h * res_unit_tbl[res_unit] / yres;
126
127         ratio = xsize / ysize;
128
129         if (ratio < 0.5 || ratio > 2.0) return 0.0; /* reasonable ratio */
130
131         size = sqrt(xsize * xsize + ysize * ysize);
132
133         if (size < 1.0 || size > 100.0) return 0.0; /* reasonable sensor size in mm */
134
135         return sqrt(36*36+24*24) / size;
136
137 }
138
139 static gint remove_suffix(gchar *str, const gchar *suffix, gint suffix_len)
140 {
141         gint str_len = strlen(str);
142         
143         if (suffix_len < 0) suffix_len = strlen(suffix);
144         if (str_len < suffix_len) return FALSE;
145         
146         if (strcmp(str + str_len - suffix_len, suffix) != 0) return FALSE; 
147         str[str_len - suffix_len] = '\0';
148         
149         return TRUE;
150 }
151
152 gchar *exif_get_formatted_by_key(ExifData *exif, const gchar *key, gint *key_valid)
153 {
154         /* must begin with f, else not formatted */
155         if (key[0] != 'f')
156                 {
157                 if (key_valid) *key_valid = FALSE;
158                 return NULL;
159                 }
160
161         if (key_valid) *key_valid = TRUE;
162
163         if (strcmp(key, "fCamera") == 0)
164                 {
165                 gchar *text;
166                 gchar *make = exif_get_data_as_text(exif, "Exif.Image.Make");
167                 gchar *model = exif_get_data_as_text(exif, "Exif.Image.Model");
168                 gchar *software = exif_get_data_as_text(exif, "Exif.Image.Software");
169                 gchar *model2;
170                 gchar *software2;
171         
172                 if (make)
173                         {
174                         g_strstrip(make);
175
176                         if (remove_suffix(make, " CORPORATION", 12)) { /* Nikon */ }
177                         else if (remove_suffix(make, " Corporation", 12)) { /* Pentax */ }
178                         else if (remove_suffix(make, " OPTICAL CO.,LTD", 16)) { /* OLYMPUS */ };
179                         }
180
181                 if (model)
182                         g_strstrip(model);
183
184                 if (software)
185                         {
186                         gint i;
187
188                         g_strstrip(software);
189                         
190                         /* remove superfluous spaces (pentax K100D) */
191                         for (i = 0; software[i]; i++)
192                                 if (software[i] == ' ' && software[i + 1] == ' ')
193                                         {
194                                         gint j;
195
196                                         for (j = 1; software[i + j] == ' '; j++);
197                                         memmove(software + i + 1, software + i + j, strlen(software + i + j) + 1);
198                                         }
199                         }
200
201                 model2 = remove_common_prefix(make, model);
202                 software2 = remove_common_prefix(model2, software);
203
204                 text = g_strdup_printf("%s%s%s%s%s%s", (make) ? make : "", (make && model2) ? " " : "",
205                                                        (model2) ? model2 : "",
206                                                        (software2 && (make || model2)) ? " (" : "",
207                                                        (software2) ? software2 : "",
208                                                        (software2 && (make || model2)) ? ")" : "");
209
210                 g_free(make);
211                 g_free(model);
212                 g_free(software);
213                 return text;
214                 }
215         if (strcmp(key, "fDateTime") == 0)
216                 {
217                 gchar *text = exif_get_data_as_text(exif, "Exif.Photo.DateTimeOriginal");
218                 gchar *subsec = NULL;
219                 if (text) subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTimeOriginal");
220                 if (!text)
221                         {
222                         text = exif_get_data_as_text(exif, "Exif.Image.DateTime");
223                         if (text) subsec = exif_get_data_as_text(exif, "Exif.Photo.SubSecTime");
224                         }
225                 if (subsec)
226                         {
227                         gchar *tmp = text;
228                         text = g_strconcat(tmp, ".", subsec, NULL);
229                         g_free(tmp);
230                         g_free(subsec);
231                         }
232                 return text;
233                 }
234         if (strcmp(key, "fShutterSpeed") == 0)
235                 {
236                 ExifRational *r;
237
238                 r = exif_get_rational(exif, "Exif.Photo.ExposureTime", NULL);
239                 if (r && r->num && r->den)
240                         {
241                         double n = (double)r->den / (double)r->num;
242                         return g_strdup_printf("%s%.0fs", n > 1.0 ? "1/" : "",
243                                                           n > 1.0 ? n : 1.0 / n);
244                         }
245                 r = exif_get_rational(exif, "Exif.Photo.ShutterSpeedValue", NULL);
246                 if (r && r->num  && r->den)
247                         {
248                         double n = pow(2.0, exif_rational_to_double(r, TRUE));
249
250                         /* Correct exposure time to avoid values like 1/91s (seen on Minolta DImage 7) */
251                         if (n > 1.0 && (int)n - ((int)(n/10))*10 == 1) n--;
252
253                         return g_strdup_printf("%s%.0fs", n > 1.0 ? "1/" : "",
254                                                           n > 1.0 ? floor(n) : 1.0 / n);
255                         }
256                 return NULL;
257                 }
258         if (strcmp(key, "fAperture") == 0)
259                 {
260                 double n;
261
262                 n = exif_get_rational_as_double(exif, "Exif.Photo.FNumber");
263                 if (n == 0.0) n = exif_get_rational_as_double(exif, "Exif.Photo.ApertureValue");
264                 if (n == 0.0) return NULL;
265
266                 return g_strdup_printf("f/%.1f", n);
267                 }
268         if (strcmp(key, "fExposureBias") == 0)
269                 {
270                 ExifRational *r;
271                 gint sign;
272                 double n;
273
274                 r = exif_get_rational(exif, "Exif.Photo.ExposureBiasValue", &sign);
275                 if (!r) return NULL;
276
277                 n = exif_rational_to_double(r, sign);
278                 return g_strdup_printf("%+.1f", n);
279                 }
280         if (strcmp(key, "fFocalLength") == 0)
281                 {
282                 double n;
283
284                 n = exif_get_rational_as_double(exif, "Exif.Photo.FocalLength");
285                 if (n == 0.0) return NULL;
286                 return g_strdup_printf("%.0f mm", n);
287                 }
288         if (strcmp(key, "fFocalLength35mmFilm") == 0)
289                 {
290                 gint n;
291                 double f, c;
292
293                 if (exif_get_integer(exif, "Exif.Photo.FocalLengthIn35mmFilm", &n) && n != 0)
294                         {
295                         return g_strdup_printf("%d mm", n);
296                         }
297
298                 f = exif_get_rational_as_double(exif, "Exif.Photo.FocalLength");
299                 c = get_crop_factor(exif);
300
301                 if (f != 0.0 && c != 0.0)
302                         {
303                         return g_strdup_printf("%.0f mm", f * c);
304                         }
305
306                 return NULL;
307                 }
308         if (strcmp(key, "fISOSpeedRating") == 0)
309                 {
310                 gchar *text;
311
312                 text = exif_get_data_as_text(exif, "Exif.Photo.ISOSpeedRatings");
313                 /* kodak may set this instead */
314                 if (!text) text = exif_get_data_as_text(exif, "Exif.Photo.ExposureIndex");
315                 return text;
316                 }
317         if (strcmp(key, "fSubjectDistance") == 0)
318                 {
319                 ExifRational *r;
320                 gint sign;
321                 double n;
322
323                 r = exif_get_rational(exif, "Exif.Photo.SubjectDistance", &sign);
324                 if (!r) return NULL;
325
326                 if ((long)r->num == 0xffffffff) return g_strdup(_("infinity"));
327                 if ((long)r->num == 0) return g_strdup(_("unknown"));
328
329                 n = exif_rational_to_double(r, sign);
330                 if (n == 0.0) return _("unknown");
331                 return g_strdup_printf("%.3f m", n);
332                 }
333         if (strcmp(key, "fFlash") == 0)
334                 {
335                 /* grr, flash is a bitmask... */
336                 GString *string;
337                 gchar *text;
338                 gint n;
339                 gint v;
340
341                 if (!exif_get_integer(exif, "Exif.Photo.Flash", &n)) return NULL;
342
343                 /* Exif 2.1 only defines first 3 bits */
344                 if (n <= 0x07) return exif_get_data_as_text(exif, "Exif.Photo.Flash");
345
346                 /* must be Exif 2.2 */
347                 string = g_string_new("");
348
349                 /* flash fired (bit 0) */
350                 string = g_string_append(string, (n & 0x01) ? _("yes") : _("no"));
351
352                 /* flash mode (bits 3, 4) */
353                 v = (n >> 3) & 0x03;
354                 if (v) string = append_comma_text(string, _("mode:"));
355                 switch (v)
356                         {
357                         case 1:
358                                 string = g_string_append(string, _("on"));
359                                 break;
360                         case 2:
361                                 string = g_string_append(string, _("off"));
362                                 break;
363                         case 3:
364                                 string = g_string_append(string, _("auto"));
365                                 break;
366                         }
367
368                 /* return light (bits 1, 2) */
369                 v = (n >> 1) & 0x03;
370                 if (v == 2) string = append_comma_text(string, _("not detected by strobe"));
371                 if (v == 3) string = append_comma_text(string, _("detected by strobe"));
372
373                 /* we ignore flash function (bit 5) */
374
375                 /* red-eye (bit 6) */
376                 if ((n >> 5) & 0x01) string = append_comma_text(string, _("red-eye reduction"));
377
378                 text = string->str;
379                 g_string_free(string, FALSE);
380                 return text;
381                 }
382         if (strcmp(key, "fResolution") == 0)
383                 {
384                 ExifRational *rx, *ry;
385                 gchar *units;
386                 gchar *text;
387
388                 rx = exif_get_rational(exif, "Exif.Image.XResolution", NULL);
389                 ry = exif_get_rational(exif, "Exif.Image.YResolution", NULL);
390                 if (!rx || !ry) return NULL;
391
392                 units = exif_get_data_as_text(exif, "Exif.Image.ResolutionUnit");
393                 text = g_strdup_printf("%0.f x %0.f (%s/%s)", rx->den ? (double)rx->num / rx->den : 1.0,
394                                                               ry->den ? (double)ry->num / ry->den : 1.0,
395                                                               _("dot"), (units) ? units : _("unknown"));
396
397                 g_free(units);
398                 return text;
399                 }
400         if (strcmp(key, "fColorProfile") == 0)
401                 {
402                 const gchar *name = "";
403                 const gchar *source = "";
404                 unsigned char *profile_data;
405                 guint profile_len;
406                 profile_data = exif_get_color_profile(exif, &profile_len);
407                 if (!profile_data)
408                         {
409                         gint cs;
410                         gchar *interop_index;
411
412                         /* ColorSpace == 1 specifies sRGB per EXIF 2.2 */
413                         if (!exif_get_integer(exif, "Exif.Photo.ColorSpace", &cs)) cs = 0;
414                         interop_index = exif_get_data_as_text(exif, "Exif.Iop.InteroperabilityIndex");
415
416                         if (cs == 1)
417                                 {
418                                 name = _("sRGB");
419                                 source = "ColorSpace";
420                                 }
421                         else if (cs == 2 || (interop_index && !strcmp(interop_index, "R03")))
422                                 {
423                                 name = _("AdobeRGB");
424                                 source = (cs == 2) ? "ColorSpace" : "Iop";
425                                 }
426
427                         g_free(interop_index);
428                         }
429                 else
430                         {
431                         source = _("embedded");
432 #ifdef HAVE_LCMS
433
434                                 {
435                                 cmsHPROFILE profile;
436
437                                 profile = cmsOpenProfileFromMem(profile_data, profile_len);
438                                 if (profile)
439                                         {
440                                         name = cmsTakeProductName(profile);
441                                         cmsCloseProfile(profile);
442                                         }
443                                 g_free(profile_data);
444                                 }
445 #endif
446                         }
447                 if (name[0] == 0 && source[0] == 0) return NULL;
448                 return g_strdup_printf("%s (%s)", name, source);
449                 }
450
451         if (key_valid) *key_valid = FALSE;
452         return NULL;
453 }
454
455 const gchar *exif_get_description_by_key(const gchar *key)
456 {
457         gint i;
458
459         if (!key) return NULL;
460
461         i = 0;
462         while (ExifFormattedList[i].key != NULL)
463                 {
464                 if (strcmp(key, ExifFormattedList[i].key) == 0) return _(ExifFormattedList[i].description);
465                 i++;
466                 }
467
468         return exif_get_tag_description_by_key(key);
469 }
470
471 gint exif_get_integer(ExifData *exif, const gchar *key, gint *value)
472 {
473         ExifItem *item;
474
475         item = exif_get_item(exif, key);
476         return exif_item_get_integer(item, value);
477 }
478
479 ExifRational *exif_get_rational(ExifData *exif, const gchar *key, gint *sign)
480 {
481         ExifItem *item;
482
483         item = exif_get_item(exif, key);
484         return exif_item_get_rational(item, sign);
485 }
486
487 gchar *exif_get_data_as_text(ExifData *exif, const gchar *key)
488 {
489         ExifItem *item;
490         gchar *text;
491         gint key_valid;
492
493         if (!key) return NULL;
494
495         text = exif_get_formatted_by_key(exif, key, &key_valid);
496         if (key_valid) return text;
497
498         item = exif_get_item(exif, key);
499         if (item) return exif_item_get_data_as_text(item);
500
501         return NULL;
502 }
503
504 ExifData *exif_read_fd(FileData *fd)
505 {
506         GList *work;
507         gchar *sidecar_path = NULL;
508
509         if (!fd) return NULL;
510
511         work = fd->parent ? fd->parent->sidecar_files : fd->sidecar_files;
512
513         if (filter_file_class(fd->extension, FORMAT_CLASS_RAWIMAGE))
514                 {
515                 while (work)
516                         {
517                         FileData *sfd = work->data;
518                         work = work->next;
519                         if (strcasecmp(sfd->extension, ".xmp") == 0)
520                                 {
521                                 sidecar_path = sfd->path;
522                                 break;
523                                 }
524                         }
525                 }
526
527
528         // FIXME: some caching would be nice
529         return exif_read(fd->path, sidecar_path);
530 }
531
532
533
534 /* embedded icc in jpeg */
535
536
537 #define JPEG_MARKER             0xFF
538 #define JPEG_MARKER_SOI         0xD8
539 #define JPEG_MARKER_EOI         0xD9
540 #define JPEG_MARKER_APP1        0xE1
541 #define JPEG_MARKER_APP2        0xE2
542
543 /* jpeg container format:
544      all data markers start with 0XFF
545      2 byte long file start and end markers: 0xFFD8(SOI) and 0XFFD9(EOI)
546      4 byte long data segment markers in format: 0xFFTTSSSSNNN...
547        FF:   1 byte standard marker identifier
548        TT:   1 byte data type
549        SSSS: 2 bytes in Motorola byte alignment for length of the data.
550              This value includes these 2 bytes in the count, making actual
551              length of NN... == SSSS - 2.
552        NNN.: the data in this segment
553  */
554
555 gint exif_jpeg_segment_find(unsigned char *data, guint size,
556                                    guchar app_marker, const gchar *magic, guint magic_len,
557                                    guint *seg_offset, guint *seg_length)
558 {
559         guchar marker = 0;
560         guint offset = 0;
561         guint length = 0;
562
563         while (marker != app_marker &&
564                marker != JPEG_MARKER_EOI)
565                 {
566                 offset += length;
567                 length = 2;
568
569                 if (offset + 2 >= size ||
570                     data[offset] != JPEG_MARKER) return FALSE;
571
572                 marker = data[offset + 1];
573                 if (marker != JPEG_MARKER_SOI &&
574                     marker != JPEG_MARKER_EOI)
575                         {
576                         if (offset + 4 >= size) return FALSE;
577                         length += ((guint)data[offset + 2] << 8) + data[offset + 3];
578                         }
579                 }
580
581         if (marker == app_marker &&
582             offset + length < size &&
583             length >= 4 + magic_len &&
584             memcmp(data + offset + 4, magic, magic_len) == 0)
585                 {
586                 *seg_offset = offset + 4;
587                 *seg_length = length - 4;
588                 return TRUE;
589                 }
590
591         return FALSE;
592 }
593
594 gint exif_jpeg_parse_color(ExifData *exif, unsigned char *data, guint size)
595 {
596         guint seg_offset = 0;
597         guint seg_length = 0;
598         guint chunk_offset[255];
599         guint chunk_length[255];
600         guint chunk_count = 0;
601
602         /* For jpeg/jfif, ICC color profile data can be in more than one segment.
603            the data is in APP2 data segments that start with "ICC_PROFILE\x00\xNN\xTT"
604            NN = segment number for data
605            TT = total number of ICC segments (TT in each ICC segment should match)
606          */
607
608         while (exif_jpeg_segment_find(data + seg_offset + seg_length,
609                                       size - seg_offset - seg_length,
610                                       JPEG_MARKER_APP2,
611                                       "ICC_PROFILE\x00", 12,
612                                       &seg_offset, &seg_length))
613                 {
614                 guchar chunk_num;
615                 guchar chunk_tot;
616
617                 if (seg_length < 14) return FALSE;
618
619                 chunk_num = data[seg_offset + 12];
620                 chunk_tot = data[seg_offset + 13];
621
622                 if (chunk_num == 0 || chunk_tot == 0) return FALSE;
623
624                 if (chunk_count == 0)
625                         {
626                         guint i;
627
628                         chunk_count = (guint)chunk_tot;
629                         for (i = 0; i < chunk_count; i++) chunk_offset[i] = 0;
630                         for (i = 0; i < chunk_count; i++) chunk_length[i] = 0;
631                         }
632
633                 if (chunk_tot != chunk_count ||
634                     chunk_num > chunk_count) return FALSE;
635
636                 chunk_num--;
637                 chunk_offset[chunk_num] = seg_offset + 14;
638                 chunk_length[chunk_num] = seg_length - 14;
639                 }
640
641         if (chunk_count > 0)
642                 {
643                 unsigned char *cp_data;
644                 guint cp_length = 0;
645                 guint i;
646
647                 for (i = 0; i < chunk_count; i++) cp_length += chunk_length[i];
648                 cp_data = g_malloc(cp_length);
649
650                 for (i = 0; i < chunk_count; i++)
651                         {
652                         if (chunk_offset[i] == 0)
653                                 {
654                                 /* error, we never saw this chunk */
655                                 g_free(cp_data);
656                                 return FALSE;
657                                 }
658                         memcpy(cp_data, data + chunk_offset[i], chunk_length[i]);
659                         }
660                 DEBUG_1("Found embedded icc profile in jpeg");
661                 exif_add_jpeg_color_profile(exif, cp_data, cp_length);
662
663                 return TRUE;
664                 }
665
666         return FALSE;
667 }