84 #define ORTHANC_PLUGINS_API __declspec(dllexport)
86 #define ORTHANC_PLUGINS_API
89 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
90 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 8
91 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 3
109 #ifndef ORTHANC_PLUGIN_INLINE
110 # if __STDC_VERSION__ >= 199901L
112 # define ORTHANC_PLUGIN_INLINE static inline
113 # elif defined(__cplusplus)
115 # define ORTHANC_PLUGIN_INLINE static inline
116 # elif defined(__GNUC__)
118 # define ORTHANC_PLUGIN_INLINE static __inline
119 # elif defined(_MSC_VER)
121 # define ORTHANC_PLUGIN_INLINE static __inline
123 # error Your compiler is not known to support the "inline" keyword
134 #include "../../Resources/ThirdParty/VisualStudio/stdint.h"
237 _OrthancPluginService_LogInfo = 1,
238 _OrthancPluginService_LogWarning = 2,
239 _OrthancPluginService_LogError = 3,
240 _OrthancPluginService_GetOrthancPath = 4,
241 _OrthancPluginService_GetOrthancDirectory = 5,
242 _OrthancPluginService_GetConfigurationPath = 6,
245 _OrthancPluginService_RegisterRestCallback = 1000,
246 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
247 _OrthancPluginService_RegisterStorageArea = 1002,
250 _OrthancPluginService_AnswerBuffer = 2000,
251 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
252 _OrthancPluginService_Redirect = 2002,
253 _OrthancPluginService_SendHttpStatusCode = 2003,
254 _OrthancPluginService_SendUnauthorized = 2004,
255 _OrthancPluginService_SendMethodNotAllowed = 2005,
256 _OrthancPluginService_SetCookie = 2006,
257 _OrthancPluginService_SetHttpHeader = 2007,
260 _OrthancPluginService_GetDicomForInstance = 3000,
261 _OrthancPluginService_RestApiGet = 3001,
262 _OrthancPluginService_RestApiPost = 3002,
263 _OrthancPluginService_RestApiDelete = 3003,
264 _OrthancPluginService_RestApiPut = 3004,
265 _OrthancPluginService_LookupPatient = 3005,
266 _OrthancPluginService_LookupStudy = 3006,
267 _OrthancPluginService_LookupSeries = 3007,
268 _OrthancPluginService_LookupInstance = 3008,
269 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
272 _OrthancPluginService_GetInstanceRemoteAet = 4000,
273 _OrthancPluginService_GetInstanceSize = 4001,
274 _OrthancPluginService_GetInstanceData = 4002,
275 _OrthancPluginService_GetInstanceJson = 4003,
276 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
277 _OrthancPluginService_HasInstanceMetadata = 4005,
278 _OrthancPluginService_GetInstanceMetadata = 4006
279 } _OrthancPluginService;
395 const char* instanceId);
462 typedef struct _OrthancPluginContext_t
464 void* pluginsManager;
465 const char* orthancVersion;
467 int32_t (*InvokeService) (
struct _OrthancPluginContext_t* context,
468 _OrthancPluginService service,
508 int major, minor, revision;
511 if (!strcmp(context->orthancVersion,
"mainline"))
523 (context->orthancVersion,
"%d.%d.%d", &major, &minor, &revision) != 3)
530 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
535 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
542 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
547 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
554 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
577 context->Free(buffer->
data);
593 context->InvokeService(context, _OrthancPluginService_LogError, message);
609 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
625 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
632 const char* pathRegularExpression;
634 } _OrthancPluginRestCallback;
650 const char* pathRegularExpression,
653 _OrthancPluginRestCallback params;
654 params.pathRegularExpression = pathRegularExpression;
655 params.callback = callback;
656 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
664 } _OrthancPluginOnStoredInstanceCallback;
679 _OrthancPluginOnStoredInstanceCallback params;
680 params.callback = callback;
682 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
692 const char* mimeType;
693 } _OrthancPluginAnswerBuffer;
711 const char* mimeType)
713 _OrthancPluginAnswerBuffer params;
714 params.output = output;
715 params.answer = answer;
716 params.answerSize = answerSize;
717 params.mimeType = mimeType;
718 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
730 } _OrthancPluginCompressAndAnswerPngImage;
758 _OrthancPluginCompressAndAnswerPngImage params;
759 params.output = output;
760 params.format = format;
761 params.width = width;
762 params.height = height;
763 params.pitch = pitch;
764 params.buffer = buffer;
765 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerPngImage, ¶ms);
773 const char* instanceId;
774 } _OrthancPluginGetDicomForInstance;
790 const char* instanceId)
792 _OrthancPluginGetDicomForInstance params;
793 params.target = target;
794 params.instanceId = instanceId;
795 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
804 } _OrthancPluginRestApiGet;
822 _OrthancPluginRestApiGet params;
823 params.target = target;
825 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
836 } _OrthancPluginRestApiPostPut;
858 _OrthancPluginRestApiPostPut params;
859 params.target = target;
862 params.bodySize = bodySize;
863 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
881 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
906 _OrthancPluginRestApiPostPut params;
907 params.target = target;
910 params.bodySize = bodySize;
911 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
919 const char* argument;
920 } _OrthancPluginOutputPlusArgument;
935 const char* redirection)
937 _OrthancPluginOutputPlusArgument params;
938 params.output = output;
939 params.argument = redirection;
940 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
948 const char* argument;
949 } _OrthancPluginRetrieveDynamicString;
965 const char* patientID)
969 _OrthancPluginRetrieveDynamicString params;
970 params.result = &result;
971 params.argument = patientID;
973 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, ¶ms))
999 const char* studyUID)
1003 _OrthancPluginRetrieveDynamicString params;
1004 params.result = &result;
1005 params.argument = studyUID;
1007 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, ¶ms))
1033 const char* accessionNumber)
1037 _OrthancPluginRetrieveDynamicString params;
1038 params.result = &result;
1039 params.argument = accessionNumber;
1041 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, ¶ms))
1067 const char* seriesUID)
1071 _OrthancPluginRetrieveDynamicString params;
1072 params.result = &result;
1073 params.argument = seriesUID;
1075 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, ¶ms))
1101 const char* sopInstanceUID)
1105 _OrthancPluginRetrieveDynamicString params;
1106 params.result = &result;
1107 params.argument = sopInstanceUID;
1109 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, ¶ms))
1126 } _OrthancPluginSendHttpStatusCode;
1147 _OrthancPluginSendHttpStatusCode params;
1148 params.output = output;
1149 params.status = status;
1150 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
1169 _OrthancPluginOutputPlusArgument params;
1170 params.output = output;
1171 params.argument = realm;
1172 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
1189 const char* allowedMethods)
1191 _OrthancPluginOutputPlusArgument params;
1192 params.output = output;
1193 params.argument = allowedMethods;
1194 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
1203 } _OrthancPluginSetHttpHeader;
1221 _OrthancPluginSetHttpHeader params;
1222 params.output = output;
1223 params.key = cookie;
1224 params.value = value;
1225 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
1245 _OrthancPluginSetHttpHeader params;
1246 params.output = output;
1248 params.value = value;
1249 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
1255 char** resultStringToFree;
1256 const char** resultString;
1257 int64_t* resultInt64;
1260 } _OrthancPluginAccessDicomInstance;
1279 _OrthancPluginAccessDicomInstance params;
1280 memset(¶ms, 0,
sizeof(params));
1281 params.resultString = &result;
1282 params.instance = instance;
1284 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, ¶ms))
1311 _OrthancPluginAccessDicomInstance params;
1312 memset(¶ms, 0,
sizeof(params));
1313 params.resultInt64 = &size;
1314 params.instance = instance;
1316 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, ¶ms))
1343 _OrthancPluginAccessDicomInstance params;
1344 memset(¶ms, 0,
sizeof(params));
1345 params.resultString = &result;
1346 params.instance = instance;
1348 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, ¶ms))
1378 _OrthancPluginAccessDicomInstance params;
1379 memset(¶ms, 0,
sizeof(params));
1380 params.resultStringToFree = &result;
1381 params.instance = instance;
1383 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, ¶ms))
1415 _OrthancPluginAccessDicomInstance params;
1416 memset(¶ms, 0,
sizeof(params));
1417 params.resultStringToFree = &result;
1418 params.instance = instance;
1420 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, ¶ms))
1450 const char* metadata)
1454 _OrthancPluginAccessDicomInstance params;
1455 memset(¶ms, 0,
sizeof(params));
1456 params.resultInt64 = &result;
1457 params.instance = instance;
1458 params.key = metadata;
1460 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, ¶ms))
1467 return (result != 0);
1487 const char* metadata)
1491 _OrthancPluginAccessDicomInstance params;
1492 memset(¶ms, 0,
sizeof(params));
1493 params.resultString = &result;
1494 params.instance = instance;
1495 params.key = metadata;
1497 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, ¶ms))
1516 } _OrthancPluginRegisterStorageArea;
1537 _OrthancPluginRegisterStorageArea params;
1538 params.create_ = create;
1539 params.read_ = read;
1540 params.remove_ =
remove;
1543 params.free_ = ::free;
1545 params.free_ = free;
1548 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
1567 _OrthancPluginRetrieveDynamicString params;
1568 params.result = &result;
1569 params.argument = NULL;
1571 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, ¶ms))
1597 _OrthancPluginRetrieveDynamicString params;
1598 params.result = &result;
1599 params.argument = NULL;
1601 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, ¶ms))
1628 _OrthancPluginRetrieveDynamicString params;
1629 params.result = &result;
1630 params.argument = NULL;
1632 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, ¶ms))
int32_t(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:417
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:1186
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:402
int32_t(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:393
The parameters of a REST request.
Definition: OrthancCPlugin.h:169
int32_t(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:436
Definition: OrthancCPlugin.h:337
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:675
int32_t(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:383
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:229
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:224
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:189
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:932
int OrthancPluginRestApiPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:851
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:1142
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:1273
void OrthancPluginCompressAndAnswerPngImage(OrthancPluginContext *context, OrthancPluginRestOutput *output, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer)
Answer to a REST request with a PNG image.
Definition: OrthancCPlugin.h:749
OrthancPluginContentType
Definition: OrthancCPlugin.h:334
void OrthancPluginLogInfo(OrthancPluginContext *context, const char *message)
Log an information.
Definition: OrthancCPlugin.h:621
Definition: OrthancCPlugin.h:159
void OrthancPluginLogError(OrthancPluginContext *context, const char *message)
Log an error.
Definition: OrthancCPlugin.h:589
void OrthancPluginFreeMemoryBuffer(OrthancPluginContext *context, OrthancPluginMemoryBuffer *buffer)
Free a memory buffer.
Definition: OrthancCPlugin.h:573
char * OrthancPluginGetOrthancPath(OrthancPluginContext *context)
Return the path to the Orthanc executable.
Definition: OrthancCPlugin.h:1563
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:1164
int OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:877
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:1239
int OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:787
char * OrthancPluginGetOrthancDirectory(OrthancPluginContext *context)
Return the directory containing the Orthanc.
Definition: OrthancCPlugin.h:1593
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:302
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:1031
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:355
Color image in RGB24 format.
Definition: OrthancCPlugin.h:318
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:1447
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:219
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:1409
OrthancPluginHttpMethod
Definition: OrthancCPlugin.h:157
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance received by Orthanc.
Definition: OrthancCPlugin.h:376
struct _OrthancPluginContext_t OrthancPluginContext
Opaque structure that contains information about the Orthanc core.
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:369
int OrthancPluginRestApiPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:899
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:199
Definition: OrthancCPlugin.h:161
char * OrthancPluginGetConfigurationPath(OrthancPluginContext *context)
Return the path to the configuration file.
Definition: OrthancCPlugin.h:1624
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:204
Definition: OrthancCPlugin.h:162
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:963
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:326
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:1215
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:194
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:184
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:360
int OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:817
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:179
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:286
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:648
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:294
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:209
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:706
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition: OrthancCPlugin.h:1484
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:1531
void OrthancPluginFreeString(OrthancPluginContext *context, char *str)
Free a string.
Definition: OrthancCPlugin.h:482
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:1305
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:1372
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:310
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:174
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:1337
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:350
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:505
void OrthancPluginLogWarning(OrthancPluginContext *context, const char *message)
Log a warning.
Definition: OrthancCPlugin.h:605
int32_t(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:453
Definition: OrthancCPlugin.h:338
Definition: OrthancCPlugin.h:160
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:997
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:1065
Definition: OrthancCPlugin.h:336
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:1099