Merge pull request #405 from sebres/gh-403-zstd--max

Ultimate (and advanced max zstd) level

Author: mcmilk

CPP/7zip/Archive/7z/7zHandler.cpp

@@ -604,7 +604,7 @@ HRESULT CHandler::ObtainBlockMethods(CNum folderIndex, PROPVARIANT *prop, CHandl
         {
           UInt32 l = props[2];
           if (info) {
-            if (l <= 22) {
+            if (l <= 22 || l == Z7_ZSTD_ULTIMATE_LEV) {
               lev = l;
             } else {
               // todo: need parameter to set fast mode (to NCoderPropID::kFast)
@@ -625,6 +625,11 @@ HRESULT CHandler::ObtainBlockMethods(CNum folderIndex, PROPVARIANT *prop, CHandl
           if (l <= 22) {
             *dest++ = 'l';
             ConvertUInt32ToString(l, dest);
+          } else if (l == Z7_ZSTD_ULTIMATE_LEV) { // special level for zstd --max (advanced ultra) 
+            *dest++ = 'm';
+            *dest++ = 'a';
+            *dest++ = 'x';
+            *dest = '\0';
           } else {
             *dest++ = 'f';
             *dest++ = 'l';

CPP/7zip/Archive/Common/HandlerOut.cpp

@@ -184,6 +184,16 @@ HRESULT CMultiMethodProps::SetProperty(const wchar_t *nameSpec, const PROPVARIAN
     _level = 9;
     return ParsePropToUInt32(name, value, _level);
   }
+  if (name == L"max")
+  {
+    bool _max;
+    const HRESULT res = PROPVARIANT_to_bool(value, _max);
+    if (res == S_OK && _max) {
+      // adjust level (zstd --max), set it to the highest level too (e. g. setting of options.MaxFilter for BCJ2 etc)
+      _level = Z7_ZSTD_ULTIMATE_LEV;
+    }
+    return res;
+  }
 
   if (name.IsPrefixedBy_Ascii_NoCase("yx"))
   {

CPP/7zip/Common/MethodProps.cpp

@@ -369,7 +369,8 @@ unsigned CMethodProps::GetLevel() const
   if (Props[(unsigned)i].Value.vt != VT_UI4)
     return 9;
   UInt32 level = Props[(unsigned)i].Value.ulVal;
-  return level > 9 ? 9 : (unsigned)level;
+  // return level > 9 ? 9 : (unsigned)level;
+  return level;
 }
 
 struct CNameToPropID
@@ -422,7 +423,8 @@ static const CNameToPropID g_NameToPropID[] =
   { VT_UI4, "ldmhlog" },
   { VT_UI4, "ldmslen" },
   { VT_UI4, "ldmblog" },
-  { VT_UI4, "ldmhevery" }
+  { VT_UI4, "ldmhevery" },
+  { VT_BOOL, "max" }
 };
 
 #if defined(static_assert) || (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)) || (_MSC_VER >= 1900)
@@ -581,11 +583,24 @@ HRESULT CMethodProps::SetParam(const UString &name, const UString &value)
     }
     if (!ConvertProperty(propValue, nameToPropID.VarType, prop.Value))
       return E_INVALIDARG;
+    if (prop.Id == NCoderPropID::kAdvMax && prop.Value.boolVal) {
+      setMaxCompression();
+    }
   }
   Props.Add(prop);
   return S_OK;
 }
 
+void CMethodProps::setMaxCompression()
+{
+  // adjust level (zstd --max), set it to the highest level too (e. g. setting of options.MaxFilter for BCJ2 etc)
+  CProp prop;
+  prop.Id = (unsigned)NCoderPropID::kLevel;
+  prop.Value.vt = VT_UI4;
+  prop.Value.ulVal = Z7_ZSTD_ULTIMATE_LEV;
+  Props.Add(prop);
+}
+
 HRESULT CMethodProps::ParseParamsFromString(const UString &srcString)
 {
   UStringVector params;
@@ -631,6 +646,9 @@ HRESULT CMethodProps::ParseParamsFromPROPVARIANT(const UString &realName, const
   {
     if (!ConvertProperty(value, nameToPropID.VarType, prop.Value))
       return E_INVALIDARG;
+    if (prop.Id == NCoderPropID::kAdvMax && prop.Value.boolVal) {
+      setMaxCompression();
+    }
   }
   Props.Add(prop);
   return S_OK;

CPP/7zip/Common/MethodProps.h

@@ -86,6 +86,7 @@ struct CProps
 class CMethodProps: public CProps
 {
   HRESULT SetParam(const UString &name, const UString &value);
+  void setMaxCompression();
 public:
   unsigned GetLevel() const;
   int Get_NumThreads() const

CPP/7zip/Compress/ZstdEncoder.cpp

@@ -17,6 +17,7 @@ CEncoder::CEncoder():
   _processedIn(0),
   _processedOut(0),
   _numThreads(NWindows::NSystem::GetNumberOfProcessors()),
+  _Max(false),
   _Long(-1),
   _Level(ZSTD_CLEVEL_DEFAULT),
   _Strategy(-1),
@@ -70,22 +71,33 @@ Z7_COM7F_IMF(CEncoder::SetCoderProperties(const PROPID * propIDs, const PROPVARI
         _Strategy = v;
         break;
       }
+    case NCoderPropID::kAdvMax:
+      if (!v)
+        break;
+    #if Z7_ZSTD_ADVMAX_ALLOWED // 64-bit only
+      _Max = true;
+    #endif
+      v = Z7_ZSTD_ULTIMATE_LEV;
     case NCoderPropID::kLevel:
       {
-        _Level = v;
+        _Level = !_Max ? v : Z7_ZSTD_ULTIMATE_LEV;
         if (v < 1) {
           _Level = 1;
         } else if ((Int32)v > ZSTD_maxCLevel()) {
+        #if Z7_ZSTD_ADVMAX_ALLOWED // 64-bit only
+          _Max = (_Level == Z7_ZSTD_ULTIMATE_LEV); // special case (level from GUI)
+        #endif
           _Level = ZSTD_maxCLevel();
         }
 
         /**
-         * zstd default levels: _Level => 1..ZSTD_maxCLevel()
+         * zstd default levels: _Level => 1..ZSTD_maxCLevel(), Z7_ZSTD_ULTIMATE_LEV (128) == --max
          */
-        _props._level = static_cast < Byte > (_Level);
+        _props._level = static_cast < Byte > (!_Max ? _Level : Z7_ZSTD_ULTIMATE_LEV);
         break;
       }
     case NCoderPropID::kFast:
+      if (!_Max)
       {
         /* like --fast in zstd cli program */
         UInt32 _Fast = v;
@@ -256,6 +268,26 @@ Z7_COM7F_IMF(CEncoder::Code(ISequentialInStream *inStream,
     if (!_dstBuf)
       return E_OUTOFMEMORY;
 
+  #if Z7_ZSTD_ADVMAX_ALLOWED // 64-bit only
+    // params from setMaxCompression(), https://github.com/facebook/zstd/blob/v1.5.7/programs/zstdcli.c#L642 :
+    if (_Max) {
+      _Long = 1;
+      _WindowLog = ZSTD_WINDOWLOG_MAX;
+      _ChainLog = ZSTD_CHAINLOG_MAX;
+      _HashLog = ZSTD_HASHLOG_MAX;
+      _SearchLog = ZSTD_SEARCHLOG_MAX;
+      _MinMatch = ZSTD_MINMATCH_MIN;
+      _TargetLen = ZSTD_TARGETLENGTH_MAX;
+      _Strategy = ZSTD_STRATEGY_MAX;
+      _OverlapLog = ZSTD_OVERLAPLOG_MAX;
+      _LdmHashLog = ZSTD_LDM_HASHLOG_MAX;
+      _LdmHashRateLog = 0; /* automatically derived */
+      _LdmMinMatch = 16; /* heuristic */
+      _LdmBucketSizeLog = ZSTD_LDM_BUCKETSIZELOG_MAX;
+      _Level = ZSTD_maxCLevel();
+    }
+  #endif
+
     /* setup level */
     err = ZSTD_CCtx_setParameter(_ctx, ZSTD_c_compressionLevel, (UInt32)_Level);
     if (ZSTD_isError(err)) return E_INVALIDARG;

CPP/7zip/Compress/ZstdEncoder.h

@@ -53,6 +53,7 @@ Z7_CLASS_IMP_COM_5(
   UInt32 _numThreads;
 
   /* zstd advanced compression options */
+  bool  _Max;
   Int32 _Long;
   Int32 _Level;
   Int32 _Strategy;

CPP/7zip/ICoder.h

@@ -152,10 +152,18 @@ namespace NCoderPropID
     kLdmSearchLength,   // VT_UI4 The minimum ldmslen is 4 and the maximum is 4096 (default: 64).
     kLdmBucketSizeLog,  // VT_UI4 The minimum ldmblog is 0 and the maximum is 8 (default: 3).
     kLdmHashRateLog,    // VT_UI4 The default value is wlog - ldmhlog.
+    kAdvMax,            // VT_BOOL 1=ZSTD --max (advanced max compression)
     k_NUM_DEFINED
   };
 }
 
+/* artificial level used to specify max possible level (for ZSTD advanced max compression, equivalent of --max) */
+#define Z7_ZSTD_ULTIMATE_LEV  255
+
+#if !defined (Z7_ZSTD_ADVMAX_ALLOWED) && INTPTR_MAX == INT64_MAX // allowed for 64-bit only
+#define Z7_ZSTD_ADVMAX_ALLOWED 1
+#endif
+
 #define Z7_IFACEM_ICompressSetCoderPropertiesOpt(x) \
   x(SetCoderPropertiesOpt(const PROPID *propIDs, const PROPVARIANT *props, UInt32 numProps))
 Z7_IFACE_CONSTR_CODER(ICompressSetCoderPropertiesOpt, 0x1F)

CPP/7zip/UI/Console/Main.cpp

@@ -123,9 +123,10 @@ DECLARE_AND_SET_CLIENT_VERSION_VAR
 #endif
 
 
-static const char * const kCopyrightString = "\n7-Zip"
-  PROG_POSTFIX_2
-  " " MY_VERSION_CPU
+#define kVersionString "7-Zip" PROG_POSTFIX_2 " " MY_VERSION_CPU
+
+static const char * const kCopyrightString = "\n"
+  kVersionString
   " : " MY_COPYRIGHT_DATE "\n";
 
 static const char * const kHelpString =
@@ -145,6 +146,7 @@ static const char * const kHelpString =
     "  t : Test integrity of archive\n"
     "  u : Update files to archive\n"
     "  x : eXtract files with full paths\n"
+    "  --version : Show version information\n"
     "\n"
     "<Switches>\n"
     "  -- : Stop switches and @listfile parsing\n"
@@ -881,6 +883,11 @@ int Main2(
     return 0;
   }
 
+  if (commandStrings.Size() == 1 && commandStrings[0] == L"--version") {
+    *g_StdStream << kVersionString;
+    return 0;
+  }
+
   CArcCmdLineOptions options;
 
   CArcCmdLineParser parser;

CPP/7zip/UI/GUI/CompressDialog.cpp

@@ -284,13 +284,6 @@ static const EMethodID g_XzMethods[] =
   kLZMA2
 };
 
-/*
-static const EMethodID g_ZstdMethods[] =
-{
-  kZSTD
-};
-*/
-
 /*
 static const EMethodID g_SwfcMethods[] =
 {
@@ -1673,11 +1666,12 @@ void CCompressDialog::SetLevel2()
   UInt32 LevelsMask = fi.LevelsMask;
   UInt32 LevelsStart = 1;
   UInt32 LevelsEnd = 9;
+  int id = -1;
   if (ai.LevelsMask != 0xFFFFFFFF)
     LevelsMask = ai.LevelsMask;
   else
   {
-    int id = GetMethodID();
+    id = GetMethodID();
     if (id == kCopy) {
       LevelsStart = 0;
       LevelsEnd = 0;
@@ -1699,12 +1693,14 @@ void CCompressDialog::SetLevel2()
     }
   }
   UInt32 level = m_Level.GetCount() > 0 ? (UInt32)m_Level.GetItemData_of_CurSel() : (LevelsEnd - LevelsStart + 1) / 2;
+  UInt32 readLevel = (UInt32)-1;
   m_Level.ResetContent();
   {
     int index = FindRegistryFormat(ai.Name);
     if (index >= 0)
     {
       const NCompression::CFormatOptions &fo = m_RegistryInfo.Formats[index];
+      readLevel = fo.Level;
       if (fo.Level <= LevelsEnd)
         level = fo.Level;
       else if (fo.Level == (UInt32)(Int32)-1)
@@ -1735,7 +1731,7 @@ void CCompressDialog::SetLevel2()
     {
       UString s = t;
       s.Add_UInt32(i);
-      s += L" (";
+      s += L" "; if (i <= 9) s += L" "; s += L"(";
       s += LangString(g_Levels[langID]);
       s += L")";
       int index = (int)m_Level.AddString(s);
@@ -1748,6 +1744,13 @@ void CCompressDialog::SetLevel2()
       m_Level.SetItemData(index, i);
     }
   }
+  if (1) { // ultimate level (max possible or zstd --max if allowed)
+    int index = (int)m_Level.AddString(L"-mmax  (Ultimate)");
+    m_Level.SetItemData(index, Z7_ZSTD_ULTIMATE_LEV);
+    if (readLevel == Z7_ZSTD_ULTIMATE_LEV) { // exception (available for any method), restore read from registry
+      level = readLevel;
+    }
+  }
   SetNearestSelectComboBox(m_Level, level);
 }
 

tests/7z.tcl

@@ -83,6 +83,10 @@ proc 7z_get_info {args} {
 				# to unix time (UTC, TZ independend)
 				set v [clock scan [regsub {\.\d+$} $v {}]]
 			}
+			if {$n eq "Method"} {
+				# remove version from method (unneeded and expecting adjustment of all tests by later version upgrades):
+				regsub -all {v\d+\.\d+,?} $v {} v
+			}
 			lappend fi $n $v
 		}
 		if {[llength $fi]} { lappend flst $fi }