Update version to 0.2.4

CMakeLists.txt

@@ -1,6 +1,8 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(libXISF VERSION 0.2.2 LANGUAGES CXX C)
+project(libXISF VERSION 0.2.4 LANGUAGES CXX C
+    HOMEPAGE_URL https://gitea.nouspiro.space/nou/libXISF
+    DESCRIPTION "LibXISF is C++ library that can read and write XISF files produced by PixInsight.")
 
 include(CMakeDependentOption)
 
@@ -16,50 +18,48 @@ cmake_dependent_option(USE_BUNDLED_LZ4 "Use bundled LZ4" ON "USE_BUNDLED_LIBS" O
 cmake_dependent_option(USE_BUNDLED_PUGIXML "Use bundled PugiXML" ON "USE_BUNDLED_LIBS" OFF)
 cmake_dependent_option(USE_BUNDLED_ZLIB "Use bundled Zlib" ON "USE_BUNDLED_LIBS" OFF)
 
-find_package(PkgConfig REQUIRED)
+find_package(PkgConfig)
 
-if(USE_BUNDLED_LIBS)
+if(USE_BUNDLED_LZ4)
-    if(USE_BUNDLED_LZ4)
+    list(APPEND THIRD_PARTY_SRC
-        list(APPEND THIRD_PARTY_SRC
+        lz4/lz4.c
-            lz4/lz4.c
+        lz4/lz4.h
-            lz4/lz4.h
+        lz4/lz4hc.c
-            lz4/lz4hc.c
+        lz4/lz4hc.h)
-            lz4/lz4hc.h)
+    list(APPEND THIRD_PARTY_INCLUDE lz4)
-        list(APPEND THIRD_PARTY_INCLUDE lz4)
+else(USE_BUNDLED_LZ4)
-    else(USE_BUNDLED_LZ4)
+    pkg_check_modules(LZ4 liblz4 IMPORTED_TARGET REQUIRED)
-        pkg_check_modules(LZ4 liblz4 IMPORTED_TARGET REQUIRED)
+endif(USE_BUNDLED_LZ4)
-    endif(USE_BUNDLED_LZ4)
+if(USE_BUNDLED_PUGIXML)
-    if(USE_BUNDLED_PUGIXML)
+    list(APPEND THIRD_PARTY_SRC pugixml/pugixml.cpp)
-        list(APPEND THIRD_PARTY_SRC pugixml/pugixml.cpp)
+    list(APPEND THIRD_PARTY_INCLUDE pugixml)
-        list(APPEND THIRD_PARTY_INCLUDE pugixml)
+else(USE_BUNDLED_PUGIXML)
-    else(USE_BUNDLED_PUGIXML)
+    pkg_check_modules(PUGIXML pugixml IMPORTED_TARGET REQUIRED)
-        pkg_check_modules(PUGIXML pugixml IMPORTED_TARGET REQUIRED)
+endif(USE_BUNDLED_PUGIXML)
-    endif(USE_BUNDLED_PUGIXML)
+if(USE_BUNDLED_ZLIB)
-    if(USE_BUNDLED_ZLIB)
+    list(APPEND THIRD_PARTY_SRC
-        list(APPEND THIRD_PARTY_SRC
+        zlib/adler32.c
-            zlib/adler32.c
+        zlib/compress.c
-            zlib/compress.c
+        zlib/crc32.c
-            zlib/crc32.c
+        zlib/deflate.c
-            zlib/deflate.c
+        zlib/gzclose.c
-            zlib/gzclose.c
+        zlib/gzlib.c
-            zlib/gzlib.c
+        zlib/gzread.c
-            zlib/gzread.c
+        zlib/gzwrite.c
-            zlib/gzwrite.c
+        zlib/inflate.c
-            zlib/inflate.c
+        zlib/infback.c
-            zlib/infback.c
+        zlib/inftrees.c
-            zlib/inftrees.c
+        zlib/inffast.c
-            zlib/inffast.c
+        zlib/trees.c
-            zlib/trees.c
+        zlib/uncompr.c
-            zlib/uncompr.c
+        zlib/zutil.c)
-            zlib/zutil.c)
+    set(ZLIB_PC ${CMAKE_CURRENT_BINARY_DIR}/zlib.pc)
-        set(ZLIB_PC ${CMAKE_CURRENT_BINARY_DIR}/zlib.pc)
+    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/zlib/zlib.pc.cmakein ${ZLIB_PC} @ONLY)
-        configure_file(${CMAKE_CURRENT_SOURCE_DIR}/zlib/zlib.pc.cmakein ${ZLIB_PC} @ONLY)
+    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/zlib/zconf.h.cmakein ${CMAKE_CURRENT_BINARY_DIR}/zconf.h @ONLY)
-        configure_file(${CMAKE_CURRENT_SOURCE_DIR}/zlib/zconf.h.cmakein ${CMAKE_CURRENT_BINARY_DIR}/zconf.h @ONLY)
+    list(APPEND THIRD_PARTY_INCLUDE zlib)
-        list(APPEND THIRD_PARTY_INCLUDE zlib)
+else(USE_BUNDLED_ZLIB)
-    else(USE_BUNDLED_ZLIB)
+    pkg_check_modules(ZLIB zlib IMPORTED_TARGET REQUIRED)
-        pkg_check_modules(ZLIB zlib IMPORTED_TARGET REQUIRED)
+endif(USE_BUNDLED_ZLIB)
-    endif(USE_BUNDLED_ZLIB)
-endif(USE_BUNDLED_LIBS)
 
 add_library(XISF
   bytearray.cpp
@@ -75,15 +75,19 @@ if(USE_BUNDLED_LIBS)
     target_include_directories(XISF PRIVATE ${THIRD_PARTY_INCLUDE})
     if(NOT USE_BUNDLED_LZ4)
         target_link_libraries(XISF PUBLIC PkgConfig::LZ4)
+        list(APPEND PC_LIBS_REQUIRE lz4)
     endif(NOT USE_BUNDLED_LZ4)
     if(NOT USE_BUNDLED_PUGIXML)
         target_link_libraries(XISF PUBLIC PkgConfig::PUGIXML)
+        list(APPEND PC_LIBS_REQUIRE pugixml)
     endif(NOT USE_BUNDLED_PUGIXML)
     if(NOT USE_BUNDLED_ZLIB)
         target_link_libraries(XISF PUBLIC PkgConfig::ZLIB)
+        list(APPEND PC_LIBS_REQUIRE zlib)
     endif(NOT USE_BUNDLED_ZLIB)
 else(USE_BUNDLED_LIBS)
     target_link_libraries(XISF PUBLIC PkgConfig::LZ4 PkgConfig::PUGIXML PkgConfig::ZLIB)
+    list(APPEND PC_LIBS_REQUIRE lz4 pugixml zlib)
 endif(USE_BUNDLED_LIBS)
 
 set_target_properties(XISF PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR})
