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 * @deprecated Deprecated since 8.0.
41 * @brief Clones the media face handle.
42 * @details This function copies the media face handle from a source to
43 * destination. There is no media_face_create() function. The media_face_h is created internally and available through
44 * media face foreach function such as media_face_foreach_face_from_db(). To use this handle outside of these foreach functions,
48 * @remarks The @a dst should be released using media_face_destroy().
50 * @param[out] dst The destination handle to the media face
51 * @param[in] src The source handle to the media face
53 * @return 0 on success, otherwise a negative error value.
55 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
56 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
57 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
59 * @see media_face_destroy()
60 * @see media_face_foreach_face_from_db()
62 int media_face_clone(media_face_h *dst, media_face_h src) TIZEN_DEPRECATED_API;
65 * @deprecated Deprecated since 8.0.
66 * @brief Destroys the media face handle.
67 * @details Function frees all resources related to media face handle. This
68 * handle no longer can be used to perform any operations. New handle has to
69 * be created before next usage.
73 * @param[in] face The media face handle
75 * @return 0 on success, otherwise a negative error value.
77 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
78 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
80 * @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()
82 * @see media_face_clone()
84 int media_face_destroy(media_face_h face) TIZEN_DEPRECATED_API;
87 * @deprecated Deprecated since 8.0.
88 * @brief Gets the face id from the media face handle.
92 * @remarks The @a face_id should be released using free().
94 * @param[in] face The media face handle
95 * @param[out] face_id The ID of the media face
97 * @return 0 on success, otherwise a negative error value.
99 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
100 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
102 int media_face_get_face_id(media_face_h face, char **face_id) TIZEN_DEPRECATED_API;
105 * @deprecated Deprecated since 8.0.
106 * @brief Gets the media id from the media face handle.
110 * @remarks The @a media_id should be released using free().
112 * @param[in] face The media face handle
113 * @param[out] media_id The media ID
115 * @return 0 on success, otherwise a negative error value.
117 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
118 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
120 int media_face_get_media_id(media_face_h face, char **media_id) TIZEN_DEPRECATED_API;
123 * @deprecated Deprecated since 8.0.
124 * @brief Gets the face's rectangle from the media face handle.
125 * @details This function can get the face's rectangle information. returned rectangle information includes the orientation value.
129 * @param[in] face The media face handle
130 * @param[out] rect_x The x position of the media face
131 * @param[out] rect_y The y position of the media face
132 * @param[out] rect_w The width of the media face
133 * @param[out] rect_h The height of the media face
135 * @return 0 on success, otherwise a negative error value.
136 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
137 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
139 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) TIZEN_DEPRECATED_API;
142 * @deprecated Deprecated since 8.0.
143 * @brief Gets the orientation from the media face handle.
144 * @details This function can get the orientation value from the original image.
148 * @param[in] face The media face handle
149 * @param[out] orientation The orientation of the media face
151 * @return 0 on success, otherwise a negative error value.
152 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
153 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
155 int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation) TIZEN_DEPRECATED_API;
158 * @deprecated Deprecated since 8.0.
159 * @brief Gets the tag from the media face handle.
163 * @remarks The @a tag should be released using free().
165 * @param[in] face The media face handle
166 * @param[out] tag The tag of the media face
168 * @return 0 on success, otherwise a negative error value.
169 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
170 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
172 int media_face_get_tag(media_face_h face, char **tag) TIZEN_DEPRECATED_API;
175 * @deprecated Deprecated since 8.0.
176 * @brief Creates the media face handle.
180 * @remarks The @a face should be released using media_face_destroy(). \n
181 * Since 5.5, this function supports only image type.
183 * @param[in] media_id The media ID
184 * @param[out] face The media face handle
186 * @return 0 on success, otherwise a negative error value.
187 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
188 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
190 * @see media_face_destroy()
192 int media_face_create(const char *media_id, media_face_h *face) TIZEN_DEPRECATED_API;
195 * @deprecated Deprecated since 8.0.
196 * @brief Sets the face rectangle of the media face handle.
200 * @param[in] face The media face handle
201 * @param[in] rect_x The integer to set as a position x of face rectangle
202 * @param[in] rect_y The integer to set as a position y of face rectangle
203 * @param[in] rect_w The integer to set as a width of face rectangle
204 * @param[in] rect_h The integer to set as a height of face rectangle
206 * @return 0 on success, otherwise a negative error value.
207 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
208 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
210 * @post media_face_insert_to_db()
211 * @post media_face_update_to_db()
214 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) TIZEN_DEPRECATED_API;
217 * @deprecated Deprecated since 8.0.
218 * @brief Sets the orientation of the media face handle.
219 * @details This function may set the value of the original image orientation.
223 * @param[in] face The media face handle
224 * @param[in] orientation The integer to set as an orientation
226 * @return 0 on success, otherwise a negative error value.
227 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
228 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
230 * @post media_face_insert_to_db()
231 * @post media_face_update_to_db()
234 int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation) TIZEN_DEPRECATED_API;
237 * @deprecated Deprecated since 8.0.
238 * @brief Sets the tag of the media face handle.
242 * @param[in] face The media face handle
243 * @param[in] tag The tag of the media face
245 * @return 0 on success, otherwise a negative error value.
246 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
247 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
248 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
250 * @post media_face_insert_to_db()
251 * @post media_face_update_to_db()
253 int media_face_set_tag(media_face_h face, const char *tag) TIZEN_DEPRECATED_API;
256 * @deprecated Deprecated since 8.0.
257 * @brief Inserts a new face in the media database.
261 * @privilege %http://tizen.org/privilege/content.write
263 * @remarks The @a face should be released using media_face_destroy().
265 * @param[in] face The media face handle
267 * @return 0 on success, otherwise a negative error value.
269 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
270 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
271 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
272 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
273 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
274 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
275 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
276 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
278 * @see media_content_connect()
279 * @see media_face_destroy()
280 * @see media_face_set_face_rect()
281 * @see media_face_set_orientation()
282 * @see media_face_set_tag()
284 int media_face_insert_to_db(media_face_h face) TIZEN_DEPRECATED_API;
287 * @deprecated Deprecated since 8.0.
288 * @brief Updates the face details to the media database.
290 * @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
291 * 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
292 * the given face attributes in the media database.
296 * @privilege %http://tizen.org/privilege/content.write
298 * @param[in] face The media face handle to update
300 * @return 0 on success, otherwise a negative error value.
302 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
303 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
304 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
305 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
306 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
307 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
308 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
310 * @pre This function requires opened connection to content service by media_content_connect().
312 * @see media_content_connect()
313 * @see media_face_destroy()
314 * @see media_face_set_face_rect()
315 * @see media_face_set_orientation()
316 * @see media_face_set_tag()
319 int media_face_update_to_db(media_face_h face) TIZEN_DEPRECATED_API;
322 * @deprecated Deprecated since 8.0.
323 * @brief Deletes the face with given face id from the media database.
328 * @privilege %http://tizen.org/privilege/content.write
330 * @param[in] face_id The ID of the media face
332 * @return 0 on success, otherwise a negative error value.
333 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
334 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
335 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
336 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
337 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
338 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
339 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
341 * @pre This function requires opened connection to content service by media_content_connect().
342 * @see media_content_connect()
345 int media_face_delete_from_db(const char *face_id) TIZEN_DEPRECATED_API;
348 * @deprecated Deprecated since 8.0.
349 * @brief Gets the number of media faces with an optional filter from the media database.
352 * @param[in] filter The handle to the media filter
353 * @param[out] face_count The count of the media faces
355 * @return @c 0 on success,
356 * otherwise a negative error value
358 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
359 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
360 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
361 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
363 * @pre This function requires opened connection to content service by media_content_connect().
365 * @see media_content_connect()
366 * @see media_filter_create()
368 int media_face_get_face_count_from_db(filter_h filter, int *face_count) TIZEN_DEPRECATED_API;
371 * @deprecated Deprecated since 8.0.
372 * @brief Iterates through the faces with an optional filter from the media database.
373 * @details This function gets all faces associated with the given filter and calls @a callback for every retrieved media face.
374 * If @c NULL is passed to the @a filter, then no filtering is applied.
377 * @param[in] filter The handle to the media filter
378 * @param[in] callback The callback function to be invoked
379 * @param[in] user_data The user data to be passed to the callback function
381 * @return @c 0 on success,
382 * otherwise a negative error value
384 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
385 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
386 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
387 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
388 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
390 * @pre This function requires opened connection to content service by media_content_connect().
391 * @post This function invokes media_face_cb().
393 * @see media_content_connect()
394 * @see media_face_cb()
395 * @see media_filter_create()
397 int media_face_foreach_face_from_db(filter_h filter, media_face_cb callback, void *user_data) TIZEN_DEPRECATED_API;
405 #endif /* __cplusplus */
407 #endif /* __TIZEN_CONTENT_MEDIA_FACE_H__ */