Zlib compressor for Chromoting

A simple implementation of compressor using zlib.

Review URL: http://codereview.chromium.org/2841032

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@51386 0039d316-1c4b-4281-b951-d872f2087c98

5 files changed, 214 insertions, 3 deletions

diff --git a/remoting/base/compressor.h b/remoting/base/compressor.h
new file mode 100644
index 0000000..4c242bd
--- /dev/null
+++ b/remoting/base/compressor.h
@@ -0,0 +1,49 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef REMOTING_BASE_COMPRESSOR_H_
+#define REMOTING_BASE_COMPRESSOR_H_
+
+#include "base/basictypes.h"
+
+namespace remoting {
+
+// An object to compress data losslessly. Compressed data can be fully
+// recovered by a Decompressor.
+//
+// Note that a Compressor can only be used on one stream during its
+// lifetime. This object should be destroyed after use.
+class Compressor {
+ public:
+  virtual ~Compressor() {}
+
+  // Compress |input_data| with |input_size| bytes.
+  //
+  // |output_data| is provided by the caller and |output_size| is the
+  // size of |output_data|.
+  //
+  // Compressed data is written to |output_data|. |consumed| will
+  // contain the number of bytes consumed from the input. |written|
+  // contains the number of bytes written to output.
+  virtual void Write(const uint8* input_data, int input_size,
+                     uint8* output_data, int output_size,
+                     int* consumed, int* written) = 0;
+
+  // Flush all the remaining data in the compressor.
+  //
+  // |output_data| is provided by the caller and |output_size| is called
+  // with the size of |output_data|.
+  //
+  // Output data is written to |output_data| and |written| contains the
+  // number of bytes written.
+  //
+  // Returns true if |output_data| is not large enough to carry all
+  // compressed data and caller needs to call Flush() again.
+  virtual bool Flush(uint8* output_data, int output_size,
+                     int* written) = 0;
+};
+
+}  // namespace remoting
+
+#endif  // REMOTING_BASE_COMPRESSOR_H_
diff --git a/remoting/base/compressor_zlib.cc b/remoting/base/compressor_zlib.cc
new file mode 100644
index 0000000..e08d2f9
--- /dev/null
+++ b/remoting/base/compressor_zlib.cc
@@ -0,0 +1,73 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "remoting/base/compressor_zlib.h"
+
+#if defined(USE_SYSTEM_ZLIB)
+#include <zlib.h>
+// The code below uses the MOZ_Z_ forms of these functions in order that things
+// should work on Windows. In order to make this code cross platform, we map
+// back to the normal functions here in the case that we are using the system
+// zlib.
+#define MOZ_Z_deflate deflate
+#define MOZ_Z_deflateEnd deflateEnd
+#define MOZ_Z_deflateInit_ deflateInit_
+#else
+#include "third_party/zlib/zlib.h"
+#endif
+#include "base/logging.h"
+
+namespace remoting {
+
+CompressorZlib::CompressorZlib() {
+  stream_.reset(new z_stream());
+
+  stream_->next_in = Z_NULL;
+  stream_->zalloc = Z_NULL;
+  stream_->zfree = Z_NULL;
+  stream_->opaque = Z_NULL;
+
+  deflateInit(stream_.get(), Z_BEST_SPEED);
+}
+
+CompressorZlib::~CompressorZlib() {
+  deflateEnd(stream_.get());
+}
+
+void CompressorZlib::Write(const uint8* input_data, int input_size,
+                           uint8* output_data, int output_size,
+                           int* consumed, int* written) {
+  // Setup I/O parameters.
+  stream_->avail_in = input_size;
+  stream_->next_in = (Bytef*)input_data;
+  stream_->avail_out = output_size;
+  stream_->next_out = (Bytef*)output_data;
+
+  int ret = deflate(stream_.get(), Z_NO_FLUSH);
+  if (ret == Z_STREAM_ERROR) {
+    NOTREACHED() << "zlib compression failed";
+  }
+
+  *consumed = input_size - stream_->avail_in;
+  *written = output_size - stream_->avail_out;
+}
+
+bool CompressorZlib::Flush(uint8* output_data, int output_size,
+                           int* written) {
+  // Setup I/O parameters.
+  stream_->avail_in = 0;
+  stream_->next_in = NULL;
+  stream_->avail_out = output_size;
+  stream_->next_out = (Bytef*)output_data;
+
+  int ret = deflate(stream_.get(), Z_FINISH);
+  if (ret == Z_STREAM_ERROR) {
+    NOTREACHED() << "zlib compression failed";
+  }
+
+  *written = output_size - stream_->avail_out;
+  return ret == Z_OK;
+}
+
+}  // namespace remoting
diff --git a/remoting/base/compressor_zlib.h b/remoting/base/compressor_zlib.h
new file mode 100644
index 0000000..93bd5ca
--- /dev/null
+++ b/remoting/base/compressor_zlib.h
@@ -0,0 +1,33 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef REMOTING_BASE_COMPRESSOR_ZLIB_H_
+#define REMOTING_BASE_COMPRESSOR_ZLIB_H_
+
+#include "base/scoped_ptr.h"
+#include "remoting/base/compressor.h"
+
+typedef struct z_stream_s z_stream;
+
+namespace remoting {
+
+// A lossless compressor using zlib.
+class CompressorZlib : public Compressor {
+ public:
+  CompressorZlib();
+  virtual ~CompressorZlib();
+
+  // Compressor implementations.
+  virtual void Write(const uint8* input_data, int input_size,
+                     uint8* output_data, int output_size,
+                     int* consumed, int* written);
+  virtual bool Flush(uint8* output_data, int output_size, int* written);
+
+ private:
+  scoped_ptr<z_stream> stream_;
+};
+
+}  // namespace remoting
+
+#endif  // REMOTING_BASE_COMPRESSOR_ZLIB_H_
diff --git a/remoting/base/compressor_zlib_unittest.cc b/remoting/base/compressor_zlib_unittest.cc
new file mode 100644
index 0000000..9d65aad
--- /dev/null
+++ b/remoting/base/compressor_zlib_unittest.cc
@@ -0,0 +1,52 @@
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include <stdlib.h>
+
+#include "remoting/base/compressor_zlib.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+static void GenerateTestData(uint8* data, int size, int seed) {
+  srand(seed);
+  for (int i = 0; i < size; ++i)
+    data[i] = rand() % 256;
+}
+
+// Keep compressing |input_data| into |output_data| until the last
+// bytes is consumed.
+static void Compress(remoting::Compressor* compressor,
+                     const uint8* input_data, int input_size,
+                     uint8* output_data, int output_size) {
+
+  // Feed data into the compress until the end.
+  // This loop will rewrite |output_data| continuously.
+  while (input_size) {
+    int consumed, written;
+    compressor->Write(input_data, input_size,
+                      output_data, output_size,
+                      &consumed, &written);
+    input_data += consumed;
+    input_size -= consumed;
+  }
+
+  // And then flush the remaining data from the compressor.
+  int written;
+  while (compressor->Flush(output_data, output_size, &written)) {
+  }
+}
+
+TEST(CompressorZlibTest, SimpleCompress) {
+  static const int kRawDataSize = 1024 * 128;
+  static const int kCompressedDataSize = 256;
+  uint8 raw_data[kRawDataSize];
+  uint8 compressed_data[kCompressedDataSize];
+
+  // Generate the test data.g
+  GenerateTestData(raw_data, kRawDataSize, 99);
+
+  // Then use the compressor to compress.
+  remoting::CompressorZlib compressor;
+  Compress(&compressor, raw_data, kRawDataSize,
+           compressed_data, kCompressedDataSize);
+}
diff --git a/remoting/remoting.gyp b/remoting/remoting.gyp
index d0ad8cc..b045a62 100644
--- a/remoting/remoting.gyp
+++ b/remoting/remoting.gyp
@@ -72,7 +72,6 @@
         'chromoting_client',
         'chromoting_jingle_glue',
         '../third_party/ppapi/ppapi.gyp:ppapi_c',
