| Travis | AppVeyor | GitLab | Codecov |
|---|---|---|---|
 |
 |
 |
- 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
- 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 Packages
- Debugging Exiv2
- Building Exiv2 with Clang and other build chains
- Building Exiv2 with ccache
- License and Support
- Test Suit
- Platform Notes
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 |
| Downloads and Documentation | http://exiv2.dyndns.org |
| BuildServer: | http://exiv2.dyndns.org:8080 |
| License (GPLv2) | license.txt |
| CMake Downloads | 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.
You need CMake to build Exiv2: https://cmake.org/download/
### 2.1 Build, Install, Use, Uninstall Exiv2 on a UNIX-like system$ cd <exiv2dir> ; mkdir build ; cd build
$ cmake .. -G "Unix Makefiles" ; cmake --build . ; make test
$ sudo make installThis 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
To execute the exiv2 command line program, you should update your path to search /usr/local/bin/
$ export PATH="/usr/local/bin:$PATH"you'll 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" # MacOS-X$ sudo make uninstallWe recommend that you use conan with CMake to build Exiv2 with Visual Studio. See README-CONAN for more information
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 Build exiv2lib as shared or static (On) |
Options defined by /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 )
...
577 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $Options are defined on the CMake command line:
$ cmake -DBUILD_SHARED_LIBS=On -DEXIV2_ENABLE_NLS=OFFThe following Exiv2 features are enabled by default and require external libraries. You can disable the dependency with CMake options:
| Feature | Package | cmake option to disable | Availability |
|---|---|---|---|
| PNG image support | zlib | -DEXIV2_ENABLE_PNG=Off | http://zlib.net/ |
| Native language support | gettext | -DEXIV2_ENABLE_NLS=Off | http://www.gnu.org/software/gettext/ |
| XMP support | expat | -DEXIV2_ENABLE_XMP=Off | http://expat.sourceforge.net/ Use Expat 2.2.6 and later |
On Linux, 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 static libraries required to build Exiv2.
Notes about different platforms are included in this document: 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.
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:
- Application code should be written in C++ 98 and include exiv2 headers:
#include <exiv2/exiv2.hpp>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:
$ g++ -std=c++98 myprog.cpp -o myprog -I/usr/local/include -L/usr/local/lib -lexiv2When 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:
$ cd <exiv2dir>
$ 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}/share/exiv2/cmake/
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 ]
$The default cmake Generator is usually appropriate for your platform. Additional information concerning Generators for Visual Studio in README-CONAN
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++98 myprogram.cpp -o myprogram $(pkg-config exiv2 --libs --cflags)Localisation is supported on a UNIX-like platform: Linux, MacOS-X, Cygwin and MinGW/msys2. Localisation is not supported for Visual Studio builds.
To build localisation support, use the CMake option -DEXIV2_BUILD_PO=On. There are no additional build steps as the normal build commands will compile the library, samples and localisation support. You must install the build to ensure the localisation message files can be found at run-time.
- Running exiv2 in a foreign 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 [ options ] [ action ] fichier ...
Manipulation des métadonnées EXIF issues des images.
$- 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 "Manipulate the Exif metadata of images.\n"
msgstr ""to:
#: src/exiv2.cpp:237
msgid "Manipulate the Exif metadata of images.\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 message file from the build/bin directory.
$ sudo cp -R po/xy /usr/local/share/locale/xy
$ 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:
Open a new issue on https://github.com/exiv2/exiv2 and attach the file po/xy/exiv2.po
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.
$ cmake ..options.. -DEXIV2_BUILD_DOC=On
$ make 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/ |
To enable building of 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
$ make package
...
CPack: - package: /path/to/exiv2/build/exiv2-0.27.0.1-Linux.tar.gz generated.- Source Package
$ 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
- 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.
$ cd <exiv2dir>
$ mkdir build
$ cd build
$ cmake .. -G "Unix Makefiles" "-DCMAKE_BUILD_TYPE=Debug"
$ make
$ sudo make installYou 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.0.3
debug=1
$- About preprocessor symbols NDEBUG and DEBUG
In accordance with current practice, exiv2 respects the symbol NDEBUG which is set for Release builds. There are sequences of code which are defined within:
#ifdef DEBUG
....
#endifThose blocks of code are not compiled for debug builds. They are provided for additional debugging information. For example, if you are interested in additonal output from webpimage.cpp, you can update your build as follows:
$ cd <exiv2dir>
$ touch src/webpimage.cpp
$ make CXXFLAGS=-DDEBUG
$ 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.
- 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 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 <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 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:
$ 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
.........- 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-X
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.
- 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
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
$ make
# Build again to appreciate the performance gain
$ make clean
$ makeDue 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
All project resources are accessible from the project website. https://github.com/Exiv2/exiv2
### 3.1 LicenseCopyright (C) 2004-2018 Exiv2 authors. You should have received a copy of the file license.txt 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 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, 5th Floor, Boston, MA 02110-1301 USA.
For new bug reports and feature requests, please open an issue in Github.
The test suite is a mix of bash and python scripts. 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 systemYou can run the suite directly from the build:
$ cmake .. -G "Unix Makefiles"
$ make
...
$ make tests
... lots of output ...
Summary reportYou 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
rmills@rmillsmbp-w7 ~/gnu/github/exiv2/exiv2/build $ cd ../test
rmills@rmillsmbp-w7 ~/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.
rmills@rmillsmbp-w7 ~/gnu/github/exiv2/exiv2/test $ env EXIV2_BINDIR=${PWD}/../build/bin make newtestsUse 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.
$ cd <exiv2dir>/build
$ cd ../test
$ PATH="/c/Python36:$PATH"
$ export EXIV2_EXT=.exe
$ export EXIV2_BINDIR=${PWD}/../build/binOnce 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:
$ cd <exiv2dir>/test
$ make test
$ make newtests
$ ./icc-test.shThe code for the unit tests is in <exiv2dir>/unitTests
To build the unit tests, use the cmake option -DEXIV2_BUILD_UNIT_TESTS=On.
To execute the unit tests:
$ cd <exiv2dir>/build
$ bin/unit_testsThere are many ways to set up and configure your platform. The following notes are provided as a guide.
### 5.1 LinuxUpdate your system and install the build tools.
sudo apt --yes update
sudo apt install --yes build-essential git libxml2-utils cmake python3 libexpat1-dev libz-devGet the code from GitHub and build
$ 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"
$ makeYou 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.
We provide support for both 64bit and 32bit builds using MinGW/msys2. 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.
Install: 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)
@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 -norcInstall: 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)
@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 -norcInstall tools and dependencies:
$ 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); doneYou 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.
$ pacman -Syu$ 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"
$ makeThe exiv2 command line program provides an option --grep to filter output. The implementation requires the header file <regex.h> and supporting library to be available during the build. When not available, the option --grep degrades to a substring match. Because there are several versions of <regex.h> available on the MinGW platform, detection of regex is always disabled on this platform and uses substring match. The following command reveals if regex is included in your build:
$ exiv2 -vVg regex
exiv2 0.27.0.3
have_regex=1
$Download: 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
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/
I use the following batch file "cygwin64.bat" to start the Cygwin/64 bit bash shell from the Dos Command Prompt (cmd.exe).
@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 -norcWe recommend that you use Conan to build Exiv2 using Microsoft Visual C++. For v0.27, we support Visual Studio 2008, 2010, 2012, 2013, 2015 and 2017.
As well as Microsoft Visual Studio, you will need to install CMake, Python3, and Conan.
- Binary installers for CMake on Windows are availably from https://cmake.org/download/.
- Binary installers for Python3 are available from python.org
- Conan can be installed using python/pip. Details in 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".
@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;"
cmdWritten by Robin Mills
[email protected]
Updated: 2018-11-28