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