Support for ZSTD

CMakeLists.txt

@@ -1,6 +1,10 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(libXISF VERSION 0.2.1 LANGUAGES CXX C)
+project(libXISF VERSION 0.2.8 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)
 
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_CXX_STANDARD 17)
@@ -9,15 +13,31 @@ set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 
 option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
-option(USE_BUNDLED_LIBS "Use bundled LZ4 PugiXML and Zlib" ON)
+option(USE_BUNDLED_LIBS "Use bundled LZ4 PugiXML and Zlib. You can still exclude some" ON)
+cmake_dependent_option(USE_BUNDLED_LZ4 "Use bundled LZ4" ON "USE_BUNDLED_LIBS" OFF)
+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)
 
-if(USE_BUNDLED_LIBS)
-set(THIRD_PARTY_SRC
+find_package(PkgConfig)
+
+if(USE_BUNDLED_LZ4)
+    list(APPEND THIRD_PARTY_SRC
         lz4/lz4.c
         lz4/lz4.h
         lz4/lz4hc.c
-    lz4/lz4hc.h
-    pugixml/pugixml.cpp
+        lz4/lz4hc.h)
+    list(APPEND THIRD_PARTY_INCLUDE lz4)
+else(USE_BUNDLED_LZ4)
+    pkg_check_modules(LZ4 liblz4 IMPORTED_TARGET REQUIRED)
+endif(USE_BUNDLED_LZ4)
+if(USE_BUNDLED_PUGIXML)
+    list(APPEND THIRD_PARTY_SRC pugixml/pugixml.cpp)
+    list(APPEND THIRD_PARTY_INCLUDE pugixml)
+else(USE_BUNDLED_PUGIXML)
+    pkg_check_modules(PUGIXML pugixml IMPORTED_TARGET REQUIRED)
+endif(USE_BUNDLED_PUGIXML)
+if(USE_BUNDLED_ZLIB)
+    list(APPEND THIRD_PARTY_SRC
         zlib/adler32.c
         zlib/compress.c
         zlib/crc32.c
@@ -36,31 +56,50 @@ set(THIRD_PARTY_SRC
     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/zconf.h.cmakein ${CMAKE_CURRENT_BINARY_DIR}/zconf.h @ONLY)
-else(USE_BUNDLED_LIBS)
-    find_package(PkgConfig REQUIRED)
-    pkg_check_modules(LZ4 liblz4 IMPORTED_TARGET REQUIRED)
-    pkg_check_modules(PUGIXML pugixml IMPORTED_TARGET REQUIRED)
+    list(APPEND THIRD_PARTY_INCLUDE zlib)
+else(USE_BUNDLED_ZLIB)
     pkg_check_modules(ZLIB zlib IMPORTED_TARGET REQUIRED)
-endif(USE_BUNDLED_LIBS)
+endif(USE_BUNDLED_ZLIB)
 
 add_library(XISF
   bytearray.cpp
   libXISF_global.h
   libxisf.cpp
   libxisf.h
+  streambuffer.cpp
+  streambuffer.h
   utils.cpp
   variant.cpp
   ${THIRD_PARTY_SRC}
 )
 
 if(USE_BUNDLED_LIBS)
-    target_include_directories(XISF PRIVATE lz4 pugixml zlib)
+    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})
 
+pkg_check_modules(ZSTD libzstd IMPORTED_TARGET)
+if(ZSTD_FOUND)
+    target_compile_definitions(XISF PRIVATE HAVE_ZSTD)
+    target_link_libraries(XISF PUBLIC PkgConfig::ZSTD)
+endif(ZSTD_FOUND)
+
 if(BUILD_SHARED_LIBS)
     target_compile_definitions(XISF PRIVATE LIBXISF_LIBRARY)
 else(BUILD_SHARED_LIBS)
@@ -72,8 +111,17 @@ 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})
 
+list(JOIN PC_LIBS_REQUIRE ", " PC_REQUIRE_STR2)
+if(NOT PC_REQUIRE_STR2 STREQUAL "")
+    string(REPLACE "lz4" "liblz4" PC_REQUIRE_STR ${PC_REQUIRE_STR2})
+endif()
+list(TRANSFORM PC_LIBS_REQUIRE PREPEND "-l")
+list(JOIN PC_LIBS_REQUIRE " " PC_LIBS_STR)
+configure_file(libxisf.pc.in libxisf.pc @ONLY)
+
 #testing
 
 enable_testing()

debian/changelog

