# exiv2 **Repository Path**: downloadtool/exiv2 ## Basic Information - **Project Name**: exiv2 - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-06-15 - **Last Updated**: 2024-05-30 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README | Travis | AppVeyor | GitLab| Codecov| Repology| Matrix Chat | |:-------------:|:-------------:|:-----:|:------:|:-------:|:-----------:| | [![Build Status](https://travis-ci.org/Exiv2/exiv2.svg?branch=master)](https://travis-ci.org/Exiv2/exiv2) | [![Build status](https://ci.appveyor.com/api/projects/status/d6vxf2n0cp3v88al/branch/master?svg=true)](https://ci.appveyor.com/project/piponazo/exiv2-wutfp/branch/master) | [![pipeline status](https://gitlab.com/D4N/exiv2/badges/master/pipeline.svg)](https://gitlab.com/D4N/exiv2/commits/master) | [![codecov](https://codecov.io/gh/Exiv2/exiv2/branch/master/graph/badge.svg)](https://codecov.io/gh/Exiv2/exiv2) | [![Packaging status](https://repology.org/badge/tiny-repos/exiv2.svg)](https://repology.org/metapackage/exiv2/versions) | [![#exiv2-chat on matrix.org](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#exiv2-chat:matrix.org)
### TABLE OF CONTENTS 1. [Welcome to Exiv2](#1) 1. [Contact](#1-1) 2. [Building, Installing, Using and Uninstalling Exiv2](#2) 1. [Build, Install, Use and Uninstall Exiv2 on a UNIX-like system](#2-1) 2. [Build and Install Exiv2 with Visual Studio](#2-2) 3. [Build Options](#2-3) 4. [Dependencies](#2-4) 5. [Building and linking your code with Exiv2](#2-5) 6. [Consuming Exiv2 with CMake](#2-6) 7. [Using pkg-config to compile and link your code with Exiv2](#2-7) 8. [Localisation](#2-8) 9. [Building Exiv2 Documentation](#2-9) 10. [Building Exiv2 Packages](#2-10) 11. [Debugging Exiv2](#2-11) 12. [Building Exiv2 with Clang and other build chains](#2-12) 13. [Building Exiv2 with ccache](#2-13) 14. [Thread Safety](#2-14) 15. [Library Initialisation and Cleanup](#2-15) 3. [License and Support](#3) 1. [License](#3-1) 2. [Support](#3-2) 4. [Test Suit](#4) 1. [Running tests on a UNIX-like system](#4-1) 2. [Running tests on Visual Studio builds](#4-2) 3. [Unit tests](#4-3) 4. [Fuzzing](#4-4) 5. [Platform Notes](#5) 1. [Linux](#5-1) 2. [macOS](#5-2) 3. [MinGW](#5-3) 4. [Cygwin](#5-4) 5. [Microsoft Visual C++](#5-5) 6. [Unix](#5-6)
# Welcome to Exiv2 ![Exiv2](exiv2.png) 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 | |:------ |:---- | | Project Homepage | [https://github.com/Exiv2/exiv2](https://github.com/Exiv2/exiv2) | | Downloads and Documentation | [http://exiv2.dyndns.org](http://exiv2.dyndns.org) | | BuildServer: | [http://exiv2.dyndns.org:8080](http://exiv2.dyndns.org:8080) | | License (GPLv2) | [COPYING](COPYING) | | CMake Downloads | [https://cmake.org/download/](https://cmake.org/download/) | 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.
## 1.1 Contact Contact | Where? --------|------- Bug tracker | [Exiv2/exiv2](https://github.com/Exiv2/exiv2/issues) Matrix chat | [`#exiv2-chat:matrix.org`](https://matrix.to/#/#exiv2-chat:matrix.org) Announcement mailing list | [exiv2-announce](https://lists.sr.ht/~d4n/exiv2-announce) Discussion mailing list | [exiv2-discussion](https://lists.sr.ht/~d4n/exiv2-discussion) [TOC](#TOC)
## 2 Building, Installing, Using and Uninstalling Exiv2 You need [CMake](https://cmake.org/download/) to configure the Exiv2 project and a C++11 compiler.
### 2.1 Build, Install, Use Exiv2 on a UNIX-like system ```ShellSession cd $EXIV_ROOT mkdir build && cd build cmake .. -DCMAKE_BUILD_TYPE=Release cmake --build . make tests sudo make install ``` 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` #### Using the exiv2 command-line program To execute the exiv2 command line program, you should update your path to search /usr/local/bin/ ```ShellSession $ export PATH="/usr/local/bin:$PATH" ``` you'll also need to locate libexiv2 at run time: ```ShellSession $ export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH" # Linux, Cygwin, MinGW/msys2 $ export DYLD_LIBRARY_PATH="/usr/local/lib:$DYLD_LIBRARY_PATH" # macOS ``` [TOC](#TOC)
### 2.2 Build and Install Exiv2 with Visual Studio We recommend that you use conan to download the Exiv2 external dependencies on Windows (On Linux/macOS you can use or install system packages). Apart from handling the dependencies, to configure and compile the project is pretty similar to the UNIX like systems. See [README-CONAN](README-CONAN.md) for more information [TOC](#TOC)
### 2.3 Build options There are two groups of CMake options. There are many options defined by CMake. Here are some particularly useful options: | 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](#2-11)
Build exiv2lib as shared or static _**(On)**_ | Options defined by /CMakeLists.txt include: ```ShellSession $ ~/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 ) ... $ ~/gnu/github/exiv2/exiv2 $ ``` Options are defined on the CMake command line: ```ShellSession $ cmake -DBUILD_SHARED_LIBS=On -DEXIV2_ENABLE_NLS=OFF ``` [TOC](#TOC)
### 2.4 Dependencies The 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/](http://zlib.net/) | | XMP support | expat | ON | -DEXIV2\_ENABLE\_XMP=Off | [http://expat.sourceforge.net](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/](http://www.gnu.org/software/gettext/) | | Regex for gcc <= 4.8 | Boost::regex | OFF | autodetected | https://www.boost.org/users/download/ | 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. You can check the file `ci/install_dependencies.sh` for a list of packages that we install on different Linux distributions. This file is used to setup some CI images in which we use to test the Exiv2 compilation. Natural language system is discussed in more detail here: [Localisation](#2-8) Notes about different platforms are included here: [Platform Notes](#5) 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](README-CONAN.md) for more information. [TOC](#TOC)
### 2.5 Building and linking your code with Exiv2 There are detailed platform notes about linking code in releasenotes/platform/ReadMe.txt platform: { CYGWIN| Darwin | Linux | MinGW | msvc } In general you need to do the following: 1) Application code should be written in C++11 and include exiv2 headers: ```C++ #include ``` 2 Compile your C++ code with the directive: **`-I/usr/local/include`** 3 Link your code with libexiv2 using the linker options: **`-lexiv2`** and **`-L/usr/local/lib`** The following is a typical command to build and link with libexiv2: ```ShellSession $ g++ -std=c++11 myprog.cpp -o myprog -I/usr/local/include -L/usr/local/lib -lexiv2 ``` [TOC](#TOC)
### 2.6 Consuming Exiv2 with CMake When exiv2 is installed, the files required to consume Exiv2 are installed in `${CMAKE_INSTALL_PREFIX}/share/exiv2/cmake/` You can build samples/exifprint.cpp as follows: ```ShellSession $ cd $ mkdir exifprint $ cd exifprint $ *** EDIT CMakeLists.txt *** $ cat CMakeLists.txt cmake_minimum_required(VERSION 3.8) project(exifprint VERSION 0.0.1 LANGUAGES CXX) set(CMAKE_CXX_STANDARD 11) 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) # compile this target_link_libraries(exifprint exiv2) # link exiv2 $ cmake . # generate the makefile $ make # build the code $ ./exifprint # test your executable Usage: ./exifprint [ file | --version || --version-test ] $ ``` This [repository](https://github.com/piponazo/exiv2Consumer) shows an example of how to consume Exiv2 with CMake. [TOC](#TOC)
### 2.7 Using pkg-config to compile and link your code with Exiv2 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: ```ShellSession $ 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. ```ShellSession 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: ```ShellSession g++ -std=c++11 myprogram.cpp -o myprogram $(pkg-config exiv2 --libs --cflags) ``` [TOC](#TOC)
### 2.8 Localisation Localisation is supported on a UNIX-like platform: Linux, macOS, Cygwin and MinGW/msys2. Localisation is not supported for Visual Studio builds. 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/](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`. 1) Running exiv2 in another language ```ShellSession $ 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 [ options ] [ action ] fichier ... Manipulation des métadonnées EXIF issues des images. $ ``` 2) 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: ```ShellSession $ cd $ mkdir -p po/xy $ msginit --input=po/exiv2.pot --locale=xy --output=po/xy.po ``` 2.2) Edit/Translate the strings in po/xy.po I edited the following: ```ShellSession #: src/exiv2.cpp:237 msgid "Manipulate the Exif metadata of images.\n" msgstr "" ``` to: ```ShellSession #: src/exiv2.cpp:237 msgid "Manipulate the Exif metadata of images.\n" msgstr "Manipulate image metadata.\n" ``` 2.3) Generate the messages file: ```ShellSession $ mkdir -p po/xy/LC_MESSAGES $ msgfmt --output-file=po/xy/LC_MESSAGES/exiv2.mo po/xy.po ``` 2.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. ```ShellSession $ 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 [ options ] [ 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 $ ``` [TOC](#TOC)
### 2.9 Building Exiv2 Documentation Building documentation requires installing special tools. You will probably prefer to read the documentation on-line from the project website: http://exiv2.dyndns.org Additionally, complete copies of the project website are archived on the buildserver and can be downloaded for off-line use. http://exiv2.dyndns.org:8080/userContent/builds/Website/ To build documentation, use the CMake option **`-DEXIV2_BUILD_DOC=On`**. Additionally, you will require an additional build step to actually build the documentation. ```ShellSession $ cmake ..options.. -DEXIV2_BUILD_DOC=ON $ make doc ``` To build the documentation, you must install the following products: | Product | Availability | |:------------ |:------------ | | doxygen
graphviz
python
xsltproc
md5sum | [http://www.doxygen.org/](http://www.doxygen.org/)
[http://www.graphviz.org/](http://www.graphviz.org/)
[http://www.python.org/](http://www.python.org/)
[http://xmlsoft.org/XSLT/](http://xmlsoft.org/XSLT/)
[http://www.microbrew.org/tools/md5sha1sum/](http://www.microbrew.org/tools/md5sha1sum/) | [TOC](#TOC)
### 2.10 Building Exiv2 Packages 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. 1) Platform Package (header files, binary library and samples. Some documentation and release notes) Create and build exiv2 for your platform. ```ShellSession $ 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 $ make package ... CPack: - package: /path/to/exiv2/build/exiv2-0.27.0.1-Linux.tar.gz generated. ``` 2) Source Package ```ShellSession $ make package_source Run CPack packaging tool for source... ... CPack: - package: /path/to/exiv2/build/exiv2-0.27.0.1-Source.tar.gz generated. ``` You may prefer to run `$ cmake --build . --config Release --target package_source` [TOC](#TOC)
### 2.11 Debugging Exiv2 1) Generating and installing a debug library In general to generate a debug library, you should use the option *cmake* option `-DCMAKE_RELEASE_TYPE=Debug` and build in the usual way. ```ShellSession $ cd $ mkdir build $ cd build $ cmake .. -G "Unix Makefiles" "-DCMAKE_BUILD_TYPE=Debug" $ make ``` 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: ```ShellSession $ exiv2 -vVg debug exiv2 0.27.0.3 debug=1 $ ``` [TOC](#TOC) 2) About preprocessor symbols `NDEBUG` and `EXIV2_DEBUG_MESSAGES` Exiv2 respects the symbol `NDEBUG` which is set only for Release builds. There are sequences of code which are defined within: ```C++ #ifdef EXIV2_DEBUG_MESSAGES .... #endif ``` Those blocks of code are not compiled unless you define `EXIV2_DEBUG_MESSAGES` by yourself. 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: ```ShellSession $ cd $ touch src/webpimage.cpp $ make CXXFLAGS=-DEXIV2_DEBUG_MESSAGES $ bin/exiv2 ... -- or -- $ sudo make install $ exiv2 ... ``` If you are debugging library code, it is recommended that you use the exiv2 command-line as your test harness as Team Exiv2 is very familiar with this tool and able to give support. [TOC](#TOC) 3) Starting the debugger This is platform specific. On Linux: ```ShellSession $ gdb exiv2 ``` [TOC](#TOC) 4) 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 personally use CLion which has excellent integration with CMake. It will automatically add **`-DCMAKE_BUILD_TYPE=Debug`** to the cmake command. It keeps build types in separate directories such as **`/cmake-build-debug`**. [TOC](#TOC) 5) cmake --build . options **`--config Release|Debug`** and **`--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 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: ```ShellSession $ make help The following are some of the valid targets for this Makefile: ... all (the default if no target is provided) ... clean ... depend ... install/local ......... ``` [TOC](#TOC)
### 2.12 Building Exiv2 with **clang** and other build chains 1) On Linux ```ShellSession $ cd $ rm -rf build ; mkdir build ; cd build $ cmake .. -DCMAKE_C_COMPILER=$(which clang) -DCMAKE_CXX_COMPILER=$(which clang++) $ cmake --build . ``` **_OR_** ```ShellSession $ export CC=$(which clang) $ export CXX=$(which clang++) $ cd $ rm -rf build ; mkdir build ; cd build $ cmake .. $ cmake --build . ``` 2) On macOS Apple provide clang with Xcode. GCC has not been supported by Apple since 2013. The _"normal unix build"_ uses Clang. 3) 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. 4) Cross Compiling I've never succeeded in getting this to work. I use different VMs for Linux 32 and 64 bit. I've documented how to set up Cygwin and MinGW/msys2 for 64 and 32 bit builds in [README-CONAN](README-CONAN.md) [TOC](#TOC)
### 2.13 Building Exiv2 with ccache 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: ```ShellSession $ sudo apt install --yes ccache ``` To build with ccache, use the cmake option **-DBUILD\_WITH\_CCACHE=On** ```ShellSession $ cd $ mkdir build ; cd build ; cd build $ cmake .. -G "Unix Makefiles" -DBUILD_WITH_CCACHE=On $ make # Build again to appreciate the performance gain $ make clean $ make ``` 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. [https://github.com/Exiv2/exiv2/issues/361](https://github.com/Exiv2/exiv2/issues/361) [TOC](#TOC)
### 2.14 Thread Safety 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. [TOC](#TOC)
### 2.15 Library Initialisation and Cleanup 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 and the sample applications call the following at the outset: ``` Exiv2::XmpParser::initialize(); ::atexit(Exiv2::XmpParser::terminate); ``` [TOC](#TOC)
## 3 License and Support All project resources are accessible from the project website. https://github.com/Exiv2/exiv2
### 3.1 License Copyright (C) 2004-2019 Exiv2 authors. You should have received a copy of the file [COPYING](COPYING) which details the GPLv2 license. Exiv2 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. Exiv2 program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. [TOC](#TOC)
### 3.2 Support For new bug reports and feature requests, please open an issue in Github. [TOC](#TOC)
## 4 Running the test suite The test suite is a mix of bash and python scripts (in addition to the unit tests written in C++). The python scripts are new to v0.27 and the bash scripts are being replaced as time permits.
### 4.1 Running tests on a UNIX-like system You can run the suite directly from the build: ```ShellSession $ cmake .. -G "Unix Makefiles" $ make ... $ make tests ... lots of output ... Summary report ``` You can run individual tests in the test directory using the environment variable EXIV2\_BINDIR to specify the location of the build artifacts. For Cygwin and MinGW/msys builds, also set EXIV2_EXT=.exe ```ShellSession $ ~/gnu/github/exiv2/exiv2/build $ cd ../test $ ~/gnu/github/exiv2/exiv2/test $ env EXIV2_BINDIR=${PWD}/../build/bin ./icc-test.sh ICC jpg md5 webp md5 png md5 jpg md5 all testcases passed. $ ~/gnu/github/exiv2/exiv2/test $ env EXIV2_BINDIR=${PWD}/../build/bin make newtests ``` [TOC](#TOC)
### 4.2 Running tests on Visual Studio builds Use the bash interpreter for MinGW/msys2 to run the test suite. It's essential to have a DOS Python3 interpreter on your path. The variables EXIV2\_BINDIR and EXIV2\_EXT enable the test suite to locate the MSVC build artifacts. ```ShellSession $ cd /build $ cd ../test $ PATH="/c/Python36:$PATH" $ export EXIV2_EXT=.exe $ export EXIV2_BINDIR=${PWD}/../build/bin ``` Once you have modified the PATH and and exported EXIV2\_BINDIR and EXIV2\_EXT, you can execute the test suite as described for UNIX-like systems: ```ShellSession $ cd /test $ make test $ make newtests $ ./icc-test.sh ``` [TOC](#TOC)
### 4.3 Unit tests The code for the unit tests is in `/unitTests` To build the unit tests, use the *cmake* option `-DEXIV2_BUILD_UNIT_TESTS=ON`. Note that we depends on GTest and GMock for being able to compile and run those tests. To execute the unit tests: ```ShellSession $ cd /build $ bin/unit_tests # Alternatively you can run them with CTest $ cd /build $ ctest ``` ### 4.4 Fuzzing The code for the fuzzers is in `exiv2dir/fuzz` To build the fuzzers, use the *cmake* option `-DEXIV2_BUILD_FUZZ_TESTS=ON` and `-DEXIV2_TEAM_USE_SANITIZERS=ON`. Note that it only works with clang compiler as libFuzzer is integrate with clang > 6.0 To build the fuzzers: ```ShellSession export CXX=clang++ export CC=clang cmake .. -G "Unix Makefiles" "-DEXIV2_BUILD_FUZZ_TESTS=ON" "-DEXIV2_TEAM_USE_SANITIZERS=ON" make -j4 ``` To execute the fuzzers: ```ShellSession cd /build bin/ # for example ./bin/read-metadata.cpp ``` [TOC](#TOC)
## 5 Platform Notes There are many ways to set up and configure your platform. The following notes are provided as a guide.
### 5.1 Linux Update your system and install the build tools and dependencies (zlib, expat, gtest and others) ```ShellSession $ sudo apt --yes update $ sudo apt install --yes build-essential git clang ccache python3 libxml2-utils cmake python3 libexpat1-dev libz-dev zlib1g-dev libssh-dev libcurl4-openssl-dev libgtest-dev google-mock ``` Get the code from GitHub and build ```ShellSession $ mkdir -p ~/gnu/github/exiv2 $ cd ~/gnu/github/exiv2 $ git clone https://github.com/exiv2/exiv2 $ cd exiv2 $ mkdir build ; cd build ; $ cmake .. -G "Unix Makefiles" $ make ``` #### 5.1.1 CentOS/RHEL 7 CentOS/RHEL 7 comes with gcc 4.8, which is compatible with C++11, but unfortanely ships a broken implementation of ``. We work around this issue by falling back to using `boost::regex` in this case. To build exiv2 on CentOS, please install the following additional packages: - `cmake3` - `boost-devel` - `boost-regex` [TOC](#TOC)
### 5.2 macOS You will need to install Xcode and the Xcode command-line tools to build on the Mac. You should build and install libexpat and zlib. You may use brew, macports, build from source, or use conan. I recommend that you build and install CMake from source. [TOC](#TOC)
### 5.3 MinGW We provide support for both 64bit and 32bit builds using MinGW/msys2. [https://www.msys2.org](https://www.msys2.org) Support for MinGW/msys1.0 32 bit build was provided for Exiv2 v0.26. MinGW/msys1.0 is not supported by Team Exiv2 for Exiv2 v0.27 and later. There is a discussion on the web about installing GTest: [https://github.com/Exiv2/exiv2/issues/575](https://github.com/Exiv2/exiv2/issues/575) #### MinGW/msys2 64 bit Install: [http://repo.msys2.org/distrib/x86\_64/msys2-x86\_64-20180531.exe](http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20180531.exe) I use the following batch file to start the MinGW/msys2 64 bit bash shell from the Dos Command Prompt (cmd.exe) ```bat @echo off setlocal set "PATH=c:\msys64\usr\bin;c:\msys64\usr\local\bin;" set "HOME=c:\msys64\home\rmills" if NOT EXIST %HOME% mkdir %HOME% cd %HOME% set "PS1=\! MSYS64:\u@\h:\w \$ " bash.exe -norc ``` #### MinGW/msys2 32 bit Install: [http://repo.msys2.org/distrib/i686/msys2-i686-20180531.exe](http://repo.msys2.org/distrib/i686/msys2-i686-20180531.exe) I use the following batch file to start the MinGW/msys2 32 bit bash shell from the Dos Command Prompt (cmd.exe) ```bat @echo off setlocal set "PATH=c:\msys32\usr\bin;c:\msys32\usr\local\bin;" set "HOME=c:\msys32\home\rmills" if NOT EXIST %HOME% mkdir %HOME% cd %HOME% set "PS1=\! MSYS32:\u@\h:\w \$ " bash.exe -norc ``` #### Install MinGW Dependencies Install tools and dependencies: ```ShellSession $ for i in base-devel git cmake coreutils python3 man gcc gdb make dos2unix diffutils zlib-devel libexpat-devel libiconv-devel gettext-devel; do (echo y|pacman -S $i); done ``` You can upgrade all installed packages on your system with the following command. For me, this broke msys32 and I had to reinstall msys32 and all the dependencies. Your experience may be different. ```ShellSession $ pacman -Syu ``` #### Download exiv2 from github and build ```ShellSession $ mkdir -p ~/gnu/github/exiv2 $ cd ~/gnu/github/exiv2 $ git clone https://github.com/exiv2/exiv2 $ cd exiv2 $ mkdir build ; cd build ; $ cmake .. -G "Unix Makefiles" $ make ``` [TOC](#TOC)
### 5.4 Cygwin Download: [https://cygwin.com/install.html](https://cygwin.com/install.html) and run setup-x86_64.exe for 64 Bit Cygwin, or setup-x86.exe for 32 bit Cygwin. I install into c:\\cygwin64 and c:\\cygwin32 You need: make, cmake, gcc, gettext-devel pkg-config, dos2unix, zlib-devel, libexpat1-devel, git, python3-interpreter, libiconv, libxml2-utils, libncurses. Download and build libiconv-1.15: [https://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.15.tar.gz](https://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.15.tar.gz) There is a discussion on the web about installing GTest: [https://github.com/Exiv2/exiv2/issues/575](https://github.com/Exiv2/exiv2/issues/575) Download and build cmake from source because I can't get the cygwin installed cmake 3.6.2 to work. To build cmake from source, you need libncurses. [https://cmake.org/download/](https://cmake.org/download/) I use the following batch file "cygwin64.bat" to start the Cygwin/64 bit bash shell from the Dos Command Prompt (cmd.exe). ```bat @echo off setlocal set "PATH=c:\cygwin64\usr\local\bin;c:\cygwin64\bin;c:\cygwin64\usr\bin;c:\cygwin64\usr\sbin;" if NOT EXIST %HOME% mkdir %HOME% set "HOME=c:\cygwin64\home\rmills" cd %HOME% set "PS1=\! CYGWIN64:\u@\h:\w \$ " bash.exe -norc ``` [TOC](#TOC)
### 5.5 Microsoft Visual C++ We recommend that you use Conan to build Exiv2 using Microsoft Visual C++. Since we require a C++11 compiler, we only support the Visual Studio versions 2015 and 2017. As well as Microsoft Visual Studio, you will need to install CMake, Python3, and Conan. 1) Binary installers for CMake on Windows are availably from [https://cmake.org/download/](https://cmake.org/download/).
2) Binary installers for Python3 are available from [python.org](https://python.org)
3) Conan can be installed using python/pip. Details in [README-CONAN.md](README-CONAN.md) I use the following batch file to start cmd.exe. I do this to reduce the complexity of the path which grows as various tools are installed on Windows. The purpose of this script is to ensure a "stripped down path". ```bat @echo off setlocal cd %HOMEPATH% set "PATH=C:\Python34\;C:\Python27\;C:\Python27\Scripts;C:\Perl64\site\bin;C:\Perl64\bin;C:\WINDOWS\system32;C:\Program Files\Git\cmd;C:\Program Files\Git\usr\bin;c:\Program Files\cmake\bin;" cmd ``` [TOC](#TOC)
### Unix Exiv2 can be built on many Unix and Linux distros. We actively support the Unix Distributions NetBSD and FreeBSD. I am willing to support Exiv2 on commercial Unix distributions such as Solaris, AIX, HP-UX and OSF/1 provided you provide with an ssh account on your platform. I will require super-user privileges to install software. #### NetBSD You can build exiv2 from source using the methods described for linux. I built and installed exiv2 using "Pure CMake" and didn't require conan. You will want to use the package manager `pkgsrc` to build/install: 1. gcc (currently GCC 5.5.0) 2. python3 3. cmake 4. bash 5. sudo 6. chksum 7. gettext I entered links into the file system `# ln -s /usr/pkg/bin/python37 /usr/local/bin/python3` and `# ln -s /usr/pkg/bin/bash /bin/bash` It's important to ensure that `LD_LIBRARY_PATH` includes `/usr/local/lib` and `/usr/pkg/lib`. It's important to ensure that PATH includes `/usr/local/bin`, `/usr/pkg/bin` and `/usr/pkg/sbin`. #### FreeBSD FreeBSD uses pkg as the package manager. You should install the dependency expat. libz is already installed. As with NetBSD, you should use pkg to install python3, cmake, bash, sudo, gettext and gcc. The default GCC compiler is currently 8.3.0. [TOC](#TOC) Written by Robin Mills Revised: 2019-08-03