annotate Core/Compression/DeflateBaseCompressor.h @ 2235:99d151fafab9

merge
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 16 Dec 2016 14:35:52 +0100
parents b1291df2f780
children a3a65de1840f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1513
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "IBufferCompressor.h"
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <stdint.h>
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class DeflateBaseCompressor : public IBufferCompressor
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 private:
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 uint8_t compressionLevel_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 bool prefixWithUncompressedSize_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
1513
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
47 protected:
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
48 uint64_t ReadUncompressedSizePrefix(const void* compressed,
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
49 size_t compressedSize);
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
50
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 public:
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 DeflateBaseCompressor() :
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 compressionLevel_(6),
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 prefixWithUncompressedSize_(false)
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 void SetCompressionLevel(uint8_t level);
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 void SetPrefixWithUncompressedSize(bool prefix)
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 prefixWithUncompressedSize_ = prefix;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 bool HasPrefixWithUncompressedSize() const
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 return prefixWithUncompressedSize_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 uint8_t GetCompressionLevel() const
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 return compressionLevel_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 };
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 }