@@ -99,8 +103,11 @@ set(XISF_PUBLIC_HEADERS libxisf.h libXISF_global.h)
 include(GNUInstallDirs)
 
 install(FILES ${XISF_PUBLIC_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libxisf.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
 install(TARGETS XISF LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
 
+configure_file(libxisf.pc.in libxisf.pc @ONLY)
+
 #testing
 
 enable_testing()

libxisf.cpp

@@ -520,6 +520,7 @@ public:
      *  @param readPixel when false it will read pixel data from file and imageData()
      *  will return nullptr */
     const Image& getImage(uint32_t n, bool readPixels = true);
+    const Image& getThumbnail();
 private:
     void readXISFHeader();
     void readSignature();
@@ -532,6 +533,7 @@ private:
 
     std::unique_ptr<std::istream> _io;
     std::vector<Image> _images;
+    Image _thumbnail;
     std::vector<Property> _properties;
 };
 
@@ -588,6 +590,19 @@ const Image& XISFReaderPrivate::getImage(uint32_t n, bool readPixels)
     return img;
 }
 
+const Image &XISFReaderPrivate::getThumbnail()
+{
+    Image &img = _thumbnail;
+    if(_thumbnail._dataBlock.attachmentPos)
+    {
+        _io->seekg(img._dataBlock.attachmentPos);
+        ByteArray data(img._dataBlock.attachmentSize);
+        _io->read(data.data(), data.size());
+        img._dataBlock.decompress(data);
+    }
+    return _thumbnail;
+}
+
 void XISFReaderPrivate::readXISFHeader()
 {
     uint32_t headerLen[2] = {0};
@@ -608,6 +623,9 @@ void XISFReaderPrivate::readXISFHeader()
 
         for(auto &property : root.children("Property"))
             _properties.push_back(parseProperty(property));
+
+        if(root.child("Thumbnail"))
+            _thumbnail = parseImage(root.child("Thumbnail"));
     }
     else throw Error("Unknown root XML element");
 }
