Compression.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Compression.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All 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.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS 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 PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) 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.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Compression_h
#define __PCL_Compression_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ByteArray.h>
#include <pcl/ParallelProcess.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Compression : public ParallelProcess
{
public:
 
   struct Subblock
   {
      ByteArray compressedData;       
      size_type uncompressedSize = 0; 
      uint64    checksum         = 0; 
   };
 
   struct Performance
   {
      float  sizeReduction   = 0; 
      double throughput      = 0; 
      int    numberOfThreads = 0; 
   };
 
   using subblock_list = Array<Subblock>;
 
   Compression() = default;
 
   Compression( const Compression& ) = default;
 
   Compression& operator =( const Compression& ) = default;
 
   ~Compression() override
   {
   }
 
   virtual String AlgorithmName() const = 0;
 
   virtual int MinCompressionLevel() const
   {
      return 0;
   }
 
   virtual int MaxCompressionLevel() const = 0;
 
   virtual int DefaultCompressionLevel() const = 0;
 
   int CompressionLevel() const
   {
      return m_compressionLevel;
   }
 
   void SetCompressionLevel( int level )
   {
      m_compressionLevel = Range( level, 0, MaxCompressionLevel() );
   }
 
   void SetDefaultCompressionLevel()
   {
      SetCompressionLevel( 0 );
   }
 
   bool ByteShufflingEnabled() const
   {
      return m_byteShuffle;
   }
 
   void EnableByteShuffling( bool enable = true )
   {
      m_byteShuffle = enable;
   }
 
   void DisableByteShuffling( bool disable = true )
   {
      EnableByteShuffling( !disable );
   }
 
   size_type ItemSize() const
   {
      return m_itemSize;
   }
 
   void SetItemSize( size_type itemSize )
   {
      m_itemSize = pcl::Max( size_type( 1 ), itemSize );
   }
 
   size_type SubblockSize() const
   {
      return m_subblockSize;
   }
 
   void SetSubblockSize( size_type size )
   {
      m_subblockSize = Range( size, size_type( 0 ), MaxBlockSize() );
   }
 
   bool ChecksumsEnabled() const
   {
      return m_checksums;
   }
 
   void EnableChecksums( bool enable = true )
   {
      m_checksums = enable;
   }
 
   void DisableChecksums( bool disable = true )
   {
      EnableChecksums( !disable );
   }
 
   subblock_list Compress( const void* data, size_type size, Performance* perf = nullptr ) const;
 
   template <class C>
   subblock_list Compress( const C& data, Performance* perf = nullptr ) const
   {
      return Compress( data.Begin(), data.Size(), perf );
   }
 
   size_type Uncompress( void* data, size_type maxSize,
                         const subblock_list& subblocks, Performance* perf = nullptr ) const;
 
   ByteArray Uncompress( const subblock_list& subblocks, Performance* perf = nullptr ) const
   {
      size_type uncompressedSize = 0;
      for ( const Subblock& subblock : subblocks )
         uncompressedSize += subblock.uncompressedSize;
      ByteArray data( uncompressedSize );
      (void)Uncompress( data.Begin(), uncompressedSize, subblocks, perf );
      return data;
   }
 
   ByteArray Uncompress( const ByteArray& compressedData,
                         size_type uncompressedSize, Performance* perf = nullptr ) const
   {
      Subblock subblock;
      subblock.compressedData = compressedData;
      subblock.uncompressedSize = uncompressedSize;
      return Uncompress( subblock_list() << subblock, perf );
   }
 
private:
 
   int       m_compressionLevel = 0; // 0 = use codec's default
   size_type m_subblockSize = 0;     // 0 = use largest possible subblocks
   size_type m_itemSize = 1;
   bool      m_byteShuffle = true;
   bool      m_checksums = true;
 
protected:
 
   virtual size_type MinBlockSize() const = 0;
 
   virtual size_type MaxBlockSize() const = 0;
 
   virtual size_type MaxCompressedBlockSize( size_type size ) const = 0;
 
   virtual size_type CompressBlock( void* outputData, size_type outputSize,
                                    const void* inputData, size_type inputSize, int level ) const = 0;
 
   virtual size_type UncompressBlock( void* outputData, size_type outputSize,
                                      const void* inputData, size_type inputSize ) const = 0;
 
   static ByteArray Shuffle( const uint8* data, size_type size, size_type itemSize )
   {
      ByteArray shuffled( size );
      if ( size > 0 && data != nullptr )
      {
         size_type numberOfItems = size / itemSize;
         ByteArray::iterator s = shuffled.Begin();
         for ( size_type j = 0; j < itemSize; ++j )
         {
            ByteArray::const_iterator u = data + j;
            for ( size_type i = 0; i < numberOfItems; ++i, ++s, u += itemSize )
               *s = *u;
         }
         ::memcpy( s, data + numberOfItems*itemSize, size % itemSize );
      }
      return shuffled;
   }
 
   static ByteArray Unshuffle( const uint8* data, size_type size, size_type itemSize )
   {
      ByteArray unshuffled( size );
      if ( size > 0 && data != nullptr )
      {
         size_type numberOfItems = size / itemSize;
         ByteArray::const_iterator s = data;
         for ( size_type j = 0; j < itemSize; ++j )
         {
            ByteArray::iterator u = unshuffled.At( j );
            for ( size_type i = 0; i < numberOfItems; ++i, ++s, u += itemSize )
               *u = *s;
         }
         ::memcpy( unshuffled.At( numberOfItems*itemSize ), s, size % itemSize );
      }
      return unshuffled;
   }
 
   static void InPlaceUnshuffle( uint8* data, size_type size, size_type itemSize )
   {
      if ( size > 0 && data != nullptr )
      {
         const ByteArray shuffled( data, data+size );
         size_type numberOfItems = size / itemSize;
         ByteArray::const_iterator s = shuffled.Begin();
         for ( size_type j = 0; j < itemSize; ++j )
         {
            ByteArray::iterator u = data + j;
            for ( size_type i = 0; i < numberOfItems; ++i, ++s, u += itemSize )
               *u = *s;
         }
      }
   }
 
   void Throw( const String& errorMessage ) const;
 
   friend class PCL_CompressionEngine;
   friend class PCL_DecompressionEngine;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ZLibCompression : public Compression
{
public:
 
   String AlgorithmName() const override
   {
      return "ZLib";
   }
 
   int MaxCompressionLevel() const override;
 
   int DefaultCompressionLevel() const override;
 
 
private:
 
   size_type MinBlockSize() const override;
 
   size_type MaxBlockSize() const override;
 
   size_type MaxCompressedBlockSize( size_type size ) const override;
 
   size_type CompressBlock( void* outputData, size_type outputSize,
                            const void* inputData, size_type inputSize, int level ) const override;
 
   size_type UncompressBlock( void* outputData, size_type outputSize,
                              const void* inputData, size_type inputSize ) const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS LZ4Compression : public Compression
{
public:
 
   String AlgorithmName() const override
   {
      return "LZ4";
   }
 
   int MaxCompressionLevel() const override;
 
   int DefaultCompressionLevel() const override;
 
 
private:
 
   size_type MinBlockSize() const override;
 
   size_type MaxBlockSize() const override;
 
   size_type MaxCompressedBlockSize( size_type size ) const override;
 
   size_type CompressBlock( void* outputData, size_type outputSize,
                            const void* inputData, size_type inputSize, int level ) const override;
 
   size_type UncompressBlock( void* outputData, size_type outputSize,
                              const void* inputData, size_type inputSize ) const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS LZ4HCCompression : public Compression
{
public:
 
   String AlgorithmName() const override
   {
      return "LZ4-HC";
   }
 
   int MaxCompressionLevel() const override;
 
   int DefaultCompressionLevel() const override;
 
 
private:
 
   size_type MinBlockSize() const override;
 
   size_type MaxBlockSize() const override;
 
   size_type MaxCompressedBlockSize( size_type size ) const override;
 
   size_type CompressBlock( void* outputData, size_type outputSize,
                            const void* inputData, size_type inputSize, int level ) const override;
 
   size_type UncompressBlock( void* outputData, size_type outputSize,
                              const void* inputData, size_type inputSize ) const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ZstdCompression : public Compression
{
public:
 
   String AlgorithmName() const override
   {
      return "Zstd";
   }
 
   int MinCompressionLevel() const override;
 
   int MaxCompressionLevel() const override;
 
   int DefaultCompressionLevel() const override;
 
private:
 
   size_type MinBlockSize() const override;
 
   size_type MaxBlockSize() const override;
 
   size_type MaxCompressedBlockSize( size_type size ) const override;
 
   size_type CompressBlock( void* outputData, size_type outputSize,
                            const void* inputData, size_type inputSize, int level ) const override;
 
   size_type UncompressBlock( void* outputData, size_type outputSize,
                              const void* inputData, size_type inputSize ) const override;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Compression_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Compression.h - Released 2024-06-18T15:48:54Z