doc/image_util_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_MEDIA_IMAGE_UTIL_DOC_H__
  19 #define __TIZEN_MEDIA_IMAGE_UTIL_DOC_H__
  20
  21 /**
  22  * @file image_util_doc.h
  23  * @brief This file contains high level documentation of the Multimedia Service.
  24  */
  25
  26 /**
  27  * @defgroup CAPI_MEDIA_IMAGE_UTIL_MODULE Image Util
  28  * @brief  The @ref CAPI_MEDIA_IMAGE_UTIL_MODULE  APIs provides functions for common of images .
  29  *
  30  * @ingroup CAPI_MEDIA_FRAMEWORK
  31  *
  32  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_HEADER Required Header
  33  *   \#include <image_util.h>
  34  *
  35  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_OVERVIEW Overview
  36  *
  37  * Image Util API provides support for common functions of images. The API allows :
  38  *- Calculate the size of the image buffer for the specified resolution and colorspace to be used in the image util module.
  39  *- Extracts representative color from an image buffer.
  40  *
  41  * The API consists of @ref CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE,@ref CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE.
  42  */
  43
  44 /**
  45  * @defgroup CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE Image Util Transform
  46  * @brief  The @ref CAPI_MEDIA_IMAGE_UTIL_TRANSFORM_MODULE  APIs provides functions for transforming of images .
  47  *
  48  * @ingroup CAPI_MEDIA_IMAGE_UTIL_MODULE
  49  *
  50  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_TRANSFORM_HEADER Required Header
  51  *   \#include <image_util.h>
  52  *
  53  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_TRANSFORM_OVERVIEW Overview
  54  *
  55  * Image Util API provides support for transforming of images. The API allows :
  56  *- Image transformation(Colorspace conversion/Resize/Rotate/Crop) .
  57  *
  58  * The API allows to transform(Colorspace conversion/Resize/Rotate/Crop) including convert the colorspace(#image_util_colorspace_e) of an image by calling
  59  * #image_util_transform_run() function.
  60  */
  61
  62 /**
  63  * @defgroup CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE Image Util Encode/Decode
  64  * @brief  The @ref CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_MODULE  APIs provides functions for encoding and decoding of images .
  65  *
  66  * @ingroup CAPI_MEDIA_IMAGE_UTIL_MODULE
  67  *
  68  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_ENCODE_DECODE_HEADER Required Header
  69  *   \#include <image_util.h>
  70  *
  71  * @section CAPI_MEDIA_IMAGE_UTIL_MODULE_ENCODE_DECODE_OVERVIEW Overview
  72  *
  73  * Image Util API provides support for encoding and decoding of images. The API allows :
  74  *- Encoding of a JPEG/PNG/GIF/BMP image.
  75  *- Decoding of a JPEG/PNG/GIF/BMP image.
  76  * Encoding supports gif images including the animated, but decoding gif does not support the animated.
  77  *
  78  * The decoding of a jpeg/png/gif/bmp image located at a given path, to a buffer can be done by calling #image_util_decode_run() function and decoding of a jpeg image on memory
  79  * can be done by calling #image_util_decode_set_output_buffer(). Similarly, for encoding #image_util_encode_run() and #image_util_encode_set_output_buffer() functions can be called
  80  * to encode an image buffer to a jpeg/png/gif/bmp image and a buffer respectively.
  81  *
  82  * @subsection CAPI_MEDIA_IMAGE_UTIL_ENCODE_DECODE_FOREACH_OPERATIONS Foreach Operations
  83  * <div><table class="doxtable" >
  84  *     <tr>
  85  *        <th><b>FOREACH</b></th>
  86  *        <th><b>CALLBACK</b></th>
  87  *        <th><b>DESCRIPTION</b></th>
  88  *     </tr>
  89  *     <tr>
  90  *        <td>image_util_foreach_supported_colorspace()</td>
  91  *        <td>image_util_supported_colorspace_cb()</td>
  92  *        <td> Supported JPEG/PNG/GIF/BMP encoding/decoding colorspace</td>
  93  *     </tr>
  94  *</table></div>
  95  */
  96
  97 #endif /* __TIZEN_MEDIA_IMAGE_UTIL_DOC_H__ */