@@ -1,35 +0,0 @@
-libxisf (0.2.0-ubuntu2) UNRELEASED; urgency=medium
-
-  * Fix lintian errors
-
- -- Dušan Poizl <nou@nouspiro.space>  Sun, 19 Mar 2023 22:10:39 +0100
-
-libxisf (0.2.0-ubuntu1) focal; urgency=medium
-
-  * Rewrite to remove Qt as dependency
-
- -- Dušan Poizl <nou@nouspiro.space>  Fri, 10 Mar 2023 22:10:01 +0100
-
-libxisf (0.1.3-ubuntu1) focal; urgency=medium
-
-  * Write missing pixelStorage attribute
-
- -- Dušan Poizl <nou@nouspiro.space>  Fri, 17 Feb 2023 16:57:30 +0100
-
-libxisf (0.1.2-ubuntu1) focal; urgency=medium
-
-  * Add qtbase5-dev as dependency to libxisf-dev
-
- -- Dušan Poizl <nou@nouspiro.space>  Thu, 09 Feb 2023 21:28:45 +0100
-
-libxisf (0.1.1-ubuntu1) focal; urgency=medium
-
-  * Fixed packaging
-
- -- Dušan Poizl <nou@nouspiro.space>  Wed, 08 Feb 2023 18:57:50 +0100
-
-libxisf (0.1.0-ubuntu1) focal; urgency=low
-
-  * Initial release.
-
- -- Dušan Poizl <nou@nouspiro.space>  Tue, 07 Feb 2023 10:47:08 +0100

debian/compat

@@ -1 +0,0 @@
-10

debian/control

@@ -1,25 +0,0 @@
-Source: libxisf
-Priority: optional
-Maintainer: Dušan Poizl <nou@nouspiro.space>
-Build-Depends: debhelper (>= 9),
-               cdbs,
-               cmake,
-Standards-Version: 4.5.0
-Section: libs
-Homepage: https://gitea.nouspiro.space/nou/libXISF
-Vcs-Git: https://gitea.nouspiro.space/nou/libXISF.git
-
-Package: libxisf-dev
-Section: libdevel
-Architecture: any
-Multi-Arch: same
-Depends: libxisf (= ${binary:Version}), ${misc:Depends}, qtbase5-dev
-Description: Library to load and save XISF images
- Native format of PixInsight astroprocessing suite
-
-Package: libxisf
-Architecture: any
-Multi-Arch: same
-Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: Library to load and save XISF images
- Native format of PixInsight astroprocessing suite

debian/copyright

@@ -1,97 +0,0 @@
-Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: libxisf
-Source: https://gitea.nouspiro.space/nou/libXISF
-
-Files: * debian/*
-Copyright: (c) 2023 <Dušan Poizl nou@nouspiro.space>
-License: GPL-3+
- 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 3 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, see <http://www.gnu.org/licenses/>.
- .
- On Debian systems, the complete texts of the GNU General Public Licenses
- version 2 and 3 can be found in '/usr/share/common-licenses/GPL-2' and
- '/usr/share/common-licenses/GPL-3'.
-
-Files: lz4/*
-Copyright: (c) 2011-2020, Yann Collet
-License: BSD-2-clause
- LZ4 Library
- Copyright (c) 2011-2020, Yann Collet
- All rights reserved.
- .
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
- .
- * Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
- .
- * Redistributions in binary form must reproduce the above copyright notice, this
- list of conditions and the following disclaimer in the documentation and/or
- other materials provided with the distribution.
- .
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-Files: zlib/*
-Copyright: (c) 1995-2022 Jean-loup Gailly and Mark Adler
-License: Zlib
- This software is provided 'as-is', without any express or implied
- warranty.  In no event will the authors be held liable for any damages
- arising from the use of this software.
- .
- Permission is granted to anyone to use this software for any purpose,
- including commercial applications, and to alter it and redistribute it
- freely, subject to the following restrictions:
- .
- 1. The origin of this software must not be misrepresented; you must not
-    claim that you wrote the original software. If you use this software
-    in a product, an acknowledgment in the product documentation would be
-    appreciated but is not required.
- 2. Altered source versions must be plainly marked as such, and must not be
-    misrepresented as being the original software.
- 3. This notice may not be removed or altered from any source distribution.
- .
- Jean-loup Gailly        Mark Adler
- jloup@gzip.org          madler@alumni.caltech.edu
-
-Files: pugixml/*
-Copyright: (c) 2006-2022 Arseny Kapoulkine
-License: MIT
- Permission is hereby granted, free of charge, to any person
- obtaining a copy of this software and associated documentation
- files (the "Software"), to deal in the Software without
- restriction, including without limitation the rights to use,
- copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the
- Software is furnished to do so, subject to the following
- conditions:
- .
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
- .
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- OTHER DEALINGS IN THE SOFTWARE.

debian/libxisf-dev.install

@@ -1,2 +0,0 @@
-usr/include
-usr/lib/*/*.so

