|
78
|
1 /**
|
|
|
2 * \mainpage
|
|
|
3 *
|
|
|
4 * This C/C++ SDK allows external developers to create plugins that
|
|
|
5 * can be loaded into Orthanc to extend its functionality. Each
|
|
|
6 * Orthanc plugin must expose 4 public functions with the following
|
|
|
7 * signatures:
|
|
|
8 *
|
|
|
9 * -# <tt>int32_t OrthancPluginInitialize(const OrthancPluginContext* context)</tt>:
|
|
|
10 * This function is invoked by Orthanc when it loads the plugin on startup.
|
|
|
11 * The plugin must:
|
|
|
12 * - Check its compatibility with the Orthanc version using
|
|
|
13 * ::OrthancPluginCheckVersion().
|
|
|
14 * - Store the context pointer so that it can use the plugin
|
|
|
15 * services of Orthanc.
|
|
|
16 * - Register all its REST callbacks using ::OrthancPluginRegisterRestCallback().
|
|
|
17 * - Possibly register its callback for received DICOM instances using ::OrthancPluginRegisterOnStoredInstanceCallback().
|
|
|
18 * - Possibly register its callback for changes to the DICOM store using ::OrthancPluginRegisterOnChangeCallback().
|
|
|
19 * - Possibly register a custom storage area using ::OrthancPluginRegisterStorageArea().
|
|
|
20 * - Possibly register a custom database back-end area using OrthancPluginRegisterDatabaseBackendV2().
|
|
101
|
21 * - Possibly register a handler for C-Find SCP against DICOM worklists using OrthancPluginRegisterWorklistCallback().
|
|
|
22 * - Possibly register a custom decoder for DICOM images using OrthancPluginRegisterDecodeImageCallback().
|
|
78
|
23 * -# <tt>void OrthancPluginFinalize()</tt>:
|
|
|
24 * This function is invoked by Orthanc during its shutdown. The plugin
|
|
|
25 * must free all its memory.
|
|
|
26 * -# <tt>const char* OrthancPluginGetName()</tt>:
|
|
|
27 * The plugin must return a short string to identify itself.
|
|
|
28 * -# <tt>const char* OrthancPluginGetVersion()</tt>:
|
|
|
29 * The plugin must return a string containing its version number.
|
|
|
30 *
|
|
|
31 * The name and the version of a plugin is only used to prevent it
|
|
|
32 * from being loaded twice. Note that, in C++, it is mandatory to
|
|
|
33 * declare these functions within an <tt>extern "C"</tt> section.
|
|
|
34 *
|
|
|
35 * To ensure multi-threading safety, the various REST callbacks are
|
|
|
36 * guaranteed to be executed in mutual exclusion since Orthanc
|
|
|
37 * 0.8.5. If this feature is undesired (notably when developing
|
|
|
38 * high-performance plugins handling simultaneous requests), use
|
|
|
39 * ::OrthancPluginRegisterRestCallbackNoLock().
|
|
|
40 **/
|
|
|
41
|
|
|
42
|
|
|
43
|
|
|
44 /**
|
|
|
45 * @defgroup Images Images and compression
|
|
|
46 * @brief Functions to deal with images and compressed buffers.
|
|
|
47 *
|
|
|
48 * @defgroup REST REST
|
|
|
49 * @brief Functions to answer REST requests in a callback.
|
|
|
50 *
|
|
|
51 * @defgroup Callbacks Callbacks
|
|
|
52 * @brief Functions to register and manage callbacks by the plugins.
|
|
|
53 *
|
|
101
|
54 * @defgroup Worklists Worklists
|
|
|
55 * @brief Functions to register and manage worklists.
|
|
|
56 *
|
|
78
|
57 * @defgroup Orthanc Orthanc
|
|
|
58 * @brief Functions to access the content of the Orthanc server.
|
|
|
59 **/
|
|
|
60
|
|
|
61
|
|
|
62
|
|
|
63 /**
|
|
|
64 * @defgroup Toolbox Toolbox
|
|
|
65 * @brief Generic functions to help with the creation of plugins.
|
|
|
66 **/
|
|
|
67
|
|
|
68
|
|
|
69
|
|
|
70 /**
|
|
|
71 * Orthanc - A Lightweight, RESTful DICOM Store
|
|
|
72 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
|
|
|
73 * Department, University Hospital of Liege, Belgium
|
|
|
74 *
|
|
|
75 * This program is free software: you can redistribute it and/or
|
|
|
76 * modify it under the terms of the GNU General Public License as
|
|
|
77 * published by the Free Software Foundation, either version 3 of the
|
|
|
78 * License, or (at your option) any later version.
|
|
|
79 *
|
|
|
80 * In addition, as a special exception, the copyright holders of this
|
|
|
81 * program give permission to link the code of its release with the
|
|
|
82 * OpenSSL project's "OpenSSL" library (or with modified versions of it
|
|
|
83 * that use the same license as the "OpenSSL" library), and distribute
|
|
|
84 * the linked executables. You must obey the GNU General Public License
|
|
|
85 * in all respects for all of the code used other than "OpenSSL". If you
|
|
|
86 * modify file(s) with this exception, you may extend this exception to
|
|
|
87 * your version of the file(s), but you are not obligated to do so. If
|
|
|
88 * you do not wish to do so, delete this exception statement from your
|
|
|
89 * version. If you delete this exception statement from all source files
|
|
|
90 * in the program, then also delete it here.
|
|
|
91 *
|
|
|
92 * This program is distributed in the hope that it will be useful, but
|
|
|
93 * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
94 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
95 * General Public License for more details.
|
|
|
96 *
|
|
|
97 * You should have received a copy of the GNU General Public License
|
|
|
98 * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
99 **/
|
|
|
100
|
|
|
101
|
|
|
102
|
|
|
103 #pragma once
|
|
|
104
|
|
|
105
|
|
|
106 #include <stdio.h>
|
|
|
107 #include <string.h>
|
|
|
108
|
|
|
109 #ifdef WIN32
|
|
|
110 #define ORTHANC_PLUGINS_API __declspec(dllexport)
|
|
|
111 #else
|
|
|
112 #define ORTHANC_PLUGINS_API
|
|
|
113 #endif
|
|
|
114
|
|
|
115 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
|
|
|
116 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
|
|
101
|
117 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 5
|
|
78
|
118
|
|
|
119
|
|
|
120
|
|
|
121 /********************************************************************
|
|
|
122 ** Check that function inlining is properly supported. The use of
|
|
|
123 ** inlining is required, to avoid the duplication of object code
|
|
|
124 ** between two compilation modules that would use the Orthanc Plugin
|
|
|
125 ** API.
|
|
|
126 ********************************************************************/
|
|
|
127
|
|
|
128 /* If the auto-detection of the "inline" keyword below does not work
|
|
|
129 automatically and that your compiler is known to properly support
|
|
|
130 inlining, uncomment the following #define and adapt the definition
|
|
|
131 of "static inline". */
|
|
|
132
|
|
|
133 /* #define ORTHANC_PLUGIN_INLINE static inline */
|
|
|
134
|
|
|
135 #ifndef ORTHANC_PLUGIN_INLINE
|
|
|
136 # if __STDC_VERSION__ >= 199901L
|
|
|
137 /* This is C99 or above: http://predef.sourceforge.net/prestd.html */
|
|
|
138 # define ORTHANC_PLUGIN_INLINE static inline
|
|
|
139 # elif defined(__cplusplus)
|
|
|
140 /* This is C++ */
|
|
|
141 # define ORTHANC_PLUGIN_INLINE static inline
|
|
|
142 # elif defined(__GNUC__)
|
|
|
143 /* This is GCC running in C89 mode */
|
|
|
144 # define ORTHANC_PLUGIN_INLINE static __inline
|
|
|
145 # elif defined(_MSC_VER)
|
|
|
146 /* This is Visual Studio running in C89 mode */
|
|
|
147 # define ORTHANC_PLUGIN_INLINE static __inline
|
|
|
148 # else
|
|
|
149 # error Your compiler is not known to support the "inline" keyword
|
|
|
150 # endif
|
|
|
151 #endif
|
|
|
152
|
|
|
153
|
|
|
154
|
|
|
155 /********************************************************************
|
|
|
156 ** Inclusion of standard libraries.
|
|
|
157 ********************************************************************/
|
|
|
158
|
|
|
159 /**
|
|
|
160 * For Microsoft Visual Studio, a compatibility "stdint.h" can be
|
|
|
161 * downloaded at the following URL:
|
|
|
162 * https://orthanc.googlecode.com/hg/Resources/ThirdParty/VisualStudio/stdint.h
|
|
|
163 **/
|
|
|
164 #include <stdint.h>
|
|
|
165
|
|
|
166 #include <stdlib.h>
|
|
|
167
|
|
|
168
|
|
|
169
|
|
|
170 /********************************************************************
|
|
|
171 ** Definition of the Orthanc Plugin API.
|
|
|
172 ********************************************************************/
|
|
|
173
|
|
|
174 /** @{ */
|
|
|
175
|
|
|
176 #ifdef __cplusplus
|
|
|
177 extern "C"
|
|
|
178 {
|
|
|
179 #endif
|
|
|
180
|
|
|
181 /**
|
|
|
182 * The various error codes that can be returned by the Orthanc core.
|
|
|
183 **/
|
|
|
184 typedef enum
|
|
|
185 {
|
|
|
186 OrthancPluginErrorCode_InternalError = -1 /*!< Internal error */,
|
|
|
187 OrthancPluginErrorCode_Success = 0 /*!< Success */,
|
|
|
188 OrthancPluginErrorCode_Plugin = 1 /*!< Error encountered within the plugin engine */,
|
|
|
189 OrthancPluginErrorCode_NotImplemented = 2 /*!< Not implemented yet */,
|
|
|
190 OrthancPluginErrorCode_ParameterOutOfRange = 3 /*!< Parameter out of range */,
|
|
|
191 OrthancPluginErrorCode_NotEnoughMemory = 4 /*!< Not enough memory */,
|
|
|
192 OrthancPluginErrorCode_BadParameterType = 5 /*!< Bad type for a parameter */,
|
|
|
193 OrthancPluginErrorCode_BadSequenceOfCalls = 6 /*!< Bad sequence of calls */,
|
|
|
194 OrthancPluginErrorCode_InexistentItem = 7 /*!< Accessing an inexistent item */,
|
|
|
195 OrthancPluginErrorCode_BadRequest = 8 /*!< Bad request */,
|
|
|
196 OrthancPluginErrorCode_NetworkProtocol = 9 /*!< Error in the network protocol */,
|
|
|
197 OrthancPluginErrorCode_SystemCommand = 10 /*!< Error while calling a system command */,
|
|
|
198 OrthancPluginErrorCode_Database = 11 /*!< Error with the database engine */,
|
|
|
199 OrthancPluginErrorCode_UriSyntax = 12 /*!< Badly formatted URI */,
|
|
|
200 OrthancPluginErrorCode_InexistentFile = 13 /*!< Inexistent file */,
|
|
|
201 OrthancPluginErrorCode_CannotWriteFile = 14 /*!< Cannot write to file */,
|
|
|
202 OrthancPluginErrorCode_BadFileFormat = 15 /*!< Bad file format */,
|
|
|
203 OrthancPluginErrorCode_Timeout = 16 /*!< Timeout */,
|
|
|
204 OrthancPluginErrorCode_UnknownResource = 17 /*!< Unknown resource */,
|
|
|
205 OrthancPluginErrorCode_IncompatibleDatabaseVersion = 18 /*!< Incompatible version of the database */,
|
|
|
206 OrthancPluginErrorCode_FullStorage = 19 /*!< The file storage is full */,
|
|
|
207 OrthancPluginErrorCode_CorruptedFile = 20 /*!< Corrupted file (e.g. inconsistent MD5 hash) */,
|
|
|
208 OrthancPluginErrorCode_InexistentTag = 21 /*!< Inexistent tag */,
|
|
|
209 OrthancPluginErrorCode_ReadOnly = 22 /*!< Cannot modify a read-only data structure */,
|
|
|
210 OrthancPluginErrorCode_IncompatibleImageFormat = 23 /*!< Incompatible format of the images */,
|
|
|
211 OrthancPluginErrorCode_IncompatibleImageSize = 24 /*!< Incompatible size of the images */,
|
|
|
212 OrthancPluginErrorCode_SharedLibrary = 25 /*!< Error while using a shared library (plugin) */,
|
|
|
213 OrthancPluginErrorCode_UnknownPluginService = 26 /*!< Plugin invoking an unknown service */,
|
|
|
214 OrthancPluginErrorCode_UnknownDicomTag = 27 /*!< Unknown DICOM tag */,
|
|
|
215 OrthancPluginErrorCode_BadJson = 28 /*!< Cannot parse a JSON document */,
|
|
|
216 OrthancPluginErrorCode_Unauthorized = 29 /*!< Bad credentials were provided to an HTTP request */,
|
|
|
217 OrthancPluginErrorCode_BadFont = 30 /*!< Badly formatted font file */,
|
|
101
|
218 OrthancPluginErrorCode_DatabasePlugin = 31 /*!< The plugin implementing a custom database back-end does not fulfill the proper interface */,
|
|
|
219 OrthancPluginErrorCode_StorageAreaPlugin = 32 /*!< Error in the plugin implementing a custom storage area */,
|
|
|
220 OrthancPluginErrorCode_EmptyRequest = 33 /*!< The request is empty */,
|
|
|
221 OrthancPluginErrorCode_NotAcceptable = 34 /*!< Cannot send a response which is acceptable according to the Accept HTTP header */,
|
|
78
|
222 OrthancPluginErrorCode_SQLiteNotOpened = 1000 /*!< SQLite: The database is not opened */,
|
|
|
223 OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /*!< SQLite: Connection is already open */,
|
|
|
224 OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /*!< SQLite: Unable to open the database */,
|
|
|
225 OrthancPluginErrorCode_SQLiteStatementAlreadyUsed = 1003 /*!< SQLite: This cached statement is already being referred to */,
|
|
|
226 OrthancPluginErrorCode_SQLiteExecute = 1004 /*!< SQLite: Cannot execute a command */,
|
|
|
227 OrthancPluginErrorCode_SQLiteRollbackWithoutTransaction = 1005 /*!< SQLite: Rolling back a nonexistent transaction (have you called Begin()?) */,
|
|
|
228 OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /*!< SQLite: Committing a nonexistent transaction */,
|
|
|
229 OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /*!< SQLite: Unable to register a function */,
|
|
|
230 OrthancPluginErrorCode_SQLiteFlush = 1008 /*!< SQLite: Unable to flush the database */,
|
|
|
231 OrthancPluginErrorCode_SQLiteCannotRun = 1009 /*!< SQLite: Cannot run a cached statement */,
|
|
|
232 OrthancPluginErrorCode_SQLiteCannotStep = 1010 /*!< SQLite: Cannot step over a cached statement */,
|
|
|
233 OrthancPluginErrorCode_SQLiteBindOutOfRange = 1011 /*!< SQLite: Bing a value while out of range (serious error) */,
|
|
|
234 OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /*!< SQLite: Cannot prepare a cached statement */,
|
|
|
235 OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /*!< SQLite: Beginning the same transaction twice */,
|
|
|
236 OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /*!< SQLite: Failure when committing the transaction */,
|
|
|
237 OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /*!< SQLite: Cannot start a transaction */,
|
|
|
238 OrthancPluginErrorCode_DirectoryOverFile = 2000 /*!< The directory to be created is already occupied by a regular file */,
|
|
|
239 OrthancPluginErrorCode_FileStorageCannotWrite = 2001 /*!< Unable to create a subdirectory or a file in the file storage */,
|
|
|
240 OrthancPluginErrorCode_DirectoryExpected = 2002 /*!< The specified path does not point to a directory */,
|
|
|
241 OrthancPluginErrorCode_HttpPortInUse = 2003 /*!< The TCP port of the HTTP server is already in use */,
|
|
|
242 OrthancPluginErrorCode_DicomPortInUse = 2004 /*!< The TCP port of the DICOM server is already in use */,
|
|
|
243 OrthancPluginErrorCode_BadHttpStatusInRest = 2005 /*!< This HTTP status is not allowed in a REST API */,
|
|
|
244 OrthancPluginErrorCode_RegularFileExpected = 2006 /*!< The specified path does not point to a regular file */,
|
|
|
245 OrthancPluginErrorCode_PathToExecutable = 2007 /*!< Unable to get the path to the executable */,
|
|
|
246 OrthancPluginErrorCode_MakeDirectory = 2008 /*!< Cannot create a directory */,
|
|
|
247 OrthancPluginErrorCode_BadApplicationEntityTitle = 2009 /*!< An application entity title (AET) cannot be empty or be longer than 16 characters */,
|
|
|
248 OrthancPluginErrorCode_NoCFindHandler = 2010 /*!< No request handler factory for DICOM C-FIND SCP */,
|
|
|
249 OrthancPluginErrorCode_NoCMoveHandler = 2011 /*!< No request handler factory for DICOM C-MOVE SCP */,
|
|
|
250 OrthancPluginErrorCode_NoCStoreHandler = 2012 /*!< No request handler factory for DICOM C-STORE SCP */,
|
|
|
251 OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /*!< No application entity filter */,
|
|
|
252 OrthancPluginErrorCode_NoSopClassOrInstance = 2014 /*!< DicomUserConnection: Unable to find the SOP class and instance */,
|
|
|
253 OrthancPluginErrorCode_NoPresentationContext = 2015 /*!< DicomUserConnection: No acceptable presentation context for modality */,
|
|
|
254 OrthancPluginErrorCode_DicomFindUnavailable = 2016 /*!< DicomUserConnection: The C-FIND command is not supported by the remote SCP */,
|
|
|
255 OrthancPluginErrorCode_DicomMoveUnavailable = 2017 /*!< DicomUserConnection: The C-MOVE command is not supported by the remote SCP */,
|
|
|
256 OrthancPluginErrorCode_CannotStoreInstance = 2018 /*!< Cannot store an instance */,
|
|
|
257 OrthancPluginErrorCode_CreateDicomNotString = 2019 /*!< Only string values are supported when creating DICOM instances */,
|
|
|
258 OrthancPluginErrorCode_CreateDicomOverrideTag = 2020 /*!< Trying to override a value inherited from a parent module */,
|
|
|
259 OrthancPluginErrorCode_CreateDicomUseContent = 2021 /*!< Use \"Content\" to inject an image into a new DICOM instance */,
|
|
|
260 OrthancPluginErrorCode_CreateDicomNoPayload = 2022 /*!< No payload is present for one instance in the series */,
|
|
|
261 OrthancPluginErrorCode_CreateDicomUseDataUriScheme = 2023 /*!< The payload of the DICOM instance must be specified according to Data URI scheme */,
|
|
|
262 OrthancPluginErrorCode_CreateDicomBadParent = 2024 /*!< Trying to attach a new DICOM instance to an inexistent resource */,
|
|
|
263 OrthancPluginErrorCode_CreateDicomParentIsInstance = 2025 /*!< Trying to attach a new DICOM instance to an instance (must be a series, study or patient) */,
|
|
|
264 OrthancPluginErrorCode_CreateDicomParentEncoding = 2026 /*!< Unable to get the encoding of the parent resource */,
|
|
|
265 OrthancPluginErrorCode_UnknownModality = 2027 /*!< Unknown modality */,
|
|
|
266 OrthancPluginErrorCode_BadJobOrdering = 2028 /*!< Bad ordering of filters in a job */,
|
|
|
267 OrthancPluginErrorCode_JsonToLuaTable = 2029 /*!< Cannot convert the given JSON object to a Lua table */,
|
|
|
268 OrthancPluginErrorCode_CannotCreateLua = 2030 /*!< Cannot create the Lua context */,
|
|
|
269 OrthancPluginErrorCode_CannotExecuteLua = 2031 /*!< Cannot execute a Lua command */,
|
|
|
270 OrthancPluginErrorCode_LuaAlreadyExecuted = 2032 /*!< Arguments cannot be pushed after the Lua function is executed */,
|
|
|
271 OrthancPluginErrorCode_LuaBadOutput = 2033 /*!< The Lua function does not give the expected number of outputs */,
|
|
|
272 OrthancPluginErrorCode_NotLuaPredicate = 2034 /*!< The Lua function is not a predicate (only true/false outputs allowed) */,
|
|
|
273 OrthancPluginErrorCode_LuaReturnsNoString = 2035 /*!< The Lua function does not return a string */,
|
|
101
|
274 OrthancPluginErrorCode_StorageAreaAlreadyRegistered = 2036 /*!< Another plugin has already registered a custom storage area */,
|
|
|
275 OrthancPluginErrorCode_DatabaseBackendAlreadyRegistered = 2037 /*!< Another plugin has already registered a custom database back-end */,
|
|
|
276 OrthancPluginErrorCode_DatabaseNotInitialized = 2038 /*!< Plugin trying to call the database during its initialization */,
|
|
|
277 OrthancPluginErrorCode_SslDisabled = 2039 /*!< Orthanc has been built without SSL support */,
|
|
|
278 OrthancPluginErrorCode_CannotOrderSlices = 2040 /*!< Unable to order the slices of the series */,
|
|
|
279 OrthancPluginErrorCode_NoWorklistHandler = 2041 /*!< No request handler factory for DICOM C-Find Modality SCP */,
|
|
78
|
280
|
|
|
281 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
|
|
|
282 } OrthancPluginErrorCode;
|
|
|
283
|
|
|
284
|
|
|
285 /**
|
|
|
286 * Forward declaration of one of the mandatory functions for Orthanc
|
|
|
287 * plugins.
|
|
|
288 **/
|
|
|
289 ORTHANC_PLUGINS_API const char* OrthancPluginGetName();
|
|
|
290
|
|
|
291
|
|
|
292 /**
|
|
|
293 * The various HTTP methods for a REST call.
|
|
|
294 **/
|
|
|
295 typedef enum
|
|
|
296 {
|
|
|
297 OrthancPluginHttpMethod_Get = 1, /*!< GET request */
|
|
|
298 OrthancPluginHttpMethod_Post = 2, /*!< POST request */
|
|
|
299 OrthancPluginHttpMethod_Put = 3, /*!< PUT request */
|
|
|
300 OrthancPluginHttpMethod_Delete = 4, /*!< DELETE request */
|
|
|
301
|
|
|
302 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
|
|
|
303 } OrthancPluginHttpMethod;
|
|
|
304
|
|
|
305
|
|
|
306 /**
|
|
|
307 * @brief The parameters of a REST request.
|
|
|
308 * @ingroup Callbacks
|
|
|
309 **/
|
|
|
310 typedef struct
|
|
|
311 {
|
|
|
312 /**
|
|
|
313 * @brief The HTTP method.
|
|
|
314 **/
|
|
|
315 OrthancPluginHttpMethod method;
|
|
|
316
|
|
|
317 /**
|
|
|
318 * @brief The number of groups of the regular expression.
|
|
|
319 **/
|
|
|
320 uint32_t groupsCount;
|
|
|
321
|
|
|
322 /**
|
|
|
323 * @brief The matched values for the groups of the regular expression.
|
|
|
324 **/
|
|
|
325 const char* const* groups;
|
|
|
326
|
|
|
327 /**
|
|
|
328 * @brief For a GET request, the number of GET parameters.
|
|
|
329 **/
|
|
|
330 uint32_t getCount;
|
|
|
331
|
|
|
332 /**
|
|
|
333 * @brief For a GET request, the keys of the GET parameters.
|
|
|
334 **/
|
|
|
335 const char* const* getKeys;
|
|
|
336
|
|
|
337 /**
|
|
|
338 * @brief For a GET request, the values of the GET parameters.
|
|
|
339 **/
|
|
|
340 const char* const* getValues;
|
|
|
341
|
|
|
342 /**
|
|
|
343 * @brief For a PUT or POST request, the content of the body.
|
|
|
344 **/
|
|
|
345 const char* body;
|
|
|
346
|
|
|
347 /**
|
|
|
348 * @brief For a PUT or POST request, the number of bytes of the body.
|
|
|
349 **/
|
|
|
350 uint32_t bodySize;
|
|
|
351
|
|
|
352
|
|
|
353 /* --------------------------------------------------
|
|
|
354 New in version 0.8.1
|
|
|
355 -------------------------------------------------- */
|
|
|
356
|
|
|
357 /**
|
|
|
358 * @brief The number of HTTP headers.
|
|
|
359 **/
|
|
|
360 uint32_t headersCount;
|
|
|
361
|
|
|
362 /**
|
|
|
363 * @brief The keys of the HTTP headers (always converted to low-case).
|
|
|
364 **/
|
|
|
365 const char* const* headersKeys;
|
|
|
366
|
|
|
367 /**
|
|
|
368 * @brief The values of the HTTP headers.
|
|
|
369 **/
|
|
|
370 const char* const* headersValues;
|
|
|
371
|
|
|
372 } OrthancPluginHttpRequest;
|
|
|
373
|
|
|
374
|
|
|
375 typedef enum
|
|
|
376 {
|
|
|
377 /* Generic services */
|
|
|
378 _OrthancPluginService_LogInfo = 1,
|
|
|
379 _OrthancPluginService_LogWarning = 2,
|
|
|
380 _OrthancPluginService_LogError = 3,
|
|
|
381 _OrthancPluginService_GetOrthancPath = 4,
|
|
|
382 _OrthancPluginService_GetOrthancDirectory = 5,
|
|
|
383 _OrthancPluginService_GetConfigurationPath = 6,
|
|
|
384 _OrthancPluginService_SetPluginProperty = 7,
|
|
|
385 _OrthancPluginService_GetGlobalProperty = 8,
|
|
|
386 _OrthancPluginService_SetGlobalProperty = 9,
|
|
|
387 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
|
|
|
388 _OrthancPluginService_GetCommandLineArgument = 11,
|
|
|
389 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
|
|
|
390 _OrthancPluginService_GetConfiguration = 13,
|
|
|
391 _OrthancPluginService_BufferCompression = 14,
|
|
|
392 _OrthancPluginService_ReadFile = 15,
|
|
|
393 _OrthancPluginService_WriteFile = 16,
|
|
|
394 _OrthancPluginService_GetErrorDescription = 17,
|
|
|
395 _OrthancPluginService_CallHttpClient = 18,
|
|
101
|
396 _OrthancPluginService_RegisterErrorCode = 19,
|
|
|
397 _OrthancPluginService_RegisterDictionaryTag = 20,
|
|
|
398 _OrthancPluginService_DicomBufferToJson = 21,
|
|
|
399 _OrthancPluginService_DicomInstanceToJson = 22,
|
|
|
400 _OrthancPluginService_CreateDicom = 23,
|
|
|
401 _OrthancPluginService_ComputeMd5 = 24,
|
|
|
402 _OrthancPluginService_ComputeSha1 = 25,
|
|
78
|
403
|
|
|
404 /* Registration of callbacks */
|
|
|
405 _OrthancPluginService_RegisterRestCallback = 1000,
|
|
|
406 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
|
|
|
407 _OrthancPluginService_RegisterStorageArea = 1002,
|
|
|
408 _OrthancPluginService_RegisterOnChangeCallback = 1003,
|
|
|
409 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
|
|
101
|
410 _OrthancPluginService_RegisterWorklistCallback = 1005,
|
|
|
411 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
|
|
78
|
412
|
|
|
413 /* Sending answers to REST calls */
|
|
|
414 _OrthancPluginService_AnswerBuffer = 2000,
|
|
|
415 _OrthancPluginService_CompressAndAnswerPngImage = 2001, /* Unused as of Orthanc 0.9.4 */
|
|
|
416 _OrthancPluginService_Redirect = 2002,
|
|
|
417 _OrthancPluginService_SendHttpStatusCode = 2003,
|
|
|
418 _OrthancPluginService_SendUnauthorized = 2004,
|
|
|
419 _OrthancPluginService_SendMethodNotAllowed = 2005,
|
|
|
420 _OrthancPluginService_SetCookie = 2006,
|
|
|
421 _OrthancPluginService_SetHttpHeader = 2007,
|
|
|
422 _OrthancPluginService_StartMultipartAnswer = 2008,
|
|
|
423 _OrthancPluginService_SendMultipartItem = 2009,
|
|
|
424 _OrthancPluginService_SendHttpStatus = 2010,
|
|
|
425 _OrthancPluginService_CompressAndAnswerImage = 2011,
|
|
|
426
|
|
|
427 /* Access to the Orthanc database and API */
|
|
|
428 _OrthancPluginService_GetDicomForInstance = 3000,
|
|
|
429 _OrthancPluginService_RestApiGet = 3001,
|
|
|
430 _OrthancPluginService_RestApiPost = 3002,
|
|
|
431 _OrthancPluginService_RestApiDelete = 3003,
|
|
|
432 _OrthancPluginService_RestApiPut = 3004,
|
|
|
433 _OrthancPluginService_LookupPatient = 3005,
|
|
|
434 _OrthancPluginService_LookupStudy = 3006,
|
|
|
435 _OrthancPluginService_LookupSeries = 3007,
|
|
|
436 _OrthancPluginService_LookupInstance = 3008,
|
|
|
437 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
|
|
|
438 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
|
|
|
439 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
|
|
|
440 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
|
|
|
441 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
|
|
101
|
442 _OrthancPluginService_ReconstructMainDicomTags = 3014,
|
|
|
443 _OrthancPluginService_RestApiGet2 = 3015,
|
|
78
|
444
|
|
|
445 /* Access to DICOM instances */
|
|
|
446 _OrthancPluginService_GetInstanceRemoteAet = 4000,
|
|
|
447 _OrthancPluginService_GetInstanceSize = 4001,
|
|
|
448 _OrthancPluginService_GetInstanceData = 4002,
|
|
|
449 _OrthancPluginService_GetInstanceJson = 4003,
|
|
|
450 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
|
|
|
451 _OrthancPluginService_HasInstanceMetadata = 4005,
|
|
|
452 _OrthancPluginService_GetInstanceMetadata = 4006,
|
|
101
|
453 _OrthancPluginService_GetInstanceOrigin = 4007,
|
|
78
|
454
|
|
|
455 /* Services for plugins implementing a database back-end */
|
|
|
456 _OrthancPluginService_RegisterDatabaseBackend = 5000,
|
|
|
457 _OrthancPluginService_DatabaseAnswer = 5001,
|
|
|
458 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
|
|
|
459 _OrthancPluginService_StorageAreaCreate = 5003,
|
|
|
460 _OrthancPluginService_StorageAreaRead = 5004,
|
|
|
461 _OrthancPluginService_StorageAreaRemove = 5005,
|
|
|
462
|
|
|
463 /* Primitives for handling images */
|
|
|
464 _OrthancPluginService_GetImagePixelFormat = 6000,
|
|
|
465 _OrthancPluginService_GetImageWidth = 6001,
|
|
|
466 _OrthancPluginService_GetImageHeight = 6002,
|
|
|
467 _OrthancPluginService_GetImagePitch = 6003,
|
|
|
468 _OrthancPluginService_GetImageBuffer = 6004,
|
|
|
469 _OrthancPluginService_UncompressImage = 6005,
|
|
|
470 _OrthancPluginService_FreeImage = 6006,
|
|
|
471 _OrthancPluginService_CompressImage = 6007,
|
|
|
472 _OrthancPluginService_ConvertPixelFormat = 6008,
|
|
|
473 _OrthancPluginService_GetFontsCount = 6009,
|
|
|
474 _OrthancPluginService_GetFontInfo = 6010,
|
|
|
475 _OrthancPluginService_DrawText = 6011,
|
|
101
|
476 _OrthancPluginService_CreateImage = 6012,
|
|
|
477 _OrthancPluginService_CreateImageAccessor = 6013,
|
|
|
478 _OrthancPluginService_DecodeDicomImage = 6014,
|
|
|
479
|
|
|
480 /* Primitives for handling worklists */
|
|
|
481 _OrthancPluginService_WorklistAddAnswer = 7000,
|
|
|
482 _OrthancPluginService_WorklistMarkIncomplete = 7001,
|
|
|
483 _OrthancPluginService_WorklistIsMatch = 7002,
|
|
|
484 _OrthancPluginService_WorklistGetDicomQuery = 7003,
|
|
78
|
485
|
|
|
486 _OrthancPluginService_INTERNAL = 0x7fffffff
|
|
|
487 } _OrthancPluginService;
|
|
|
488
|
|
|
489
|
|
|
490 typedef enum
|
|
|
491 {
|
|
|
492 _OrthancPluginProperty_Description = 1,
|
|
|
493 _OrthancPluginProperty_RootUri = 2,
|
|
|
494 _OrthancPluginProperty_OrthancExplorer = 3,
|
|
|
495
|
|
|
496 _OrthancPluginProperty_INTERNAL = 0x7fffffff
|
|
|
497 } _OrthancPluginProperty;
|
|
|
498
|
|
|
499
|
|
|
500
|
|
|
501 /**
|
|
|
502 * The memory layout of the pixels of an image.
|
|
|
503 * @ingroup Images
|
|
|
504 **/
|
|
|
505 typedef enum
|
|
|
506 {
|
|
|
507 /**
|
|
|
508 * @brief Graylevel 8bpp image.
|
|
|
509 *
|
|
|
510 * The image is graylevel. Each pixel is unsigned and stored in
|
|
|
511 * one byte.
|
|
|
512 **/
|
|
|
513 OrthancPluginPixelFormat_Grayscale8 = 1,
|
|
|
514
|
|
|
515 /**
|
|
|
516 * @brief Graylevel, unsigned 16bpp image.
|
|
|
517 *
|
|
|
518 * The image is graylevel. Each pixel is unsigned and stored in
|
|
|
519 * two bytes.
|
|
|
520 **/
|
|
|
521 OrthancPluginPixelFormat_Grayscale16 = 2,
|
|
|
522
|
|
|
523 /**
|
|
|
524 * @brief Graylevel, signed 16bpp image.
|
|
|
525 *
|
|
|
526 * The image is graylevel. Each pixel is signed and stored in two
|
|
|
527 * bytes.
|
|
|
528 **/
|
|
|
529 OrthancPluginPixelFormat_SignedGrayscale16 = 3,
|
|
|
530
|
|
|
531 /**
|
|
|
532 * @brief Color image in RGB24 format.
|
|
|
533 *
|
|
|
534 * This format describes a color image. The pixels are stored in 3
|
|
|
535 * consecutive bytes. The memory layout is RGB.
|
|
|
536 **/
|
|
|
537 OrthancPluginPixelFormat_RGB24 = 4,
|
|
|
538
|
|
|
539 /**
|
|
|
540 * @brief Color image in RGBA32 format.
|
|
|
541 *
|
|
|
542 * This format describes a color image. The pixels are stored in 4
|
|
|
543 * consecutive bytes. The memory layout is RGBA.
|
|
|
544 **/
|
|
|
545 OrthancPluginPixelFormat_RGBA32 = 5,
|
|
|
546
|
|
|
547 OrthancPluginPixelFormat_Unknown = 6, /*!< Unknown pixel format */
|
|
|
548
|
|
|
549 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
|
|
|
550 } OrthancPluginPixelFormat;
|
|
|
551
|
|
|
552
|
|
|
553
|
|
|
554 /**
|
|
|
555 * The content types that are supported by Orthanc plugins.
|
|
|
556 **/
|
|
|
557 typedef enum
|
|
|
558 {
|
|
|
559 OrthancPluginContentType_Unknown = 0, /*!< Unknown content type */
|
|
|
560 OrthancPluginContentType_Dicom = 1, /*!< DICOM */
|
|
|
561 OrthancPluginContentType_DicomAsJson = 2, /*!< JSON summary of a DICOM file */
|
|
|
562
|
|
|
563 _OrthancPluginContentType_INTERNAL = 0x7fffffff
|
|
|
564 } OrthancPluginContentType;
|
|
|
565
|
|
|
566
|
|
|
567
|
|
|
568 /**
|
|
|
569 * The supported types of DICOM resources.
|
|
|
570 **/
|
|
|
571 typedef enum
|
|
|
572 {
|
|
|
573 OrthancPluginResourceType_Patient = 0, /*!< Patient */
|
|
|
574 OrthancPluginResourceType_Study = 1, /*!< Study */
|
|
|
575 OrthancPluginResourceType_Series = 2, /*!< Series */
|
|
|
576 OrthancPluginResourceType_Instance = 3, /*!< Instance */
|
|
101
|
577 OrthancPluginResourceType_None = 4, /*!< Unavailable resource type */
|
|
78
|
578
|
|
|
579 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
|
|
|
580 } OrthancPluginResourceType;
|
|
|
581
|
|
|
582
|
|
|
583
|
|
|
584 /**
|
|
|
585 * The supported types of changes that can happen to DICOM resources.
|
|
|
586 * @ingroup Callbacks
|
|
|
587 **/
|
|
|
588 typedef enum
|
|
|
589 {
|
|
|
590 OrthancPluginChangeType_CompletedSeries = 0, /*!< Series is now complete */
|
|
|
591 OrthancPluginChangeType_Deleted = 1, /*!< Deleted resource */
|
|
|
592 OrthancPluginChangeType_NewChildInstance = 2, /*!< A new instance was added to this resource */
|
|
|
593 OrthancPluginChangeType_NewInstance = 3, /*!< New instance received */
|
|
|
594 OrthancPluginChangeType_NewPatient = 4, /*!< New patient created */
|
|
|
595 OrthancPluginChangeType_NewSeries = 5, /*!< New series created */
|
|
|
596 OrthancPluginChangeType_NewStudy = 6, /*!< New study created */
|
|
|
597 OrthancPluginChangeType_StablePatient = 7, /*!< Timeout: No new instance in this patient */
|
|
|
598 OrthancPluginChangeType_StableSeries = 8, /*!< Timeout: No new instance in this series */
|
|
|
599 OrthancPluginChangeType_StableStudy = 9, /*!< Timeout: No new instance in this study */
|
|
101
|
600 OrthancPluginChangeType_OrthancStarted = 10, /*!< Orthanc has started */
|
|
|
601 OrthancPluginChangeType_OrthancStopped = 11, /*!< Orthanc is stopping */
|
|
|
602 OrthancPluginChangeType_UpdatedAttachment = 12, /*!< Some user-defined attachment has changed for this resource */
|
|
|
603 OrthancPluginChangeType_UpdatedMetadata = 13, /*!< Some user-defined metadata has changed for this resource */
|
|
78
|
604
|
|
|
605 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
|
|
|
606 } OrthancPluginChangeType;
|
|
|
607
|
|
|
608
|
|
|
609 /**
|
|
|
610 * The compression algorithms that are supported by the Orthanc core.
|
|
|
611 * @ingroup Images
|
|
|
612 **/
|
|
|
613 typedef enum
|
|
|
614 {
|
|
|
615 OrthancPluginCompressionType_Zlib = 0, /*!< Standard zlib compression */
|
|
|
616 OrthancPluginCompressionType_ZlibWithSize = 1, /*!< zlib, prefixed with uncompressed size (uint64_t) */
|
|
|
617 OrthancPluginCompressionType_Gzip = 2, /*!< Standard gzip compression */
|
|
|
618 OrthancPluginCompressionType_GzipWithSize = 3, /*!< gzip, prefixed with uncompressed size (uint64_t) */
|
|
|
619
|
|
|
620 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
|
|
|
621 } OrthancPluginCompressionType;
|
|
|
622
|
|
|
623
|
|
|
624 /**
|
|
|
625 * The image formats that are supported by the Orthanc core.
|
|
|
626 * @ingroup Images
|
|
|
627 **/
|
|
|
628 typedef enum
|
|
|
629 {
|
|
101
|
630 OrthancPluginImageFormat_Png = 0, /*!< Image compressed using PNG */
|
|
|
631 OrthancPluginImageFormat_Jpeg = 1, /*!< Image compressed using JPEG */
|
|
|
632 OrthancPluginImageFormat_Dicom = 2, /*!< Image compressed using DICOM */
|
|
78
|
633
|
|
|
634 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
|
|
|
635 } OrthancPluginImageFormat;
|
|
|
636
|
|
|
637
|
|
101
|
638 /**
|
|
|
639 * The value representations present in the DICOM standard (version 2013).
|
|
|
640 * @ingroup Toolbox
|
|
|
641 **/
|
|
|
642 typedef enum
|
|
|
643 {
|
|
|
644 OrthancPluginValueRepresentation_AE = 1, /*!< Application Entity */
|
|
|
645 OrthancPluginValueRepresentation_AS = 2, /*!< Age String */
|
|
|
646 OrthancPluginValueRepresentation_AT = 3, /*!< Attribute Tag */
|
|
|
647 OrthancPluginValueRepresentation_CS = 4, /*!< Code String */
|
|
|
648 OrthancPluginValueRepresentation_DA = 5, /*!< Date */
|
|
|
649 OrthancPluginValueRepresentation_DS = 6, /*!< Decimal String */
|
|
|
650 OrthancPluginValueRepresentation_DT = 7, /*!< Date Time */
|
|
|
651 OrthancPluginValueRepresentation_FD = 8, /*!< Floating Point Double */
|
|
|
652 OrthancPluginValueRepresentation_FL = 9, /*!< Floating Point Single */
|
|
|
653 OrthancPluginValueRepresentation_IS = 10, /*!< Integer String */
|
|
|
654 OrthancPluginValueRepresentation_LO = 11, /*!< Long String */
|
|
|
655 OrthancPluginValueRepresentation_LT = 12, /*!< Long Text */
|
|
|
656 OrthancPluginValueRepresentation_OB = 13, /*!< Other Byte String */
|
|
|
657 OrthancPluginValueRepresentation_OF = 14, /*!< Other Float String */
|
|
|
658 OrthancPluginValueRepresentation_OW = 15, /*!< Other Word String */
|
|
|
659 OrthancPluginValueRepresentation_PN = 16, /*!< Person Name */
|
|
|
660 OrthancPluginValueRepresentation_SH = 17, /*!< Short String */
|
|
|
661 OrthancPluginValueRepresentation_SL = 18, /*!< Signed Long */
|
|
|
662 OrthancPluginValueRepresentation_SQ = 19, /*!< Sequence of Items */
|
|
|
663 OrthancPluginValueRepresentation_SS = 20, /*!< Signed Short */
|
|
|
664 OrthancPluginValueRepresentation_ST = 21, /*!< Short Text */
|
|
|
665 OrthancPluginValueRepresentation_TM = 22, /*!< Time */
|
|
|
666 OrthancPluginValueRepresentation_UI = 23, /*!< Unique Identifier (UID) */
|
|
|
667 OrthancPluginValueRepresentation_UL = 24, /*!< Unsigned Long */
|
|
|
668 OrthancPluginValueRepresentation_UN = 25, /*!< Unknown */
|
|
|
669 OrthancPluginValueRepresentation_US = 26, /*!< Unsigned Short */
|
|
|
670 OrthancPluginValueRepresentation_UT = 27, /*!< Unlimited Text */
|
|
|
671
|
|
|
672 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
|
|
|
673 } OrthancPluginValueRepresentation;
|
|
|
674
|
|
|
675
|
|
|
676 /**
|
|
|
677 * The possible output formats for a DICOM-to-JSON conversion.
|
|
|
678 * @ingroup Toolbox
|
|
|
679 * @see OrthancPluginDicomToJson()
|
|
|
680 **/
|
|
|
681 typedef enum
|
|
|
682 {
|
|
|
683 OrthancPluginDicomToJsonFormat_Full = 1, /*!< Full output, with most details */
|
|
|
684 OrthancPluginDicomToJsonFormat_Short = 2, /*!< Tags output as hexadecimal numbers */
|
|
|
685 OrthancPluginDicomToJsonFormat_Simple = 3, /*!< Human-readable JSON */
|
|
|
686
|
|
|
687 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
|
|
|
688 } OrthancPluginDicomToJsonFormat;
|
|
|
689
|
|
|
690
|
|
|
691 /**
|
|
|
692 * Flags to customize a DICOM-to-JSON conversion. By default, binary
|
|
|
693 * tags are formatted using Data URI scheme.
|
|
|
694 * @ingroup Toolbox
|
|
|
695 **/
|
|
|
696 typedef enum
|
|
|
697 {
|
|
|
698 OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /*!< Include the binary tags */
|
|
|
699 OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /*!< Include the private tags */
|
|
|
700 OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /*!< Include the tags unknown by the dictionary */
|
|
|
701 OrthancPluginDicomToJsonFlags_IncludePixelData = (1 << 3), /*!< Include the pixel data */
|
|
|
702 OrthancPluginDicomToJsonFlags_ConvertBinaryToAscii = (1 << 4), /*!< Output binary tags as-is, dropping non-ASCII */
|
|
|
703 OrthancPluginDicomToJsonFlags_ConvertBinaryToNull = (1 << 5), /*!< Signal binary tags as null values */
|
|
|
704
|
|
|
705 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
|
|
|
706 } OrthancPluginDicomToJsonFlags;
|
|
|
707
|
|
|
708
|
|
|
709 /**
|
|
|
710 * Flags to the creation of a DICOM file.
|
|
|
711 * @ingroup Toolbox
|
|
|
712 * @see OrthancPluginCreateDicom()
|
|
|
713 **/
|
|
|
714 typedef enum
|
|
|
715 {
|
|
|
716 OrthancPluginCreateDicomFlags_DecodeDataUriScheme = (1 << 0), /*!< Decode fields encoded using data URI scheme */
|
|
|
717 OrthancPluginCreateDicomFlags_GenerateIdentifiers = (1 << 1), /*!< Automatically generate DICOM identifiers */
|
|
|
718
|
|
|
719 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
|
|
|
720 } OrthancPluginCreateDicomFlags;
|
|
|
721
|
|
|
722
|
|
|
723 /**
|
|
|
724 * The constraints on the DICOM identifiers that must be supported
|
|
|
725 * by the database plugins.
|
|
|
726 **/
|
|
|
727 typedef enum
|
|
|
728 {
|
|
|
729 OrthancPluginIdentifierConstraint_Equal = 1, /*!< Equal */
|
|
|
730 OrthancPluginIdentifierConstraint_SmallerOrEqual = 2, /*!< Less or equal */
|
|
|
731 OrthancPluginIdentifierConstraint_GreaterOrEqual = 3, /*!< More or equal */
|
|
|
732 OrthancPluginIdentifierConstraint_Wildcard = 4, /*!< Case-sensitive wildcard matching (with * and ?) */
|
|
|
733
|
|
|
734 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
|
|
|
735 } OrthancPluginIdentifierConstraint;
|
|
|
736
|
|
|
737
|
|
|
738 /**
|
|
|
739 * The origin of a DICOM instance that has been received by Orthanc.
|
|
|
740 **/
|
|
|
741 typedef enum
|
|
|
742 {
|
|
|
743 OrthancPluginInstanceOrigin_Unknown = 1, /*!< Unknown origin */
|
|
|
744 OrthancPluginInstanceOrigin_DicomProtocol = 2, /*!< Instance received through DICOM protocol */
|
|
|
745 OrthancPluginInstanceOrigin_RestApi = 3, /*!< Instance received through REST API of Orthanc */
|
|
|
746 OrthancPluginInstanceOrigin_Plugin = 4, /*!< Instance added to Orthanc by a plugin */
|
|
|
747 OrthancPluginInstanceOrigin_Lua = 5, /*!< Instance added to Orthanc by a Lua script */
|
|
|
748
|
|
|
749 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
|
|
|
750 } OrthancPluginInstanceOrigin;
|
|
|
751
|
|
78
|
752
|
|
|
753 /**
|
|
|
754 * @brief A memory buffer allocated by the core system of Orthanc.
|
|
|
755 *
|
|
|
756 * A memory buffer allocated by the core system of Orthanc. When the
|
|
|
757 * content of the buffer is not useful anymore, it must be free by a
|
|
|
758 * call to ::OrthancPluginFreeMemoryBuffer().
|
|
|
759 **/
|
|
|
760 typedef struct
|
|
|
761 {
|
|
|
762 /**
|
|
|
763 * @brief The content of the buffer.
|
|
|
764 **/
|
|
|
765 void* data;
|
|
|
766
|
|
|
767 /**
|
|
|
768 * @brief The number of bytes in the buffer.
|
|
|
769 **/
|
|
|
770 uint32_t size;
|
|
|
771 } OrthancPluginMemoryBuffer;
|
|
|
772
|
|
|
773
|
|
|
774
|
|
|
775
|
|
|
776 /**
|
|
|
777 * @brief Opaque structure that represents the HTTP connection to the client application.
|
|
|
778 * @ingroup Callback
|
|
|
779 **/
|
|
|
780 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
|
|
|
781
|
|
|
782
|
|
|
783
|
|
|
784 /**
|
|
|
785 * @brief Opaque structure that represents a DICOM instance received by Orthanc.
|
|
|
786 **/
|
|
|
787 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
|
|
|
788
|
|
|
789
|
|
|
790
|
|
|
791 /**
|
|
|
792 * @brief Opaque structure that represents an image that is uncompressed in memory.
|
|
|
793 * @ingroup Images
|
|
|
794 **/
|
|
|
795 typedef struct _OrthancPluginImage_t OrthancPluginImage;
|
|
|
796
|
|
|
797
|
|
|
798
|
|
|
799 /**
|
|
|
800 * @brief Opaque structure that represents the storage area that is actually used by Orthanc.
|
|
|
801 * @ingroup Images
|
|
|
802 **/
|
|
|
803 typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea;
|
|
|
804
|
|
|
805
|
|
|
806
|
|
|
807 /**
|
|
101
|
808 * @brief Opaque structure to an object that represents a C-Find query.
|
|
|
809 * @ingroup Worklists
|
|
|
810 **/
|
|
|
811 typedef struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery;
|
|
|
812
|
|
|
813
|
|
|
814
|
|
|
815 /**
|
|
|
816 * @brief Opaque structure to an object that represents the answers to a C-Find query.
|
|
|
817 * @ingroup Worklists
|
|
|
818 **/
|
|
|
819 typedef struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers;
|
|
|
820
|
|
|
821
|
|
|
822
|
|
|
823 /**
|
|
78
|
824 * @brief Signature of a callback function that answers to a REST request.
|
|
|
825 * @ingroup Callbacks
|
|
|
826 **/
|
|
101
|
827 typedef OrthancPluginErrorCode (*OrthancPluginRestCallback) (
|
|
78
|
828 OrthancPluginRestOutput* output,
|
|
|
829 const char* url,
|
|
|
830 const OrthancPluginHttpRequest* request);
|
|
|
831
|
|
|
832
|
|
|
833
|
|
|
834 /**
|
|
|
835 * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
|
|
|
836 * @ingroup Callbacks
|
|
|
837 **/
|
|
101
|
838 typedef OrthancPluginErrorCode (*OrthancPluginOnStoredInstanceCallback) (
|
|
78
|
839 OrthancPluginDicomInstance* instance,
|
|
|
840 const char* instanceId);
|
|
|
841
|
|
|
842
|
|
|
843
|
|
|
844 /**
|
|
|
845 * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource.
|
|
|
846 * @ingroup Callbacks
|
|
|
847 **/
|
|
101
|
848 typedef OrthancPluginErrorCode (*OrthancPluginOnChangeCallback) (
|
|
78
|
849 OrthancPluginChangeType changeType,
|
|
|
850 OrthancPluginResourceType resourceType,
|
|
|
851 const char* resourceId);
|
|
|
852
|
|
|
853
|
|
|
854
|
|
|
855 /**
|
|
101
|
856 * @brief Signature of a callback function to decode a DICOM instance as an image.
|
|
|
857 * @ingroup Callbacks
|
|
|
858 **/
|
|
|
859 typedef OrthancPluginErrorCode (*OrthancPluginDecodeImageCallback) (
|
|
|
860 OrthancPluginImage** target,
|
|
|
861 const void* dicom,
|
|
|
862 const uint32_t size,
|
|
|
863 uint32_t frameIndex);
|
|
|
864
|
|
|
865
|
|
|
866
|
|
|
867 /**
|
|
78
|
868 * @brief Signature of a function to free dynamic memory.
|
|
|
869 **/
|
|
|
870 typedef void (*OrthancPluginFree) (void* buffer);
|
|
|
871
|
|
|
872
|
|
|
873
|
|
|
874 /**
|
|
|
875 * @brief Callback for writing to the storage area.
|
|
|
876 *
|
|
|
877 * Signature of a callback function that is triggered when Orthanc writes a file to the storage area.
|
|
|
878 *
|
|
|
879 * @param uuid The UUID of the file.
|
|
|
880 * @param content The content of the file.
|
|
|
881 * @param size The size of the file.
|
|
|
882 * @param type The content type corresponding to this file.
|
|
|
883 * @return 0 if success, other value if error.
|
|
|
884 * @ingroup Callbacks
|
|
|
885 **/
|
|
101
|
886 typedef OrthancPluginErrorCode (*OrthancPluginStorageCreate) (
|
|
78
|
887 const char* uuid,
|
|
|
888 const void* content,
|
|
|
889 int64_t size,
|
|
|
890 OrthancPluginContentType type);
|
|
|
891
|
|
|
892
|
|
|
893
|
|
|
894 /**
|
|
|
895 * @brief Callback for reading from the storage area.
|
|
|
896 *
|
|
|
897 * Signature of a callback function that is triggered when Orthanc reads a file from the storage area.
|
|
|
898 *
|
|
|
899 * @param content The content of the file (output).
|
|
|
900 * @param size The size of the file (output).
|
|
|
901 * @param uuid The UUID of the file of interest.
|
|
|
902 * @param type The content type corresponding to this file.
|
|
|
903 * @return 0 if success, other value if error.
|
|
|
904 * @ingroup Callbacks
|
|
|
905 **/
|
|
101
|
906 typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) (
|
|
78
|
907 void** content,
|
|
|
908 int64_t* size,
|
|
|
909 const char* uuid,
|
|
|
910 OrthancPluginContentType type);
|
|
|
911
|
|
|
912
|
|
|
913
|
|
|
914 /**
|
|
|
915 * @brief Callback for removing a file from the storage area.
|
|
|
916 *
|
|
|
917 * Signature of a callback function that is triggered when Orthanc deletes a file from the storage area.
|
|
|
918 *
|
|
|
919 * @param uuid The UUID of the file to be removed.
|
|
|
920 * @param type The content type corresponding to this file.
|
|
|
921 * @return 0 if success, other value if error.
|
|
|
922 * @ingroup Callbacks
|
|
|
923 **/
|
|
101
|
924 typedef OrthancPluginErrorCode (*OrthancPluginStorageRemove) (
|
|
78
|
925 const char* uuid,
|
|
|
926 OrthancPluginContentType type);
|
|
|
927
|
|
|
928
|
|
|
929
|
|
|
930 /**
|
|
101
|
931 * @brief Callback to handle the C-Find SCP requests received by Orthanc.
|
|
|
932 *
|
|
|
933 * Signature of a callback function that is triggered when Orthanc
|
|
|
934 * receives a C-Find SCP request against modality worklists.
|
|
|
935 *
|
|
|
936 * @param answers The target structure where answers must be stored.
|
|
|
937 * @param query The worklist query.
|
|
|
938 * @param remoteAet The Application Entity Title (AET) of the modality from which the request originates.
|
|
|
939 * @param calledAet The Application Entity Title (AET) of the modality that is called by the request.
|
|
|
940 * @return 0 if success, other value if error.
|
|
|
941 * @ingroup Worklists
|
|
|
942 **/
|
|
|
943 typedef OrthancPluginErrorCode (*OrthancPluginWorklistCallback) (
|
|
|
944 OrthancPluginWorklistAnswers* answers,
|
|
|
945 const OrthancPluginWorklistQuery* query,
|
|
|
946 const char* remoteAet,
|
|
|
947 const char* calledAet);
|
|
|
948
|
|
|
949
|
|
|
950
|
|
|
951 /**
|
|
78
|
952 * @brief Data structure that contains information about the Orthanc core.
|
|
|
953 **/
|
|
|
954 typedef struct _OrthancPluginContext_t
|
|
|
955 {
|
|
|
956 void* pluginsManager;
|
|
|
957 const char* orthancVersion;
|
|
|
958 OrthancPluginFree Free;
|
|
|
959 OrthancPluginErrorCode (*InvokeService) (struct _OrthancPluginContext_t* context,
|
|
|
960 _OrthancPluginService service,
|
|
|
961 const void* params);
|
|
|
962 } OrthancPluginContext;
|
|
|
963
|
|
|
964
|
|
|
965
|
|
|
966 /**
|
|
|
967 * @brief Free a string.
|
|
|
968 *
|
|
|
969 * Free a string that was allocated by the core system of Orthanc.
|
|
|
970 *
|
|
|
971 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
972 * @param str The string to be freed.
|
|
|
973 **/
|
|
|
974 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
|
|
|
975 OrthancPluginContext* context,
|
|
|
976 char* str)
|
|
|
977 {
|
|
|
978 if (str != NULL)
|
|
|
979 {
|
|
|
980 context->Free(str);
|
|
|
981 }
|
|
|
982 }
|
|
|
983
|
|
|
984
|
|
|
985 /**
|
|
|
986 * @brief Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
|
|
|
987 *
|
|
|
988 * This function checks whether the version of this C header is
|
|
|
989 * compatible with the current version of Orthanc. The result of
|
|
|
990 * this function should always be checked in the
|
|
|
991 * OrthancPluginInitialize() entry point of the plugin.
|
|
|
992 *
|
|
|
993 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
994 * @return 1 if and only if the versions are compatible. If the
|
|
|
995 * result is 0, the initialization of the plugin should fail.
|
|
|
996 * @ingroup Callbacks
|
|
|
997 **/
|
|
|
998 ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
|
|
|
999 OrthancPluginContext* context)
|
|
|
1000 {
|
|
|
1001 int major, minor, revision;
|
|
|
1002
|
|
|
1003 if (sizeof(int32_t) != sizeof(OrthancPluginErrorCode) ||
|
|
|
1004 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) ||
|
|
|
1005 sizeof(int32_t) != sizeof(_OrthancPluginService) ||
|
|
|
1006 sizeof(int32_t) != sizeof(_OrthancPluginProperty) ||
|
|
|
1007 sizeof(int32_t) != sizeof(OrthancPluginPixelFormat) ||
|
|
|
1008 sizeof(int32_t) != sizeof(OrthancPluginContentType) ||
|
|
|
1009 sizeof(int32_t) != sizeof(OrthancPluginResourceType) ||
|
|
|
1010 sizeof(int32_t) != sizeof(OrthancPluginChangeType) ||
|
|
|
1011 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) ||
|
|
101
|
1012 sizeof(int32_t) != sizeof(OrthancPluginImageFormat) ||
|
|
|
1013 sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) ||
|
|
|
1014 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) ||
|
|
|
1015 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) ||
|
|
|
1016 sizeof(int32_t) != sizeof(OrthancPluginCreateDicomFlags) ||
|
|
|
1017 sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) ||
|
|
|
1018 sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin))
|
|
78
|
1019 {
|
|
|
1020 /* Mismatch in the size of the enumerations */
|
|
|
1021 return 0;
|
|
|
1022 }
|
|
|
1023
|
|
|
1024 /* Assume compatibility with the mainline */
|
|
|
1025 if (!strcmp(context->orthancVersion, "mainline"))
|
|
|
1026 {
|
|
|
1027 return 1;
|
|
|
1028 }
|
|
|
1029
|
|
|
1030 /* Parse the version of the Orthanc core */
|
|
|
1031 if (
|
|
|
1032 #ifdef _MSC_VER
|
|
|
1033 sscanf_s
|
|
|
1034 #else
|
|
|
1035 sscanf
|
|
|
1036 #endif
|
|
|
1037 (context->orthancVersion, "%4d.%4d.%4d", &major, &minor, &revision) != 3)
|
|
|
1038 {
|
|
|
1039 return 0;
|
|
|
1040 }
|
|
|
1041
|
|
|
1042 /* Check the major number of the version */
|
|
|
1043
|
|
|
1044 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
|
|
|
1045 {
|
|
|
1046 return 1;
|
|
|
1047 }
|
|
|
1048
|
|
|
1049 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
|
|
|
1050 {
|
|
|
1051 return 0;
|
|
|
1052 }
|
|
|
1053
|
|
|
1054 /* Check the minor number of the version */
|
|
|
1055
|
|
|
1056 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
|
|
|
1057 {
|
|
|
1058 return 1;
|
|
|
1059 }
|
|
|
1060
|
|
|
1061 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
|
|
|
1062 {
|
|
|
1063 return 0;
|
|
|
1064 }
|
|
|
1065
|
|
|
1066 /* Check the revision number of the version */
|
|
|
1067
|
|
|
1068 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
|
|
|
1069 {
|
|
|
1070 return 1;
|
|
|
1071 }
|
|
|
1072 else
|
|
|
1073 {
|
|
|
1074 return 0;
|
|
|
1075 }
|
|
|
1076 }
|
|
|
1077
|
|
|
1078
|
|
|
1079 /**
|
|
|
1080 * @brief Free a memory buffer.
|
|
|
1081 *
|
|
|
1082 * Free a memory buffer that was allocated by the core system of Orthanc.
|
|
|
1083 *
|
|
|
1084 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1085 * @param buffer The memory buffer to release.
|
|
|
1086 **/
|
|
|
1087 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
|
|
|
1088 OrthancPluginContext* context,
|
|
|
1089 OrthancPluginMemoryBuffer* buffer)
|
|
|
1090 {
|
|
|
1091 context->Free(buffer->data);
|
|
|
1092 }
|
|
|
1093
|
|
|
1094
|
|
|
1095 /**
|
|
|
1096 * @brief Log an error.
|
|
|
1097 *
|
|
|
1098 * Log an error message using the Orthanc logging system.
|
|
|
1099 *
|
|
|
1100 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1101 * @param message The message to be logged.
|
|
|
1102 **/
|
|
|
1103 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
|
|
|
1104 OrthancPluginContext* context,
|
|
|
1105 const char* message)
|
|
|
1106 {
|
|
|
1107 context->InvokeService(context, _OrthancPluginService_LogError, message);
|
|
|
1108 }
|
|
|
1109
|
|
|
1110
|
|
|
1111 /**
|
|
|
1112 * @brief Log a warning.
|
|
|
1113 *
|
|
|
1114 * Log a warning message using the Orthanc logging system.
|
|
|
1115 *
|
|
|
1116 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1117 * @param message The message to be logged.
|
|
|
1118 **/
|
|
|
1119 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
|
|
|
1120 OrthancPluginContext* context,
|
|
|
1121 const char* message)
|
|
|
1122 {
|
|
|
1123 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
|
|
|
1124 }
|
|
|
1125
|
|
|
1126
|
|
|
1127 /**
|
|
|
1128 * @brief Log an information.
|
|
|
1129 *
|
|
|
1130 * Log an information message using the Orthanc logging system.
|
|
|
1131 *
|
|
|
1132 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1133 * @param message The message to be logged.
|
|
|
1134 **/
|
|
|
1135 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
|
|
|
1136 OrthancPluginContext* context,
|
|
|
1137 const char* message)
|
|
|
1138 {
|
|
|
1139 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
|
|
|
1140 }
|
|
|
1141
|
|
|
1142
|
|
|
1143
|
|
|
1144 typedef struct
|
|
|
1145 {
|
|
|
1146 const char* pathRegularExpression;
|
|
|
1147 OrthancPluginRestCallback callback;
|
|
|
1148 } _OrthancPluginRestCallback;
|
|
|
1149
|
|
|
1150 /**
|
|
|
1151 * @brief Register a REST callback.
|
|
|
1152 *
|
|
|
1153 * This function registers a REST callback against a regular
|
|
|
1154 * expression for a URI. This function must be called during the
|
|
|
1155 * initialization of the plugin, i.e. inside the
|
|
|
1156 * OrthancPluginInitialize() public function.
|
|
|
1157 *
|
|
|
1158 * Each REST callback is guaranteed to run in mutual exclusion.
|
|
|
1159 *
|
|
|
1160 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1161 * @param pathRegularExpression Regular expression for the URI. May contain groups.
|
|
|
1162 * @param callback The callback function to handle the REST call.
|
|
|
1163 * @see OrthancPluginRegisterRestCallbackNoLock()
|
|
|
1164 * @ingroup Callbacks
|
|
|
1165 **/
|
|
|
1166 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
|
|
|
1167 OrthancPluginContext* context,
|
|
|
1168 const char* pathRegularExpression,
|
|
|
1169 OrthancPluginRestCallback callback)
|
|
|
1170 {
|
|
|
1171 _OrthancPluginRestCallback params;
|
|
|
1172 params.pathRegularExpression = pathRegularExpression;
|
|
|
1173 params.callback = callback;
|
|
|
1174 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
|
|
|
1175 }
|
|
|
1176
|
|
|
1177
|
|
|
1178
|
|
|
1179 /**
|
|
|
1180 * @brief Register a REST callback, without locking.
|
|
|
1181 *
|
|
|
1182 * This function registers a REST callback against a regular
|
|
|
1183 * expression for a URI. This function must be called during the
|
|
|
1184 * initialization of the plugin, i.e. inside the
|
|
|
1185 * OrthancPluginInitialize() public function.
|
|
|
1186 *
|
|
|
1187 * Contrarily to OrthancPluginRegisterRestCallback(), the callback
|
|
|
1188 * will NOT be invoked in mutual exclusion. This can be useful for
|
|
|
1189 * high-performance plugins that must handle concurrent requests
|
|
|
1190 * (Orthanc uses a pool of threads, one thread being assigned to
|
|
|
1191 * each incoming HTTP request). Of course, it is up to the plugin to
|
|
|
1192 * implement the required locking mechanisms.
|
|
|
1193 *
|
|
|
1194 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1195 * @param pathRegularExpression Regular expression for the URI. May contain groups.
|
|
|
1196 * @param callback The callback function to handle the REST call.
|
|
|
1197 * @see OrthancPluginRegisterRestCallback()
|
|
|
1198 * @ingroup Callbacks
|
|
|
1199 **/
|
|
|
1200 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock(
|
|
|
1201 OrthancPluginContext* context,
|
|
|
1202 const char* pathRegularExpression,
|
|
|
1203 OrthancPluginRestCallback callback)
|
|
|
1204 {
|
|
|
1205 _OrthancPluginRestCallback params;
|
|
|
1206 params.pathRegularExpression = pathRegularExpression;
|
|
|
1207 params.callback = callback;
|
|
|
1208 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
|
|
|
1209 }
|
|
|
1210
|
|
|
1211
|
|
|
1212
|
|
|
1213 typedef struct
|
|
|
1214 {
|
|
|
1215 OrthancPluginOnStoredInstanceCallback callback;
|
|
|
1216 } _OrthancPluginOnStoredInstanceCallback;
|
|
|
1217
|
|
|
1218 /**
|
|
|
1219 * @brief Register a callback for received instances.
|
|
|
1220 *
|
|
|
1221 * This function registers a callback function that is called
|
|
|
1222 * whenever a new DICOM instance is stored into the Orthanc core.
|
|
|
1223 *
|
|
|
1224 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1225 * @param callback The callback function.
|
|
|
1226 * @ingroup Callbacks
|
|
|
1227 **/
|
|
|
1228 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
|
|
|
1229 OrthancPluginContext* context,
|
|
|
1230 OrthancPluginOnStoredInstanceCallback callback)
|
|
|
1231 {
|
|
|
1232 _OrthancPluginOnStoredInstanceCallback params;
|
|
|
1233 params.callback = callback;
|
|
|
1234
|
|
|
1235 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
|
|
|
1236 }
|
|
|
1237
|
|
|
1238
|
|
|
1239
|
|
|
1240 typedef struct
|
|
|
1241 {
|
|
|
1242 OrthancPluginRestOutput* output;
|
|
|
1243 const char* answer;
|
|
|
1244 uint32_t answerSize;
|
|
|
1245 const char* mimeType;
|
|
|
1246 } _OrthancPluginAnswerBuffer;
|
|
|
1247
|
|
|
1248 /**
|
|
|
1249 * @brief Answer to a REST request.
|
|
|
1250 *
|
|
|
1251 * This function answers to a REST request with the content of a memory buffer.
|
|
|
1252 *
|
|
|
1253 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1254 * @param output The HTTP connection to the client application.
|
|
|
1255 * @param answer Pointer to the memory buffer containing the answer.
|
|
|
1256 * @param answerSize Number of bytes of the answer.
|
|
|
1257 * @param mimeType The MIME type of the answer.
|
|
|
1258 * @ingroup REST
|
|
|
1259 **/
|
|
|
1260 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
|
|
|
1261 OrthancPluginContext* context,
|
|
|
1262 OrthancPluginRestOutput* output,
|
|
|
1263 const char* answer,
|
|
|
1264 uint32_t answerSize,
|
|
|
1265 const char* mimeType)
|
|
|
1266 {
|
|
|
1267 _OrthancPluginAnswerBuffer params;
|
|
|
1268 params.output = output;
|
|
|
1269 params.answer = answer;
|
|
|
1270 params.answerSize = answerSize;
|
|
|
1271 params.mimeType = mimeType;
|
|
|
1272 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
|
|
|
1273 }
|
|
|
1274
|
|
|
1275
|
|
|
1276 typedef struct
|
|
|
1277 {
|
|
|
1278 OrthancPluginRestOutput* output;
|
|
|
1279 OrthancPluginPixelFormat format;
|
|
|
1280 uint32_t width;
|
|
|
1281 uint32_t height;
|
|
|
1282 uint32_t pitch;
|
|
|
1283 const void* buffer;
|
|
|
1284 } _OrthancPluginCompressAndAnswerPngImage;
|
|
|
1285
|
|
|
1286 typedef struct
|
|
|
1287 {
|
|
|
1288 OrthancPluginRestOutput* output;
|
|
|
1289 OrthancPluginImageFormat imageFormat;
|
|
|
1290 OrthancPluginPixelFormat pixelFormat;
|
|
|
1291 uint32_t width;
|
|
|
1292 uint32_t height;
|
|
|
1293 uint32_t pitch;
|
|
|
1294 const void* buffer;
|
|
|
1295 uint8_t quality;
|
|
|
1296 } _OrthancPluginCompressAndAnswerImage;
|
|
|
1297
|
|
|
1298
|
|
|
1299 /**
|
|
|
1300 * @brief Answer to a REST request with a PNG image.
|
|
|
1301 *
|
|
|
1302 * This function answers to a REST request with a PNG image. The
|
|
|
1303 * parameters of this function describe a memory buffer that
|
|
|
1304 * contains an uncompressed image. The image will be automatically compressed
|
|
|
1305 * as a PNG image by the core system of Orthanc.
|
|
|
1306 *
|
|
|
1307 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1308 * @param output The HTTP connection to the client application.
|
|
|
1309 * @param format The memory layout of the uncompressed image.
|
|
|
1310 * @param width The width of the image.
|
|
|
1311 * @param height The height of the image.
|
|
|
1312 * @param pitch The pitch of the image (i.e. the number of bytes
|
|
|
1313 * between 2 successive lines of the image in the memory buffer).
|
|
|
1314 * @param buffer The memory buffer containing the uncompressed image.
|
|
|
1315 * @ingroup REST
|
|
|
1316 **/
|
|
|
1317 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
|
|
|
1318 OrthancPluginContext* context,
|
|
|
1319 OrthancPluginRestOutput* output,
|
|
|
1320 OrthancPluginPixelFormat format,
|
|
|
1321 uint32_t width,
|
|
|
1322 uint32_t height,
|
|
|
1323 uint32_t pitch,
|
|
|
1324 const void* buffer)
|
|
|
1325 {
|
|
|
1326 _OrthancPluginCompressAndAnswerImage params;
|
|
|
1327 params.output = output;
|
|
|
1328 params.imageFormat = OrthancPluginImageFormat_Png;
|
|
|
1329 params.pixelFormat = format;
|
|
|
1330 params.width = width;
|
|
|
1331 params.height = height;
|
|
|
1332 params.pitch = pitch;
|
|
|
1333 params.buffer = buffer;
|
|
|
1334 params.quality = 0; /* No quality for PNG */
|
|
|
1335 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
|
|
|
1336 }
|
|
|
1337
|
|
|
1338
|
|
|
1339
|
|
|
1340 typedef struct
|
|
|
1341 {
|
|
|
1342 OrthancPluginMemoryBuffer* target;
|
|
|
1343 const char* instanceId;
|
|
|
1344 } _OrthancPluginGetDicomForInstance;
|
|
|
1345
|
|
|
1346 /**
|
|
|
1347 * @brief Retrieve a DICOM instance using its Orthanc identifier.
|
|
|
1348 *
|
|
|
1349 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM
|
|
|
1350 * file is stored into a newly allocated memory buffer.
|
|
|
1351 *
|
|
|
1352 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1353 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1354 * @param instanceId The Orthanc identifier of the DICOM instance of interest.
|
|
|
1355 * @return 0 if success, or the error code if failure.
|
|
|
1356 * @ingroup Orthanc
|
|
|
1357 **/
|
|
|
1358 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance(
|
|
|
1359 OrthancPluginContext* context,
|
|
|
1360 OrthancPluginMemoryBuffer* target,
|
|
|
1361 const char* instanceId)
|
|
|
1362 {
|
|
|
1363 _OrthancPluginGetDicomForInstance params;
|
|
|
1364 params.target = target;
|
|
|
1365 params.instanceId = instanceId;
|
|
|
1366 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
|
|
|
1367 }
|
|
|
1368
|
|
|
1369
|
|
|
1370
|
|
|
1371 typedef struct
|
|
|
1372 {
|
|
|
1373 OrthancPluginMemoryBuffer* target;
|
|
|
1374 const char* uri;
|
|
|
1375 } _OrthancPluginRestApiGet;
|
|
|
1376
|
|
|
1377 /**
|
|
|
1378 * @brief Make a GET call to the built-in Orthanc REST API.
|
|
|
1379 *
|
|
|
1380 * Make a GET call to the built-in Orthanc REST API. The result to
|
|
|
1381 * the query is stored into a newly allocated memory buffer.
|
|
|
1382 *
|
|
|
1383 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1384 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1385 * @param uri The URI in the built-in Orthanc API.
|
|
|
1386 * @return 0 if success, or the error code if failure.
|
|
|
1387 * @see OrthancPluginRestApiGetAfterPlugins
|
|
|
1388 * @ingroup Orthanc
|
|
|
1389 **/
|
|
|
1390 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet(
|
|
|
1391 OrthancPluginContext* context,
|
|
|
1392 OrthancPluginMemoryBuffer* target,
|
|
|
1393 const char* uri)
|
|
|
1394 {
|
|
|
1395 _OrthancPluginRestApiGet params;
|
|
|
1396 params.target = target;
|
|
|
1397 params.uri = uri;
|
|
|
1398 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
|
|
|
1399 }
|
|
|
1400
|
|
|
1401
|
|
|
1402
|
|
|
1403 /**
|
|
|
1404 * @brief Make a GET call to the REST API, as tainted by the plugins.
|
|
|
1405 *
|
|
|
1406 * Make a GET call to the Orthanc REST API, after all the plugins
|
|
|
1407 * are applied. In other words, if some plugin overrides or adds the
|
|
|
1408 * called URI to the built-in Orthanc REST API, this call will
|
|
|
1409 * return the result provided by this plugin. The result to the
|
|
|
1410 * query is stored into a newly allocated memory buffer.
|
|
|
1411 *
|
|
|
1412 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1413 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1414 * @param uri The URI in the built-in Orthanc API.
|
|
|
1415 * @return 0 if success, or the error code if failure.
|
|
|
1416 * @see OrthancPluginRestApiGet
|
|
|
1417 * @ingroup Orthanc
|
|
|
1418 **/
|
|
|
1419 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins(
|
|
|
1420 OrthancPluginContext* context,
|
|
|
1421 OrthancPluginMemoryBuffer* target,
|
|
|
1422 const char* uri)
|
|
|
1423 {
|
|
|
1424 _OrthancPluginRestApiGet params;
|
|
|
1425 params.target = target;
|
|
|
1426 params.uri = uri;
|
|
|
1427 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
|
|
|
1428 }
|
|
|
1429
|
|
|
1430
|
|
|
1431
|
|
|
1432 typedef struct
|
|
|
1433 {
|
|
|
1434 OrthancPluginMemoryBuffer* target;
|
|
|
1435 const char* uri;
|
|
|
1436 const char* body;
|
|
|
1437 uint32_t bodySize;
|
|
|
1438 } _OrthancPluginRestApiPostPut;
|
|
|
1439
|
|
|
1440 /**
|
|
|
1441 * @brief Make a POST call to the built-in Orthanc REST API.
|
|
|
1442 *
|
|
|
1443 * Make a POST call to the built-in Orthanc REST API. The result to
|
|
|
1444 * the query is stored into a newly allocated memory buffer.
|
|
|
1445 *
|
|
|
1446 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1447 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1448 * @param uri The URI in the built-in Orthanc API.
|
|
|
1449 * @param body The body of the POST request.
|
|
|
1450 * @param bodySize The size of the body.
|
|
|
1451 * @return 0 if success, or the error code if failure.
|
|
|
1452 * @see OrthancPluginRestApiPostAfterPlugins
|
|
|
1453 * @ingroup Orthanc
|
|
|
1454 **/
|
|
|
1455 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost(
|
|
|
1456 OrthancPluginContext* context,
|
|
|
1457 OrthancPluginMemoryBuffer* target,
|
|
|
1458 const char* uri,
|
|
|
1459 const char* body,
|
|
|
1460 uint32_t bodySize)
|
|
|
1461 {
|
|
|
1462 _OrthancPluginRestApiPostPut params;
|
|
|
1463 params.target = target;
|
|
|
1464 params.uri = uri;
|
|
|
1465 params.body = body;
|
|
|
1466 params.bodySize = bodySize;
|
|
|
1467 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
|
|
|
1468 }
|
|
|
1469
|
|
|
1470
|
|
|
1471 /**
|
|
|
1472 * @brief Make a POST call to the REST API, as tainted by the plugins.
|
|
|
1473 *
|
|
|
1474 * Make a POST call to the Orthanc REST API, after all the plugins
|
|
|
1475 * are applied. In other words, if some plugin overrides or adds the
|
|
|
1476 * called URI to the built-in Orthanc REST API, this call will
|
|
|
1477 * return the result provided by this plugin. The result to the
|
|
|
1478 * query is stored into a newly allocated memory buffer.
|
|
|
1479 *
|
|
|
1480 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1481 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1482 * @param uri The URI in the built-in Orthanc API.
|
|
|
1483 * @param body The body of the POST request.
|
|
|
1484 * @param bodySize The size of the body.
|
|
|
1485 * @return 0 if success, or the error code if failure.
|
|
|
1486 * @see OrthancPluginRestApiPost
|
|
|
1487 * @ingroup Orthanc
|
|
|
1488 **/
|
|
|
1489 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(
|
|
|
1490 OrthancPluginContext* context,
|
|
|
1491 OrthancPluginMemoryBuffer* target,
|
|
|
1492 const char* uri,
|
|
|
1493 const char* body,
|
|
|
1494 uint32_t bodySize)
|
|
|
1495 {
|
|
|
1496 _OrthancPluginRestApiPostPut params;
|
|
|
1497 params.target = target;
|
|
|
1498 params.uri = uri;
|
|
|
1499 params.body = body;
|
|
|
1500 params.bodySize = bodySize;
|
|
|
1501 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
|
|
|
1502 }
|
|
|
1503
|
|
|
1504
|
|
|
1505
|
|
|
1506 /**
|
|
|
1507 * @brief Make a DELETE call to the built-in Orthanc REST API.
|
|
|
1508 *
|
|
|
1509 * Make a DELETE call to the built-in Orthanc REST API.
|
|
|
1510 *
|
|
|
1511 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1512 * @param uri The URI to delete in the built-in Orthanc API.
|
|
|
1513 * @return 0 if success, or the error code if failure.
|
|
|
1514 * @see OrthancPluginRestApiDeleteAfterPlugins
|
|
|
1515 * @ingroup Orthanc
|
|
|
1516 **/
|
|
|
1517 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete(
|
|
|
1518 OrthancPluginContext* context,
|
|
|
1519 const char* uri)
|
|
|
1520 {
|
|
|
1521 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
|
|
|
1522 }
|
|
|
1523
|
|
|
1524
|
|
|
1525 /**
|
|
|
1526 * @brief Make a DELETE call to the REST API, as tainted by the plugins.
|
|
|
1527 *
|
|
|
1528 * Make a DELETE call to the Orthanc REST API, after all the plugins
|
|
|
1529 * are applied. In other words, if some plugin overrides or adds the
|
|
|
1530 * called URI to the built-in Orthanc REST API, this call will
|
|
|
1531 * return the result provided by this plugin.
|
|
|
1532 *
|
|
|
1533 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1534 * @param uri The URI to delete in the built-in Orthanc API.
|
|
|
1535 * @return 0 if success, or the error code if failure.
|
|
|
1536 * @see OrthancPluginRestApiDelete
|
|
|
1537 * @ingroup Orthanc
|
|
|
1538 **/
|
|
|
1539 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(
|
|
|
1540 OrthancPluginContext* context,
|
|
|
1541 const char* uri)
|
|
|
1542 {
|
|
|
1543 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
|
|
|
1544 }
|
|
|
1545
|
|
|
1546
|
|
|
1547
|
|
|
1548 /**
|
|
|
1549 * @brief Make a PUT call to the built-in Orthanc REST API.
|
|
|
1550 *
|
|
|
1551 * Make a PUT call to the built-in Orthanc REST API. The result to
|
|
|
1552 * the query is stored into a newly allocated memory buffer.
|
|
|
1553 *
|
|
|
1554 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1555 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1556 * @param uri The URI in the built-in Orthanc API.
|
|
|
1557 * @param body The body of the PUT request.
|
|
|
1558 * @param bodySize The size of the body.
|
|
|
1559 * @return 0 if success, or the error code if failure.
|
|
|
1560 * @see OrthancPluginRestApiPutAfterPlugins
|
|
|
1561 * @ingroup Orthanc
|
|
|
1562 **/
|
|
|
1563 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut(
|
|
|
1564 OrthancPluginContext* context,
|
|
|
1565 OrthancPluginMemoryBuffer* target,
|
|
|
1566 const char* uri,
|
|
|
1567 const char* body,
|
|
|
1568 uint32_t bodySize)
|
|
|
1569 {
|
|
|
1570 _OrthancPluginRestApiPostPut params;
|
|
|
1571 params.target = target;
|
|
|
1572 params.uri = uri;
|
|
|
1573 params.body = body;
|
|
|
1574 params.bodySize = bodySize;
|
|
|
1575 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
|
|
|
1576 }
|
|
|
1577
|
|
|
1578
|
|
|
1579
|
|
|
1580 /**
|
|
|
1581 * @brief Make a PUT call to the REST API, as tainted by the plugins.
|
|
|
1582 *
|
|
|
1583 * Make a PUT call to the Orthanc REST API, after all the plugins
|
|
|
1584 * are applied. In other words, if some plugin overrides or adds the
|
|
|
1585 * called URI to the built-in Orthanc REST API, this call will
|
|
|
1586 * return the result provided by this plugin. The result to the
|
|
|
1587 * query is stored into a newly allocated memory buffer.
|
|
|
1588 *
|
|
|
1589 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
1590 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
1591 * @param uri The URI in the built-in Orthanc API.
|
|
|
1592 * @param body The body of the PUT request.
|
|
|
1593 * @param bodySize The size of the body.
|
|
|
1594 * @return 0 if success, or the error code if failure.
|
|
|
1595 * @see OrthancPluginRestApiPut
|
|
|
1596 * @ingroup Orthanc
|
|
|
1597 **/
|
|
|
1598 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(
|
|
|
1599 OrthancPluginContext* context,
|
|
|
1600 OrthancPluginMemoryBuffer* target,
|
|
|
1601 const char* uri,
|
|
|
1602 const char* body,
|
|
|
1603 uint32_t bodySize)
|
|
|
1604 {
|
|
|
1605 _OrthancPluginRestApiPostPut params;
|
|
|
1606 params.target = target;
|
|
|
1607 params.uri = uri;
|
|
|
1608 params.body = body;
|
|
|
1609 params.bodySize = bodySize;
|
|
|
1610 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
|
|
|
1611 }
|
|
|
1612
|
|
|
1613
|
|
|
1614
|
|
|
1615 typedef struct
|
|
|
1616 {
|
|
|
1617 OrthancPluginRestOutput* output;
|
|
|
1618 const char* argument;
|
|
|
1619 } _OrthancPluginOutputPlusArgument;
|
|
|
1620
|
|
|
1621 /**
|
|
|
1622 * @brief Redirect a REST request.
|
|
|
1623 *
|
|
|
1624 * This function answers to a REST request by redirecting the user
|
|
|
1625 * to another URI using HTTP status 301.
|
|
|
1626 *
|
|
|
1627 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1628 * @param output The HTTP connection to the client application.
|
|
|
1629 * @param redirection Where to redirect.
|
|
|
1630 * @ingroup REST
|
|
|
1631 **/
|
|
|
1632 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
|
|
|
1633 OrthancPluginContext* context,
|
|
|
1634 OrthancPluginRestOutput* output,
|
|
|
1635 const char* redirection)
|
|
|
1636 {
|
|
|
1637 _OrthancPluginOutputPlusArgument params;
|
|
|
1638 params.output = output;
|
|
|
1639 params.argument = redirection;
|
|
|
1640 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
|
|
|
1641 }
|
|
|
1642
|
|
|
1643
|
|
|
1644
|
|
|
1645 typedef struct
|
|
|
1646 {
|
|
|
1647 char** result;
|
|
|
1648 const char* argument;
|
|
|
1649 } _OrthancPluginRetrieveDynamicString;
|
|
|
1650
|
|
|
1651 /**
|
|
|
1652 * @brief Look for a patient.
|
|
|
1653 *
|
|
|
1654 * Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020).
|
|
|
1655 * This function uses the database index to run as fast as possible (it does not loop
|
|
|
1656 * over all the stored patients).
|
|
|
1657 *
|
|
|
1658 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1659 * @param patientID The Patient ID of interest.
|
|
|
1660 * @return The NULL value if the patient is non-existent, or a string containing the
|
|
|
1661 * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
|
|
|
1662 * @ingroup Orthanc
|
|
|
1663 **/
|
|
|
1664 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
|
|
|
1665 OrthancPluginContext* context,
|
|
|
1666 const char* patientID)
|
|
|
1667 {
|
|
|
1668 char* result;
|
|
|
1669
|
|
|
1670 _OrthancPluginRetrieveDynamicString params;
|
|
|
1671 params.result = &result;
|
|
|
1672 params.argument = patientID;
|
|
|
1673
|
|
|
1674 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1675 {
|
|
|
1676 /* Error */
|
|
|
1677 return NULL;
|
|
|
1678 }
|
|
|
1679 else
|
|
|
1680 {
|
|
|
1681 return result;
|
|
|
1682 }
|
|
|
1683 }
|
|
|
1684
|
|
|
1685
|
|
|
1686 /**
|
|
|
1687 * @brief Look for a study.
|
|
|
1688 *
|
|
|
1689 * Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d).
|
|
|
1690 * This function uses the database index to run as fast as possible (it does not loop
|
|
|
1691 * over all the stored studies).
|
|
|
1692 *
|
|
|
1693 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1694 * @param studyUID The Study Instance UID of interest.
|
|
|
1695 * @return The NULL value if the study is non-existent, or a string containing the
|
|
|
1696 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
|
|
|
1697 * @ingroup Orthanc
|
|
|
1698 **/
|
|
|
1699 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
|
|
|
1700 OrthancPluginContext* context,
|
|
|
1701 const char* studyUID)
|
|
|
1702 {
|
|
|
1703 char* result;
|
|
|
1704
|
|
|
1705 _OrthancPluginRetrieveDynamicString params;
|
|
|
1706 params.result = &result;
|
|
|
1707 params.argument = studyUID;
|
|
|
1708
|
|
|
1709 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1710 {
|
|
|
1711 /* Error */
|
|
|
1712 return NULL;
|
|
|
1713 }
|
|
|
1714 else
|
|
|
1715 {
|
|
|
1716 return result;
|
|
|
1717 }
|
|
|
1718 }
|
|
|
1719
|
|
|
1720
|
|
|
1721 /**
|
|
|
1722 * @brief Look for a study, using the accession number.
|
|
|
1723 *
|
|
|
1724 * Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050).
|
|
|
1725 * This function uses the database index to run as fast as possible (it does not loop
|
|
|
1726 * over all the stored studies).
|
|
|
1727 *
|
|
|
1728 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1729 * @param accessionNumber The Accession Number of interest.
|
|
|
1730 * @return The NULL value if the study is non-existent, or a string containing the
|
|
|
1731 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
|
|
|
1732 * @ingroup Orthanc
|
|
|
1733 **/
|
|
|
1734 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
|
|
|
1735 OrthancPluginContext* context,
|
|
|
1736 const char* accessionNumber)
|
|
|
1737 {
|
|
|
1738 char* result;
|
|
|
1739
|
|
|
1740 _OrthancPluginRetrieveDynamicString params;
|
|
|
1741 params.result = &result;
|
|
|
1742 params.argument = accessionNumber;
|
|
|
1743
|
|
|
1744 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1745 {
|
|
|
1746 /* Error */
|
|
|
1747 return NULL;
|
|
|
1748 }
|
|
|
1749 else
|
|
|
1750 {
|
|
|
1751 return result;
|
|
|
1752 }
|
|
|
1753 }
|
|
|
1754
|
|
|
1755
|
|
|
1756 /**
|
|
|
1757 * @brief Look for a series.
|
|
|
1758 *
|
|
|
1759 * Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e).
|
|
|
1760 * This function uses the database index to run as fast as possible (it does not loop
|
|
|
1761 * over all the stored series).
|
|
|
1762 *
|
|
|
1763 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1764 * @param seriesUID The Series Instance UID of interest.
|
|
|
1765 * @return The NULL value if the series is non-existent, or a string containing the
|
|
|
1766 * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
|
|
|
1767 * @ingroup Orthanc
|
|
|
1768 **/
|
|
|
1769 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
|
|
|
1770 OrthancPluginContext* context,
|
|
|
1771 const char* seriesUID)
|
|
|
1772 {
|
|
|
1773 char* result;
|
|
|
1774
|
|
|
1775 _OrthancPluginRetrieveDynamicString params;
|
|
|
1776 params.result = &result;
|
|
|
1777 params.argument = seriesUID;
|
|
|
1778
|
|
|
1779 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1780 {
|
|
|
1781 /* Error */
|
|
|
1782 return NULL;
|
|
|
1783 }
|
|
|
1784 else
|
|
|
1785 {
|
|
|
1786 return result;
|
|
|
1787 }
|
|
|
1788 }
|
|
|
1789
|
|
|
1790
|
|
|
1791 /**
|
|
|
1792 * @brief Look for an instance.
|
|
|
1793 *
|
|
|
1794 * Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018).
|
|
|
1795 * This function uses the database index to run as fast as possible (it does not loop
|
|
|
1796 * over all the stored instances).
|
|
|
1797 *
|
|
|
1798 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1799 * @param sopInstanceUID The SOP Instance UID of interest.
|
|
|
1800 * @return The NULL value if the instance is non-existent, or a string containing the
|
|
|
1801 * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
|
|
|
1802 * @ingroup Orthanc
|
|
|
1803 **/
|
|
|
1804 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
|
|
|
1805 OrthancPluginContext* context,
|
|
|
1806 const char* sopInstanceUID)
|
|
|
1807 {
|
|
|
1808 char* result;
|
|
|
1809
|
|
|
1810 _OrthancPluginRetrieveDynamicString params;
|
|
|
1811 params.result = &result;
|
|
|
1812 params.argument = sopInstanceUID;
|
|
|
1813
|
|
|
1814 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1815 {
|
|
|
1816 /* Error */
|
|
|
1817 return NULL;
|
|
|
1818 }
|
|
|
1819 else
|
|
|
1820 {
|
|
|
1821 return result;
|
|
|
1822 }
|
|
|
1823 }
|
|
|
1824
|
|
|
1825
|
|
|
1826
|
|
|
1827 typedef struct
|
|
|
1828 {
|
|
|
1829 OrthancPluginRestOutput* output;
|
|
|
1830 uint16_t status;
|
|
|
1831 } _OrthancPluginSendHttpStatusCode;
|
|
|
1832
|
|
|
1833 /**
|
|
|
1834 * @brief Send a HTTP status code.
|
|
|
1835 *
|
|
|
1836 * This function answers to a REST request by sending a HTTP status
|
|
|
1837 * code (such as "400 - Bad Request"). Note that:
|
|
|
1838 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
|
|
|
1839 * - Redirections (status 301) must use ::OrthancPluginRedirect().
|
|
|
1840 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
|
|
|
1841 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
|
|
|
1842 *
|
|
|
1843 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1844 * @param output The HTTP connection to the client application.
|
|
|
1845 * @param status The HTTP status code to be sent.
|
|
|
1846 * @ingroup REST
|
|
|
1847 * @see OrthancPluginSendHttpStatus()
|
|
|
1848 **/
|
|
|
1849 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
|
|
|
1850 OrthancPluginContext* context,
|
|
|
1851 OrthancPluginRestOutput* output,
|
|
|
1852 uint16_t status)
|
|
|
1853 {
|
|
|
1854 _OrthancPluginSendHttpStatusCode params;
|
|
|
1855 params.output = output;
|
|
|
1856 params.status = status;
|
|
|
1857 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
|
|
|
1858 }
|
|
|
1859
|
|
|
1860
|
|
|
1861 /**
|
|
|
1862 * @brief Signal that a REST request is not authorized.
|
|
|
1863 *
|
|
|
1864 * This function answers to a REST request by signaling that it is
|
|
|
1865 * not authorized.
|
|
|
1866 *
|
|
|
1867 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1868 * @param output The HTTP connection to the client application.
|
|
|
1869 * @param realm The realm for the authorization process.
|
|
|
1870 * @ingroup REST
|
|
|
1871 **/
|
|
|
1872 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
|
|
|
1873 OrthancPluginContext* context,
|
|
|
1874 OrthancPluginRestOutput* output,
|
|
|
1875 const char* realm)
|
|
|
1876 {
|
|
|
1877 _OrthancPluginOutputPlusArgument params;
|
|
|
1878 params.output = output;
|
|
|
1879 params.argument = realm;
|
|
|
1880 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
|
|
|
1881 }
|
|
|
1882
|
|
|
1883
|
|
|
1884 /**
|
|
|
1885 * @brief Signal that this URI does not support this HTTP method.
|
|
|
1886 *
|
|
|
1887 * This function answers to a REST request by signaling that the
|
|
|
1888 * queried URI does not support this method.
|
|
|
1889 *
|
|
|
1890 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1891 * @param output The HTTP connection to the client application.
|
|
|
1892 * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
|
|
|
1893 * @ingroup REST
|
|
|
1894 **/
|
|
|
1895 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
|
|
|
1896 OrthancPluginContext* context,
|
|
|
1897 OrthancPluginRestOutput* output,
|
|
|
1898 const char* allowedMethods)
|
|
|
1899 {
|
|
|
1900 _OrthancPluginOutputPlusArgument params;
|
|
|
1901 params.output = output;
|
|
|
1902 params.argument = allowedMethods;
|
|
|
1903 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
|
|
|
1904 }
|
|
|
1905
|
|
|
1906
|
|
|
1907 typedef struct
|
|
|
1908 {
|
|
|
1909 OrthancPluginRestOutput* output;
|
|
|
1910 const char* key;
|
|
|
1911 const char* value;
|
|
|
1912 } _OrthancPluginSetHttpHeader;
|
|
|
1913
|
|
|
1914 /**
|
|
|
1915 * @brief Set a cookie.
|
|
|
1916 *
|
|
|
1917 * This function sets a cookie in the HTTP client.
|
|
|
1918 *
|
|
|
1919 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1920 * @param output The HTTP connection to the client application.
|
|
|
1921 * @param cookie The cookie to be set.
|
|
|
1922 * @param value The value of the cookie.
|
|
|
1923 * @ingroup REST
|
|
|
1924 **/
|
|
|
1925 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
|
|
|
1926 OrthancPluginContext* context,
|
|
|
1927 OrthancPluginRestOutput* output,
|
|
|
1928 const char* cookie,
|
|
|
1929 const char* value)
|
|
|
1930 {
|
|
|
1931 _OrthancPluginSetHttpHeader params;
|
|
|
1932 params.output = output;
|
|
|
1933 params.key = cookie;
|
|
|
1934 params.value = value;
|
|
|
1935 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
|
|
|
1936 }
|
|
|
1937
|
|
|
1938
|
|
|
1939 /**
|
|
|
1940 * @brief Set some HTTP header.
|
|
|
1941 *
|
|
|
1942 * This function sets a HTTP header in the HTTP answer.
|
|
|
1943 *
|
|
|
1944 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1945 * @param output The HTTP connection to the client application.
|
|
|
1946 * @param key The HTTP header to be set.
|
|
|
1947 * @param value The value of the HTTP header.
|
|
|
1948 * @ingroup REST
|
|
|
1949 **/
|
|
|
1950 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
|
|
|
1951 OrthancPluginContext* context,
|
|
|
1952 OrthancPluginRestOutput* output,
|
|
|
1953 const char* key,
|
|
|
1954 const char* value)
|
|
|
1955 {
|
|
|
1956 _OrthancPluginSetHttpHeader params;
|
|
|
1957 params.output = output;
|
|
|
1958 params.key = key;
|
|
|
1959 params.value = value;
|
|
|
1960 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
|
|
|
1961 }
|
|
|
1962
|
|
|
1963
|
|
|
1964 typedef struct
|
|
|
1965 {
|
|
101
|
1966 char** resultStringToFree;
|
|
|
1967 const char** resultString;
|
|
|
1968 int64_t* resultInt64;
|
|
|
1969 const char* key;
|
|
|
1970 OrthancPluginDicomInstance* instance;
|
|
|
1971 OrthancPluginInstanceOrigin* resultOrigin; /* New in Orthanc 0.9.5 SDK */
|
|
78
|
1972 } _OrthancPluginAccessDicomInstance;
|
|
|
1973
|
|
|
1974
|
|
|
1975 /**
|
|
|
1976 * @brief Get the AET of a DICOM instance.
|
|
|
1977 *
|
|
|
1978 * This function returns the Application Entity Title (AET) of the
|
|
|
1979 * DICOM modality from which a DICOM instance originates.
|
|
|
1980 *
|
|
|
1981 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
1982 * @param instance The instance of interest.
|
|
|
1983 * @return The AET if success, NULL if error.
|
|
|
1984 * @ingroup Callbacks
|
|
|
1985 **/
|
|
|
1986 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
|
|
|
1987 OrthancPluginContext* context,
|
|
|
1988 OrthancPluginDicomInstance* instance)
|
|
|
1989 {
|
|
|
1990 const char* result;
|
|
|
1991
|
|
|
1992 _OrthancPluginAccessDicomInstance params;
|
|
|
1993 memset(¶ms, 0, sizeof(params));
|
|
|
1994 params.resultString = &result;
|
|
|
1995 params.instance = instance;
|
|
|
1996
|
|
|
1997 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
1998 {
|
|
|
1999 /* Error */
|
|
|
2000 return NULL;
|
|
|
2001 }
|
|
|
2002 else
|
|
|
2003 {
|
|
|
2004 return result;
|
|
|
2005 }
|
|
|
2006 }
|
|
|
2007
|
|
|
2008
|
|
|
2009 /**
|
|
|
2010 * @brief Get the size of a DICOM file.
|
|
|
2011 *
|
|
|
2012 * This function returns the number of bytes of the given DICOM instance.
|
|
|
2013 *
|
|
|
2014 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2015 * @param instance The instance of interest.
|
|
|
2016 * @return The size of the file, -1 in case of error.
|
|
|
2017 * @ingroup Callbacks
|
|
|
2018 **/
|
|
|
2019 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
|
|
|
2020 OrthancPluginContext* context,
|
|
|
2021 OrthancPluginDicomInstance* instance)
|
|
|
2022 {
|
|
|
2023 int64_t size;
|
|
|
2024
|
|
|
2025 _OrthancPluginAccessDicomInstance params;
|
|
|
2026 memset(¶ms, 0, sizeof(params));
|
|
|
2027 params.resultInt64 = &size;
|
|
|
2028 params.instance = instance;
|
|
|
2029
|
|
|
2030 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2031 {
|
|
|
2032 /* Error */
|
|
|
2033 return -1;
|
|
|
2034 }
|
|
|
2035 else
|
|
|
2036 {
|
|
|
2037 return size;
|
|
|
2038 }
|
|
|
2039 }
|
|
|
2040
|
|
|
2041
|
|
|
2042 /**
|
|
|
2043 * @brief Get the data of a DICOM file.
|
|
|
2044 *
|
|
|
2045 * This function returns a pointer to the content of the given DICOM instance.
|
|
|
2046 *
|
|
|
2047 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2048 * @param instance The instance of interest.
|
|
|
2049 * @return The pointer to the DICOM data, NULL in case of error.
|
|
|
2050 * @ingroup Callbacks
|
|
|
2051 **/
|
|
|
2052 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
|
|
|
2053 OrthancPluginContext* context,
|
|
|
2054 OrthancPluginDicomInstance* instance)
|
|
|
2055 {
|
|
|
2056 const char* result;
|
|
|
2057
|
|
|
2058 _OrthancPluginAccessDicomInstance params;
|
|
|
2059 memset(¶ms, 0, sizeof(params));
|
|
|
2060 params.resultString = &result;
|
|
|
2061 params.instance = instance;
|
|
|
2062
|
|
|
2063 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2064 {
|
|
|
2065 /* Error */
|
|
|
2066 return NULL;
|
|
|
2067 }
|
|
|
2068 else
|
|
|
2069 {
|
|
|
2070 return result;
|
|
|
2071 }
|
|
|
2072 }
|
|
|
2073
|
|
|
2074
|
|
|
2075 /**
|
|
|
2076 * @brief Get the DICOM tag hierarchy as a JSON file.
|
|
|
2077 *
|
|
|
2078 * This function returns a pointer to a newly created string
|
|
|
2079 * containing a JSON file. This JSON file encodes the tag hierarchy
|
|
|
2080 * of the given DICOM instance.
|
|
|
2081 *
|
|
|
2082 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2083 * @param instance The instance of interest.
|
|
|
2084 * @return The NULL value in case of error, or a string containing the JSON file.
|
|
|
2085 * This string must be freed by OrthancPluginFreeString().
|
|
|
2086 * @ingroup Callbacks
|
|
|
2087 **/
|
|
|
2088 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
|
|
|
2089 OrthancPluginContext* context,
|
|
|
2090 OrthancPluginDicomInstance* instance)
|
|
|
2091 {
|
|
|
2092 char* result;
|
|
|
2093
|
|
|
2094 _OrthancPluginAccessDicomInstance params;
|
|
|
2095 memset(¶ms, 0, sizeof(params));
|
|
|
2096 params.resultStringToFree = &result;
|
|
|
2097 params.instance = instance;
|
|
|
2098
|
|
|
2099 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2100 {
|
|
|
2101 /* Error */
|
|
|
2102 return NULL;
|
|
|
2103 }
|
|
|
2104 else
|
|
|
2105 {
|
|
|
2106 return result;
|
|
|
2107 }
|
|
|
2108 }
|
|
|
2109
|
|
|
2110
|
|
|
2111 /**
|
|
|
2112 * @brief Get the DICOM tag hierarchy as a JSON file (with simplification).
|
|
|
2113 *
|
|
|
2114 * This function returns a pointer to a newly created string
|
|
|
2115 * containing a JSON file. This JSON file encodes the tag hierarchy
|
|
|
2116 * of the given DICOM instance. In contrast with
|
|
|
2117 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in
|
|
|
2118 * its simplified version.
|
|
|
2119 *
|
|
|
2120 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2121 * @param instance The instance of interest.
|
|
|
2122 * @return The NULL value in case of error, or a string containing the JSON file.
|
|
|
2123 * This string must be freed by OrthancPluginFreeString().
|
|
|
2124 * @ingroup Callbacks
|
|
|
2125 **/
|
|
|
2126 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
|
|
|
2127 OrthancPluginContext* context,
|
|
|
2128 OrthancPluginDicomInstance* instance)
|
|
|
2129 {
|
|
|
2130 char* result;
|
|
|
2131
|
|
|
2132 _OrthancPluginAccessDicomInstance params;
|
|
|
2133 memset(¶ms, 0, sizeof(params));
|
|
|
2134 params.resultStringToFree = &result;
|
|
|
2135 params.instance = instance;
|
|
|
2136
|
|
|
2137 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2138 {
|
|
|
2139 /* Error */
|
|
|
2140 return NULL;
|
|
|
2141 }
|
|
|
2142 else
|
|
|
2143 {
|
|
|
2144 return result;
|
|
|
2145 }
|
|
|
2146 }
|
|
|
2147
|
|
|
2148
|
|
|
2149 /**
|
|
|
2150 * @brief Check whether a DICOM instance is associated with some metadata.
|
|
|
2151 *
|
|
|
2152 * This function checks whether the DICOM instance of interest is
|
|
|
2153 * associated with some metadata. As of Orthanc 0.8.1, in the
|
|
|
2154 * callbacks registered by
|
|
|
2155 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only
|
|
|
2156 * possibly available metadata are "ReceptionDate", "RemoteAET" and
|
|
|
2157 * "IndexInSeries".
|
|
|
2158 *
|
|
|
2159 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2160 * @param instance The instance of interest.
|
|
|
2161 * @param metadata The metadata of interest.
|
|
|
2162 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
|
|
|
2163 * @ingroup Callbacks
|
|
|
2164 **/
|
|
|
2165 ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
|
|
|
2166 OrthancPluginContext* context,
|
|
|
2167 OrthancPluginDicomInstance* instance,
|
|
|
2168 const char* metadata)
|
|
|
2169 {
|
|
|
2170 int64_t result;
|
|
|
2171
|
|
|
2172 _OrthancPluginAccessDicomInstance params;
|
|
|
2173 memset(¶ms, 0, sizeof(params));
|
|
|
2174 params.resultInt64 = &result;
|
|
|
2175 params.instance = instance;
|
|
|
2176 params.key = metadata;
|
|
|
2177
|
|
|
2178 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2179 {
|
|
|
2180 /* Error */
|
|
|
2181 return -1;
|
|
|
2182 }
|
|
|
2183 else
|
|
|
2184 {
|
|
|
2185 return (result != 0);
|
|
|
2186 }
|
|
|
2187 }
|
|
|
2188
|
|
|
2189
|
|
|
2190 /**
|
|
|
2191 * @brief Get the value of some metadata associated with a given DICOM instance.
|
|
|
2192 *
|
|
|
2193 * This functions returns the value of some metadata that is associated with the DICOM instance of interest.
|
|
|
2194 * Before calling this function, the existence of the metadata must have been checked with
|
|
|
2195 * ::OrthancPluginHasInstanceMetadata().
|
|
|
2196 *
|
|
|
2197 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2198 * @param instance The instance of interest.
|
|
|
2199 * @param metadata The metadata of interest.
|
|
|
2200 * @return The metadata value if success, NULL if error.
|
|
|
2201 * @ingroup Callbacks
|
|
|
2202 **/
|
|
|
2203 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
|
|
|
2204 OrthancPluginContext* context,
|
|
|
2205 OrthancPluginDicomInstance* instance,
|
|
|
2206 const char* metadata)
|
|
|
2207 {
|
|
|
2208 const char* result;
|
|
|
2209
|
|
|
2210 _OrthancPluginAccessDicomInstance params;
|
|
|
2211 memset(¶ms, 0, sizeof(params));
|
|
|
2212 params.resultString = &result;
|
|
|
2213 params.instance = instance;
|
|
|
2214 params.key = metadata;
|
|
|
2215
|
|
|
2216 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2217 {
|
|
|
2218 /* Error */
|
|
|
2219 return NULL;
|
|
|
2220 }
|
|
|
2221 else
|
|
|
2222 {
|
|
|
2223 return result;
|
|
|
2224 }
|
|
|
2225 }
|
|
|
2226
|
|
|
2227
|
|
|
2228
|
|
|
2229 typedef struct
|
|
|
2230 {
|
|
|
2231 OrthancPluginStorageCreate create;
|
|
|
2232 OrthancPluginStorageRead read;
|
|
|
2233 OrthancPluginStorageRemove remove;
|
|
|
2234 OrthancPluginFree free;
|
|
|
2235 } _OrthancPluginRegisterStorageArea;
|
|
|
2236
|
|
|
2237 /**
|
|
|
2238 * @brief Register a custom storage area.
|
|
|
2239 *
|
|
|
2240 * This function registers a custom storage area, to replace the
|
|
|
2241 * built-in way Orthanc stores its files on the filesystem. This
|
|
|
2242 * function must be called during the initialization of the plugin,
|
|
|
2243 * i.e. inside the OrthancPluginInitialize() public function.
|
|
|
2244 *
|
|
|
2245 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2246 * @param create The callback function to store a file on the custom storage area.
|
|
|
2247 * @param read The callback function to read a file from the custom storage area.
|
|
|
2248 * @param remove The callback function to remove a file from the custom storage area.
|
|
|
2249 * @ingroup Callbacks
|
|
|
2250 **/
|
|
|
2251 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea(
|
|
|
2252 OrthancPluginContext* context,
|
|
|
2253 OrthancPluginStorageCreate create,
|
|
|
2254 OrthancPluginStorageRead read,
|
|
|
2255 OrthancPluginStorageRemove remove)
|
|
|
2256 {
|
|
|
2257 _OrthancPluginRegisterStorageArea params;
|
|
|
2258 params.create = create;
|
|
|
2259 params.read = read;
|
|
|
2260 params.remove = remove;
|
|
|
2261
|
|
|
2262 #ifdef __cplusplus
|
|
|
2263 params.free = ::free;
|
|
|
2264 #else
|
|
|
2265 params.free = free;
|
|
|
2266 #endif
|
|
|
2267
|
|
|
2268 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
|
|
|
2269 }
|
|
|
2270
|
|
|
2271
|
|
|
2272
|
|
|
2273 /**
|
|
|
2274 * @brief Return the path to the Orthanc executable.
|
|
|
2275 *
|
|
|
2276 * This function returns the path to the Orthanc executable.
|
|
|
2277 *
|
|
|
2278 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2279 * @return NULL in the case of an error, or a newly allocated string
|
|
|
2280 * containing the path. This string must be freed by
|
|
|
2281 * OrthancPluginFreeString().
|
|
|
2282 **/
|
|
|
2283 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancPath(OrthancPluginContext* context)
|
|
|
2284 {
|
|
|
2285 char* result;
|
|
|
2286
|
|
|
2287 _OrthancPluginRetrieveDynamicString params;
|
|
|
2288 params.result = &result;
|
|
|
2289 params.argument = NULL;
|
|
|
2290
|
|
|
2291 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2292 {
|
|
|
2293 /* Error */
|
|
|
2294 return NULL;
|
|
|
2295 }
|
|
|
2296 else
|
|
|
2297 {
|
|
|
2298 return result;
|
|
|
2299 }
|
|
|
2300 }
|
|
|
2301
|
|
|
2302
|
|
|
2303 /**
|
|
|
2304 * @brief Return the directory containing the Orthanc.
|
|
|
2305 *
|
|
|
2306 * This function returns the path to the directory containing the Orthanc executable.
|
|
|
2307 *
|
|
|
2308 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2309 * @return NULL in the case of an error, or a newly allocated string
|
|
|
2310 * containing the path. This string must be freed by
|
|
|
2311 * OrthancPluginFreeString().
|
|
|
2312 **/
|
|
|
2313 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancDirectory(OrthancPluginContext* context)
|
|
|
2314 {
|
|
|
2315 char* result;
|
|
|
2316
|
|
|
2317 _OrthancPluginRetrieveDynamicString params;
|
|
|
2318 params.result = &result;
|
|
|
2319 params.argument = NULL;
|
|
|
2320
|
|
|
2321 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2322 {
|
|
|
2323 /* Error */
|
|
|
2324 return NULL;
|
|
|
2325 }
|
|
|
2326 else
|
|
|
2327 {
|
|
|
2328 return result;
|
|
|
2329 }
|
|
|
2330 }
|
|
|
2331
|
|
|
2332
|
|
|
2333 /**
|
|
|
2334 * @brief Return the path to the configuration file(s).
|
|
|
2335 *
|
|
|
2336 * This function returns the path to the configuration file(s) that
|
|
|
2337 * was specified when starting Orthanc. Since version 0.9.1, this
|
|
|
2338 * path can refer to a folder that stores a set of configuration
|
|
|
2339 * files. This function is deprecated in favor of
|
|
|
2340 * OrthancPluginGetConfiguration().
|
|
|
2341 *
|
|
|
2342 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2343 * @return NULL in the case of an error, or a newly allocated string
|
|
|
2344 * containing the path. This string must be freed by
|
|
|
2345 * OrthancPluginFreeString().
|
|
|
2346 * @see OrthancPluginGetConfiguration()
|
|
|
2347 **/
|
|
|
2348 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfigurationPath(OrthancPluginContext* context)
|
|
|
2349 {
|
|
|
2350 char* result;
|
|
|
2351
|
|
|
2352 _OrthancPluginRetrieveDynamicString params;
|
|
|
2353 params.result = &result;
|
|
|
2354 params.argument = NULL;
|
|
|
2355
|
|
|
2356 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2357 {
|
|
|
2358 /* Error */
|
|
|
2359 return NULL;
|
|
|
2360 }
|
|
|
2361 else
|
|
|
2362 {
|
|
|
2363 return result;
|
|
|
2364 }
|
|
|
2365 }
|
|
|
2366
|
|
|
2367
|
|
|
2368
|
|
|
2369 typedef struct
|
|
|
2370 {
|
|
|
2371 OrthancPluginOnChangeCallback callback;
|
|
|
2372 } _OrthancPluginOnChangeCallback;
|
|
|
2373
|
|
|
2374 /**
|
|
|
2375 * @brief Register a callback to monitor changes.
|
|
|
2376 *
|
|
|
2377 * This function registers a callback function that is called
|
|
|
2378 * whenever a change happens to some DICOM resource.
|
|
101
|
2379 *
|
|
|
2380 * @warning If your change callback has to call the REST API of
|
|
|
2381 * Orthanc, you should make these calls in a separate thread (with
|
|
|
2382 * the events passing through a message queue). Otherwise, this
|
|
|
2383 * could result in deadlocks in the presence of other plugins or Lua
|
|
|
2384 * script.
|
|
78
|
2385 *
|
|
|
2386 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2387 * @param callback The callback function.
|
|
|
2388 * @ingroup Callbacks
|
|
|
2389 **/
|
|
|
2390 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
|
|
|
2391 OrthancPluginContext* context,
|
|
|
2392 OrthancPluginOnChangeCallback callback)
|
|
|
2393 {
|
|
|
2394 _OrthancPluginOnChangeCallback params;
|
|
|
2395 params.callback = callback;
|
|
|
2396
|
|
|
2397 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
|
|
|
2398 }
|
|
|
2399
|
|
|
2400
|
|
|
2401
|
|
|
2402 typedef struct
|
|
|
2403 {
|
|
|
2404 const char* plugin;
|
|
|
2405 _OrthancPluginProperty property;
|
|
|
2406 const char* value;
|
|
|
2407 } _OrthancPluginSetPluginProperty;
|
|
|
2408
|
|
|
2409
|
|
|
2410 /**
|
|
|
2411 * @brief Set the URI where the plugin provides its Web interface.
|
|
|
2412 *
|
|
|
2413 * For plugins that come with a Web interface, this function
|
|
|
2414 * declares the entry path where to find this interface. This
|
|
|
2415 * information is notably used in the "Plugins" page of Orthanc
|
|
|
2416 * Explorer.
|
|
|
2417 *
|
|
|
2418 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2419 * @param uri The root URI for this plugin.
|
|
|
2420 **/
|
|
|
2421 ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri(
|
|
|
2422 OrthancPluginContext* context,
|
|
|
2423 const char* uri)
|
|
|
2424 {
|
|
|
2425 _OrthancPluginSetPluginProperty params;
|
|
|
2426 params.plugin = OrthancPluginGetName();
|
|
|
2427 params.property = _OrthancPluginProperty_RootUri;
|
|
|
2428 params.value = uri;
|
|
|
2429
|
|
|
2430 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
|
|
|
2431 }
|
|
|
2432
|
|
|
2433
|
|
|
2434 /**
|
|
|
2435 * @brief Set a description for this plugin.
|
|
|
2436 *
|
|
|
2437 * Set a description for this plugin. It is displayed in the
|
|
|
2438 * "Plugins" page of Orthanc Explorer.
|
|
|
2439 *
|
|
|
2440 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2441 * @param description The description.
|
|
|
2442 **/
|
|
|
2443 ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription(
|
|
|
2444 OrthancPluginContext* context,
|
|
|
2445 const char* description)
|
|
|
2446 {
|
|
|
2447 _OrthancPluginSetPluginProperty params;
|
|
|
2448 params.plugin = OrthancPluginGetName();
|
|
|
2449 params.property = _OrthancPluginProperty_Description;
|
|
|
2450 params.value = description;
|
|
|
2451
|
|
|
2452 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
|
|
|
2453 }
|
|
|
2454
|
|
|
2455
|
|
|
2456 /**
|
|
|
2457 * @brief Extend the JavaScript code of Orthanc Explorer.
|
|
|
2458 *
|
|
|
2459 * Add JavaScript code to customize the default behavior of Orthanc
|
|
|
2460 * Explorer. This can for instance be used to add new buttons.
|
|
|
2461 *
|
|
|
2462 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2463 * @param javascript The custom JavaScript code.
|
|
|
2464 **/
|
|
|
2465 ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer(
|
|
|
2466 OrthancPluginContext* context,
|
|
|
2467 const char* javascript)
|
|
|
2468 {
|
|
|
2469 _OrthancPluginSetPluginProperty params;
|
|
|
2470 params.plugin = OrthancPluginGetName();
|
|
|
2471 params.property = _OrthancPluginProperty_OrthancExplorer;
|
|
|
2472 params.value = javascript;
|
|
|
2473
|
|
|
2474 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
|
|
|
2475 }
|
|
|
2476
|
|
|
2477
|
|
|
2478 typedef struct
|
|
|
2479 {
|
|
|
2480 char** result;
|
|
|
2481 int32_t property;
|
|
|
2482 const char* value;
|
|
|
2483 } _OrthancPluginGlobalProperty;
|
|
|
2484
|
|
|
2485
|
|
|
2486 /**
|
|
|
2487 * @brief Get the value of a global property.
|
|
|
2488 *
|
|
|
2489 * Get the value of a global property that is stored in the Orthanc database. Global
|
|
|
2490 * properties whose index is below 1024 are reserved by Orthanc.
|
|
|
2491 *
|
|
|
2492 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2493 * @param property The global property of interest.
|
|
|
2494 * @param defaultValue The value to return, if the global property is unset.
|
|
|
2495 * @return The value of the global property, or NULL in the case of an error. This
|
|
|
2496 * string must be freed by OrthancPluginFreeString().
|
|
|
2497 * @ingroup Orthanc
|
|
|
2498 **/
|
|
|
2499 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetGlobalProperty(
|
|
|
2500 OrthancPluginContext* context,
|
|
|
2501 int32_t property,
|
|
|
2502 const char* defaultValue)
|
|
|
2503 {
|
|
|
2504 char* result;
|
|
|
2505
|
|
|
2506 _OrthancPluginGlobalProperty params;
|
|
|
2507 params.result = &result;
|
|
|
2508 params.property = property;
|
|
|
2509 params.value = defaultValue;
|
|
|
2510
|
|
|
2511 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2512 {
|
|
|
2513 /* Error */
|
|
|
2514 return NULL;
|
|
|
2515 }
|
|
|
2516 else
|
|
|
2517 {
|
|
|
2518 return result;
|
|
|
2519 }
|
|
|
2520 }
|
|
|
2521
|
|
|
2522
|
|
|
2523 /**
|
|
|
2524 * @brief Set the value of a global property.
|
|
|
2525 *
|
|
|
2526 * Set the value of a global property into the Orthanc
|
|
|
2527 * database. Setting a global property can be used by plugins to
|
|
|
2528 * save their internal parameters. Plugins are only allowed to set
|
|
|
2529 * properties whose index are above or equal to 1024 (properties
|
|
|
2530 * below 1024 are read-only and reserved by Orthanc).
|
|
|
2531 *
|
|
|
2532 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2533 * @param property The global property of interest.
|
|
|
2534 * @param value The value to be set in the global property.
|
|
|
2535 * @return 0 if success, or the error code if failure.
|
|
|
2536 * @ingroup Orthanc
|
|
|
2537 **/
|
|
|
2538 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetGlobalProperty(
|
|
|
2539 OrthancPluginContext* context,
|
|
|
2540 int32_t property,
|
|
|
2541 const char* value)
|
|
|
2542 {
|
|
|
2543 _OrthancPluginGlobalProperty params;
|
|
|
2544 params.result = NULL;
|
|
|
2545 params.property = property;
|
|
|
2546 params.value = value;
|
|
|
2547
|
|
|
2548 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
|
|
|
2549 }
|
|
|
2550
|
|
|
2551
|
|
|
2552
|
|
|
2553 typedef struct
|
|
|
2554 {
|
|
|
2555 int32_t *resultInt32;
|
|
|
2556 uint32_t *resultUint32;
|
|
|
2557 int64_t *resultInt64;
|
|
|
2558 uint64_t *resultUint64;
|
|
|
2559 } _OrthancPluginReturnSingleValue;
|
|
|
2560
|
|
|
2561 /**
|
|
|
2562 * @brief Get the number of command-line arguments.
|
|
|
2563 *
|
|
|
2564 * Retrieve the number of command-line arguments that were used to launch Orthanc.
|
|
|
2565 *
|
|
|
2566 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2567 * @return The number of arguments.
|
|
|
2568 **/
|
|
|
2569 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetCommandLineArgumentsCount(
|
|
|
2570 OrthancPluginContext* context)
|
|
|
2571 {
|
|
|
2572 uint32_t count = 0;
|
|
|
2573
|
|
|
2574 _OrthancPluginReturnSingleValue params;
|
|
|
2575 memset(¶ms, 0, sizeof(params));
|
|
|
2576 params.resultUint32 = &count;
|
|
|
2577
|
|
|
2578 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2579 {
|
|
|
2580 /* Error */
|
|
|
2581 return 0;
|
|
|
2582 }
|
|
|
2583 else
|
|
|
2584 {
|
|
|
2585 return count;
|
|
|
2586 }
|
|
|
2587 }
|
|
|
2588
|
|
|
2589
|
|
|
2590
|
|
|
2591 /**
|
|
|
2592 * @brief Get the value of a command-line argument.
|
|
|
2593 *
|
|
|
2594 * Get the value of one of the command-line arguments that were used
|
|
|
2595 * to launch Orthanc. The number of available arguments can be
|
|
|
2596 * retrieved by OrthancPluginGetCommandLineArgumentsCount().
|
|
|
2597 *
|
|
|
2598 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2599 * @param argument The index of the argument.
|
|
|
2600 * @return The value of the argument, or NULL in the case of an error. This
|
|
|
2601 * string must be freed by OrthancPluginFreeString().
|
|
|
2602 **/
|
|
|
2603 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetCommandLineArgument(
|
|
|
2604 OrthancPluginContext* context,
|
|
|
2605 uint32_t argument)
|
|
|
2606 {
|
|
|
2607 char* result;
|
|
|
2608
|
|
|
2609 _OrthancPluginGlobalProperty params;
|
|
|
2610 params.result = &result;
|
|
|
2611 params.property = (int32_t) argument;
|
|
|
2612 params.value = NULL;
|
|
|
2613
|
|
|
2614 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2615 {
|
|
|
2616 /* Error */
|
|
|
2617 return NULL;
|
|
|
2618 }
|
|
|
2619 else
|
|
|
2620 {
|
|
|
2621 return result;
|
|
|
2622 }
|
|
|
2623 }
|
|
|
2624
|
|
|
2625
|
|
|
2626 /**
|
|
|
2627 * @brief Get the expected version of the database schema.
|
|
|
2628 *
|
|
|
2629 * Retrieve the expected version of the database schema.
|
|
|
2630 *
|
|
|
2631 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2632 * @return The version.
|
|
|
2633 * @ingroup Callbacks
|
|
|
2634 * @deprecated Please instead use IDatabaseBackend::UpgradeDatabase()
|
|
|
2635 **/
|
|
|
2636 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
|
|
|
2637 OrthancPluginContext* context)
|
|
|
2638 {
|
|
|
2639 uint32_t count = 0;
|
|
|
2640
|
|
|
2641 _OrthancPluginReturnSingleValue params;
|
|
|
2642 memset(¶ms, 0, sizeof(params));
|
|
|
2643 params.resultUint32 = &count;
|
|
|
2644
|
|
|
2645 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2646 {
|
|
|
2647 /* Error */
|
|
|
2648 return 0;
|
|
|
2649 }
|
|
|
2650 else
|
|
|
2651 {
|
|
|
2652 return count;
|
|
|
2653 }
|
|
|
2654 }
|
|
|
2655
|
|
|
2656
|
|
|
2657
|
|
|
2658 /**
|
|
|
2659 * @brief Return the content of the configuration file(s).
|
|
|
2660 *
|
|
|
2661 * This function returns the content of the configuration that is
|
|
|
2662 * used by Orthanc, formatted as a JSON string.
|
|
|
2663 *
|
|
|
2664 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2665 * @return NULL in the case of an error, or a newly allocated string
|
|
|
2666 * containing the configuration. This string must be freed by
|
|
|
2667 * OrthancPluginFreeString().
|
|
|
2668 **/
|
|
|
2669 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfiguration(OrthancPluginContext* context)
|
|
|
2670 {
|
|
|
2671 char* result;
|
|
|
2672
|
|
|
2673 _OrthancPluginRetrieveDynamicString params;
|
|
|
2674 params.result = &result;
|
|
|
2675 params.argument = NULL;
|
|
|
2676
|
|
|
2677 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2678 {
|
|
|
2679 /* Error */
|
|
|
2680 return NULL;
|
|
|
2681 }
|
|
|
2682 else
|
|
|
2683 {
|
|
|
2684 return result;
|
|
|
2685 }
|
|
|
2686 }
|
|
|
2687
|
|
|
2688
|
|
|
2689
|
|
|
2690 typedef struct
|
|
|
2691 {
|
|
|
2692 OrthancPluginRestOutput* output;
|
|
|
2693 const char* subType;
|
|
|
2694 const char* contentType;
|
|
|
2695 } _OrthancPluginStartMultipartAnswer;
|
|
|
2696
|
|
|
2697 /**
|
|
|
2698 * @brief Start an HTTP multipart answer.
|
|
|
2699 *
|
|
|
2700 * Initiates a HTTP multipart answer, as the result of a REST request.
|
|
|
2701 *
|
|
|
2702 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2703 * @param output The HTTP connection to the client application.
|
|
|
2704 * @param subType The sub-type of the multipart answer ("mixed" or "related").
|
|
|
2705 * @param contentType The MIME type of the items in the multipart answer.
|
|
|
2706 * @return 0 if success, or the error code if failure.
|
|
|
2707 * @see OrthancPluginSendMultipartItem()
|
|
|
2708 * @ingroup REST
|
|
|
2709 **/
|
|
|
2710 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
|
|
|
2711 OrthancPluginContext* context,
|
|
|
2712 OrthancPluginRestOutput* output,
|
|
|
2713 const char* subType,
|
|
|
2714 const char* contentType)
|
|
|
2715 {
|
|
|
2716 _OrthancPluginStartMultipartAnswer params;
|
|
|
2717 params.output = output;
|
|
|
2718 params.subType = subType;
|
|
|
2719 params.contentType = contentType;
|
|
|
2720 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
|
|
|
2721 }
|
|
|
2722
|
|
|
2723
|
|
|
2724 /**
|
|
|
2725 * @brief Send an item as a part of some HTTP multipart answer.
|
|
|
2726 *
|
|
|
2727 * This function sends an item as a part of some HTTP multipart
|
|
|
2728 * answer that was initiated by OrthancPluginStartMultipartAnswer().
|
|
|
2729 *
|
|
|
2730 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2731 * @param output The HTTP connection to the client application.
|
|
|
2732 * @param answer Pointer to the memory buffer containing the item.
|
|
|
2733 * @param answerSize Number of bytes of the item.
|
|
|
2734 * @return 0 if success, or the error code if failure (this notably happens
|
|
|
2735 * if the connection is closed by the client).
|
|
|
2736 * @ingroup REST
|
|
|
2737 **/
|
|
|
2738 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
|
|
|
2739 OrthancPluginContext* context,
|
|
|
2740 OrthancPluginRestOutput* output,
|
|
|
2741 const char* answer,
|
|
|
2742 uint32_t answerSize)
|
|
|
2743 {
|
|
|
2744 _OrthancPluginAnswerBuffer params;
|
|
|
2745 params.output = output;
|
|
|
2746 params.answer = answer;
|
|
|
2747 params.answerSize = answerSize;
|
|
|
2748 params.mimeType = NULL;
|
|
|
2749 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
|
|
|
2750 }
|
|
|
2751
|
|
|
2752
|
|
|
2753
|
|
|
2754 typedef struct
|
|
|
2755 {
|
|
|
2756 OrthancPluginMemoryBuffer* target;
|
|
|
2757 const void* source;
|
|
|
2758 uint32_t size;
|
|
|
2759 OrthancPluginCompressionType compression;
|
|
|
2760 uint8_t uncompress;
|
|
|
2761 } _OrthancPluginBufferCompression;
|
|
|
2762
|
|
|
2763
|
|
|
2764 /**
|
|
|
2765 * @brief Compress or decompress a buffer.
|
|
|
2766 *
|
|
|
2767 * This function compresses or decompresses a buffer, using the
|
|
|
2768 * version of the zlib library that is used by the Orthanc core.
|
|
|
2769 *
|
|
|
2770 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
2771 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
2772 * @param source The source buffer.
|
|
|
2773 * @param size The size in bytes of the source buffer.
|
|
|
2774 * @param compression The compression algorithm.
|
|
|
2775 * @param uncompress If set to "0", the buffer must be compressed.
|
|
|
2776 * If set to "1", the buffer must be uncompressed.
|
|
|
2777 * @return 0 if success, or the error code if failure.
|
|
|
2778 * @ingroup Images
|
|
|
2779 **/
|
|
|
2780 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginBufferCompression(
|
|
|
2781 OrthancPluginContext* context,
|
|
|
2782 OrthancPluginMemoryBuffer* target,
|
|
|
2783 const void* source,
|
|
|
2784 uint32_t size,
|
|
|
2785 OrthancPluginCompressionType compression,
|
|
|
2786 uint8_t uncompress)
|
|
|
2787 {
|
|
|
2788 _OrthancPluginBufferCompression params;
|
|
|
2789 params.target = target;
|
|
|
2790 params.source = source;
|
|
|
2791 params.size = size;
|
|
|
2792 params.compression = compression;
|
|
|
2793 params.uncompress = uncompress;
|
|
|
2794
|
|
|
2795 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
|
|
|
2796 }
|
|
|
2797
|
|
|
2798
|
|
|
2799
|
|
|
2800 typedef struct
|
|
|
2801 {
|
|
|
2802 OrthancPluginMemoryBuffer* target;
|
|
|
2803 const char* path;
|
|
|
2804 } _OrthancPluginReadFile;
|
|
|
2805
|
|
|
2806 /**
|
|
|
2807 * @brief Read a file.
|
|
|
2808 *
|
|
|
2809 * Read the content of a file on the filesystem, and returns it into
|
|
|
2810 * a newly allocated memory buffer.
|
|
|
2811 *
|
|
|
2812 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
2813 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
2814 * @param path The path of the file to be read.
|
|
|
2815 * @return 0 if success, or the error code if failure.
|
|
|
2816 **/
|
|
|
2817 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile(
|
|
|
2818 OrthancPluginContext* context,
|
|
|
2819 OrthancPluginMemoryBuffer* target,
|
|
|
2820 const char* path)
|
|
|
2821 {
|
|
|
2822 _OrthancPluginReadFile params;
|
|
|
2823 params.target = target;
|
|
|
2824 params.path = path;
|
|
|
2825 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
|
|
|
2826 }
|
|
|
2827
|
|
|
2828
|
|
|
2829
|
|
|
2830 typedef struct
|
|
|
2831 {
|
|
|
2832 const char* path;
|
|
|
2833 const void* data;
|
|
|
2834 uint32_t size;
|
|
|
2835 } _OrthancPluginWriteFile;
|
|
|
2836
|
|
|
2837 /**
|
|
|
2838 * @brief Write a file.
|
|
|
2839 *
|
|
|
2840 * Write the content of a memory buffer to the filesystem.
|
|
|
2841 *
|
|
|
2842 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2843 * @param path The path of the file to be written.
|
|
|
2844 * @param data The content of the memory buffer.
|
|
|
2845 * @param size The size of the memory buffer.
|
|
|
2846 * @return 0 if success, or the error code if failure.
|
|
|
2847 **/
|
|
|
2848 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile(
|
|
|
2849 OrthancPluginContext* context,
|
|
|
2850 const char* path,
|
|
|
2851 const void* data,
|
|
|
2852 uint32_t size)
|
|
|
2853 {
|
|
|
2854 _OrthancPluginWriteFile params;
|
|
|
2855 params.path = path;
|
|
|
2856 params.data = data;
|
|
|
2857 params.size = size;
|
|
|
2858 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
|
|
|
2859 }
|
|
|
2860
|
|
|
2861
|
|
|
2862
|
|
|
2863 typedef struct
|
|
|
2864 {
|
|
|
2865 const char** target;
|
|
|
2866 OrthancPluginErrorCode error;
|
|
|
2867 } _OrthancPluginGetErrorDescription;
|
|
|
2868
|
|
|
2869 /**
|
|
|
2870 * @brief Get the description of a given error code.
|
|
|
2871 *
|
|
|
2872 * This function returns the description of a given error code.
|
|
|
2873 *
|
|
|
2874 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2875 * @param error The error code of interest.
|
|
|
2876 * @return The error description. This is a statically-allocated
|
|
|
2877 * string, do not free it.
|
|
|
2878 **/
|
|
|
2879 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription(
|
|
|
2880 OrthancPluginContext* context,
|
|
|
2881 OrthancPluginErrorCode error)
|
|
|
2882 {
|
|
|
2883 const char* result = NULL;
|
|
|
2884
|
|
|
2885 _OrthancPluginGetErrorDescription params;
|
|
|
2886 params.target = &result;
|
|
|
2887 params.error = error;
|
|
|
2888
|
|
|
2889 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, ¶ms) != OrthancPluginErrorCode_Success ||
|
|
|
2890 result == NULL)
|
|
|
2891 {
|
|
|
2892 return "Unknown error code";
|
|
|
2893 }
|
|
|
2894 else
|
|
|
2895 {
|
|
|
2896 return result;
|
|
|
2897 }
|
|
|
2898 }
|
|
|
2899
|
|
|
2900
|
|
|
2901
|
|
|
2902 typedef struct
|
|
|
2903 {
|
|
|
2904 OrthancPluginRestOutput* output;
|
|
|
2905 uint16_t status;
|
|
|
2906 const char* body;
|
|
|
2907 uint32_t bodySize;
|
|
|
2908 } _OrthancPluginSendHttpStatus;
|
|
|
2909
|
|
|
2910 /**
|
|
|
2911 * @brief Send a HTTP status, with a custom body.
|
|
|
2912 *
|
|
|
2913 * This function answers to a HTTP request by sending a HTTP status
|
|
|
2914 * code (such as "400 - Bad Request"), together with a body
|
|
|
2915 * describing the error. The body will only be returned if the
|
|
|
2916 * configuration option "HttpDescribeErrors" of Orthanc is set to "true".
|
|
|
2917 *
|
|
|
2918 * Note that:
|
|
|
2919 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
|
|
|
2920 * - Redirections (status 301) must use ::OrthancPluginRedirect().
|
|
|
2921 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
|
|
|
2922 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
|
|
|
2923 *
|
|
|
2924 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2925 * @param output The HTTP connection to the client application.
|
|
|
2926 * @param status The HTTP status code to be sent.
|
|
|
2927 * @param body The body of the answer.
|
|
|
2928 * @param bodySize The size of the body.
|
|
|
2929 * @see OrthancPluginSendHttpStatusCode()
|
|
|
2930 * @ingroup REST
|
|
|
2931 **/
|
|
|
2932 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
|
|
|
2933 OrthancPluginContext* context,
|
|
|
2934 OrthancPluginRestOutput* output,
|
|
|
2935 uint16_t status,
|
|
|
2936 const char* body,
|
|
|
2937 uint32_t bodySize)
|
|
|
2938 {
|
|
|
2939 _OrthancPluginSendHttpStatus params;
|
|
|
2940 params.output = output;
|
|
|
2941 params.status = status;
|
|
|
2942 params.body = body;
|
|
|
2943 params.bodySize = bodySize;
|
|
|
2944 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
|
|
|
2945 }
|
|
|
2946
|
|
|
2947
|
|
|
2948
|
|
|
2949 typedef struct
|
|
|
2950 {
|
|
|
2951 const OrthancPluginImage* image;
|
|
|
2952 uint32_t* resultUint32;
|
|
|
2953 OrthancPluginPixelFormat* resultPixelFormat;
|
|
101
|
2954 void** resultBuffer;
|
|
78
|
2955 } _OrthancPluginGetImageInfo;
|
|
|
2956
|
|
|
2957
|
|
|
2958 /**
|
|
|
2959 * @brief Return the pixel format of an image.
|
|
|
2960 *
|
|
|
2961 * This function returns the type of memory layout for the pixels of the given image.
|
|
|
2962 *
|
|
|
2963 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2964 * @param image The image of interest.
|
|
|
2965 * @return The pixel format.
|
|
|
2966 * @ingroup Images
|
|
|
2967 **/
|
|
|
2968 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(
|
|
|
2969 OrthancPluginContext* context,
|
|
|
2970 const OrthancPluginImage* image)
|
|
|
2971 {
|
|
|
2972 OrthancPluginPixelFormat target;
|
|
|
2973
|
|
|
2974 _OrthancPluginGetImageInfo params;
|
|
|
2975 memset(¶ms, 0, sizeof(params));
|
|
|
2976 params.image = image;
|
|
|
2977 params.resultPixelFormat = ⌖
|
|
|
2978
|
|
|
2979 if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
2980 {
|
|
|
2981 return OrthancPluginPixelFormat_Unknown;
|
|
|
2982 }
|
|
|
2983 else
|
|
|
2984 {
|
|
|
2985 return (OrthancPluginPixelFormat) target;
|
|
|
2986 }
|
|
|
2987 }
|
|
|
2988
|
|
|
2989
|
|
|
2990
|
|
|
2991 /**
|
|
|
2992 * @brief Return the width of an image.
|
|
|
2993 *
|
|
|
2994 * This function returns the width of the given image.
|
|
|
2995 *
|
|
|
2996 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
2997 * @param image The image of interest.
|
|
|
2998 * @return The width.
|
|
|
2999 * @ingroup Images
|
|
|
3000 **/
|
|
|
3001 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth(
|
|
|
3002 OrthancPluginContext* context,
|
|
|
3003 const OrthancPluginImage* image)
|
|
|
3004 {
|
|
|
3005 uint32_t width;
|
|
|
3006
|
|
|
3007 _OrthancPluginGetImageInfo params;
|
|
|
3008 memset(¶ms, 0, sizeof(params));
|
|
|
3009 params.image = image;
|
|
|
3010 params.resultUint32 = &width;
|
|
|
3011
|
|
|
3012 if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3013 {
|
|
|
3014 return 0;
|
|
|
3015 }
|
|
|
3016 else
|
|
|
3017 {
|
|
|
3018 return width;
|
|
|
3019 }
|
|
|
3020 }
|
|
|
3021
|
|
|
3022
|
|
|
3023
|
|
|
3024 /**
|
|
|
3025 * @brief Return the height of an image.
|
|
|
3026 *
|
|
|
3027 * This function returns the height of the given image.
|
|
|
3028 *
|
|
|
3029 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3030 * @param image The image of interest.
|
|
|
3031 * @return The height.
|
|
|
3032 * @ingroup Images
|
|
|
3033 **/
|
|
|
3034 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight(
|
|
|
3035 OrthancPluginContext* context,
|
|
|
3036 const OrthancPluginImage* image)
|
|
|
3037 {
|
|
|
3038 uint32_t height;
|
|
|
3039
|
|
|
3040 _OrthancPluginGetImageInfo params;
|
|
|
3041 memset(¶ms, 0, sizeof(params));
|
|
|
3042 params.image = image;
|
|
|
3043 params.resultUint32 = &height;
|
|
|
3044
|
|
|
3045 if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3046 {
|
|
|
3047 return 0;
|
|
|
3048 }
|
|
|
3049 else
|
|
|
3050 {
|
|
|
3051 return height;
|
|
|
3052 }
|
|
|
3053 }
|
|
|
3054
|
|
|
3055
|
|
|
3056
|
|
|
3057 /**
|
|
|
3058 * @brief Return the pitch of an image.
|
|
|
3059 *
|
|
|
3060 * This function returns the pitch of the given image. The pitch is
|
|
|
3061 * defined as the number of bytes between 2 successive lines of the
|
|
|
3062 * image in the memory buffer.
|
|
|
3063 *
|
|
|
3064 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3065 * @param image The image of interest.
|
|
|
3066 * @return The pitch.
|
|
|
3067 * @ingroup Images
|
|
|
3068 **/
|
|
|
3069 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch(
|
|
|
3070 OrthancPluginContext* context,
|
|
|
3071 const OrthancPluginImage* image)
|
|
|
3072 {
|
|
|
3073 uint32_t pitch;
|
|
|
3074
|
|
|
3075 _OrthancPluginGetImageInfo params;
|
|
|
3076 memset(¶ms, 0, sizeof(params));
|
|
|
3077 params.image = image;
|
|
|
3078 params.resultUint32 = &pitch;
|
|
|
3079
|
|
|
3080 if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3081 {
|
|
|
3082 return 0;
|
|
|
3083 }
|
|
|
3084 else
|
|
|
3085 {
|
|
|
3086 return pitch;
|
|
|
3087 }
|
|
|
3088 }
|
|
|
3089
|
|
|
3090
|
|
|
3091
|
|
|
3092 /**
|
|
|
3093 * @brief Return a pointer to the content of an image.
|
|
|
3094 *
|
|
|
3095 * This function returns a pointer to the memory buffer that
|
|
|
3096 * contains the pixels of the image.
|
|
|
3097 *
|
|
|
3098 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3099 * @param image The image of interest.
|
|
|
3100 * @return The pointer.
|
|
|
3101 * @ingroup Images
|
|
|
3102 **/
|
|
101
|
3103 ORTHANC_PLUGIN_INLINE void* OrthancPluginGetImageBuffer(
|
|
78
|
3104 OrthancPluginContext* context,
|
|
|
3105 const OrthancPluginImage* image)
|
|
|
3106 {
|
|
101
|
3107 void* target = NULL;
|
|
78
|
3108
|
|
|
3109 _OrthancPluginGetImageInfo params;
|
|
|
3110 memset(¶ms, 0, sizeof(params));
|
|
|
3111 params.resultBuffer = ⌖
|
|
|
3112 params.image = image;
|
|
|
3113
|
|
|
3114 if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3115 {
|
|
|
3116 return NULL;
|
|
|
3117 }
|
|
|
3118 else
|
|
|
3119 {
|
|
|
3120 return target;
|
|
|
3121 }
|
|
|
3122 }
|
|
|
3123
|
|
|
3124
|
|
|
3125 typedef struct
|
|
|
3126 {
|
|
|
3127 OrthancPluginImage** target;
|
|
|
3128 const void* data;
|
|
|
3129 uint32_t size;
|
|
|
3130 OrthancPluginImageFormat format;
|
|
|
3131 } _OrthancPluginUncompressImage;
|
|
|
3132
|
|
|
3133
|
|
|
3134 /**
|
|
|
3135 * @brief Decode a compressed image.
|
|
|
3136 *
|
|
|
3137 * This function decodes a compressed image from a memory buffer.
|
|
|
3138 *
|
|
|
3139 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3140 * @param data Pointer to a memory buffer containing the compressed image.
|
|
|
3141 * @param size Size of the memory buffer containing the compressed image.
|
|
|
3142 * @param format The file format of the compressed image.
|
|
|
3143 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage().
|
|
|
3144 * @ingroup Images
|
|
|
3145 **/
|
|
|
3146 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage(
|
|
|
3147 OrthancPluginContext* context,
|
|
|
3148 const void* data,
|
|
|
3149 uint32_t size,
|
|
|
3150 OrthancPluginImageFormat format)
|
|
|
3151 {
|
|
|
3152 OrthancPluginImage* target = NULL;
|
|
|
3153
|
|
|
3154 _OrthancPluginUncompressImage params;
|
|
|
3155 memset(¶ms, 0, sizeof(params));
|
|
|
3156 params.target = ⌖
|
|
|
3157 params.data = data;
|
|
|
3158 params.size = size;
|
|
|
3159 params.format = format;
|
|
|
3160
|
|
|
3161 if (context->InvokeService(context, _OrthancPluginService_UncompressImage, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3162 {
|
|
|
3163 return NULL;
|
|
|
3164 }
|
|
|
3165 else
|
|
|
3166 {
|
|
|
3167 return target;
|
|
|
3168 }
|
|
|
3169 }
|
|
|
3170
|
|
|
3171
|
|
|
3172
|
|
|
3173
|
|
|
3174 typedef struct
|
|
|
3175 {
|
|
|
3176 OrthancPluginImage* image;
|
|
|
3177 } _OrthancPluginFreeImage;
|
|
|
3178
|
|
|
3179 /**
|
|
|
3180 * @brief Free an image.
|
|
|
3181 *
|
|
|
3182 * This function frees an image that was decoded with OrthancPluginUncompressImage().
|
|
|
3183 *
|
|
|
3184 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3185 * @param image The image.
|
|
|
3186 * @ingroup Images
|
|
|
3187 **/
|
|
|
3188 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage(
|
|
|
3189 OrthancPluginContext* context,
|
|
|
3190 OrthancPluginImage* image)
|
|
|
3191 {
|
|
|
3192 _OrthancPluginFreeImage params;
|
|
|
3193 params.image = image;
|
|
|
3194
|
|
|
3195 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
|
|
|
3196 }
|
|
|
3197
|
|
|
3198
|
|
|
3199
|
|
|
3200
|
|
|
3201 typedef struct
|
|
|
3202 {
|
|
|
3203 OrthancPluginMemoryBuffer* target;
|
|
|
3204 OrthancPluginImageFormat imageFormat;
|
|
|
3205 OrthancPluginPixelFormat pixelFormat;
|
|
|
3206 uint32_t width;
|
|
|
3207 uint32_t height;
|
|
|
3208 uint32_t pitch;
|
|
|
3209 const void* buffer;
|
|
|
3210 uint8_t quality;
|
|
|
3211 } _OrthancPluginCompressImage;
|
|
|
3212
|
|
|
3213
|
|
|
3214 /**
|
|
|
3215 * @brief Encode a PNG image.
|
|
|
3216 *
|
|
|
3217 * This function compresses the given memory buffer containing an
|
|
|
3218 * image using the PNG specification, and stores the result of the
|
|
|
3219 * compression into a newly allocated memory buffer.
|
|
|
3220 *
|
|
|
3221 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3222 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
3223 * @param format The memory layout of the uncompressed image.
|
|
|
3224 * @param width The width of the image.
|
|
|
3225 * @param height The height of the image.
|
|
|
3226 * @param pitch The pitch of the image (i.e. the number of bytes
|
|
|
3227 * between 2 successive lines of the image in the memory buffer).
|
|
|
3228 * @param buffer The memory buffer containing the uncompressed image.
|
|
|
3229 * @return 0 if success, or the error code if failure.
|
|
|
3230 * @see OrthancPluginCompressAndAnswerPngImage()
|
|
|
3231 * @ingroup Images
|
|
|
3232 **/
|
|
|
3233 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage(
|
|
|
3234 OrthancPluginContext* context,
|
|
|
3235 OrthancPluginMemoryBuffer* target,
|
|
|
3236 OrthancPluginPixelFormat format,
|
|
|
3237 uint32_t width,
|
|
|
3238 uint32_t height,
|
|
|
3239 uint32_t pitch,
|
|
|
3240 const void* buffer)
|
|
|
3241 {
|
|
|
3242 _OrthancPluginCompressImage params;
|
|
|
3243 memset(¶ms, 0, sizeof(params));
|
|
|
3244 params.target = target;
|
|
|
3245 params.imageFormat = OrthancPluginImageFormat_Png;
|
|
|
3246 params.pixelFormat = format;
|
|
|
3247 params.width = width;
|
|
|
3248 params.height = height;
|
|
|
3249 params.pitch = pitch;
|
|
|
3250 params.buffer = buffer;
|
|
|
3251 params.quality = 0; /* Unused for PNG */
|
|
|
3252
|
|
|
3253 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
|
|
|
3254 }
|
|
|
3255
|
|
|
3256
|
|
|
3257 /**
|
|
|
3258 * @brief Encode a JPEG image.
|
|
|
3259 *
|
|
|
3260 * This function compresses the given memory buffer containing an
|
|
|
3261 * image using the JPEG specification, and stores the result of the
|
|
|
3262 * compression into a newly allocated memory buffer.
|
|
|
3263 *
|
|
|
3264 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3265 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
3266 * @param format The memory layout of the uncompressed image.
|
|
|
3267 * @param width The width of the image.
|
|
|
3268 * @param height The height of the image.
|
|
|
3269 * @param pitch The pitch of the image (i.e. the number of bytes
|
|
|
3270 * between 2 successive lines of the image in the memory buffer).
|
|
|
3271 * @param buffer The memory buffer containing the uncompressed image.
|
|
|
3272 * @param quality The quality of the JPEG encoding, between 1 (worst
|
|
|
3273 * quality, best compression) and 100 (best quality, worst
|
|
|
3274 * compression).
|
|
|
3275 * @return 0 if success, or the error code if failure.
|
|
|
3276 * @ingroup Images
|
|
|
3277 **/
|
|
|
3278 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage(
|
|
|
3279 OrthancPluginContext* context,
|
|
|
3280 OrthancPluginMemoryBuffer* target,
|
|
|
3281 OrthancPluginPixelFormat format,
|
|
|
3282 uint32_t width,
|
|
|
3283 uint32_t height,
|
|
|
3284 uint32_t pitch,
|
|
|
3285 const void* buffer,
|
|
|
3286 uint8_t quality)
|
|
|
3287 {
|
|
|
3288 _OrthancPluginCompressImage params;
|
|
|
3289 memset(¶ms, 0, sizeof(params));
|
|
|
3290 params.target = target;
|
|
|
3291 params.imageFormat = OrthancPluginImageFormat_Jpeg;
|
|
|
3292 params.pixelFormat = format;
|
|
|
3293 params.width = width;
|
|
|
3294 params.height = height;
|
|
|
3295 params.pitch = pitch;
|
|
|
3296 params.buffer = buffer;
|
|
|
3297 params.quality = quality;
|
|
|
3298
|
|
|
3299 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
|
|
|
3300 }
|
|
|
3301
|
|
|
3302
|
|
|
3303
|
|
|
3304 /**
|
|
|
3305 * @brief Answer to a REST request with a JPEG image.
|
|
|
3306 *
|
|
|
3307 * This function answers to a REST request with a JPEG image. The
|
|
|
3308 * parameters of this function describe a memory buffer that
|
|
|
3309 * contains an uncompressed image. The image will be automatically compressed
|
|
|
3310 * as a JPEG image by the core system of Orthanc.
|
|
|
3311 *
|
|
|
3312 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3313 * @param output The HTTP connection to the client application.
|
|
|
3314 * @param format The memory layout of the uncompressed image.
|
|
|
3315 * @param width The width of the image.
|
|
|
3316 * @param height The height of the image.
|
|
|
3317 * @param pitch The pitch of the image (i.e. the number of bytes
|
|
|
3318 * between 2 successive lines of the image in the memory buffer).
|
|
|
3319 * @param buffer The memory buffer containing the uncompressed image.
|
|
|
3320 * @param quality The quality of the JPEG encoding, between 1 (worst
|
|
|
3321 * quality, best compression) and 100 (best quality, worst
|
|
|
3322 * compression).
|
|
|
3323 * @ingroup REST
|
|
|
3324 **/
|
|
|
3325 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage(
|
|
|
3326 OrthancPluginContext* context,
|
|
|
3327 OrthancPluginRestOutput* output,
|
|
|
3328 OrthancPluginPixelFormat format,
|
|
|
3329 uint32_t width,
|
|
|
3330 uint32_t height,
|
|
|
3331 uint32_t pitch,
|
|
|
3332 const void* buffer,
|
|
|
3333 uint8_t quality)
|
|
|
3334 {
|
|
|
3335 _OrthancPluginCompressAndAnswerImage params;
|
|
|
3336 params.output = output;
|
|
|
3337 params.imageFormat = OrthancPluginImageFormat_Jpeg;
|
|
|
3338 params.pixelFormat = format;
|
|
|
3339 params.width = width;
|
|
|
3340 params.height = height;
|
|
|
3341 params.pitch = pitch;
|
|
|
3342 params.buffer = buffer;
|
|
|
3343 params.quality = quality;
|
|
|
3344 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
|
|
|
3345 }
|
|
|
3346
|
|
|
3347
|
|
|
3348
|
|
|
3349
|
|
|
3350 typedef struct
|
|
|
3351 {
|
|
|
3352 OrthancPluginMemoryBuffer* target;
|
|
|
3353 OrthancPluginHttpMethod method;
|
|
|
3354 const char* url;
|
|
|
3355 const char* username;
|
|
|
3356 const char* password;
|
|
|
3357 const char* body;
|
|
|
3358 uint32_t bodySize;
|
|
|
3359 } _OrthancPluginCallHttpClient;
|
|
|
3360
|
|
|
3361
|
|
|
3362 /**
|
|
|
3363 * @brief Issue a HTTP GET call.
|
|
|
3364 *
|
|
|
3365 * Make a HTTP GET call to the given URL. The result to the query is
|
|
|
3366 * stored into a newly allocated memory buffer. Favor
|
|
|
3367 * OrthancPluginRestApiGet() if calling the built-in REST API of the
|
|
|
3368 * Orthanc instance that hosts this plugin.
|
|
|
3369 *
|
|
|
3370 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
3371 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
3372 * @param url The URL of interest.
|
|
|
3373 * @param username The username (can be <tt>NULL</tt> if no password protection).
|
|
|
3374 * @param password The password (can be <tt>NULL</tt> if no password protection).
|
|
|
3375 * @return 0 if success, or the error code if failure.
|
|
|
3376 **/
|
|
|
3377 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet(
|
|
|
3378 OrthancPluginContext* context,
|
|
|
3379 OrthancPluginMemoryBuffer* target,
|
|
|
3380 const char* url,
|
|
|
3381 const char* username,
|
|
|
3382 const char* password)
|
|
|
3383 {
|
|
|
3384 _OrthancPluginCallHttpClient params;
|
|
|
3385 memset(¶ms, 0, sizeof(params));
|
|
|
3386
|
|
|
3387 params.target = target;
|
|
|
3388 params.method = OrthancPluginHttpMethod_Get;
|
|
|
3389 params.url = url;
|
|
|
3390 params.username = username;
|
|
|
3391 params.password = password;
|
|
|
3392
|
|
|
3393 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
|
|
|
3394 }
|
|
|
3395
|
|
|
3396
|
|
|
3397 /**
|
|
|
3398 * @brief Issue a HTTP POST call.
|
|
|
3399 *
|
|
|
3400 * Make a HTTP POST call to the given URL. The result to the query
|
|
|
3401 * is stored into a newly allocated memory buffer. Favor
|
|
|
3402 * OrthancPluginRestApiPost() if calling the built-in REST API of
|
|
|
3403 * the Orthanc instance that hosts this plugin.
|
|
|
3404 *
|
|
|
3405 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
3406 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
3407 * @param url The URL of interest.
|
|
|
3408 * @param body The content of the body of the request.
|
|
|
3409 * @param bodySize The size of the body of the request.
|
|
|
3410 * @param username The username (can be <tt>NULL</tt> if no password protection).
|
|
|
3411 * @param password The password (can be <tt>NULL</tt> if no password protection).
|
|
|
3412 * @return 0 if success, or the error code if failure.
|
|
|
3413 **/
|
|
|
3414 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost(
|
|
|
3415 OrthancPluginContext* context,
|
|
|
3416 OrthancPluginMemoryBuffer* target,
|
|
|
3417 const char* url,
|
|
|
3418 const char* body,
|
|
|
3419 uint32_t bodySize,
|
|
|
3420 const char* username,
|
|
|
3421 const char* password)
|
|
|
3422 {
|
|
|
3423 _OrthancPluginCallHttpClient params;
|
|
|
3424 memset(¶ms, 0, sizeof(params));
|
|
|
3425
|
|
|
3426 params.target = target;
|
|
|
3427 params.method = OrthancPluginHttpMethod_Post;
|
|
|
3428 params.url = url;
|
|
|
3429 params.body = body;
|
|
|
3430 params.bodySize = bodySize;
|
|
|
3431 params.username = username;
|
|
|
3432 params.password = password;
|
|
|
3433
|
|
|
3434 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
|
|
|
3435 }
|
|
|
3436
|
|
|
3437
|
|
|
3438 /**
|
|
|
3439 * @brief Issue a HTTP PUT call.
|
|
|
3440 *
|
|
|
3441 * Make a HTTP PUT call to the given URL. The result to the query is
|
|
|
3442 * stored into a newly allocated memory buffer. Favor
|
|
|
3443 * OrthancPluginRestApiPut() if calling the built-in REST API of the
|
|
|
3444 * Orthanc instance that hosts this plugin.
|
|
|
3445 *
|
|
|
3446 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
101
|
3447 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
78
|
3448 * @param url The URL of interest.
|
|
|
3449 * @param body The content of the body of the request.
|
|
|
3450 * @param bodySize The size of the body of the request.
|
|
|
3451 * @param username The username (can be <tt>NULL</tt> if no password protection).
|
|
|
3452 * @param password The password (can be <tt>NULL</tt> if no password protection).
|
|
|
3453 * @return 0 if success, or the error code if failure.
|
|
|
3454 **/
|
|
|
3455 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut(
|
|
|
3456 OrthancPluginContext* context,
|
|
|
3457 OrthancPluginMemoryBuffer* target,
|
|
|
3458 const char* url,
|
|
|
3459 const char* body,
|
|
|
3460 uint32_t bodySize,
|
|
|
3461 const char* username,
|
|
|
3462 const char* password)
|
|
|
3463 {
|
|
|
3464 _OrthancPluginCallHttpClient params;
|
|
|
3465 memset(¶ms, 0, sizeof(params));
|
|
|
3466
|
|
|
3467 params.target = target;
|
|
|
3468 params.method = OrthancPluginHttpMethod_Put;
|
|
|
3469 params.url = url;
|
|
|
3470 params.body = body;
|
|
|
3471 params.bodySize = bodySize;
|
|
|
3472 params.username = username;
|
|
|
3473 params.password = password;
|
|
|
3474
|
|
|
3475 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
|
|
|
3476 }
|
|
|
3477
|
|
|
3478
|
|
|
3479 /**
|
|
|
3480 * @brief Issue a HTTP DELETE call.
|
|
|
3481 *
|
|
|
3482 * Make a HTTP DELETE call to the given URL. Favor
|
|
|
3483 * OrthancPluginRestApiDelete() if calling the built-in REST API of
|
|
|
3484 * the Orthanc instance that hosts this plugin.
|
|
|
3485 *
|
|
|
3486 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3487 * @param url The URL of interest.
|
|
|
3488 * @param username The username (can be <tt>NULL</tt> if no password protection).
|
|
|
3489 * @param password The password (can be <tt>NULL</tt> if no password protection).
|
|
|
3490 * @return 0 if success, or the error code if failure.
|
|
|
3491 **/
|
|
|
3492 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete(
|
|
|
3493 OrthancPluginContext* context,
|
|
|
3494 const char* url,
|
|
|
3495 const char* username,
|
|
|
3496 const char* password)
|
|
|
3497 {
|
|
|
3498 _OrthancPluginCallHttpClient params;
|
|
|
3499 memset(¶ms, 0, sizeof(params));
|
|
|
3500
|
|
|
3501 params.method = OrthancPluginHttpMethod_Delete;
|
|
|
3502 params.url = url;
|
|
|
3503 params.username = username;
|
|
|
3504 params.password = password;
|
|
|
3505
|
|
|
3506 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
|
|
|
3507 }
|
|
|
3508
|
|
|
3509
|
|
|
3510
|
|
|
3511 typedef struct
|
|
|
3512 {
|
|
|
3513 OrthancPluginImage** target;
|
|
|
3514 const OrthancPluginImage* source;
|
|
|
3515 OrthancPluginPixelFormat targetFormat;
|
|
|
3516 } _OrthancPluginConvertPixelFormat;
|
|
|
3517
|
|
|
3518
|
|
|
3519 /**
|
|
|
3520 * @brief Change the pixel format of an image.
|
|
|
3521 *
|
|
|
3522 * This function creates a new image, changing the memory layout of the pixels.
|
|
|
3523 *
|
|
|
3524 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3525 * @param source The source image.
|
|
|
3526 * @param targetFormat The target pixel format.
|
|
|
3527 * @return The resulting image. It must be freed with OrthancPluginFreeImage().
|
|
|
3528 * @ingroup Images
|
|
|
3529 **/
|
|
|
3530 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat(
|
|
|
3531 OrthancPluginContext* context,
|
|
|
3532 const OrthancPluginImage* source,
|
|
|
3533 OrthancPluginPixelFormat targetFormat)
|
|
|
3534 {
|
|
|
3535 OrthancPluginImage* target = NULL;
|
|
|
3536
|
|
|
3537 _OrthancPluginConvertPixelFormat params;
|
|
|
3538 params.target = ⌖
|
|
|
3539 params.source = source;
|
|
|
3540 params.targetFormat = targetFormat;
|
|
|
3541
|
|
|
3542 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3543 {
|
|
|
3544 return NULL;
|
|
|
3545 }
|
|
|
3546 else
|
|
|
3547 {
|
|
|
3548 return target;
|
|
|
3549 }
|
|
|
3550 }
|
|
|
3551
|
|
|
3552
|
|
|
3553
|
|
|
3554 /**
|
|
|
3555 * @brief Return the number of available fonts.
|
|
|
3556 *
|
|
|
3557 * This function returns the number of fonts that are built in the
|
|
|
3558 * Orthanc core. These fonts can be used to draw texts on images
|
|
|
3559 * through OrthancPluginDrawText().
|
|
|
3560 *
|
|
|
3561 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3562 * @return The number of fonts.
|
|
|
3563 * @ingroup Images
|
|
|
3564 **/
|
|
|
3565 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount(
|
|
|
3566 OrthancPluginContext* context)
|
|
|
3567 {
|
|
|
3568 uint32_t count = 0;
|
|
|
3569
|
|
|
3570 _OrthancPluginReturnSingleValue params;
|
|
|
3571 memset(¶ms, 0, sizeof(params));
|
|
|
3572 params.resultUint32 = &count;
|
|
|
3573
|
|
|
3574 if (context->InvokeService(context, _OrthancPluginService_GetFontsCount, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3575 {
|
|
|
3576 /* Error */
|
|
|
3577 return 0;
|
|
|
3578 }
|
|
|
3579 else
|
|
|
3580 {
|
|
|
3581 return count;
|
|
|
3582 }
|
|
|
3583 }
|
|
|
3584
|
|
|
3585
|
|
|
3586
|
|
|
3587
|
|
|
3588 typedef struct
|
|
|
3589 {
|
|
|
3590 uint32_t fontIndex; /* in */
|
|
|
3591 const char** name; /* out */
|
|
|
3592 uint32_t* size; /* out */
|
|
|
3593 } _OrthancPluginGetFontInfo;
|
|
|
3594
|
|
|
3595 /**
|
|
|
3596 * @brief Return the name of a font.
|
|
|
3597 *
|
|
|
3598 * This function returns the name of a font that is built in the Orthanc core.
|
|
|
3599 *
|
|
|
3600 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3601 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
|
|
|
3602 * @return The font name. This is a statically-allocated string, do not free it.
|
|
|
3603 * @ingroup Images
|
|
|
3604 **/
|
|
|
3605 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName(
|
|
|
3606 OrthancPluginContext* context,
|
|
|
3607 uint32_t fontIndex)
|
|
|
3608 {
|
|
|
3609 const char* result = NULL;
|
|
|
3610
|
|
|
3611 _OrthancPluginGetFontInfo params;
|
|
|
3612 memset(¶ms, 0, sizeof(params));
|
|
|
3613 params.name = &result;
|
|
|
3614 params.fontIndex = fontIndex;
|
|
|
3615
|
|
|
3616 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3617 {
|
|
|
3618 return NULL;
|
|
|
3619 }
|
|
|
3620 else
|
|
|
3621 {
|
|
|
3622 return result;
|
|
|
3623 }
|
|
|
3624 }
|
|
|
3625
|
|
|
3626
|
|
|
3627 /**
|
|
|
3628 * @brief Return the size of a font.
|
|
|
3629 *
|
|
|
3630 * This function returns the size of a font that is built in the Orthanc core.
|
|
|
3631 *
|
|
|
3632 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3633 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
|
|
|
3634 * @return The font size.
|
|
|
3635 * @ingroup Images
|
|
|
3636 **/
|
|
|
3637 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize(
|
|
|
3638 OrthancPluginContext* context,
|
|
|
3639 uint32_t fontIndex)
|
|
|
3640 {
|
|
|
3641 uint32_t result;
|
|
|
3642
|
|
|
3643 _OrthancPluginGetFontInfo params;
|
|
|
3644 memset(¶ms, 0, sizeof(params));
|
|
|
3645 params.size = &result;
|
|
|
3646 params.fontIndex = fontIndex;
|
|
|
3647
|
|
|
3648 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
3649 {
|
|
|
3650 return 0;
|
|
|
3651 }
|
|
|
3652 else
|
|
|
3653 {
|
|
|
3654 return result;
|
|
|
3655 }
|
|
|
3656 }
|
|
|
3657
|
|
|
3658
|
|
|
3659
|
|
|
3660 typedef struct
|
|
|
3661 {
|
|
|
3662 OrthancPluginImage* image;
|
|
|
3663 uint32_t fontIndex;
|
|
|
3664 const char* utf8Text;
|
|
|
3665 int32_t x;
|
|
|
3666 int32_t y;
|
|
|
3667 uint8_t r;
|
|
|
3668 uint8_t g;
|
|
|
3669 uint8_t b;
|
|
|
3670 } _OrthancPluginDrawText;
|
|
|
3671
|
|
|
3672
|
|
|
3673 /**
|
|
|
3674 * @brief Draw text on an image.
|
|
|
3675 *
|
|
|
3676 * This function draws some text on some image.
|
|
|
3677 *
|
|
|
3678 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3679 * @param image The image upon which to draw the text.
|
|
|
3680 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
|
|
|
3681 * @param utf8Text The text to be drawn, encoded as an UTF-8 zero-terminated string.
|
|
|
3682 * @param x The X position of the text over the image.
|
|
|
3683 * @param y The Y position of the text over the image.
|
|
|
3684 * @param r The value of the red color channel of the text.
|
|
|
3685 * @param g The value of the green color channel of the text.
|
|
|
3686 * @param b The value of the blue color channel of the text.
|
|
|
3687 * @return 0 if success, other value if error.
|
|
|
3688 * @ingroup Images
|
|
|
3689 **/
|
|
|
3690 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDrawText(
|
|
|
3691 OrthancPluginContext* context,
|
|
|
3692 OrthancPluginImage* image,
|
|
|
3693 uint32_t fontIndex,
|
|
|
3694 const char* utf8Text,
|
|
|
3695 int32_t x,
|
|
|
3696 int32_t y,
|
|
|
3697 uint8_t r,
|
|
|
3698 uint8_t g,
|
|
|
3699 uint8_t b)
|
|
|
3700 {
|
|
|
3701 _OrthancPluginDrawText params;
|
|
|
3702 memset(¶ms, 0, sizeof(params));
|
|
|
3703 params.image = image;
|
|
|
3704 params.fontIndex = fontIndex;
|
|
|
3705 params.utf8Text = utf8Text;
|
|
|
3706 params.x = x;
|
|
|
3707 params.y = y;
|
|
|
3708 params.r = r;
|
|
|
3709 params.g = g;
|
|
|
3710 params.b = b;
|
|
|
3711
|
|
|
3712 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
|
|
|
3713 }
|
|
|
3714
|
|
|
3715
|
|
|
3716
|
|
|
3717 typedef struct
|
|
|
3718 {
|
|
|
3719 OrthancPluginStorageArea* storageArea;
|
|
|
3720 const char* uuid;
|
|
|
3721 const void* content;
|
|
|
3722 uint64_t size;
|
|
|
3723 OrthancPluginContentType type;
|
|
|
3724 } _OrthancPluginStorageAreaCreate;
|
|
|
3725
|
|
|
3726
|
|
|
3727 /**
|
|
|
3728 * @brief Create a file inside the storage area.
|
|
|
3729 *
|
|
|
3730 * This function creates a new file inside the storage area that is
|
|
|
3731 * currently used by Orthanc.
|
|
|
3732 *
|
|
|
3733 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3734 * @param storageArea The storage area.
|
|
|
3735 * @param uuid The identifier of the file to be created.
|
|
|
3736 * @param content The content to store in the newly created file.
|
|
|
3737 * @param size The size of the content.
|
|
|
3738 * @param type The type of the file content.
|
|
|
3739 * @return 0 if success, other value if error.
|
|
|
3740 * @ingroup Callbacks
|
|
|
3741 **/
|
|
|
3742 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate(
|
|
|
3743 OrthancPluginContext* context,
|
|
|
3744 OrthancPluginStorageArea* storageArea,
|
|
|
3745 const char* uuid,
|
|
|
3746 const void* content,
|
|
|
3747 uint64_t size,
|
|
|
3748 OrthancPluginContentType type)
|
|
|
3749 {
|
|
|
3750 _OrthancPluginStorageAreaCreate params;
|
|
|
3751 params.storageArea = storageArea;
|
|
|
3752 params.uuid = uuid;
|
|
|
3753 params.content = content;
|
|
|
3754 params.size = size;
|
|
|
3755 params.type = type;
|
|
|
3756
|
|
|
3757 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
|
|
|
3758 }
|
|
|
3759
|
|
|
3760
|
|
|
3761 typedef struct
|
|
|
3762 {
|
|
|
3763 OrthancPluginMemoryBuffer* target;
|
|
|
3764 OrthancPluginStorageArea* storageArea;
|
|
|
3765 const char* uuid;
|
|
|
3766 OrthancPluginContentType type;
|
|
|
3767 } _OrthancPluginStorageAreaRead;
|
|
|
3768
|
|
|
3769
|
|
|
3770 /**
|
|
|
3771 * @brief Read a file from the storage area.
|
|
|
3772 *
|
|
|
3773 * This function reads the content of a given file from the storage
|
|
|
3774 * area that is currently used by Orthanc.
|
|
|
3775 *
|
|
|
3776 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3777 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
3778 * @param storageArea The storage area.
|
|
|
3779 * @param uuid The identifier of the file to be read.
|
|
|
3780 * @param type The type of the file content.
|
|
|
3781 * @return 0 if success, other value if error.
|
|
|
3782 * @ingroup Callbacks
|
|
|
3783 **/
|
|
|
3784 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead(
|
|
|
3785 OrthancPluginContext* context,
|
|
|
3786 OrthancPluginMemoryBuffer* target,
|
|
|
3787 OrthancPluginStorageArea* storageArea,
|
|
|
3788 const char* uuid,
|
|
|
3789 OrthancPluginContentType type)
|
|
|
3790 {
|
|
|
3791 _OrthancPluginStorageAreaRead params;
|
|
|
3792 params.target = target;
|
|
|
3793 params.storageArea = storageArea;
|
|
|
3794 params.uuid = uuid;
|
|
|
3795 params.type = type;
|
|
|
3796
|
|
|
3797 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
|
|
|
3798 }
|
|
|
3799
|
|
|
3800
|
|
|
3801 typedef struct
|
|
|
3802 {
|
|
|
3803 OrthancPluginStorageArea* storageArea;
|
|
|
3804 const char* uuid;
|
|
|
3805 OrthancPluginContentType type;
|
|
|
3806 } _OrthancPluginStorageAreaRemove;
|
|
|
3807
|
|
|
3808 /**
|
|
|
3809 * @brief Remove a file from the storage area.
|
|
|
3810 *
|
|
|
3811 * This function removes a given file from the storage area that is
|
|
|
3812 * currently used by Orthanc.
|
|
|
3813 *
|
|
|
3814 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3815 * @param storageArea The storage area.
|
|
|
3816 * @param uuid The identifier of the file to be removed.
|
|
|
3817 * @param type The type of the file content.
|
|
|
3818 * @return 0 if success, other value if error.
|
|
|
3819 * @ingroup Callbacks
|
|
|
3820 **/
|
|
|
3821 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove(
|
|
|
3822 OrthancPluginContext* context,
|
|
|
3823 OrthancPluginStorageArea* storageArea,
|
|
|
3824 const char* uuid,
|
|
|
3825 OrthancPluginContentType type)
|
|
|
3826 {
|
|
|
3827 _OrthancPluginStorageAreaRemove params;
|
|
|
3828 params.storageArea = storageArea;
|
|
|
3829 params.uuid = uuid;
|
|
|
3830 params.type = type;
|
|
|
3831
|
|
|
3832 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
|
|
|
3833 }
|
|
|
3834
|
|
|
3835
|
|
|
3836
|
|
101
|
3837 typedef struct
|
|
|
3838 {
|
|
|
3839 OrthancPluginErrorCode* target;
|
|
|
3840 int32_t code;
|
|
|
3841 uint16_t httpStatus;
|
|
|
3842 const char* message;
|
|
|
3843 } _OrthancPluginRegisterErrorCode;
|
|
|
3844
|
|
|
3845 /**
|
|
|
3846 * @brief Declare a custom error code for this plugin.
|
|
|
3847 *
|
|
|
3848 * This function declares a custom error code that can be generated
|
|
|
3849 * by this plugin. This declaration is used to enrich the body of
|
|
|
3850 * the HTTP answer in the case of an error, and to set the proper
|
|
|
3851 * HTTP status code.
|
|
|
3852 *
|
|
|
3853 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3854 * @param code The error code that is internal to this plugin.
|
|
|
3855 * @param httpStatus The HTTP status corresponding to this error.
|
|
|
3856 * @param message The description of the error.
|
|
|
3857 * @return The error code that has been assigned inside the Orthanc core.
|
|
|
3858 * @ingroup Toolbox
|
|
|
3859 **/
|
|
|
3860 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterErrorCode(
|
|
|
3861 OrthancPluginContext* context,
|
|
|
3862 int32_t code,
|
|
|
3863 uint16_t httpStatus,
|
|
|
3864 const char* message)
|
|
|
3865 {
|
|
|
3866 OrthancPluginErrorCode target;
|
|
|
3867
|
|
|
3868 _OrthancPluginRegisterErrorCode params;
|
|
|
3869 params.target = ⌖
|
|
|
3870 params.code = code;
|
|
|
3871 params.httpStatus = httpStatus;
|
|
|
3872 params.message = message;
|
|
|
3873
|
|
|
3874 if (context->InvokeService(context, _OrthancPluginService_RegisterErrorCode, ¶ms) == OrthancPluginErrorCode_Success)
|
|
|
3875 {
|
|
|
3876 return target;
|
|
|
3877 }
|
|
|
3878 else
|
|
|
3879 {
|
|
|
3880 /* There was an error while assigned the error. Use a generic code. */
|
|
|
3881 return OrthancPluginErrorCode_Plugin;
|
|
|
3882 }
|
|
|
3883 }
|
|
|
3884
|
|
|
3885
|
|
|
3886
|
|
|
3887 typedef struct
|
|
|
3888 {
|
|
|
3889 uint16_t group;
|
|
|
3890 uint16_t element;
|
|
|
3891 OrthancPluginValueRepresentation vr;
|
|
|
3892 const char* name;
|
|
|
3893 uint32_t minMultiplicity;
|
|
|
3894 uint32_t maxMultiplicity;
|
|
|
3895 } _OrthancPluginRegisterDictionaryTag;
|
|
|
3896
|
|
|
3897 /**
|
|
|
3898 * @brief Register a new tag into the DICOM dictionary.
|
|
|
3899 *
|
|
|
3900 * This function declares a new tag in the dictionary of DICOM tags
|
|
|
3901 * that are known to Orthanc. This function should be used in the
|
|
|
3902 * OrthancPluginInitialize() callback.
|
|
|
3903 *
|
|
|
3904 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3905 * @param group The group of the tag.
|
|
|
3906 * @param element The element of the tag.
|
|
|
3907 * @param vr The value representation of the tag.
|
|
|
3908 * @param name The nickname of the tag.
|
|
|
3909 * @param minMultiplicity The minimum multiplicity of the tag (must be above 0).
|
|
|
3910 * @param maxMultiplicity The maximum multiplicity of the tag. A value of 0 means
|
|
|
3911 * an arbitrary multiplicity ("<tt>n</tt>").
|
|
|
3912 * @return 0 if success, other value if error.
|
|
|
3913 * @ingroup Toolbox
|
|
|
3914 **/
|
|
|
3915 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDictionaryTag(
|
|
|
3916 OrthancPluginContext* context,
|
|
|
3917 uint16_t group,
|
|
|
3918 uint16_t element,
|
|
|
3919 OrthancPluginValueRepresentation vr,
|
|
|
3920 const char* name,
|
|
|
3921 uint32_t minMultiplicity,
|
|
|
3922 uint32_t maxMultiplicity)
|
|
|
3923 {
|
|
|
3924 _OrthancPluginRegisterDictionaryTag params;
|
|
|
3925 params.group = group;
|
|
|
3926 params.element = element;
|
|
|
3927 params.vr = vr;
|
|
|
3928 params.name = name;
|
|
|
3929 params.minMultiplicity = minMultiplicity;
|
|
|
3930 params.maxMultiplicity = maxMultiplicity;
|
|
|
3931
|
|
|
3932 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
|
|
|
3933 }
|
|
|
3934
|
|
|
3935
|
|
|
3936
|
|
|
3937
|
|
|
3938 typedef struct
|
|
|
3939 {
|
|
|
3940 OrthancPluginStorageArea* storageArea;
|
|
|
3941 OrthancPluginResourceType level;
|
|
|
3942 } _OrthancPluginReconstructMainDicomTags;
|
|
|
3943
|
|
|
3944 /**
|
|
|
3945 * @brief Reconstruct the main DICOM tags.
|
|
|
3946 *
|
|
|
3947 * This function requests the Orthanc core to reconstruct the main
|
|
|
3948 * DICOM tags of all the resources of the given type. This function
|
|
|
3949 * can only be used as a part of the upgrade of a custom database
|
|
|
3950 * back-end
|
|
|
3951 * (cf. OrthancPlugins::IDatabaseBackend::UpgradeDatabase). A
|
|
|
3952 * database transaction will be automatically setup.
|
|
|
3953 *
|
|
|
3954 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3955 * @param storageArea The storage area.
|
|
|
3956 * @param level The type of the resources of interest.
|
|
|
3957 * @return 0 if success, other value if error.
|
|
|
3958 * @ingroup Callbacks
|
|
|
3959 **/
|
|
|
3960 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(
|
|
|
3961 OrthancPluginContext* context,
|
|
|
3962 OrthancPluginStorageArea* storageArea,
|
|
|
3963 OrthancPluginResourceType level)
|
|
|
3964 {
|
|
|
3965 _OrthancPluginReconstructMainDicomTags params;
|
|
|
3966 params.level = level;
|
|
|
3967 params.storageArea = storageArea;
|
|
|
3968
|
|
|
3969 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
|
|
|
3970 }
|
|
|
3971
|
|
|
3972
|
|
|
3973 typedef struct
|
|
|
3974 {
|
|
|
3975 char** result;
|
|
|
3976 const char* instanceId;
|
|
|
3977 const char* buffer;
|
|
|
3978 uint32_t size;
|
|
|
3979 OrthancPluginDicomToJsonFormat format;
|
|
|
3980 OrthancPluginDicomToJsonFlags flags;
|
|
|
3981 uint32_t maxStringLength;
|
|
|
3982 } _OrthancPluginDicomToJson;
|
|
|
3983
|
|
|
3984
|
|
|
3985 /**
|
|
|
3986 * @brief Format a DICOM memory buffer as a JSON string.
|
|
|
3987 *
|
|
|
3988 * This function takes as input a memory buffer containing a DICOM
|
|
|
3989 * file, and outputs a JSON string representing the tags of this
|
|
|
3990 * DICOM file.
|
|
|
3991 *
|
|
|
3992 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
3993 * @param buffer The memory buffer containing the DICOM file.
|
|
|
3994 * @param size The size of the memory buffer.
|
|
|
3995 * @param format The output format.
|
|
|
3996 * @param flags Flags governing the output.
|
|
|
3997 * @param maxStringLength The maximum length of a field. Too long fields will
|
|
|
3998 * be output as "null". The 0 value means no maximum length.
|
|
|
3999 * @return The NULL value if the case of an error, or the JSON
|
|
|
4000 * string. This string must be freed by OrthancPluginFreeString().
|
|
|
4001 * @ingroup Toolbox
|
|
|
4002 * @see OrthancPluginDicomInstanceToJson
|
|
|
4003 **/
|
|
|
4004 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomBufferToJson(
|
|
|
4005 OrthancPluginContext* context,
|
|
|
4006 const char* buffer,
|
|
|
4007 uint32_t size,
|
|
|
4008 OrthancPluginDicomToJsonFormat format,
|
|
|
4009 OrthancPluginDicomToJsonFlags flags,
|
|
|
4010 uint32_t maxStringLength)
|
|
|
4011 {
|
|
|
4012 char* result;
|
|
|
4013
|
|
|
4014 _OrthancPluginDicomToJson params;
|
|
|
4015 memset(¶ms, 0, sizeof(params));
|
|
|
4016 params.result = &result;
|
|
|
4017 params.buffer = buffer;
|
|
|
4018 params.size = size;
|
|
|
4019 params.format = format;
|
|
|
4020 params.flags = flags;
|
|
|
4021 params.maxStringLength = maxStringLength;
|
|
|
4022
|
|
|
4023 if (context->InvokeService(context, _OrthancPluginService_DicomBufferToJson, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4024 {
|
|
|
4025 /* Error */
|
|
|
4026 return NULL;
|
|
|
4027 }
|
|
|
4028 else
|
|
|
4029 {
|
|
|
4030 return result;
|
|
|
4031 }
|
|
|
4032 }
|
|
|
4033
|
|
|
4034
|
|
|
4035 /**
|
|
|
4036 * @brief Format a DICOM instance as a JSON string.
|
|
|
4037 *
|
|
|
4038 * This function formats a DICOM instance that is stored in Orthanc,
|
|
|
4039 * and outputs a JSON string representing the tags of this DICOM
|
|
|
4040 * instance.
|
|
|
4041 *
|
|
|
4042 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4043 * @param instanceId The Orthanc identifier of the instance.
|
|
|
4044 * @param format The output format.
|
|
|
4045 * @param flags Flags governing the output.
|
|
|
4046 * @param maxStringLength The maximum length of a field. Too long fields will
|
|
|
4047 * be output as "null". The 0 value means no maximum length.
|
|
|
4048 * @return The NULL value if the case of an error, or the JSON
|
|
|
4049 * string. This string must be freed by OrthancPluginFreeString().
|
|
|
4050 * @ingroup Toolbox
|
|
|
4051 * @see OrthancPluginDicomInstanceToJson
|
|
|
4052 **/
|
|
|
4053 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomInstanceToJson(
|
|
|
4054 OrthancPluginContext* context,
|
|
|
4055 const char* instanceId,
|
|
|
4056 OrthancPluginDicomToJsonFormat format,
|
|
|
4057 OrthancPluginDicomToJsonFlags flags,
|
|
|
4058 uint32_t maxStringLength)
|
|
|
4059 {
|
|
|
4060 char* result;
|
|
|
4061
|
|
|
4062 _OrthancPluginDicomToJson params;
|
|
|
4063 memset(¶ms, 0, sizeof(params));
|
|
|
4064 params.result = &result;
|
|
|
4065 params.instanceId = instanceId;
|
|
|
4066 params.format = format;
|
|
|
4067 params.flags = flags;
|
|
|
4068 params.maxStringLength = maxStringLength;
|
|
|
4069
|
|
|
4070 if (context->InvokeService(context, _OrthancPluginService_DicomInstanceToJson, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4071 {
|
|
|
4072 /* Error */
|
|
|
4073 return NULL;
|
|
|
4074 }
|
|
|
4075 else
|
|
|
4076 {
|
|
|
4077 return result;
|
|
|
4078 }
|
|
|
4079 }
|
|
|
4080
|
|
|
4081
|
|
|
4082 typedef struct
|
|
|
4083 {
|
|
|
4084 OrthancPluginMemoryBuffer* target;
|
|
|
4085 const char* uri;
|
|
|
4086 uint32_t headersCount;
|
|
|
4087 const char* const* headersKeys;
|
|
|
4088 const char* const* headersValues;
|
|
|
4089 int32_t afterPlugins;
|
|
|
4090 } _OrthancPluginRestApiGet2;
|
|
|
4091
|
|
|
4092 /**
|
|
|
4093 * @brief Make a GET call to the Orthanc REST API, with custom HTTP headers.
|
|
|
4094 *
|
|
|
4095 * Make a GET call to the Orthanc REST API with extended
|
|
|
4096 * parameters. The result to the query is stored into a newly
|
|
|
4097 * allocated memory buffer.
|
|
|
4098 *
|
|
|
4099 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4100 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
4101 * @param uri The URI in the built-in Orthanc API.
|
|
|
4102 * @param headersCount The number of HTTP headers.
|
|
|
4103 * @param headersKeys Array containing the keys of the HTTP headers.
|
|
|
4104 * @param headersValues Array containing the values of the HTTP headers.
|
|
|
4105 * @param afterPlugins If 0, the built-in API of Orthanc is used.
|
|
|
4106 * If 1, the API is tainted by the plugins.
|
|
|
4107 * @return 0 if success, or the error code if failure.
|
|
|
4108 * @see OrthancPluginRestApiGet, OrthancPluginRestApiGetAfterPlugins
|
|
|
4109 * @ingroup Orthanc
|
|
|
4110 **/
|
|
|
4111 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet2(
|
|
|
4112 OrthancPluginContext* context,
|
|
|
4113 OrthancPluginMemoryBuffer* target,
|
|
|
4114 const char* uri,
|
|
|
4115 uint32_t headersCount,
|
|
|
4116 const char* const* headersKeys,
|
|
|
4117 const char* const* headersValues,
|
|
|
4118 int32_t afterPlugins)
|
|
|
4119 {
|
|
|
4120 _OrthancPluginRestApiGet2 params;
|
|
|
4121 params.target = target;
|
|
|
4122 params.uri = uri;
|
|
|
4123 params.headersCount = headersCount;
|
|
|
4124 params.headersKeys = headersKeys;
|
|
|
4125 params.headersValues = headersValues;
|
|
|
4126 params.afterPlugins = afterPlugins;
|
|
|
4127
|
|
|
4128 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
|
|
|
4129 }
|
|
|
4130
|
|
|
4131
|
|
|
4132
|
|
|
4133 typedef struct
|
|
|
4134 {
|
|
|
4135 OrthancPluginWorklistCallback callback;
|
|
|
4136 } _OrthancPluginWorklistCallback;
|
|
|
4137
|
|
|
4138 /**
|
|
|
4139 * @brief Register a callback to handle modality worklists requests.
|
|
|
4140 *
|
|
|
4141 * This function registers a callback to handle C-Find SCP requests
|
|
|
4142 * on modality worklists.
|
|
|
4143 *
|
|
|
4144 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4145 * @param callback The callback.
|
|
|
4146 * @return 0 if success, other value if error.
|
|
|
4147 * @ingroup Worklists
|
|
|
4148 **/
|
|
|
4149 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(
|
|
|
4150 OrthancPluginContext* context,
|
|
|
4151 OrthancPluginWorklistCallback callback)
|
|
|
4152 {
|
|
|
4153 _OrthancPluginWorklistCallback params;
|
|
|
4154 params.callback = callback;
|
|
|
4155
|
|
|
4156 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
|
|
|
4157 }
|
|
|
4158
|
|
|
4159
|
|
|
4160
|
|
|
4161 typedef struct
|
|
|
4162 {
|
|
|
4163 OrthancPluginWorklistAnswers* answers;
|
|
|
4164 const OrthancPluginWorklistQuery* query;
|
|
|
4165 const void* dicom;
|
|
|
4166 uint32_t size;
|
|
|
4167 } _OrthancPluginWorklistAnswersOperation;
|
|
|
4168
|
|
|
4169 /**
|
|
|
4170 * @brief Add one answer to some modality worklist request.
|
|
|
4171 *
|
|
|
4172 * This function adds one worklist (encoded as a DICOM file) to the
|
|
|
4173 * set of answers corresponding to some C-Find SCP request against
|
|
|
4174 * modality worklists.
|
|
|
4175 *
|
|
|
4176 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4177 * @param answers The set of answers.
|
|
|
4178 * @param query The worklist query, as received by the callback.
|
|
|
4179 * @param dicom The worklist to answer, encoded as a DICOM file.
|
|
|
4180 * @param size The size of the DICOM file.
|
|
|
4181 * @return 0 if success, other value if error.
|
|
|
4182 * @ingroup Worklists
|
|
|
4183 **/
|
|
|
4184 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistAddAnswer(
|
|
|
4185 OrthancPluginContext* context,
|
|
|
4186 OrthancPluginWorklistAnswers* answers,
|
|
|
4187 const OrthancPluginWorklistQuery* query,
|
|
|
4188 const void* dicom,
|
|
|
4189 uint32_t size)
|
|
|
4190 {
|
|
|
4191 _OrthancPluginWorklistAnswersOperation params;
|
|
|
4192 params.answers = answers;
|
|
|
4193 params.query = query;
|
|
|
4194 params.dicom = dicom;
|
|
|
4195 params.size = size;
|
|
|
4196
|
|
|
4197 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
|
|
|
4198 }
|
|
|
4199
|
|
|
4200
|
|
|
4201 /**
|
|
|
4202 * @brief Mark the set of worklist answers as incomplete.
|
|
|
4203 *
|
|
|
4204 * This function marks as incomplete the set of answers
|
|
|
4205 * corresponding to some C-Find SCP request against modality
|
|
|
4206 * worklists. This must be used if canceling the handling of a
|
|
|
4207 * request when too many answers are to be returned.
|
|
|
4208 *
|
|
|
4209 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4210 * @param answers The set of answers.
|
|
|
4211 * @return 0 if success, other value if error.
|
|
|
4212 * @ingroup Worklists
|
|
|
4213 **/
|
|
|
4214 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(
|
|
|
4215 OrthancPluginContext* context,
|
|
|
4216 OrthancPluginWorklistAnswers* answers)
|
|
|
4217 {
|
|
|
4218 _OrthancPluginWorklistAnswersOperation params;
|
|
|
4219 params.answers = answers;
|
|
|
4220 params.query = NULL;
|
|
|
4221 params.dicom = NULL;
|
|
|
4222 params.size = 0;
|
|
|
4223
|
|
|
4224 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
|
|
|
4225 }
|
|
|
4226
|
|
|
4227
|
|
|
4228 typedef struct
|
|
|
4229 {
|
|
|
4230 const OrthancPluginWorklistQuery* query;
|
|
|
4231 const void* dicom;
|
|
|
4232 uint32_t size;
|
|
|
4233 int32_t* isMatch;
|
|
|
4234 OrthancPluginMemoryBuffer* target;
|
|
|
4235 } _OrthancPluginWorklistQueryOperation;
|
|
|
4236
|
|
|
4237 /**
|
|
|
4238 * @brief Test whether a worklist matches the query.
|
|
|
4239 *
|
|
|
4240 * This function checks whether one worklist (encoded as a DICOM
|
|
|
4241 * file) matches the C-Find SCP query against modality
|
|
|
4242 * worklists. This function must be called before adding the
|
|
|
4243 * worklist as an answer through OrthancPluginWorklistAddAnswer().
|
|
|
4244 *
|
|
|
4245 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4246 * @param query The worklist query, as received by the callback.
|
|
|
4247 * @param dicom The worklist to answer, encoded as a DICOM file.
|
|
|
4248 * @param size The size of the DICOM file.
|
|
|
4249 * @return 1 if the worklist matches the query, 0 otherwise.
|
|
|
4250 * @ingroup Worklists
|
|
|
4251 **/
|
|
|
4252 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginWorklistIsMatch(
|
|
|
4253 OrthancPluginContext* context,
|
|
|
4254 const OrthancPluginWorklistQuery* query,
|
|
|
4255 const void* dicom,
|
|
|
4256 uint32_t size)
|
|
|
4257 {
|
|
|
4258 int32_t isMatch = 0;
|
|
|
4259
|
|
|
4260 _OrthancPluginWorklistQueryOperation params;
|
|
|
4261 params.query = query;
|
|
|
4262 params.dicom = dicom;
|
|
|
4263 params.size = size;
|
|
|
4264 params.isMatch = &isMatch;
|
|
|
4265 params.target = NULL;
|
|
|
4266
|
|
|
4267 if (context->InvokeService(context, _OrthancPluginService_WorklistIsMatch, ¶ms) == OrthancPluginErrorCode_Success)
|
|
|
4268 {
|
|
|
4269 return isMatch;
|
|
|
4270 }
|
|
|
4271 else
|
|
|
4272 {
|
|
|
4273 /* Error: Assume non-match */
|
|
|
4274 return 0;
|
|
|
4275 }
|
|
|
4276 }
|
|
|
4277
|
|
|
4278
|
|
|
4279 /**
|
|
|
4280 * @brief Retrieve the worklist query as a DICOM file.
|
|
|
4281 *
|
|
|
4282 * This function retrieves the DICOM file that underlies a C-Find
|
|
|
4283 * SCP query against modality worklists.
|
|
|
4284 *
|
|
|
4285 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4286 * @param target Memory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
4287 * @param query The worklist query, as received by the callback.
|
|
|
4288 * @return 0 if success, other value if error.
|
|
|
4289 * @ingroup Worklists
|
|
|
4290 **/
|
|
|
4291 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(
|
|
|
4292 OrthancPluginContext* context,
|
|
|
4293 OrthancPluginMemoryBuffer* target,
|
|
|
4294 const OrthancPluginWorklistQuery* query)
|
|
|
4295 {
|
|
|
4296 _OrthancPluginWorklistQueryOperation params;
|
|
|
4297 params.query = query;
|
|
|
4298 params.dicom = NULL;
|
|
|
4299 params.size = 0;
|
|
|
4300 params.isMatch = NULL;
|
|
|
4301 params.target = target;
|
|
|
4302
|
|
|
4303 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
|
|
|
4304 }
|
|
|
4305
|
|
|
4306
|
|
|
4307 /**
|
|
|
4308 * @brief Get the origin of a DICOM file.
|
|
|
4309 *
|
|
|
4310 * This function returns the origin of a DICOM instance that has been received by Orthanc.
|
|
|
4311 *
|
|
|
4312 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4313 * @param instance The instance of interest.
|
|
|
4314 * @return The origin of the instance.
|
|
|
4315 * @ingroup Callbacks
|
|
|
4316 **/
|
|
|
4317 ORTHANC_PLUGIN_INLINE OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(
|
|
|
4318 OrthancPluginContext* context,
|
|
|
4319 OrthancPluginDicomInstance* instance)
|
|
|
4320 {
|
|
|
4321 OrthancPluginInstanceOrigin origin;
|
|
|
4322
|
|
|
4323 _OrthancPluginAccessDicomInstance params;
|
|
|
4324 memset(¶ms, 0, sizeof(params));
|
|
|
4325 params.resultOrigin = &origin;
|
|
|
4326 params.instance = instance;
|
|
|
4327
|
|
|
4328 if (context->InvokeService(context, _OrthancPluginService_GetInstanceOrigin, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4329 {
|
|
|
4330 /* Error */
|
|
|
4331 return OrthancPluginInstanceOrigin_Unknown;
|
|
|
4332 }
|
|
|
4333 else
|
|
|
4334 {
|
|
|
4335 return origin;
|
|
|
4336 }
|
|
|
4337 }
|
|
|
4338
|
|
|
4339
|
|
|
4340 typedef struct
|
|
|
4341 {
|
|
|
4342 OrthancPluginMemoryBuffer* target;
|
|
|
4343 const char* json;
|
|
|
4344 const OrthancPluginImage* pixelData;
|
|
|
4345 OrthancPluginCreateDicomFlags flags;
|
|
|
4346 } _OrthancPluginCreateDicom;
|
|
|
4347
|
|
|
4348 /**
|
|
|
4349 * @brief Create a DICOM instance from a JSON string and an image.
|
|
|
4350 *
|
|
|
4351 * This function takes as input a string containing a JSON file
|
|
|
4352 * describing the content of a DICOM instance. As an output, it
|
|
|
4353 * writes the corresponding DICOM instance to a newly allocated
|
|
|
4354 * memory buffer. Additionally, an image to be encoded within the
|
|
|
4355 * DICOM instance can also be provided.
|
|
|
4356 *
|
|
|
4357 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4358 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
|
|
|
4359 * @param json The input JSON file.
|
|
|
4360 * @param pixelData The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme.
|
|
|
4361 * @param flags Flags governing the output.
|
|
|
4362 * @return 0 if success, other value if error.
|
|
|
4363 * @ingroup Toolbox
|
|
|
4364 * @see OrthancPluginDicomBufferToJson
|
|
|
4365 **/
|
|
|
4366 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateDicom(
|
|
|
4367 OrthancPluginContext* context,
|
|
|
4368 OrthancPluginMemoryBuffer* target,
|
|
|
4369 const char* json,
|
|
|
4370 const OrthancPluginImage* pixelData,
|
|
|
4371 OrthancPluginCreateDicomFlags flags)
|
|
|
4372 {
|
|
|
4373 _OrthancPluginCreateDicom params;
|
|
|
4374 params.target = target;
|
|
|
4375 params.json = json;
|
|
|
4376 params.pixelData = pixelData;
|
|
|
4377 params.flags = flags;
|
|
|
4378
|
|
|
4379 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
|
|
|
4380 }
|
|
|
4381
|
|
|
4382
|
|
|
4383 typedef struct
|
|
|
4384 {
|
|
|
4385 OrthancPluginDecodeImageCallback callback;
|
|
|
4386 } _OrthancPluginDecodeImageCallback;
|
|
|
4387
|
|
|
4388 /**
|
|
|
4389 * @brief Register a callback to handle the decoding of DICOM images.
|
|
|
4390 *
|
|
|
4391 * This function registers a custom callback to the decoding of
|
|
|
4392 * DICOM images, replacing the built-in decoder of Orthanc.
|
|
|
4393 *
|
|
|
4394 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4395 * @param callback The callback.
|
|
|
4396 * @return 0 if success, other value if error.
|
|
|
4397 * @ingroup Callbacks
|
|
|
4398 **/
|
|
|
4399 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(
|
|
|
4400 OrthancPluginContext* context,
|
|
|
4401 OrthancPluginDecodeImageCallback callback)
|
|
|
4402 {
|
|
|
4403 _OrthancPluginDecodeImageCallback params;
|
|
|
4404 params.callback = callback;
|
|
|
4405
|
|
|
4406 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
|
|
|
4407 }
|
|
|
4408
|
|
|
4409
|
|
|
4410
|
|
|
4411 typedef struct
|
|
|
4412 {
|
|
|
4413 OrthancPluginImage** target;
|
|
|
4414 OrthancPluginPixelFormat format;
|
|
|
4415 uint32_t width;
|
|
|
4416 uint32_t height;
|
|
|
4417 uint32_t pitch;
|
|
|
4418 void* buffer;
|
|
|
4419 const void* constBuffer;
|
|
|
4420 uint32_t bufferSize;
|
|
|
4421 uint32_t frameIndex;
|
|
|
4422 } _OrthancPluginCreateImage;
|
|
|
4423
|
|
|
4424
|
|
|
4425 /**
|
|
|
4426 * @brief Create an image.
|
|
|
4427 *
|
|
|
4428 * This function creates an image of given size and format.
|
|
|
4429 *
|
|
|
4430 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4431 * @param format The format of the pixels.
|
|
|
4432 * @param width The width of the image.
|
|
|
4433 * @param height The height of the image.
|
|
|
4434 * @return The newly allocated image. It must be freed with OrthancPluginFreeImage().
|
|
|
4435 * @ingroup Images
|
|
|
4436 **/
|
|
|
4437 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImage(
|
|
|
4438 OrthancPluginContext* context,
|
|
|
4439 OrthancPluginPixelFormat format,
|
|
|
4440 uint32_t width,
|
|
|
4441 uint32_t height)
|
|
|
4442 {
|
|
|
4443 OrthancPluginImage* target = NULL;
|
|
|
4444
|
|
|
4445 _OrthancPluginCreateImage params;
|
|
|
4446 memset(¶ms, 0, sizeof(params));
|
|
|
4447 params.target = ⌖
|
|
|
4448 params.format = format;
|
|
|
4449 params.width = width;
|
|
|
4450 params.height = height;
|
|
|
4451
|
|
|
4452 if (context->InvokeService(context, _OrthancPluginService_CreateImage, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4453 {
|
|
|
4454 return NULL;
|
|
|
4455 }
|
|
|
4456 else
|
|
|
4457 {
|
|
|
4458 return target;
|
|
|
4459 }
|
|
|
4460 }
|
|
|
4461
|
|
|
4462
|
|
|
4463 /**
|
|
|
4464 * @brief Create an image pointing to a memory buffer.
|
|
|
4465 *
|
|
|
4466 * This function creates an image whose content points to a memory
|
|
|
4467 * buffer managed by the plugin. Note that the buffer is directly
|
|
|
4468 * accessed, no memory is allocated and no data is copied.
|
|
|
4469 *
|
|
|
4470 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4471 * @param format The format of the pixels.
|
|
|
4472 * @param width The width of the image.
|
|
|
4473 * @param height The height of the image.
|
|
|
4474 * @param pitch The pitch of the image (i.e. the number of bytes
|
|
|
4475 * between 2 successive lines of the image in the memory buffer).
|
|
|
4476 * @param buffer The memory buffer.
|
|
|
4477 * @return The newly allocated image. It must be freed with OrthancPluginFreeImage().
|
|
|
4478 * @ingroup Images
|
|
|
4479 **/
|
|
|
4480 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImageAccessor(
|
|
|
4481 OrthancPluginContext* context,
|
|
|
4482 OrthancPluginPixelFormat format,
|
|
|
4483 uint32_t width,
|
|
|
4484 uint32_t height,
|
|
|
4485 uint32_t pitch,
|
|
|
4486 void* buffer)
|
|
|
4487 {
|
|
|
4488 OrthancPluginImage* target = NULL;
|
|
|
4489
|
|
|
4490 _OrthancPluginCreateImage params;
|
|
|
4491 memset(¶ms, 0, sizeof(params));
|
|
|
4492 params.target = ⌖
|
|
|
4493 params.format = format;
|
|
|
4494 params.width = width;
|
|
|
4495 params.height = height;
|
|
|
4496 params.pitch = pitch;
|
|
|
4497 params.buffer = buffer;
|
|
|
4498
|
|
|
4499 if (context->InvokeService(context, _OrthancPluginService_CreateImageAccessor, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4500 {
|
|
|
4501 return NULL;
|
|
|
4502 }
|
|
|
4503 else
|
|
|
4504 {
|
|
|
4505 return target;
|
|
|
4506 }
|
|
|
4507 }
|
|
|
4508
|
|
|
4509
|
|
|
4510
|
|
|
4511 /**
|
|
|
4512 * @brief Decode one frame from a DICOM instance.
|
|
|
4513 *
|
|
|
4514 * This function decodes one frame of a DICOM image that is stored
|
|
|
4515 * in a memory buffer. This function will give the same result as
|
|
|
4516 * OrthancPluginUncompressImage() for single-frame DICOM images.
|
|
|
4517 *
|
|
|
4518 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4519 * @param buffer Pointer to a memory buffer containing the DICOM image.
|
|
|
4520 * @param bufferSize Size of the memory buffer containing the DICOM image.
|
|
|
4521 * @param frameIndex The index of the frame of interest in a multi-frame image.
|
|
|
4522 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage().
|
|
|
4523 * @ingroup Images
|
|
|
4524 **/
|
|
|
4525 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginDecodeDicomImage(
|
|
|
4526 OrthancPluginContext* context,
|
|
|
4527 const void* buffer,
|
|
|
4528 uint32_t bufferSize,
|
|
|
4529 uint32_t frameIndex)
|
|
|
4530 {
|
|
|
4531 OrthancPluginImage* target = NULL;
|
|
|
4532
|
|
|
4533 _OrthancPluginCreateImage params;
|
|
|
4534 memset(¶ms, 0, sizeof(params));
|
|
|
4535 params.target = ⌖
|
|
|
4536 params.constBuffer = buffer;
|
|
|
4537 params.bufferSize = bufferSize;
|
|
|
4538 params.frameIndex = frameIndex;
|
|
|
4539
|
|
|
4540 if (context->InvokeService(context, _OrthancPluginService_DecodeDicomImage, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4541 {
|
|
|
4542 return NULL;
|
|
|
4543 }
|
|
|
4544 else
|
|
|
4545 {
|
|
|
4546 return target;
|
|
|
4547 }
|
|
|
4548 }
|
|
|
4549
|
|
|
4550
|
|
|
4551
|
|
|
4552 typedef struct
|
|
|
4553 {
|
|
|
4554 char** result;
|
|
|
4555 const void* buffer;
|
|
|
4556 uint32_t size;
|
|
|
4557 } _OrthancPluginComputeHash;
|
|
|
4558
|
|
|
4559 /**
|
|
|
4560 * @brief Compute an MD5 hash.
|
|
|
4561 *
|
|
|
4562 * This functions computes the MD5 cryptographic hash of the given memory buffer.
|
|
|
4563 *
|
|
|
4564 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4565 * @param buffer The source memory buffer.
|
|
|
4566 * @param size The size in bytes of the source buffer.
|
|
|
4567 * @return The NULL value in case of error, or a string containing the cryptographic hash.
|
|
|
4568 * This string must be freed by OrthancPluginFreeString().
|
|
|
4569 * @ingroup Toolbox
|
|
|
4570 **/
|
|
|
4571 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeMd5(
|
|
|
4572 OrthancPluginContext* context,
|
|
|
4573 const void* buffer,
|
|
|
4574 uint32_t size)
|
|
|
4575 {
|
|
|
4576 char* result;
|
|
|
4577
|
|
|
4578 _OrthancPluginComputeHash params;
|
|
|
4579 params.result = &result;
|
|
|
4580 params.buffer = buffer;
|
|
|
4581 params.size = size;
|
|
|
4582
|
|
|
4583 if (context->InvokeService(context, _OrthancPluginService_ComputeMd5, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4584 {
|
|
|
4585 /* Error */
|
|
|
4586 return NULL;
|
|
|
4587 }
|
|
|
4588 else
|
|
|
4589 {
|
|
|
4590 return result;
|
|
|
4591 }
|
|
|
4592 }
|
|
|
4593
|
|
|
4594
|
|
|
4595 /**
|
|
|
4596 * @brief Compute a SHA-1 hash.
|
|
|
4597 *
|
|
|
4598 * This functions computes the SHA-1 cryptographic hash of the given memory buffer.
|
|
|
4599 *
|
|
|
4600 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
|
|
|
4601 * @param buffer The source memory buffer.
|
|
|
4602 * @param size The size in bytes of the source buffer.
|
|
|
4603 * @return The NULL value in case of error, or a string containing the cryptographic hash.
|
|
|
4604 * This string must be freed by OrthancPluginFreeString().
|
|
|
4605 * @ingroup Toolbox
|
|
|
4606 **/
|
|
|
4607 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeSha1(
|
|
|
4608 OrthancPluginContext* context,
|
|
|
4609 const void* buffer,
|
|
|
4610 uint32_t size)
|
|
|
4611 {
|
|
|
4612 char* result;
|
|
|
4613
|
|
|
4614 _OrthancPluginComputeHash params;
|
|
|
4615 params.result = &result;
|
|
|
4616 params.buffer = buffer;
|
|
|
4617 params.size = size;
|
|
|
4618
|
|
|
4619 if (context->InvokeService(context, _OrthancPluginService_ComputeSha1, ¶ms) != OrthancPluginErrorCode_Success)
|
|
|
4620 {
|
|
|
4621 /* Error */
|
|
|
4622 return NULL;
|
|
|
4623 }
|
|
|
4624 else
|
|
|
4625 {
|
|
|
4626 return result;
|
|
|
4627 }
|
|
|
4628 }
|
|
|
4629
|
|
78
|
4630 #ifdef __cplusplus
|
|
|
4631 }
|
|
|
4632 #endif
|
|
|
4633
|
|
|
4634
|
|
|
4635 /** @} */
|
|
|
4636
|