-        '../third_party/zlib/zlib.gyp:zlib',
       ],
       'sources': [
         'client/plugin/chromoting_plugin.cc',
@@ -99,7 +98,7 @@
         }],
       ],  # end of 'conditions'
     },  # end of target 'chromoting_plugin'
-
+    
     {
       'target_name': 'chromoting_base',
       'type': '<(library)',
@@ -107,6 +106,7 @@
         '../gfx/gfx.gyp:gfx',
         '../media/media.gyp:media',
         '../third_party/protobuf2/protobuf.gyp:protobuf_lite',
+        '../third_party/zlib/zlib.gyp:zlib',
         'base/protocol/chromotocol.gyp:chromotocol_proto_lib',
         'chromoting_jingle_glue',
         # TODO(hclam): Enable VP8 in the build.
@@ -124,12 +124,15 @@
       'sources': [
         'base/constants.cc',
         'base/constants.h',
+        'base/lossless_compressor.h',
         'base/multiple_array_input_stream.cc',
         'base/multiple_array_input_stream.h',
         'base/protocol_decoder.cc',
         'base/protocol_decoder.h',
         'base/protocol_util.cc',
         'base/protocol_util.h',
+        'base/compressor_zlib.cc',
+        'base/compressor_zlib.h',
       ],
     },  # end of target 'chromoting_base'
 
@@ -324,13 +327,14 @@
         '../testing/gmock/include',
       ],
       'sources': [
-        'host/client_connection_unittest.cc',
+        'base/compressor_zlib_unittest.cc',
         'base/mock_objects.h',
         'base/multiple_array_input_stream_unittest.cc',
         'base/protocol_decoder_unittest.cc',
         'client/mock_objects.h',
         'client/decoder_verbatim_unittest.cc',
         'host/chromoting_host_context_unittest.cc',
+        'host/client_connection_unittest.cc',
         'host/differ_unittest.cc',
         'host/differ_block_unittest.cc',
         'host/json_host_config_unittest.cc',