debian/libxisf.install

@@ -1 +0,0 @@
-usr/lib/*/*.so.*

debian/rules

@@ -1,10 +0,0 @@
-#!/usr/bin/make -f
-
-#!/usr/bin/make -f
-
-include /usr/share/cdbs/1/rules/debhelper.mk
-include /usr/share/cdbs/1/class/cmake.mk
-
-export CFLAGS := $(shell dpkg-buildflags --get CFLAGS)
-export CXXFLAGS := $(shell dpkg-buildflags --get CXXFLAGS)
-export LDFLAGS := $(shell dpkg-buildflags --get LDFLAGS)

debian/source/format

@@ -1 +0,0 @@
-3.0 (quilt)

libxisf.cpp

@@ -27,6 +27,10 @@
 #include <lz4hc.h>
 #include <pugixml.hpp>
 #include <zlib.h>
+#ifdef HAVE_ZSTD
+#include <zstd.h>
+#endif
+#include "streambuffer.h"
 
 namespace LibXISF
 {
@@ -141,6 +145,15 @@ void DataBlock::decompress(const ByteArray &input, const String &encoding)
         if(LZ4_decompress_safe(tmp.constData(), data.data(), tmp.size(), data.size()) < 0)
             throw Error("LZ4 decompression failed");
         break;
+    case ZSTD:
+#ifdef HAVE_ZSTD
+        data.resize(uncompressedSize);
+        if(ZSTD_isError(ZSTD_decompress(data.data(), data.size(), tmp.constData(), tmp.size())))
+            throw Error("ZSTD decompression failed");
+#else
+        throw Error("ZSTD support not compiled");
+#endif
+        break;
     }
 
     byteUnshuffle(data, byteShuffling);
@@ -191,8 +204,33 @@ void DataBlock::compress(int sampleFormatSize)
         data.resize(compSize);
         break;
     }
+    case ZSTD:
+    {
+#ifdef HAVE_ZSTD
+        size_t compSize = 0;
+        data.resize(ZSTD_compressBound(uncompressedSize));
+        compSize = ZSTD_compress(data.data(), data.size(), tmp.data(), tmp.size(), compressLevel < 0 ? ZSTD_CLEVEL_DEFAULT : compressLevel);
+        if(ZSTD_isError(compSize))
+            throw Error("ZSTD compression failed");
+
+        data.resize(compSize);
+#else
+        throw Error("ZSTD support not compiled");
+#endif
+        break;
     }
     }
+}
+
+bool DataBlock::CompressionCodecSupported(CompressionCodec codec)
+{
+    (void)codec;
+#ifndef HAVE_ZSTD
+    if(codec == ZSTD)
+        return false;
+#endif
+    return true;
+}
 
 Property::Property(const String &_id, const char *_value) :
     id(_id),
@@ -357,6 +395,16 @@ bool Image::addFITSKeywordAsProperty(const String &name, const String &value)
     return false;
 }
 
+const ByteArray &Image::iccProfile() const
+{
+    return _iccProfile;
+}
+
+void Image::setIccProfile(const ByteArray &iccProfile)
+{
+    _iccProfile = iccProfile;
+}
+
 void *Image::imageData()
 {
     return _dataBlock.data.size() ? _dataBlock.data.data() : nullptr;
@@ -520,6 +568,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();
@@ -529,9 +578,12 @@ private:
     FITSKeyword parseFITSKeyword(const pugi::xml_node &node);
     ColorFilterArray parseCFA(const pugi::xml_node &node);
     Image parseImage(const pugi::xml_node &node);
+    void readAttachment(DataBlock &dataBlock);
 
     std::unique_ptr<std::istream> _io;
+    std::unique_ptr<StreamBuffer> _buffer;
     std::vector<Image> _images;
+    Image _thumbnail;
     std::vector<Property> _properties;
 };
 
@@ -546,8 +598,8 @@ void XISFReaderPrivate::open(const String &name)
 void XISFReaderPrivate::open(const ByteArray &data)
 {
     close();
-    std::string str((char*)data.data(), data.size());
-    _io = std::make_unique<std::istringstream>(str, std::ios_base::in | std::ios_base::binary);
+    _buffer = std::make_unique<StreamBuffer>(data);
+    _io = std::make_unique<std::istream>(_buffer.get());
     readSignature();
     readXISFHeader();
 }
@@ -563,6 +615,7 @@ void XISFReaderPrivate::open(std::istream *io)
 void XISFReaderPrivate::close()
 {
     _io.reset();
+    _buffer.reset();
     _images.clear();
     _properties.clear();
 }
@@ -579,13 +632,23 @@ const Image& XISFReaderPrivate::getImage(uint32_t n, bool readPixels)
 
     Image &img = _images[n];
     if(img._dataBlock.attachmentPos && readPixels)
+    {
+        readAttachment(img._dataBlock);
+    }
+    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 img;
+    return _thumbnail;
 }
 
 void XISFReaderPrivate::readXISFHeader()
@@ -608,6 +671,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");
 }
@@ -634,6 +700,10 @@ void XISFReaderPrivate::parseCompression(const pugi::xml_node &node, DataBlock &
             dataBlock.codec = DataBlock::LZ4HC;
         else if(compression[0].find("lz4") == 0)
             dataBlock.codec = DataBlock::LZ4;
+#ifdef HAVE_ZSTD
+        else if(compression[0].find("zstd") == 0)
+            dataBlock.codec = DataBlock::ZSTD;
+#endif
         else
             throw Error("Unknown compression codec");
 
@@ -703,17 +773,10 @@ Property XISFReaderPrivate::parseProperty(const pugi::xml_node &node)
     {
         DataBlock dataBlock = parseDataBlock(node);
         if(dataBlock.attachmentPos)
-        {
-            data.resize(dataBlock.attachmentSize);
-            _io->seekg(dataBlock.attachmentPos);
-            _io->read(data.data(), dataBlock.attachmentSize);
-            dataBlock.decompress(data);
-        }
-        else
-        {
+            readAttachment(dataBlock);
+
         data = dataBlock.data;
     }
-    }
 
     deserializeVariant(node, property.value, data);
 
@@ -781,12 +844,26 @@ Image XISFReaderPrivate::parseImage(const pugi::xml_node &node)
     if(node.child("ICCProfile"))
     {
         DataBlock icc = parseDataBlock(node.child("ICCProfile"));
+        if(icc.attachmentPos)
+            readAttachment(icc);
+
         image._iccProfile = icc.data;
     }
 
+    if(node.child("Thumbnail") && std::strcmp(node.name(), "Thumbnail"))
+        _thumbnail = parseImage(node.child("Thumbnail"));
+
     return image;
 }
 
+void XISFReaderPrivate::readAttachment(DataBlock &dataBlock)
+{
+    ByteArray data(dataBlock.attachmentSize);
+    _io->seekg(dataBlock.attachmentPos);
+    _io->read(data.data(), dataBlock.attachmentSize);
+    dataBlock.decompress(data);
+}
+
 class  XISFWriterPrivate
 {
 public:
@@ -818,10 +895,10 @@ void XISFWriterPrivate::save(const String &name)
 
 void XISFWriterPrivate::save(ByteArray &data)
 {
-    std::ostringstream oss;
+    StreamBuffer buffer;
+    std::ostream oss(&buffer);
     save(oss);
-    std::string str = oss.str();
-    data = ByteArray(str.data(), str.size());
+    data = buffer.byteArray();
 }
 
 void XISFWriterPrivate::save(std::ostream &io)
@@ -912,7 +989,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);
@@ -952,6 +1029,12 @@ void XISFWriterPrivate::writeDataBlockAttributes(pugi::xml_node &image_node, con
         codec = "lz4";
     else if(dataBlock.codec == DataBlock::LZ4HC)
         codec = "lz4hc";
+    else if(dataBlock.codec == DataBlock::ZSTD)
+#ifdef HAVE_ZSTD
+        codec = "zstd";
+#else
+        throw Error("ZSTD support not compiled");
+#endif
 
     if(dataBlock.byteShuffling > 1)
         codec += "+sh";
@@ -1034,6 +1117,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;
@@ -1108,6 +1196,10 @@ struct Init
                 compressionCodecOverride = DataBlock::LZ4HC;
             else if(compression.find("lz4") == 0)
                 compressionCodecOverride = DataBlock::LZ4;
+#ifdef HAVE_ZSTD
+            else if(compression.find("zstd") == 0)
+                compressionCodecOverride = DataBlock::ZSTD;
+#endif
 
             if(compression.find("+sh") != std::string::npos)
                 byteShuffleOverride = true;

libxisf.h

@@ -172,7 +172,8 @@ struct LIBXISF_EXPORT DataBlock
         None,
         Zlib,
         LZ4,
-        LZ4HC
+        LZ4HC,
+        ZSTD
     };
     bool embedded = false;
     uint32_t byteShuffling = 0;
@@ -184,6 +185,8 @@ struct LIBXISF_EXPORT DataBlock
     ByteArray data;
     void decompress(const ByteArray &input, const std::string &encoding = "");
     void compress(int sampleFormatSize);
+    /// ZSTD compression can be disabled at compile time
+    static bool CompressionCodecSupported(CompressionCodec codec);
 };
 
 struct LIBXISF_EXPORT Property
@@ -301,6 +304,8 @@ public:
      *  For example OBSERVER => Observer:Name, SITELAT => Observation:Location:Latitude
     */
     bool addFITSKeywordAsProperty(const String &name, const String &value);
