114 #define ORTHANC_PLUGINS_API __declspec(dllexport) 116 #define ORTHANC_PLUGINS_API 119 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1 120 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 3 121 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0 139 #ifndef ORTHANC_PLUGIN_INLINE 140 # if __STDC_VERSION__ >= 199901L 142 # define ORTHANC_PLUGIN_INLINE static inline 143 # elif defined(__cplusplus) 145 # define ORTHANC_PLUGIN_INLINE static inline 146 # elif defined(__GNUC__) 148 # define ORTHANC_PLUGIN_INLINE static __inline 149 # elif defined(_MSC_VER) 151 # define ORTHANC_PLUGIN_INLINE static __inline 153 # error Your compiler is not known to support the "inline" keyword 287 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
295 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
308 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
384 _OrthancPluginService_LogInfo = 1,
385 _OrthancPluginService_LogWarning = 2,
386 _OrthancPluginService_LogError = 3,
387 _OrthancPluginService_GetOrthancPath = 4,
388 _OrthancPluginService_GetOrthancDirectory = 5,
389 _OrthancPluginService_GetConfigurationPath = 6,
390 _OrthancPluginService_SetPluginProperty = 7,
391 _OrthancPluginService_GetGlobalProperty = 8,
392 _OrthancPluginService_SetGlobalProperty = 9,
393 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
394 _OrthancPluginService_GetCommandLineArgument = 11,
395 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
396 _OrthancPluginService_GetConfiguration = 13,
397 _OrthancPluginService_BufferCompression = 14,
398 _OrthancPluginService_ReadFile = 15,
399 _OrthancPluginService_WriteFile = 16,
400 _OrthancPluginService_GetErrorDescription = 17,
401 _OrthancPluginService_CallHttpClient = 18,
402 _OrthancPluginService_RegisterErrorCode = 19,
403 _OrthancPluginService_RegisterDictionaryTag = 20,
404 _OrthancPluginService_DicomBufferToJson = 21,
405 _OrthancPluginService_DicomInstanceToJson = 22,
406 _OrthancPluginService_CreateDicom = 23,
407 _OrthancPluginService_ComputeMd5 = 24,
408 _OrthancPluginService_ComputeSha1 = 25,
409 _OrthancPluginService_LookupDictionary = 26,
410 _OrthancPluginService_CallHttpClient2 = 27,
411 _OrthancPluginService_GenerateUuid = 28,
412 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
415 _OrthancPluginService_RegisterRestCallback = 1000,
416 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
417 _OrthancPluginService_RegisterStorageArea = 1002,
418 _OrthancPluginService_RegisterOnChangeCallback = 1003,
419 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
420 _OrthancPluginService_RegisterWorklistCallback = 1005,
421 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
422 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
423 _OrthancPluginService_RegisterFindCallback = 1008,
424 _OrthancPluginService_RegisterMoveCallback = 1009,
425 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
428 _OrthancPluginService_AnswerBuffer = 2000,
429 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
430 _OrthancPluginService_Redirect = 2002,
431 _OrthancPluginService_SendHttpStatusCode = 2003,
432 _OrthancPluginService_SendUnauthorized = 2004,
433 _OrthancPluginService_SendMethodNotAllowed = 2005,
434 _OrthancPluginService_SetCookie = 2006,
435 _OrthancPluginService_SetHttpHeader = 2007,
436 _OrthancPluginService_StartMultipartAnswer = 2008,
437 _OrthancPluginService_SendMultipartItem = 2009,
438 _OrthancPluginService_SendHttpStatus = 2010,
439 _OrthancPluginService_CompressAndAnswerImage = 2011,
440 _OrthancPluginService_SendMultipartItem2 = 2012,
443 _OrthancPluginService_GetDicomForInstance = 3000,
444 _OrthancPluginService_RestApiGet = 3001,
445 _OrthancPluginService_RestApiPost = 3002,
446 _OrthancPluginService_RestApiDelete = 3003,
447 _OrthancPluginService_RestApiPut = 3004,
448 _OrthancPluginService_LookupPatient = 3005,
449 _OrthancPluginService_LookupStudy = 3006,
450 _OrthancPluginService_LookupSeries = 3007,
451 _OrthancPluginService_LookupInstance = 3008,
452 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
453 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
454 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
455 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
456 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
457 _OrthancPluginService_ReconstructMainDicomTags = 3014,
458 _OrthancPluginService_RestApiGet2 = 3015,
461 _OrthancPluginService_GetInstanceRemoteAet = 4000,
462 _OrthancPluginService_GetInstanceSize = 4001,
463 _OrthancPluginService_GetInstanceData = 4002,
464 _OrthancPluginService_GetInstanceJson = 4003,
465 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
466 _OrthancPluginService_HasInstanceMetadata = 4005,
467 _OrthancPluginService_GetInstanceMetadata = 4006,
468 _OrthancPluginService_GetInstanceOrigin = 4007,
471 _OrthancPluginService_RegisterDatabaseBackend = 5000,
472 _OrthancPluginService_DatabaseAnswer = 5001,
473 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
474 _OrthancPluginService_StorageAreaCreate = 5003,
475 _OrthancPluginService_StorageAreaRead = 5004,
476 _OrthancPluginService_StorageAreaRemove = 5005,
479 _OrthancPluginService_GetImagePixelFormat = 6000,
480 _OrthancPluginService_GetImageWidth = 6001,
481 _OrthancPluginService_GetImageHeight = 6002,
482 _OrthancPluginService_GetImagePitch = 6003,
483 _OrthancPluginService_GetImageBuffer = 6004,
484 _OrthancPluginService_UncompressImage = 6005,
485 _OrthancPluginService_FreeImage = 6006,
486 _OrthancPluginService_CompressImage = 6007,
487 _OrthancPluginService_ConvertPixelFormat = 6008,
488 _OrthancPluginService_GetFontsCount = 6009,
489 _OrthancPluginService_GetFontInfo = 6010,
490 _OrthancPluginService_DrawText = 6011,
491 _OrthancPluginService_CreateImage = 6012,
492 _OrthancPluginService_CreateImageAccessor = 6013,
493 _OrthancPluginService_DecodeDicomImage = 6014,
496 _OrthancPluginService_WorklistAddAnswer = 7000,
497 _OrthancPluginService_WorklistMarkIncomplete = 7001,
498 _OrthancPluginService_WorklistIsMatch = 7002,
499 _OrthancPluginService_WorklistGetDicomQuery = 7003,
500 _OrthancPluginService_FindAddAnswer = 7004,
501 _OrthancPluginService_FindMarkIncomplete = 7005,
502 _OrthancPluginService_GetFindQuerySize = 7006,
503 _OrthancPluginService_GetFindQueryTag = 7007,
504 _OrthancPluginService_GetFindQueryTagName = 7008,
505 _OrthancPluginService_GetFindQueryValue = 7009,
506 _OrthancPluginService_CreateFindMatcher = 7010,
507 _OrthancPluginService_FreeFindMatcher = 7011,
508 _OrthancPluginService_FindMatcherIsMatch = 7012,
510 _OrthancPluginService_INTERNAL = 0x7fffffff
511 } _OrthancPluginService;
516 _OrthancPluginProperty_Description = 1,
517 _OrthancPluginProperty_RootUri = 2,
518 _OrthancPluginProperty_OrthancExplorer = 3,
520 _OrthancPluginProperty_INTERNAL = 0x7fffffff
521 } _OrthancPluginProperty;
573 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
587 _OrthancPluginContentType_INTERNAL = 0x7fffffff
603 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
629 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
644 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
658 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
696 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
711 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
722 OrthancPluginDicomToJsonFlags_None = 0,
730 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
741 OrthancPluginCreateDicomFlags_None = 0,
745 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
760 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
775 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
890 const char* instanceId);
901 const char* resourceId);
913 uint32_t frameIndex);
996 const char* issuerAet,
997 const char* calledAet);
1024 uint32_t headersCount,
1025 const char*
const* headersKeys,
1026 const char*
const* headersValues);
1055 uint32_t headersCount,
1056 const char*
const* headersKeys,
1057 const char*
const* headersValues,
1058 uint32_t getArgumentsCount,
1059 const char*
const* getArgumentsKeys,
1060 const char*
const* getArgumentsValues);
1081 const char* issuerAet,
1082 const char* calledAet);
1121 typedef void* (*OrthancPluginMoveCallback) (
1123 const char* patientId,
1124 const char* accessionNumber,
1125 const char* studyInstanceUid,
1126 const char* seriesInstanceUid,
1127 const char* sopInstanceUid,
1128 const char* originatorAet,
1129 const char* sourceAet,
1130 const char* targetAet,
1131 uint16_t originatorId);
1179 typedef struct _OrthancPluginContext_t
1181 void* pluginsManager;
1182 const char* orthancVersion;
1185 _OrthancPluginService service,
1186 const void* params);
1240 int major, minor, revision;
1244 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1245 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1264 if (!strcmp(context->orthancVersion,
"mainline"))
1276 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1283 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1288 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1295 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1300 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1307 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1330 context->Free(buffer->
data);
1344 const char* message)
1346 context->InvokeService(context, _OrthancPluginService_LogError, message);
1360 const char* message)
1362 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1376 const char* message)
1378 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1385 const char* pathRegularExpression;
1387 } _OrthancPluginRestCallback;
1407 const char* pathRegularExpression,
1410 _OrthancPluginRestCallback params;
1411 params.pathRegularExpression = pathRegularExpression;
1412 params.callback = callback;
1413 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1441 const char* pathRegularExpression,
1444 _OrthancPluginRestCallback params;
1445 params.pathRegularExpression = pathRegularExpression;
1446 params.callback = callback;
1447 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1455 } _OrthancPluginOnStoredInstanceCallback;
1471 _OrthancPluginOnStoredInstanceCallback params;
1472 params.callback = callback;
1474 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1483 uint32_t answerSize;
1484 const char* mimeType;
1485 } _OrthancPluginAnswerBuffer;
1503 uint32_t answerSize,
1504 const char* mimeType)
1506 _OrthancPluginAnswerBuffer params;
1507 params.output = output;
1508 params.answer = answer;
1509 params.answerSize = answerSize;
1510 params.mimeType = mimeType;
1511 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1523 } _OrthancPluginCompressAndAnswerPngImage;
1535 } _OrthancPluginCompressAndAnswerImage;
1565 _OrthancPluginCompressAndAnswerImage params;
1566 params.output = output;
1568 params.pixelFormat = format;
1569 params.width = width;
1570 params.height = height;
1571 params.pitch = pitch;
1572 params.buffer = buffer;
1574 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1582 const char* instanceId;
1583 } _OrthancPluginGetDicomForInstance;
1600 const char* instanceId)
1602 _OrthancPluginGetDicomForInstance params;
1603 params.target = target;
1604 params.instanceId = instanceId;
1605 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1614 } _OrthancPluginRestApiGet;
1635 _OrthancPluginRestApiGet params;
1636 params.target = target;
1638 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1665 _OrthancPluginRestApiGet params;
1666 params.target = target;
1668 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1679 } _OrthancPluginRestApiPostPut;
1704 _OrthancPluginRestApiPostPut params;
1705 params.target = target;
1708 params.bodySize = bodySize;
1709 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1739 _OrthancPluginRestApiPostPut params;
1740 params.target = target;
1743 params.bodySize = bodySize;
1744 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1765 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1788 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1816 _OrthancPluginRestApiPostPut params;
1817 params.target = target;
1820 params.bodySize = bodySize;
1821 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1852 _OrthancPluginRestApiPostPut params;
1853 params.target = target;
1856 params.bodySize = bodySize;
1857 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1865 const char* argument;
1866 } _OrthancPluginOutputPlusArgument;
1882 const char* redirection)
1884 _OrthancPluginOutputPlusArgument params;
1885 params.output = output;
1886 params.argument = redirection;
1887 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1895 const char* argument;
1896 } _OrthancPluginRetrieveDynamicString;
1913 const char* patientID)
1917 _OrthancPluginRetrieveDynamicString params;
1918 params.result = &result;
1919 params.argument = patientID;
1948 const char* studyUID)
1952 _OrthancPluginRetrieveDynamicString params;
1953 params.result = &result;
1954 params.argument = studyUID;
1983 const char* accessionNumber)
1987 _OrthancPluginRetrieveDynamicString params;
1988 params.result = &result;
1989 params.argument = accessionNumber;
2018 const char* seriesUID)
2022 _OrthancPluginRetrieveDynamicString params;
2023 params.result = &result;
2024 params.argument = seriesUID;
2053 const char* sopInstanceUID)
2057 _OrthancPluginRetrieveDynamicString params;
2058 params.result = &result;
2059 params.argument = sopInstanceUID;
2078 } _OrthancPluginSendHttpStatusCode;
2101 _OrthancPluginSendHttpStatusCode params;
2102 params.output = output;
2103 params.status = status;
2104 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2124 _OrthancPluginOutputPlusArgument params;
2125 params.output = output;
2126 params.argument = realm;
2127 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2145 const char* allowedMethods)
2147 _OrthancPluginOutputPlusArgument params;
2148 params.output = output;
2149 params.argument = allowedMethods;
2150 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2159 } _OrthancPluginSetHttpHeader;
2178 _OrthancPluginSetHttpHeader params;
2179 params.output = output;
2180 params.key = cookie;
2181 params.value = value;
2182 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2203 _OrthancPluginSetHttpHeader params;
2204 params.output = output;
2206 params.value = value;
2207 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2213 char** resultStringToFree;
2214 const char** resultString;
2215 int64_t* resultInt64;
2219 } _OrthancPluginAccessDicomInstance;
2239 _OrthancPluginAccessDicomInstance params;
2240 memset(¶ms, 0,
sizeof(params));
2241 params.resultString = &result;
2242 params.instance = instance;
2272 _OrthancPluginAccessDicomInstance params;
2273 memset(¶ms, 0,
sizeof(params));
2274 params.resultInt64 = &size;
2275 params.instance = instance;
2305 _OrthancPluginAccessDicomInstance params;
2306 memset(¶ms, 0,
sizeof(params));
2307 params.resultString = &result;
2308 params.instance = instance;
2341 _OrthancPluginAccessDicomInstance params;
2342 memset(¶ms, 0,
sizeof(params));
2343 params.resultStringToFree = &result;
2344 params.instance = instance;
2379 _OrthancPluginAccessDicomInstance params;
2380 memset(¶ms, 0,
sizeof(params));
2381 params.resultStringToFree = &result;
2382 params.instance = instance;
2415 const char* metadata)
2419 _OrthancPluginAccessDicomInstance params;
2420 memset(¶ms, 0,
sizeof(params));
2421 params.resultInt64 = &result;
2422 params.instance = instance;
2423 params.key = metadata;
2432 return (result != 0);
2453 const char* metadata)
2457 _OrthancPluginAccessDicomInstance params;
2458 memset(¶ms, 0,
sizeof(params));
2459 params.resultString = &result;
2460 params.instance = instance;
2461 params.key = metadata;
2482 } _OrthancPluginRegisterStorageArea;
2504 _OrthancPluginRegisterStorageArea params;
2505 params.create = create;
2507 params.remove =
remove;
2510 params.free = ::free;
2515 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2534 _OrthancPluginRetrieveDynamicString params;
2535 params.result = &result;
2536 params.argument = NULL;
2564 _OrthancPluginRetrieveDynamicString params;
2565 params.result = &result;
2566 params.argument = NULL;
2599 _OrthancPluginRetrieveDynamicString params;
2600 params.result = &result;
2601 params.argument = NULL;
2619 } _OrthancPluginOnChangeCallback;
2641 _OrthancPluginOnChangeCallback params;
2642 params.callback = callback;
2644 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2652 _OrthancPluginProperty property;
2654 } _OrthancPluginSetPluginProperty;
2672 _OrthancPluginSetPluginProperty params;
2673 params.plugin = OrthancPluginGetName();
2674 params.property = _OrthancPluginProperty_RootUri;
2677 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2692 const char* description)
2694 _OrthancPluginSetPluginProperty params;
2695 params.plugin = OrthancPluginGetName();
2696 params.property = _OrthancPluginProperty_Description;
2697 params.value = description;
2699 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2714 const char* javascript)
2716 _OrthancPluginSetPluginProperty params;
2717 params.plugin = OrthancPluginGetName();
2718 params.property = _OrthancPluginProperty_OrthancExplorer;
2719 params.value = javascript;
2721 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2730 } _OrthancPluginGlobalProperty;
2749 const char* defaultValue)
2753 _OrthancPluginGlobalProperty params;
2754 params.result = &result;
2755 params.property = property;
2756 params.value = defaultValue;
2790 _OrthancPluginGlobalProperty params;
2791 params.result = NULL;
2792 params.property = property;
2793 params.value = value;
2795 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2802 int32_t *resultInt32;
2803 uint32_t *resultUint32;
2804 int64_t *resultInt64;
2805 uint64_t *resultUint64;
2806 } _OrthancPluginReturnSingleValue;
2821 _OrthancPluginReturnSingleValue params;
2822 memset(¶ms, 0,
sizeof(params));
2823 params.resultUint32 = &count;
2856 _OrthancPluginGlobalProperty params;
2857 params.result = &result;
2858 params.property = (int32_t) argument;
2859 params.value = NULL;
2888 _OrthancPluginReturnSingleValue params;
2889 memset(¶ms, 0,
sizeof(params));
2890 params.resultUint32 = &count;
2920 _OrthancPluginRetrieveDynamicString params;
2921 params.result = &result;
2922 params.argument = NULL;
2940 const char* subType;
2941 const char* contentType;
2942 } _OrthancPluginStartMultipartAnswer;
2960 const char* subType,
2961 const char* contentType)
2963 _OrthancPluginStartMultipartAnswer params;
2964 params.output = output;
2965 params.subType = subType;
2966 params.contentType = contentType;
2967 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
2990 uint32_t answerSize)
2992 _OrthancPluginAnswerBuffer params;
2993 params.output = output;
2994 params.answer = answer;
2995 params.answerSize = answerSize;
2996 params.mimeType = NULL;
2997 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3009 } _OrthancPluginBufferCompression;
3036 _OrthancPluginBufferCompression params;
3037 params.target = target;
3038 params.source = source;
3040 params.compression = compression;
3041 params.uncompress = uncompress;
3043 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3052 } _OrthancPluginReadFile;
3070 _OrthancPluginReadFile params;
3071 params.target = target;
3073 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3083 } _OrthancPluginWriteFile;
3102 _OrthancPluginWriteFile params;
3106 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3113 const char** target;
3115 } _OrthancPluginGetErrorDescription;
3131 const char* result = NULL;
3133 _OrthancPluginGetErrorDescription params;
3134 params.target = &result;
3135 params.error = error;
3140 return "Unknown error code";
3156 } _OrthancPluginSendHttpStatus;
3187 _OrthancPluginSendHttpStatus params;
3188 params.output = output;
3189 params.status = status;
3191 params.bodySize = bodySize;
3192 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3200 uint32_t* resultUint32;
3202 void** resultBuffer;
3203 } _OrthancPluginGetImageInfo;
3222 _OrthancPluginGetImageInfo params;
3223 memset(¶ms, 0,
sizeof(params));
3224 params.image = image;
3225 params.resultPixelFormat = ⌖
3255 _OrthancPluginGetImageInfo params;
3256 memset(¶ms, 0,
sizeof(params));
3257 params.image = image;
3258 params.resultUint32 = &width;
3288 _OrthancPluginGetImageInfo params;
3289 memset(¶ms, 0,
sizeof(params));
3290 params.image = image;
3291 params.resultUint32 = &height;
3323 _OrthancPluginGetImageInfo params;
3324 memset(¶ms, 0,
sizeof(params));
3325 params.image = image;
3326 params.resultUint32 = &pitch;
3355 void* target = NULL;
3357 _OrthancPluginGetImageInfo params;
3358 memset(¶ms, 0,
sizeof(params));
3359 params.resultBuffer = ⌖
3360 params.image = image;
3379 } _OrthancPluginUncompressImage;
3402 _OrthancPluginUncompressImage params;
3403 memset(¶ms, 0,
sizeof(params));
3404 params.target = ⌖
3407 params.format = format;
3425 } _OrthancPluginFreeImage;
3440 _OrthancPluginFreeImage params;
3441 params.image = image;
3443 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3459 } _OrthancPluginCompressImage;
3490 _OrthancPluginCompressImage params;
3491 memset(¶ms, 0,
sizeof(params));
3492 params.target = target;
3494 params.pixelFormat = format;
3495 params.width = width;
3496 params.height = height;
3497 params.pitch = pitch;
3498 params.buffer = buffer;
3501 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3536 _OrthancPluginCompressImage params;
3537 memset(¶ms, 0,
sizeof(params));
3538 params.target = target;
3540 params.pixelFormat = format;
3541 params.width = width;
3542 params.height = height;
3543 params.pitch = pitch;
3544 params.buffer = buffer;
3545 params.quality = quality;
3547 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3583 _OrthancPluginCompressAndAnswerImage params;
3584 params.output = output;
3586 params.pixelFormat = format;
3587 params.width = width;
3588 params.height = height;
3589 params.pitch = pitch;
3590 params.buffer = buffer;
3591 params.quality = quality;
3592 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3603 const char* username;
3604 const char* password;
3607 } _OrthancPluginCallHttpClient;
3629 const char* username,
3630 const char* password)
3632 _OrthancPluginCallHttpClient params;
3633 memset(¶ms, 0,
sizeof(params));
3635 params.target = target;
3638 params.username = username;
3639 params.password = password;
3641 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3668 const char* username,
3669 const char* password)
3671 _OrthancPluginCallHttpClient params;
3672 memset(¶ms, 0,
sizeof(params));
3674 params.target = target;
3678 params.bodySize = bodySize;
3679 params.username = username;
3680 params.password = password;
3682 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3709 const char* username,
3710 const char* password)
3712 _OrthancPluginCallHttpClient params;
3713 memset(¶ms, 0,
sizeof(params));
3715 params.target = target;
3719 params.bodySize = bodySize;
3720 params.username = username;
3721 params.password = password;
3723 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3743 const char* username,
3744 const char* password)
3746 _OrthancPluginCallHttpClient params;
3747 memset(¶ms, 0,
sizeof(params));
3751 params.username = username;
3752 params.password = password;
3754 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3764 } _OrthancPluginConvertPixelFormat;
3785 _OrthancPluginConvertPixelFormat params;
3786 params.target = ⌖
3787 params.source = source;
3788 params.targetFormat = targetFormat;
3818 _OrthancPluginReturnSingleValue params;
3819 memset(¶ms, 0,
sizeof(params));
3820 params.resultUint32 = &count;
3841 } _OrthancPluginGetFontInfo;
3857 const char* result = NULL;
3859 _OrthancPluginGetFontInfo params;
3860 memset(¶ms, 0,
sizeof(params));
3861 params.name = &result;
3862 params.fontIndex = fontIndex;
3891 _OrthancPluginGetFontInfo params;
3892 memset(¶ms, 0,
sizeof(params));
3893 params.size = &result;
3894 params.fontIndex = fontIndex;
3912 const char* utf8Text;
3918 } _OrthancPluginDrawText;
3942 const char* utf8Text,
3949 _OrthancPluginDrawText params;
3950 memset(¶ms, 0,
sizeof(params));
3951 params.image = image;
3952 params.fontIndex = fontIndex;
3953 params.utf8Text = utf8Text;
3960 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
3969 const void* content;
3972 } _OrthancPluginStorageAreaCreate;
3994 const void* content,
3998 _OrthancPluginStorageAreaCreate params;
3999 params.storageArea = storageArea;
4001 params.content = content;
4005 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4015 } _OrthancPluginStorageAreaRead;
4039 _OrthancPluginStorageAreaRead params;
4040 params.target = target;
4041 params.storageArea = storageArea;
4045 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4054 } _OrthancPluginStorageAreaRemove;
4075 _OrthancPluginStorageAreaRemove params;
4076 params.storageArea = storageArea;
4080 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4089 uint16_t httpStatus;
4090 const char* message;
4091 } _OrthancPluginRegisterErrorCode;
4111 uint16_t httpStatus,
4112 const char* message)
4116 _OrthancPluginRegisterErrorCode params;
4117 params.target = ⌖
4119 params.httpStatus = httpStatus;
4120 params.message = message;
4141 uint32_t minMultiplicity;
4142 uint32_t maxMultiplicity;
4143 } _OrthancPluginRegisterDictionaryTag;
4170 uint32_t minMultiplicity,
4171 uint32_t maxMultiplicity)
4173 _OrthancPluginRegisterDictionaryTag params;
4174 params.group = group;
4175 params.element = element;
4178 params.minMultiplicity = minMultiplicity;
4179 params.maxMultiplicity = maxMultiplicity;
4181 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4192 uint32_t minMultiplicity;
4193 uint32_t maxMultiplicity;
4194 const char* privateCreator;
4195 } _OrthancPluginRegisterPrivateDictionaryTag;
4223 uint32_t minMultiplicity,
4224 uint32_t maxMultiplicity,
4225 const char* privateCreator)
4227 _OrthancPluginRegisterPrivateDictionaryTag params;
4228 params.group = group;
4229 params.element = element;
4232 params.minMultiplicity = minMultiplicity;
4233 params.maxMultiplicity = maxMultiplicity;
4234 params.privateCreator = privateCreator;
4236 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4245 } _OrthancPluginReconstructMainDicomTags;
4268 _OrthancPluginReconstructMainDicomTags params;
4269 params.level = level;
4270 params.storageArea = storageArea;
4272 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4279 const char* instanceId;
4284 uint32_t maxStringLength;
4285 } _OrthancPluginDicomToJson;
4313 uint32_t maxStringLength)
4317 _OrthancPluginDicomToJson params;
4318 memset(¶ms, 0,
sizeof(params));
4319 params.result = &result;
4320 params.buffer = buffer;
4322 params.format = format;
4323 params.flags = flags;
4324 params.maxStringLength = maxStringLength;
4358 const char* instanceId,
4361 uint32_t maxStringLength)
4365 _OrthancPluginDicomToJson params;
4366 memset(¶ms, 0,
sizeof(params));
4367 params.result = &result;
4368 params.instanceId = instanceId;
4369 params.format = format;
4370 params.flags = flags;
4371 params.maxStringLength = maxStringLength;
4389 uint32_t headersCount;
4390 const char*
const* headersKeys;
4391 const char*
const* headersValues;
4392 int32_t afterPlugins;
4393 } _OrthancPluginRestApiGet2;
4418 uint32_t headersCount,
4419 const char*
const* headersKeys,
4420 const char*
const* headersValues,
4421 int32_t afterPlugins)
4423 _OrthancPluginRestApiGet2 params;
4424 params.target = target;
4426 params.headersCount = headersCount;
4427 params.headersKeys = headersKeys;
4428 params.headersValues = headersValues;
4429 params.afterPlugins = afterPlugins;
4431 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4439 } _OrthancPluginWorklistCallback;
4456 _OrthancPluginWorklistCallback params;
4457 params.callback = callback;
4459 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4470 } _OrthancPluginWorklistAnswersOperation;
4495 _OrthancPluginWorklistAnswersOperation params;
4496 params.answers = answers;
4497 params.query = query;
4498 params.dicom = dicom;
4501 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4522 _OrthancPluginWorklistAnswersOperation params;
4523 params.answers = answers;
4524 params.query = NULL;
4525 params.dicom = NULL;
4528 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4539 } _OrthancPluginWorklistQueryOperation;
4562 int32_t isMatch = 0;
4564 _OrthancPluginWorklistQueryOperation params;
4565 params.query = query;
4566 params.dicom = dicom;
4568 params.isMatch = &isMatch;
4569 params.target = NULL;
4600 _OrthancPluginWorklistQueryOperation params;
4601 params.query = query;
4602 params.dicom = NULL;
4604 params.isMatch = NULL;
4605 params.target = target;
4607 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
4627 _OrthancPluginAccessDicomInstance params;
4628 memset(¶ms, 0,
sizeof(params));
4629 params.resultOrigin = &origin;
4630 params.instance = instance;
4650 } _OrthancPluginCreateDicom;
4677 _OrthancPluginCreateDicom params;
4678 params.target = target;
4680 params.pixelData = pixelData;
4681 params.flags = flags;
4683 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
4690 } _OrthancPluginDecodeImageCallback;
4707 _OrthancPluginDecodeImageCallback params;
4708 params.callback = callback;
4710 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
4723 const void* constBuffer;
4724 uint32_t bufferSize;
4725 uint32_t frameIndex;
4726 } _OrthancPluginCreateImage;
4749 _OrthancPluginCreateImage params;
4750 memset(¶ms, 0,
sizeof(params));
4751 params.target = ⌖
4752 params.format = format;
4753 params.width = width;
4754 params.height = height;
4794 _OrthancPluginCreateImage params;
4795 memset(¶ms, 0,
sizeof(params));
4796 params.target = ⌖
4797 params.format = format;
4798 params.width = width;
4799 params.height = height;
4800 params.pitch = pitch;
4801 params.buffer = buffer;
4832 uint32_t bufferSize,
4833 uint32_t frameIndex)
4837 _OrthancPluginCreateImage params;
4838 memset(¶ms, 0,
sizeof(params));
4839 params.target = ⌖
4840 params.constBuffer = buffer;
4841 params.bufferSize = bufferSize;
4842 params.frameIndex = frameIndex;
4861 } _OrthancPluginComputeHash;
4882 _OrthancPluginComputeHash params;
4883 params.result = &result;
4884 params.buffer = buffer;
4918 _OrthancPluginComputeHash params;
4919 params.result = &result;
4920 params.buffer = buffer;
4940 } _OrthancPluginLookupDictionary;
4962 _OrthancPluginLookupDictionary params;
4963 params.target = target;
4965 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
4974 uint32_t answerSize;
4975 uint32_t headersCount;
4976 const char*
const* headersKeys;
4977 const char*
const* headersValues;
4978 } _OrthancPluginSendMultipartItem2;
5004 uint32_t answerSize,
5005 uint32_t headersCount,
5006 const char*
const* headersKeys,
5007 const char*
const* headersValues)
5009 _OrthancPluginSendMultipartItem2 params;
5010 params.output = output;
5011 params.answer = answer;
5012 params.answerSize = answerSize;
5013 params.headersCount = headersCount;
5014 params.headersKeys = headersKeys;
5015 params.headersValues = headersValues;
5017 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5024 } _OrthancPluginIncomingHttpRequestFilter;
5042 _OrthancPluginIncomingHttpRequestFilter params;
5043 params.callback = callback;
5045 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5054 uint16_t* httpStatus;
5057 uint32_t headersCount;
5058 const char*
const* headersKeys;
5059 const char*
const* headersValues;
5062 const char* username;
5063 const char* password;
5065 const char* certificateFile;
5066 const char* certificateKeyFile;
5067 const char* certificateKeyPassword;
5069 } _OrthancPluginCallHttpClient2;
5114 uint16_t* httpStatus,
5117 uint32_t headersCount,
5118 const char*
const* headersKeys,
5119 const char*
const* headersValues,
5122 const char* username,
5123 const char* password,
5125 const char* certificateFile,
5126 const char* certificateKeyFile,
5127 const char* certificateKeyPassword,
5130 _OrthancPluginCallHttpClient2 params;
5131 memset(¶ms, 0,
sizeof(params));
5133 params.answerBody = answerBody;
5134 params.answerHeaders = answerHeaders;
5135 params.httpStatus = httpStatus;
5136 params.method = method;
5138 params.headersCount = headersCount;
5139 params.headersKeys = headersKeys;
5140 params.headersValues = headersValues;
5142 params.bodySize = bodySize;
5143 params.username = username;
5144 params.password = password;
5145 params.timeout = timeout;
5146 params.certificateFile = certificateFile;
5147 params.certificateKeyFile = certificateKeyFile;
5148 params.certificateKeyPassword = certificateKeyPassword;
5149 params.pkcs11 = pkcs11;
5151 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5170 _OrthancPluginRetrieveDynamicString params;
5171 params.result = &result;
5172 params.argument = NULL;
5191 } _OrthancPluginFindCallback;
5208 _OrthancPluginFindCallback params;
5209 params.callback = callback;
5211 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5222 uint32_t *resultUint32;
5223 uint16_t *resultGroup;
5224 uint16_t *resultElement;
5225 char **resultString;
5226 } _OrthancPluginFindOperation;
5249 _OrthancPluginFindOperation params;
5250 memset(¶ms, 0,
sizeof(params));
5251 params.answers = answers;
5252 params.dicom = dicom;
5255 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5276 _OrthancPluginFindOperation params;
5277 memset(¶ms, 0,
sizeof(params));
5278 params.answers = answers;
5280 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5302 _OrthancPluginFindOperation params;
5303 memset(¶ms, 0,
sizeof(params));
5304 params.query = query;
5305 params.resultUint32 = &count;
5340 _OrthancPluginFindOperation params;
5341 memset(¶ms, 0,
sizeof(params));
5342 params.query = query;
5343 params.index = index;
5344 params.resultGroup = group;
5345 params.resultElement = element;
5347 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5371 _OrthancPluginFindOperation params;
5372 memset(¶ms, 0,
sizeof(params));
5373 params.query = query;
5374 params.index = index;
5375 params.resultString = &result;
5409 _OrthancPluginFindOperation params;
5410 memset(¶ms, 0,
sizeof(params));
5411 params.query = query;
5412 params.index = index;
5413 params.resultString = &result;
5435 } _OrthancPluginMoveCallback;
5457 _OrthancPluginMoveCallback params;
5458 params.callback = callback;
5459 params.getMoveSize = getMoveSize;
5460 params.applyMove = applyMove;
5461 params.freeMove = freeMove;
5463 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5473 } _OrthancPluginCreateFindMatcher;
5496 _OrthancPluginCreateFindMatcher params;
5497 memset(¶ms, 0,
sizeof(params));
5498 params.target = ⌖
5499 params.query = query;
5516 } _OrthancPluginFreeFindMatcher;
5531 _OrthancPluginFreeFindMatcher params;
5532 params.matcher = matcher;
5534 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5544 } _OrthancPluginFindMatcherIsMatch;
5566 int32_t isMatch = 0;
5568 _OrthancPluginFindMatcherIsMatch params;
5569 params.matcher = matcher;
5570 params.dicom = dicom;
5572 params.isMatch = &isMatch;
5589 } _OrthancPluginIncomingHttpRequestFilter2;
5606 _OrthancPluginIncomingHttpRequestFilter2 params;
5607 params.callback = callback;
5609 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
Definition: OrthancCPlugin.h:655
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2233
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2412
OrthancPluginChangeType
Definition: OrthancCPlugin.h:612
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2096
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2197
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:4703
The parameters of a REST request.
Definition: OrthancCPlugin.h:316
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1879
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1784
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2299
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:3481
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:3573
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1237
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2266
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:545
Definition: OrthancCPlugin.h:627
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:376
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:371
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:529
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:336
Definition: OrthancCPlugin.h:571
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2498
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1597
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:652
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3853
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3778
Definition: OrthancCPlugin.h:621
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4032
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3813
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2637
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:569
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2142
Definition: OrthancCPlugin.h:639
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1499
Definition: OrthancCPlugin.h:615
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:4829
uint16_t group
Definition: OrthancCPlugin.h:1196
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3351
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1199
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:2450
Definition: OrthancCPlugin.h:654
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:829
Definition: OrthancCPlugin.h:619
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:1845
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2883
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:537
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3282
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:3180
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3394
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:877
Definition: OrthancCPlugin.h:640
Definition: OrthancCPlugin.h:642
Color image in RGB24 format.
Definition: OrthancCPlugin.h:561
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5602
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:553
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1194
Definition: OrthancCPlugin.h:614
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:637
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:4414
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3216
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:3938
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3317
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:1556
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1200
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:909
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2119
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:791
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3885
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1630
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:366
Definition: OrthancCPlugin.h:620
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:936
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1761
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:4741
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2746
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:5000
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:974
Definition: OrthancCPlugin.h:622
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4263
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:4784
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5038
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:346
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:898
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2373
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:3028
Definition: OrthancCPlugin.h:656
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:351
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1439
Definition: OrthancCPlugin.h:625
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:821
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:1809
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:2957
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4069
Definition: OrthancCPlugin.h:626
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:341
Definition: OrthancCPlugin.h:617
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1911
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:4621
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3436
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1198
uint16_t element
Definition: OrthancCPlugin.h:1197
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2051
Definition: OrthancCPlugin.h:624
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2785
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:2986
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:331
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:956
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1946
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:796
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:326
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:356
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2172
Definition: OrthancCPlugin.h:616
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2335
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:1697
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1467
Definition: OrthancCPlugin.h:618
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1405
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:1981
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:1660
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:888
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:1732
Definition: OrthancCPlugin.h:623
Definition: OrthancCPlugin.h:641
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:321
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:3990
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:786
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2016
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3249
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:3526