annotate OrthancFramework/Sources/Compression/DeflateBaseCompressor.h @ 4119:bf7b9edf6b81 framework-lgpl

re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 19:17:56 +0200
parents d25f4c0fa160
children ab4d015af660
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
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * the License, or (at your option) any later version.
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
15 * Lesser General Public License for more details.
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * <http://www.gnu.org/licenses/>.
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "IBufferCompressor.h"
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
2508
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
27 #if !defined(ORTHANC_ENABLE_ZLIB)
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
28 # error The macro ORTHANC_ENABLE_ZLIB must be defined
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
29 #endif
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
30
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
31 #if ORTHANC_ENABLE_ZLIB != 1
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
32 # error ZLIB support must be enabled to include this file
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
33 #endif
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
34
91ee08d986f9 possibility to disable zlib support in the Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
35
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include <stdint.h>
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 namespace Orthanc
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
40 class ORTHANC_PUBLIC DeflateBaseCompressor : public IBufferCompressor
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 private:
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 uint8_t compressionLevel_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 bool prefixWithUncompressedSize_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
1513
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
46 protected:
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
47 uint64_t ReadUncompressedSizePrefix(const void* compressed,
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
48 size_t compressedSize);
fe07f82d83d3 gzip compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
49
1512
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 public:
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 DeflateBaseCompressor() :
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 compressionLevel_(6),
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 prefixWithUncompressedSize_(false)
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 {
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 void SetCompressionLevel(uint8_t level);
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 void SetPrefixWithUncompressedSize(bool prefix)
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 prefixWithUncompressedSize_ = prefix;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 bool HasPrefixWithUncompressedSize() const
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 return prefixWithUncompressedSize_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 uint8_t GetCompressionLevel() const
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 {
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 return compressionLevel_;
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 }
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 };
52dc56bcec7d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 }