+    const ByteArray& iccProfile() const;
+    void setIccProfile(const ByteArray &iccProfile);
 
     void* imageData();
     const void* imageData() const;
@@ -364,9 +369,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()
-     *  will return nullptr */
+     *  @param readPixel when false it will not read pixel data from file and imageData()
+     *  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,12 @@
+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_REQUIRE_STR@
+Cflags: -I"${includedir}"
+Libs: -L"${libdir}" -lXISF

streambuffer.cpp

@@ -0,0 +1,144 @@
+#include "streambuffer.h"
+
+namespace LibXISF
+{
+
+StreamBuffer::StreamBuffer()
+{
+    setg(nullptr, nullptr, nullptr);
+    setp(nullptr, nullptr);
+}
+
+StreamBuffer::StreamBuffer(const ByteArray &byteArray) :
+    _size(byteArray.size()),
+    _byteArray(byteArray)
+{
+    if(_byteArray.size())
+    {
+        char *ptr = _byteArray.data();
+        setg(ptr, ptr, ptr + _size);
+        setp(ptr, ptr + _size);
+    }
+    else
+    {
+        setg(nullptr, nullptr, nullptr);
+        setp(nullptr, nullptr);
+    }
+}
+
+ByteArray StreamBuffer::byteArray()
+{
+    return _byteArray;
+}
+
+StreamBuffer::pos_type StreamBuffer::seekoff(off_type off, std::ios_base::seekdir dir, std::ios_base::openmode mode)
+{
+    pos_type ret = pos_type(off_type(-1));
+    off_type newoffi = off;
+    off_type newoffo = off;
+    if(dir == std::ios_base::cur)
+    {
+        newoffi += gptr() - eback();
+        newoffo += pptr() - pbase();
+    }
+    else if(dir == std::ios_base::end)
+        newoffo = newoffi = _byteArray.size() - off;
+
+    char *ptr = _byteArray.data();
+    if(mode & std::ios_base::in && newoffi >= 0 && newoffi <= _size)
+    {
+        setg(ptr, ptr + newoffi, ptr + _size);
+        ret = pos_type(newoffi);
+    }
+
+    if(mode & std::ios_base::out && newoffo >= 0 && newoffo <= _size)
+    {
+        setp(ptr, ptr + _size);
+        pbump(newoffo);
+        ret = pos_type(newoffo);
+    }
+
+    return ret;
+}
+
+StreamBuffer::pos_type StreamBuffer::seekpos(pos_type pos, std::ios_base::openmode mode)
+{
+    pos_type ret = pos_type(off_type(-1));
+    off_type off = pos;
+
+    if(off >= 0 && off <= (off_type)_byteArray.size())
+    {
+        char *ptr = _byteArray.data();
+        if(mode & std::ios_base::in)
+            setg(ptr, ptr + pos, ptr + _size);
+
+        if(mode & std::ios_base::out)
+        {
+            setp(ptr, ptr + _size);
+            pbump(pos);
+        }
+
+        ret = pos;
+    }
+    return ret;
+}
+
+std::streamsize StreamBuffer::xsgetn(char_type *s, std::streamsize n)
+{
+    std::streamsize ret = 0;
+    std::streamsize len = egptr() - gptr();
+    if(len > 0)
+    {
+        std::streamsize c = std::min(n, len);
+        std::memcpy(s, gptr(), c);
+        gbump(c);
+        ret = c;
+    }
+    return ret;
+}
+
+StreamBuffer::int_type StreamBuffer::underflow()
+{
+    if(gptr() < egptr())
+        return traits_type::to_int_type(*gptr());
+    else
+        return traits_type::eof();
+}
+
+std::streamsize StreamBuffer::xsputn(const char_type *s, std::streamsize n)
+{
+    off_type len = epptr() - pptr();
+    if(len < n)
+    {
+        _size += n - len;
+        _byteArray.resize(_size);
+        update_ptrs();
+    }
+    std::memcpy(pptr(), s, n);
+    pbump(n);
+    return n;
+}
+
+StreamBuffer::int_type StreamBuffer::overflow(int_type c)
+{
+    if(traits_type::eq_int_type(traits_type::eof(), c))
+        return traits_type::eof();
+
+    _byteArray.append(c);
+    _size++;
+    pbump(1);
+    update_ptrs();
+    return c;
+}
+
+void StreamBuffer::update_ptrs()
+{
+    off_type ipos = gptr() - eback();
+    off_type opos = pptr() - pbase();
+    char *ptr = _byteArray.data();
+    setg(ptr, ptr + ipos, ptr + _size);
+    setp(ptr, ptr + _size);
+    pbump(opos);
+}
+
+}

