orthanc: Plugins/Include/orthanc/OrthancCPlugin.h comparison

comparison Plugins/Include/orthanc/OrthancCPlugin.h @ 1601:6cccf1da35c6

groups in the plugin documentation

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 01 Sep 2015 12:42:49 +0200
parents	7151d63e6d81
children	292bce3f54ed

comparison

equal deleted inserted replaced

-:7151d63e6d81
+:6cccf1da35c6
 **/
 /**
-* @defgroup CInterface C Interface
+* @defgroup Compression Compression
-* @brief The C interface to create Orthanc plugins.
+* @brief Functions to deal with images and compressed buffers.
 *
-* These functions must be used to create C plugins for Orthanc.
+* @defgroup REST REST
+* @brief Functions to answer REST requests in a callback.
+*
+* @defgroup Callbacks Callbacks
+* @brief Functions to register and manage callbacks by the plugins.
+*
+* @defgroup Orthanc Orthanc
+* @brief Functions to access the content of the Orthanc server.
+**/
+/**
+* @defgroup Toolbox Toolbox
+* @brief Generic functions to help with the creation of plugins.
 **/
 /**
 } OrthancPluginHttpMethod;
 /**
 * @brief The parameters of a REST request.
+* @ingroup Callbacks
 **/
 typedef struct
 {
 /**
 * @brief The HTTP method.
 /**
 * The memory layout of the pixels of an image.
+* @ingroup Compression
 **/
 typedef enum
 {
 /**
 * @brief Graylevel 8bpp image.
 /**
 * The supported types of changes that can happen to DICOM resources.
+* @ingroup Callbacks
 **/
 typedef enum
 {
 OrthancPluginChangeType_CompletedSeries = 0,    /*!< Series is now complete */
 OrthancPluginChangeType_Deleted = 1,            /*!< Deleted resource */
 } OrthancPluginChangeType;
 /**
 * The compression algorithms that are supported by the Orthanc core.
+* @ingroup Compression
 **/
 typedef enum
 {
 OrthancPluginCompressionType_Zlib = 0,          /*!< Standard zlib compression */
 OrthancPluginCompressionType_ZlibWithSize = 1,  /*!< zlib, prefixed with uncompressed size (uint64_t) */
 } OrthancPluginCompressionType;
 /**
 * The image formats that are supported by the Orthanc core.
+* @ingroup Compression
 **/
 typedef enum
 {
 OrthancPluginImageFormat_Png = 0,   /*!< Image compressed using PNG */
 OrthancPluginImageFormat_Jpeg = 1,  /*!< Image compressed using JPEG */
 /**
 * @brief Opaque structure that represents the HTTP connection to the client application.
+* @ingroup Callback
 **/
 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
 /**
 * @brief Opaque structure that represents a uncompressed image in memory.
+* @ingroup Compression
 **/
 typedef struct _OrthancPluginImage_t OrthancPluginImage;
 /**
 * @brief Signature of a callback function that answers to a REST request.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginRestCallback) (
 OrthancPluginRestOutput* output,
 const char* url,
 const OrthancPluginHttpRequest* request);
 /**
 * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginOnStoredInstanceCallback) (
 OrthancPluginDicomInstance* instance,
 const char* instanceId);
 /**
 * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginOnChangeCallback) (
 OrthancPluginChangeType changeType,
 OrthancPluginResourceType resourceType,
 const char* resourceId);
 * @param uuid The UUID of the file.
 * @param content The content of the file.
 * @param size The size of the file.
 * @param type The content type corresponding to this file.
 * @return 0 if success, other value if error.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginStorageCreate) (
 const char* uuid,
 const void* content,
 int64_t size,
 * @param content The content of the file (output).
 * @param size The size of the file (output).
 * @param uuid The UUID of the file of interest.
 * @param type The content type corresponding to this file.
 * @return 0 if success, other value if error.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginStorageRead) (
 void** content,
 int64_t* size,
 const char* uuid,
 * Signature of a callback function that is triggered when Orthanc deletes a file from the storage area.
 *
 * @param uuid The UUID of the file to be removed.
 * @param type The content type corresponding to this file.
 * @return 0 if success, other value if error.
+* @ingroup Callbacks
 **/
 typedef int32_t (*OrthancPluginStorageRemove) (
 const char* uuid,
 OrthancPluginContentType type);
 * OrthancPluginInitialize() entry point of the plugin.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @return 1 if and only if the versions are compatible. If the
 * result is 0, the initialization of the plugin should fail.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE int  OrthancPluginCheckVersion(
 OrthancPluginContext* context)
 {
 int major, minor, revision;
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param pathRegularExpression Regular expression for the URI. May contain groups.
 * @param callback The callback function to handle the REST call.
 * @see OrthancPluginRegisterRestCallbackNoLock()
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
 OrthancPluginContext*     context,
 const char*               pathRegularExpression,
 OrthancPluginRestCallback callback)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param pathRegularExpression Regular expression for the URI. May contain groups.
 * @param callback The callback function to handle the REST call.
 * @see OrthancPluginRegisterRestCallback()
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock(
 OrthancPluginContext*     context,
 const char*               pathRegularExpression,
 OrthancPluginRestCallback callback)
 * This function registers a callback function that is called
 * whenever a new DICOM instance is stored into the Orthanc core.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param callback The callback function.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
 OrthancPluginContext*                  context,
 OrthancPluginOnStoredInstanceCallback  callback)
 {
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param answer Pointer to the memory buffer containing the answer.
 * @param answerSize Number of bytes of the answer.
 * @param mimeType The MIME type of the answer.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              answer,
 * @param width The width of the image.
 * @param height The height of the image.
 * @param pitch The pitch of the image (i.e. the number of bytes
 * between 2 successive lines of the image in the memory buffer).
 * @param buffer The memory buffer containing the uncompressed image.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
 OrthancPluginContext*     context,
 OrthancPluginRestOutput*  output,
 OrthancPluginPixelFormat  format,
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param target The target memory buffer.
 * @param instanceId The Orthanc identifier of the DICOM instance of interest.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginGetDicomForInstance(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 instanceId)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiGet(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiGetAfterPlugins(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri)
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @param body The body of the POST request.
 * @param bodySize The size of the body.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiPost(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri,
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @param body The body of the POST request.
 * @param bodySize The size of the body.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiPostAfterPlugins(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri,
 * Make a DELETE call to the built-in Orthanc REST API.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param uri The URI to delete in the built-in Orthanc API.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiDelete(
 OrthancPluginContext*       context,
 const char*                 uri)
 {
 * return the result provided by this plugin.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param uri The URI to delete in the built-in Orthanc API.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiDeleteAfterPlugins(
 OrthancPluginContext*       context,
 const char*                 uri)
 {
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @param body The body of the PUT request.
 * @param bodySize The size of the body.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiPut(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri,
 * @param target The target memory buffer.
 * @param uri The URI in the built-in Orthanc API.
 * @param body The body of the PUT request.
 * @param bodySize The size of the body.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode  OrthancPluginRestApiPutAfterPlugins(
 OrthancPluginContext*       context,
 OrthancPluginMemoryBuffer*  target,
 const char*                 uri,
 * to another URI using HTTP status 301.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param redirection Where to redirect.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              redirection)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param patientID The Patient ID of interest.
 * @return The NULL value if the patient is non-existent, or a string containing the
 * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
 OrthancPluginContext*  context,
 const char*            patientID)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param studyUID The Study Instance UID of interest.
 * @return The NULL value if the study is non-existent, or a string containing the
 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
 OrthancPluginContext*  context,
 const char*            studyUID)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param accessionNumber The Accession Number of interest.
 * @return The NULL value if the study is non-existent, or a string containing the
 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
 OrthancPluginContext*  context,
 const char*            accessionNumber)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param seriesUID The Series Instance UID of interest.
 * @return The NULL value if the series is non-existent, or a string containing the
 * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
 OrthancPluginContext*  context,
 const char*            seriesUID)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param sopInstanceUID The SOP Instance UID of interest.
 * @return The NULL value if the instance is non-existent, or a string containing the
 * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
 OrthancPluginContext*  context,
 const char*            sopInstanceUID)
 {
 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param status The HTTP status code to be sent.
+* @ingroup REST
 * @see OrthancPluginSendHttpStatus()
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 * not authorized.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param realm The realm for the authorization process.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              realm)
 * queried URI does not support this method.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              allowedMethods)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param cookie The cookie to be set.
 * @param value The value of the cookie.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              cookie,
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param output The HTTP connection to the client application.
 * @param key The HTTP header to be set.
 * @param value The value of the HTTP header.
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              key,
 * DICOM modality from which a DICOM instance originates.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @return The AET if success, NULL if error.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance)
 {
 * This function returns the number of bytes of the given DICOM instance.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @return The size of the file, -1 in case of error.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
 OrthancPluginContext*       context,
 OrthancPluginDicomInstance* instance)
 {
 * This function returns a pointer to the content of the given DICOM instance.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @return The pointer to the DICOM data, NULL in case of error.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @return The NULL value in case of error, or a string containing the JSON file.
 * This string must be freed by OrthancPluginFreeString().
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @return The NULL value in case of error, or a string containing the JSON file.
 * This string must be freed by OrthancPluginFreeString().
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance)
 {
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @param metadata The metadata of interest.
 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE int  OrthancPluginHasInstanceMetadata(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance,
 const char*                  metadata)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param instance The instance of interest.
 * @param metadata The metadata of interest.
 * @return The metadata value if success, NULL if error.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
 OrthancPluginContext*        context,
 OrthancPluginDicomInstance*  instance,
 const char*                  metadata)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param create The callback function to store a file on the custom storage area.
 * @param read The callback function to read a file from the custom storage area.
 * @param remove The callback function to remove a file from the custom storage area.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea(
 OrthancPluginContext*       context,
 OrthancPluginStorageCreate  create,
 OrthancPluginStorageRead    read,
 * This function registers a callback function that is called
 * whenever a change happens to some DICOM resource.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param callback The callback function.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
 OrthancPluginContext*          context,
 OrthancPluginOnChangeCallback  callback)
 {
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param property The global property of interest.
 * @param defaultValue The value to return, if the global property is unset.
 * @return The value of the global property, or NULL in the case of an error. This
 * string must be freed by OrthancPluginFreeString().
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetGlobalProperty(
 OrthancPluginContext*  context,
 int32_t                property,
 const char*            defaultValue)
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param property The global property of interest.
 * @param value The value to be set in the global property.
 * @return 0 if success, or the error code if failure.
+* @ingroup Orthanc
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetGlobalProperty(
 OrthancPluginContext*  context,
 int32_t                property,
 const char*            value)
 *
 * Retrieve the expected version of the database schema.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @return The version.
+* @ingroup Callbacks
 **/
 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
 OrthancPluginContext*  context)
 {
 uint32_t count = 0;
 * @param output The HTTP connection to the client application.
 * @param subType The sub-type of the multipart answer ("mixed" or "related").
 * @param contentType The MIME type of the items in the multipart answer.
 * @return 0 if success, or the error code if failure.
 * @see OrthancPluginSendMultipartItem()
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              subType,
 * @param output The HTTP connection to the client application.
 * @param answer Pointer to the memory buffer containing the item.
 * @param answerSize Number of bytes of the item.
 * @return 0 if success, or the error code if failure (this notably happens
 * if the connection is closed by the client).
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 const char*              answer,
 * @param size The size in bytes of the source buffer.
 * @param compression The compression algorithm.
 * @param uncompress If set to "0", the buffer must be compressed.
 * If set to "1", the buffer must be uncompressed.
 * @return 0 if success, or the error code if failure.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginBufferCompression(
 OrthancPluginContext*         context,
 OrthancPluginMemoryBuffer*    target,
 const void*                   source,
 * @param output The HTTP connection to the client application.
 * @param status The HTTP status code to be sent.
 * @param body The body of the answer.
 * @param bodySize The size of the body.
 * @see OrthancPluginSendHttpStatusCode()
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
 OrthancPluginContext*    context,
 OrthancPluginRestOutput* output,
 uint16_t                 status,
 * This function returns the type of memory layout for the pixels of the given image.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image of interest.
 * @return The pixel format.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat  OrthancPluginGetImagePixelFormat(
 OrthancPluginContext*      context,
 const OrthancPluginImage*  image)
 {
 * This function returns the width of the given image.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image of interest.
 * @return The width.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE uint32_t  OrthancPluginGetImageWidth(
 OrthancPluginContext*      context,
 const OrthancPluginImage*  image)
 {
 * This function returns the height of the given image.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image of interest.
 * @return The height.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE uint32_t  OrthancPluginGetImageHeight(
 OrthancPluginContext*      context,
 const OrthancPluginImage*  image)
 {
 * image in the memory buffer.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image of interest.
 * @return The pitch.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE uint32_t  OrthancPluginGetImagePitch(
 OrthancPluginContext*      context,
 const OrthancPluginImage*  image)
 {
 * contains the pixels of the image.
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image of interest.
 * @return The pointer.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE const void*  OrthancPluginGetImageBuffer(
 OrthancPluginContext*      context,
 const OrthancPluginImage*  image)
 {
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param data Pointer to a memory buffer containing the compressed image.
 * @param size Size of the memory buffer containing the compressed image.
 * @param format The file format of the compressed image.
 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage().
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage(
 OrthancPluginContext*      context,
 const void*                data,
 uint32_t                   size,
 *
 * This function frees an image that was decoded with OrthancPluginUncompressImage().
 *
 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 * @param image The image.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE void  OrthancPluginFreeImage(
 OrthancPluginContext* context,
 OrthancPluginImage*   image)
 {
 uint8_t                    quality;
 } _OrthancPluginCompressImage;
 /**
-* @brief Create a PNG image.
+* @brief Encode a PNG image.
 *
 * This function compresses the given memory buffer containing an
 * image using the PNG specification, and stores the result of the
 * compression into a newly allocated memory buffer.
 *
 * @param pitch The pitch of the image (i.e. the number of bytes
 * between 2 successive lines of the image in the memory buffer).
 * @param buffer The memory buffer containing the uncompressed image.
 * @return 0 if success, or the error code if failure.
 * @see OrthancPluginCompressAndAnswerPngImage()
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage(
 OrthancPluginContext*         context,
 OrthancPluginMemoryBuffer*    target,
 OrthancPluginPixelFormat      format,
 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
 }
 /**
-* @brief Create a JPEG image.
+* @brief Encode a JPEG image.
 *
 * This function compresses the given memory buffer containing an
 * image using the JPEG specification, and stores the result of the
 * compression into a newly allocated memory buffer.
 *
 * @param buffer The memory buffer containing the uncompressed image.
 * @param quality The quality of the JPEG encoding, between 1 (worst
 * quality, best compression) and 100 (best quality, worst
 * compression).
 * @return 0 if success, or the error code if failure.
+* @ingroup Compression
 **/
 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage(
 OrthancPluginContext*         context,
 OrthancPluginMemoryBuffer*    target,
 OrthancPluginPixelFormat      format,
 * between 2 successive lines of the image in the memory buffer).
 * @param buffer The memory buffer containing the uncompressed image.
 * @param quality The quality of the JPEG encoding, between 1 (worst
 * quality, best compression) and 100 (best quality, worst
 * compression).
+* @ingroup REST
 **/
 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage(
 OrthancPluginContext*     context,
 OrthancPluginRestOutput*  output,
 OrthancPluginPixelFormat  format,

Mercurial > hg > orthanc

comparison Plugins/Include/orthanc/OrthancCPlugin.h @ 1601:6cccf1da35c6