| Codecov | OSS-Fuzz | Repology | Chat |
|---|---|---|---|
 |
 |
 |
 |
| CI Status: | ||
|---|---|---|
 |
 |
 |
Exiv2 is a C++ library and a command-line utility to read, write, delete and modify Exif, IPTC, XMP and ICC image metadata.
| Exiv2 Resource | Location |
|---|---|
| Releases and Documentation Prereleases: Project Resources License (GPLv2) CMake Downloads |
https://exiv2.org https://pre-release.exiv2.org https://github.com/Exiv2/exiv2 COPYING https://cmake.org/download/ |
| README.md README-CONAN.md README-SAMPLES.md |
User Manual. This document Conan User Manual click here Sample Code Manual. click here |
The file ReadMe.txt in a build bundle describes how to install the library on the platform. ReadMe.txt also documents how to compile and link code on the platform.
- Welcome to Exiv2
- Building, Installing, Using and Uninstalling Exiv2
- Build, Install, Use and Uninstall Exiv2 on a UNIX-like system
- Build and Install Exiv2 with Visual Studio
- Configure the project with CMake presets
- Build Options
- Dependencies
- Building and linking your code with Exiv2
- Consuming Exiv2 with CMake
- Using pkg-config to compile and link your code with Exiv2
- Localisation
- Building Exiv2 Documentation
- Building Exiv2 Tag Webpages
- Building Exiv2 Packages
- Debugging Exiv2
- Building Exiv2 with Clang and other build chains
- Building Exiv2 with ccache
- Thread Safety
- Library Initialisation and Cleanup
- Cross Platform Build and Test on Linux for MinGW
- Static and Shared Libraries
- Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)
- License and Support
- Test Suite
- Platform Notes
You need CMake to configure the Exiv2 project, any C++ compiler implementing the C++ 17 standard and the associated tool chain.
$ cd ~/gnu/github/exiv2 # Location of the project code
$ mkdir build && cd build # Create a build directory
$ cmake -DCMAKE_BUILD_TYPE=Release .. # Configure the project with CMake
$ cmake --build . # Compile the project
$ ctest --verbose # Run tests
$ cmake --install . # Run the install target (install library, public headers, application and CMake files)This will install the library into the "standard locations". The library will be installed in /usr/local/lib, executables (including the exiv2 command-line program) in /usr/local/bin/ and header files in /usr/local/include/exiv2. The target directory for the installation can be modified by using the CMake option -DCMAKE_INSTALL_PREFIX.
CMake analyzes the project configuration from the source code directory and generates files into the build directory. It generates the project/solution/makefiles required to build the exiv2 library and command line application (and optionally sample applications and test runners). CMake also creates the files exv_conf.h and exiv2lib_export.h which contain compiler directives about the build options you have chosen and the availability of libraries on your machine.
To execute the exiv2 command line program, you should update your path to search /usr/local/bin/
$ export PATH="/usr/local/bin:$PATH"You will also need to locate libexiv2 at run time:
$ export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH" # Linux, Cygwin, MinGW/msys2
$ export DYLD_LIBRARY_PATH="/usr/local/lib:$DYLD_LIBRARY_PATH" # macOSI don't know why anybody would uninstall Exiv2.
$ cd ~/gnu/github/exiv2 # location of the project code
$ cd build
$ cmake --build . --target uninstallThese commands will run the uninstall target and remove all the files which were installed by the install target.
Note that this mechanism is not perfect and it is not able to remove the sub-directories created in the installation
path.
We recommend to use conan to download the Exiv2 external dependencies on Windows. On other platforms (macOS, Linux and others), traditionally the platform package managers have been used. However, conan can be used in any platform/architecture to bring the project dependencies. These are discussed at Platform Notes. The options to configure and compile the project using Visual Studio are similar to UNIX like systems. See README-CONAN for more information about Conan.
When you build, you may install with the following command.
> cmake --install .This will create and copy the exiv2 build artefacts to %ProgramFiles%/exiv2. To be able to run the exiv2 command line application from any terminal you should modify your path to include %ProgramFiles%/exiv2/bin.
CMake presets (see documentation here) were added recently to the project to ease the CMake configuration process for typical configurations. The presets are defined in the file CMakePresets.json and they can be used from the terminal or interpreted by different IDEs. Please note that one needs to use a recent version of CMake (>= 3.21) supporting the presets feature.
One can list the available presets using the --list-presets option:
# Running the command from a Windows terminal
$ cmake --list-presets
Available configure presets:
"msvc" - Visual Studio cl toolchain (also usable from VS Code)
"win-debug" - Windows Debug with configured architecture
"win-release" - Windows Release with configured architecture
# Running the command from a Linux terminal
$ cmake --list-presets
Available configure presets:
"linux-debug" - Linux Debug with default architecture
"linux-release" - Linux Release with default architectureThe project configuration with a specific preset can be choosen with the CMake --preset option. In the following terminal output we comment out some interesting things happening during the project configuration:
# Configuring the project using a preset
$ cmake --preset win-release
Preset CMake variables:
# Note that with the usage of a preset, we pass many different options to CMake.
BUILD_SHARED_LIBS:BOOL="TRUE"
CMAKE_BUILD_TYPE="Release"
CMAKE_INSTALL_PREFIX:PATH="C:/dev/personal/exiv2/build-win-release/install"
# A build & install directory are configured with the preset
CONAN_AUTO_INSTALL:BOOL="TRUE"
EXIV2_BUILD_SAMPLES:BOOL="TRUE"
EXIV2_BUILD_UNIT_TESTS:BOOL="TRUE"
EXIV2_ENABLE_BMFF:BOOL="TRUE"
EXIV2_ENABLE_CURL:BOOL="TRUE"
EXIV2_ENABLE_NLS:BOOL="FALSE"
EXIV2_ENABLE_VIDEO:BOOL="TRUE"
EXIV2_ENABLE_PNG:BOOL="TRUE"
EXIV2_ENABLE_WEBREADY:BOOL="TRUE"
EXIV2_TEAM_WARNINGS_AS_ERRORS:BOOL="TRUE"
# Conan can be automatically detected in your system and it is run automatically to bring the
# project dependencies
-- Conan: Detected VS runtime: MD
-- Conan: checking conan executable
-- Conan: Found program C:/dev/envs/conan/Scripts/conan.exe
-- Conan: Version found Conan version 1.47.0
-- Conan executing: C:/dev/envs/conan/Scripts/conan.exe install .. --remote conancenter --build missing --options webready=True --settings arch=x86_64 --settings build_type=Release --settings compiler=Visual Studio --settings compiler.version=17 --settings compiler.runtime=MD
...
# CMake finds the project dependencies which were automatically handled by conan
-- Conan: Using autogenerated FindZLIB.cmake
-- Library zlib found C:/Users/luis/.conan/data/zlib/1.2.11/_/_/package/
-- Conan: Using autogenerated FindCURL.cmake
-- Library libcurl_imp found C:/Users/luis/.conan/data/libcurl/7.79.0/_/_/package/
...
# CMake finish the project configuration and prints a report
-- Install prefix: C:/dev/personal/exiv2/build-win-release/install
-- ------------------------------------------------------------------
-- CMake Generator: Ninja
-- CMAKE_BUILD_TYPE: Release
-- Compiler info: MSVC (C:/Program Files/Microsoft Visual Studio/2022/Professional/VC/Tools/MSVC/14.30.30705/bin/Hostx64/x64/cl.exe) ; version: 19.30.30705.0
-- CMAKE_CXX_STANDARD:17
-- --- Compiler flags ---
-- General: /DWIN32 /D_WINDOWS /W3 /GR /EHsc
/MP
/utf-8
/WX
-- Extra:
-- Debug: /MDd /Zi /Ob0 /Ox /Zo
-- Release: /MD /O2 /DNDEBUG
-- RelWithDebInfo: /MD /Zi /O2 /DNDEBUG
-- MinSizeRel: /MD /O1 /DNDEBUG
-- --- Linker flags ---
-- General: /machine:x64 /WX
-- Debug: /debug /INCREMENTAL
-- Release: /INCREMENTAL:NO
-- RelWithDebInfo: /debug /INCREMENTAL
-- MinSizeRel: /INCREMENTAL:NO
--
...
-- Build files have been written to: C:/dev/personal/exiv2/build-win-releaseNote that the usage of CMake presets allow the project contributors to use the same set of options easily in different environments (using terminal, IDEs or CI).
There are two groups of CMake options which are relevant to the project: global CMake options and project specific ones. Here are some of the global options which are particularly useful:
| Options | Purpose (default) |
|---|---|
| CMAKE_INSTALL_PREFIX CMAKE_BUILD_TYPE BUILD_SHARED_LIBS |
Where to install on your computer (/usr/local) Type of build (Release) See: Debugging Exiv2 Build exiv2lib as SHARED or STATIC |
Options defined at exiv2/CMakeLists.txt include:
576 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $ grep ^option CMakeLists.txt
option( BUILD_SHARED_LIBS "Build exiv2lib as a shared library" ON )
option( EXIV2_ENABLE_XMP "Build with XMP metadata support" ON )
option( EXIV2_ENABLE_EXTERNAL_XMP "Use external version of XMP" OFF )
option( EXIV2_ENABLE_PNG "Build with png support (requires libz)" ON )
...
option( EXIV2_ENABLE_BMFF "Build with BMFF support (brotli recommended)" ON )
option( EXIV2_ENABLE_BROTLI "Use Brotli for JPEG XL compressed boxes (BMFF)" ON )
577 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $Using the command-line, these variables can be set/updated using the option -D:
$ cmake -DBUILD_SHARED_LIBS=ON -DEXIV2_ENABLE_NLS=OFFThe following Exiv2 features require external libraries:
| Feature | Package | Default | To change default | Availability |
|---|---|---|---|---|
| PNG image support | zlib | ON | -DEXIV2_ENABLE_PNG=OFF | http://zlib.net/ |
| XMP support | expat | ON | -DEXIV2_ENABLE_XMP=OFF | http://expat.sourceforge.net/ Use Expat 2.2.6 and later |
| Natural language system | gettext | OFF | -DEXIV2_ENABLE_NLS=ON | http://www.gnu.org/software/gettext/ |
| JPEG XL brob support | brotli | ON | -DEXIV2_ENABLE_BROTLI=OFF | https://github.com/google/brotli |
| Character set conversion | libiconv | Disabled for Visual Studio. Linked when installed on UNIX like platforms. |
https://www.gnu.org/software/libiconv/ |
On UNIX systems, you may install the dependencies using the distribution's package management system. Install the
development package of a dependency to install the header files and libraries required to build Exiv2. The script
ci/install_dependencies.sh is used to setup the CI images on which we build and test Exiv2. You may find that helpful in setting up your platform dependencies.
Natural language system is discussed in more detail here: Localisation
Notes about different platforms are included here: Platform Notes
You may choose to install dependences with conan. This is supported on all platforms and is especially useful for users of Visual Studio. See README-CONAN for more information.
The library libiconv is used to perform character set encoding in the tags Exif.Photo.UserComment, Exif.GPSInfo.GPSProcessingMethod and Exif.GPSInfo.GPSAreaInformation. This is documented in the exiv2 man page.
CMake will detect libiconv of all UNIX like systems including Linux, macOS, UNIX, Cygwin64 and MinGW/msys2. If you have installed libiconv on your machine, Exiv2 will link and use it.
The library libiconv is a GNU library and we do not recommend using libiconv with Exiv2 when building with Visual Studio.
Exiv2 includes the file cmake/FindIconv.cmake which contains a guard to prevent CMake from finding libiconv when you build with Visual Studio. This was added because of issues reported when Visual Studio attempted to link libiconv libraries installed by Cygwin, or MinGW or gnuwin32. Exiv2#1250
There are build instructions about Visual Studio in libiconv-1.16/INSTALL.window require you to install Cygwin. There is an article here about building libiconv with Visual Studio. https://www.codeproject.com/Articles/302012/How-to-Build-libiconv-with-Microsoft-Visual-Studio.
If you wish to use libiconv with Visual Studio you will have to build libiconv and remove the "guard" in cmake/FindIconv.cmake. Team Exiv2 will not provide support concerning libiconv and Visual Studio.
There are detailed platform notes about compiling and linking in releasenotes/{platform}/ReadMe.txt
where platform: { CYGWIN | Darwin | Linux | MinGW | msvc | Unix }
In general you need to do the following:
- Application code should be written in C++98 and include exiv2 headers:
#include <exiv2/exiv2.hpp>-
Compile your C++ code with the directive:
-I/usr/local/include -
Link your code with libexiv2 using the linker options:
-lexiv2and-L/usr/local/lib
The following is a typical command to build and link with libexiv2:
$ g++ -std=c++17 myprog.cpp -o myprog -I/usr/local/include -L/usr/local/lib -lexiv2When exiv2 is installed, the files required to consume Exiv2 with CMake are installed in ${CMAKE_INSTALL_PREFIX}/lib/cmake/exiv2
You can build samples/exifprint.cpp as follows:
$ cd <exiv2dir>
$ mkdir exifprint
$ cd exifprint
$ cat - > CMakeLists.txt <<EOF
cmake_minimum_required(VERSION 3.11)
project(exifprint VERSION 0.0.1 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_EXTENSIONS OFF)
find_package(exiv2 REQUIRED CONFIG NAMES exiv2) # search ${CMAKE_INSTALL_PREFIX}/lib/cmake/exiv2/
add_executable(exifprint ../samples/exifprint.cpp) # Create exifprint target
target_link_libraries(exifprint PRIVATE exiv2lib) # link exiv2lib
EOF
$ cmake . # generate the makefile
$ cmake --build . # build the code
$ ./exifprint # test your executable
Usage: bin/exifprint [ path | --version | --version-test ]
$When exiv2 is installed, the file exiv2.pc used by pkg-config is installed in ${CMAKE_INSTALL_PREFIX}/lib/pkgconfig You will need to set the following in your environment:
$ export PKG_CONFIG_PATH="/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH"To compile and link using exiv2.pc, you usually add the following to your Makefile.
PKGCONFIG=pkg-config
CPPFLAGS := `pkg-config exiv2 --cflags`
LDFLAGS := `pkg-config exiv2 --libs`If you are not using make, you can use pkg-config as follows:
g++ -std=c++17 myprogram.cpp -o myprogram $(pkg-config exiv2 --libs --cflags)Localisation is supported on a UNIX-like platform: Linux, macOS, Cygwin and MinGW/msys2. Localisation is not supported for Visual Studio builds.
Crowdin have provided Exiv2 with a free open-source license to use their services. The Exiv2 localisation project is located at https://crowdin.com/project/exiv2. You will also need to register to have a free user account on Crowdin. The Crowdin setup is discussed here: Exiv2#1510. It is recommended that you coordinate with Leonardo before contributing localisation changes on Crowdin. You can contact Leonardo by via GitHub.
To build localisation support, use the CMake option -DEXIV2_ENABLE_NLS=ON. You must install the gettext package with your package manager or from source. The gettext package is available from http://www.gnu.org/software/gettext/ and includes the library libintl and utilities to build localisation files. If CMake produces error messages which mention libintl or gettext, you should verify that the package gettext has been correctly built and installed.
You must install the build to test localisation. This ensures that the localisation message files can be found at run-time. You cannot test localisation in the directory build\bin.
- Running exiv2 in another language
$ env LANG=fr_FR exiv2 # env LANGUAGE=fr_FR exiv2 on Linux!
exiv2: Une action doit être spécifié
exiv2: Au moins un fichier est nécessaire
Utilisation : exiv2 [ option [ arg ] ]+ [ action ] fichier ...
Image metadata manipulation tool.
$- Adding additional languages to exiv2
To support a new language which we'll designate 'xy' for this discussion:
2.1) Generate a po file from the po template:
$ cd <exiv2dir>
$ mkdir -p po/xy
$ msginit --input=po/exiv2.pot --locale=xy --output=po/xy.po2.2) Edit/Translate the strings in po/xy.po
I edited the following:
#: src/exiv2.cpp:237
msgid "Image metadata manipulation tool.\n"
msgstr ""to:
#: src/exiv2.cpp:237
msgid "Image metadata manipulation tool.\n"
msgstr "Manipulate image metadata.\n"2.3) Generate the messages file:
$ mkdir -p po/xy/LC_MESSAGES
$ msgfmt --output-file=po/xy/LC_MESSAGES/exiv2.mo po/xy.po2.4) Install and test your messages:
You have to install your messages to test them. It's not possible to test a messages file by executing build/bin/exiv2.
$ sudo mkdir -p /usr/local/share/locale/xy/LC_MESSAGES
$ sudo cp -R po/xy/LC_MESSAGES/exiv2.mo /usr/local/share/locale/xy/LC_MESSAGES
$ env LANG=xy exiv2 # env LANGUAGE=xy on Linux!
exiv2: An action must be specified
exiv2: At least one file is required
Usage: exiv2 [ option [ arg ] ]+ [ action ] file ...
Manipulate image metadata. <--------- Edited message!
$2.5) Submitting your new language file for inclusion in future versions of Exiv2:
You may submit a PR which contains po/xy.po AND a modification to po/CMakeLists.txt
Or, open a new issue on https://github.com/exiv2/exiv2 and attach the file xy.po.zip which can be created as follows:
$ zip xy.po.zip po/xy.po
adding: po/xy.po (deflated 78%)
ls -l xy.po.zip
-rw-r--r--+ 1 rmills staff 130417 25 Jun 10:15 xy.po.zip
$
Building documentation requires installing special tools. You will probably prefer to read the documentation on-line from the project website: https://exiv2.org
To build documentation, use the CMake option -DEXIV2_BUILD_DOC=ON.
Additionally, you will require an additional build step to actually build the documentation.
$ cmake ..options.. -DEXIV2_BUILD_DOC=ON
$ cmake --build . --target docTo build the documentation, you must install the following products:
| Product | Availability |
|---|---|
| doxygen graphviz python xsltproc md5sum |
http://www.doxygen.org/ http://www.graphviz.org/ http://www.python.org/ http://xmlsoft.org/XSLT/ http://www.microbrew.org/tools/md5sha1sum/ |
Exiv2 provides many built-in metadata tags which are listed in the sub-pages of https://exiv2.org/metadata.html and https://pre-release.exiv2.org/metadata.html. Those tag webpages are generated using tag information extracted from the Exiv2 source code.
The tag webpage build files are in the <exiv2dir>/doc/templates directory. If changes are made to
tag groups in the Exiv2 source code then the build files need to be updated. Any changes made
to individual tags in an existing tag group are automatically included.
Building the tag webpages requires building the Exiv2 sample programs and using scripts which have additional dependancies on BASH, make, xsltproc and Python3.
To build the tag webpages, first build Exiv2 from source with the -DEXIV2_BUILD_SAMPLES=ON
option enabled. This is required as the taglist sample program is used by one of the scripts.
Next, set the EXIV2_BINDIR environment variable (see Exiv2 environment variables).
Then, change directory to doc/templates and run make.
$ cd <exiv2dir>/doc/templates
$ makeAfter processing, the generated webpages are stored in the <exiv2dir>/doc/templates directory.
When the Exiv2 websites are updated, the generated tag webpages are reformatted before use.
To enable the building of Exiv2 packages, use the CMake option -DEXIV2_TEAM_PACKAGING=ON.
You should not build Exiv2 Packages. This feature is intended for use by Team Exiv2 to create Platform and Source Packages on the buildserver.
There are two types of Exiv2 packages which are generated by cpack from the CMake command-line.
- Platform Package (header files, binary library and samples. Some documentation and release notes)
Create and build exiv2 for your platform.
$ git clone https://github.com/exiv2/exiv2
$ mkdir -p exiv2/build
$ cd exiv2/build
$ cmake .. -G "Unix Makefiles" -DEXIV2_TEAM_PACKAGING=ON
...
-- Build files have been written to: .../build
$ cmake --build . --config Release
...
[100%] Built target addmoddel
$ cmake --build . --target package
...
CPack: - package: /path/to/exiv2/build/exiv2-0.27.1-Linux.tar.gz generated.- Source Package
$ cmake --build . --target package_source
Run CPack packaging tool for source...
...
CPack: - package: /path/to/exiv2/build/exiv2-0.27.1-Source.tar.gz generated.- Generating and installing a debug library
In general to generate a debug library, you should use the CMake option -DCMAKE_RELEASE_TYPE=Debug and build in the usual way.
$ cd <exiv2dir>
$ mkdir build
$ cd build
$ cmake .. -G "Unix Makefiles" "-DCMAKE_BUILD_TYPE=Debug"
$ cmake --build .
You must install the library to ensure that your code is linked to the debug library.
You can check that you have generated a debug build with the command:
$ exiv2 -vVg debug
exiv2 0.27.1
debug=1
$- About preprocessor symbols
NDEBUGandEXIV2_DEBUG_MESSAGES
Exiv2 respects the symbol NDEBUG which is set only for Release builds. There are sequences of code which are defined within:
#ifdef EXIV2_DEBUG_MESSAGES
....
#endifThose blocks of code are not compiled unless you define EXIV2_DEBUG_MESSAGES. They are provided for additional debugging information. For example, if you are interested in additional output from webpimage.cpp, you can update your build as follows:
$ cd <exiv2dir> && cd build
$ cmake -DCMAKE_CXX_FLAGS=-DEXIV2_DEBUG_MESSAGES ..
$ cmake --build .
$ bin/exiv2 ...
-- or --
$ cmake --install .
$ exiv2 ...If you are debugging library code, it is recommended that you use the exiv2 command-line program as your test harness as Team Exiv2 is very familiar with this tool and able to give support.
- Starting the debugger
This is platform specific. On Linux:
$ gdb exiv2- Using Debugger IDEs such as Xcode, CLion, Visual Studio, Eclipse or QtCreator
I have used all those IDEs to debug the Exiv2 library and applications. All of them work. You may find it takes initial effort, however I assure you that they all work well.
I work on macOS and use Xcode to develop Exiv2. For a couple of years, Team Exiv2 had free
open-source licences from JetBrains for CLion. I really liked CLion as it is cross platform
and runs on Windows, Mac and Linux. It has excellent integration with CMake and will automatically
add -DCMAKE_BUILD_TYPE=Debug to the CMake command. It keeps build types in separate directories
such as <exiv2dir>/cmake-build-debug.
- cmake --build . options
--config Release|Debugand--target install
Visual Studio and Xcode can build debug or release builds without using the option -DCMAKE_BUILD_TYPE because the generated project files can build multiple types. The option --config Debug can be specified on the CMake command-line to specify the build type. Alternatively, if you prefer to build in the IDE, the UI provides options to select the configuration and target.
With the Unix Makefile generator, the targets can be listed:
$ cmake --build . --target help
The following are some of the valid targets for this Makefile:
... all (the default if no target is provided)
... clean
... depend
... install/local
.........- On Linux
$ cd <exiv2dir>
$ rm -rf build ; mkdir build ; cd build
$ cmake .. -DCMAKE_C_COMPILER=$(which clang) -DCMAKE_CXX_COMPILER=$(which clang++)
$ cmake --build .OR
$ export CC=$(which clang)
$ export CXX=$(which clang++)
$ cd <exiv2dir>
$ rm -rf build ; mkdir build ; cd build
$ cmake ..
$ cmake --build .- On macOS
Apple provide clang with Xcode. GCC has not been supported by Apple since 2013. The "normal unix build" uses Clang.
- On Cygwin, MinGW/msys2, Windows (using clang-cl) and Visual Studio.
I have been unable to get clang to work on any of those platforms.
To speed up compilation, the utility ccache can be installed to cache the output of the compiler. This greatly speeds up the build when you frequently built code that has not been modified.
Installing and using ccache (and other similar utilities), is platform dependent. On Ubuntu:
$ sudo apt install --yes ccacheTo build with ccache, use the CMake option -DBUILD_WITH_CCACHE=ON
$ cd <exiv2dir>
$ mkdir build ; cd build ; cd build
$ cmake .. -G "Unix Makefiles" -DBUILD_WITH_CCACHE=ON
$ cmake --build .
# Build again to appreciate the performance gain
$ cmake --build . --target clean
$ cmake --build .Due to the way in which ccache is installed in Fedora (and other Linux distros), ccache effectively replaces the compiler. A default build or -DBUILD_WITH_CCACHE=OFF is not effective and the environment variable CCACHE_DISABLE is required to disable ccache. Exiv2#361
Exiv2 heavily relies on standard C++ containers. Static or global variables are used read-only, with the exception of the XMP namespace registration function (see below). Thus Exiv2 is thread safe in the same sense as C++ containers: Different instances of the same class can safely be used concurrently in multiple threads.
In order to use the same instance of a class concurrently in multiple threads the application must serialize all write access to the object.
The level of thread safety within Exiv2 varies depending on the type of metadata: The Exif and IPTC code is reentrant. The XMP code uses the Adobe XMP toolkit (XMP SDK), which according to its documentation is thread-safe. It actually uses mutexes to serialize critical sections. However, the XMP SDK initialisation function is not mutex protected, thus Exiv2::XmpParser::initialize is not thread-safe. In addition, Exiv2::XmpProperties::registerNs writes to a static class variable, and is also not thread-safe.
Therefore, multi-threaded applications need to ensure that these two XMP functions are serialized, e.g., by calling them from an initialization section which is run before any threads are started. All exiv2 sample applications begin with:
#include <exiv2/exiv2.hpp>
int main(int argc, const char* argv[])
{
Exiv2::XmpParser::initialize();
::atexit(Exiv2::XmpParser::terminate);
#ifdef EXV_ENABLE_BMFF
Exiv2::enableBMFF(true);
#endif
...
}The use of the thread unsafe function Exiv2::enableBMFF(true) is discussed in Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)
As discussed in the section on Thread Safety, Exiv2 classes for Exif and IPTC metadata are fully reentrant and require no initialisation or cleanup.
Adobe's XMPsdk is generally thread-safe, however it has to be initialized and terminated before and after starting any threads to access XMP metadata. The Exiv2 library will initialize this if necessary, however it does not terminate the XMPsdk.
The exiv2 command-line program and sample applications call the following at the outset:
Exiv2::XmpParser::initialize();
::atexit(Exiv2::XmpParser::terminate);
#ifdef EXV_ENABLE_BMFF
Exiv2::enableBMFF(true);
#endifYou can cross compile Exiv2 on Linux for MinGW. We have used the following method on Fedora and believe this is also possible on Ubuntu and other distros. Detailed instructions are provided here for Fedora.
$ sudo dnf install mingw64-gcc-c++ mingw64-filesystem mingw64-expat mingw64-zlib cmake makeYou will need to install x86_64 libraries to support the options you wish to use. By default, you will need libz and expat. Your dnf command above has installed them for you. If you wish to use features such as webready you should install openssl and libcurl as follows:
[rmills@rmillsmm-fedora 0.27-maintenance]$ sudo yum install libcurl.x86_64 openssl.x86_64
Last metadata expiration check: 0:00:18 ago on Fri 10 Apr 2020 10:50:30 AM BST.
Dependencies resolved.
=========================
Package Architecture Version Repository Size
=========================
Installing:
...$ git clone://github.com/exiv2/exiv2 --branch 0.27-maintenance exiv2
$ cd exiv2
$ mkdir build_mingw_fedora
$ mingw64-cmake ..
$ makeNote, you may wish to choose to build with optional features and/or build static libraries. To do this, request appropriately on the mingw64-cmake command:
$ mingw64-cmake .. -DEXIV2_TEAM_EXTRA_WARNINGS=ON \
-DEXIV2_ENABLE_WEBREADY=ON \
-DBUILD_SHARED_LIBS=OFFThe options available for cross-compiling are the same as provided for all builds. See: Build Options
These DLLs are required to execute the cross-platform build in the bin from Windows
for i in libexpat-1.dll libgcc_s_seh-1.dll libstdc++-6.dll libwinpthread-1.dll zlib1.dll ; do
cp -v /usr/x86_64-w64-mingw32/sys-root/mingw/bin/$i bin
doneYou may wish to use wine to execute exiv2 from the command prompt. To do this:
[rmills@rmillsmm-fedora build_mingw_fedora]$ wine cmd
Microsoft Windows 6.1.7601
Z:\Home\gnu\github\exiv2\main\build_mingw_fedora>bin\exiv2
exiv2: An action must be specified
exiv2: At least one file is required
Usage: exiv2 [ option [ arg ] ]+ [ action ] file ...
Image metadata manipulation tool.If you have not installed wine, Fedora will offer to install it for you.
On a default wine installation, you are in the MSDOS/cmd.exe prompt. You cannot execute the exiv2 test suite in this environment as you require python3 and MSYS/bash to run the suite.
You should mount the your Fedora exiv2/ directory on a Windows machine on which you have installed MinGW/msys2. You will need python3 and make.
My build machines is a MacMini with VMs for Windows, Fedora and other platforms. On Fedora, I build in a Mac directory which is shared to all VMs.
[rmills@rmillsmm-fedora 0.27-maintenance]$ pwd
/media/psf/Home/gnu/github/exiv2/0.27-maintenance
[rmills@rmillsmm-fedora 0.27-maintenance]$ ls -l build_mingw_fedora/bin/exiv2.exe
-rwxrwxr-x. 1 rmills rmills 754944 Apr 10 07:44 build_mingw_fedora/bin/exiv2.exe
[rmills@rmillsmm-fedora 0.27-maintenance]$On MinGW/msys2, I can directly access the share:
$ cd //Mac/Home/gnu/github/exiv2/0.27/maintenance/build_mingw_fedora
$ mingw64-ctestYou will find that 3 tests fail at the end of the test suite. It is safe to ignore those minor exceptions.