2 * Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef __TIZEN_MEDIA_IMAGE_FACE_H__
18 #define __TIZEN_MEDIA_IMAGE_FACE_H__
20 #include <media_content_type.h>
24 #endif /* __cplusplus */
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.
35 * @addtogroup CAPI_CONTENT_MEDIA_FACE_MODULE
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,
47 * @remark The destination handle must be released with media_event_destroy() by you.
49 * @param [in] src The source face handle
50 * @param [out] dst A destination face handle
52 * @return 0 on success, otherwise a negative error value.
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
58 * @see media_face_destroy()
59 * @see media_face_foreach_face_from_db()
61 int media_face_clone(media_face_h *dst, media_face_h src);
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.
71 * @param [in] face The face handle
73 * @return 0 on success, otherwise a negative error value.
75 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
76 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
78 * @see media_face_clone()
80 * @pre Get copy of face handle by calling media_face_clone() or Get face handle by calling media_info_foreach_face_from_db()
83 int media_face_destroy(media_face_h face);
86 * @brief Gets the face id from the face handle.
90 * @remarks You must release @a face_id using free().
92 * @param [in] face The face handle
93 * @param [out] face_id The uuid of the face handle
95 * @return 0 on success, otherwise a negative error value.
97 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
98 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
100 int media_face_get_face_id(media_face_h face, char **face_id);
103 * @brief Gets the media uuid from the face handle.
107 * @remarks You must release @a media_id using free().
109 * @param [in] face The face handle
110 * @param [out] media_id The media uuid of the face handle
112 * @return 0 on success, otherwise a negative error value.
114 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
115 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
117 int media_face_get_media_id(media_face_h face, char **media_id);
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.
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
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
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);
138 * @brief Gets the orientation from the face handle.
139 * @details This API can get the orientation value from the original image.
143 * @param [in] face The face handle
144 * @param [out] orientation The orientation of the face handle
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
150 int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation);
153 * @brief Gets the tag from the face handle.
157 * @remarks You must release @a tag using free().
159 * @param [in] face The face handle
160 * @param [out] tag The tag of the face handle
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
166 int media_face_get_tag(media_face_h face, char **tag);
169 * @brief Creates the face handle.
173 * @param [in] media_id The media uuid to create the face handle
174 * @param [out] face The face handle
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
180 * @see media_face_destroy()
182 int media_face_create(const char *media_id, media_face_h *face);
185 * @brief Sets the face rectangle of the face handle
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
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
199 * @post media_face_insert_to_db()
200 * @post media_face_update_to_db()
203 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);
206 * @brief Sets the orientation of the face handle
207 * @details This API may set the value of the original image orientation.
211 * @param[in] face The face handle
212 * @param[in] orientation The integer to set as an orientation
214 * @return 0 on success, otherwise a negative error value.
215 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
216 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
218 * @post media_face_insert_to_db()
219 * @post media_face_update_to_db()
222 int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation);
225 * @brief Sets the tag of the face handle.
229 * @param [in] face The face handle
230 * @param [in] tag The tag of the face handle
232 * @return 0 on success, otherwise a negative error value.
233 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
234 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
235 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
237 * @post media_face_insert_to_db()
238 * @post media_face_update_to_db()
240 int media_face_set_tag(media_face_h face, const char *tag);
243 * @brief Inserts a new face in the media database.
247 * @privilege %http://tizen.org/privilege/content.write
249 * @remarks The created tag handle must be released using media_tag_destroy().
251 * @param [in] face The face handle
253 * @return 0 on success, otherwise a negative error value.
255 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
256 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
257 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
258 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
259 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
260 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
261 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
262 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
264 * @see media_content_connect()
265 * @see media_face_destroy()
266 * @see media_face_set_xxx()
268 int media_face_insert_to_db(media_face_h face);
271 * @brief Updates the face details to the media database.
273 * @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
274 * 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
275 * the given face attributes in the media database.
279 * @privilege %http://tizen.org/privilege/content.write
281 * @param[in] face The face handle to update
283 * @return 0 on success, otherwise a negative error value.
285 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
286 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
287 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
288 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
289 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
290 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
291 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
293 * @pre This function requires opened connection to content service by media_content_connect().
295 * @see media_content_connect()
296 * @see media_face_destroy()
297 * @see media_face_set_xxx()
300 int media_face_update_to_db(media_face_h face);
303 * @brief Deletes the face with given face uuid from the media database.
308 * @privilege %http://tizen.org/privilege/content.write
310 * @param [in] face_id The id of media face
312 * @return 0 on success, otherwise a negative error value.
313 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
314 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
315 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
316 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
317 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
318 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
319 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
321 * @pre This function requires opened connection to content service by media_content_connect().
322 * @see media_content_connect()
325 int media_face_delete_from_db(const char *face_id);
328 * @brief Gets the number of media faces with an optional filter from the media database.
331 * @param[in] filter The handle to the face filter
332 * @param[out] face_count The count of the media faces
334 * @return @c 0 on success,
335 * otherwise a negative error value
337 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
338 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
339 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
340 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
341 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
343 * @pre This function requires opened connection to content service by media_content_connect().
345 * @see media_content_connect()
346 * @see media_filter_create()
348 int media_face_get_face_count_from_db(filter_h filter, int *face_count);
351 * @brief Iterates through the faces with an optional filter from the media database.
352 * @details This function gets all faces associated with the given filter and calls @a callback for every retrieved media face.
353 * If @c NULL is passed to the @a filter, then no filtering is applied.
356 * @param[in] filter The handle to the face filter
357 * @param[in] callback The callback function to be invoked
358 * @param[in] user_data The user data to be passed to the callback function
360 * @return @c 0 on success,
361 * otherwise a negative error value
363 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
364 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
365 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
366 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
367 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
368 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
370 * @pre This function requires opened connection to content service by media_content_connect().
371 * @post This function invokes media_face_cb().
373 * @see media_content_connect()
374 * @see media_face_cb()
375 * @see media_filter_create()
377 int media_face_foreach_face_from_db(filter_h filter, media_face_cb callback, void *user_data);
385 #endif /* __cplusplus */
387 #endif /* __TIZEN_MEDIA_IMAGE_FACE_H__ */