Exiv2 · clanmills · Mar 10, 2021 · Jan 24, 2021 · Jan 24, 2021 · Jan 25, 2021
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ xcode_build*
 msvc_build*
 cygwin_build*
 mingw_build*
+linux_build*
 po/POTFILES
 po/remove-potcdate.sed
 po/stamp-po

diff --git a/.travis.yml b/.travis.yml
@@ -6,7 +6,7 @@ git:
 
 env:
   global:
-    - COMMON_CMAKE_OPTIONS="-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_ENABLE_CURL=ON -DEXIV2_BUILD_UNIT_TESTS=ON -DEXIV2_TEAM_WARNINGS_AS_ERRORS=ON -DCMAKE_INSTALL_PREFIX=install"
+    - COMMON_CMAKE_OPTIONS="-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_ENABLE_CURL=ON -DEXIV2_BUILD_UNIT_TESTS=ON -DEXIV2_ENABLE_BMFF=ON -DEXIV2_TEAM_WARNINGS_AS_ERRORS=ON -DCMAKE_INSTALL_PREFIX=install"
 
 matrix:
   include:

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,6 +25,7 @@ option( EXIV2_ENABLE_WIN_UNICODE      "Use Unicode paths (wstring) on Windows"
 option( EXIV2_ENABLE_WEBREADY         "Build webready support into library"                   OFF )
 option( EXIV2_ENABLE_CURL             "USE Libcurl for HttpIo (WEBREADY)"                     OFF )
 option( EXIV2_ENABLE_SSH              "USE Libssh for SshIo (WEBREADY)"                       OFF )
+option( EXIV2_ENABLE_BMFF             "Build with BMFF support"                               OFF )
 
 option( EXIV2_BUILD_SAMPLES           "Build sample applications"                             ON  )
 option( EXIV2_BUILD_EXIV2_COMMAND     "Build exiv2 command-line executable"                   ON  )

diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ The file ReadMe.txt in a build bundle describes how to install the library on th
    16. [Cross Platform Build and Test on Linux for MinGW](#2-16)
    17. [Building with C++11 and other compilers](#2-17)
    18. [Static and Shared Libraries](#2-18)
+   19. [Support for bmff files (CR3, HIF, AVIF and HEIC)](#2-19)
 3. [License and Support](#3)
     1. [License](#3-1)
     2. [Support](#3-2)
@@ -127,6 +128,7 @@ 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"                OFF )
 577 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $
 ```
 
@@ -581,13 +583,18 @@ The level of thread safety within Exiv2 varies depending on the type of metadata
 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:
 
 ```cpp
+#include <exiv2/exiv2.hpp>
 int main(int argc, const char* argv[])
 {
     Exiv2::XmpParser::initialize();
     ::atexit(Exiv2::XmpParser::terminate);
+#if EXIV2_TEST_VERSION(0,27,4)
+    Exiv2::enableBMFF(true);
+#endif
     ...
 }
 ```
+The use of the _**thread unsafe function**_ Exiv2::enableBMFF(true) is discussed in [2.19 Support for bmff files](#2-19)
 
 [TOC](#TOC)
 
@@ -604,6 +611,7 @@ The exiv2 command-line program and sample applications call the following at the
 ```cpp
     Exiv2::XmpParser::initialize();
     ::atexit(Exiv2::XmpParser::terminate);
+    Exiv2::enableBMFF(true);
 ```
 
 [TOC](#TOC)
@@ -773,6 +781,24 @@ This is discussed: [https://github.com/Exiv2/exiv2/issues/1230](https://github.c
 
 [TOC](#TOC)
 
+<div id="2-19">
+
+2.19 Support for bmff files (CR3, HIF, AVIF and HEIC)
+
+**Attention is drawn to the possibility that bmff support may be the subject of patent rights. _Exiv2 shall not be held responsible for identifying any or all such patent rights.  Exiv2 shall not be held responsible for the legal consequences of the use of this code_.**
+
+Access to the bmff code is guarded in two ways.  Firstly, you have to build the library with the cmake option: `-DEXIV2_ENABLE_BMFF=On`.  Secondly, the application must enable bmff support at run-time by calling the following function.
+
+```cpp
+EXIV2API bool enableBMFF(bool enable);
+```
+
+Applications may wish the provide a preference setting to enable bmff support and thereby place the responsibility for the use of this code with the user of the application.
+
+It is recommended that you enclose the call to `enableBMFF()` with the compile time macro EXIV2\_TEST\_VERSION to ensure that your code builds cleanly on earlier versions of Exiv2.  It is recommended that you call enableBMFF() at process start-up as it is not threadsafe.  A code snippet is provided in [2.14 Thread Safety](#2-14).
+
+[TOC](#TOC)
+
 <div id="3">
 
 ## 3 License and Support
@@ -784,7 +810,7 @@ All project resources are accessible from the project website.
 
 ### 3.1 License
 
-Copyright (C) 2004-2019 Exiv2 authors.
+Copyright (C) 2004-2021 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
@@ -1092,6 +1118,8 @@ Please note that the platform MinGW/msys2 32 is obsolete and superceded by MinGW
 #### MinGW/msys2 64 bit
 Install: [https://repo.msys2.org/distrib/x86\_64/msys2-x86\_64-20200903.exe](https://repo.msys2.org/distrib/x86_64/msys2-x86_64-20200903.exe)
 
+The file `appveyor_mingw_cygwin.yml` has instructions to configure the AppVeyor CI to configures itself to build Exiv2 on MinGW/msys2 and Cygwin/64.
+
 I use the following batch file to start the MinGW/msys2 64 bit bash shell from the Dos Command Prompt (cmd.exe)
 
 ```bat
@@ -1154,7 +1182,9 @@ Please note that the platform Cygwin/32 is obsolete and superceded by Cygwin/64.
 Download: [https://cygwin.com/install.html](https://cygwin.com/install.html) and run setup-x86_64.exe.  I install into c:\\cygwin64
 
 You need:
-make, cmake, curl, gcc, gettext-devel pkg-config, dos2unix, tar, zlib-devel, libexpat1-devel, git, python3-interpreter, libiconv, libxml2-utils, libncurses
+make, cmake, curl, gcc, gettext-devel pkg-config, dos2unix, tar, zlib-devel, libexpat1-devel, git, libxml2-devel python3-interpreter, libiconv, libxml2-utils, libncurses, libxml2-devel libxslt-devel python38 python38-pip python38-libxml2
+
+The file `appveyor_mingw_cygwin.yml` has instructions to configure the AppVeyor CI to configures itself to build Exiv2 on MinGW/msys2 and Cygwin/64.
 
 To build unit tests, you should install googletest-release-1.8.0 as discussed [4.3 Unit tests](#4-3)
 
@@ -1304,5 +1334,5 @@ $ sudo pkg install developer/gcc-7
 
 [TOC](#TOC)
 
-Written by Robin Mills<br>robin@clanmills.com<br>Updated: 2020-11-20
+Written by Robin Mills<br>robin@clanmills.com<br>Updated: 2021-03-05
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -74,7 +74,7 @@ build_script:
     - cmd: conan --version
     - cmd: conan install .. -o webready=%WEBREADY% --build missing
     - cmd: echo %CMAKE_GENERATOR%
-    - cmd: cmake -G "%CMAKE_GENERATOR%" -DEXIV2_TEAM_WARNINGS_AS_ERRORS=%WARNINGS_AS_ERRORS% -DCMAKE_BUILD_TYPE=Release -DEXIV2_ENABLE_NLS=OFF -DEXIV2_ENABLE_PNG=ON -DEXIV2_ENABLE_WEBREADY=%WEBREADY% -DEXIV2_BUILD_UNIT_TESTS=%UNIT_TESTS% -DCMAKE_INSTALL_PREFIX=install ..
+    - cmd: cmake -G "%CMAKE_GENERATOR%" -DEXIV2_TEAM_WARNINGS_AS_ERRORS=%WARNINGS_AS_ERRORS% -DCMAKE_BUILD_TYPE=Release -DEXIV2_ENABLE_NLS=OFF -DEXIV2_ENABLE_PNG=ON -DEXIV2_ENABLE_BMFF=ON -DEXIV2_ENABLE_WEBREADY=%WEBREADY% -DEXIV2_BUILD_UNIT_TESTS=%UNIT_TESTS% -DCMAKE_INSTALL_PREFIX=install ..
     - cmd: cmake --build . --config Release
     - cmd: cmake --build . --config Release --target install
     - cmd: cd bin

diff --git a/ci/install.sh b/ci/install.sh
@@ -10,11 +10,12 @@ python3 --version
 if [[ "$(uname -s)" == 'Linux' ]]; then
     sudo apt-get update
 
+    sudo apt-get install cmake
     if [[ "$(lsb_release -cs)" == 'focal' ]]; then
         # In Ubuntu 20.04 python-pip does not exist. Furthermore we need to have the alias python for python3
-        sudo apt-get install cmake zlib1g-dev libssh-dev python3-pip python-is-python3 libxml2-utils
+        sudo apt-get install zlib1g-dev libssh-dev python3-pip python-is-python3 libxml2-utils
     else
-        sudo apt-get install cmake zlib1g-dev libssh-dev python-pip libxml2-utils
+        sudo apt-get install zlib1g-dev libssh-dev python-pip libxml2-utils
     fi
 
     if [ -n "$WITH_VALGRIND" ]; then

diff --git a/ci/test_build.py b/ci/test_build.py
@@ -117,7 +117,7 @@ def run(cmd):
         type=str,
         nargs='?',
         default="-DEXIV2_TEAM_EXTRA_WARNINGS=ON -DEXIV2_ENABLE_VIDEO=ON "
-        "-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_BUILD_UNIT_TESTS=ON "
+        "-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_BUILD_UNIT_TESTS=ON -DEXIV2_ENABLE_BMFF=ON "
         "-DBUILD_WITH_CCACHE=ON -DEXIV2_ENABLE_CURL=ON"
     )
 

diff --git a/cmake/compilerFlagsExiv2.cmake b/cmake/compilerFlagsExiv2.cmake
@@ -1,8 +1,14 @@
 # These flags only applies to exiv2lib, and the applications, but not to the xmp code
 
+include(CheckCXXCompilerFlag)
+
 if (COMPILER_IS_GCC OR COMPILER_IS_CLANG) # MINGW, Linux, APPLE, CYGWIN
     if ( EXIV2_TEAM_WARNINGS_AS_ERRORS )
         add_compile_options(-Werror -Wno-error=deprecated-declarations)
+        check_cxx_compiler_flag(-Wno-error=deprecated-copy DEPRECATED_COPY)
+        if ( DEPRECATED_COPY) 
+            add_compile_options(-Wno-error=deprecated-copy)
+        endif ()
     endif ()
 
     if ( EXIV2_TEAM_EXTRA_WARNINGS )

diff --git a/cmake/config.h.cmake b/cmake/config.h.cmake
@@ -18,6 +18,9 @@
 // Define if you want translation of program messages to the user's native language
 #cmakedefine EXV_ENABLE_NLS
 
+// Define if you want BMFF support.
+#cmakedefine EXV_ENABLE_BMFF
+
 // Define if you want video support.
 #cmakedefine EXV_ENABLE_VIDEO
 

diff --git a/cmake/generateConfigFile.cmake b/cmake/generateConfigFile.cmake
@@ -7,6 +7,7 @@ if (${EXIV2_ENABLE_WEBREADY})
     set(EXV_USE_SSH   ${EXIV2_ENABLE_SSH})
     set(EXV_USE_CURL  ${EXIV2_ENABLE_CURL})
 endif()
+set(EXV_ENABLE_BMFF   ${EXIV2_ENABLE_BMFF})
 set(EXV_ENABLE_VIDEO     ${EXIV2_ENABLE_VIDEO})
 set(EXV_ENABLE_WEBREADY  ${EXIV2_ENABLE_WEBREADY})
 set(EXV_HAVE_LENSDATA    ${EXIV2_ENABLE_LENSDATA})

diff --git a/cmake/printSummary.cmake b/cmake/printSummary.cmake
@@ -50,6 +50,7 @@ if    ( EXIV2_ENABLE_EXTERNAL_XMP )
 else()
     OptionOutput( "XMP metadata support:               " EXIV2_ENABLE_XMP            )
 endif()
+OptionOutput( "Building BMFF support:              " EXIV2_ENABLE_BMFF               )
 OptionOutput( "Native language support:            " EXIV2_ENABLE_NLS                )
 OptionOutput( "Conversion of Windows XP tags:      " EXIV2_ENABLE_PRINTUCS2          )
 OptionOutput( "Nikon lens database:                " EXIV2_ENABLE_LENSDATA           )

diff --git a/include/exiv2/CMakeLists.txt b/include/exiv2/CMakeLists.txt
@@ -1,6 +1,7 @@
 install(FILES
             asfvideo.hpp
             basicio.hpp
+            bmffimage.hpp
             bmpimage.hpp
             config.h
             convert.hpp

diff --git a/include/exiv2/bmffimage.hpp b/include/exiv2/bmffimage.hpp
@@ -0,0 +1,170 @@
+// ***************************************************************** -*- C++ -*-
+/*
+ * Copyright (C) 2021 Exiv2 authors
+ * This program is part of the Exiv2 distribution.
+ *
+ * This program 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.
+ *
+ * This 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, 5th Floor, Boston, MA 02110-1301 USA.
+ */
+
+#pragma once
+
+// *****************************************************************************
+#include "exiv2lib_export.h"
+
+// included header files
+#include "image.hpp"
+#include "iostream"
+
+// *****************************************************************************
+// namespace extensions
+namespace Exiv2
+{
+    EXIV2API bool enableBMFF(bool enable = true);
+
+    struct Iloc
+    {
+        Iloc(uint32_t ID = 0, uint32_t start = 0, uint32_t length = 0) : ID_(ID), start_(start), length_(length){};
+        virtual ~Iloc(){};
+
+        uint32_t ID_;
+        uint32_t start_;
+        uint32_t length_;
+
+        std::string toString() const;
+    };  // class Iloc
+
+    // *****************************************************************************
+    // class definitions
+
+    // Add Base Media File Format to the supported image formats
+    namespace ImageType
+    {
+        const int bmff = 15;  //!< BMFF (bmff) image type (see class BMFF)
+    }
+
+    /*!
+      @brief Class to access BMFF images.
+     */
+    class EXIV2API BmffImage : public Image
+    {
+    public:
+        //! @name Creators
+        //@{
+        /*!
+          @brief Constructor to open a BMFF image. Since the
+              constructor can not return a result, callers should check the
+              good() method after object construction to determine success
+              or failure.
+          @param io An auto-pointer that owns a BasicIo instance used for
+              reading and writing image metadata. \b Important: The constructor
+              takes ownership of the passed in BasicIo instance through the
+              auto-pointer. Callers should not continue to use the BasicIo
+              instance after it is passed to this method.  Use the Image::io()
+              method to get a temporary reference.
+          @param create Specifies if an existing image should be read (false)
+              or if a new file should be created (true).
+         */
+        BmffImage(BasicIo::AutoPtr io, bool create);
+        //@}
+
+        //@{
+        /*!
+          @brief parse embedded tiff file (Exif metadata)
+          @param root_tag root of parse tree Tag::root, Tag::cmt2 etc.
+          @param length tiff block length
+          @param start offset in file (default, io_->tell())
+         @
+         */
+        void parseTiff(uint32_t root_tag, uint32_t length);
+        void parseTiff(uint32_t root_tag, uint32_t length,uint32_t start);
+        //@}
+
+        //@{
+        /*!
+          @brief parse embedded xmp/xml
+          @param length xmp block length
+          @param start offset in file
+         @
+         */
+        void parseXmp(uint32_t length,uint32_t start);
+        //@}
+
+        //! @name Manipulators
+        //@{
+        void readMetadata() /* override */;
+        void writeMetadata() /* override */;
+        void setComment(const std::string& comment) /* override */;
+        void printStructure(std::ostream& out, Exiv2::PrintStructureOption option,int depth);
+        //@}
+
+        //! @name Accessors
+        //@{
+        std::string mimeType() const /* override */;
+        int pixelWidth() const;
+        int pixelHeight() const;
+        //@}
+
+        Exiv2::ByteOrder endian_ ;
+
+    private:
+        void openOrThrow();
+        /*!
+          @brief recursiveBoxHandler
+          @throw Error if we visit a box more than once
+          @return address of next box
+          @warning This function should only be called by readMetadata()
+         */
+        long boxHandler(std::ostream& out=std::cout, Exiv2::PrintStructureOption option=kpsNone,int depth = 0);
+        std::string indent(int i)
+        {
+            return std::string(2*i,' ');
+        }
+
+        uint32_t                 fileType_;
+        std::set<uint64_t>       visits_;
+        uint64_t                 visits_max_;
+        uint16_t                 unknownID_;  // 0xffff
+        uint16_t                 exifID_;
+        uint16_t                 xmpID_;
+        std::map<uint32_t, Iloc> ilocs_;
+        bool                     bReadMetadata_;
+        //@}
+
+        /*!
+          @brief box utilities
+         */
+        std::string toAscii(long n);
+        std::string boxName(uint32_t box);
+        bool        superBox(uint32_t box);
+        bool        fullBox(uint32_t box);
+        std::string uuidName(Exiv2::DataBuf& uuid);
+
+    };  // class BmffImage
+
+    // *****************************************************************************
+    // template, inline and free functions
+
+    // These could be static private functions on Image subclasses but then
+    // ImageFactory needs to be made a friend.
+    /*!
+      @brief Create a new BMFF instance and return an auto-pointer to it.
+             Caller owns the returned object and the auto-pointer ensures that
+             it will be deleted.
+     */
+    EXIV2API Image::AutoPtr newBmffInstance(BasicIo::AutoPtr io, bool create);
+
+    //! Check if the file iIo is a BMFF image.
+    EXIV2API bool isBmffType(BasicIo& iIo, bool advance);
+}  // namespace Exiv2
diff --git a/include/exiv2/exiv2.hpp b/include/exiv2/exiv2.hpp
@@ -46,6 +46,9 @@
 #include "exiv2/image.hpp"
 #include "exiv2/ini.hpp"
 #include "exiv2/iptc.hpp"
+#ifdef   EXV_ENABLE_BMFF
+#include "bmffimage.hpp"
+#endif// EXV_ENABLE_BMFF
 #include "exiv2/jp2image.hpp"
 #include "exiv2/jpgimage.hpp"
 #include "exiv2/metadatum.hpp"
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ git: @@
     env:
       global:
-        - COMMON_CMAKE_OPTIONS="-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_ENABLE_CURL=ON -DEXIV2_BUILD_UNIT_TESTS=ON -DEXIV2_TEAM_WARNINGS_AS_ERRORS=ON -DCMAKE_INSTALL_PREFIX=install"
+        - COMMON_CMAKE_OPTIONS="-DEXIV2_ENABLE_WEBREADY=ON -DEXIV2_ENABLE_CURL=ON -DEXIV2_BUILD_UNIT_TESTS=ON -DEXIV2_ENABLE_BMFF=ON -DEXIV2_TEAM_WARNINGS_AS_ERRORS=ON -DCMAKE_INSTALL_PREFIX=install"
     matrix:
       include:
@@ Expand Down @@