Mercurial > hg > orthanc
annotate OrthancFramework/Sources/Images/ImageBuffer.h @ 4181:b416b6bf129b
clarification of sdk doc about deadlocks
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 08 Sep 2020 09:16:33 +0200 |
| parents | bf7b9edf6b81 |
| children | b30a8de92ad9 |
| rev | line source |
|---|---|
| 801 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
863
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 |
| 801 | 6 * |
| 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. |
| 801 | 11 * |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 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. |
| 801 | 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/>. |
| 801 | 20 **/ |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 25 #include "ImageAccessor.h" | |
| 26 | |
| 27 #include <vector> | |
| 28 #include <stdint.h> | |
| 863 | 29 #include <boost/noncopyable.hpp> |
| 801 | 30 |
| 31 namespace Orthanc | |
| 32 { | |
|
3992
f9863630ec7f
working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
33 class ORTHANC_PUBLIC ImageBuffer : public boost::noncopyable |
| 801 | 34 { |
| 35 private: | |
| 36 bool changed_; | |
| 37 | |
| 844 | 38 bool forceMinimalPitch_; // Currently unused |
| 801 | 39 PixelFormat format_; |
| 40 unsigned int width_; | |
| 41 unsigned int height_; | |
| 42 unsigned int pitch_; | |
| 863 | 43 void *buffer_; |
|
853
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
44 |
|
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
45 void Initialize(); |
| 801 | 46 |
| 47 void Allocate(); | |
| 48 | |
| 863 | 49 void Deallocate(); |
| 50 | |
| 801 | 51 public: |
|
1608
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
52 ImageBuffer(PixelFormat format, |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
53 unsigned int width, |
| 2107 | 54 unsigned int height, |
| 55 bool forceMinimalPitch); | |
|
853
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
56 |
|
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
57 ImageBuffer() |
|
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
58 { |
|
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
59 Initialize(); |
|
839be3022203
DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
844
diff
changeset
|
60 } |
| 801 | 61 |
| 863 | 62 ~ImageBuffer() |
| 63 { | |
| 64 Deallocate(); | |
| 65 } | |
| 66 | |
| 801 | 67 PixelFormat GetFormat() const |
| 68 { | |
| 69 return format_; | |
| 70 } | |
| 71 | |
| 72 void SetFormat(PixelFormat format); | |
| 73 | |
| 74 unsigned int GetWidth() const | |
| 75 { | |
| 76 return width_; | |
| 77 } | |
| 78 | |
| 79 void SetWidth(unsigned int width); | |
| 80 | |
| 81 unsigned int GetHeight() const | |
| 82 { | |
| 83 return height_; | |
| 84 } | |
| 85 | |
| 86 void SetHeight(unsigned int height); | |
| 87 | |
| 88 unsigned int GetBytesPerPixel() const | |
| 89 { | |
| 90 return ::Orthanc::GetBytesPerPixel(format_); | |
| 91 } | |
| 92 | |
|
2861
9b4251721f22
ImageAccessor now non-copyable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
93 void GetReadOnlyAccessor(ImageAccessor& accessor); |
| 801 | 94 |
|
2861
9b4251721f22
ImageAccessor now non-copyable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
95 void GetWriteableAccessor(ImageAccessor& accessor); |
| 844 | 96 |
| 97 bool IsMinimalPitchForced() const | |
| 98 { | |
| 99 return forceMinimalPitch_; | |
| 100 } | |
| 101 | |
| 863 | 102 void AcquireOwnership(ImageBuffer& other); |
| 801 | 103 }; |
| 104 } |