@@ -784,6 +802,9 @@ Image XISFReaderPrivate::parseImage(const pugi::xml_node &node)
         image._iccProfile = icc.data;
     }
 
+    if(node.child("Thumbnail") && std::strcmp(node.name(), "Thumbnail"))
+        _thumbnail = parseImage(node.child("Thumbnail"));
+
     return image;
 }
 
@@ -912,7 +933,7 @@ void XISFWriterPrivate::writeImageElement(pugi::xml_node &node, const Image &ima
 
     if(image._cfa.width && image._cfa.height)
     {
-        pugi::xml_node cfa_node = node.append_child("ColorFilterArray");
+        pugi::xml_node cfa_node = image_node.append_child("ColorFilterArray");
         cfa_node.append_attribute("pattern").set_value(image._cfa.pattern.c_str());
         cfa_node.append_attribute("width").set_value(image._cfa.width);
         cfa_node.append_attribute("height").set_value(image._cfa.height);
@@ -1034,6 +1055,11 @@ const Image &XISFReader::getImage(uint32_t n, bool readPixels)
     return p->getImage(n, readPixels);
 }
 
+const Image &XISFReader::getThumbnail()
+{
+    return p->getThumbnail();
+}
+
 XISFWriter::XISFWriter()
 {
     p = new XISFWriterPrivate;

libxisf.h

@@ -364,9 +364,14 @@ public:
     int imagesCount() const;
     /** Return reference to Image
      *  @param n index of image
-     *  @param readPixel when false it will read pixel data from file and imageData()
+     *  @param readPixel when false it will not read pixel data from file and imageData()
-     *  will return nullptr */
+     *  will return nullptr. Other properties like width, height, format etc will be returned correctly */
     const Image& getImage(uint32_t n, bool readPixels = true);
+    /**
+     * @brief getThumbnail
+     * @return image thumbnail
+     */
+    const Image& getThumbnail();
 private:
     XISFReaderPrivate *p;
 };

libxisf.pc.in

@@ -0,0 +1,13 @@
+prefix="@CMAKE_INSTALL_PREFIX@"
+exec_prefix="${prefix}"
+libdir="${exec_prefix}/@CMAKE_INSTALL_LIBDIR@"
+includedir="${prefix}/@CMAKE_INSTALL_INCLUDEDIR@"
+
+Name: @PROJECT_NAME@
+Description: @CMAKE_PROJECT_DESCRIPTION@
+URL: @CMAKE_PROJECT_HOMEPAGE_URL@
+Version: @PROJECT_VERSION@
+Requires.private: @PC_LIBS_REQUIRE@
+Cflags: -I"${includedir}"
+Libs: -L"${libdir}" -lXISF
+Libs.private: -L"${libdir}" @PC_LIBS_REQUIRE@