Mercurial > hg > orthanc
annotate Plugins/OrthancCPlugin/OrthancCPlugin.h @ 908:e078ea944089 plugins
refactoring HttpOutput
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 19 Jun 2014 17:47:39 +0200 |
| parents | 9b8298234254 |
| children | dcb2469f00f4 |
| rev | line source |
|---|---|
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
1 /** |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
2 * \mainpage |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
3 * |
| 907 | 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 | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
7 * signatures: |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
8 * |
| 907 | 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 store the context pointer so that it can use the plugin | |
| 12 * services of Orthanc. It must also register all its callbacks using | |
| 13 * ::OrthancPluginRegisterRestCallback(). | |
| 14 * -# <tt>void OrthancPluginFinalize()</tt>: | |
| 15 * This function is invoked by Orthanc during its shutdown. The plugin | |
| 16 * must free all its memory. | |
| 17 * -# <tt>const char* OrthancPluginGetName()</tt>: | |
| 18 * The plugin must return a short string to identify itself. | |
| 19 * -# <tt>const char* OrthancPluginGetVersion()</tt> | |
| 20 * The plugin must return a string containing its version number. | |
| 21 * | |
| 22 * The name and the version of a plugin is only used to prevent it | |
| 23 * from being loaded twice. | |
| 24 * | |
| 25 * | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
26 **/ |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
27 |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
28 |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
29 |
| 900 | 30 /** |
| 31 * @defgroup CInterface C Interface | |
| 32 * @brief The C interface to create Orthanc plugins. | |
| 33 * | |
| 34 * These functions must be used to create C plugins for Orthanc. | |
| 35 **/ | |
| 36 | |
| 37 | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
38 |
| 886 | 39 /** |
| 40 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 41 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, | |
| 42 * Belgium | |
| 43 * | |
| 44 * This program is free software: you can redistribute it and/or | |
| 45 * modify it under the terms of the GNU General Public License as | |
| 46 * published by the Free Software Foundation, either version 3 of the | |
| 47 * License, or (at your option) any later version. | |
| 48 * | |
| 49 * In addition, as a special exception, the copyright holders of this | |
| 50 * program give permission to link the code of its release with the | |
| 51 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 52 * that use the same license as the "OpenSSL" library), and distribute | |
| 53 * the linked executables. You must obey the GNU General Public License | |
| 54 * in all respects for all of the code used other than "OpenSSL". If you | |
| 55 * modify file(s) with this exception, you may extend this exception to | |
| 56 * your version of the file(s), but you are not obligated to do so. If | |
| 57 * you do not wish to do so, delete this exception statement from your | |
| 58 * version. If you delete this exception statement from all source files | |
| 59 * in the program, then also delete it here. | |
| 60 * | |
| 61 * This program is distributed in the hope that it will be useful, but | |
| 62 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 63 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 64 * General Public License for more details. | |
| 65 * | |
| 66 * You should have received a copy of the GNU General Public License | |
| 67 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 68 **/ | |
| 69 | |
| 70 | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
71 |
| 886 | 72 #pragma once |
| 73 | |
| 74 | |
| 900 | 75 #include <stdio.h> |
| 76 #include <string.h> | |
| 77 | |
| 886 | 78 #ifdef WIN32 |
| 79 #define ORTHANC_PLUGINS_API __declspec(dllexport) | |
| 80 #else | |
| 81 #define ORTHANC_PLUGINS_API | |
| 82 #endif | |
| 83 | |
| 84 | |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
85 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
86 /******************************************************************** |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
87 ** Check that function inlining is properly supported. The use of |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
88 ** inlining is required, to avoid the duplication of object code |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
89 ** between two compilation modules that would use the Orthanc Plugin |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
90 ** API. |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
91 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
92 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
93 /* If the auto-detection of the "inline" keyword below does not work |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
94 automatically and that your compiler is known to properly support |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
95 inlining, uncomment the following #define and adapt the definition |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
96 of "static inline". */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
97 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
98 /* #define ORTHANC_PLUGIN_INLINE static inline */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
99 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
100 #ifndef ORTHANC_PLUGIN_INLINE |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
101 # if __STDC_VERSION__ >= 199901L |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
102 /* This is C99 or above: http://predef.sourceforge.net/prestd.html */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
103 # define ORTHANC_PLUGIN_INLINE static inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
104 # elif defined(__cplusplus) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
105 /* This is C++ */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
106 # define ORTHANC_PLUGIN_INLINE static inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
107 # elif defined(__GNUC__) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
108 /* This is GCC running in C89 mode */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
109 # define ORTHANC_PLUGIN_INLINE static __inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
110 # elif defined(_MSC_VER) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
111 /* This is Visual Studio running in C89 mode */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
112 # define ORTHANC_PLUGIN_INLINE static __inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
113 # else |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
114 # error Your compiler is not known to support the "inline" keyword |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
115 # endif |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
116 #endif |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
117 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
118 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
119 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
120 /******************************************************************** |
| 907 | 121 ** Inclusion of standard libraries. |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
122 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
123 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
124 #ifdef _MSC_VER |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
125 #include "../../Resources/VisualStudio/stdint.h" |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
126 #else |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
127 #include <stdint.h> |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
128 #endif |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
129 |
| 886 | 130 #include <stdlib.h> |
| 131 | |
| 132 | |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
133 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
134 /******************************************************************** |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
135 ** Definition of the Orthanc Plugin API. |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
136 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
137 |
| 900 | 138 /** @{ */ |
| 139 | |
| 886 | 140 #ifdef __cplusplus |
| 141 extern "C" | |
| 142 { | |
| 143 #endif | |
| 144 | |
| 907 | 145 /** |
| 146 * The various HTTP methods for a REST call. | |
| 147 **/ | |
| 894 | 148 typedef enum |
| 149 { | |
| 907 | 150 OrthancPluginHttpMethod_Get = 1, /*!< GET request */ |
| 151 OrthancPluginHttpMethod_Post = 2, /*!< POST request */ | |
| 152 OrthancPluginHttpMethod_Put = 3, /*!< PUT request */ | |
| 153 OrthancPluginHttpMethod_Delete = 4 /*!< DELETE request */ | |
| 896 | 154 } OrthancPluginHttpMethod; |
| 886 | 155 |
| 907 | 156 |
| 157 /** | |
| 158 * @brief The parameters of a REST request. | |
| 159 **/ | |
| 899 | 160 typedef struct |
| 161 { | |
| 907 | 162 /** |
| 163 * @brief The HTTP method. | |
| 164 **/ | |
| 165 OrthancPluginHttpMethod method; | |
| 899 | 166 |
| 907 | 167 /** |
| 168 * @brief The number of groups of the regular expression. | |
| 169 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
170 uint32_t groupsCount; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
171 |
| 907 | 172 /** |
| 173 * @brief The matched values for the groups of the regular expression. | |
| 174 **/ | |
| 175 const char* const* groups; | |
| 176 | |
| 177 /** | |
| 178 * @brief For a GET request, the number of GET parameters. | |
| 179 **/ | |
| 899 | 180 uint32_t getCount; |
| 181 | |
| 907 | 182 /** |
| 183 * @brief For a GET request, the keys of the GET parameters. | |
| 184 **/ | |
| 185 const char* const* getKeys; | |
| 186 | |
| 187 /** | |
| 188 * @brief For a GET request, the values of the GET parameters. | |
| 189 **/ | |
| 190 const char* const* getValues; | |
| 191 | |
| 192 /** | |
| 193 * @brief For a PUT or POST request, the content of the body. | |
| 194 **/ | |
| 899 | 195 const char* body; |
| 907 | 196 |
| 197 /** | |
| 198 * @brief For a PUT or POST request, the number of bytes of the body. | |
| 199 **/ | |
| 899 | 200 uint32_t bodySize; |
| 201 } OrthancPluginHttpRequest; | |
| 202 | |
| 900 | 203 typedef enum |
| 886 | 204 { |
| 900 | 205 /* Generic services */ |
| 907 | 206 _OrthancPluginService_LogInfo = 1, |
| 207 _OrthancPluginService_LogWarning = 2, | |
| 208 _OrthancPluginService_LogError = 3, | |
| 900 | 209 |
| 210 /* Registration of callbacks */ | |
| 907 | 211 _OrthancPluginService_RegisterRestCallback = 1000, |
| 900 | 212 |
| 213 /* Sending answers to REST calls */ | |
| 907 | 214 _OrthancPluginService_AnswerBuffer = 2000, |
| 215 _OrthancPluginService_CompressAndAnswerPngImage = 2001, | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
216 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
217 /* Access to the Orthanc database */ |
| 907 | 218 _OrthancPluginService_GetDicomForInstance = 3000 |
| 219 } _OrthancPluginService; | |
| 900 | 220 |
| 221 | |
| 222 | |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
223 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
224 * The memory layout of the pixels of an image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
225 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
226 typedef enum |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
227 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
228 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
229 * @brief Graylevel 8bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
230 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
231 * The image is graylevel. Each pixel is unsigned and stored in |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
232 * one byte. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
233 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
234 OrthancPluginPixelFormat_Grayscale8 = 1, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
235 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
236 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
237 * @brief Graylevel, unsigned 16bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
238 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
239 * The image is graylevel. Each pixel is unsigned and stored in |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
240 * two bytes. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
241 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
242 OrthancPluginPixelFormat_Grayscale16 = 2, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
243 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
244 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
245 * @brief Graylevel, signed 16bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
246 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
247 * The image is graylevel. Each pixel is signed and stored in two |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
248 * bytes. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
249 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
250 OrthancPluginPixelFormat_SignedGrayscale16 = 3, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
251 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
252 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
253 * @brief Color image in RGB24 format. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
254 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
255 * This format describes a color image. The pixels are stored in 3 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
256 * consecutive bytes. The memory layout is RGB. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
257 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
258 OrthancPluginPixelFormat_RGB24 = 4, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
259 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
260 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
261 * @brief Color image in RGBA32 format. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
262 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
263 * This format describes a color image. The pixels are stored in 4 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
264 * consecutive bytes. The memory layout is RGBA. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
265 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
266 OrthancPluginPixelFormat_RGBA32 = 5 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
267 } OrthancPluginPixelFormat; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
268 |
| 894 | 269 |
| 907 | 270 /** |
| 271 * @brief A memory buffer allocated by the core system of Orthanc. | |
| 272 * | |
| 273 * A memory buffer allocated by the core system of Orthanc. When the | |
| 274 * content of the buffer is not useful anymore, it must be free by a | |
| 275 * call to ::OrthancPluginFreeMemoryBuffer(). | |
| 276 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
277 typedef struct |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
278 { |
| 907 | 279 /** |
| 280 * @brief The content of the buffer. | |
| 281 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
282 void* data; |
| 907 | 283 |
| 284 /** | |
| 285 * @brief The number of bytes in the buffer. | |
| 286 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
287 uint32_t size; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
288 } OrthancPluginMemoryBuffer; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
289 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
290 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
291 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
292 |
| 907 | 293 /** |
| 294 * @brief Opaque structure that represents the HTTP connection to the client application. | |
| 295 **/ | |
| 900 | 296 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput; |
| 297 | |
| 907 | 298 |
| 299 /** | |
|
908
e078ea944089
refactoring HttpOutput
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
907
diff
changeset
|
300 * @brief Signature of a callback function that answers to a REST request. |
| 907 | 301 **/ |
| 900 | 302 typedef int32_t (*OrthancPluginRestCallback) ( |
| 303 OrthancPluginRestOutput* output, | |
| 304 const char* url, | |
| 305 const OrthancPluginHttpRequest* request); | |
| 306 | |
| 907 | 307 |
| 308 /** | |
| 309 * @brief Opaque structure that contains information about the Orthanc core. | |
| 310 **/ | |
| 900 | 311 typedef struct _OrthancPluginContext_t |
| 312 { | |
| 313 void* pluginsManager; | |
| 314 const char* orthancVersion; | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
315 void (*Free) (void* buffer); |
| 900 | 316 int32_t (*InvokeService) (struct _OrthancPluginContext_t* context, |
| 907 | 317 _OrthancPluginService service, |
| 900 | 318 const void* params); |
| 899 | 319 } OrthancPluginContext; |
| 320 | |
| 886 | 321 |
| 907 | 322 |
| 323 /** | |
| 324 * @brief Free a string. | |
| 325 * | |
| 326 * Free a string that was allocated by the core system of Orthanc. | |
| 327 * | |
| 328 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 329 * @param str The string to be freed. | |
| 330 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
331 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString( |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
332 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
333 char* str) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
334 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
335 context->Free(str); |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
336 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
337 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
338 |
| 907 | 339 /** |
| 340 * @brief Free a memory buffer. | |
| 341 * | |
| 342 * Free a memory buffer that was allocated by the core system of Orthanc. | |
| 343 * | |
| 344 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 345 * @param buffer The memory buffer to release. | |
| 346 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
347 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer( |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
348 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
349 OrthancPluginMemoryBuffer* buffer) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
350 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
351 context->Free(buffer->data); |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
352 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
353 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
354 |
| 907 | 355 /** |
| 356 * @brief Log an error. | |
| 357 * | |
| 358 * Log an error message using the Orthanc logging system. | |
| 359 * | |
| 360 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 361 * @param message The message to be logged. | |
| 362 **/ | |
| 900 | 363 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError( |
| 364 OrthancPluginContext* context, | |
| 907 | 365 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
366 { |
| 907 | 367 context->InvokeService(context, _OrthancPluginService_LogError, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
368 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
369 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
370 |
| 907 | 371 /** |
| 372 * @brief Log a warning. | |
| 373 * | |
| 374 * Log a warning message using the Orthanc logging system. | |
| 375 * | |
| 376 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 377 * @param message The message to be logged. | |
| 378 **/ | |
| 900 | 379 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning( |
| 380 OrthancPluginContext* context, | |
| 907 | 381 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
382 { |
| 907 | 383 context->InvokeService(context, _OrthancPluginService_LogWarning, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
384 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
385 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
386 |
| 907 | 387 /** |
| 388 * @brief Log an information. | |
| 389 * | |
| 390 * Log an information message using the Orthanc logging system. | |
| 391 * | |
| 392 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 393 * @param message The message to be logged. | |
| 394 **/ | |
| 900 | 395 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo( |
| 396 OrthancPluginContext* context, | |
| 907 | 397 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
398 { |
| 907 | 399 context->InvokeService(context, _OrthancPluginService_LogInfo, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
400 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
401 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
402 |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
403 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
404 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
405 const char* pathRegularExpression; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
406 OrthancPluginRestCallback callback; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
407 } _OrthancPluginRestCallback; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
408 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
409 |
| 907 | 410 /** |
| 411 * @brief Register a REST callback. | |
| 412 * | |
| 413 * This function registers a REST callback against a regular | |
| 414 * expression for a URI. This function must be called during the | |
| 415 * initialization of the plugin, i.e. inside the | |
| 416 * OrthancPluginInitialize() public function. | |
| 417 * | |
| 418 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 419 * @param pathRegularExpression Regular expression for the URI. May contain groups. | |
| 420 * @param callback The callback function to handle the REST call. | |
| 421 **/ | |
| 900 | 422 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback( |
| 423 OrthancPluginContext* context, | |
| 424 const char* pathRegularExpression, | |
| 425 OrthancPluginRestCallback callback) | |
| 899 | 426 { |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
427 _OrthancPluginRestCallback params; |
| 899 | 428 params.pathRegularExpression = pathRegularExpression; |
| 429 params.callback = callback; | |
| 907 | 430 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms); |
| 899 | 431 } |
| 432 | |
| 433 | |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
434 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
435 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
436 OrthancPluginRestOutput* output; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
437 const char* answer; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
438 uint32_t answerSize; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
439 const char* mimeType; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
440 } _OrthancPluginAnswerBuffer; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
441 |
| 907 | 442 |
| 443 /** | |
| 444 * @brief Answer to a REST request. | |
| 445 * | |
| 446 * This function answers to a REST request with the content of a memory buffer. | |
| 447 * | |
| 448 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 449 * @param output The HTTP connection to the client application. | |
| 450 * @param answer Pointer to the memory buffer containing the answer. | |
| 451 * @param answerSize Number of bytes of the answer. | |
| 452 * @param mimeType The MIME type of the answer. | |
| 453 **/ | |
| 900 | 454 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer( |
| 455 OrthancPluginContext* context, | |
| 456 OrthancPluginRestOutput* output, | |
| 457 const char* answer, | |
| 458 uint32_t answerSize, | |
| 459 const char* mimeType) | |
| 899 | 460 { |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
461 _OrthancPluginAnswerBuffer params; |
| 899 | 462 params.output = output; |
| 463 params.answer = answer; | |
| 464 params.answerSize = answerSize; | |
| 465 params.mimeType = mimeType; | |
| 907 | 466 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms); |
| 899 | 467 } |
| 468 | |
| 469 | |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
470 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
471 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
472 OrthancPluginRestOutput* output; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
473 OrthancPluginPixelFormat format; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
474 uint32_t width; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
475 uint32_t height; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
476 uint32_t pitch; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
477 const void* buffer; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
478 } _OrthancPluginCompressAndAnswerPngImage; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
479 |
| 907 | 480 /** |
| 481 * @brief Answer to a REST request with a PNG image. | |
| 482 * | |
| 483 * This function answers to a REST request with a PNG image. The | |
| 484 * parameters of this function describe a memory buffer that | |
| 485 * contains an uncompressed image. The image will be automatically compressed | |
| 486 * as a PNG image by the core system of Orthanc. | |
| 487 * | |
| 488 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 489 * @param output The HTTP connection to the client application. | |
| 490 * @param format The memory layout of the uncompressed image. | |
| 491 * @param width The width of the image. | |
| 492 * @param height The height of the image. | |
| 493 * @param pitch The pitch of the image (i.e. the number of bytes | |
| 494 * between 2 successive lines of the image in the memory buffer. | |
| 495 * @param buffer The memory buffer containing the uncompressed image. | |
| 496 **/ | |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
497 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage( |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
498 OrthancPluginContext* context, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
499 OrthancPluginRestOutput* output, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
500 OrthancPluginPixelFormat format, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
501 uint32_t width, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
502 uint32_t height, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
503 uint32_t pitch, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
504 const void* buffer) |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
505 { |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
506 _OrthancPluginCompressAndAnswerPngImage params; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
507 params.output = output; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
508 params.format = format; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
509 params.width = width; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
510 params.height = height; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
511 params.pitch = pitch; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
512 params.buffer = buffer; |
| 907 | 513 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerPngImage, ¶ms); |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
514 } |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
515 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
516 |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
517 typedef struct |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
518 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
519 OrthancPluginMemoryBuffer* target; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
520 const char* instanceId; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
521 } _OrthancPluginGetDicomForInstance; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
522 |
| 907 | 523 |
| 524 /** | |
| 525 * @brief Retrieve a DICOM instance using its Orthanc identifier. | |
| 526 * | |
| 527 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM | |
| 528 * file is stored into a newly allocated memory buffer. | |
| 529 * | |
| 530 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 531 * @param target The target memory buffer. | |
| 532 * @param instanceId The Orthanc identifier of the DICOM instance of interest. | |
| 533 * @return 0 if success, other value if error. | |
| 534 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
535 ORTHANC_PLUGIN_INLINE int OrthancPluginGetDicomForInstance( |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
536 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
537 OrthancPluginMemoryBuffer* target, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
538 const char* instanceId) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
539 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
540 _OrthancPluginGetDicomForInstance params; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
541 params.target = target; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
542 params.instanceId = instanceId; |
| 907 | 543 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms); |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
544 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
545 |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
546 |
| 886 | 547 #ifdef __cplusplus |
| 548 } | |
| 549 #endif | |
| 900 | 550 |
| 551 | |
| 552 /** @} */ | |
| 553 |