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_CONTENT_MEDIA_FACE_H__
18 #define __TIZEN_CONTENT_MEDIA_FACE_H__
20 #include <media_content_type.h>
24 #endif /* __cplusplus */
28 * @brief This file contains the media face function and related to all operations with the face information of the image in Media DB. \n
29 * Functions include cloning and destroying the media 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() function. And you can insert,update,delete face information manually.
35 * @addtogroup CAPI_CONTENT_MEDIA_FACE_MODULE
40 * @brief Clones the media face handle.
41 * @details This function copies the media 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 * @remarks The @a dst should be released using media_face_destroy().
49 * @param[out] dst The destination handle to the media face
50 * @param[in] src The source handle to the media face
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 media face handle.
65 * @details Function frees all resources related to media face handle. This
66 * handle no longer can be used to perform any operations. New handle has to
67 * be created before next usage.
71 * @param[in] face The media 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 * @pre Get copy of media face handle by calling media_face_clone() or Get media face handle by calling media_info_foreach_face_from_db()
80 * @see media_face_clone()
82 int media_face_destroy(media_face_h face);
85 * @brief Gets the face id from the media face handle.
89 * @remarks The @a face_id should be released using free().
91 * @param[in] face The media face handle
92 * @param[out] face_id The ID of the media face
94 * @return 0 on success, otherwise a negative error value.
96 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
97 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
99 int media_face_get_face_id(media_face_h face, char **face_id);
102 * @brief Gets the media id from the media face handle.
106 * @remarks The @a media_id should be released using free().
108 * @param[in] face The media face handle
109 * @param[out] media_id The media ID
111 * @return 0 on success, otherwise a negative error value.
113 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
114 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
116 int media_face_get_media_id(media_face_h face, char **media_id);
119 * @brief Gets the face's rectangle from the media face handle.
120 * @details This function can get the face's rectangle information. returned rectangle information includes the orientation value.
124 * @param[in] face The media face handle
125 * @param[out] rect_x The x position of the media face
126 * @param[out] rect_y The y position of the media face
127 * @param[out] rect_w The width of the media face
128 * @param[out] rect_h The height of the media face
130 * @return 0 on success, otherwise a negative error value.
131 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
132 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
134 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);
137 * @brief Gets the orientation from the media face handle.
138 * @details This function can get the orientation value from the original image.
142 * @param[in] face The media face handle
143 * @param[out] orientation The orientation of the media face
145 * @return 0 on success, otherwise a negative error value.
146 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
147 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
149 int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation);
152 * @brief Gets the tag from the media face handle.
156 * @remarks The @a tag should be released using free().
158 * @param[in] face The media face handle
159 * @param[out] tag The tag of the media face
161 * @return 0 on success, otherwise a negative error value.
162 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
163 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
165 int media_face_get_tag(media_face_h face, char **tag);
168 * @brief Creates the media face handle.
172 * @remarks The @a face should be released using media_face_destroy().
174 * @param[in] media_id The media ID
175 * @param[out] face The media face handle
177 * @return 0 on success, otherwise a negative error value.
178 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
179 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
181 * @see media_face_destroy()
183 int media_face_create(const char *media_id, media_face_h *face);
186 * @brief Sets the face rectangle of the media face handle.
190 * @param[in] face The media face handle
191 * @param[in] rect_x The integer to set as a position x of face rectangle
192 * @param[in] rect_y The integer to set as a position y of face rectangle
193 * @param[in] rect_w The integer to set as a width of face rectangle
194 * @param[in] rect_h The integer to set as a height of face rectangle
196 * @return 0 on success, otherwise a negative error value.
197 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
198 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
200 * @post media_face_insert_to_db()
201 * @post media_face_update_to_db()
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);
207 * @brief Sets the orientation of the media face handle.
208 * @details This function may set the value of the original image orientation.
212 * @param[in] face The media face handle
213 * @param[in] orientation The integer to set as an orientation
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
219 * @post media_face_insert_to_db()
220 * @post media_face_update_to_db()
223 int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation);
226 * @brief Sets the tag of the media face handle.
230 * @param[in] face The media face handle
231 * @param[in] tag The tag of the media face
233 * @return 0 on success, otherwise a negative error value.
234 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
235 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
236 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
238 * @post media_face_insert_to_db()
239 * @post media_face_update_to_db()
241 int media_face_set_tag(media_face_h face, const char *tag);
244 * @brief Inserts a new face in the media database.
248 * @privilege %http://tizen.org/privilege/content.write
250 * @remarks The @a face should be released using media_face_destroy().
252 * @param[in] face The media face handle
254 * @return 0 on success, otherwise a negative error value.
256 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
257 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
258 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
259 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
260 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
261 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
262 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
263 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
265 * @see media_content_connect()
266 * @see media_face_destroy()
267 * @see media_face_set_xxx()
269 int media_face_insert_to_db(media_face_h face);
272 * @brief Updates the face details to the media database.
274 * @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
275 * 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
276 * the given face attributes in the media database.
280 * @privilege %http://tizen.org/privilege/content.write
282 * @param[in] face The media face handle to update
284 * @return 0 on success, otherwise a negative error value.
286 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
287 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
288 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
289 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
290 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
291 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
292 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
294 * @pre This function requires opened connection to content service by media_content_connect().
296 * @see media_content_connect()
297 * @see media_face_destroy()
298 * @see media_face_set_xxx()
301 int media_face_update_to_db(media_face_h face);
304 * @brief Deletes the face with given face id from the media database.
309 * @privilege %http://tizen.org/privilege/content.write
311 * @param[in] face_id The ID of the media face
313 * @return 0 on success, otherwise a negative error value.
314 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
315 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
316 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
317 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
318 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
319 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
320 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
322 * @pre This function requires opened connection to content service by media_content_connect().
323 * @see media_content_connect()
326 int media_face_delete_from_db(const char *face_id);
329 * @brief Gets the number of media faces with an optional filter from the media database.
332 * @param[in] filter The handle to the media filter
333 * @param[out] face_count The count of the media faces
335 * @return @c 0 on success,
336 * otherwise a negative error value
338 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
339 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
340 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
341 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
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 media 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
369 * @pre This function requires opened connection to content service by media_content_connect().
370 * @post This function invokes media_face_cb().
372 * @see media_content_connect()
373 * @see media_face_cb()
374 * @see media_filter_create()
376 int media_face_foreach_face_from_db(filter_h filter, media_face_cb callback, void *user_data);
384 #endif /* __cplusplus */
386 #endif /* __TIZEN_CONTENT_MEDIA_FACE_H__ */