From dd4f4f38becaaf0a9b4173d4d007deac81a9b656 Mon Sep 17 00:00:00 2001 From: Jiyong Date: Fri, 13 Sep 2024 13:18:52 +0900 Subject: [PATCH] Improve API description Change-Id: I8f023f2028ed8f498168385bed4e8fedd57ddc26 --- include/image_util.h | 214 ++++++++++++++++++++------------------------ include/image_util_decode.h | 81 ++--------------- include/image_util_encode.h | 153 ++++++------------------------- include/image_util_type.h | 47 +++++----- 4 files changed, 156 insertions(+), 339 deletions(-) diff --git a/include/image_util.h b/include/image_util.h index ee7793c..9a2a6fa 100644 --- a/include/image_util.h +++ b/include/image_util.h @@ -75,7 +75,7 @@ int image_util_extract_color_from_memory(const unsigned char *image_buffer, int * * @remarks The @a handle should be released using image_util_transform_destroy(). * -* @param[out] handle The handle for transforming an image +* @param[out] handle The handle of image util tranform * * @return @c 0 on success, * otherwise a negative error value @@ -90,11 +90,11 @@ int image_util_extract_color_from_memory(const unsigned char *image_buffer, int int image_util_transform_create(transformation_h *handle); /** -* @brief Sets the information of the converting. +* @brief Sets the information of the colorspace to transform. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in] colorspace The colorspace of the image buffer +* @param[in] handle The handle for image util transform +* @param[in] colorspace The colorspace to transform * * @return @c 0 on success, * otherwise a negative error value @@ -104,23 +104,22 @@ int image_util_transform_create(transformation_h *handle); * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_transform_create(). +* @pre image_util_transform_create() +* +* @see image_util_transform_get_colorspace() * -* @see image_util_transform_create() -* @see image_util_transform_run() -* @see image_util_transform_destroy() */ int image_util_transform_set_colorspace(transformation_h handle, image_util_colorspace_e colorspace); /** -* @brief Sets the information of the resizing. +* @brief Sets the information of the resolution to transform. * @since_tizen 2.3 * * @remarks image_util_transform_set_resolution() and image_util_transform_set_crop_area() can't do that at the same time. * -* @param[in] handle The handle for transforming an image -* @param[in] width The width of image buffer -* @param[in] height The height of image buffer +* @param[in] handle The handle for image util transform +* @param[in] width The width to transform +* @param[in] height The height to transform * * @return @c 0 on success, * otherwise a negative error value @@ -129,20 +128,19 @@ int image_util_transform_set_colorspace(transformation_h handle, image_util_colo * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @pre image_util_transform_create(). +* @pre image_util_transform_create() +* +* @see image_util_transform_get_resolution() * -* @see image_util_transform_create() -* @see image_util_transform_run() -* @see image_util_transform_destroy() */ int image_util_transform_set_resolution(transformation_h handle, unsigned int width, unsigned int height); /** -* @brief Sets the information of the rotating. +* @brief Sets the information of the rotation to transform. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in] rotation The rotation value of image buffer +* @param[in] handle The handle of image util tranform +* @param[in] rotation The rotation to transform * * @return @c 0 on success, * otherwise a negative error value @@ -151,25 +149,24 @@ int image_util_transform_set_resolution(transformation_h handle, unsigned int wi * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @pre image_util_transform_create(). +* @pre image_util_transform_create() +* +* @see image_util_transform_get_rotation() * -* @see image_util_transform_create() -* @see image_util_transform_run() -* @see image_util_transform_destroy() */ int image_util_transform_set_rotation(transformation_h handle, image_util_rotation_e rotation); /** -* @brief Sets the information of the cropping. +* @brief Sets the information of the crop area to transform. * @since_tizen 2.3 * * @remarks image_util_transform_set_resolution() and image_util_transform_set_crop_area() can't do that at the same time. * -* @param[in] handle The handle for transforming an image -* @param[in] start_x The start x position of cropped image buffer -* @param[in] start_y The start y position of cropped image buffer -* @param[in] end_x The end x position of cropped image buffer -* @param[in] end_y The end y position of cropped image buffer +* @param[in] handle The handle of image util tranform +* @param[in] start_x The start x position to transform +* @param[in] start_y The start y position to transform +* @param[in] end_x The end x position to transform +* @param[in] end_y The end y position to transform * * @return @c 0 on success, * otherwise a negative error value @@ -178,11 +175,10 @@ int image_util_transform_set_rotation(transformation_h handle, image_util_rotati * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @pre image_util_transform_create(). +* @pre image_util_transform_create() +* +* @see image_util_transform_get_crop_area() * -* @see image_util_transform_create() -* @see image_util_transform_run() -* @see image_util_transform_destroy() */ int image_util_transform_set_crop_area(transformation_h handle, unsigned int start_x, unsigned int start_y, unsigned int end_x, unsigned int end_y); @@ -190,8 +186,8 @@ int image_util_transform_set_crop_area(transformation_h handle, unsigned int sta * @brief Gets the colorspace of the image buffer. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in,out] colorspace The colorspace of the image buffer +* @param[in] handle The handle of image util tranform +* @param[in,out] colorspace The colorspace to transform * * @return @c 0 on success, * otherwise a negative error value @@ -201,11 +197,10 @@ int image_util_transform_set_crop_area(transformation_h handle, unsigned int sta * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_transform_create().\n -* image_util_transform_set_crop_area(). +* @pre image_util_transform_create() +* +* @see image_util_transform_set_colorspace() * -* @see image_util_transform_create() -* @see image_util_transform_destroy() */ int image_util_transform_get_colorspace(transformation_h handle, image_util_colorspace_e *colorspace); @@ -213,9 +208,9 @@ int image_util_transform_get_colorspace(transformation_h handle, image_util_colo * @brief Gets the resolution of the image buffer. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in,out] width The width of source image buffer -* @param[in,out] height The height of source image buffer +* @param[in] handle The handle of image util tranform +* @param[in,out] width The width to transform +* @param[in,out] height The height to transform * * @return @c 0 on success, * otherwise a negative error value @@ -224,11 +219,10 @@ int image_util_transform_get_colorspace(transformation_h handle, image_util_colo * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @pre image_util_transform_create().\n -* image_util_transform_set_resolution(). +* @pre image_util_transform_create() +* +* @see image_util_transform_set_resolution() * -* @see image_util_transform_create() -* @see image_util_transform_destroy() */ int image_util_transform_get_resolution(transformation_h handle, unsigned int *width, unsigned int *height); @@ -236,8 +230,8 @@ int image_util_transform_get_resolution(transformation_h handle, unsigned int *w * @brief Gets the information of the rotating. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in,out] rotation The rotation value of image buffer +* @param[in] handle The handle of image util tranform +* @param[in,out] rotation The rotation to transform * * @return @c 0 on success, * otherwise a negative error value @@ -249,8 +243,8 @@ int image_util_transform_get_resolution(transformation_h handle, unsigned int *w * @pre image_util_transform_create().\n * image_util_transform_set_rotation(). * -* @see image_util_transform_create() -* @see image_util_transform_destroy() +* @see image_util_transform_set_rotation() +* */ int image_util_transform_get_rotation(transformation_h handle, image_util_rotation_e *rotation); @@ -258,11 +252,11 @@ int image_util_transform_get_rotation(transformation_h handle, image_util_rotati * @brief Gets the information of the cropping. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image -* @param[in,out] start_x The start x position of cropped source image buffer -* @param[in,out] start_y The start y position of cropped source image buffer -* @param[in,out] end_x The end x position of cropped source image buffer -* @param[in,out] end_y The end y position of cropped source image buffer +* @param[in] handle The handle of image util tranform +* @param[in,out] start_x The start x position to transform +* @param[in,out] start_y The start y position to transform +* @param[in,out] end_x The end x position to transform +* @param[in,out] end_y The end y position to transform * * @return @c 0 on success, * otherwise a negative error value @@ -274,21 +268,19 @@ int image_util_transform_get_rotation(transformation_h handle, image_util_rotati * @pre image_util_transform_create().\n * image_util_transform_set_crop_area(). * -* @see image_util_transform_create() -* @see image_util_transform_destroy() +* @see image_util_transform_set_crop_area() +* */ int image_util_transform_get_crop_area(transformation_h handle, unsigned int *start_x, unsigned int *start_y, unsigned int *end_x, unsigned int *end_y); /** -* @brief Transforms the image for given image util handle. -* @details The function execute asynchronously, which contains complete callback \n -* If you set more than two transforming, the order of running is crop or resolution, colorspace converting, rotation. \n +* @brief Transforms an image using given @a handle. +* @details This function transforms @a src media packet synchronously using the @a handle. +* If you set more than two transforming, the order of running is crop or resolution, colorspace converting, and rotation. * @since_tizen 2.3 * -* @remarks If H/W acceleration is not set, transformation is done via S/W acceleration. -* -* @param[in] handle The handle for transforming an image -* @param[in] src The handle of source +* @param[in] handle The handle of image util tranform +* @param[in] src The handle of a source media packet * @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * @@ -299,22 +291,22 @@ int image_util_transform_get_crop_area(transformation_h handle, unsigned int *st * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @see image_util_transform_create() -* @see image_util_transform_destroy() +* @see image_util_transform_completed_cb() +* */ int image_util_transform_run(transformation_h handle, media_packet_h src, image_util_transform_completed_cb callback, void *user_data); /** -* @brief Synchronously transforms an image with the given transformation handle. -* @details This function transforms an image synchronously using the @a src image handle, which has image information such as size, resolution.\n +* @brief Synchronously transforms an image using given @a handle. +* @details This function transforms @a src image synchronously using the @a handle.\n * A transformed image is stored into the @a dst image handle.\n * @since_tizen 5.5 * * @remarks If transforming is failed, the @a dst will be null. * The @a dst should be released using image_util_destroy_image(). * -* @param[in] handle The handle for transforming an image -* @param[in] src The handle of the src image +* @param[in] handle The handle of image util tranform +* @param[in] src The handle of a source image * @param[out] dst The transformed image * * @return @c 0 on success, @@ -326,27 +318,22 @@ int image_util_transform_run(transformation_h handle, media_packet_h src, image_ * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * * @pre Create a transformation handle by calling image_util_transform_create(). -* @pre Set the transformation information by calling image_util_transform_set_colorspace(), image_util_transform_set_resolution(), \n +* @pre Set the information to transform by calling image_util_transform_set_colorspace(), image_util_transform_set_resolution(), \n * image_util_transform_set_rotation(), image_util_transform_set_crop_area(). -* @see image_util_transform_create() -* @see image_util_transform_destroy() -* @see image_util_transform_set_colorspace() -* @see image_util_transform_set_resolution() -* @see image_util_transform_set_rotation() -* @see image_util_transform_set_crop_area() +* */ int image_util_transform_run2(transformation_h handle, image_util_image_h src, image_util_image_h *dst); /** -* @brief Synchronously transforms an image with the given transformation handle. -* @details This function transforms an image asynchronously using the @a src image handle, which has image information such as size, resolution.\n -* @a callback will be called after completing transform. \n +* @brief Asynchronously transforms an image with the given transformation handle. +* @details This function transforms @a src image asynchronously using the @a handle. +* @a callback will be invoked after transforming is completed. * @since_tizen 5.5 * * @remarks If transforming is failed, the dst of callback parameter will be null. * -* @param[in] handle The handle for transforming an image -* @param[in] src The handle of the src image +* @param[in] handle The handle of image util tranform +* @param[in] src The handle of a source image * @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * @@ -361,24 +348,20 @@ int image_util_transform_run2(transformation_h handle, image_util_image_h src, i * @pre Create a transformation handle by calling image_util_transform_create(). * @pre Set the transformation information by calling image_util_transform_set_colorspace(), image_util_transform_set_resolution(), \n * image_util_transform_set_rotation(), image_util_transform_set_crop_area(). -* @see image_util_transform_create() -* @see image_util_transform_destroy() -* @see image_util_transform_set_colorspace() -* @see image_util_transform_set_resolution() -* @see image_util_transform_set_rotation() -* @see image_util_transform_set_crop_area() +* * @see image_util_transform_completed2_cb() +* */ int image_util_transform_run2_async(transformation_h handle, image_util_image_h src, image_util_transform_completed2_cb callback, void *user_data); /** * @brief Destroys a handle to image util. -* @details The function frees all resources related to the image util handle. The image util -* handle no longer can be used to perform any operations. A new image util handle -* has to be created before the next usage. +* @details The function frees all resources related to the image util handle. +* The image util handle no longer can be used to perform any operations. +* A new image util handle has to be created before the next usage. * @since_tizen 2.3 * -* @param[in] handle The handle for transforming an image +* @param[in] handle The handle of image util tranform * * @return @c 0 on success, * otherwise a negative error value @@ -402,7 +385,7 @@ int image_util_transform_destroy(transformation_h handle); * @param[in] colorspace The colorspace of image * @param[in] data The data of image * @param[in] data_size The size of data -* @param[out] image A handle of image +* @param[out] image The handle of image * * @return @c 0 on success, * otherwise a negative error value @@ -412,8 +395,7 @@ int image_util_transform_destroy(transformation_h handle); * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * * @see image_util_destroy_image() -* @see image_util_get_image() -* @see image_util_clone_image() +* */ int image_util_create_image(unsigned int width, unsigned int height, image_util_colorspace_e colorspace, const unsigned char *data, size_t data_size, image_util_image_h *image); @@ -434,8 +416,7 @@ int image_util_create_image(unsigned int width, unsigned int height, image_util_ * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * * @see image_util_destroy_image() -* @see image_util_get_image() -* @see image_util_clone_image() +* */ int image_util_create_image_from_media_packet(media_packet_h media_packet, image_util_image_h *image); @@ -445,8 +426,8 @@ int image_util_create_image_from_media_packet(media_packet_h media_packet, image * * @remarks The @a dst should be released using image_util_destroy_image(). * -* @param[in] src The handle of the image -* @param[out] dst A handle of the cloned image +* @param[in] src The handle of the image to clone +* @param[out] dst The handle of new image * * @return @c 0 on success, * otherwise a negative error value @@ -456,20 +437,22 @@ int image_util_create_image_from_media_packet(media_packet_h media_packet, image * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * * @see image_util_destroy_image() -* @see image_util_get_image() +* */ int image_util_clone_image(image_util_image_h src, image_util_image_h *dst); /** * @brief Gets the information from the image. +* @details The function get the information from the image. +* If you don't want to get specific information, you can pass unwanted parameters to NULL. * @since_tizen 5.5 * -* @remarks The @a data should be released using free() if that's not NULL. And if you don't want to get specific information, you can set parameters to NULL. +* @remarks The @a data should be released using free() if that's not NULL. * -* @param[in] image The handle of the image -* @param[out] width The width of image -* @param[out] height The height of image -* @param[out] colorspace The colorspace of image +* @param[in] image The handle of the image to get the information +* @param[out] width The width of the image +* @param[out] height The height of the image +* @param[out] colorspace The colorspace of the image * @param[out] data The data of image * @param[out] data_size The size of data * @@ -480,7 +463,6 @@ int image_util_clone_image(image_util_image_h src, image_util_image_h *dst); * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @see image_util_create_image() */ int image_util_get_image(image_util_image_h image, unsigned int *width, unsigned int *height, image_util_colorspace_e *colorspace, unsigned char **data, size_t *data_size); @@ -490,7 +472,7 @@ int image_util_get_image(image_util_image_h image, unsigned int *width, unsigned * A new image handle has to be created before the next usage. * @since_tizen 5.5 * -* @param[in] image The handle of the image +* @param[in] image The handle of the image to destroy * * @return @c 0 on success, * otherwise a negative error value @@ -499,6 +481,7 @@ int image_util_get_image(image_util_image_h image, unsigned int *width, unsigned * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * * @see image_util_create_image() +* */ int image_util_destroy_image(image_util_image_h image); @@ -521,20 +504,18 @@ int image_util_destroy_image(image_util_image_h image); * @return @c true to continue with the next iteration of the loop, \n * otherwise @c false to break out of the loop * -* @pre image_util_foreach_supported_colorspace() invokes this callback. -* * @see image_util_foreach_supported_colorspace() -* @see image_util_encode_create() -* @see image_util_decode_create() +* */ typedef bool(*image_util_supported_colorspace_cb)(image_util_colorspace_e colorspace, void *user_data); /** -* @brief Retrieves all supported image encoding/decoding colorspace by invoking a callback function once for each one. +* @brief Retrieves all supported colorspace for image encoding/decoding. +* @details Retrieves all supported colorspace by invoking a callback function for each colorspace * @since_tizen 3.0 * -* @param[in] image_type The type of supported image for which to create encode/decode handle -* @param[in] callback The callback function to invoke +* @param[in] image_type The supported colorspace of @a image_type for which to create encode/decode handle +* @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * @return 0 on success, * otherwise a negative error value @@ -542,11 +523,8 @@ typedef bool(*image_util_supported_colorspace_cb)(image_util_colorspace_e colors * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * -* @post This function invokes image_util_supported_colorspace_cb() repeatedly to retrieve each supported image encoding/decoding colorspace. -* * @see image_util_supported_colorspace_cb() -* @see image_util_encode_create() -* @see image_util_decode_create() +* */ int image_util_foreach_supported_colorspace(image_util_type_e image_type, image_util_supported_colorspace_cb callback, void *user_data); diff --git a/include/image_util_decode.h b/include/image_util_decode.h index d07b02e..19d70a7 100644 --- a/include/image_util_decode.h +++ b/include/image_util_decode.h @@ -36,7 +36,7 @@ extern "C" * * @remarks The @a handle should be released using image_util_decode_destroy(). * -* @param[out] handle The handle of image util decoding +* @param[out] handle The handle of image util decode * * @return @c 0 on success, * otherwise a negative error value @@ -63,7 +63,7 @@ int image_util_decode_create(image_util_decode_h *handle); * Since 6.5, this module supports HEIF image format.\n * Since 7.0, this module supports JPEG-XL image format. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[in] path The path to input image * * @return @c 0 on success, @@ -77,15 +77,6 @@ int image_util_decode_create(image_util_decode_h *handle); * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file * -* @pre image_util_decode_create() -* -* @post image_util_decode_run2() / image_util_decode_run_async2() -* @post image_util_decode_destroy() -* -* @see image_util_decode_create() -* @see image_util_decode_run2() -* @see image_util_decode_run_async2() -* @see image_util_decode_destroy() */ int image_util_decode_set_input_path(image_util_decode_h handle, const char *path); @@ -100,7 +91,7 @@ int image_util_decode_set_input_path(image_util_decode_h handle, const char *pat * Since 6.5, this module supports HEIF image format.\n * Since 7.0, this module supports JPEG-XL image format. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[in] src_buffer The input image buffer * @param[in] src_size The input image buffer size * @@ -113,15 +104,6 @@ int image_util_decode_set_input_path(image_util_decode_h handle, const char *pat * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_decode_create() -* -* @post image_util_decode_run2() / image_util_decode_run_async2() -* @post image_util_decode_destroy() -* -* @see image_util_decode_create() -* @see image_util_decode_run2() -* @see image_util_decode_run_async2() -* @see image_util_decode_destroy() */ int image_util_decode_set_input_buffer(image_util_decode_h handle, const unsigned char *src_buffer, unsigned long long src_size); @@ -133,7 +115,7 @@ int image_util_decode_set_input_buffer(image_util_decode_h handle, const unsigne * Use image_util_foreach_supported_colorspace to get supported colorspaces for each image format.\n * Errors would be returned if not supported. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[in] colorspace The decoded image colorspace * * @return @c 0 on success, @@ -143,20 +125,6 @@ int image_util_decode_set_input_buffer(image_util_decode_h handle, const unsigne * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_decode_create() -* @pre image_util_decode_set_input_path() / image_util_decode_set_input_buffer() -* -* @post image_util_decode_run2() / image_util_decode_run_async2() -* @post image_util_decode_destroy() -* -* @see image_util_supported_colorspace_cb() -* @see image_util_foreach_supported_colorspace() -* @see image_util_decode_create() -* @see image_util_decode_set_input_path() -* @see image_util_decode_set_input_buffer() -* @see image_util_decode_run2() -* @see image_util_decode_run_async2() -* @see image_util_decode_destroy() */ int image_util_decode_set_colorspace(image_util_decode_h handle, image_util_colorspace_e colorspace); @@ -166,7 +134,7 @@ int image_util_decode_set_colorspace(image_util_decode_h handle, image_util_colo * * @remarks This is API is supported only for JPEG decoding. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[in] down_scale The downscale at which image is to be decoded * * @return @c 0 on success, @@ -176,18 +144,6 @@ int image_util_decode_set_colorspace(image_util_decode_h handle, image_util_colo * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_decode_create() -* @pre image_util_decode_set_input_path() / image_util_decode_set_input_buffer() -* -* @post image_util_decode_run2() / image_util_decode_run_async2() -* @post image_util_decode_destroy() -* -* @see image_util_decode_create() -* @see image_util_decode_set_input_path() -* @see image_util_decode_set_input_buffer() -* @see image_util_decode_run2() -* @see image_util_decode_run_async2() -* @see image_util_decode_destroy() */ int image_util_decode_set_jpeg_downscale(image_util_decode_h handle, image_util_scale_e down_scale); @@ -200,7 +156,7 @@ int image_util_decode_set_jpeg_downscale(image_util_decode_h handle, image_util_ * The @a image should be released using image_util_destroy_image().\n * If any of the required functions listed in the preconditions section has not been called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[out] image The decoded image * * @return @c 0 on success, @@ -212,16 +168,6 @@ int image_util_decode_set_jpeg_downscale(image_util_decode_h handle, image_util_ * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_decode_create() -* @pre image_util_decode_set_input_buffer() / image_util_decode_set_input_path(). -* -* @post image_util_decode_destroy() -* -* @see image_util_decode_create() -* @see image_util_decode_set_input_path() -* @see image_util_decode_set_input_buffer() -* @see image_util_decode_destroy() -* @see image_util_destroy_image() */ int image_util_decode_run2(image_util_decode_h handle, image_util_image_h *image); @@ -233,7 +179,7 @@ int image_util_decode_run2(image_util_decode_h handle, image_util_image_h *image * @remarks If the decoding fails, the image_util_decode_completed2_cb() will be called with @c NULL image and a non-zero error_code.\n * If any of the required functions listed in the preconditions section has not been called, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * @@ -246,16 +192,6 @@ int image_util_decode_run2(image_util_decode_h handle, image_util_image_h *image * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_decode_create() -* @pre image_util_decode_set_input_buffer() / image_util_decode_set_input_path(). -* -* @post image_util_decode_destroy() -* -* @see image_util_decode_create() -* @see image_util_decode_set_input_path() -* @see image_util_decode_set_input_buffer() -* @see image_util_decode_destroy() -* @see image_util_destroy_image() * @see image_util_decode_completed2_cb() */ int image_util_decode_run_async2(image_util_decode_h handle, image_util_decode_completed2_cb callback, void *user_data); @@ -266,7 +202,7 @@ int image_util_decode_run_async2(image_util_decode_h handle, image_util_decode_c * * @remarks Any image handle created should be destroyed. * -* @param[in] handle The handle of image util decoding +* @param[in] handle The handle of image util decode * * @return @c 0 on success, * otherwise a negative error value @@ -278,6 +214,7 @@ int image_util_decode_run_async2(image_util_decode_h handle, image_util_decode_c * @pre image_util_decode_create() * * @see image_util_decode_create() +* */ int image_util_decode_destroy(image_util_decode_h handle); diff --git a/include/image_util_encode.h b/include/image_util_encode.h index aeb8fe3..fbe7134 100644 --- a/include/image_util_encode.h +++ b/include/image_util_encode.h @@ -30,14 +30,14 @@ extern "C" */ /** -* @brief Creates a handle of image util encoding. -* @details This function creates a handle of image util encoding. +* @brief Creates a handle of image util encode. +* @details This function creates a handle of image util encode. * @since_tizen 3.0 * * @remarks The @a handle should be released using image_util_encode_destroy(). * * @param[in] image_type The type of output image for which to create encode handle. -* @param[out] handle The handle of image util encoding +* @param[out] handle The handle of image util encode * * @return @c 0 on success, * otherwise a negative error value @@ -46,29 +46,19 @@ extern "C" * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @post image_util_encode_run_to_file() -* @post image_util_encode_run_to_buffer() -* @post image_util_encode_run_async_to_file() -* @post image_util_encode_run_async_to_buffer() -* @post image_util_encode_destroy() -* -* @see image_util_encode_run_to_file() -* @see image_util_encode_run_to_buffer() -* @see image_util_encode_run_async_to_file() -* @see image_util_encode_run_async_to_buffer() * @see image_util_encode_destroy() * */ int image_util_encode_create(image_util_type_e image_type, image_util_encode_h *handle); /** -* @brief Sets the quality for image encoding. +* @brief Sets the quality for encoding image. * @since_tizen 3.0 * * @remarks If application does not set this, then by default quality of 75 is set.\n * Quality is supported for JPEG format. #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT will be returned for other formats. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] quality Encoding quality from 1~100 * * @return @c 0 on success, @@ -78,17 +68,6 @@ int image_util_encode_create(image_util_type_e image_type, image_util_encode_h * * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_encode_create() -* -* @post image_util_encode_run_to_file() / image_util_encode_run_to_buffer() -* @post image_util_encode_destroy() -* -* @see image_util_encode_create() -* @see image_util_encode_run_to_file() -* @see image_util_encode_run_to_buffer() -* @see image_util_encode_run_async_to_file() -* @see image_util_encode_run_async_to_buffer() -* @see image_util_encode_destroy() */ int image_util_encode_set_quality(image_util_encode_h handle, int quality); @@ -98,7 +77,7 @@ int image_util_encode_set_quality(image_util_encode_h handle, int quality); * * @remarks If application does not set this, then the default value is #IMAGE_UTIL_PNG_COMPRESSION_6. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] compression The compression value valid from 0~9 * * @return @c 0 on success, @@ -109,27 +88,17 @@ int image_util_encode_set_quality(image_util_encode_h handle, int quality); * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_encode_create() -* -* @post image_util_encode_run_to_file() / image_util_encode_run_to_buffer() -* @post image_util_encode_destroy() -* -* @see image_util_encode_create() -* @see image_util_encode_run_to_file() -* @see image_util_encode_run_to_buffer() -* @see image_util_encode_run_async_to_file() -* @see image_util_encode_run_async_to_buffer() -* @see image_util_encode_destroy() */ int image_util_encode_set_png_compression(image_util_encode_h handle, image_util_png_compression_e compression); /** -* @brief Sets lossless compression of WEBP and JPEG-XL images. +* @brief Sets lossless for #IMAGE_UTIL_WEBP and #IMAGE_UTIL_JPEG_XL. +* @details This function sets lossless compression of WEBP and JPEG-XL image format. * @since_tizen 7.0 * * @remarks If application does not set this, then the default value is @c false. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] lossless The flag determining whether the compression is lossless or lossy: @c true for lossless, @c false for lossy * * @return @c 0 on success, @@ -140,23 +109,12 @@ int image_util_encode_set_png_compression(image_util_encode_h handle, image_util * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_encode_create() -* -* @post image_util_encode_run_to_file() / image_util_encode_run_to_buffer() -* @post image_util_encode_destroy() -* -* @see image_util_encode_create() -* @see image_util_encode_run_to_file() -* @see image_util_encode_run_to_buffer() -* @see image_util_encode_run_async_to_file() -* @see image_util_encode_run_async_to_buffer() -* @see image_util_encode_destroy() */ int image_util_encode_set_lossless(image_util_encode_h handle, bool lossless); /** -* @brief Encodes the image and save it to a file in the given encoding handle. -* @details The function executes synchronously. +* @brief Encodes an @a image using given @a handle synchronously. +* @details This function encodes an @ image and stores it in @a file_path. * @since_tizen 5.5 * * @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n @@ -169,7 +127,7 @@ int image_util_encode_set_lossless(image_util_encode_h handle, bool lossless); * Since 6.0, this module supports WEBP, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for WEBP.\n * Since 7.0, this module supports JPEG-XL, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG-XL. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] image The image handle for encoding * @param[in] file_path The file path for encoding image * @@ -183,18 +141,12 @@ int image_util_encode_set_lossless(image_util_encode_h handle, bool lossless); * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_encode_create() -* -* @post image_util_encode_destroy() -* -* @see image_util_encode_create() -* @see image_util_encode_destroy() */ int image_util_encode_run_to_file(image_util_encode_h handle, image_util_image_h image, const char *file_path); /** -* @brief Encodes the image to save it to a buffer in the given encoding handle. -* @details The function executes synchronously. +* @brief Encodes an @a image using given @a handle synchronously. +* @details This function encodes an @ image and stores it in @a buffer. * @since_tizen 5.5 * * @remarks If any functions at the pre-condition are not called first, #IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n @@ -206,7 +158,7 @@ int image_util_encode_run_to_file(image_util_encode_h handle, image_util_image_h * Since 6.0, this module supports WEBP, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for WEBP.\n * Since 7.0, this module supports JPEG-XL, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG-XL. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] image The image handle for encoding * @param[out] buffer The buffer that encoded image is stored * @param[out] buffer_size The size of the buffer @@ -220,17 +172,11 @@ int image_util_encode_run_to_file(image_util_encode_h handle, image_util_image_h * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_encode_create() -* -* @post image_util_encode_destroy() -* -* @see image_util_encode_create() -* @see image_util_encode_destroy() */ int image_util_encode_run_to_buffer(image_util_encode_h handle, image_util_image_h image, unsigned char **buffer, size_t *buffer_size); /** -* @brief Encodes the image and save it to a file in the given encoding handle asynchronously. +* @brief Encodes an @a image using given @a handle asynchronously. * @details The output will be stored in @a file_path. And the function executes asynchronously. * @since_tizen 5.5 * @@ -244,7 +190,7 @@ int image_util_encode_run_to_buffer(image_util_encode_h handle, image_util_image * Since 6.0, this module supports WEBP, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for WEBP.\n * Since 7.0, this module supports JPEG-XL, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG-XL. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] image The image handle for encoding * @param[in] file_path The file path for encoding image * @param[in] completed_cb The callback function to be invoked @@ -259,17 +205,13 @@ int image_util_encode_run_to_buffer(image_util_encode_h handle, image_util_image * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @pre image_util_encode_create() -* -* @post image_util_encode_destroy() +* @see image_util_encode_to_file_completed_cb() * -* @see image_util_encode_create() -* @see image_util_encode_destroy() */ int image_util_encode_run_async_to_file(image_util_encode_h handle, image_util_image_h image, const char *file_path, image_util_encode_to_file_completed_cb completed_cb, void *user_data); /** -* @brief Encodes the image and save it to a buffer in the given encoding handle asynchronously. +* @brief Encodes an @a image using given @a handle asynchronously. * @details The output will be stored in a buffer provided by the @a completed_cb callback. * @since_tizen 5.5 * @@ -281,7 +223,7 @@ int image_util_encode_run_async_to_file(image_util_encode_h handle, image_util_i * Since 6.0, this module supports WEBP, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for WEBP.\n * Since 7.0, this module supports JPEG-XL, you can use image_util_foreach_supported_colorspace() to get supported colorspaces for JPEG-XL. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * @param[in] image The image handle for encoding * @param[in] completed_cb The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function @@ -294,12 +236,8 @@ int image_util_encode_run_async_to_file(image_util_encode_h handle, image_util_i * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @pre image_util_encode_create() -* -* @post image_util_encode_destroy() +* @see image_util_encode_to_buffer_completed_cb() * -* @see image_util_encode_create() -* @see image_util_encode_destroy() */ int image_util_encode_run_async_to_buffer(image_util_encode_h handle, image_util_image_h image, image_util_encode_to_buffer_completed_cb completed_cb, void *user_data); @@ -309,7 +247,7 @@ int image_util_encode_run_async_to_buffer(image_util_encode_h handle, image_util * * @remarks Any image handle created should be destroyed. * -* @param[in] handle The handle of image util encoding +* @param[in] handle The handle of image util encode * * @return @c 0 on success, * otherwise a negative error value @@ -321,6 +259,7 @@ int image_util_encode_run_async_to_buffer(image_util_encode_h handle, image_util * @pre image_util_encode_create() * * @see image_util_encode_create() +* */ int image_util_encode_destroy(image_util_encode_h handle); @@ -339,11 +278,6 @@ int image_util_encode_destroy(image_util_encode_h handle); * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @post image_util_agif_encode_destroy() -* -* @see image_util_agif_encode_add_frame() -* @see image_util_agif_encode_save_to_file() -* @see image_util_agif_encode_save_to_buffer() * @see image_util_agif_encode_destroy() * */ @@ -372,16 +306,8 @@ int image_util_agif_encode_create(image_util_agif_encode_h *handle); * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_agif_encode_create() -* -* @post image_util_agif_encode_save_to_file() -* @post image_util_agif_encode_save_to_buffer() -* @post image_util_agif_encode_destroy() -* -* @see image_util_agif_encode_create() * @see image_util_agif_encode_save_to_file() * @see image_util_agif_encode_save_to_buffer() -* @see image_util_agif_encode_destroy() * */ int image_util_agif_encode_add_frame(image_util_agif_encode_h handle, image_util_image_h image, unsigned int time_delay); @@ -418,13 +344,7 @@ int image_util_agif_encode_add_frame(image_util_agif_encode_h handle, image_util * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file * -* @pre image_util_agif_encode_create() -* -* @post image_util_agif_encode_destroy() -* -* @see image_util_agif_encode_create() * @see image_util_agif_encode_add_frame() -* @see image_util_agif_encode_destroy() * */ int image_util_agif_encode_save_to_file(image_util_agif_encode_h handle, const char *file_path); @@ -459,13 +379,7 @@ int image_util_agif_encode_save_to_file(image_util_agif_encode_h handle, const c * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @pre image_util_agif_encode_create() -* -* @post image_util_agif_encode_destroy() -* -* @see image_util_agif_encode_create() * @see image_util_agif_encode_add_frame() -* @see image_util_agif_encode_destroy() * */ int image_util_agif_encode_save_to_buffer(image_util_agif_encode_h handle, unsigned char **buffer, size_t *buffer_size); @@ -507,9 +421,6 @@ int image_util_agif_encode_destroy(image_util_agif_encode_h handle); * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @see image_util_anim_encode_add_frame() -* @see image_util_anim_encode_save_to_file() -* @see image_util_anim_encode_save_to_buffer() * @see image_util_anim_encode_destroy() * */ @@ -520,6 +431,7 @@ int image_util_anim_encode_create(image_util_anim_type_e image_type, image_util_ * @since_tizen 6.0 * * @remarks This function should be called before image_util_anim_encode_add_frame() is called. +* If not set, the default value is infinite repetition. * * @param[in] handle The handle of animation encoder * @param[in] loop_count The number of times to repeat the animation @@ -531,8 +443,6 @@ int image_util_anim_encode_create(image_util_anim_type_e image_type, image_util_ * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_anim_encode_create() -* */ int image_util_anim_encode_set_loop_count(image_util_anim_encode_h handle, unsigned int loop_count); @@ -555,8 +465,6 @@ int image_util_anim_encode_set_loop_count(image_util_anim_encode_h handle, unsig * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_anim_encode_create() -* */ int image_util_anim_encode_set_background_color(image_util_anim_encode_h handle, unsigned char r, unsigned char g, unsigned char b, unsigned char a); @@ -576,8 +484,6 @@ int image_util_anim_encode_set_background_color(image_util_anim_encode_h handle, * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Not supported format * -* @pre image_util_anim_encode_create() -* */ int image_util_anim_encode_set_lossless(image_util_anim_encode_h handle, bool lossless); @@ -604,11 +510,6 @@ int image_util_anim_encode_set_lossless(image_util_anim_encode_h handle, bool lo * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_OUT_OF_MEMORY Out of memory * -* @pre image_util_anim_encode_create() -* -* @post image_util_anim_encode_save_to_file() -* @post image_util_anim_encode_save_to_buffer() -* * @see image_util_anim_encode_save_to_file() * @see image_util_anim_encode_save_to_buffer() * @@ -647,7 +548,7 @@ int image_util_anim_encode_add_frame(image_util_anim_encode_h handle, image_util * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file * -* @pre image_util_anim_encode_create() +* @pre image_util_anim_encode_add_frame() * * @see image_util_anim_encode_add_frame() * @@ -684,7 +585,7 @@ int image_util_anim_encode_save_to_file(image_util_anim_encode_h handle, const c * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation * -* @pre image_util_anim_encode_create() +* @pre image_util_anim_encode_add_frame() * * @see image_util_anim_encode_add_frame() * @@ -695,7 +596,7 @@ int image_util_anim_encode_save_to_buffer(image_util_anim_encode_h handle, unsig * @brief Destroys the handle for encoding animation. * @since_tizen 6.0 * -* @remarks Any created animated encoder handle created should be destroyed. +* @remarks Any created animated encode handle should be destroyed. * * @param[in] handle The handle of animation encoder * diff --git a/include/image_util_type.h b/include/image_util_type.h index a271304..0a18313 100644 --- a/include/image_util_type.h +++ b/include/image_util_type.h @@ -27,7 +27,7 @@ extern "C" #endif /** -* @brief Definition for Metadata extractor Error Class. +* @brief Definition for image util Error Class. * @since_tizen 2.3 * */ @@ -53,7 +53,7 @@ typedef enum { IMAGE_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ IMAGE_UTIL_ERROR_NO_SUCH_FILE = TIZEN_ERROR_NO_SUCH_FILE, /**< No such file */ IMAGE_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Internal error */ - IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT = TIZEN_ERROR_IMAGE_UTIL | 0x01, /**< Not supported format */ + IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT = IMAGE_UTIL_ERROR_CLASS | 0x01, /**< Not supported format */ IMAGE_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ IMAGE_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED /**< Not supported */ } image_util_error_e; @@ -84,7 +84,7 @@ typedef enum { } image_util_colorspace_e; /** -* @brief Image handle. +* @brief The handle of an image. * @since_tizen 5.5 */ typedef void *image_util_image_h; @@ -113,23 +113,25 @@ typedef enum { /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE -* @brief Image util handle. +* @brief The handle of image util transform. * @since_tizen 2.3 */ typedef struct transformation_s *transformation_h; /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE -* @brief Called when transform is finished just before returning the output. +* @brief Called when transforming an media packet is completed. * @since_tizen 2.3 * * @remarks The @a dst should be released using media_packet_destroy(). \n * The callback is called in a separate thread(not in the main loop). * -* @param[in,out] dst The result buffer of image util transform +* @param[in] dst The transformed media packet handle * @param[in] error_code The error code of image util transform * @param[in] user_data The user data passed from the callback registration function -* @pre image_util_transform_run() will invoke this function. +* +* @pre image_util_transform_run() +* */ typedef void(*image_util_transform_completed_cb)(media_packet_h *dst, int error_code, void *user_data); @@ -148,7 +150,6 @@ typedef void(*image_util_transform_completed_cb)(media_packet_h *dst, int error_ * * @pre image_util_transform_run2_async() * -* @see image_util_transform_run2_async() * @see image_util_clone_image() */ typedef void(*image_util_transform_completed2_cb)(image_util_image_h dst, int error_code, void *user_data); @@ -186,7 +187,7 @@ typedef enum { } image_util_anim_type_e; /** - * @brief Enumeration for scale decoding. + * @brief Enumeration for JPEG downscale decoding. * @since_tizen 2.4 */ typedef enum { @@ -215,14 +216,14 @@ typedef enum { /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Called when image_util_decode_run_async2() finishes decoding an image. +* @brief Called when decoding an image is completed. * @since_tizen 5.5 * -* @remarks The callback is called in a separate thread(not in the main loop). \n -* The @a image should not be released by the application. \n -* The @a image can be used only in the callback. To use outside, make a copy using image_util_clone_image(). +* @remarks The @a image should not be released by the application. \n +* The @a image can be used only in the callback. To use outside, make a copy using image_util_clone_image(). \n +* The callback is called in a separate thread(not in the main loop). \n * -* @param[in] error_code The error code of image util decoding +* @param[in] error_code The error code of image util * #IMAGE_UTIL_ERROR_NONE Successful * #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation @@ -232,19 +233,19 @@ typedef enum { * @param[in] image The decoded image (or @c NULL if decoding failed) * @param[in] user_data The user data passed from the callback registration function * -* @pre image_util_decode_run_async2() will invoke this function. +* @pre image_util_decode_run_async2() */ typedef void (*image_util_decode_completed2_cb) (int error_code, image_util_image_h image, void *user_data); /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Called when image encoding is finished just after storing the output to the file. +* @brief Called when encoding an image is completed just after storing the output to the file. * @since_tizen 5.5 * * @remarks The output will be stored in the file set using image_util_encode_run_to_file(). \n * The callback is called in a separate thread (not in the main loop). * -* @param[in] error_code The error code of image util encoding \n +* @param[in] error_code The error code of image util \n * #IMAGE_UTIL_ERROR_NONE Successful \n * #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter \n * #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation \n @@ -258,7 +259,7 @@ typedef void (*image_util_encode_to_file_completed_cb) (image_util_error_e error /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Called when image encoding is finished just after storing the output to the buffer. +* @brief Called when encoding an image is completed just after storing the output to the buffer. * @since_tizen 5.5 * * @remarks The output will be stored in the @a buffer. \n @@ -266,7 +267,7 @@ typedef void (*image_util_encode_to_file_completed_cb) (image_util_error_e error * The @a buffer should not be released by the application.\n * The @a buffer can be used only in the callback. To use outside, make a copy. * -* @param[in] error_code The error code of image util encoding \n +* @param[in] error_code The error code of image util \n * #IMAGE_UTIL_ERROR_NONE Successful \n * #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter \n * #IMAGE_UTIL_ERROR_INVALID_OPERATION Invalid operation \n @@ -282,28 +283,28 @@ typedef void (*image_util_encode_to_buffer_completed_cb) (image_util_error_e err /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Image-util decoding handle. +* @brief The handle of image util decode. * @since_tizen 3.0 */ typedef void *image_util_decode_h; /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Image-util encoding handle. +* @brief The handle of image util encode. * @since_tizen 3.0 */ typedef void *image_util_encode_h; /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Image-util animation GIF encoding handle. +* @brief The handle of image util AGIF encode. * @since_tizen 5.5 */ typedef void *image_util_agif_encode_h; /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE -* @brief Image-util animation encoding handle. +* @brief The handle of image util animation encode. * @since_tizen 6.0 */ typedef void *image_util_anim_encode_h; -- 2.7.4