2 * Copyright (C) 2008 - 2016 The Geeqie Team
4 * Author: Vladimir Nadvornik
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 // Don't include the <exiv2/version.hpp> file directly
26 // Early Exiv2 versions didn't have version.hpp and the macros.
27 #include <exiv2/exiv2.hpp>
31 // EXIV2_TEST_VERSION is defined in Exiv2 0.15 and newer.
33 #ifndef EXIV2_TEST_VERSION
34 #define EXIV2_TEST_VERSION(major,minor,patch) \
35 ( EXIV2_VERSION >= EXIV2_MAKE_VERSION(major,minor,patch) )
38 #define EXIV2_TEST_VERSION(major,minor,patch) (false)
41 #if EXIV2_TEST_VERSION(0,27,0)
42 #define HAVE_EXIV2_ERROR_CODE
45 #include <sys/types.h>
51 #if EXIV2_TEST_VERSION(0,27,0)
52 #define EXV_PACKAGE "exiv2"
60 #include "filefilter.h"
61 #include "ui-fileops.h"
65 #if EXIV2_TEST_VERSION(0,28,0)
66 #define AnyError Error
67 #define AutoPtr UniquePtr
70 typedef struct _AltKey AltKey;
75 const gchar *exif_key;
76 const gchar *iptc_key;
79 /* this is a list of keys that should be converted, even with the older Exiv2 which does not support it directly */
80 static const AltKey alt_keys[] = {
81 {"Xmp.tiff.Orientation", "Exif.Image.Orientation", nullptr},
82 {"Xmp.dc.title", nullptr, "Iptc.Application2.ObjectName" },
83 {"Xmp.photoshop.Urgency", nullptr, "Iptc.Application2.Urgency" },
84 {"Xmp.photoshop.Category", nullptr, "Iptc.Application2.Category" },
85 {"Xmp.photoshop.SupplementalCategory", nullptr, "Iptc.Application2.SuppCategory" },
86 {"Xmp.dc.subject", nullptr, "Iptc.Application2.Keywords" },
87 {"Xmp.iptc.Location", nullptr, "Iptc.Application2.LocationName" },
88 {"Xmp.photoshop.Instruction", nullptr, "Iptc.Application2.SpecialInstructions" },
89 {"Xmp.photoshop.DateCreated", nullptr, "Iptc.Application2.DateCreated" },
90 {"Xmp.dc.creator", nullptr, "Iptc.Application2.Byline" },
91 {"Xmp.photoshop.AuthorsPosition", nullptr, "Iptc.Application2.BylineTitle" },
92 {"Xmp.photoshop.City", nullptr, "Iptc.Application2.City" },
93 {"Xmp.photoshop.State", nullptr, "Iptc.Application2.ProvinceState" },
94 {"Xmp.iptc.CountryCode", nullptr, "Iptc.Application2.CountryCode" },
95 {"Xmp.photoshop.Country", nullptr, "Iptc.Application2.CountryName" },
96 {"Xmp.photoshop.TransmissionReference", nullptr, "Iptc.Application2.TransmissionReference"},
97 {"Xmp.photoshop.Headline", nullptr, "Iptc.Application2.Headline" },
98 {"Xmp.photoshop.Credit", nullptr, "Iptc.Application2.Credit" },
99 {"Xmp.photoshop.Source", nullptr, "Iptc.Application2.Source" },
100 {"Xmp.dc.rights", nullptr, "Iptc.Application2.Copyright" },
101 {"Xmp.dc.description", nullptr, "Iptc.Application2.Caption" },
102 {"Xmp.photoshop.CaptionWriter", nullptr, "Iptc.Application2.Writer" },
103 {nullptr, nullptr, nullptr}
106 static void _debug_exception(const char* file,
111 gchar *str = g_locale_from_utf8(e.what(), -1, nullptr, nullptr, nullptr);
112 DEBUG_1("%s:%d:%s:Exiv2: %s", file, line, func, str);
116 #define debug_exception(e) _debug_exception(__FILE__, __LINE__, __func__, e)
120 Exiv2::ExifData::const_iterator exifIter; /* for exif_get_next_item */
121 Exiv2::IptcData::const_iterator iptcIter; /* for exif_get_next_item */
122 #if EXIV2_TEST_VERSION(0,16,0)
123 Exiv2::XmpData::const_iterator xmpIter; /* for exif_get_next_item */
126 virtual ~_ExifData() = default;
128 virtual void writeMetadata(gchar *UNUSED(path) = nullptr)
130 g_critical("Unsupported method of writing metadata");
133 virtual ExifData *original()
138 virtual Exiv2::Image *image() = 0;
140 virtual Exiv2::ExifData &exifData() = 0;
142 virtual Exiv2::IptcData &iptcData() = 0;
144 #if EXIV2_TEST_VERSION(0,16,0)
145 virtual Exiv2::XmpData &xmpData() = 0;
148 virtual void add_jpeg_color_profile(unsigned char *cp_data, guint cp_length) = 0;
150 virtual guchar *get_jpeg_color_profile(guint *data_len) = 0;
152 virtual std::string image_comment() const = 0;
154 virtual void set_image_comment(const std::string& comment) = 0;
157 // This allows read-only access to the original metadata
158 struct _ExifDataOriginal : public _ExifData
161 Exiv2::Image::AutoPtr image_;
163 /* the icc profile in jpeg is not technically exif - store it here */
164 unsigned char *cp_data_;
169 Exiv2::ExifData emptyExifData_;
170 Exiv2::IptcData emptyIptcData_;
171 #if EXIV2_TEST_VERSION(0,16,0)
172 Exiv2::XmpData emptyXmpData_;
176 _ExifDataOriginal(Exiv2::Image::AutoPtr image)
180 image_ = std::move(image);
184 _ExifDataOriginal(gchar *path)
190 pathl_ = path_from_utf8(path);
193 image_ = Exiv2::ImageFactory::open(pathl_);
194 // g_assert (image.get() != 0);
195 image_->readMetadata();
197 #if EXIV2_TEST_VERSION(0,16,0)
198 if (image_->mimeType() == "application/rdf+xml")
200 //Exiv2 sidecar converts xmp to exif and iptc, we don't want it.
201 image_->clearExifData();
202 image_->clearIptcData();
206 #if EXIV2_TEST_VERSION(0,14,0)
207 if (image_->mimeType() == "image/jpeg")
209 /* try to get jpeg color profile */
210 Exiv2::BasicIo &io = image_->io();
211 gint open = io.isopen();
212 if (!open) io.open();
215 auto mapped = static_cast<unsigned char*>(io.mmap());
216 if (mapped) exif_jpeg_parse_color(this, mapped, io.size());
219 if (!open) io.close();
223 catch (Exiv2::AnyError& e)
229 ~_ExifDataOriginal() override
231 if (cp_data_) g_free(cp_data_);
232 if (pathl_) g_free(pathl_);
235 Exiv2::Image *image() override
237 if (!valid_) return nullptr;
241 Exiv2::ExifData &exifData () override
243 if (!valid_) return emptyExifData_;
244 return image_->exifData();
247 Exiv2::IptcData &iptcData () override
249 if (!valid_) return emptyIptcData_;
250 return image_->iptcData();
253 #if EXIV2_TEST_VERSION(0,16,0)
254 Exiv2::XmpData &xmpData () override
256 if (!valid_) return emptyXmpData_;
257 return image_->xmpData();
261 void add_jpeg_color_profile(unsigned char *cp_data, guint cp_length) override
263 if (cp_data_) g_free(cp_data_);
265 cp_length_ = cp_length;
268 guchar *get_jpeg_color_profile(guint *data_len) override
272 if (data_len) *data_len = cp_length_;
273 #if GLIB_CHECK_VERSION(2,68,0)
274 return (unsigned char *) g_memdup2(cp_data_, cp_length_);
276 return static_cast<unsigned char *>(g_memdup(cp_data_, cp_length_));
282 std::string image_comment() const override
284 return image_.get() ? image_->comment() : "";
287 void set_image_comment(const std::string& comment) override
290 image_->setComment(comment);
294 static void _ExifDataProcessed_update_xmp(gpointer key, gpointer value, gpointer data);
296 // This allows read-write access to the metadata
297 struct _ExifDataProcessed : public _ExifData
300 std::unique_ptr<_ExifDataOriginal> imageData_;
301 std::unique_ptr<_ExifDataOriginal> sidecarData_;
303 Exiv2::ExifData exifData_;
304 Exiv2::IptcData iptcData_;
305 #if EXIV2_TEST_VERSION(0,16,0)
306 Exiv2::XmpData xmpData_;
310 _ExifDataProcessed(gchar *path, gchar *sidecar_path, GHashTable *modified_xmp)
312 imageData_ = std::make_unique<_ExifDataOriginal>(path);
313 sidecarData_ = nullptr;
314 #if EXIV2_TEST_VERSION(0,16,0)
317 sidecarData_ = std::make_unique<_ExifDataOriginal>(sidecar_path);
318 xmpData_ = sidecarData_->xmpData();
322 xmpData_ = imageData_->xmpData();
326 exifData_ = imageData_->exifData();
327 iptcData_ = imageData_->iptcData();
328 #if EXIV2_TEST_VERSION(0,17,0)
331 syncExifWithXmp(exifData_, xmpData_);
335 DEBUG_1("Exiv2: Catching bug\n");
340 g_hash_table_foreach(modified_xmp, _ExifDataProcessed_update_xmp, this);
344 ExifData *original() override
346 return imageData_.get();
349 void writeMetadata(gchar *path = nullptr) override
353 #if EXIV2_TEST_VERSION(0,17,0)
354 if (options->metadata.save_legacy_IPTC)
355 copyXmpToIptc(xmpData_, iptcData_);
359 copyXmpToExif(xmpData_, exifData_);
361 Exiv2::Image *image = imageData_->image();
363 #ifdef HAVE_EXIV2_ERROR_CODE
364 #if EXIV2_TEST_VERSION(0,28,0)
365 if (!image) throw Exiv2::Error(Exiv2::ErrorCode::kerInputDataReadFailed);
367 if (!image) throw Exiv2::Error(Exiv2::kerInputDataReadFailed);
370 if (!image) throw Exiv2::Error(21);
372 image->setExifData(exifData_);
373 image->setIptcData(iptcData_);
374 #if EXIV2_TEST_VERSION(0,16,0)
375 image->setXmpData(xmpData_);
377 image->writeMetadata();
381 #if EXIV2_TEST_VERSION(0,17,0)
382 gchar *pathl = path_from_utf8(path);;
384 auto sidecar = Exiv2::ImageFactory::create(Exiv2::ImageType::xmp, pathl);
388 sidecar->setXmpData(xmpData_);
389 sidecar->writeMetadata();
391 #ifdef HAVE_EXIV2_ERROR_CODE
392 throw Exiv2::Error(Exiv2::kerNotAnImage, "xmp");
394 throw Exiv2::Error(3, "xmp");
400 Exiv2::Image *image() override
402 return imageData_->image();
405 Exiv2::ExifData &exifData () override
410 Exiv2::IptcData &iptcData () override
415 #if EXIV2_TEST_VERSION(0,16,0)
416 Exiv2::XmpData &xmpData () override
422 void add_jpeg_color_profile(unsigned char *cp_data, guint cp_length) override
424 imageData_->add_jpeg_color_profile(cp_data, cp_length);
427 guchar *get_jpeg_color_profile(guint *data_len) override
429 return imageData_->get_jpeg_color_profile(data_len);
432 std::string image_comment() const override
434 return imageData_->image_comment();
437 void set_image_comment(const std::string& comment) override
439 imageData_->set_image_comment(comment);
450 #ifdef EXV_ENABLE_NLS
451 bind_textdomain_codeset (EXV_PACKAGE, "UTF-8");
454 #ifdef EXV_ENABLE_BMFF
455 Exiv2::enableBMFF(TRUE);
461 static void _ExifDataProcessed_update_xmp(gpointer key, gpointer value, gpointer data)
463 exif_update_metadata(static_cast<ExifData *>(data), static_cast<gchar *>(key), static_cast<GList *>(value));
466 ExifData *exif_read(gchar *path, gchar *sidecar_path, GHashTable *modified_xmp)
468 DEBUG_1("exif read %s, sidecar: %s", path, sidecar_path ? sidecar_path : "-");
470 return new _ExifDataProcessed(path, sidecar_path, modified_xmp);
472 catch (Exiv2::AnyError& e) {
479 gboolean exif_write(ExifData *exif)
482 exif->writeMetadata();
485 catch (Exiv2::AnyError& e) {
491 gboolean exif_write_sidecar(ExifData *exif, gchar *path)
494 exif->writeMetadata(path);
497 catch (Exiv2::AnyError& e) {
505 void exif_free(ExifData *exif)
508 g_assert(dynamic_cast<_ExifDataProcessed *>(exif)); // this should not be called on ExifDataOriginal
512 ExifData *exif_get_original(ExifData *exif)
514 return exif->original();
518 ExifItem *exif_get_item(ExifData *exif, const gchar *key)
521 Exiv2::Metadatum *item = nullptr;
523 Exiv2::ExifKey ekey(key);
524 auto pos = exif->exifData().findKey(ekey);
525 if (pos == exif->exifData().end()) return nullptr;
528 catch (Exiv2::AnyError& e) {
530 Exiv2::IptcKey ekey(key);
531 auto pos = exif->iptcData().findKey(ekey);
532 if (pos == exif->iptcData().end()) return nullptr;
535 catch (Exiv2::AnyError& e) {
536 #if EXIV2_TEST_VERSION(0,16,0)
537 Exiv2::XmpKey ekey(key);
538 auto pos = exif->xmpData().findKey(ekey);
539 if (pos == exif->xmpData().end()) return nullptr;
544 return reinterpret_cast<ExifItem *>(item);
546 catch (Exiv2::AnyError& e) {
552 ExifItem *exif_add_item(ExifData *exif, const gchar *key)
555 Exiv2::Metadatum *item = nullptr;
557 Exiv2::ExifKey ekey(key);
558 exif->exifData().add(ekey, nullptr);
559 auto pos = exif->exifData().end(); // a hack, there should be a better way to get the currently added item
563 catch (Exiv2::AnyError& e) {
565 Exiv2::IptcKey ekey(key);
566 exif->iptcData().add(ekey, nullptr);
567 auto pos = exif->iptcData().end();
571 catch (Exiv2::AnyError& e) {
572 #if EXIV2_TEST_VERSION(0,16,0)
573 Exiv2::XmpKey ekey(key);
574 exif->xmpData().add(ekey, nullptr);
575 auto pos = exif->xmpData().end();
581 return reinterpret_cast<ExifItem *>(item);
583 catch (Exiv2::AnyError& e) {
590 ExifItem *exif_get_first_item(ExifData *exif)
593 exif->exifIter = exif->exifData().begin();
594 exif->iptcIter = exif->iptcData().begin();
595 #if EXIV2_TEST_VERSION(0,16,0)
596 exif->xmpIter = exif->xmpData().begin();
598 if (exif->exifIter != exif->exifData().end())
600 const Exiv2::Metadatum *item = &*exif->exifIter;
602 return (ExifItem *)item;
604 if (exif->iptcIter != exif->iptcData().end())
606 const Exiv2::Metadatum *item = &*exif->iptcIter;
608 return (ExifItem *)item;
610 #if EXIV2_TEST_VERSION(0,16,0)
611 if (exif->xmpIter != exif->xmpData().end())
613 const Exiv2::Metadatum *item = &*exif->xmpIter;
615 return (ExifItem *)item;
621 catch (Exiv2::AnyError& e) {
627 ExifItem *exif_get_next_item(ExifData *exif)
630 if (exif->exifIter != exif->exifData().end())
632 const Exiv2::Metadatum *item = &*exif->exifIter;
634 return (ExifItem *)item;
636 if (exif->iptcIter != exif->iptcData().end())
638 const Exiv2::Metadatum *item = &*exif->iptcIter;
640 return (ExifItem *)item;
642 #if EXIV2_TEST_VERSION(0,16,0)
643 if (exif->xmpIter != exif->xmpData().end())
645 const Exiv2::Metadatum *item = &*exif->xmpIter;
647 return (ExifItem *)item;
652 catch (Exiv2::AnyError& e) {
658 char *exif_item_get_tag_name(ExifItem *item)
661 if (!item) return nullptr;
662 return g_strdup((reinterpret_cast<Exiv2::Metadatum *>(item))->key().c_str());
664 catch (Exiv2::AnyError& e) {
670 guint exif_item_get_tag_id(ExifItem *item)
674 return (reinterpret_cast<Exiv2::Metadatum *>(item))->tag();
676 catch (Exiv2::AnyError& e) {
682 guint exif_item_get_elements(ExifItem *item)
686 return (reinterpret_cast<Exiv2::Metadatum *>(item))->count();
688 catch (Exiv2::AnyError& e) {
694 char *exif_item_get_data(ExifItem *item, guint *data_len)
697 if (!item) return nullptr;
698 auto md = reinterpret_cast<Exiv2::Metadatum *>(item);
699 if (data_len) *data_len = md->size();
700 auto data = static_cast<char *>(g_malloc(md->size()));
701 long res = md->copy(reinterpret_cast<Exiv2::byte *>(data), Exiv2::littleEndian /* should not matter */);
702 g_assert(res == md->size());
705 catch (Exiv2::AnyError& e) {
711 char *exif_item_get_description(ExifItem *item)
714 if (!item) return nullptr;
715 return utf8_validate_or_convert((reinterpret_cast<Exiv2::Metadatum *>(item))->tagLabel().c_str());
717 catch (std::exception& e) {
718 // debug_exception(e);
724 invalidTypeId, unsignedByte, asciiString, unsignedShort,
725 unsignedLong, unsignedRational, signedByte, undefined,
726 signedShort, signedLong, signedRational, string,
727 date, time, comment, directory,
728 xmpText, xmpAlt, xmpBag, xmpSeq,
732 static guint format_id_trans_tbl [] = {
734 EXIF_FORMAT_BYTE_UNSIGNED,
736 EXIF_FORMAT_SHORT_UNSIGNED,
737 EXIF_FORMAT_LONG_UNSIGNED,
738 EXIF_FORMAT_RATIONAL_UNSIGNED,
740 EXIF_FORMAT_UNDEFINED,
743 EXIF_FORMAT_RATIONAL,
747 EXIF_FORMAT_UNDEFINED,
756 guint exif_item_get_format_id(ExifItem *item)
759 if (!item) return EXIF_FORMAT_UNKNOWN;
760 guint id = (reinterpret_cast<Exiv2::Metadatum *>(item))->typeId();
761 if (id >= (sizeof(format_id_trans_tbl) / sizeof(format_id_trans_tbl[0])) ) return EXIF_FORMAT_UNKNOWN;
762 return format_id_trans_tbl[id];
764 catch (Exiv2::AnyError& e) {
766 return EXIF_FORMAT_UNKNOWN;
770 const char *exif_item_get_format_name(ExifItem *item, gboolean UNUSED(brief))
773 if (!item) return nullptr;
774 return (reinterpret_cast<Exiv2::Metadatum *>(item))->typeName();
776 catch (Exiv2::AnyError& e) {
783 gchar *exif_item_get_data_as_text(ExifItem *item)
786 if (!item) return nullptr;
787 auto metadatum = reinterpret_cast<Exiv2::Metadatum *>(item);
788 #if EXIV2_TEST_VERSION(0,17,0)
789 return utf8_validate_or_convert(metadatum->print().c_str());
791 std::stringstream str;
792 Exiv2::Exifdatum *exifdatum;
793 Exiv2::Iptcdatum *iptcdatum;
794 #if EXIV2_TEST_VERSION(0,16,0)
795 Exiv2::Xmpdatum *xmpdatum;
797 if ((exifdatum = dynamic_cast<Exiv2::Exifdatum *>(metadatum)))
799 else if ((iptcdatum = dynamic_cast<Exiv2::Iptcdatum *>(metadatum)))
801 #if EXIV2_TEST_VERSION(0,16,0)
802 else if ((xmpdatum = dynamic_cast<Exiv2::Xmpdatum *>(metadatum)))
806 return utf8_validate_or_convert(str.str().c_str());
809 catch (Exiv2::AnyError& e) {
814 gchar *exif_item_get_string(ExifItem *item, int idx)
817 if (!item) return nullptr;
818 auto em = reinterpret_cast<Exiv2::Metadatum *>(item);
819 #if EXIV2_TEST_VERSION(0,16,0)
820 std::string str = em->toString(idx);
822 std::string str = em->toString(); /**< @FIXME ?? */
824 if (idx == 0 && str == "") str = em->toString();
825 if (str.length() > 5 && str.substr(0, 5) == "lang=")
827 std::string::size_type pos = str.find_first_of(' ');
828 if (pos != std::string::npos) str = str.substr(pos+1);
831 return utf8_validate_or_convert(str.c_str());
833 catch (Exiv2::AnyError& e) {
839 gint exif_item_get_integer(ExifItem *item, gint *value)
842 if (!item || exif_item_get_elements(item) == 0) return 0;
844 #if EXIV2_TEST_VERSION(0,28,0)
845 *value = ((Exiv2::Metadatum *)item)->toInt64();
847 *value = (reinterpret_cast<Exiv2::Metadatum *>(item))->toLong();
851 catch (Exiv2::AnyError& e) {
857 ExifRational *exif_item_get_rational(ExifItem *item, gint *sign, guint n)
860 if (!item) return nullptr;
861 if (n >= exif_item_get_elements(item)) return nullptr;
862 Exiv2::Rational v = (reinterpret_cast<Exiv2::Metadatum *>(item))->toRational(n);
863 static ExifRational ret;
866 if (sign) *sign = ((reinterpret_cast<Exiv2::Metadatum *>(item))->typeId() == Exiv2::signedRational);
869 catch (Exiv2::AnyError& e) {
875 gchar *exif_get_tag_description_by_key(const gchar *key)
878 Exiv2::ExifKey ekey(key);
879 return utf8_validate_or_convert(ekey.tagLabel().c_str());
881 catch (Exiv2::AnyError& e) {
883 Exiv2::IptcKey ikey(key);
884 return utf8_validate_or_convert(ikey.tagLabel().c_str());
886 catch (Exiv2::AnyError& e) {
888 #if EXIV2_TEST_VERSION(0,16,0)
889 Exiv2::XmpKey xkey(key);
890 return utf8_validate_or_convert(xkey.tagLabel().c_str());
893 catch (Exiv2::AnyError& e) {
902 static const AltKey *find_alt_key(const gchar *xmp_key)
906 while (alt_keys[i].xmp_key)
908 if (strcmp(xmp_key, alt_keys[i].xmp_key) == 0) return &alt_keys[i];
914 static gint exif_update_metadata_simple(ExifData *exif, const gchar *key, const GList *values)
917 const GList *work = values;
920 Exiv2::ExifKey ekey(key);
922 auto pos = exif->exifData().findKey(ekey);
923 while (pos != exif->exifData().end())
925 exif->exifData().erase(pos);
926 pos = exif->exifData().findKey(ekey);
931 exif->exifData()[key] = static_cast<gchar *>(work->data);
935 catch (Exiv2::AnyError& e) {
936 #if EXIV2_TEST_VERSION(0,16,0)
940 Exiv2::IptcKey ekey(key);
941 auto pos = exif->iptcData().findKey(ekey);
942 while (pos != exif->iptcData().end())
944 exif->iptcData().erase(pos);
945 pos = exif->iptcData().findKey(ekey);
950 exif->iptcData()[key] = static_cast<gchar *>(work->data);
954 #if EXIV2_TEST_VERSION(0,16,0)
955 catch (Exiv2::AnyError& e) {
956 Exiv2::XmpKey ekey(key);
957 auto pos = exif->xmpData().findKey(ekey);
958 while (pos != exif->xmpData().end())
960 exif->xmpData().erase(pos);
961 pos = exif->xmpData().findKey(ekey);
966 exif->xmpData()[key] = static_cast<gchar *>(work->data);
974 catch (Exiv2::AnyError& e) {
980 gint exif_update_metadata(ExifData *exif, const gchar *key, const GList *values)
982 gint ret = exif_update_metadata_simple(exif, key, values);
985 #if !EXIV2_TEST_VERSION(0,17,0)
986 TRUE || /* no conversion support */
988 !values || /* deleting item */
989 !ret /* writing to the explicitly given xmp tag failed */
992 /* deleted xmp metadatum can't be converted, we have to delete also the corresponding legacy tag */
993 /* if we can't write xmp, update at least the legacy tag */
994 const AltKey *alt_key = find_alt_key(key);
995 if (alt_key && alt_key->iptc_key)
996 ret = exif_update_metadata_simple(exif, alt_key->iptc_key, values);
998 if (alt_key && alt_key->exif_key)
999 ret = exif_update_metadata_simple(exif, alt_key->exif_key, values);
1005 static GList *exif_add_value_to_glist(GList *list, Exiv2::Metadatum &item, MetadataFormat format, const Exiv2::ExifData *metadata)
1007 #if EXIV2_TEST_VERSION(0,16,0)
1008 Exiv2::TypeId id = item.typeId();
1009 if (format == METADATA_FORMATTED ||
1010 id == Exiv2::asciiString ||
1011 id == Exiv2::undefined ||
1012 id == Exiv2::string ||
1013 id == Exiv2::date ||
1014 id == Exiv2::time ||
1015 id == Exiv2::xmpText ||
1016 id == Exiv2::langAlt ||
1017 id == Exiv2::comment
1021 /* read as a single entry */
1024 if (format == METADATA_FORMATTED)
1026 #if EXIV2_TEST_VERSION(0,17,0)
1028 #if EXIV2_TEST_VERSION(0,18,0)
1033 std::stringstream stream;
1034 Exiv2::Exifdatum *exifdatum;
1035 Exiv2::Iptcdatum *iptcdatum;
1036 #if EXIV2_TEST_VERSION(0,16,0)
1037 Exiv2::Xmpdatum *xmpdatum;
1039 if ((exifdatum = dynamic_cast<Exiv2::Exifdatum *>(&item)))
1040 stream << *exifdatum;
1041 else if ((iptcdatum = dynamic_cast<Exiv2::Iptcdatum *>(&item)))
1042 stream << *iptcdatum;
1043 #if EXIV2_TEST_VERSION(0,16,0)
1044 else if ((xmpdatum = dynamic_cast<Exiv2::Xmpdatum *>(&item)))
1045 stream << *xmpdatum;
1049 if (str.length() > 1024)
1051 /* truncate very long strings, they cause problems in gui */
1058 str = item.toString();
1060 if (str.length() > 5 && str.substr(0, 5) == "lang=")
1062 std::string::size_type pos = str.find_first_of(' ');
1063 if (pos != std::string::npos) str = str.substr(pos+1);
1065 list = g_list_append(list, utf8_validate_or_convert(str.c_str()));
1066 #if EXIV2_TEST_VERSION(0,16,0)
1070 /* read as a list */
1072 for (i = 0; i < item.count(); i++)
1073 list = g_list_append(list, utf8_validate_or_convert(item.toString(i).c_str()));
1079 static GList *exif_get_metadata_simple(ExifData *exif, const gchar *key, MetadataFormat format)
1081 GList *list = nullptr;
1084 Exiv2::ExifKey ekey(key);
1085 auto pos = exif->exifData().findKey(ekey);
1086 if (pos != exif->exifData().end())
1087 list = exif_add_value_to_glist(list, *pos, format, &exif->exifData());
1090 catch (Exiv2::AnyError& e) {
1092 Exiv2::IptcKey ekey(key);
1093 auto pos = exif->iptcData().begin();
1094 while (pos != exif->iptcData().end())
1096 if (pos->key() == key)
1097 list = exif_add_value_to_glist(list, *pos, format, nullptr);
1102 catch (Exiv2::AnyError& e) {
1103 #if EXIV2_TEST_VERSION(0,16,0)
1104 Exiv2::XmpKey ekey(key);
1105 auto pos = exif->xmpData().findKey(ekey);
1106 if (pos != exif->xmpData().end())
1107 list = exif_add_value_to_glist(list, *pos, format, nullptr);
1112 catch (Exiv2::AnyError& e) {
1118 GList *exif_get_metadata(ExifData *exif, const gchar *key, MetadataFormat format)
1120 GList *list = nullptr;
1122 if (!key) return nullptr;
1124 if (format == METADATA_FORMATTED)
1128 text = exif_get_formatted_by_key(exif, key, &key_valid);
1129 if (key_valid) return g_list_append(nullptr, text);
1132 list = exif_get_metadata_simple(exif, key, format);
1134 /* the following code can be ifdefed out as soon as Exiv2 supports it */
1137 const AltKey *alt_key = find_alt_key(key);
1138 if (alt_key && alt_key->iptc_key)
1139 list = exif_get_metadata_simple(exif, alt_key->iptc_key, format);
1141 #if !EXIV2_TEST_VERSION(0,17,0)
1142 /* with older Exiv2 versions exif is not synced */
1143 if (!list && alt_key && alt_key->exif_key)
1144 list = exif_get_metadata_simple(exif, alt_key->exif_key, format);
1151 void exif_add_jpeg_color_profile(ExifData *exif, unsigned char *cp_data, guint cp_length)
1153 exif->add_jpeg_color_profile(cp_data, cp_length);
1156 guchar *exif_get_color_profile(ExifData *exif, guint *data_len)
1158 guchar *ret = exif->get_jpeg_color_profile(data_len);
1159 if (ret) return ret;
1161 ExifItem *prof_item = exif_get_item(exif, "Exif.Image.InterColorProfile");
1162 if (prof_item && exif_item_get_format_id(prof_item) == EXIF_FORMAT_UNDEFINED)
1163 ret = reinterpret_cast<guchar *>(exif_item_get_data(prof_item, data_len));
1167 gchar* exif_get_image_comment(FileData* fd)
1169 if (!fd || !fd->exif)
1170 return g_strdup("");
1172 return g_strdup(fd->exif->image_comment().c_str());
1175 void exif_set_image_comment(FileData* fd, const gchar* comment)
1177 if (!fd || !fd->exif)
1180 fd->exif->set_image_comment(comment ? comment : "");
1184 #if EXIV2_TEST_VERSION(0,17,90)
1186 guchar *exif_get_preview(ExifData *exif, guint *data_len, gint requested_width, gint requested_height)
1188 if (!exif) return nullptr;
1190 if (!exif->image()) return nullptr;
1192 std::string const path = exif->image()->io().path();
1193 /* given image pathname, first do simple (and fast) file extension test */
1194 gboolean is_raw = filter_file_class(path.c_str(), FORMAT_CLASS_RAWIMAGE);
1196 if (!is_raw && requested_width == 0) return nullptr;
1200 Exiv2::PreviewManager pm(*exif->image());
1202 Exiv2::PreviewPropertiesList list = pm.getPreviewProperties();
1206 Exiv2::PreviewPropertiesList::iterator pos;
1207 auto last = --list.end();
1209 if (requested_width == 0)
1211 pos = last; // the largest
1218 if (pos->width_ >= static_cast<uint32_t>(requested_width) &&
1219 pos->height_ >= static_cast<uint32_t>(requested_height)) break;
1223 // we are not interested in smaller thumbnails in normal image formats - we can use full image instead
1226 if (pos->width_ < static_cast<uint32_t>(requested_width) || pos->height_ < static_cast<uint32_t>(requested_height)) return nullptr;
1230 Exiv2::PreviewImage image = pm.getPreviewImage(*pos);
1232 Exiv2::DataBuf buf = image.copy();
1234 #if EXIV2_TEST_VERSION(0,28,0)
1235 *data_len = buf.size();
1236 auto b = buf.data();
1240 std::pair<Exiv2::byte*, long> p = buf.release();
1242 *data_len = p.second;
1248 catch (Exiv2::AnyError& e) {
1254 void exif_free_preview(guchar *buf)
1256 delete[] static_cast<Exiv2::byte*>(buf);
1260 #if !EXIV2_TEST_VERSION(0,17,90)
1262 /* This is a dirty hack to support raw file preview, bassed on
1263 tiffparse.cpp from Exiv2 examples */
1268 RawFile(Exiv2::BasicIo &io);
1271 const Exiv2::Value *find(uint16_t tag, uint16_t group);
1273 unsigned long preview_offset();
1277 Exiv2::TiffComponent::AutoPtr rootDir;
1278 Exiv2::BasicIo &io_;
1279 const Exiv2::byte *map_data;
1281 unsigned long offset;
1284 typedef struct _UnmapData UnmapData;
1292 static GList *exif_unmap_list = 0;
1294 guchar *exif_get_preview(ExifData *exif, guint *data_len, gint requested_width, gint requested_height)
1296 unsigned long offset;
1298 if (!exif) return NULL;
1299 if (!exif->image()) return NULL;
1301 std::string const path = exif->image()->io().path();
1303 /* given image pathname, first do simple (and fast) file extension test */
1304 if (!filter_file_class(path.c_str(), FORMAT_CLASS_RAWIMAGE)) return NULL;
1313 RawFile rf(exif->image()->io());
1314 offset = rf.preview_offset();
1315 DEBUG_1("%s: offset %lu", path.c_str(), offset);
1317 fd = open(path.c_str(), O_RDONLY);
1323 if (fstat(fd, &st) == -1)
1328 map_len = st.st_size;
1329 map_data = (guchar *) mmap(0, map_len, PROT_READ, MAP_PRIVATE, fd, 0);
1331 if (map_data == MAP_FAILED)
1335 *data_len = map_len - offset;
1336 ud = g_new(UnmapData, 1);
1337 ud->ptr = map_data + offset;
1338 ud->map_data = map_data;
1339 ud->map_len = map_len;
1341 exif_unmap_list = g_list_prepend(exif_unmap_list, ud);
1345 catch (Exiv2::AnyError& e) {
1352 void exif_free_preview(guchar *buf)
1354 GList *work = exif_unmap_list;
1358 UnmapData *ud = (UnmapData *)work->data;
1361 munmap(ud->map_data, ud->map_len);
1362 exif_unmap_list = g_list_remove_link(exif_unmap_list, work);
1368 g_assert_not_reached();
1371 using namespace Exiv2;
1373 RawFile::RawFile(BasicIo &io) : io_(io), map_data(NULL), map_len(0), offset(0)
1377 if (fstat(fd, &st) == -1)
1381 map_len = st.st_size;
1382 map_data = (Exiv2::byte *) mmap(0, map_len, PROT_READ, MAP_PRIVATE, fd, 0);
1383 if (map_data == MAP_FAILED)
1388 if (io.open() != 0) {
1389 throw Error(9, io.path(), strError());
1392 map_data = io.mmap();
1393 map_len = io.size();
1396 type = Exiv2::ImageFactory::getType(map_data, map_len);
1398 #if EXIV2_TEST_VERSION(0,16,0)
1399 std::unique_ptr<TiffHeaderBase> tiffHeader;
1401 std::unique_ptr<TiffHeade2> tiffHeader;
1403 std::unique_ptr<Cr2Header> cr2Header;
1406 case Exiv2::ImageType::tiff:
1407 tiffHeader = std::make_unique<TiffHeade2>();
1409 case Exiv2::ImageType::cr2:
1410 cr2Header = std::make_unique<Cr2Header>();
1412 #if EXIV2_TEST_VERSION(0,16,0)
1413 case Exiv2::ImageType::orf:
1414 tiffHeader = std::make_unique<OrfHeader>();
1417 #if EXIV2_TEST_VERSION(0,13,0)
1418 case Exiv2::ImageType::raf:
1419 if (map_len < 84 + 4) throw Error(14);
1420 offset = getULong(map_data + 84, bigEndian);
1423 case Exiv2::ImageType::crw:
1425 // Parse the image, starting with a CIFF header component
1426 auto parseTree = std::make_unique<Exiv2::CiffHeader>();
1427 parseTree->read(map_data, map_len);
1428 CiffComponent *entry = parseTree->findComponent(0x2007, 0);
1429 if (entry) offset = entry->pData() - map_data;
1434 throw Error(3, "RAW");
1437 // process tiff-like formats
1439 TiffCompFactoryFct createFct = TiffCreator::create;
1441 rootDir = createFct(Tag::root, Group::none);
1442 if (0 == rootDir.get()) {
1443 throw Error(1, "No root element defined in TIFF structure");
1448 if (!tiffHeader->read(map_data, map_len)) throw Error(3, "TIFF");
1449 #if EXIV2_TEST_VERSION(0,16,0)
1450 rootDir->setStart(map_data + tiffHeader->offset());
1452 rootDir->setStart(map_data + tiffHeader->ifdOffset());
1458 rootDir->setStart(map_data + cr2Header->offset());
1461 TiffRwState::AutoPtr state(new TiffRwState(tiffHeader ? tiffHeader->byteOrder() : littleEndian, 0, createFct));
1463 TiffReader reader(map_data,
1468 rootDir->accept(reader);
1471 RawFile::~RawFile(void)
1477 const Value * RawFile::find(uint16_t tag, uint16_t group)
1479 TiffFinder finder(tag, group);
1480 rootDir->accept(finder);
1481 TiffEntryBase* te = dynamic_cast<TiffEntryBase*>(finder.result());
1484 DEBUG_1("(tag: %04x %04x) ", tag, group);
1485 return te->pValue();
1491 unsigned long RawFile::preview_offset(void)
1494 if (offset) return offset;
1496 if (type == Exiv2::ImageType::cr2)
1498 val = find(0x111, Group::ifd0);
1499 #if EXIV2_TEST_VERSION(0,28,0)
1500 if (val) return val->toInt64();
1502 if (val) return val->tolong();
1507 val = find(0x201, Group::sub0_0);
1508 #if EXIV2_TEST_VERSION(0,28,0)
1509 if (val) return val->toInt64();
1511 if (val) return val->tolong();
1514 val = find(0x201, Group::ifd0);
1515 #if EXIV2_TEST_VERSION(0,28,0)
1516 if (val) return val->toInt64();
1518 if (val) return val->tolong();
1521 val = find(0x201, Group::ignr); // for PEF files, originally it was probably ifd2
1522 #if EXIV2_TEST_VERSION(0,28,0)
1523 if (val) return val->toInt64();
1525 if (val) return val->tolong();
1528 val = find(0x111, Group::sub0_1); // dng
1529 #if EXIV2_TEST_VERSION(0,28,0)
1530 if (val) return val->toInt64();
1532 if (val) return val->tolong();
1544 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */