Mercurial > hg > orthanc-wsi
annotate ViewerPlugin/Plugin.cpp @ 59:7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 25 Nov 2016 16:34:34 +0100 |
parents | 91fc9583b2de |
children | 147bd6dc28db |
rev | line source |
---|---|
0 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU Affero General Public License | |
8 * as published by the Free Software Foundation, either version 3 of | |
9 * the License, or (at your option) any later version. | |
10 * | |
11 * This program is distributed in the hope that it will be useful, but | |
12 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 * Affero General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU Affero General Public License | |
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 **/ | |
19 | |
20 | |
16
7a88c614be04
preparing for precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
8
diff
changeset
|
21 #include "../Framework/PrecompiledHeadersWSI.h" |
0 | 22 #include "../Framework/Inputs/DicomPyramid.h" |
23 #include "../Framework/Jpeg2000Reader.h" | |
24 #include "../Framework/Messaging/PluginOrthancConnection.h" | |
59
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
25 |
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
26 #include "../Resources/Orthanc/Core/Images/ImageProcessing.h" |
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
27 #include "../Resources/Orthanc/Core/Images/PngWriter.h" |
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
28 #include "../Resources/Orthanc/Core/MultiThreading/Semaphore.h" |
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
29 #include "../Resources/Orthanc/Core/OrthancException.h" |
7a3853d51c45
Move "Framework/Orthanc/" as "Resources/Orthanc/"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
30 #include "../Resources/Orthanc/Plugins/Samples/Common/OrthancPluginCppWrapper.h" |
0 | 31 |
32 #include <EmbeddedResources.h> | |
33 | |
34 #include <cassert> | |
35 | |
36 | |
37 | |
38 namespace OrthancWSI | |
39 { | |
40 // TODO Add LRU recycling policy | |
41 class DicomPyramidCache : public boost::noncopyable | |
42 { | |
43 private: | |
44 boost::mutex mutex_; | |
45 IOrthancConnection& orthanc_; | |
46 std::auto_ptr<DicomPyramid> pyramid_; | |
47 | |
48 DicomPyramid& GetPyramid(const std::string& seriesId) | |
49 { | |
50 // Mutex is assumed to be locked | |
51 | |
52 if (pyramid_.get() == NULL || | |
53 pyramid_->GetSeriesId() != seriesId) | |
54 { | |
55 pyramid_.reset(new DicomPyramid(orthanc_, seriesId)); | |
56 } | |
57 | |
58 if (pyramid_.get() == NULL) | |
59 { | |
60 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
61 } | |
62 | |
63 return *pyramid_; | |
64 } | |
65 | |
66 public: | |
67 DicomPyramidCache(IOrthancConnection& orthanc) : | |
68 orthanc_(orthanc) | |
69 { | |
70 } | |
71 | |
72 void Invalidate(const std::string& seriesId) | |
73 { | |
74 boost::mutex::scoped_lock lock(mutex_); | |
75 | |
76 if (pyramid_.get() != NULL && | |
77 pyramid_->GetSeriesId() == seriesId) | |
78 { | |
79 pyramid_.reset(NULL); | |
80 } | |
81 } | |
82 | |
83 class Locker : public boost::noncopyable | |
84 { | |
85 private: | |
86 boost::mutex::scoped_lock lock_; | |
87 DicomPyramid& pyramid_; | |
88 | |
89 public: | |
90 Locker(DicomPyramidCache& cache, | |
91 const std::string& seriesId) : | |
92 lock_(cache.mutex_), | |
93 pyramid_(cache.GetPyramid(seriesId)) | |
94 { | |
95 } | |
96 | |
97 DicomPyramid& GetPyramid() const | |
98 { | |
99 return pyramid_; | |
100 } | |
101 }; | |
102 }; | |
103 } | |
104 | |
105 | |
106 OrthancPluginContext* context_ = NULL; | |
107 | |
108 std::auto_ptr<OrthancWSI::PluginOrthancConnection> orthanc_; | |
109 std::auto_ptr<OrthancWSI::DicomPyramidCache> cache_; | |
110 std::auto_ptr<Orthanc::Semaphore> transcoderSemaphore_; | |
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
111 std::string sparseTile_; |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
112 |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
113 |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
114 static void AnswerSparseTile(OrthancPluginRestOutput* output, |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
115 unsigned int tileWidth, |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
116 unsigned int tileHeight) |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
117 { |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
118 Orthanc::Image tile(Orthanc::PixelFormat_RGB24, tileWidth, tileHeight, false); |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
119 |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
120 // Black (TODO parameter) |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
121 uint8_t red = 0; |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
122 uint8_t green = 0; |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
123 uint8_t blue = 0; |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
124 Orthanc::ImageProcessing::Set(tile, red, green, blue, 255); |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
125 |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
126 // TODO Cache the tile |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
127 OrthancPluginCompressAndAnswerPngImage(context_, output, OrthancPluginPixelFormat_RGB24, |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
128 tile.GetWidth(), tile.GetHeight(), |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
129 tile.GetPitch(), tile.GetBuffer()); |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
130 } |
0 | 131 |
132 | |
133 static bool DisplayPerformanceWarning() | |
134 { | |
135 (void) DisplayPerformanceWarning; // Disable warning about unused function | |
136 OrthancPluginLogWarning(context_, "Performance warning in whole-slide imaging: " | |
137 "Non-release build, runtime debug assertions are turned on"); | |
138 return true; | |
139 } | |
140 | |
141 | |
142 void ServePyramid(OrthancPluginRestOutput* output, | |
143 const char* url, | |
144 const OrthancPluginHttpRequest* request) | |
145 { | |
146 std::string seriesId(request->groups[0]); | |
147 | |
148 char tmp[1024]; | |
149 sprintf(tmp, "Accessing whole-slide pyramid of series %s", seriesId.c_str()); | |
150 OrthancPluginLogInfo(context_, tmp); | |
151 | |
152 | |
153 OrthancWSI::DicomPyramidCache::Locker locker(*cache_, seriesId); | |
154 | |
155 unsigned int totalWidth = locker.GetPyramid().GetLevelWidth(0); | |
156 unsigned int totalHeight = locker.GetPyramid().GetLevelHeight(0); | |
157 | |
158 Json::Value resolutions = Json::arrayValue; | |
159 for (unsigned int i = 0; i < locker.GetPyramid().GetLevelCount(); i++) | |
160 { | |
161 resolutions.append(static_cast<float>(totalWidth) / | |
162 static_cast<float>(locker.GetPyramid().GetLevelWidth(i))); | |
163 } | |
164 | |
165 Json::Value result; | |
166 result["ID"] = seriesId; | |
167 result["TotalWidth"] = totalWidth; | |
168 result["TotalHeight"] = totalHeight; | |
169 result["TileWidth"] = locker.GetPyramid().GetTileWidth(); | |
170 result["TileHeight"] = locker.GetPyramid().GetTileHeight(); | |
171 result["Resolutions"] = resolutions; | |
172 | |
173 std::string s = result.toStyledString(); | |
174 OrthancPluginAnswerBuffer(context_, output, s.c_str(), s.size(), "application/json"); | |
175 } | |
176 | |
177 | |
178 void ServeTile(OrthancPluginRestOutput* output, | |
179 const char* url, | |
180 const OrthancPluginHttpRequest* request) | |
181 { | |
182 std::string seriesId(request->groups[0]); | |
183 int level = boost::lexical_cast<int>(request->groups[1]); | |
184 int tileY = boost::lexical_cast<int>(request->groups[3]); | |
185 int tileX = boost::lexical_cast<int>(request->groups[2]); | |
186 | |
187 char tmp[1024]; | |
188 sprintf(tmp, "Accessing tile in series %s: (%d,%d) at level %d", seriesId.c_str(), tileX, tileY, level); | |
189 OrthancPluginLogInfo(context_, tmp); | |
190 | |
191 if (level < 0 || | |
192 tileX < 0 || | |
193 tileY < 0) | |
194 { | |
195 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
196 } | |
197 | |
198 // Retrieve the raw tile from the WSI pyramid | |
199 OrthancWSI::ImageCompression compression; | |
200 Orthanc::PixelFormat format; | |
201 std::string tile; | |
202 unsigned int tileWidth, tileHeight; | |
203 | |
204 { | |
205 OrthancWSI::DicomPyramidCache::Locker locker(*cache_, seriesId); | |
206 | |
207 format = locker.GetPyramid().GetPixelFormat(); | |
208 tileWidth = locker.GetPyramid().GetTileWidth(); | |
209 tileHeight = locker.GetPyramid().GetTileHeight(); | |
210 | |
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
211 if (!locker.GetPyramid().ReadRawTile(tile, compression, |
0 | 212 static_cast<unsigned int>(level), |
213 static_cast<unsigned int>(tileX), | |
214 static_cast<unsigned int>(tileY))) | |
215 { | |
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
216 // Handling of missing tile (for sparse tiling): TODO parameter? |
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
217 // AnswerSparseTile(output, tileWidth, tileHeight); return; |
0 | 218 throw Orthanc::OrthancException(Orthanc::ErrorCode_UnknownResource); |
219 } | |
220 } | |
221 | |
222 | |
223 // Test whether the tile is a JPEG image. In such a case, we can | |
224 // serve it as such, because any Web browser can handle JPEG | |
225 | |
226 if (compression == OrthancWSI::ImageCompression_Jpeg) | |
227 { | |
228 OrthancPluginAnswerBuffer(context_, output, tile.c_str(), tile.size(), "image/jpeg"); | |
229 return; // We're done | |
230 } | |
231 | |
232 | |
233 // The tile does not come from a DICOM-JPEG instance, we need to | |
234 // decompress the raw tile | |
235 std::auto_ptr<Orthanc::ImageAccessor> decoded; | |
236 | |
237 Orthanc::Semaphore::Locker locker(*transcoderSemaphore_); | |
238 | |
239 switch (compression) | |
240 { | |
241 case OrthancWSI::ImageCompression_Jpeg2000: | |
242 decoded.reset(new OrthancWSI::Jpeg2000Reader); | |
243 dynamic_cast<OrthancWSI::Jpeg2000Reader&>(*decoded).ReadFromMemory(tile); | |
244 break; | |
245 | |
246 case OrthancWSI::ImageCompression_None: | |
247 { | |
248 unsigned int bpp = Orthanc::GetBytesPerPixel(format); | |
249 if (bpp * tileWidth * tileHeight != tile.size()) | |
250 { | |
251 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat); | |
252 } | |
253 | |
254 decoded.reset(new Orthanc::ImageAccessor); | |
255 decoded->AssignReadOnly(format, tileWidth, tileHeight, bpp * tileWidth, tile.c_str()); | |
256 break; | |
257 } | |
258 | |
259 default: | |
260 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
261 } | |
262 | |
263 | |
264 // This is a lossless frame (coming from a JPEG2000 or uncompressed | |
265 // DICOM instance), serve it as a PNG image so as to prevent lossy | |
266 // compression | |
267 | |
268 std::string png; | |
269 Orthanc::PngWriter writer; | |
270 writer.WriteToMemory(png, *decoded); | |
271 | |
272 OrthancPluginAnswerBuffer(context_, output, png.c_str(), png.size(), "image/png"); | |
273 } | |
274 | |
275 | |
276 OrthancPluginErrorCode OnChangeCallback(OrthancPluginChangeType changeType, | |
277 OrthancPluginResourceType resourceType, | |
278 const char *resourceId) | |
279 { | |
280 if (resourceType == OrthancPluginResourceType_Series && | |
281 changeType == OrthancPluginChangeType_NewChildInstance) | |
282 { | |
283 char tmp[1024]; | |
284 sprintf(tmp, "New instance has been added to series %s, invalidating it", resourceId); | |
285 OrthancPluginLogInfo(context_, tmp); | |
286 | |
287 cache_->Invalidate(resourceId); | |
288 } | |
289 | |
290 return OrthancPluginErrorCode_Success; | |
291 } | |
292 | |
293 | |
294 | |
295 void ServeFile(OrthancPluginRestOutput* output, | |
296 const char* url, | |
297 const OrthancPluginHttpRequest* request) | |
298 { | |
299 Orthanc::EmbeddedResources::FileResourceId resource; | |
300 | |
301 std::string f(request->groups[0]); | |
302 std::string mime; | |
303 | |
304 if (f == "viewer.html") | |
305 { | |
306 resource = Orthanc::EmbeddedResources::VIEWER_HTML; | |
307 mime = "text/html"; | |
308 } | |
309 else if (f == "viewer.js") | |
310 { | |
311 resource = Orthanc::EmbeddedResources::VIEWER_JS; | |
312 mime = "application/javascript"; | |
313 } | |
314 else if (f == "ol.js") | |
315 { | |
316 resource = Orthanc::EmbeddedResources::OPENLAYERS_JS; | |
317 mime = "application/javascript"; | |
318 } | |
319 else if (f == "ol.css") | |
320 { | |
321 resource = Orthanc::EmbeddedResources::OPENLAYERS_CSS; | |
322 mime = "text/css"; | |
323 } | |
324 else | |
325 { | |
326 throw Orthanc::OrthancException(Orthanc::ErrorCode_UnknownResource); | |
327 } | |
328 | |
329 std::string content; | |
330 Orthanc::EmbeddedResources::GetFileResource(content, resource); | |
331 | |
332 OrthancPluginAnswerBuffer(context_, output, content.c_str(), content.size(), mime.c_str()); | |
333 } | |
334 | |
335 | |
336 | |
337 extern "C" | |
338 { | |
339 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* context) | |
340 { | |
341 context_ = context; | |
342 assert(DisplayPerformanceWarning()); | |
343 | |
344 /* Check the version of the Orthanc core */ | |
345 if (OrthancPluginCheckVersion(context_) == 0) | |
346 { | |
347 char info[1024]; | |
348 sprintf(info, "Your version of Orthanc (%s) must be above %d.%d.%d to run this plugin", | |
349 context_->orthancVersion, | |
350 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER, | |
351 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER, | |
352 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER); | |
353 OrthancPluginLogError(context_, info); | |
354 return -1; | |
355 } | |
356 | |
5
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
357 if (!OrthancPlugins::CheckMinimalOrthancVersion(context_, 1, 1, 0)) |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
358 { |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
359 // We need the "/instances/.../frames/.../raw" URI that was introduced in Orthanc 1.1.0 |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
360 return -1; |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
361 } |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
362 |
0 | 363 // Limit the number of PNG transcoders to the number of available |
364 // hardware threads (e.g. number of CPUs or cores or | |
365 // hyperthreading units) | |
366 unsigned int threads = boost::thread::hardware_concurrency(); | |
367 | |
368 if (threads <= 0) | |
369 { | |
370 threads = 1; | |
371 } | |
372 | |
373 transcoderSemaphore_.reset(new Orthanc::Semaphore(threads)); | |
374 | |
375 char info[1024]; | |
376 sprintf(info, "The whole-slide imaging plugin will use at most %d threads to transcode the tiles", threads); | |
377 OrthancPluginLogWarning(context_, info); | |
378 | |
8
62adabb8c122
Provide "--version" in command-line tools
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5
diff
changeset
|
379 OrthancPluginSetDescription(context, "Provides a Web viewer of whole-slide microscopic images within Orthanc."); |
0 | 380 |
381 orthanc_.reset(new OrthancWSI::PluginOrthancConnection(context)); | |
382 cache_.reset(new OrthancWSI::DicomPyramidCache(*orthanc_)); | |
383 | |
384 OrthancPluginRegisterOnChangeCallback(context_, OnChangeCallback); | |
385 | |
386 OrthancPlugins::RegisterRestCallback<ServeFile>(context, "/wsi/app/(ol.css)", true); | |
387 OrthancPlugins::RegisterRestCallback<ServeFile>(context, "/wsi/app/(ol.js)", true); | |
388 OrthancPlugins::RegisterRestCallback<ServeFile>(context, "/wsi/app/(viewer.html)", true); | |
389 OrthancPlugins::RegisterRestCallback<ServeFile>(context, "/wsi/app/(viewer.js)", true); | |
390 OrthancPlugins::RegisterRestCallback<ServePyramid>(context, "/wsi/pyramids/([0-9a-f-]+)", true); | |
391 OrthancPlugins::RegisterRestCallback<ServeTile>(context, "/wsi/tiles/([0-9a-f-]+)/([0-9-]+)/([0-9-]+)/([0-9-]+)", true); | |
392 | |
393 // Extend the default Orthanc Explorer with custom JavaScript for WSI | |
394 std::string explorer; | |
395 Orthanc::EmbeddedResources::GetFileResource(explorer, Orthanc::EmbeddedResources::ORTHANC_EXPLORER); | |
396 OrthancPluginExtendOrthancExplorer(context_, explorer.c_str()); | |
397 | |
398 return 0; | |
399 } | |
400 | |
401 | |
402 ORTHANC_PLUGINS_API void OrthancPluginFinalize() | |
403 { | |
404 cache_.reset(NULL); | |
405 orthanc_.reset(NULL); | |
406 transcoderSemaphore_.reset(NULL); | |
407 } | |
408 | |
409 | |
410 ORTHANC_PLUGINS_API const char* OrthancPluginGetName() | |
411 { | |
412 return "wsi"; | |
413 } | |
414 | |
415 | |
416 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion() | |
417 { | |
418 return ORTHANC_WSI_VERSION; | |
419 } | |
420 } |