Use compressionLevel in ZRLEEncoder

This change makes the ZRLEEncoder respect a client's desired compressionLevel. The ZlibLevel option is marked deprecated and removed from the manpages.
TigerVNC · Nov 20, 2023 · e2c4471 · e2c4471
1 parent 9abf88e
commit e2c4471
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 14 deletions.
diff --git a/common/rfb/Configuration.cxx b/common/rfb/Configuration.cxx
@@ -70,6 +70,15 @@ Configuration* Configuration::viewer() {
   return viewer_;
 }
 
+void warnDeprecatedOptions(const char* name)
+{
+  if (!strcasecmp(name, "ZlibLevel")) {
+    fprintf(stderr, "Warning: The ZlibLevel option is deprecated and is "
+                    "ignored by the server. The compression level can be set "
+                    "by the client instead.\n");
+  }
+}
+
 // -=- Configuration implementation
 
 bool Configuration::set(const char* n, const char* v, bool immutable) {
@@ -84,6 +93,7 @@ bool Configuration::set(const char* name, int len,
     if ((int)strlen(current->getName()) == len &&
         strncasecmp(current->getName(), name, len) == 0)
     {
+      warnDeprecatedOptions(current->getName());
       bool b = current->setParam(val);
       if (b && immutable) 
 	current->setImmutable();

diff --git a/common/rfb/ZRLEEncoder.cxx b/common/rfb/ZRLEEncoder.cxx
@@ -31,11 +31,11 @@
 
 using namespace rfb;
 
-IntParameter zlibLevel("ZlibLevel","Zlib compression level",-1);
+IntParameter zlibLevel("ZlibLevel","[DEPRECATED] Zlib compression level",-1);
 
 ZRLEEncoder::ZRLEEncoder(SConnection* conn)
   : Encoder(conn, encodingZRLE, EncoderPlain, 127),
-  zos(0,zlibLevel), mos(129*1024)
+  zos(0, 2), mos(129*1024)
 {
   zos.setUnderlying(&mos);
 }
@@ -50,6 +50,11 @@ bool ZRLEEncoder::isSupported()
   return conn->client.supportsEncoding(encodingZRLE);
 }
 
+void ZRLEEncoder::setCompressLevel(int level)
+{
+  zos.setCompressionLevel(level);
+}
+
 void ZRLEEncoder::writeRect(const PixelBuffer* pb, const Palette& palette)
 {
   int x, y;

diff --git a/common/rfb/ZRLEEncoder.h b/common/rfb/ZRLEEncoder.h
@@ -32,6 +32,8 @@ namespace rfb {
 
     virtual bool isSupported();
 
+    virtual void setCompressLevel(int level);
+
     virtual void writeRect(const PixelBuffer* pb, const Palette& palette);
     virtual void writeSolidRect(int width, int height,
                                 const PixelFormat& pf,

diff --git a/unix/x0vncserver/x0vncserver.man b/unix/x0vncserver/x0vncserver.man
@@ -287,12 +287,6 @@ Use MIT-SHM extension if available.  Using that extension accelerates reading
 the screen.  Default is on.
 .
 .TP
-.B \-ZlibLevel \fIlevel\fP
-Zlib compression level for ZRLE encoding (it does not affect Tight encoding).
-Acceptable values are between 0 and 9.  Default is to use the standard
-compression level provided by the \fBzlib\fP(3) compression library.
-.
-.TP
 .B \-ImprovedHextile
 Use improved compression algorithm for Hextile encoding which achieves better
 compression ratios by the cost of using slightly more CPU time.  Default is

diff --git a/unix/xserver/hw/vnc/Xvnc.man b/unix/xserver/hw/vnc/Xvnc.man
@@ -171,12 +171,6 @@ be either \fB0\fP (off), \fB1\fP (always) or \fB2\fP (auto). Default is
 \fB2\fP.
 .
 .TP
-.B \-ZlibLevel \fIlevel\fP
-Zlib compression level for ZRLE encoding (it does not affect Tight encoding).
-Acceptable values are between 0 and 9.  Default is to use the standard
-compression level provided by the \fBzlib\fP(3) compression library.
-.
-.TP
 .B \-ImprovedHextile
 Use improved compression algorithm for Hextile encoding which achieves better
 compression ratios by the cost of using slightly more CPU time.  Default is