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