From f07c8d62c21bb663d668bcb2a5dbdf130876d2b2 Mon Sep 17 00:00:00 2001 From: hj kim Date: Thu, 25 Jan 2018 09:06:30 +0900 Subject: [PATCH] Fix doxgyen mistakes Change-Id: I418cb6ca08435acfbba14f88d477ec5760fc7b57 --- include/image_util.h | 65 ++++++++++++------------ include/image_util_decode.h | 71 +++++++++++++-------------- include/image_util_encode.h | 95 ++++++++++++++++++------------------ include/image_util_internal.h | 8 +-- include/image_util_private.h | 6 +-- include/image_util_type.h | 25 ++++++---- packaging/capi-media-image-util.spec | 2 +- 7 files changed, 136 insertions(+), 136 deletions(-) diff --git a/include/image_util.h b/include/image_util.h index 497f3cc..315a460 100755 --- a/include/image_util.h +++ b/include/image_util.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_H__ #include #include @@ -38,7 +38,7 @@ extern "C" /** * @brief Calculates the size of the image buffer for the specified resolution and colorspace. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] width The image width * @param[in] height The image height @@ -93,11 +93,10 @@ int image_util_extract_color_from_memory(const unsigned char *image_buffer, int /** * @brief Creates a handle to image util transform. -* @since_tizen 2.3 -* * @details This function creates a handle to image util transform. +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * -* @remarks You must release the @a image util handle using image_util_transform_destroy(). +* @remarks The @a handle should be released using image_util_transform_destroy(). * * @param[out] handle A handle to image util transform * @@ -116,14 +115,14 @@ int image_util_transform_create(transformation_h *handle); /** * @deprecated Deprecated since 5.0. * @brief Sets the image util's accurate mode. -* @since_tizen 2.3 -* * @details This function set if you use hardware accerlation or not. +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif +* * * @remarks The value returned will be IMAGE_UTIL_ERROR_NOT_SUPPORTED, if H/W acceleration doesn't support on the device. * * @param[in] handle The handle to image util -* @param [in] mode Set @c true, user can use the hardware acceleration\n +* @param[in] mode Set @c true, user can use the hardware acceleration\n * otherwise set @c false if user can only software image processing * * @return @c 0 on success, @@ -143,7 +142,7 @@ int image_util_transform_set_hardware_acceleration(transformation_h handle, bool /** * @brief Sets the information of the converting. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform * @param[in] colorspace The colorspace of the image buffer @@ -166,7 +165,7 @@ int image_util_transform_set_colorspace(transformation_h handle, image_util_colo /** * @brief Sets the information of the resizing. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @remarks image_util_transform_set_resolution and image_util_transform_set_crop_area can't do that at the same time. * @@ -191,7 +190,7 @@ int image_util_transform_set_resolution(transformation_h handle, unsigned int wi /** * @brief Sets the information of the rotating. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform * @param[in] rotation The rotation value of image buffer @@ -213,7 +212,7 @@ int image_util_transform_set_rotation(transformation_h handle, image_util_rotati /** * @brief Sets the information of the cropping. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @remarks image_util_transform_set_resolution and image_util_transform_set_crop_area can't do that at the same time. * @@ -240,10 +239,10 @@ 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 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform -* @param[in, out] colorspace The colorspace of the image buffer +* @param[in,out] colorspace The colorspace of the image buffer * * @return @c 0 on success, * otherwise a negative error value @@ -263,11 +262,11 @@ int image_util_transform_get_colorspace(transformation_h handle, image_util_colo /** * @brief Gets the resolution of the image buffer. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform -* @param[in, out] width The width of source image buffer -* @param[in, out] height The height of source image buffer +* @param[in,out] width The width of source image buffer +* @param[in,out] height The height of source image buffer * * @return @c 0 on success, * otherwise a negative error value @@ -286,10 +285,10 @@ int image_util_transform_get_resolution(transformation_h handle, unsigned int *w /** * @brief Gets the information of the rotating. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform -* @param[in, out] rotation The rotation value of image buffer +* @param[in,out] rotation The rotation value of image buffer * * @return @c 0 on success, * otherwise a negative error value @@ -308,13 +307,13 @@ int image_util_transform_get_rotation(transformation_h handle, image_util_rotati /** * @brief Gets the information of the cropping. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform -* @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,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 * * @return @c 0 on success, * otherwise a negative error value @@ -333,12 +332,11 @@ int image_util_transform_get_crop_area(transformation_h handle, unsigned int *st /** * @brief Transforms the image for given image util handle. -* @since_tizen 2.3 -* -* @remarks If H/W acceleration is not set, transformation is done via S/W acceleration. -* * @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, rotaion. \n +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif +* +* @remarks If H/W acceleration is not set, transformation is done via S/W acceleration. * * @param[in] handle The handle of transform * @param[in] src The handle to image util transform @@ -359,11 +357,10 @@ int image_util_transform_run(transformation_h handle, media_packet_h src, image_ /** * @brief Destroys a handle to image util. -* @since_tizen 2.3 -* * @details The function frees all resources related to the image util handle. The image util * handle no longer can be used to perform any operation. A new image util handle * has to be created before the next usage. +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] handle The handle to image util transform * @@ -390,7 +387,7 @@ int image_util_transform_destroy(transformation_h handle); /** * @deprecated Deprecated since 3.0. Use image_util_supported_colorspace_cb() instead. * @brief Called once for each supported JPEG encode/decode colorspace. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] colorspace The colorspace * @param[in] user_data The user data passed from the foreach function @@ -411,7 +408,7 @@ typedef bool(*image_util_supported_jpeg_colorspace_cb)(image_util_colorspace_e c /** * @deprecated Deprecated since 3.0. Use image_util_foreach_supported_colorspace() instead. * @brief Retrieves all supported JPEG encoding/decoding colorspace by invoking a callback function once for each one. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function @@ -477,4 +474,4 @@ int image_util_foreach_supported_colorspace(image_util_type_e image_type, image_ } #endif -#endif /* __TIZEN_MEDIA_IMAGE_UTIL_H__ */ +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_H__ */ diff --git a/include/image_util_decode.h b/include/image_util_decode.h index 9294a79..b969064 100755 --- a/include/image_util_decode.h +++ b/include/image_util_decode.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_DECODE_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_DECODE_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_DECODE_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_DECODE_H__ #include @@ -31,16 +31,15 @@ extern "C" /** * @brief Creates a handle to image util decoding. -* @since_tizen 3.0 -* * @details This function creates a handle to image util decoding. +* @since_tizen 3.0 * -* @remarks You must release the @a image util handle using image_util_decode_destroy(). +* @remarks The @a handle should be released using image_util_decode_destroy(). * * @param[out] handle A handle to image util decoding * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -56,16 +55,16 @@ int image_util_decode_create(image_util_decode_h *handle); * @since_tizen 3.0 * * @remarks One of image_util_decode_set_input_path() or image_util_decode_set_input_buffer() should be set.\n -* If both are set then the latest input set, is considered.\n -* http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n -* http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\n -* Finds out image type by reading the header of the image provided in input path. +* If both are set then the latest input set, is considered.\n +* http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n +* http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\n +* Finds out image type by reading the header of the image provided in input path. * * @param[in] handle The handle to image util decoding * @param[in] path The path to input image * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file @@ -93,15 +92,15 @@ int image_util_decode_set_input_path(image_util_decode_h handle, const char *pat * @since_tizen 3.0 * * @remarks One of image_util_decode_set_input_path() or image_util_decode_set_input_buffer() should be set.\n -* If both are set then the latest input set, is considered.\n -* Finds out image type by reading the header of the image provided in input buffer. +* If both are set then the latest input set, is considered.\n +* Finds out image type by reading the header of the image provided in input buffer. * * @param[in] handle The handle to image util decoding * @param[in] src_buffer The input image buffer * @param[in] src_size The input image buffer size * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -127,15 +126,15 @@ int image_util_decode_set_input_buffer(image_util_decode_h handle, const unsigne * @since_tizen 3.0 * * @remarks Either image_util_decode_set_input_path() or image_util_decode_set_input_buffer() should be set.\n -* By default the decoded output buffer colorspace will be IMAGE_UTIL_COLORSPACE_RGBA8888. -* Use image_util_decode_set_colorspace to change the colorspace. -* @a dst_buffer should be released after @a image_util_decode_run() or @a image_util_decode_run_async(). +* By default the decoded output buffer colorspace will be IMAGE_UTIL_COLORSPACE_RGBA8888. +* Use image_util_decode_set_colorspace to change the colorspace. +* @a dst_buffer should be released after @c image_util_decode_run() or @c image_util_decode_run_async(). * * @param[in] handle The handle to image util decoding * @param[in] dst_buffer The decoded output buffer * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -160,14 +159,14 @@ int image_util_decode_set_output_buffer(image_util_decode_h handle, unsigned cha * @since_tizen 3.0 * * @remarks The default colorspace is IMAGE_UTIL_COLORSPACE_RGBA8888.\n -* Use image_util_foreach_supported_colorspace to get supported colorspaces for each image format.\n -* Errors would be returned if not supported. +* 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 to image util decoding * @param[in] colorspace The decoded image colorspace * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -201,7 +200,7 @@ int image_util_decode_set_colorspace(image_util_encode_h handle, image_util_colo * @param[in] down_scale The downscale at which image is to be decoded * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -228,8 +227,8 @@ int image_util_decode_set_jpeg_downscale(image_util_encode_h handle, image_util_ * @since_tizen 3.0 * * @remarks The output will be stored in the pointer set using image_util_decode_set_output_buffer().\n -* The function executes synchronously.\n -* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. +* The function executes synchronously.\n +* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. * * @param[in] handle The handle to image util decoding * @param[out] width Width of the decoded image @@ -237,7 +236,7 @@ int image_util_decode_set_jpeg_downscale(image_util_encode_h handle, image_util_ * @param[out] size Size of the decoded image * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -262,15 +261,15 @@ int image_util_decode_run(image_util_decode_h handle, unsigned long *width, unsi * @since_tizen 3.0 * * @remarks The output will be stored in the pointer set using image_util_decode_set_output_buffer().\n -* The function executes asynchronously, which contains complete callback.\n -* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. +* The function executes asynchronously, which contains complete callback.\n +* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned. * * @param[in] handle The handle to image util decoding * @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -299,7 +298,7 @@ int image_util_decode_run_async(image_util_decode_h handle, image_util_decode_co * @param[in] handle The handle to image util decoding * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -314,9 +313,9 @@ int image_util_decode_destroy(image_util_decode_h handle); /** * @deprecated Deprecated since 3.0. Use image_util_decode_create() instead. * @brief Decodes the JPEG image to the buffer. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * -* @remarks You must release @a image_buffer using free().\n +* @remarks The @a image_buffer should be released using free().\n * http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n * http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\n * If you decode the JPEG image which has odd numbered width or height to YUV colorspace, \n @@ -348,9 +347,9 @@ int image_util_decode_jpeg(const char *path, image_util_colorspace_e colorspace, /** * @deprecated Deprecated since 3.0. Use image_util_decode_create() instead. * @brief Decodes the JPEG image(in memory) to the buffer. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * -* @remarks You must release @a image_buffer using free().\n +* @remarks The @a image_buffer should be released using free().\n * If you decode the JPEG image which has odd numbered width or height to YUV colorspace, \n * the width or height of decoded data will be rounded down to even numbered width or height. * @@ -383,7 +382,7 @@ int image_util_decode_jpeg_from_memory(const unsigned char *jpeg_buffer, int jpe * @brief Decodes the JPEG image to the buffer with downscale decoding option. * @since_tizen @if WEARABLE @else 2.4 @endif * -* @remarks You must release @a image_buffer using free().\n +* @remarks The @a image_buffer should be released using free().\n * http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n * http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.\n * If you decode the JPEG image which has odd numbered width or height to YUV colorspace, \n @@ -418,7 +417,7 @@ int image_util_decode_jpeg_with_downscale(const char *path, image_util_colorspac * @brief Decodes the JPEG image(in memory) to the buffer with downscale decoding option. * @since_tizen @if WEARABLE @else 2.4 @endif * -* @remarks You must release @a image_buffer using free().\n +* @remarks The @a image_buffer should be released using free().\n * If you decode the JPEG image which has odd numbered width or height to YUV colorspace, \n * the width or height of decoded data will be rounded down to even numbered width or height. * @@ -455,4 +454,4 @@ int image_util_decode_jpeg_from_memory_with_downscale(const unsigned char *jpeg_ } #endif -#endif +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_DECODE_H__ */ \ No newline at end of file diff --git a/include/image_util_encode.h b/include/image_util_encode.h index 76fd9c9..f931233 100755 --- a/include/image_util_encode.h +++ b/include/image_util_encode.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_ENCODE_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_ENCODE_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_ENCODE_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_ENCODE_H__ #include @@ -31,17 +31,16 @@ extern "C" /** * @brief Creates a handle to image util encoding. -* @since_tizen 3.0 -* * @details This function creates a handle to image util encoding. +* @since_tizen 3.0 * -* @remarks You must release the @a image util handle using image_util_encode_destroy(). +* @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 A handle to image util encoding * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -57,14 +56,14 @@ int image_util_encode_create(image_util_type_e image_type, image_util_encode_h * * @since_tizen 3.0 * * @remarks This should be called before calling image_util_encode_run().\n -* While encoding animated gif image, resolution should be set for each frame. +* While encoding animated gif image, resolution should be set for each frame. * * @param[in] handle The handle to image util encoding * @param[in] width Width of the original image * @param[in] height Height of the original image * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -90,14 +89,14 @@ int image_util_encode_set_resolution(image_util_encode_h handle, unsigned long w * @since_tizen 3.0 * * @remarks The default colorspace is IMAGE_UTIL_COLORSPACE_RGBA8888.\n -* Use image_util_foreach_supported_colorspace to get supported colorspaces for each image format.\n -* Errors would be returned if not supported. +* 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 to image util encoding * @param[in] colorspace The colorspace of the input image to encode * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported @@ -126,13 +125,13 @@ int image_util_encode_set_colorspace(image_util_encode_h handle, image_util_colo * @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. +* Quality is supported for JPEG format. IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT will be returned for other formats. * * @param[in] handle The handle to image util encoding * @param[in] quality Encoding quality from 1~100 * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported @@ -164,7 +163,7 @@ int image_util_encode_set_quality(image_util_encode_h handle, int quality); * @param[in] compression The compression value valid from 0~9 * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported @@ -192,14 +191,14 @@ int image_util_encode_set_png_compression(image_util_encode_h handle, image_util * @since_tizen 3.0 * * @remarks In case animated gif image if this is not set then there will be no delay between each frame.\n -* This should be set for each frame in the animated gif image.\n -* This can be set a different value for each frame, which results in different delay time between different frames. +* This should be set for each frame in the animated gif image.\n +* This can be set a different value for each frame, which results in different delay time between different frames. * * @param[in] handle The handle to image util encoding * @param[in] delay_time Time delay between each frame in the encoded image, in 0.01sec units. * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT Format not supported @@ -226,15 +225,15 @@ int image_util_encode_set_gif_frame_delay_time(image_util_encode_h handle, unsig * @since_tizen 3.0 * * @remarks Either image_util_encode_set_output_path() or image_util_encode_set_output_buffer() should be set.\n -* By default the input buffer colorspace will be considered as IMAGE_UTIL_COLORSPACE_RGBA8888.\n -* Use image_util_encode_set_colorspace to change the colorspace.\n -* While encoding animated gif image, input buffer should be set for each frame. +* By default the input buffer colorspace will be considered as IMAGE_UTIL_COLORSPACE_RGBA8888.\n +* Use image_util_encode_set_colorspace to change the colorspace.\n +* While encoding animated gif image, input buffer should be set for each frame. * * @param[in] handle The handle to image util decoding * @param[in] src_buffer The input image buffer * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -261,15 +260,15 @@ int image_util_encode_set_input_buffer(image_util_encode_h handle, const unsigne * @since_tizen 3.0 * * @remarks One of image_util_encode_set_output_path() or image_util_encode_set_output_buffer() should be set.\n -* If both are set then the latest output set is considered.\n -* http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n -* http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. +* If both are set then the latest output set is considered.\n +* http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n +* http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. * * @param[in] handle The handle to image util encoding * @param[in] path The output file path * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_NO_SUCH_FILE No such file @@ -296,17 +295,17 @@ int image_util_encode_set_output_path(image_util_encode_h handle, const char *pa * @since_tizen 3.0 * * @remarks One of image_util_encode_set_output_path() or image_util_encode_set_output_buffer() should be set.\n -* If both are set then the latest output set is considered.\n -* Before 4.0, output buffer setting is not supported for bmp. IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT will be returned for bmp.\n -* Since 4.0, output buffer setting has been supported for bmp. Applications can set the output buffer to write encoded bmp.\n -* In case of gif encoding, the output buffer will be completely available only after image_util_encode_destroy(). -* @a dst_buffer should be released after @a image_util_encode_run() or @a image_util_encode_run_async(). +* If both are set then the latest output set is considered.\n +* Before 4.0, output buffer setting is not supported for bmp. IMAGE_UTIL_ERROR_NOT_SUPPORTED_FORMAT will be returned for bmp.\n +* Since 4.0, output buffer setting has been supported for bmp. Applications can set the output buffer to write encoded bmp.\n +* In case of gif encoding, the output buffer will be completely available only after image_util_encode_destroy(). +* @a dst_buffer should be released after @c image_util_encode_run() or @c image_util_encode_run_async(). * * @param[in] handle The handle to image util encoding * @param[in] dst_buffer The output image buffer * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -332,17 +331,17 @@ int image_util_encode_set_output_buffer(image_util_encode_h handle, unsigned cha * @since_tizen 3.0 * * @remarks The output will be stored in the pointer set to image_util_encode_set_output_buffer() or image_util_encode_set_output_path().\n -* The function executes synchronously.\n -* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n -* In case of animated gif encoding, image_util_encode_set_resolution(), image_util_encode_set_input_buffer() and\n -* image_util_encode_set_gif_frame_delay_time() MUST be called for each frame. -* In case of animated gif encoding, call image_util_encode_run() for each frame to encode progressively. +* The function executes synchronously.\n +* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n +* In case of animated gif encoding, image_util_encode_set_resolution(), image_util_encode_set_input_buffer() and\n +* image_util_encode_set_gif_frame_delay_time() MUST be called for each frame. +* In case of animated gif encoding, call image_util_encode_run() for each frame to encode progressively. * * @param[in] handle The handle to image util encoding * @param[out] size Size of the encoded image * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -370,18 +369,18 @@ int image_util_encode_run(image_util_encode_h handle, unsigned long long *size); * @since_tizen 3.0 * * @remarks The output will be stored in the pointer set to image_util_encode_set_output_buffer() or image_util_encode_set_output_path().\n -* The function executes asynchronously, which contains complete callback.\n -* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n -* In case of animated gif encoding, image_util_encode_set_resolution(), image_util_encode_set_input_buffer() and\n -* image_util_encode_set_gif_frame_delay_time() MUST be called for each frame. -* In case of animated gif encoding, call image_util_encode_run_async() for each frame to encode progressively. +* The function executes asynchronously, which contains complete callback.\n +* When any of the @pre functions are not called, IMAGE_UTIL_ERROR_INVALID_PARAMETER is returned.\n +* In case of animated gif encoding, image_util_encode_set_resolution(), image_util_encode_set_input_buffer() and\n +* image_util_encode_set_gif_frame_delay_time() MUST be called for each frame. +* In case of animated gif encoding, call image_util_encode_run_async() for each frame to encode progressively. * * @param[in] handle The handle to image util encoding * @param[in] callback The callback function to be invoked * @param[in] user_data The user data to be passed to the callback function * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -413,7 +412,7 @@ int image_util_encode_run_async(image_util_encode_h handle, image_util_encode_co * @param[in] handle The handle to image util encoding * * @return @c 0 on success, -* otherwise a negative error value +* otherwise a negative error value * * @retval #IMAGE_UTIL_ERROR_NONE Successful * @retval #IMAGE_UTIL_ERROR_INVALID_PARAMETER Invalid parameter @@ -428,7 +427,7 @@ int image_util_encode_destroy(image_util_encode_h handle); /** * @deprecated Deprecated since 3.0. Use image_util_encode_create() instead. * @brief Encodes the image to the JPEG image. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @remarks http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n * http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. @@ -459,9 +458,9 @@ int image_util_encode_jpeg(const unsigned char *buffer, int width, int height, i /** * @deprecated Deprecated since 3.0. Use image_util_encode_create() instead. * @brief Encodes the image to the JPEG image -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * -* @remarks You must release @a jpeg_buffer using free(). +* @remarks The @a jpeg_buffer should be released using free(). * * @param[in] image_buffer The original image buffer * @param[in] width The image width @@ -496,4 +495,4 @@ int image_util_encode_jpeg_to_memory(const unsigned char *image_buffer, int widt } #endif -#endif +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_ENCODE_H__ */ \ No newline at end of file diff --git a/include/image_util_internal.h b/include/image_util_internal.h index eae8bb5..a53e077 100755 --- a/include/image_util_internal.h +++ b/include/image_util_internal.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_INTERNAL_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_INTERNAL_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_INTERNAL_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_INTERNAL_H__ #include @@ -280,7 +280,7 @@ int image_util_frame_set_gif_disposal_mode(image_util_frame_h frame_h, const int * @brief Sets the frame buffer. * @since_tizen 4.0 * -* @remarks You must release the @a buffer using free() after @image_util_frame_destroy. +* @remarks The @a buffer should be released using free(). * * @param[in] frame_h The frame handle to encode * @param[in] buffer The frame buffer to encode @@ -364,4 +364,4 @@ int image_util_encode_save(image_util_encode_h encode_h, unsigned long long *siz } #endif -#endif /* __TIZEN_MEDIA_IMAGE_UTIL_INTERNAL_H__ */ +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_INTERNAL_H__ */ diff --git a/include/image_util_private.h b/include/image_util_private.h index 39c54b3..4a881bb 100755 --- a/include/image_util_private.h +++ b/include/image_util_private.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_PRIVATE_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_PRIVATE_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_PRIVATE_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_PRIVATE_H__ #include #include @@ -195,4 +195,4 @@ bool _image_util_check_resolution(int width, int height); } #endif -#endif /* __TIZEN_MEDIA_IMAGE_UTIL_PRIVATE_H__ */ +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_PRIVATE_H__ */ diff --git a/include/image_util_type.h b/include/image_util_type.h index ef8cea0..caebe2e 100755 --- a/include/image_util_type.h +++ b/include/image_util_type.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_MEDIA_IMAGE_UTIL_TYPE_H__ -#define __TIZEN_MEDIA_IMAGE_UTIL_TYPE_H__ +#ifndef __TIZEN_MULTIMEDIA_IMAGE_UTIL_TYPE_H__ +#define __TIZEN_MULTIMEDIA_IMAGE_UTIL_TYPE_H__ #include #include @@ -25,6 +25,11 @@ extern "C" { #endif +/** +* @brief Definition for Metadata extractor Error Class. +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif +* +*/ #define IMAGE_UTIL_ERROR_CLASS TIZEN_ERROR_IMAGE_UTIL /** @@ -39,7 +44,7 @@ extern "C" /** * @brief Enumeration for error. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { IMAGE_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -54,7 +59,7 @@ typedef enum { /** * @brief Enumeration for colorspace. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { IMAGE_UTIL_COLORSPACE_YV12, /**< YV12 - YCrCb planar format */ @@ -88,7 +93,7 @@ typedef enum { /** * @brief Enumeration for rotation. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { IMAGE_UTIL_ROTATION_NONE = 0, /**< None */ @@ -102,20 +107,20 @@ typedef enum { /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE * @brief Image util handle. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef struct transformation_s *transformation_h; /** * @ingroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE * @brief Called when transform is finished just before returning the output. -* @since_tizen 2.3 +* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * -* @remarks You must release the @a dst result using media_packet_destroy(). \n +* @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] error_code The error code of image util transfrom -* @param[in, out] dst The result buffer 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. */ @@ -231,4 +236,4 @@ typedef void *image_util_encode_h; } #endif -#endif /* __TIZEN_MEDIA_IMAGE_UTIL_TYPE_H__ */ +#endif /* __TIZEN_MULTIMEDIA_IMAGE_UTIL_TYPE_H__ */ diff --git a/packaging/capi-media-image-util.spec b/packaging/capi-media-image-util.spec index b598f58..b379786 100755 --- a/packaging/capi-media-image-util.spec +++ b/packaging/capi-media-image-util.spec @@ -1,6 +1,6 @@ Name: capi-media-image-util Summary: A Image Utility library in Tizen Native API -Version: 0.1.31 +Version: 0.1.32 Release: 2 Group: Multimedia/API License: Apache-2.0 -- 2.7.4