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