include_product/media_face.h

   1 /*
   2 * Copyright (c) 2014 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 #ifndef __TIZEN_MEDIA_IMAGE_FACE_H__
  18 #define __TIZEN_MEDIA_IMAGE_FACE_H__
  19
  20 #include <media_content_type.h>
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif /* __cplusplus */
  25
  26 /**
  27  * @file media_face.h
  28  * @brief This file contains the media face API and related to all operations with the face information of the image in Media DB. \n
  29  *             Functions include cloning and destroying the face handler, getting face information such as face id, face coordinates in file, \n
  30  *             face tag. Face information will be managed by DB. To insert face information, you should use media_face_insert_to_db() \n
  31  *             or media_info_start_face_detection() API. And you can insert,update,delete face information manually.
  32  */
  33
  34 /**
  35  * @addtogroup CAPI_CONTENT_MEDIA_FACE_MODULE
  36  * @{
  37  */
  38
  39 /**
  40  * @brief Clones the face handle.
  41  * @details This function copies the face handle from a source to
  42  * destination. There is no media_face_create() function. The media_face_h is created internally and available through
  43  * media face foreach function such as media_face_foreach_face_from_db(). To use this handle outside of these foreach functions,
  44  * use this function.
  45  *
  46  * @since_tizen 3.0
  47  * @remark The destination handle must be released with media_event_destroy() by you.
  48  *
  49  * @param [in] src The source face handle
  50  * @param [out] dst A destination face handle
  51  *
  52  * @return 0 on success, otherwise a negative error value.
  53  *
  54  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  55  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  56  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
  57  *
  58  * @see media_face_destroy()
  59  * @see media_face_foreach_face_from_db()
  60  */
  61 int media_face_clone(media_face_h *dst, media_face_h src);
  62
  63 /**
  64  * @brief Destroys the face handle.
  65  * @details Function frees all resources related to face handle. This
  66  * handle no longer can be used to perform any operation. New handle has to
  67  * be created before next usage.
  68  *
  69  * @since_tizen 3.0
  70  *
  71  * @param [in] face The face handle
  72  *
  73  * @return 0 on success, otherwise a negative error value.
  74  *
  75  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  76  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  77  *
  78  * @see media_face_clone()
  79  *
  80  * @pre Get copy of face handle by calling media_face_clone() or Get face handle by calling media_info_foreach_face_from_db()
  81  *
  82  */
  83 int media_face_destroy(media_face_h face);
  84
  85 /**
  86  * @brief Gets the face id from the face handle.
  87  *
  88  * @since_tizen 3.0
  89  *
  90  * @remarks You must release @a face_id using free().
  91  *
  92  * @param [in] face The face handle
  93  * @param [out] face_id The uuid of the face handle
  94  *
  95  * @return 0 on success, otherwise a negative error value.
  96  *
  97  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  98  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  99  */
 100 int media_face_get_face_id(media_face_h face, char **face_id);
 101
 102 /**
 103  * @brief Gets the media uuid from the face handle.
 104  *
 105  * @since_tizen 3.0
 106  *
 107  * @remarks You must release @a media_id using free().
 108  *
 109  * @param [in] face The face handle
 110  * @param [out] media_id The media uuid of the face handle
 111  *
 112  * @return 0 on success, otherwise a negative error value.
 113  *
 114  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 115  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 116  */
 117 int media_face_get_media_id(media_face_h face, char **media_id);
 118
 119  /**
 120  * @brief Gets the face's rectangle from the face handle.
 121  * @details This API can get the face's rectangle information. returned rectangle information includes the orientation value.
 122  *
 123  * @since_tizen 3.0
 124  *
 125  * @param [in] face The face handle
 126  * @param [out] rect_x The x position of face of the face handle
 127  * @param [out] rect_y The y position of face of the face handle
 128  * @param [out] rect_w The width of face of the face handle
 129  * @param [out] rect_h The height of face of the face handle
 130  *
 131  * @return 0 on success, otherwise a negative error value.
 132  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 133  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 134  */
 135 int media_face_get_face_rect(media_face_h face, unsigned int *rect_x, unsigned int *rect_y, unsigned int *rect_w, unsigned int *rect_h);
 136
 137 /**
 138  * @brief Gets the orientation from the face handle.
 139  * @details This API can get the orientation value from the original image.
 140  *
 141  * @since_tizen 3.0
 142  *
 143  * @param [in] face The face handle
 144  * @param [out] orientation The orientation of the face handle
 145  *
 146  * @return 0 on success, otherwise a negative error value.
 147  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 148  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 149  */
 150 int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation);
 151
 152 /**
 153  * @brief Gets the tag from the face handle.
 154  *
 155  * @since_tizen 3.0
 156  *
 157  * @remarks You must release @a tag using free().
 158  *
 159  * @param [in] face The face handle
 160  * @param [out] tag The tag of the face handle
 161  *
 162  * @return 0 on success, otherwise a negative error value.
 163  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 164  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 165  */
 166 int media_face_get_tag(media_face_h face, char **tag);
 167
 168 /**
 169  * @brief Creates the face handle.
 170  *
 171  * @since_tizen 3.0
 172  *
 173  * @param [in] media_id The media uuid to create the face handle
 174  * @param [out] face The face handle
 175  *
 176  * @return 0 on success, otherwise a negative error value.
 177  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 178  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 179  *
 180  * @see media_face_destroy()
 181  */
 182 int media_face_create(const char *media_id, media_face_h *face);
 183
 184 /**
 185  * @brief Sets the face rectangle of the face handle
 186  *
 187  * @since_tizen 3.0
 188  *
 189  * @param[in] face The face handle
 190  * @param[in] rect_x The integer to set as a position x of face rectangle
 191  * @param[in] rect_y The integer to set as a position y of face rectangle
 192  * @param[in] rect_w The integer to set as a width  of face rectangle
 193  * @param[in] rect_h The integer to set as a height of face rectangle
 194  *
 195  * @return 0 on success, otherwise a negative error value.
 196  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 197  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 198  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
 199  *
 200  * @post media_face_insert_to_db()
 201  * @post media_face_update_to_db()
 202  *
 203  */
 204 int media_face_set_face_rect(media_face_h face, unsigned int rect_x, unsigned int rect_y, unsigned int rect_w, unsigned int rect_h);
 205
 206 /**
 207  * @brief Sets the orientation of the face handle
 208  * @details This API may set the value of the original image orientation.
 209  *
 210  * @since_tizen 3.0
 211  *
 212  * @param[in] face The face handle
 213  * @param[in] orientation The integer to set as an orientation
 214  *
 215  * @return 0 on success, otherwise a negative error value.
 216  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 217  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 218  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
 219  *
 220  * @post media_face_insert_to_db()
 221  * @post media_face_update_to_db()
 222  *
 223  */
 224 int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation);
 225
 226 /**
 227  * @brief Sets the tag of the face handle.
 228  *
 229  * @since_tizen 3.0
 230  *
 231  * @param [in] face The face handle
 232  * @param [in] tag The tag of the face handle
 233  *
 234  * @return 0 on success, otherwise a negative error value.
 235  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 236  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 237  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
 238  *
 239  * @post media_face_insert_to_db()
 240  * @post media_face_update_to_db()
 241  */
 242 int media_face_set_tag(media_face_h face, const char *tag);
 243
 244 /**
 245  * @brief Inserts a new face in the media database.
 246  * @since_tizen 3.0
 247  *
 248  * @privlevel public
 249  * @privilege %http://tizen.org/privilege/content.write
 250  *
 251  * @remarks The created tag handle must be released using media_tag_destroy().
 252  *
 253  * @param [in] face The face handle
 254  *
 255  * @return 0 on success, otherwise a negative error value.
 256  *
 257  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 258  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 259  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
 260  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 261  *
 262  * @see media_content_connect()
 263  * @see media_face_destroy()
 264  * @see media_face_set_xxx()
 265  */
 266 int media_face_insert_to_db(media_face_h face);
 267
 268 /**
 269  * @brief Updates the face details to the media database.
 270  *
 271  * @details The function updates the given media face in the media database. The function should be called after any change in face, to be updated to the media
 272  * database. For example, after using media_face_set_orientation() for setting the orientation of the face, media_face_update_to_db() function should be called so as to update
 273  * the given face attributes in the media database.
 274  * @since_tizen 3.0
 275  *
 276  * @privlevel public
 277  * @privilege %http://tizen.org/privilege/content.write
 278  *
 279  * @param[in] face The face handle to update
 280  *
 281  * @return 0 on success, otherwise a negative error value.
 282  *
 283  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 284  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 285  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 286  *
 287  * @pre This function requires opened connection to content service by media_content_connect().
 288  *
 289  * @see media_content_connect()
 290  * @see media_face_destroy()
 291  * @see media_face_set_xxx()
 292  *
 293  */
 294 int media_face_update_to_db(media_face_h face);
 295
 296 /**
 297  * @brief Deletes the face with given face uuid from the media database.
 298  *
 299  * @since_tizen 3.0
 300  *
 301  * @privlevel public
 302  * @privilege %http://tizen.org/privilege/content.write
 303  *
 304  * @param [in] face_id The id of media face
 305  *
 306  * @return 0 on success, otherwise a negative error value.
 307  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 308  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 309  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 310  *
 311  * @pre This function requires opened connection to content service by media_content_connect().
 312  * @see media_content_connect()
 313  *
 314  */
 315 int media_face_delete_from_db(const char *face_id);
 316
 317 /**
 318  * @}
 319  */
 320
 321 #ifdef __cplusplus
 322 }
 323 #endif /* __cplusplus */
 324
 325 #endif /* __TIZEN_MEDIA_IMAGE_FACE_H__ */