2 * Copyright (c) 2011 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.
18 #ifndef __TIZEN_MEDIA_CONTENT_TYPE_H__
19 #define __TIZEN_MEDIA_CONTENT_TYPE_H__
26 #endif /* __cplusplus */
29 #ifndef DEPRECATED_API
30 #define DEPRECATED_API __attribute__ ((deprecated))
34 * @addtogroup CAPI_MEDIA_CONTENT_MODULE
39 * @ingroup CAPI_MEDIA_CONTENT_MODULE
40 * @brief The enumerations of the media file format.
44 MEDIA_CONTENT_TYPE_IMAGE = 0, /**<The type of image */
45 MEDIA_CONTENT_TYPE_VIDEO = 1, /**<The type of video */
46 MEDIA_CONTENT_TYPE_SOUND = 2, /**<The type of sound */
47 MEDIA_CONTENT_TYPE_MUSIC = 3, /**<The type of music */
48 MEDIA_CONTENT_TYPE_OTHERS = 4, /**<The type of other */
49 } media_content_type_e;
52 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
53 * @brief The enumerations of the storage type.
54 * @detail This information is used to establish where the folder is.
58 MEDIA_CONTENT_STORAGE_INTERNAL = 0, /**< The device's internal storage */
59 MEDIA_CONTENT_STORAGE_EXTERNAL = 1, /**< The device's external storage */
60 } media_content_storage_e;
63 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
64 * @brief The type of orientation.
67 MEDIA_CONTENT_ORIENTATION_NOT_AVAILABLE = 0, /**< Not available*/
68 MEDIA_CONTENT_ORIENTATION_NORMAL = 1, /**< Normal*/
69 MEDIA_CONTENT_ORIENTATION_HFLIP = 2, /**< Flip horizontal*/
70 MEDIA_CONTENT_ORIENTATION_ROT_180 = 3, /**< Rotate 180 degrees*/
71 MEDIA_CONTENT_ORIENTATION_VFLIP = 4, /**< Flip vertical*/
72 MEDIA_CONTENT_ORIENTATION_TRANSPOSE = 5, /**< Transpose*/
73 MEDIA_CONTENT_ORIENTATION_ROT_90 = 6, /**< Rotate 90 degrees*/
74 MEDIA_CONTENT_ORIENTATION_TRANSVERSE = 7, /**< Transverse*/
75 MEDIA_CONTENT_ORIENTATION_ROT_270 = 8, /**< Rotate 270 degrees*/
76 } media_content_orientation_e;
79 * @ingroup CAPI_MEDIA_CONTENT_MODULE
80 * @brief The enumerations of ordering.
84 MEDIA_CONTENT_ORDER_ASC = 0, /**< ascending order*/
85 MEDIA_CONTENT_ORDER_DESC = 1, /**< descending order*/
86 } media_content_order_e;
89 * @ingroup CAPI_MEDIA_CONTENT_MODULE
90 * @brief The enumerations of collations.
94 MEDIA_CONTENT_COLLATE_DEFAULT = 0, /**< default collation BINARY */
95 MEDIA_CONTENT_COLLATE_NOCASE = 1, /**< collation NOCASE, not case sensitive */
96 MEDIA_CONTENT_COLLATE_RTRIM = 2, /**< collation RTRIM, trailing space characters are ignored */
97 } media_content_collation_e;
100 * @ingroup CAPI_MEDIA_CONTENT_MODULE
101 * @brief The enumerations of media content error
105 MEDIA_CONTENT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
106 MEDIA_CONTENT_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
107 MEDIA_CONTENT_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
108 MEDIA_CONTENT_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid Operation */
109 MEDIA_CONTENT_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on device */
110 MEDIA_CONTENT_ERROR_DB_FAILED = TIZEN_ERROR_CONTENT_CLASS | 0x01, /**< DB operation failed */
111 MEDIA_CONTENT_ERROR_DB_BUSY = TIZEN_ERROR_CONTENT_CLASS | 0x02, /**< DB operation BUSY */
112 MEDIA_CONTENT_ERROR_NETWORK = TIZEN_ERROR_CONTENT_CLASS | 0x03, /**< Network Fail */
113 MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT = TIZEN_ERROR_CONTENT_CLASS | 0x04, /**< Unsupported Content */
114 } media_content_error_e;
117 * @ingroup CAPI_MEDIA_CONTENT_MODULE
118 * @brief The enumerations of media group
121 MEDIA_CONTENT_GROUP_DISPLAY_NAME = 0,
122 MEDIA_CONTENT_GROUP_TYPE,
123 MEDIA_CONTENT_GROUP_MIME_TYPE,
124 MEDIA_CONTENT_GROUP_SIZE,
125 MEDIA_CONTENT_GROUP_ADDED_TIME,
126 MEDIA_CONTENT_GROUP_MODIFIED_TIME,
127 MEDIA_CONTENT_GROUP_TITLE,
128 MEDIA_CONTENT_GROUP_ARTIST,
129 MEDIA_CONTENT_GROUP_GENRE,
130 MEDIA_CONTENT_GROUP_COMPOSER,
131 MEDIA_CONTENT_GROUP_YEAR,
132 MEDIA_CONTENT_GROUP_RECORDED_DATE,
133 MEDIA_CONTENT_GROUP_COPYRIGHT,
134 MEDIA_CONTENT_GROUP_TRACK_NUM,
135 MEDIA_CONTENT_GROUP_DESCRIPTION,
136 MEDIA_CONTENT_GROUP_LONGITUDE,
137 MEDIA_CONTENT_GROUP_LATITUDE,
138 MEDIA_CONTENT_GROUP_ALTITUDE,
139 MEDIA_CONTENT_GROUP_RATING,
140 MEDIA_CONTENT_GROUP_AUTHOR,
141 MEDIA_CONTENT_GROUP_PROVIDER,
142 MEDIA_CONTENT_GROUP_CONTENT_NAME,
143 MEDIA_CONTENT_GROUP_CATEGORY,
144 MEDIA_CONTENT_GROUP_LOCATION_TAG,
145 MEDIA_CONTENT_GROUP_AGE_RATING,
146 MEDIA_CONTENT_GROUP_KEYWORD
150 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
151 * @brief The handle to media info.
153 typedef struct media_info_s *media_info_h;
156 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
157 * @brief The handle to media folder.
159 typedef struct media_folder_s *media_folder_h;
162 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
163 * @brief The handle to media playlist.
165 typedef struct media_playlist_s *media_playlist_h;
168 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
169 * @brief The handle to media tag.
171 typedef struct media_tag_s *media_tag_h;
174 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
175 * @brief The handle to media bookmark.
177 typedef struct media_bookmark_s *media_bookmark_h;
180 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
181 * @brief The handle to media album.
183 typedef struct media_album_s *media_album_h;
186 typedef struct media_artist_s *media_artist_h;
187 typedef struct media_genre_s *media_genre_h;
188 typedef struct media_composer_s *media_composer_h;
189 typedef struct media_year_s *media_year_h;
192 * @ingroup CAPI_CONTENT_MEDIA_IMAGE_MODULE
193 * @brief The handle to image metadata.
195 typedef struct image_meta_s *image_meta_h;
198 * @ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
199 * @brief The handle to video metadata.
201 typedef struct video_meta_s *video_meta_h;
204 * @ingroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE
205 * @brief The handle to audio metadata.
207 typedef struct audio_meta_s *audio_meta_h;
210 * @ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
211 * @brief The handle to media filter.
213 typedef struct filter_s *filter_h;
216 * @ingroup CAPI_MEDIA_CONTENT_MODULE
217 * @brief Called when the media scanning is finished.
219 * @param[in] error The error code
220 * @param[in] user_data The user data passed from the foreach function
221 * @pre media_content_scan()
222 * @see media_content_scan()
225 typedef void (*media_scan_completed_cb)(media_content_error_e error, void * user_data);
229 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
230 * @brief Iterates over a list of media info.
232 * @details This callback is called for every available media info.\n
234 * @remarks To use the @a media outside this function, copy the handle with #media_info_clone() function.
236 * @param[in] media The handle to media info
237 * @param[in] user_data The user data passed from the foreach function
238 * @return true to continue with the next iteration of the loop,
239 * @return false to break out of the loop.
240 * @pre media_tag_foreach_media_from_db(), media_playlist_foreach_media_from_db(), media_genre_foreach_media_from_db(),
241 * media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
242 * @see media_info_clone()
243 * @see media_album_foreach_media_from_db()
244 * @see media_playlist_foreach_media_from_db()
245 * @see media_tag_foreach_media_from_db()
246 * @see media_info_foreach_media_from_db()
247 * @see media_folder_foreach_media_from_db()
249 typedef bool (*media_info_cb)(media_info_h media, void *user_data);
252 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
253 * @brief Called when batch of media items is being inserted to media database.
255 * @param[in] error The error code
256 * @param[in] current The current count which is inserted
257 * @param[in] total The total count which will be inserted
258 * @pre media_info_insert_batch_to_db()
259 * @see media_info_insert_batch_to_db()
262 typedef void (*media_insert_progress_cb)(media_content_error_e error, unsigned int current, unsigned int total, void *user_data);
265 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
266 * @brief Called when media items is inserted completely.
269 * @param[in] media The handle to media info
270 * @param[in] user_data The user data passed from the foreach function
271 * @pre media_info_insert_batch_to_db()
272 * @see media_info_insert_batch_to_db()
275 typedef void (*media_insert_completed_cb)(media_content_error_e error, void * user_data);
280 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
281 * @brief Creates a thumbnail image.
283 * @details This callback is called for completion of generating the thumbnail image.\n
285 * @param[in] error The Error code
286 * @param[in] path The Path of thumbnail which is generated
287 * @param[in] user_data The user data passed from the foreach function
288 * @pre media_info_create_thumbnail()
289 * @see media_info_create_thumbnail()
291 typedef void (*media_thumbnail_completed_cb)(media_content_error_e error, const char *path, void *user_data);
295 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
296 * @brief Iterates over a list of folders.
298 * @details This callback is called for every available media folder.\n
300 * @remarks To use the @a folder outside this function, copy the handle with #media_folder_clone() function.
302 * @param[in] folder The handle to media folder
303 * @param[in] user_data The user data passed from the foreach function
304 * @return true to continue with the next iteration of the loop,
305 * @return false to break out of the loop.
306 * @pre media_folder_foreach_folder_from_db() will invoke this function.
307 * @see media_folder_clone()
308 * @see media_folder_foreach_folder_from_db()
310 typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
313 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
314 * @brief Iterates over playlist list.
316 * @details This callback is called for every playlist in obtained list of playlists.\n
318 * @remarks To use the @a playlist outside this function, copy the handle with #media_playlist_clone() function.
320 * @param[in] playlist The handle to media playlist
321 * @param[in] user_data The user data passed from the foreach function
322 * @return true to continue with the next iteration of the loop,
323 * @return false to break out of the loop.
324 * @pre media_playlist_foreach_playlist_from_db() will invoke this function.
325 * @see media_playlist_clone()
326 * @see media_playlist_foreach_playlist_from_db()
328 typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
331 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
332 * @brief Iterates over playlist member.
334 * @details This callback is called for every media info with playlist member ID in obtained list of media info.\n
336 * @remarks To use the @a media outside this function, copy the handle with #media_info_clone() function.
338 * @param[in] playlist_member_id The ID to member of playlist
339 * @param[in] media The handle to media info
340 * @param[in] user_data The user data passed from the foreach function
341 * @return true to continue with the next iteration of the loop,
342 * @return false to break out of the loop.
343 * @pre media_playlist_foreach_media_from_db() will invoke this function.
344 * @see media_info_clone()
345 * @see media_playlist_foreach_media_from_db()
347 typedef bool(* playlist_member_cb)(int playlist_member_id, media_info_h media, void *user_data);
350 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
351 * @brief Iterates over a list of tags
353 * @details This callback is called for every tag in the obtained list of tags.\n
355 * @remarks To use the @a tag outside this function, copy the handle with #media_tag_clone() function.
357 * @param[in] tag The handle to media tag
358 * @param[in] user_data The user data passed from the foreach function
359 * @return true to continue with the next iteration of the loop,
360 * @return false to break out of the loop.
361 * @pre media_tag_foreach_tag_from_db(), media_info_foreach_tag_from_db() will invoke this function.
362 * @see media_tag_clone()
363 * @see media_tag_foreach_tag_from_db()
364 * @see media_info_foreach_tag_from_db()
366 typedef bool (*media_tag_cb)(media_tag_h tag, void *user_data);
369 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
370 * @brief Iterates over bookmark list
372 * @details This callback is called for every bookmark in obtained list of bookmarks.\n
374 * @remarks To use the @a bookmark outside this function, copy the handle with #media_bookmark_clone() function.
376 * @param[in] bookmark The handle to video bookmark
377 * @param[in] user_data The user data passed from the foreach function
378 * @return true to continue with the next iteration of the loop,
379 * @return false to break out of the loop.
380 * @pre media_info_foreach_bookmark_from_db() will invoke this function.
381 * @see media_info_foreach_bookmark_from_db()
383 typedef bool (*media_bookmark_cb)(media_bookmark_h bookmark, void *user_data);
386 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
387 * @brief Iterates over album list
389 * @details This callback is called for every album in obtained list of groups.\n
391 * @remarks To use the @a album outside this function, copy the handle with #media_album_clone() function.
393 * @param[in] album The handle to media album
394 * @param[in] user_data The user data passed from the foreach function
395 * @return true to continue with the next iteration of the loop,
396 * @return false to break out of the loop.
397 * @pre media_album_foreach_album_from_db() will invoke this function.
398 * @see media_album_clone()
399 * @see media_album_foreach_album_from_db()
401 typedef bool (*media_album_cb)(media_album_h album, void *user_data);
403 typedef bool (*media_artist_cb)(const char *artist, void *user_data);
404 typedef bool (*media_genre_cb)(const char *genre, void *user_data);
405 typedef bool (*media_composer_cb)(const char *composer, void *user_data);
406 typedef bool (*media_year_cb)(const char *year, void *user_data);
409 * @ingroup CAPI_CONTENT_MEDIA_GROUP_MODULE
410 * @brief Iterates over media group list
412 * @details This callback is called for every group in obtained list of groups.\n
414 * @remarks You should not free group_name returned by this function.
416 * @param[in] group_name The name of media group
417 * @param[in] user_data The user data passed from the foreach function
418 * @return true to continue with the next iteration of the loop,
419 * @return false to break out of the loop.
420 * @pre media_group_foreach_group_from_db() will invoke this function.
421 * @see media_group_foreach_group_from_db()
423 typedef bool (*media_group_cb)(const char *group_name, void *user_data);
430 * @addtogroup CAPI_CONTENT_MEDIA_INFO_MODULE
434 #define MEDIA_ID "MEDIA_ID" /**< media id */
435 #define MEDIA_PATH "MEDIA_PATH" /**< media full path */
436 #define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME" /**< media base name */
437 #define MEDIA_TYPE "MEDIA_TYPE" /**< media type. 0-image, 1-video, 2-sound, 3-music, 4-other*/
438 #define MEDIA_MIME_TYPE "MEDIA_MIME_TYPE" /**< media mime type */
439 #define MEDIA_SIZE "MEDIA_SIZE" /**< media mime size */
440 #define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME" /**< media added time */
441 #define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME" /**< media modified time */
442 #define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH" /**< media thumbnail path */
443 #define MEDIA_TITLE "MEDIA_TITLE" /**< media title get from tag or file name */
444 #define MEDIA_ALBUM "MEDIA_ALBUM" /**< media album name*/
445 #define MEDIA_ARTIST "MEDIA_ARTIST" /**< media artist*/
446 #define MEDIA_GENRE "MEDIA_GENRE" /**< media genre*/
447 #define MEDIA_COMPOSER "MEDIA_COMPOSER" /**< media composer*/
448 #define MEDIA_YEAR "MEDIA_YEAR" /**< media year*/
449 #define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE" /**< media recorded date*/
450 #define MEDIA_COPYRIGHT "MEDIA_COPYRIGHT" /**< media copyright*/
451 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM" /**< media track number*/
452 #define MEDIA_DESCRIPTION "MEDIA_DESCRIPTION" /**< media description*/
453 #define MEDIA_BITRATE "MEDIA_BITRATE" /**< media bitrate*/
454 #define MEDIA_SAMPLERATE "MEDIA_SAMPLERATE" /**< media sample rate*/
455 #define MEDIA_CHANNEL "MEDIA_CHANNEL" /**< media channel*/
456 #define MEDIA_DURATION "MEDIA_DURATION" /**< media duration */
457 #define MEDIA_LONGITUDE "MEDIA_LONGITUDE" /**< media longitude */
458 #define MEDIA_LATITUDE "MEDIA_LATITUDE" /**< media latitude */
459 #define MEDIA_ALTITUDE "MEDIA_ALTITUDE" /**< media altitude */
460 #define MEDIA_WIDTH "MEDIA_WIDTH" /**< media width*/
461 #define MEDIA_HEIGHT "MEDIA_HEIGHT" /**< media height*/
462 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN" /**< media datetaken*/
463 #define MEDIA_ORIENTATION "MEDIA_ORIENTATION" /**< media orientation*/
464 #define MEDIA_PLAYED_COUNT "MEDIA_PLAYED_COUNT" /**< media playedcount*/
465 #define MEDIA_LAST_PLAYED_TIME "MEDIA_LAST_PLAYED_TIME" /**< media last played time*/
466 #define MEDIA_LAST_PLAYED_POSITION "MEDIA_LAST_PLAYED_POSITION" /**< media last played position of file*/
467 #define MEDIA_RATING "MEDIA_RATING" /**< media rating*/
468 #define MEDIA_FAVOURITE "MEDIA_FAVORITE" /**< 0-not favourite, 1-favourite*/
469 #define MEDIA_AUTHOR "MEDIA_AUTHOR" /**< media authore*/
470 #define MEDIA_PROVIDER "MEDIA_PROVIDER" /**< media provider*/
471 #define MEDIA_CONTENT_NAME "MEDIA_CONTENT_NAME" /**< media content name*/
472 #define MEDIA_CATEGORY "MEDIA_CATEGORY" /**< media category*/
473 #define MEDIA_LOCATION_TAG "MEDIA_LOCATION_TAG" /**< media location tag*/
474 #define MEDIA_AGE_RATING "MEDIA_AGE_RATING" /**< media age rating*/
475 #define MEDIA_KEYWORD "MEDIA_KEYWORD" /**< media keyword*/
476 #define MEDIA_IS_DRM "MEDIA_IS_DRM" /**< is drm. 0-not drm, 1-drm*/
477 #define MEDIA_STORAGE_TYPE "MEDIA_STORAGE_TYPE" /**< media storage. 0-internal storage, 1-external storage*/
485 * @addtogroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
488 #define FOLDER_ID "FOLDER_ID" /**< folder id */
489 #define FOLDER_PATH "FOLDER_PATH" /**< folder full path */
490 #define FOLDER_NAME "FOLDER_NAME" /**< folder base name */
491 #define FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME" /**< folder modified time */
492 #define FOLDER_STORAGE_TYPE "FOLDER_STORAGE_TYPE" /**< folder storage. 0-internal storage, 1-external storage*/
499 * @addtogroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
502 #define PLAYLIST_NAME "PLAYLIST_NAME" /**< playlist name */
503 #define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER" /**< playlist name */
504 #define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT" /**< media count in playlist view */
511 * @addtogroup CAPI_CONTENT_MEDIA_TAG_MODULE
514 #define TAG_NAME "TAG_NAME" /**< tag name */
515 #define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT" /**< media count in tag view */
522 * @addtogroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
525 #define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME" /**< bookmark marked time */
533 #endif /* __cplusplus */
536 #endif /*__TIZEN_MEDIA_CONTENT_TYPE_H__*/