streambuffer.h

@@ -0,0 +1,33 @@
+#ifndef STREAMBUFFER_H
+#define STREAMBUFFER_H
+
+#include <streambuf>
+#include "libxisf.h"
+
+namespace LibXISF
+{
+
+class StreamBuffer : public std::streambuf
+{
+public:
+    StreamBuffer();
+    StreamBuffer(const ByteArray &byteArray);
+    ByteArray byteArray();
+protected:
+    pos_type seekoff(off_type off, std::ios_base::seekdir dir, std::ios_base::openmode mode = std::ios_base::in | std::ios_base::out) override;
+    pos_type seekpos(pos_type pos, std::ios_base::openmode mode = std::ios_base::in | std::ios_base::out) override;
+
+    std::streamsize xsgetn(char_type *s, std::streamsize n) override;
+    int_type underflow() override;
+
+    std::streamsize xsputn(const char_type *s, std::streamsize n) override;
+    int_type overflow(int_type c = traits_type::eof()) override;
+private:
+    void update_ptrs();
+    off_type _size = 0;
+    ByteArray _byteArray;
+};
+
+}
+
+#endif // STREAMBUFFER_H

test/benchmark.cpp

@@ -78,6 +78,17 @@ void benchmarkType(float avg, float stdDev)
         std::cout << "LZ4HC compression   \tElapsed time: " << timer.elapsed() << " " << "ms\tSpeed: "
                   << size/1024.0/1.024/timer.elapsed() << "MiB/s\tRatio: " << baseSize/xisfImage.size() << std::endl;
     }
