annotate Resources/Orthanc/Core/Images/ImageBuffer.h @ 98:ff0ef01c332c

shared copyright with osimis
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 04 Jan 2017 16:43:25 +0100
parents 7a3853d51c45
children a18bfe1fdd62
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
98
ff0ef01c332c shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
5 * Copyright (C) 2017 Osimis, Belgium
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "ImageAccessor.h"
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <vector>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <stdint.h>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 #include <boost/noncopyable.hpp>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 namespace Orthanc
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 class ImageBuffer : public boost::noncopyable
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 private:
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 bool changed_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 bool forceMinimalPitch_; // Currently unused
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 PixelFormat format_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 unsigned int width_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 unsigned int height_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 unsigned int pitch_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void *buffer_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 void Initialize();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 void Allocate();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 void Deallocate();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 public:
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 ImageBuffer(PixelFormat format,
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 unsigned int width,
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 unsigned int height,
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 bool forceMinimalPitch);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 ImageBuffer()
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 Initialize();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 ~ImageBuffer()
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 Deallocate();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 PixelFormat GetFormat() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 return format_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 void SetFormat(PixelFormat format);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 unsigned int GetWidth() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 return width_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 void SetWidth(unsigned int width);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 unsigned int GetHeight() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 return height_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 void SetHeight(unsigned int height);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 unsigned int GetBytesPerPixel() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 return ::Orthanc::GetBytesPerPixel(format_);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 ImageAccessor GetAccessor();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 ImageAccessor GetConstAccessor();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 bool IsMinimalPitchForced() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 return forceMinimalPitch_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 void AcquireOwnership(ImageBuffer& other);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 };
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 }