zstdlib 0.2.0 → 0.3.0

data/ext/zstdlib/{zstd-1.4.0 → zstd-1.4.2}/lib/zstd.h

@@ -71,7 +71,7 @@ extern "C" {
 /*------   Version   ------*/
 #define ZSTD_VERSION_MAJOR    1
 #define ZSTD_VERSION_MINOR    4
-#define ZSTD_VERSION_RELEASE  0
+#define ZSTD_VERSION_RELEASE  2
 
 #define ZSTD_VERSION_NUMBER  (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
 ZSTDLIB_API unsigned ZSTD_versionNumber(void);   /**< to check runtime library version */
@@ -82,16 +82,16 @@ ZSTDLIB_API unsigned ZSTD_versionNumber(void);   /**< to check runtime library v
 #define ZSTD_VERSION_STRING ZSTD_EXPAND_AND_QUOTE(ZSTD_LIB_VERSION)
 ZSTDLIB_API const char* ZSTD_versionString(void);   /* requires v1.3.0+ */
 
-/***************************************
-*  Default constant
-***************************************/
+/* *************************************
+ *  Default constant
+ ***************************************/
 #ifndef ZSTD_CLEVEL_DEFAULT
 #  define ZSTD_CLEVEL_DEFAULT 3
 #endif
 
-/***************************************
-*  Constants
-***************************************/
+/* *************************************
+ *  Constants
+ ***************************************/
 
 /* All magic numbers are supposed read/written to/from files/memory using little-endian convention */
 #define ZSTD_MAGICNUMBER            0xFD2FB528    /* valid since v0.8.0 */
@@ -183,9 +183,14 @@ ZSTDLIB_API int         ZSTD_maxCLevel(void);               /*!< maximum compres
 ***************************************/
 /*= Compression context
  *  When compressing many times,
- *  it is recommended to allocate a context just once, and re-use it for each successive compression operation.
+ *  it is recommended to allocate a context just once,
+ *  and re-use it for each successive compression operation.
  *  This will make workload friendlier for system's memory.
- *  Use one context per thread for parallel execution in multi-threaded environments. */
+ *  Note : re-using context is just a speed / resource optimization.
+ *         It doesn't change the compression ratio, which remains identical.
+ *  Note 2 : In multi-threaded environments,
+ *         use one different context per thread for parallel execution.
+ */
 typedef struct ZSTD_CCtx_s ZSTD_CCtx;
 ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
 ZSTDLIB_API size_t     ZSTD_freeCCtx(ZSTD_CCtx* cctx);
@@ -380,6 +385,7 @@ typedef enum {
      * ZSTD_c_forceMaxWindow
      * ZSTD_c_forceAttachDict
      * ZSTD_c_literalCompressionMode
+     * ZSTD_c_targetCBlockSize
      * Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
      * note : never ever use experimentalParam? names directly;
      *        also, the enums values themselves are unstable and can still change.
@@ -389,6 +395,7 @@ typedef enum {
      ZSTD_c_experimentalParam3=1000,
      ZSTD_c_experimentalParam4=1001,
      ZSTD_c_experimentalParam5=1002,
+     ZSTD_c_experimentalParam6=1003,
 } ZSTD_cParameter;
 
 typedef struct {
@@ -657,17 +664,33 @@ ZSTDLIB_API size_t ZSTD_compressStream2( ZSTD_CCtx* cctx,
                                          ZSTD_inBuffer* input,
                                          ZSTD_EndDirective endOp);
 
+
+/* These buffer sizes are softly recommended.
+ * They are not required : ZSTD_compressStream*() happily accepts any buffer size, for both input and output.
+ * Respecting the recommended size just makes it a bit easier for ZSTD_compressStream*(),
+ * reducing the amount of memory shuffling and buffering, resulting in minor performance savings.
+ *
+ * However, note that these recommendations are from the perspective of a C caller program.
+ * If the streaming interface is invoked from some other language,
+ * especially managed ones such as Java or Go, through a foreign function interface such as jni or cgo,
+ * a major performance rule is to reduce crossing such interface to an absolute minimum.
+ * It's not rare that performance ends being spent more into the interface, rather than compression itself.
+ * In which cases, prefer using large buffers, as large as practical,
+ * for both input and output, to reduce the nb of roundtrips.
+ */
 ZSTDLIB_API size_t ZSTD_CStreamInSize(void);    /**< recommended size for input buffer */
-ZSTDLIB_API size_t ZSTD_CStreamOutSize(void);   /**< recommended size for output buffer. Guarantee to successfully flush at least one complete compressed block in all circumstances. */
+ZSTDLIB_API size_t ZSTD_CStreamOutSize(void);   /**< recommended size for output buffer. Guarantee to successfully flush at least one complete compressed block. */
 
-/*******************************************************************************
- * This is a legacy streaming API, and can be replaced by ZSTD_CCtx_reset() and
- * ZSTD_compressStream2(). It is redundant, but is still fully supported.
+
+/* *****************************************************************************
+ * This following is a legacy streaming API.
+ * It can be replaced by ZSTD_CCtx_reset() and ZSTD_compressStream2().
+ * It is redundant, but remains fully supported.
  * Advanced parameters and dictionary compression can only be used through the
  * new API.
  ******************************************************************************/
 
-/**
+/*!
  * Equivalent to:
  *
  *     ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
@@ -675,16 +698,16 @@ ZSTDLIB_API size_t ZSTD_CStreamOutSize(void);   /**< recommended size for output
  *     ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
  */
 ZSTDLIB_API size_t ZSTD_initCStream(ZSTD_CStream* zcs, int compressionLevel);
-/**
+/*!
  * Alternative for ZSTD_compressStream2(zcs, output, input, ZSTD_e_continue).
  * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
  * the next read size (if non-zero and not an error). ZSTD_compressStream2()
- * returns the number of bytes left to flush (if non-zero and not an error).
+ * returns the minimum nb of bytes left to flush (if non-zero and not an error).
  */
 ZSTDLIB_API size_t ZSTD_compressStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
-/** Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_flush). */
+/*! Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_flush). */
 ZSTDLIB_API size_t ZSTD_flushStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output);
-/** Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_end). */
+/*! Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_end). */
 ZSTDLIB_API size_t ZSTD_endStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output);
 
 
@@ -969,7 +992,7 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
 #endif  /* ZSTD_H_235446 */
 
 
-/****************************************************************************************
+/* **************************************************************************************
  *   ADVANCED AND EXPERIMENTAL FUNCTIONS
  ****************************************************************************************
  * The definitions in the following section are considered experimental.
@@ -1037,6 +1060,10 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
 #define ZSTD_LDM_HASHRATELOG_MIN     0
 #define ZSTD_LDM_HASHRATELOG_MAX (ZSTD_WINDOWLOG_MAX - ZSTD_HASHLOG_MIN)
 
+/* Advanced parameter bounds */
+#define ZSTD_TARGETCBLOCKSIZE_MIN   64
+#define ZSTD_TARGETCBLOCKSIZE_MAX   ZSTD_BLOCKSIZE_MAX
+
 /* internal */
 #define ZSTD_HASHLOG3_MAX           17
 
@@ -1162,7 +1189,7 @@ typedef enum {
  *            however it does mean that all frame data must be present and valid. */
 ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
 
-/** ZSTD_decompressBound() :
+/*! ZSTD_decompressBound() :
  *  `src` should point to the start of a series of ZSTD encoded and/or skippable frames
  *  `srcSize` must be the _exact_ size of this series
  *       (i.e. there should be a frame boundary at `src + srcSize`)
@@ -1409,6 +1436,11 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
  */
 #define ZSTD_c_literalCompressionMode ZSTD_c_experimentalParam5
 
+/* Tries to fit compressed block size to be around targetCBlockSize.
+ * No target when targetCBlockSize == 0.
+ * There is no guarantee on compressed block size (default:0) */
+#define ZSTD_c_targetCBlockSize ZSTD_c_experimentalParam6
+
 /*! ZSTD_CCtx_getParameter() :
  *  Get the requested compression parameter value, selected by enum ZSTD_cParameter,
  *  and store it into int* value.
@@ -1843,7 +1875,7 @@ typedef struct {
     unsigned checksumFlag;
 } ZSTD_frameHeader;
 
-/** ZSTD_getFrameHeader() :
+/*! ZSTD_getFrameHeader() :
  *  decode Frame Header, or requires larger `srcSize`.
  * @return : 0, `zfhPtr` is correctly filled,
  *          >0, `srcSize` is too small, value is wanted `srcSize` amount,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zstdlib
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Oleg A. Khlybov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,61 +128,65 @@ files:
 - ext/zstdlib/zlib.mk
 - ext/zstdlib/zlibwrapper.mk
 - ext/zstdlib/zlibwrapper/zlibwrapper.c
-- ext/zstdlib/zstd-1.4.0/lib/common/bitstream.h
-- ext/zstdlib/zstd-1.4.0/lib/common/compiler.h
-- ext/zstdlib/zstd-1.4.0/lib/common/cpu.h
-- ext/zstdlib/zstd-1.4.0/lib/common/debug.c
-- ext/zstdlib/zstd-1.4.0/lib/common/debug.h
-- ext/zstdlib/zstd-1.4.0/lib/common/entropy_common.c
-- ext/zstdlib/zstd-1.4.0/lib/common/error_private.c
-- ext/zstdlib/zstd-1.4.0/lib/common/error_private.h
-- ext/zstdlib/zstd-1.4.0/lib/common/fse.h
-- ext/zstdlib/zstd-1.4.0/lib/common/fse_decompress.c
-- ext/zstdlib/zstd-1.4.0/lib/common/huf.h
-- ext/zstdlib/zstd-1.4.0/lib/common/mem.h
-- ext/zstdlib/zstd-1.4.0/lib/common/pool.c
-- ext/zstdlib/zstd-1.4.0/lib/common/pool.h
-- ext/zstdlib/zstd-1.4.0/lib/common/threading.c
-- ext/zstdlib/zstd-1.4.0/lib/common/threading.h
-- ext/zstdlib/zstd-1.4.0/lib/common/xxhash.c
-- ext/zstdlib/zstd-1.4.0/lib/common/xxhash.h
-- ext/zstdlib/zstd-1.4.0/lib/common/zstd_common.c
-- ext/zstdlib/zstd-1.4.0/lib/common/zstd_errors.h
-- ext/zstdlib/zstd-1.4.0/lib/common/zstd_internal.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/fse_compress.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/hist.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/hist.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/huf_compress.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_compress.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_compress_internal.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_double_fast.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_double_fast.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_fast.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_fast.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_lazy.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_lazy.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_ldm.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_ldm.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_opt.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstd_opt.h
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstdmt_compress.c
-- ext/zstdlib/zstd-1.4.0/lib/compress/zstdmt_compress.h
-- ext/zstdlib/zstd-1.4.0/lib/decompress/huf_decompress.c
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_ddict.c
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_ddict.h
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_decompress.c
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_decompress_block.c
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_decompress_block.h
-- ext/zstdlib/zstd-1.4.0/lib/decompress/zstd_decompress_internal.h
-- ext/zstdlib/zstd-1.4.0/lib/zstd.h
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzclose.c
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzcompatibility.h
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzguts.h
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzlib.c
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzread.c
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/gzwrite.c
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/zstd_zlibwrapper.c
-- ext/zstdlib/zstd-1.4.0/zlibWrapper/zstd_zlibwrapper.h
+- ext/zstdlib/zstd-1.4.2/lib/common/bitstream.h
+- ext/zstdlib/zstd-1.4.2/lib/common/compiler.h
+- ext/zstdlib/zstd-1.4.2/lib/common/cpu.h
+- ext/zstdlib/zstd-1.4.2/lib/common/debug.c
+- ext/zstdlib/zstd-1.4.2/lib/common/debug.h
+- ext/zstdlib/zstd-1.4.2/lib/common/entropy_common.c
+- ext/zstdlib/zstd-1.4.2/lib/common/error_private.c
+- ext/zstdlib/zstd-1.4.2/lib/common/error_private.h
+- ext/zstdlib/zstd-1.4.2/lib/common/fse.h
+- ext/zstdlib/zstd-1.4.2/lib/common/fse_decompress.c
+- ext/zstdlib/zstd-1.4.2/lib/common/huf.h
+- ext/zstdlib/zstd-1.4.2/lib/common/mem.h
+- ext/zstdlib/zstd-1.4.2/lib/common/pool.c
+- ext/zstdlib/zstd-1.4.2/lib/common/pool.h
+- ext/zstdlib/zstd-1.4.2/lib/common/threading.c
+- ext/zstdlib/zstd-1.4.2/lib/common/threading.h
+- ext/zstdlib/zstd-1.4.2/lib/common/xxhash.c
+- ext/zstdlib/zstd-1.4.2/lib/common/xxhash.h
+- ext/zstdlib/zstd-1.4.2/lib/common/zstd_common.c
+- ext/zstdlib/zstd-1.4.2/lib/common/zstd_errors.h
+- ext/zstdlib/zstd-1.4.2/lib/common/zstd_internal.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/fse_compress.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/hist.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/hist.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/huf_compress.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress_internal.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress_literals.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress_literals.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress_sequences.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_compress_sequences.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_double_fast.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_double_fast.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_fast.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_fast.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_lazy.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_lazy.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_ldm.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_ldm.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_opt.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstd_opt.h
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstdmt_compress.c
+- ext/zstdlib/zstd-1.4.2/lib/compress/zstdmt_compress.h
+- ext/zstdlib/zstd-1.4.2/lib/decompress/huf_decompress.c
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_ddict.c
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_ddict.h
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_decompress.c
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_decompress_block.c
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_decompress_block.h
+- ext/zstdlib/zstd-1.4.2/lib/decompress/zstd_decompress_internal.h
+- ext/zstdlib/zstd-1.4.2/lib/zstd.h
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzclose.c
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzcompatibility.h
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzguts.h
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzlib.c
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzread.c
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/gzwrite.c
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/zstd_zlibwrapper.c
+- ext/zstdlib/zstd-1.4.2/zlibWrapper/zstd_zlibwrapper.h
 - ext/zstdlib/zstd.mk
 - lib/zstdlib.rb
 - test/zstdlib_test.rb
@@ -205,8 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby interface for the Zstd data compression library