include/devman_image.h

   1 /*
   2  *  devman
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: DongGi Jang <dg0402.jang@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20 */
  21
  22
  23 #ifndef __DEVMAN_IMAGE_H__
  24 #define __DEVMAN_IMAGE_H__
  25
  26 #ifndef DEPRECATED
  27 #define DEPRECATED __attribute__((deprecated))
  28 #endif
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35  * @file        devman_image.h
  36  * @ingroup     DEVICE_MANAGER
  37  * @brief       This file contains the prototypes of API to control image enhance mode
  38  * @author      SLP2.0
  39  * @date        2010-06-26
  40  * @version     0.1
  41  */
  42
  43 /**
  44  * @addtogroup DEVICE_MANAGER
  45  * @{
  46  */
  47
  48 /**
  49  * @par Description:
  50  * mode - dynamic, standard, natural, movie
  51  */
  52         enum image_enhance_mode {
  53                 MODE_DYNAMIC = 0,
  54                 MODE_STANDARD,
  55                 MODE_NATURAL,
  56                 MODE_MOVIE,
  57         };
  58
  59 /**
  60  * @par Description:
  61  *  This API is used to get image enhance mode.\n
  62  *  It returns enum value which is the current mode on success.\n
  63  *  Or a negative value(-1) is returned on failure.
  64  * @return enum value for current mode on success, -1 if failed
  65  * @par Example
  66  * @code
  67  *  ...
  68  *  ret = device_get_image_enhance_mode();
  69  *  if( ret < 0 )
  70  *      printf("Fail to get current image enhance mode\n");
  71  *  ...
  72  * @endcode
  73  */
  74         int device_get_image_enhance_mode(void);
  75
  76 /**
  77  * @par Description:
  78  *  This API is used to set image enhance mode.\n
  79  * @param[in] val mode enum vlaue
  80  * @return 0 on success, -1 if failed
  81  * @par Example
  82  * @code
  83  *  ...
  84  *  if( device_set_image_enhance_mode(MODE_DYNAMIC) < 0 )
  85  *      printf("Fail to set the image enhance mode\n");
  86  *  ...
  87  * @endcode
  88  */
  89         int device_set_image_enhance_mode(int val);
  90
  91 /**
  92  * @par Description:
  93  * scenario - ui, gallery, video, vtcall, camera, browser, negative, bypass
  94  */
  95         enum image_enhance_scenario {
  96                 SCENARIO_UI = 0,
  97                 SCENARIO_GALLERY,
  98                 SCENARIO_VIDEO,
  99                 SCENARIO_VTCALL,
 100                 SCENARIO_CAMERA,
 101                 SCENARIO_BROWSER,
 102                 SCENARIO_NEGATIVE,
 103                 SCENARIO_BYPASS,
 104         };
 105
 106 /**
 107  * @par Description:
 108  *  This API is used to get image enhance scenario.\n
 109  *  It returns enum value which is the current scenario on success.\n
 110  *  Or a negative value(-1) is returned on failure.
 111  * @return enum value for current wcenario on success, -1 if failed
 112  * @par Example
 113  * @code
 114  *  ...
 115  *  ret = device_get_image_enhance_scenario();
 116  *  if( ret < 0 )
 117  *      printf("Fail to get current image enhance scenarioe\n");
 118  *  ...
 119  * @endcode
 120  */
 121         int device_get_image_enhance_scenario(void);
 122
 123 /**
 124  * @par Description:
 125  *  This API is used to set image enhance scenario.\n
 126  * @param[in] val scenario enum vlaue
 127  * @return 0 on success, -1 if failed
 128  * @par Example
 129  * @code
 130  *  ...
 131  *  if( device_set_image_enhance_scenario(SCENARIO_UI) < 0 )
 132  *      printf("Fail to set the image enhance scenario\n");
 133  *  ...
 134  * @endcode
 135  */
 136         int device_set_image_enhance_scenario(int val);
 137
 138 /**
 139  * @par Description:
 140  * tone - normal, warm, cold
 141  */
 142         enum image_enhance_tone {
 143                 TONE_NORMAL = 0,
 144                 TONE_WARM,
 145                 TONE_COLD,
 146         };
 147
 148 /**
 149  * @par Description:
 150  *  This API is used to get image enhance tone.\n
 151  *  It returns enum value which is the current mode on success.\n
 152  *  Or a negative value(-1) is returned on failure.
 153  * @return enum value for current tone on success, -1 if failed
 154  * @par Example
 155  * @code
 156  *  ...
 157  *  ret = device_get_image_enhance_tone();
 158  *  if( ret < 0 )
 159  *      printf("Fail to get current image enhance tone\n");
 160  *  ...
 161  * @endcode
 162  */
 163         int device_get_image_enhance_tone(void);
 164
 165 /**
 166  * @par Description:
 167  *  This API is used to set image enhance tone.\n
 168  * @param[in] val tone vlaue
 169  * @return 0 on success, -1 if failed
 170  * @par Example
 171  * @code
 172  *  ...
 173  *  if( device_set_image_enhance_tone(TONE_NORMAL) < 0 )
 174  *      printf("Fail to set the image enhance tone\n");
 175  *  ...
 176  * @endcode
 177  */
 178         int device_set_image_enhance_tone(int val);
 179
 180 /**
 181  * @par Description:
 182  * outdoor - off, on
 183  */
 184         enum image_enhance_outdoor {
 185                 OUTDOOR_OFF = 0,
 186                 OUTDOOR_ON,
 187         };
 188
 189 /**
 190  * @par Description:
 191  *  This API is used to get image enhance outdoor.\n
 192  *  It returns enum value which is the current outdoor on success.\n
 193  *  Or a negative value(-1) is returned on failure.
 194  * @return enum value for current outdoor on success, -1 if failed
 195  * @par Example
 196  * @code
 197  *  ...
 198  *  ret = device_get_image_enhance_ourdoor();
 199  *  if( ret < 0 )
 200  *      printf("Fail to get current image enhance outdoor\n");
 201  *  ...
 202  * @endcode
 203  */
 204         int device_get_image_enhance_outdoor(void);
 205
 206 /**
 207  * @par Description:
 208  *  This API is used to set image enhance outdoor.\n
 209  * @param[in] val outdoor vlaue
 210  * @return 0 on success, -1 if failed
 211  * @par Example
 212  * @code
 213  *  ...
 214  *  if( device_set_image_enhance_outdoor(TONE_NORMAL) < 0 )
 215  *      printf("Fail to set the image enhance outdoor\n");
 216  *  ...
 217  * @endcode
 218  */
 219         int device_set_image_enhance_outdoor(int val);
 220
 221 /**
 222  * @par Description:
 223  *  This API is used to get information about image enhance function.\n
 224  *  It returns 1, this device can use enhance mode.\n
 225  *  Or a negative value(-1) is returned, it doesn't support enhance mode.
 226  * @return 1 is returned on support for enhance mode, -1 if not.
 227  * @par Example
 228  * @code
 229  *  ...
 230  *  ret = device_get_image_enhance_info();
 231  *  if( ret < 0 )
 232  *      printf("Not support image enhance mode on this device\n");
 233  *  ...
 234  * @endcode
 235  */
 236         int device_get_image_enhance_info(void);
 237
 238 /**
 239  * @} // end of image enhance APIs
 240  */
 241
 242 #ifdef __cplusplus
 243 }
 244 #endif
 245 #endif