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