113 #define ORTHANC_PLUGINS_API __declspec(dllexport) 115 #define ORTHANC_PLUGINS_API 118 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1 119 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 2 120 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0 138 #ifndef ORTHANC_PLUGIN_INLINE 139 # if __STDC_VERSION__ >= 199901L 141 # define ORTHANC_PLUGIN_INLINE static inline 142 # elif defined(__cplusplus) 144 # define ORTHANC_PLUGIN_INLINE static inline 145 # elif defined(__GNUC__) 147 # define ORTHANC_PLUGIN_INLINE static __inline 148 # elif defined(_MSC_VER) 150 # define ORTHANC_PLUGIN_INLINE static __inline 152 # error Your compiler is not known to support the "inline" keyword 286 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
294 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
307 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
383 _OrthancPluginService_LogInfo = 1,
384 _OrthancPluginService_LogWarning = 2,
385 _OrthancPluginService_LogError = 3,
386 _OrthancPluginService_GetOrthancPath = 4,
387 _OrthancPluginService_GetOrthancDirectory = 5,
388 _OrthancPluginService_GetConfigurationPath = 6,
389 _OrthancPluginService_SetPluginProperty = 7,
390 _OrthancPluginService_GetGlobalProperty = 8,
391 _OrthancPluginService_SetGlobalProperty = 9,
392 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
393 _OrthancPluginService_GetCommandLineArgument = 11,
394 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
395 _OrthancPluginService_GetConfiguration = 13,
396 _OrthancPluginService_BufferCompression = 14,
397 _OrthancPluginService_ReadFile = 15,
398 _OrthancPluginService_WriteFile = 16,
399 _OrthancPluginService_GetErrorDescription = 17,
400 _OrthancPluginService_CallHttpClient = 18,
401 _OrthancPluginService_RegisterErrorCode = 19,
402 _OrthancPluginService_RegisterDictionaryTag = 20,
403 _OrthancPluginService_DicomBufferToJson = 21,
404 _OrthancPluginService_DicomInstanceToJson = 22,
405 _OrthancPluginService_CreateDicom = 23,
406 _OrthancPluginService_ComputeMd5 = 24,
407 _OrthancPluginService_ComputeSha1 = 25,
408 _OrthancPluginService_LookupDictionary = 26,
409 _OrthancPluginService_CallHttpClient2 = 27,
410 _OrthancPluginService_GenerateUuid = 28,
411 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
414 _OrthancPluginService_RegisterRestCallback = 1000,
415 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
416 _OrthancPluginService_RegisterStorageArea = 1002,
417 _OrthancPluginService_RegisterOnChangeCallback = 1003,
418 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
419 _OrthancPluginService_RegisterWorklistCallback = 1005,
420 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
421 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
422 _OrthancPluginService_RegisterFindCallback = 1008,
423 _OrthancPluginService_RegisterMoveCallback = 1009,
426 _OrthancPluginService_AnswerBuffer = 2000,
427 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
428 _OrthancPluginService_Redirect = 2002,
429 _OrthancPluginService_SendHttpStatusCode = 2003,
430 _OrthancPluginService_SendUnauthorized = 2004,
431 _OrthancPluginService_SendMethodNotAllowed = 2005,
432 _OrthancPluginService_SetCookie = 2006,
433 _OrthancPluginService_SetHttpHeader = 2007,
434 _OrthancPluginService_StartMultipartAnswer = 2008,
435 _OrthancPluginService_SendMultipartItem = 2009,
436 _OrthancPluginService_SendHttpStatus = 2010,
437 _OrthancPluginService_CompressAndAnswerImage = 2011,
438 _OrthancPluginService_SendMultipartItem2 = 2012,
441 _OrthancPluginService_GetDicomForInstance = 3000,
442 _OrthancPluginService_RestApiGet = 3001,
443 _OrthancPluginService_RestApiPost = 3002,
444 _OrthancPluginService_RestApiDelete = 3003,
445 _OrthancPluginService_RestApiPut = 3004,
446 _OrthancPluginService_LookupPatient = 3005,
447 _OrthancPluginService_LookupStudy = 3006,
448 _OrthancPluginService_LookupSeries = 3007,
449 _OrthancPluginService_LookupInstance = 3008,
450 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
451 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
452 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
453 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
454 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
455 _OrthancPluginService_ReconstructMainDicomTags = 3014,
456 _OrthancPluginService_RestApiGet2 = 3015,
459 _OrthancPluginService_GetInstanceRemoteAet = 4000,
460 _OrthancPluginService_GetInstanceSize = 4001,
461 _OrthancPluginService_GetInstanceData = 4002,
462 _OrthancPluginService_GetInstanceJson = 4003,
463 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
464 _OrthancPluginService_HasInstanceMetadata = 4005,
465 _OrthancPluginService_GetInstanceMetadata = 4006,
466 _OrthancPluginService_GetInstanceOrigin = 4007,
469 _OrthancPluginService_RegisterDatabaseBackend = 5000,
470 _OrthancPluginService_DatabaseAnswer = 5001,
471 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
472 _OrthancPluginService_StorageAreaCreate = 5003,
473 _OrthancPluginService_StorageAreaRead = 5004,
474 _OrthancPluginService_StorageAreaRemove = 5005,
477 _OrthancPluginService_GetImagePixelFormat = 6000,
478 _OrthancPluginService_GetImageWidth = 6001,
479 _OrthancPluginService_GetImageHeight = 6002,
480 _OrthancPluginService_GetImagePitch = 6003,
481 _OrthancPluginService_GetImageBuffer = 6004,
482 _OrthancPluginService_UncompressImage = 6005,
483 _OrthancPluginService_FreeImage = 6006,
484 _OrthancPluginService_CompressImage = 6007,
485 _OrthancPluginService_ConvertPixelFormat = 6008,
486 _OrthancPluginService_GetFontsCount = 6009,
487 _OrthancPluginService_GetFontInfo = 6010,
488 _OrthancPluginService_DrawText = 6011,
489 _OrthancPluginService_CreateImage = 6012,
490 _OrthancPluginService_CreateImageAccessor = 6013,
491 _OrthancPluginService_DecodeDicomImage = 6014,
494 _OrthancPluginService_WorklistAddAnswer = 7000,
495 _OrthancPluginService_WorklistMarkIncomplete = 7001,
496 _OrthancPluginService_WorklistIsMatch = 7002,
497 _OrthancPluginService_WorklistGetDicomQuery = 7003,
498 _OrthancPluginService_FindAddAnswer = 7004,
499 _OrthancPluginService_FindMarkIncomplete = 7005,
500 _OrthancPluginService_GetFindQuerySize = 7006,
501 _OrthancPluginService_GetFindQueryTag = 7007,
502 _OrthancPluginService_GetFindQueryTagName = 7008,
503 _OrthancPluginService_GetFindQueryValue = 7009,
504 _OrthancPluginService_CreateFindMatcher = 7010,
505 _OrthancPluginService_FreeFindMatcher = 7011,
506 _OrthancPluginService_FindMatcherIsMatch = 7012,
508 _OrthancPluginService_INTERNAL = 0x7fffffff
509 } _OrthancPluginService;
514 _OrthancPluginProperty_Description = 1,
515 _OrthancPluginProperty_RootUri = 2,
516 _OrthancPluginProperty_OrthancExplorer = 3,
518 _OrthancPluginProperty_INTERNAL = 0x7fffffff
519 } _OrthancPluginProperty;
571 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
585 _OrthancPluginContentType_INTERNAL = 0x7fffffff
601 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
627 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
642 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
656 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
694 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
709 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
720 OrthancPluginDicomToJsonFlags_None = 0,
728 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
739 OrthancPluginCreateDicomFlags_None = 0,
743 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
758 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
773 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
888 const char* instanceId);
899 const char* resourceId);
911 uint32_t frameIndex);
994 const char* issuerAet,
995 const char* calledAet);
1021 uint32_t headersCount,
1022 const char*
const* headersKeys,
1023 const char*
const* headersValues);
1044 const char* issuerAet,
1045 const char* calledAet);
1084 typedef void* (*OrthancPluginMoveCallback) (
1086 const char* patientId,
1087 const char* accessionNumber,
1088 const char* studyInstanceUid,
1089 const char* seriesInstanceUid,
1090 const char* sopInstanceUid,
1091 const char* originatorAet,
1092 const char* sourceAet,
1093 const char* targetAet,
1094 uint16_t originatorId);
1142 typedef struct _OrthancPluginContext_t
1144 void* pluginsManager;
1145 const char* orthancVersion;
1148 _OrthancPluginService service,
1149 const void* params);
1203 int major, minor, revision;
1207 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1208 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1227 if (!strcmp(context->orthancVersion,
"mainline"))
1239 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1246 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1251 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1258 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1263 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1270 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1293 context->Free(buffer->
data);
1307 const char* message)
1309 context->InvokeService(context, _OrthancPluginService_LogError, message);
1323 const char* message)
1325 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1339 const char* message)
1341 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1348 const char* pathRegularExpression;
1350 } _OrthancPluginRestCallback;
1370 const char* pathRegularExpression,
1373 _OrthancPluginRestCallback params;
1374 params.pathRegularExpression = pathRegularExpression;
1375 params.callback = callback;
1376 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1404 const char* pathRegularExpression,
1407 _OrthancPluginRestCallback params;
1408 params.pathRegularExpression = pathRegularExpression;
1409 params.callback = callback;
1410 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1418 } _OrthancPluginOnStoredInstanceCallback;
1434 _OrthancPluginOnStoredInstanceCallback params;
1435 params.callback = callback;
1437 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1446 uint32_t answerSize;
1447 const char* mimeType;
1448 } _OrthancPluginAnswerBuffer;
1466 uint32_t answerSize,
1467 const char* mimeType)
1469 _OrthancPluginAnswerBuffer params;
1470 params.output = output;
1471 params.answer = answer;
1472 params.answerSize = answerSize;
1473 params.mimeType = mimeType;
1474 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1486 } _OrthancPluginCompressAndAnswerPngImage;
1498 } _OrthancPluginCompressAndAnswerImage;
1528 _OrthancPluginCompressAndAnswerImage params;
1529 params.output = output;
1531 params.pixelFormat = format;
1532 params.width = width;
1533 params.height = height;
1534 params.pitch = pitch;
1535 params.buffer = buffer;
1537 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1545 const char* instanceId;
1546 } _OrthancPluginGetDicomForInstance;
1563 const char* instanceId)
1565 _OrthancPluginGetDicomForInstance params;
1566 params.target = target;
1567 params.instanceId = instanceId;
1568 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1577 } _OrthancPluginRestApiGet;
1598 _OrthancPluginRestApiGet params;
1599 params.target = target;
1601 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1628 _OrthancPluginRestApiGet params;
1629 params.target = target;
1631 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1642 } _OrthancPluginRestApiPostPut;
1667 _OrthancPluginRestApiPostPut params;
1668 params.target = target;
1671 params.bodySize = bodySize;
1672 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1702 _OrthancPluginRestApiPostPut params;
1703 params.target = target;
1706 params.bodySize = bodySize;
1707 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1728 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1751 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1779 _OrthancPluginRestApiPostPut params;
1780 params.target = target;
1783 params.bodySize = bodySize;
1784 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1815 _OrthancPluginRestApiPostPut params;
1816 params.target = target;
1819 params.bodySize = bodySize;
1820 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1828 const char* argument;
1829 } _OrthancPluginOutputPlusArgument;
1845 const char* redirection)
1847 _OrthancPluginOutputPlusArgument params;
1848 params.output = output;
1849 params.argument = redirection;
1850 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1858 const char* argument;
1859 } _OrthancPluginRetrieveDynamicString;
1876 const char* patientID)
1880 _OrthancPluginRetrieveDynamicString params;
1881 params.result = &result;
1882 params.argument = patientID;
1911 const char* studyUID)
1915 _OrthancPluginRetrieveDynamicString params;
1916 params.result = &result;
1917 params.argument = studyUID;
1946 const char* accessionNumber)
1950 _OrthancPluginRetrieveDynamicString params;
1951 params.result = &result;
1952 params.argument = accessionNumber;
1981 const char* seriesUID)
1985 _OrthancPluginRetrieveDynamicString params;
1986 params.result = &result;
1987 params.argument = seriesUID;
2016 const char* sopInstanceUID)
2020 _OrthancPluginRetrieveDynamicString params;
2021 params.result = &result;
2022 params.argument = sopInstanceUID;
2041 } _OrthancPluginSendHttpStatusCode;
2064 _OrthancPluginSendHttpStatusCode params;
2065 params.output = output;
2066 params.status = status;
2067 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2087 _OrthancPluginOutputPlusArgument params;
2088 params.output = output;
2089 params.argument = realm;
2090 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2108 const char* allowedMethods)
2110 _OrthancPluginOutputPlusArgument params;
2111 params.output = output;
2112 params.argument = allowedMethods;
2113 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2122 } _OrthancPluginSetHttpHeader;
2141 _OrthancPluginSetHttpHeader params;
2142 params.output = output;
2143 params.key = cookie;
2144 params.value = value;
2145 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2166 _OrthancPluginSetHttpHeader params;
2167 params.output = output;
2169 params.value = value;
2170 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2176 char** resultStringToFree;
2177 const char** resultString;
2178 int64_t* resultInt64;
2182 } _OrthancPluginAccessDicomInstance;
2202 _OrthancPluginAccessDicomInstance params;
2203 memset(¶ms, 0,
sizeof(params));
2204 params.resultString = &result;
2205 params.instance = instance;
2235 _OrthancPluginAccessDicomInstance params;
2236 memset(¶ms, 0,
sizeof(params));
2237 params.resultInt64 = &size;
2238 params.instance = instance;
2268 _OrthancPluginAccessDicomInstance params;
2269 memset(¶ms, 0,
sizeof(params));
2270 params.resultString = &result;
2271 params.instance = instance;
2304 _OrthancPluginAccessDicomInstance params;
2305 memset(¶ms, 0,
sizeof(params));
2306 params.resultStringToFree = &result;
2307 params.instance = instance;
2342 _OrthancPluginAccessDicomInstance params;
2343 memset(¶ms, 0,
sizeof(params));
2344 params.resultStringToFree = &result;
2345 params.instance = instance;
2378 const char* metadata)
2382 _OrthancPluginAccessDicomInstance params;
2383 memset(¶ms, 0,
sizeof(params));
2384 params.resultInt64 = &result;
2385 params.instance = instance;
2386 params.key = metadata;
2395 return (result != 0);
2416 const char* metadata)
2420 _OrthancPluginAccessDicomInstance params;
2421 memset(¶ms, 0,
sizeof(params));
2422 params.resultString = &result;
2423 params.instance = instance;
2424 params.key = metadata;
2445 } _OrthancPluginRegisterStorageArea;
2467 _OrthancPluginRegisterStorageArea params;
2468 params.create = create;
2470 params.remove =
remove;
2473 params.free = ::free;
2478 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2497 _OrthancPluginRetrieveDynamicString params;
2498 params.result = &result;
2499 params.argument = NULL;
2527 _OrthancPluginRetrieveDynamicString params;
2528 params.result = &result;
2529 params.argument = NULL;
2562 _OrthancPluginRetrieveDynamicString params;
2563 params.result = &result;
2564 params.argument = NULL;
2582 } _OrthancPluginOnChangeCallback;
2604 _OrthancPluginOnChangeCallback params;
2605 params.callback = callback;
2607 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2615 _OrthancPluginProperty property;
2617 } _OrthancPluginSetPluginProperty;
2635 _OrthancPluginSetPluginProperty params;
2636 params.plugin = OrthancPluginGetName();
2637 params.property = _OrthancPluginProperty_RootUri;
2640 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2655 const char* description)
2657 _OrthancPluginSetPluginProperty params;
2658 params.plugin = OrthancPluginGetName();
2659 params.property = _OrthancPluginProperty_Description;
2660 params.value = description;
2662 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2677 const char* javascript)
2679 _OrthancPluginSetPluginProperty params;
2680 params.plugin = OrthancPluginGetName();
2681 params.property = _OrthancPluginProperty_OrthancExplorer;
2682 params.value = javascript;
2684 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2693 } _OrthancPluginGlobalProperty;
2712 const char* defaultValue)
2716 _OrthancPluginGlobalProperty params;
2717 params.result = &result;
2718 params.property = property;
2719 params.value = defaultValue;
2753 _OrthancPluginGlobalProperty params;
2754 params.result = NULL;
2755 params.property = property;
2756 params.value = value;
2758 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2765 int32_t *resultInt32;
2766 uint32_t *resultUint32;
2767 int64_t *resultInt64;
2768 uint64_t *resultUint64;
2769 } _OrthancPluginReturnSingleValue;
2784 _OrthancPluginReturnSingleValue params;
2785 memset(¶ms, 0,
sizeof(params));
2786 params.resultUint32 = &count;
2819 _OrthancPluginGlobalProperty params;
2820 params.result = &result;
2821 params.property = (int32_t) argument;
2822 params.value = NULL;
2851 _OrthancPluginReturnSingleValue params;
2852 memset(¶ms, 0,
sizeof(params));
2853 params.resultUint32 = &count;
2883 _OrthancPluginRetrieveDynamicString params;
2884 params.result = &result;
2885 params.argument = NULL;
2903 const char* subType;
2904 const char* contentType;
2905 } _OrthancPluginStartMultipartAnswer;
2923 const char* subType,
2924 const char* contentType)
2926 _OrthancPluginStartMultipartAnswer params;
2927 params.output = output;
2928 params.subType = subType;
2929 params.contentType = contentType;
2930 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
2953 uint32_t answerSize)
2955 _OrthancPluginAnswerBuffer params;
2956 params.output = output;
2957 params.answer = answer;
2958 params.answerSize = answerSize;
2959 params.mimeType = NULL;
2960 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
2972 } _OrthancPluginBufferCompression;
2999 _OrthancPluginBufferCompression params;
3000 params.target = target;
3001 params.source = source;
3003 params.compression = compression;
3004 params.uncompress = uncompress;
3006 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3015 } _OrthancPluginReadFile;
3033 _OrthancPluginReadFile params;
3034 params.target = target;
3036 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3046 } _OrthancPluginWriteFile;
3065 _OrthancPluginWriteFile params;
3069 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3076 const char** target;
3078 } _OrthancPluginGetErrorDescription;
3094 const char* result = NULL;
3096 _OrthancPluginGetErrorDescription params;
3097 params.target = &result;
3098 params.error = error;
3103 return "Unknown error code";
3119 } _OrthancPluginSendHttpStatus;
3150 _OrthancPluginSendHttpStatus params;
3151 params.output = output;
3152 params.status = status;
3154 params.bodySize = bodySize;
3155 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3163 uint32_t* resultUint32;
3165 void** resultBuffer;
3166 } _OrthancPluginGetImageInfo;
3185 _OrthancPluginGetImageInfo params;
3186 memset(¶ms, 0,
sizeof(params));
3187 params.image = image;
3188 params.resultPixelFormat = ⌖
3218 _OrthancPluginGetImageInfo params;
3219 memset(¶ms, 0,
sizeof(params));
3220 params.image = image;
3221 params.resultUint32 = &width;
3251 _OrthancPluginGetImageInfo params;
3252 memset(¶ms, 0,
sizeof(params));
3253 params.image = image;
3254 params.resultUint32 = &height;
3286 _OrthancPluginGetImageInfo params;
3287 memset(¶ms, 0,
sizeof(params));
3288 params.image = image;
3289 params.resultUint32 = &pitch;
3318 void* target = NULL;
3320 _OrthancPluginGetImageInfo params;
3321 memset(¶ms, 0,
sizeof(params));
3322 params.resultBuffer = ⌖
3323 params.image = image;
3342 } _OrthancPluginUncompressImage;
3365 _OrthancPluginUncompressImage params;
3366 memset(¶ms, 0,
sizeof(params));
3367 params.target = ⌖
3370 params.format = format;
3388 } _OrthancPluginFreeImage;
3403 _OrthancPluginFreeImage params;
3404 params.image = image;
3406 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3422 } _OrthancPluginCompressImage;
3453 _OrthancPluginCompressImage params;
3454 memset(¶ms, 0,
sizeof(params));
3455 params.target = target;
3457 params.pixelFormat = format;
3458 params.width = width;
3459 params.height = height;
3460 params.pitch = pitch;
3461 params.buffer = buffer;
3464 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3499 _OrthancPluginCompressImage params;
3500 memset(¶ms, 0,
sizeof(params));
3501 params.target = target;
3503 params.pixelFormat = format;
3504 params.width = width;
3505 params.height = height;
3506 params.pitch = pitch;
3507 params.buffer = buffer;
3508 params.quality = quality;
3510 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3546 _OrthancPluginCompressAndAnswerImage params;
3547 params.output = output;
3549 params.pixelFormat = format;
3550 params.width = width;
3551 params.height = height;
3552 params.pitch = pitch;
3553 params.buffer = buffer;
3554 params.quality = quality;
3555 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3566 const char* username;
3567 const char* password;
3570 } _OrthancPluginCallHttpClient;
3592 const char* username,
3593 const char* password)
3595 _OrthancPluginCallHttpClient params;
3596 memset(¶ms, 0,
sizeof(params));
3598 params.target = target;
3601 params.username = username;
3602 params.password = password;
3604 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3631 const char* username,
3632 const char* password)
3634 _OrthancPluginCallHttpClient params;
3635 memset(¶ms, 0,
sizeof(params));
3637 params.target = target;
3641 params.bodySize = bodySize;
3642 params.username = username;
3643 params.password = password;
3645 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3672 const char* username,
3673 const char* password)
3675 _OrthancPluginCallHttpClient params;
3676 memset(¶ms, 0,
sizeof(params));
3678 params.target = target;
3682 params.bodySize = bodySize;
3683 params.username = username;
3684 params.password = password;
3686 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3706 const char* username,
3707 const char* password)
3709 _OrthancPluginCallHttpClient params;
3710 memset(¶ms, 0,
sizeof(params));
3714 params.username = username;
3715 params.password = password;
3717 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3727 } _OrthancPluginConvertPixelFormat;
3748 _OrthancPluginConvertPixelFormat params;
3749 params.target = ⌖
3750 params.source = source;
3751 params.targetFormat = targetFormat;
3781 _OrthancPluginReturnSingleValue params;
3782 memset(¶ms, 0,
sizeof(params));
3783 params.resultUint32 = &count;
3804 } _OrthancPluginGetFontInfo;
3820 const char* result = NULL;
3822 _OrthancPluginGetFontInfo params;
3823 memset(¶ms, 0,
sizeof(params));
3824 params.name = &result;
3825 params.fontIndex = fontIndex;
3854 _OrthancPluginGetFontInfo params;
3855 memset(¶ms, 0,
sizeof(params));
3856 params.size = &result;
3857 params.fontIndex = fontIndex;
3875 const char* utf8Text;
3881 } _OrthancPluginDrawText;
3905 const char* utf8Text,
3912 _OrthancPluginDrawText params;
3913 memset(¶ms, 0,
sizeof(params));
3914 params.image = image;
3915 params.fontIndex = fontIndex;
3916 params.utf8Text = utf8Text;
3923 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
3932 const void* content;
3935 } _OrthancPluginStorageAreaCreate;
3957 const void* content,
3961 _OrthancPluginStorageAreaCreate params;
3962 params.storageArea = storageArea;
3964 params.content = content;
3968 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
3978 } _OrthancPluginStorageAreaRead;
4002 _OrthancPluginStorageAreaRead params;
4003 params.target = target;
4004 params.storageArea = storageArea;
4008 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4017 } _OrthancPluginStorageAreaRemove;
4038 _OrthancPluginStorageAreaRemove params;
4039 params.storageArea = storageArea;
4043 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4052 uint16_t httpStatus;
4053 const char* message;
4054 } _OrthancPluginRegisterErrorCode;
4074 uint16_t httpStatus,
4075 const char* message)
4079 _OrthancPluginRegisterErrorCode params;
4080 params.target = ⌖
4082 params.httpStatus = httpStatus;
4083 params.message = message;
4104 uint32_t minMultiplicity;
4105 uint32_t maxMultiplicity;
4106 } _OrthancPluginRegisterDictionaryTag;
4133 uint32_t minMultiplicity,
4134 uint32_t maxMultiplicity)
4136 _OrthancPluginRegisterDictionaryTag params;
4137 params.group = group;
4138 params.element = element;
4141 params.minMultiplicity = minMultiplicity;
4142 params.maxMultiplicity = maxMultiplicity;
4144 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4155 uint32_t minMultiplicity;
4156 uint32_t maxMultiplicity;
4157 const char* privateCreator;
4158 } _OrthancPluginRegisterPrivateDictionaryTag;
4186 uint32_t minMultiplicity,
4187 uint32_t maxMultiplicity,
4188 const char* privateCreator)
4190 _OrthancPluginRegisterPrivateDictionaryTag params;
4191 params.group = group;
4192 params.element = element;
4195 params.minMultiplicity = minMultiplicity;
4196 params.maxMultiplicity = maxMultiplicity;
4197 params.privateCreator = privateCreator;
4199 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4208 } _OrthancPluginReconstructMainDicomTags;
4231 _OrthancPluginReconstructMainDicomTags params;
4232 params.level = level;
4233 params.storageArea = storageArea;
4235 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4242 const char* instanceId;
4247 uint32_t maxStringLength;
4248 } _OrthancPluginDicomToJson;
4276 uint32_t maxStringLength)
4280 _OrthancPluginDicomToJson params;
4281 memset(¶ms, 0,
sizeof(params));
4282 params.result = &result;
4283 params.buffer = buffer;
4285 params.format = format;
4286 params.flags = flags;
4287 params.maxStringLength = maxStringLength;
4321 const char* instanceId,
4324 uint32_t maxStringLength)
4328 _OrthancPluginDicomToJson params;
4329 memset(¶ms, 0,
sizeof(params));
4330 params.result = &result;
4331 params.instanceId = instanceId;
4332 params.format = format;
4333 params.flags = flags;
4334 params.maxStringLength = maxStringLength;
4352 uint32_t headersCount;
4353 const char*
const* headersKeys;
4354 const char*
const* headersValues;
4355 int32_t afterPlugins;
4356 } _OrthancPluginRestApiGet2;
4381 uint32_t headersCount,
4382 const char*
const* headersKeys,
4383 const char*
const* headersValues,
4384 int32_t afterPlugins)
4386 _OrthancPluginRestApiGet2 params;
4387 params.target = target;
4389 params.headersCount = headersCount;
4390 params.headersKeys = headersKeys;
4391 params.headersValues = headersValues;
4392 params.afterPlugins = afterPlugins;
4394 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4402 } _OrthancPluginWorklistCallback;
4419 _OrthancPluginWorklistCallback params;
4420 params.callback = callback;
4422 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4433 } _OrthancPluginWorklistAnswersOperation;
4458 _OrthancPluginWorklistAnswersOperation params;
4459 params.answers = answers;
4460 params.query = query;
4461 params.dicom = dicom;
4464 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4485 _OrthancPluginWorklistAnswersOperation params;
4486 params.answers = answers;
4487 params.query = NULL;
4488 params.dicom = NULL;
4491 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4502 } _OrthancPluginWorklistQueryOperation;
4525 int32_t isMatch = 0;
4527 _OrthancPluginWorklistQueryOperation params;
4528 params.query = query;
4529 params.dicom = dicom;
4531 params.isMatch = &isMatch;
4532 params.target = NULL;
4563 _OrthancPluginWorklistQueryOperation params;
4564 params.query = query;
4565 params.dicom = NULL;
4567 params.isMatch = NULL;
4568 params.target = target;
4570 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
4590 _OrthancPluginAccessDicomInstance params;
4591 memset(¶ms, 0,
sizeof(params));
4592 params.resultOrigin = &origin;
4593 params.instance = instance;
4613 } _OrthancPluginCreateDicom;
4640 _OrthancPluginCreateDicom params;
4641 params.target = target;
4643 params.pixelData = pixelData;
4644 params.flags = flags;
4646 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
4653 } _OrthancPluginDecodeImageCallback;
4670 _OrthancPluginDecodeImageCallback params;
4671 params.callback = callback;
4673 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
4686 const void* constBuffer;
4687 uint32_t bufferSize;
4688 uint32_t frameIndex;
4689 } _OrthancPluginCreateImage;
4712 _OrthancPluginCreateImage params;
4713 memset(¶ms, 0,
sizeof(params));
4714 params.target = ⌖
4715 params.format = format;
4716 params.width = width;
4717 params.height = height;
4757 _OrthancPluginCreateImage params;
4758 memset(¶ms, 0,
sizeof(params));
4759 params.target = ⌖
4760 params.format = format;
4761 params.width = width;
4762 params.height = height;
4763 params.pitch = pitch;
4764 params.buffer = buffer;
4795 uint32_t bufferSize,
4796 uint32_t frameIndex)
4800 _OrthancPluginCreateImage params;
4801 memset(¶ms, 0,
sizeof(params));
4802 params.target = ⌖
4803 params.constBuffer = buffer;
4804 params.bufferSize = bufferSize;
4805 params.frameIndex = frameIndex;
4824 } _OrthancPluginComputeHash;
4845 _OrthancPluginComputeHash params;
4846 params.result = &result;
4847 params.buffer = buffer;
4881 _OrthancPluginComputeHash params;
4882 params.result = &result;
4883 params.buffer = buffer;
4903 } _OrthancPluginLookupDictionary;
4925 _OrthancPluginLookupDictionary params;
4926 params.target = target;
4928 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
4937 uint32_t answerSize;
4938 uint32_t headersCount;
4939 const char*
const* headersKeys;
4940 const char*
const* headersValues;
4941 } _OrthancPluginSendMultipartItem2;
4967 uint32_t answerSize,
4968 uint32_t headersCount,
4969 const char*
const* headersKeys,
4970 const char*
const* headersValues)
4972 _OrthancPluginSendMultipartItem2 params;
4973 params.output = output;
4974 params.answer = answer;
4975 params.answerSize = answerSize;
4976 params.headersCount = headersCount;
4977 params.headersKeys = headersKeys;
4978 params.headersValues = headersValues;
4980 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
4987 } _OrthancPluginIncomingHttpRequestFilter;
5004 _OrthancPluginIncomingHttpRequestFilter params;
5005 params.callback = callback;
5007 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5016 uint16_t* httpStatus;
5019 uint32_t headersCount;
5020 const char*
const* headersKeys;
5021 const char*
const* headersValues;
5024 const char* username;
5025 const char* password;
5027 const char* certificateFile;
5028 const char* certificateKeyFile;
5029 const char* certificateKeyPassword;
5031 } _OrthancPluginCallHttpClient2;
5076 uint16_t* httpStatus,
5079 uint32_t headersCount,
5080 const char*
const* headersKeys,
5081 const char*
const* headersValues,
5084 const char* username,
5085 const char* password,
5087 const char* certificateFile,
5088 const char* certificateKeyFile,
5089 const char* certificateKeyPassword,
5092 _OrthancPluginCallHttpClient2 params;
5093 memset(¶ms, 0,
sizeof(params));
5095 params.answerBody = answerBody;
5096 params.answerHeaders = answerHeaders;
5097 params.httpStatus = httpStatus;
5098 params.method = method;
5100 params.headersCount = headersCount;
5101 params.headersKeys = headersKeys;
5102 params.headersValues = headersValues;
5104 params.bodySize = bodySize;
5105 params.username = username;
5106 params.password = password;
5107 params.timeout = timeout;
5108 params.certificateFile = certificateFile;
5109 params.certificateKeyFile = certificateKeyFile;
5110 params.certificateKeyPassword = certificateKeyPassword;
5111 params.pkcs11 = pkcs11;
5113 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5132 _OrthancPluginRetrieveDynamicString params;
5133 params.result = &result;
5134 params.argument = NULL;
5153 } _OrthancPluginFindCallback;
5170 _OrthancPluginFindCallback params;
5171 params.callback = callback;
5173 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5184 uint32_t *resultUint32;
5185 uint16_t *resultGroup;
5186 uint16_t *resultElement;
5187 char **resultString;
5188 } _OrthancPluginFindOperation;
5211 _OrthancPluginFindOperation params;
5212 memset(¶ms, 0,
sizeof(params));
5213 params.answers = answers;
5214 params.dicom = dicom;
5217 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5238 _OrthancPluginFindOperation params;
5239 memset(¶ms, 0,
sizeof(params));
5240 params.answers = answers;
5242 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5264 _OrthancPluginFindOperation params;
5265 memset(¶ms, 0,
sizeof(params));
5266 params.query = query;
5267 params.resultUint32 = &count;
5302 _OrthancPluginFindOperation params;
5303 memset(¶ms, 0,
sizeof(params));
5304 params.query = query;
5305 params.index = index;
5306 params.resultGroup = group;
5307 params.resultElement = element;
5309 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5333 _OrthancPluginFindOperation params;
5334 memset(¶ms, 0,
sizeof(params));
5335 params.query = query;
5336 params.index = index;
5337 params.resultString = &result;
5371 _OrthancPluginFindOperation params;
5372 memset(¶ms, 0,
sizeof(params));
5373 params.query = query;
5374 params.index = index;
5375 params.resultString = &result;
5397 } _OrthancPluginMoveCallback;
5419 _OrthancPluginMoveCallback params;
5420 params.callback = callback;
5421 params.getMoveSize = getMoveSize;
5422 params.applyMove = applyMove;
5423 params.freeMove = freeMove;
5425 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5435 } _OrthancPluginCreateFindMatcher;
5458 _OrthancPluginCreateFindMatcher params;
5459 memset(¶ms, 0,
sizeof(params));
5460 params.target = ⌖
5461 params.query = query;
5478 } _OrthancPluginFreeFindMatcher;
5493 _OrthancPluginFreeFindMatcher params;
5494 params.matcher = matcher;
5496 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5506 } _OrthancPluginFindMatcherIsMatch;
5528 int32_t isMatch = 0;
5530 _OrthancPluginFindMatcherIsMatch params;
5531 params.matcher = matcher;
5532 params.dicom = dicom;
5534 params.isMatch = &isMatch;
Definition: OrthancCPlugin.h:653
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2196
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2375
OrthancPluginChangeType
Definition: OrthancCPlugin.h:610
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2059
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2160
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:4666
The parameters of a REST request.
Definition: OrthancCPlugin.h:315
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1842
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1747
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2262
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:3444
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:3536
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1200
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2229
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:543
Definition: OrthancCPlugin.h:625
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:375
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:370
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:527
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:335
Definition: OrthancCPlugin.h:569
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2461
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1560
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:650
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3816
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3741
Definition: OrthancCPlugin.h:619
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:3995
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3776
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2600
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:567
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2105
Definition: OrthancCPlugin.h:637
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1462
Definition: OrthancCPlugin.h:613
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:4792
uint16_t group
Definition: OrthancCPlugin.h:1159
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3314
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1162
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:2413
Definition: OrthancCPlugin.h:652
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:827
Definition: OrthancCPlugin.h:617
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:1808
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2846
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:535
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3245
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:3143
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3357
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:875
Definition: OrthancCPlugin.h:638
Definition: OrthancCPlugin.h:640
Color image in RGB24 format.
Definition: OrthancCPlugin.h:559
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:551
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1157
Definition: OrthancCPlugin.h:612
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:635
OrthancPluginErrorCode OrthancPluginRestApiGet2(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, int32_t afterPlugins)
Make a GET call to the Orthanc REST API, with custom HTTP headers.
Definition: OrthancCPlugin.h:4377
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3179
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:3901
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3280
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:1519
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1163
OrthancPluginErrorCode(* OrthancPluginDecodeImageCallback)(OrthancPluginImage **target, const void *dicom, const uint32_t size, uint32_t frameIndex)
Signature of a callback function to decode a DICOM instance as an image.
Definition: OrthancCPlugin.h:907
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2082
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:789
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3848
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1593
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:365
Definition: OrthancCPlugin.h:618
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:934
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1724
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:4704
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2709
OrthancPluginErrorCode OrthancPluginSendMultipartItem2(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Send an item as a part of some HTTP multipart answer, with custom headers.
Definition: OrthancCPlugin.h:4963
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:972
Definition: OrthancCPlugin.h:620
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4226
OrthancPluginImage * OrthancPluginCreateImageAccessor(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, void *buffer)
Create an image pointing to a memory buffer.
Definition: OrthancCPlugin.h:4747
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5000
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:345
OrthancPluginErrorCode(* 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:896
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2336
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:2991
Definition: OrthancCPlugin.h:654
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:350
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1402
Definition: OrthancCPlugin.h:623
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:819
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:1772
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:2920
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4032
Definition: OrthancCPlugin.h:624
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:340
Definition: OrthancCPlugin.h:615
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1874
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:4584
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3399
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1161
uint16_t element
Definition: OrthancCPlugin.h:1160
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2014
Definition: OrthancCPlugin.h:622
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2748
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:2949
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:330
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:954
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1909
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:794
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:325
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:355
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2135
Definition: OrthancCPlugin.h:614
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2298
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:1660
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1430
Definition: OrthancCPlugin.h:616
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1368
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:1944
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:1623
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:886
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:1695
Definition: OrthancCPlugin.h:621
Definition: OrthancCPlugin.h:639
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:320
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:3953
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:784
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:1979
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3212
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:3489