OLD | NEW |
1 // Copyright (c) 2010 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2010 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef REMOTING_BASE_COMPRESSOR_H_ | 5 #ifndef REMOTING_BASE_COMPRESSOR_H_ |
6 #define REMOTING_BASE_COMPRESSOR_H_ | 6 #define REMOTING_BASE_COMPRESSOR_H_ |
7 | 7 |
8 #include "base/basictypes.h" | 8 #include "base/basictypes.h" |
9 | 9 |
10 namespace remoting { | 10 namespace remoting { |
11 | 11 |
12 // An object to compress data losslessly. Compressed data can be fully | 12 // An object to compress data losslessly. Compressed data can be fully |
13 // recovered by a Decompressor. | 13 // recovered by a Decompressor. |
14 // | 14 // |
15 // Note that a Compressor can only be used on one stream during its | 15 // Note that a Compressor can only be used on one stream during its |
16 // lifetime. This object should be destroyed after use. | 16 // lifetime. This object should be destroyed after use. |
17 class Compressor { | 17 class Compressor { |
18 public: | 18 public: |
| 19 |
| 20 // Defines the flush modes for a compressor. |
| 21 enum CompressorFlush { |
| 22 CompressorNoFlush, |
| 23 CompressorSyncFlush, |
| 24 CompressorFinish, |
| 25 }; |
19 virtual ~Compressor() {} | 26 virtual ~Compressor() {} |
20 | 27 |
21 // Compress |input_data| with |input_size| bytes. | 28 // Compress |input_data| with |input_size| bytes. |
22 // | 29 // |
23 // |output_data| is provided by the caller and |output_size| is the | 30 // |output_data| is provided by the caller and |output_size| is the |
24 // size of |output_data|. |output_size| must be greater than 0. | 31 // size of |output_data|. |output_size| must be greater than 0. |
25 // | 32 // |
26 // |input_size| is set to 0 to indicate the end of input stream. | 33 // |flush| is set to one of the three value: |
| 34 // - CompressorNoFlush |
| 35 // No flushing is requested |
| 36 // - CompressorSyncFlush |
| 37 // Write all pending output and write a synchronization point in the |
| 38 // output data stream. |
| 39 // - CompressorFinish |
| 40 // Mark the end of stream. |
27 // | 41 // |
28 // Compressed data is written to |output_data|. |consumed| will | 42 // Compressed data is written to |output_data|. |consumed| will |
29 // contain the number of bytes consumed from the input. |written| | 43 // contain the number of bytes consumed from the input. |written| |
30 // contains the number of bytes written to output. | 44 // contains the number of bytes written to output. |
31 // | 45 // |
32 // Returns true if this method needs to be called again because | 46 // Returns true if this method needs to be called again because |
33 // there is more data to be written out. This is particularly | 47 // there is more data to be written out. This is particularly |
34 // useful for end of the compression stream. | 48 // useful for end of the compression stream. |
35 virtual bool Process(const uint8* input_data, int input_size, | 49 virtual bool Process(const uint8* input_data, int input_size, |
36 uint8* output_data, int output_size, | 50 uint8* output_data, int output_size, |
37 int* consumed, int* written) = 0; | 51 CompressorFlush flush, int* consumed, int* written) = 0; |
38 }; | 52 }; |
39 | 53 |
40 } // namespace remoting | 54 } // namespace remoting |
41 | 55 |
42 #endif // REMOTING_BASE_COMPRESSOR_H_ | 56 #endif // REMOTING_BASE_COMPRESSOR_H_ |
OLD | NEW |