105 #define ORTHANC_PLUGINS_API __declspec(dllexport)
107 #define ORTHANC_PLUGINS_API
110 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
111 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
112 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 4
130 #ifndef ORTHANC_PLUGIN_INLINE
131 # if __STDC_VERSION__ >= 199901L
133 # define ORTHANC_PLUGIN_INLINE static inline
134 # elif defined(__cplusplus)
136 # define ORTHANC_PLUGIN_INLINE static inline
137 # elif defined(__GNUC__)
139 # define ORTHANC_PLUGIN_INLINE static __inline
140 # elif defined(_MSC_VER)
142 # define ORTHANC_PLUGIN_INLINE static __inline
144 # error Your compiler is not known to support the "inline" keyword
266 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
274 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
287 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
363 _OrthancPluginService_LogInfo = 1,
364 _OrthancPluginService_LogWarning = 2,
365 _OrthancPluginService_LogError = 3,
366 _OrthancPluginService_GetOrthancPath = 4,
367 _OrthancPluginService_GetOrthancDirectory = 5,
368 _OrthancPluginService_GetConfigurationPath = 6,
369 _OrthancPluginService_SetPluginProperty = 7,
370 _OrthancPluginService_GetGlobalProperty = 8,
371 _OrthancPluginService_SetGlobalProperty = 9,
372 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
373 _OrthancPluginService_GetCommandLineArgument = 11,
374 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
375 _OrthancPluginService_GetConfiguration = 13,
376 _OrthancPluginService_BufferCompression = 14,
377 _OrthancPluginService_ReadFile = 15,
378 _OrthancPluginService_WriteFile = 16,
379 _OrthancPluginService_GetErrorDescription = 17,
380 _OrthancPluginService_CallHttpClient = 18,
383 _OrthancPluginService_RegisterRestCallback = 1000,
384 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
385 _OrthancPluginService_RegisterStorageArea = 1002,
386 _OrthancPluginService_RegisterOnChangeCallback = 1003,
387 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
390 _OrthancPluginService_AnswerBuffer = 2000,
391 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
392 _OrthancPluginService_Redirect = 2002,
393 _OrthancPluginService_SendHttpStatusCode = 2003,
394 _OrthancPluginService_SendUnauthorized = 2004,
395 _OrthancPluginService_SendMethodNotAllowed = 2005,
396 _OrthancPluginService_SetCookie = 2006,
397 _OrthancPluginService_SetHttpHeader = 2007,
398 _OrthancPluginService_StartMultipartAnswer = 2008,
399 _OrthancPluginService_SendMultipartItem = 2009,
400 _OrthancPluginService_SendHttpStatus = 2010,
401 _OrthancPluginService_CompressAndAnswerImage = 2011,
404 _OrthancPluginService_GetDicomForInstance = 3000,
405 _OrthancPluginService_RestApiGet = 3001,
406 _OrthancPluginService_RestApiPost = 3002,
407 _OrthancPluginService_RestApiDelete = 3003,
408 _OrthancPluginService_RestApiPut = 3004,
409 _OrthancPluginService_LookupPatient = 3005,
410 _OrthancPluginService_LookupStudy = 3006,
411 _OrthancPluginService_LookupSeries = 3007,
412 _OrthancPluginService_LookupInstance = 3008,
413 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
414 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
415 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
416 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
417 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
420 _OrthancPluginService_GetInstanceRemoteAet = 4000,
421 _OrthancPluginService_GetInstanceSize = 4001,
422 _OrthancPluginService_GetInstanceData = 4002,
423 _OrthancPluginService_GetInstanceJson = 4003,
424 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
425 _OrthancPluginService_HasInstanceMetadata = 4005,
426 _OrthancPluginService_GetInstanceMetadata = 4006,
429 _OrthancPluginService_RegisterDatabaseBackend = 5000,
430 _OrthancPluginService_DatabaseAnswer = 5001,
431 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
432 _OrthancPluginService_StorageAreaCreate = 5003,
433 _OrthancPluginService_StorageAreaRead = 5004,
434 _OrthancPluginService_StorageAreaRemove = 5005,
437 _OrthancPluginService_GetImagePixelFormat = 6000,
438 _OrthancPluginService_GetImageWidth = 6001,
439 _OrthancPluginService_GetImageHeight = 6002,
440 _OrthancPluginService_GetImagePitch = 6003,
441 _OrthancPluginService_GetImageBuffer = 6004,
442 _OrthancPluginService_UncompressImage = 6005,
443 _OrthancPluginService_FreeImage = 6006,
444 _OrthancPluginService_CompressImage = 6007,
445 _OrthancPluginService_ConvertPixelFormat = 6008,
446 _OrthancPluginService_GetFontsCount = 6009,
447 _OrthancPluginService_GetFontInfo = 6010,
448 _OrthancPluginService_DrawText = 6011,
450 _OrthancPluginService_INTERNAL = 0x7fffffff
451 } _OrthancPluginService;
456 _OrthancPluginProperty_Description = 1,
457 _OrthancPluginProperty_RootUri = 2,
458 _OrthancPluginProperty_OrthancExplorer = 3,
460 _OrthancPluginProperty_INTERNAL = 0x7fffffff
461 } _OrthancPluginProperty;
513 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
527 _OrthancPluginContentType_INTERNAL = 0x7fffffff
542 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
564 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
579 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
592 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
668 const char* instanceId);
679 const char* resourceId);
749 typedef struct _OrthancPluginContext_t
751 void* pluginsManager;
752 const char* orthancVersion;
755 _OrthancPluginService service,
796 int major, minor, revision;
800 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
801 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
814 if (!strcmp(context->orthancVersion,
"mainline"))
826 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
833 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
838 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
845 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
850 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
857 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
880 context->Free(buffer->
data);
896 context->InvokeService(context, _OrthancPluginService_LogError, message);
912 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
928 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
935 const char* pathRegularExpression;
937 } _OrthancPluginRestCallback;
957 const char* pathRegularExpression,
960 _OrthancPluginRestCallback params;
961 params.pathRegularExpression = pathRegularExpression;
962 params.callback = callback;
963 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
991 const char* pathRegularExpression,
994 _OrthancPluginRestCallback params;
995 params.pathRegularExpression = pathRegularExpression;
996 params.callback = callback;
997 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1005 } _OrthancPluginOnStoredInstanceCallback;
1021 _OrthancPluginOnStoredInstanceCallback params;
1022 params.callback = callback;
1024 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1033 uint32_t answerSize;
1034 const char* mimeType;
1035 } _OrthancPluginAnswerBuffer;
1053 uint32_t answerSize,
1054 const char* mimeType)
1056 _OrthancPluginAnswerBuffer params;
1057 params.output = output;
1058 params.answer = answer;
1059 params.answerSize = answerSize;
1060 params.mimeType = mimeType;
1061 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1073 } _OrthancPluginCompressAndAnswerPngImage;
1085 } _OrthancPluginCompressAndAnswerImage;
1115 _OrthancPluginCompressAndAnswerImage params;
1116 params.output = output;
1118 params.pixelFormat = format;
1119 params.width = width;
1120 params.height = height;
1121 params.pitch = pitch;
1122 params.buffer = buffer;
1124 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1132 const char* instanceId;
1133 } _OrthancPluginGetDicomForInstance;
1150 const char* instanceId)
1152 _OrthancPluginGetDicomForInstance params;
1153 params.target = target;
1154 params.instanceId = instanceId;
1155 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1164 } _OrthancPluginRestApiGet;
1184 _OrthancPluginRestApiGet params;
1185 params.target = target;
1187 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1213 _OrthancPluginRestApiGet params;
1214 params.target = target;
1216 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1227 } _OrthancPluginRestApiPostPut;
1251 _OrthancPluginRestApiPostPut params;
1252 params.target = target;
1255 params.bodySize = bodySize;
1256 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1285 _OrthancPluginRestApiPostPut params;
1286 params.target = target;
1289 params.bodySize = bodySize;
1290 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1310 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1332 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1359 _OrthancPluginRestApiPostPut params;
1360 params.target = target;
1363 params.bodySize = bodySize;
1364 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1394 _OrthancPluginRestApiPostPut params;
1395 params.target = target;
1398 params.bodySize = bodySize;
1399 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1407 const char* argument;
1408 } _OrthancPluginOutputPlusArgument;
1424 const char* redirection)
1426 _OrthancPluginOutputPlusArgument params;
1427 params.output = output;
1428 params.argument = redirection;
1429 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1437 const char* argument;
1438 } _OrthancPluginRetrieveDynamicString;
1455 const char* patientID)
1459 _OrthancPluginRetrieveDynamicString params;
1460 params.result = &result;
1461 params.argument = patientID;
1490 const char* studyUID)
1494 _OrthancPluginRetrieveDynamicString params;
1495 params.result = &result;
1496 params.argument = studyUID;
1525 const char* accessionNumber)
1529 _OrthancPluginRetrieveDynamicString params;
1530 params.result = &result;
1531 params.argument = accessionNumber;
1560 const char* seriesUID)
1564 _OrthancPluginRetrieveDynamicString params;
1565 params.result = &result;
1566 params.argument = seriesUID;
1595 const char* sopInstanceUID)
1599 _OrthancPluginRetrieveDynamicString params;
1600 params.result = &result;
1601 params.argument = sopInstanceUID;
1620 } _OrthancPluginSendHttpStatusCode;
1643 _OrthancPluginSendHttpStatusCode params;
1644 params.output = output;
1645 params.status = status;
1646 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
1666 _OrthancPluginOutputPlusArgument params;
1667 params.output = output;
1668 params.argument = realm;
1669 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
1687 const char* allowedMethods)
1689 _OrthancPluginOutputPlusArgument params;
1690 params.output = output;
1691 params.argument = allowedMethods;
1692 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
1701 } _OrthancPluginSetHttpHeader;
1720 _OrthancPluginSetHttpHeader params;
1721 params.output = output;
1722 params.key = cookie;
1723 params.value = value;
1724 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
1745 _OrthancPluginSetHttpHeader params;
1746 params.output = output;
1748 params.value = value;
1749 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
1755 char** resultStringToFree;
1756 const char** resultString;
1757 int64_t* resultInt64;
1760 } _OrthancPluginAccessDicomInstance;
1780 _OrthancPluginAccessDicomInstance params;
1781 memset(¶ms, 0,
sizeof(params));
1782 params.resultString = &result;
1783 params.instance = instance;
1813 _OrthancPluginAccessDicomInstance params;
1814 memset(¶ms, 0,
sizeof(params));
1815 params.resultInt64 = &size;
1816 params.instance = instance;
1846 _OrthancPluginAccessDicomInstance params;
1847 memset(¶ms, 0,
sizeof(params));
1848 params.resultString = &result;
1849 params.instance = instance;
1882 _OrthancPluginAccessDicomInstance params;
1883 memset(¶ms, 0,
sizeof(params));
1884 params.resultStringToFree = &result;
1885 params.instance = instance;
1920 _OrthancPluginAccessDicomInstance params;
1921 memset(¶ms, 0,
sizeof(params));
1922 params.resultStringToFree = &result;
1923 params.instance = instance;
1956 const char* metadata)
1960 _OrthancPluginAccessDicomInstance params;
1961 memset(¶ms, 0,
sizeof(params));
1962 params.resultInt64 = &result;
1963 params.instance = instance;
1964 params.key = metadata;
1973 return (result != 0);
1994 const char* metadata)
1998 _OrthancPluginAccessDicomInstance params;
1999 memset(¶ms, 0,
sizeof(params));
2000 params.resultString = &result;
2001 params.instance = instance;
2002 params.key = metadata;
2023 } _OrthancPluginRegisterStorageArea;
2045 _OrthancPluginRegisterStorageArea params;
2046 params.create = create;
2048 params.remove =
remove;
2051 params.free = ::free;
2056 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2075 _OrthancPluginRetrieveDynamicString params;
2076 params.result = &result;
2077 params.argument = NULL;
2105 _OrthancPluginRetrieveDynamicString params;
2106 params.result = &result;
2107 params.argument = NULL;
2140 _OrthancPluginRetrieveDynamicString params;
2141 params.result = &result;
2142 params.argument = NULL;
2160 } _OrthancPluginOnChangeCallback;
2176 _OrthancPluginOnChangeCallback params;
2177 params.callback = callback;
2179 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2187 _OrthancPluginProperty property;
2189 } _OrthancPluginSetPluginProperty;
2207 _OrthancPluginSetPluginProperty params;
2208 params.plugin = OrthancPluginGetName();
2209 params.property = _OrthancPluginProperty_RootUri;
2212 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2227 const char* description)
2229 _OrthancPluginSetPluginProperty params;
2230 params.plugin = OrthancPluginGetName();
2231 params.property = _OrthancPluginProperty_Description;
2232 params.value = description;
2234 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2249 const char* javascript)
2251 _OrthancPluginSetPluginProperty params;
2252 params.plugin = OrthancPluginGetName();
2253 params.property = _OrthancPluginProperty_OrthancExplorer;
2254 params.value = javascript;
2256 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2265 } _OrthancPluginGlobalProperty;
2284 const char* defaultValue)
2288 _OrthancPluginGlobalProperty params;
2289 params.result = &result;
2290 params.property = property;
2291 params.value = defaultValue;
2325 _OrthancPluginGlobalProperty params;
2326 params.result = NULL;
2327 params.property = property;
2328 params.value = value;
2330 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2337 int32_t *resultInt32;
2338 uint32_t *resultUint32;
2339 int64_t *resultInt64;
2340 uint64_t *resultUint64;
2341 } _OrthancPluginReturnSingleValue;
2356 _OrthancPluginReturnSingleValue params;
2357 memset(¶ms, 0,
sizeof(params));
2358 params.resultUint32 = &count;
2391 _OrthancPluginGlobalProperty params;
2392 params.result = &result;
2393 params.property = (int32_t) argument;
2394 params.value = NULL;
2423 _OrthancPluginReturnSingleValue params;
2424 memset(¶ms, 0,
sizeof(params));
2425 params.resultUint32 = &count;
2455 _OrthancPluginRetrieveDynamicString params;
2456 params.result = &result;
2457 params.argument = NULL;
2475 const char* subType;
2476 const char* contentType;
2477 } _OrthancPluginStartMultipartAnswer;
2495 const char* subType,
2496 const char* contentType)
2498 _OrthancPluginStartMultipartAnswer params;
2499 params.output = output;
2500 params.subType = subType;
2501 params.contentType = contentType;
2502 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
2524 uint32_t answerSize)
2526 _OrthancPluginAnswerBuffer params;
2527 params.output = output;
2528 params.answer = answer;
2529 params.answerSize = answerSize;
2530 params.mimeType = NULL;
2531 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
2543 } _OrthancPluginBufferCompression;
2570 _OrthancPluginBufferCompression params;
2571 params.target = target;
2572 params.source = source;
2574 params.compression = compression;
2575 params.uncompress = uncompress;
2577 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
2586 } _OrthancPluginReadFile;
2604 _OrthancPluginReadFile params;
2605 params.target = target;
2607 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
2617 } _OrthancPluginWriteFile;
2636 _OrthancPluginWriteFile params;
2640 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
2647 const char** target;
2649 } _OrthancPluginGetErrorDescription;
2665 const char* result = NULL;
2667 _OrthancPluginGetErrorDescription params;
2668 params.target = &result;
2669 params.error = error;
2674 return "Unknown error code";
2690 } _OrthancPluginSendHttpStatus;
2721 _OrthancPluginSendHttpStatus params;
2722 params.output = output;
2723 params.status = status;
2725 params.bodySize = bodySize;
2726 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
2734 uint32_t* resultUint32;
2736 const void** resultBuffer;
2737 } _OrthancPluginGetImageInfo;
2756 _OrthancPluginGetImageInfo params;
2757 memset(¶ms, 0,
sizeof(params));
2758 params.image = image;
2759 params.resultPixelFormat = ⌖
2789 _OrthancPluginGetImageInfo params;
2790 memset(¶ms, 0,
sizeof(params));
2791 params.image = image;
2792 params.resultUint32 = &width;
2822 _OrthancPluginGetImageInfo params;
2823 memset(¶ms, 0,
sizeof(params));
2824 params.image = image;
2825 params.resultUint32 = &height;
2857 _OrthancPluginGetImageInfo params;
2858 memset(¶ms, 0,
sizeof(params));
2859 params.image = image;
2860 params.resultUint32 = &pitch;
2889 const void* target = NULL;
2891 _OrthancPluginGetImageInfo params;
2892 memset(¶ms, 0,
sizeof(params));
2893 params.resultBuffer = ⌖
2894 params.image = image;
2913 } _OrthancPluginUncompressImage;
2936 _OrthancPluginUncompressImage params;
2937 memset(¶ms, 0,
sizeof(params));
2938 params.target = ⌖
2941 params.format = format;
2959 } _OrthancPluginFreeImage;
2974 _OrthancPluginFreeImage params;
2975 params.image = image;
2977 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
2993 } _OrthancPluginCompressImage;
3024 _OrthancPluginCompressImage params;
3025 memset(¶ms, 0,
sizeof(params));
3026 params.target = target;
3028 params.pixelFormat = format;
3029 params.width = width;
3030 params.height = height;
3031 params.pitch = pitch;
3032 params.buffer = buffer;
3035 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3070 _OrthancPluginCompressImage params;
3071 memset(¶ms, 0,
sizeof(params));
3072 params.target = target;
3074 params.pixelFormat = format;
3075 params.width = width;
3076 params.height = height;
3077 params.pitch = pitch;
3078 params.buffer = buffer;
3079 params.quality = quality;
3081 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3117 _OrthancPluginCompressAndAnswerImage params;
3118 params.output = output;
3120 params.pixelFormat = format;
3121 params.width = width;
3122 params.height = height;
3123 params.pitch = pitch;
3124 params.buffer = buffer;
3125 params.quality = quality;
3126 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3137 const char* username;
3138 const char* password;
3141 } _OrthancPluginCallHttpClient;
3163 const char* username,
3164 const char* password)
3166 _OrthancPluginCallHttpClient params;
3167 memset(¶ms, 0,
sizeof(params));
3169 params.target = target;
3172 params.username = username;
3173 params.password = password;
3175 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3202 const char* username,
3203 const char* password)
3205 _OrthancPluginCallHttpClient params;
3206 memset(¶ms, 0,
sizeof(params));
3208 params.target = target;
3212 params.bodySize = bodySize;
3213 params.username = username;
3214 params.password = password;
3216 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3243 const char* username,
3244 const char* password)
3246 _OrthancPluginCallHttpClient params;
3247 memset(¶ms, 0,
sizeof(params));
3249 params.target = target;
3253 params.bodySize = bodySize;
3254 params.username = username;
3255 params.password = password;
3257 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3277 const char* username,
3278 const char* password)
3280 _OrthancPluginCallHttpClient params;
3281 memset(¶ms, 0,
sizeof(params));
3285 params.username = username;
3286 params.password = password;
3288 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3298 } _OrthancPluginConvertPixelFormat;
3319 _OrthancPluginConvertPixelFormat params;
3320 params.target = ⌖
3321 params.source = source;
3322 params.targetFormat = targetFormat;
3352 _OrthancPluginReturnSingleValue params;
3353 memset(¶ms, 0,
sizeof(params));
3354 params.resultUint32 = &count;
3375 } _OrthancPluginGetFontInfo;
3391 const char* result = NULL;
3393 _OrthancPluginGetFontInfo params;
3394 memset(¶ms, 0,
sizeof(params));
3395 params.name = &result;
3396 params.fontIndex = fontIndex;
3425 _OrthancPluginGetFontInfo params;
3426 memset(¶ms, 0,
sizeof(params));
3427 params.size = &result;
3428 params.fontIndex = fontIndex;
3446 const char* utf8Text;
3452 } _OrthancPluginDrawText;
3476 const char* utf8Text,
3483 _OrthancPluginDrawText params;
3484 memset(¶ms, 0,
sizeof(params));
3485 params.image = image;
3486 params.fontIndex = fontIndex;
3487 params.utf8Text = utf8Text;
3494 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
3503 const void* content;
3506 } _OrthancPluginStorageAreaCreate;
3528 const void* content,
3532 _OrthancPluginStorageAreaCreate params;
3533 params.storageArea = storageArea;
3535 params.content = content;
3539 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
3549 } _OrthancPluginStorageAreaRead;
3573 _OrthancPluginStorageAreaRead params;
3574 params.target = target;
3575 params.storageArea = storageArea;
3579 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
3588 } _OrthancPluginStorageAreaRemove;
3610 _OrthancPluginStorageAreaRemove params;
3611 params.storageArea = storageArea;
3615 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
Definition: OrthancCPlugin.h:590
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:1774
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:1953
OrthancPluginChangeType
Definition: OrthancCPlugin.h:551
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:1638
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:1739
The parameters of a REST request.
Definition: OrthancCPlugin.h:295
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1421
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1328
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:1840
OrthancPluginErrorCode OrthancPluginCompressPngImage(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer)
Encode a PNG image.
Definition: OrthancCPlugin.h:3015
void OrthancPluginCompressAndAnswerJpegImage(OrthancPluginContext *context, OrthancPluginRestOutput *output, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer, uint8_t quality)
Answer to a REST request with a JPEG image.
Definition: OrthancCPlugin.h:3107
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:793
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:1807
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:485
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:355
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:350
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:469
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:315
Definition: OrthancCPlugin.h:511
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2039
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1147
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:666
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:587
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3387
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3312
Definition: OrthancCPlugin.h:560
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:3566
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3347
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2172
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:509
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:1684
Definition: OrthancCPlugin.h:574
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1049
Definition: OrthancCPlugin.h:554
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:655
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:1991
Definition: OrthancCPlugin.h:589
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:647
Definition: OrthancCPlugin.h:558
OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1387
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2418
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:477
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:2816
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const char *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:2714
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:2928
Definition: OrthancCPlugin.h:575
Definition: OrthancCPlugin.h:577
Color image in RGB24 format.
Definition: OrthancCPlugin.h:501
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:493
Definition: OrthancCPlugin.h:553
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:572
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:2750
OrthancPluginErrorCode OrthancPluginDrawText(OrthancPluginContext *context, OrthancPluginImage *image, uint32_t fontIndex, const char *utf8Text, int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b)
Draw text on an image.
Definition: OrthancCPlugin.h:3472
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:2851
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:1106
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:1661
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:609
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3419
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1179
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:345
Definition: OrthancCPlugin.h:559
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1306
int32_t(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:702
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2281
int32_t(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:722
Definition: OrthancCPlugin.h:561
int32_t(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:740
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:325
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:1914
OrthancPluginErrorCode OrthancPluginBufferCompression(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const void *source, uint32_t size, OrthancPluginCompressionType compression, uint8_t uncompress)
Compress or decompress a buffer.
Definition: OrthancCPlugin.h:2562
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:330
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:989
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:639
OrthancPluginErrorCode 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:1352
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:2492
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:3604
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:320
Definition: OrthancCPlugin.h:556
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1453
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:2970
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:1593
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2320
OrthancPluginErrorCode OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition: OrthancCPlugin.h:2520
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:310
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1488
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:614
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:305
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:335
int32_t(* OrthancPluginOnChangeCallback)(OrthancPluginChangeType changeType, OrthancPluginResourceType resourceType, const char *resourceId)
Signature of a callback function that is triggered when a change happens to some DICOM resource...
Definition: OrthancCPlugin.h:676
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:1714
Definition: OrthancCPlugin.h:555
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:1876
OrthancPluginErrorCode 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:1244
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1017
Definition: OrthancCPlugin.h:557
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:955
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:1523
OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1208
OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1278
Definition: OrthancCPlugin.h:562
Definition: OrthancCPlugin.h:576
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:300
OrthancPluginErrorCode OrthancPluginStorageAreaCreate(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, const void *content, uint64_t size, OrthancPluginContentType type)
Create a file inside the storage area.
Definition: OrthancCPlugin.h:3524
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:604
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:1558
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:2783
OrthancPluginErrorCode OrthancPluginCompressJpegImage(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer, uint8_t quality)
Encode a JPEG image.
Definition: OrthancCPlugin.h:3060
const void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:2885