]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
made ZSTD_compress_generic() definition accessible
authorYann Collet <cyan@fb.com>
Fri, 12 May 2017 20:46:49 +0000 (13:46 -0700)
committerYann Collet <cyan@fb.com>
Fri, 12 May 2017 20:46:49 +0000 (13:46 -0700)
note that the implementation is not done yet.

doc/zstd_manual.html
lib/compress/zstd_compress.c
lib/zstd.h

index 9b0973164f40b90550d6ba5e123cb324fdda113a..a06d4b03791d625fb1230030289bec7d6428879e 100644 (file)
@@ -574,13 +574,13 @@ size_t ZSTD_estimateDDictSize(size_t dictSize);
 size_t ZSTD_CDict_setParameter(ZSTD_CDict* cdict, ZSTD_cParameter param, unsigned value);  </b>/* Not ready yet ! */<b>
 size_t ZSTD_CDict_loadDictionary(ZSTD_CDict* cdict, const void* dict, size_t dictSize);    </b>/* Not ready yet ! */<b>
 </b><p>  Create a CDict object which is still mutable after creation.
-  It allows usage of ZSTD_CDict_setParameter().
+  It's the only one case allowing usage of ZSTD_CDict_setParameter().
   Once all compression parameters are selected,
   it's possible to load the target dictionary, using ZSTD_CDict_loadDictionary().
-  Dictionary content will be copied internally, except if ZSTD_p_refDictContent is used.
+  Dictionary content will be copied internally (except if ZSTD_p_refDictContent is set).
   After loading the dictionary, no more change is possible.
   The only remaining operation is to free CDict object.
-  Note : An unfinished CDict behaves the same as a NULL CDict when referenced into a CCtx.
+  Note : An unfinished CDict behaves the same as a NULL CDict if referenced into a CCtx.
  
 </p></pre><BR>
 
index edf4609f7847a29d15252d86a5d3515e1ec231dc..0db9d1cd0b09c9100249f5f404caf09c1e5fbe62 100644 (file)
@@ -2468,14 +2468,14 @@ static size_t ZSTD_compressBlock_internal(ZSTD_CCtx* zc, void* dst, size_t dstCa
 }
 
 
-/*! ZSTD_compress_generic() :
+/*! ZSTD_compress_frameChunk() :
 *   Compress a chunk of data into one or multiple blocks.
 *   All blocks will be terminated, all input will be consumed.
 *   Function will issue an error if there is not enough `dstCapacity` to hold the compressed content.
 *   Frame is supposed already started (header already produced)
 *   @return : compressed size, or an error code
 */
-static size_t ZSTD_compress_generic (ZSTD_CCtx* cctx,
+static size_t ZSTD_compress_frameChunk (ZSTD_CCtx* cctx,
                                      void* dst, size_t dstCapacity,
                                const void* src, size_t srcSize,
                                      U32 lastFrameChunk)
@@ -2630,7 +2630,7 @@ static size_t ZSTD_compressContinue_internal (ZSTD_CCtx* cctx,
 
     if (srcSize) {
         size_t const cSize = frame ?
-                             ZSTD_compress_generic (cctx, dst, dstCapacity, src, srcSize, lastFrameChunk) :
+                             ZSTD_compress_frameChunk (cctx, dst, dstCapacity, src, srcSize, lastFrameChunk) :
                              ZSTD_compressBlock_internal (cctx, dst, dstCapacity, src, srcSize);
         if (ZSTD_isError(cSize)) return cSize;
         cctx->consumedSrcSize += srcSize;
index be2168bf92a25bcf8639380e2ecd9e63283b4697..fcefc7af67774933681039a2d20f17e4de5399e3 100644 (file)
@@ -688,13 +688,13 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx, const void* prefix, size
 
 /*! ZSTD_CDict_createEmpty() :
  *  Create a CDict object which is still mutable after creation.
- *  It allows usage of ZSTD_CDict_setParameter().
+ *  It's the only one case allowing usage of ZSTD_CDict_setParameter().
  *  Once all compression parameters are selected,
  *  it's possible to load the target dictionary, using ZSTD_CDict_loadDictionary().
- *  Dictionary content will be copied internally, except if ZSTD_p_refDictContent is used.
+ *  Dictionary content will be copied internally (except if ZSTD_p_refDictContent is set).
  *  After loading the dictionary, no more change is possible.
  *  The only remaining operation is to free CDict object.
- *  Note : An unfinished CDict behaves the same as a NULL CDict when referenced into a CCtx.
+ *  Note : An unfinished CDict behaves the same as a NULL CDict if referenced into a CCtx.
  */
 ZSTDLIB_API ZSTD_CDict* ZSTD_CDict_createEmpty(void);   /* Not ready yet ! */
 ZSTDLIB_API size_t ZSTD_CDict_setParameter(ZSTD_CDict* cdict, ZSTD_cParameter param, unsigned value);  /* Not ready yet ! */
@@ -714,7 +714,6 @@ ZSTDLIB_API size_t ZSTD_CDict_loadDictionary(ZSTD_CDict* cdict, const void* dict
 ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);  /* Not ready yet ! */
 
 
-#if 0
 // Target advanced compression API
 // Not ready yet !!!
 
@@ -749,9 +748,9 @@ ZSTDLIB_API size_t ZSTD_compress_generic (ZSTD_CCtx* cctx,
  *  It's allowed to change compression parameters after a reset.
  *  Any internal data not yet flushed is cancelled.
  */
+// Not ready yet !!!
 ZSTDLIB_API size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx);
 
-#endif
 
 
 /*--- Advanced decompression functions ---*/