+    if(DataBlock::CompressionCodecSupported(DataBlock::ZSTD))
+    {
+        image.setCompression(DataBlock::ZSTD);
+        timer.start();
+        XISFWriter writer;
+        writer.writeImage(image);
+        ByteArray xisfImage;
+        writer.save(xisfImage);
+        std::cout << "ZSTD compression   \tElapsed time: " << timer.elapsed() << " " << "ms\tSpeed: "
+                  << size/1024.0/1.024/timer.elapsed() << "MiB/s\tRatio: " << baseSize/xisfImage.size() << std::endl;
+    }
     image.setByteshuffling(true);
     {
         image.setCompression(DataBlock::Zlib);
@@ -109,6 +120,17 @@ void benchmarkType(float avg, float stdDev)
         std::cout << "LZ4HC compression SH\tElapsed time: " << timer.elapsed() << " " << "ms\tSpeed: "
                   << size/1024.0/1.024/timer.elapsed() << "MiB/s\tRatio: " << baseSize/xisfImage.size() << std::endl;
     }
+    if(DataBlock::CompressionCodecSupported(DataBlock::ZSTD))
+    {
+        image.setCompression(DataBlock::ZSTD);
+        timer.start();
+        XISFWriter writer;
+        writer.writeImage(image);
+        ByteArray xisfImage;
+        writer.save(xisfImage);
+        std::cout << "ZSTD compression SH\tElapsed time: " << timer.elapsed() << " " << "ms\tSpeed: "
+                  << size/1024.0/1.024/timer.elapsed() << "MiB/s\tRatio: " << baseSize/xisfImage.size() << std::endl;
+    }
 }
 
 void benchmark()