include_product/media_folder.h

   1 /*
   2 * Copyright (c) 2011 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
  18 #ifndef __TIZEN_MEDIA_FOLDER_H__
  19 #define __TIZEN_MEDIA_FOLDER_H__
  20
  21
  22 #include <media_content_type.h>
  23
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /**
  30  * @file media_folder.h
  31  * @brief This file contains API related to all operations with media folder in DB. \n
  32  *        These functions include getting the number of folders and media files filtered from DB,  \n
  33  *        iterating through media files and folders filtered in the given folder from DB;  \n
  34  *        cloning and destroying the media folder, getting its name, ID, absolute path and date \n
  35  *        and updating the media folder to the media database.
  36  */
  37
  38 /**
  39  * @addtogroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
  40  * @{
  41  */
  42
  43
  44 /**
  45  * @brief Gets the count of folder for the passed @a filter from the media database.
  46  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  47  *
  48  * @param[in]  filter       The handle to filter \n
  49  *                          To allow searching over different content types, you should use #filter_h.
  50  * @param[out] folder_count The count of the media folder
  51  *
  52  * @return @c 0 on success,
  53  *         otherwise a negative error value
  54  *
  55  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  56  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  57  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  58  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  59  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  60  *
  61  * @pre This function requires opened connection to content service by media_content_connect().
  62  *
  63  * @see media_content_connect()
  64  */
  65 int media_folder_get_folder_count_from_db(filter_h filter, int *folder_count);
  66
  67 /**
  68  * @brief Iterates through available media folders with optional @a filter from the media database.
  69  * @details This function gets the media folder meeting the given @a filter.
  70  *          The @a callback function will be invoked for every retrieved
  71  *          folder. If @c NULL is passed to the @a filter, no filtering is applied.
  72  *
  73  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  74  *
  75  * @remarks Do not call updating DB fuction like media_folder_update_to_db() in your callback function, your callback function is invoked as inline function.\n
  76  *                   So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
  77  *                   We do not recommend you call updating DB function in callback of foreach function.
  78  *
  79  * @param[in] filter    The handle to the media folder filter
  80  * @param[in] callback  The callback function to be invoked
  81  * @param[in] user_data The user data to be passed to the callback function
  82  *
  83  * @return @c 0 on success,
  84  *         otherwise a negative error value
  85  *
  86  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  87  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  88  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  89  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  90  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  91  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  92  *
  93  * @pre  This function requires opened connection to content service by media_content_connect().
  94  * @pre  A filter handle has to be created by calling media_filter_create().
  95  * @post This function invokes media_folder_cb().
  96  *
  97  * @see media_content_connect()
  98  * @see media_folder_cb()
  99  * @see media_filter_create()
 100  */
 101 int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callback, void *user_data);
 102
 103 /**
 104  * @brief Gets the count of media files for the passed @a filter in the given @a folder from the media database.
 105  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 106  *
 107  * @param[in] folder_id    The ID of the media folder
 108  * @param[in] filter       The filter of the media content
 109  * @param[out] media_count The count of media folder items
 110  *
 111  * @return @c 0 on success,
 112  *         otherwise a negative error value
 113  *
 114  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 115  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 116  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 117  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 118  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 119  *
 120  * @pre This function requires opened connection to content service by media_content_connect().
 121  *
 122  * @see media_content_connect()
 123  */
 124 int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter, int *media_count);
 125
 126 /**
 127  * @brief Iterates through the media files with an optional @a filter in the given @a folder from the media database.
 128  * @details This function gets all media files associated with the given folder and
 129  *          meeting desired filter option and calls registered callback function for
 130  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
 131  *
 132  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 133  *
 134  * @remarks   Do not call updating DB function like media_info_update_to_db(), media_info_refresh_metadata_to_db(), audio_meta_update_to_db(), image_meta_update_to_db() and video_meta_update_to_db()  in your callback function,
 135  *                    your callback function is invoked as inline function. \n
 136  *                    So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
 137  *                    We do not recommend you call updating DB function in callback of foreach function.
 138  *
 139  * @param[in] folder_id The ID of the media folder
 140  * @param[in] filter    The handle to the media info filter
 141  * @param[in] callback  The callback function to be invoked
 142  * @param[in] user_data The user data to be passed to the callback function
 143  *
 144  * @return @c 0 on success,
 145  *         otherwise a negative error value
 146  *
 147  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 148  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 149  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 150  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 151  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 152  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 153  *
 154  * @pre  This function requires opened connection to content service by media_content_connect().
 155  * @post This function invokes media_info_cb().
 156  *
 157  * @see #media_info_cb
 158  * @see media_content_connect()
 159  * @see media_filter_create()
 160  */
 161 int media_folder_foreach_media_from_db(const char *folder_id, filter_h filter, media_info_cb callback, void *user_data);
 162
 163 #ifdef _USE_SENIOR_MODE
 164 int media_folder_foreach_media_from_db_by_union_select(const char* folder_id, filter_h filter1, filter_h filter2, media_info_cb callback, void* user_data);
 165 #endif
 166
 167 /**
 168  * @brief Clones the media folder.
 169  * @details This function copies the media folder handle from a source to
 170  *          destination. There is no media_folder_create() function. The media_folder_h is created internally and available through
 171  *          media folder foreach function such as media_folder_foreach_folder_from_db(). To use this handle outside of these foreach functions,
 172  *          use this function.
 173  *
 174  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 175  *
 176  * @remarks The destination handle must be released with media_folder_destroy().
 177  *
 178  * @param[out] dst The destination handle to the media folder
 179  * @param[in]  src The source handle to the media folder
 180  *
 181  * @return @c 0 on success,
 182  *         otherwise a negative error value
 183  *
 184  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 185  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 186  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 187  *
 188  * @see media_folder_destroy()
 189  * @see media_folder_foreach_folder_from_db()
 190  */
 191 int media_folder_clone(media_folder_h *dst, media_folder_h src);
 192
 193 /**
 194  * @brief Destroys the media folder.
 195  * @details The function frees all resources related to the folder handle. This handle
 196  *          no longer can be used to perform any operation. A new handle has to
 197  *          be created before the next use.
 198  *
 199  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 200  *
 201  * @param[in] folder The handle to the media folder
 202  *
 203  * @return @c 0 on success,
 204  *         otherwise a negative error value
 205  *
 206  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 207  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 208  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 209  *
 210  * @pre A copy of the media folder handle created by calling media_folder_clone().
 211  *
 212  * @see media_folder_clone()
 213  */
 214 int media_folder_destroy(media_folder_h folder);
 215
 216 /**
 217  * @brief Gets the media folder ID.
 218  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 219  *
 220  * @remarks You must release @a folder_id using free().
 221  *
 222  * @param[in]  folder    The handle to the media folder
 223  * @param[out] folder_id The ID of the media folder
 224  *
 225  * @return @c 0 on success,
 226  *         otherwise a negative error value
 227  *
 228  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 229  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 230  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 231  */
 232 int media_folder_get_folder_id(media_folder_h folder, char **folder_id);
 233
 234 /**
 235  * @brief Gets the parent folder ID.
 236  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 237  *
 238  * @remarks You must release @a parent_folder_id using free().
 239  *
 240  * @param[in]  folder    The handle to the media folder
 241  * @param[out] parent_folder_id The ID of the upper media folder
 242  *
 243  * @return @c 0 on success,
 244  *         otherwise a negative error value
 245  *
 246  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 247  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 248  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 249  */
 250 int media_folder_get_parent_folder_id(media_folder_h folder, char **parent_folder_id);
 251
 252 /**
 253  * @brief Gets the absolute path to the media folder.
 254  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 255  *
 256  * @remarks You must release @a path using free().
 257  *
 258  * @param[in]  folder The handle to the media folder
 259  * @param[out] path   The path of the media folder
 260  *
 261  * @return @c 0 on success,
 262  *         otherwise a negative error value
 263  *
 264  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 265  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 266  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 267  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 268  *
 269  */
 270 int media_folder_get_path(media_folder_h folder, char **path);
 271
 272 /**
 273  * @brief Gets the media folder name.
 274  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 275  *
 276  * @remarks You must release @a folder_name using free().
 277  *
 278  * @param[in]  folder      The handle to the media folder
 279  * @param[out] folder_name The name of the media folder
 280  *
 281  * @return @c 0 on success,
 282  *         otherwise a negative error value
 283  *
 284  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 285  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 286  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 287  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 288  */
 289 int media_folder_get_name(media_folder_h folder, char **folder_name);
 290
 291 /**
 292  * @brief Gets the modified date of the folder.
 293  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 294  *
 295  * @param[in]  folder The handle to the media folder
 296  * @param[out] date   The modified date of the folder
 297  *
 298  * @return @c 0 on success,
 299  *         otherwise a negative error value
 300  *
 301  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 302  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 303  */
 304 int media_folder_get_modified_time(media_folder_h folder, time_t *date);
 305
 306 /**
 307  * @brief Gets the folder storage type.
 308  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 309  *
 310  * @param[in]  folder       The handle to the media folder
 311  * @param[out] storage_type The storage type of the media folder
 312  *
 313  * @return @c 0 on success,
 314  *         otherwise a negative error value
 315  *
 316  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 317  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 318  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 319  */
 320 int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e *storage_type);
 321
 322 /**
 323  * @brief Gets the storage id of the folder.
 324  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 325  *
 326  * @remarks You must release @a storage_id using free().
 327  *
 328  * @param[in]  folder      The handle to the media folder
 329  * @param[out] storage_id The storage id of the media folder
 330  *
 331  * @return @c 0 on success,
 332  *         otherwise a negative error value
 333  *
 334  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 335  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 336  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 337  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 338  */
 339 int media_folder_get_storage_id(media_folder_h folder, char **storage_id);
 340
 341 /**
 342  * @brief Gets the folder viewing order.
 343  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 344  *
 345  * @param[in] folder The handle to the media folder
 346  * @param[out] order   The viewing order of the media folder
 347  *
 348  * @return @c 0 on success,
 349  *         otherwise a negative error value
 350  *
 351  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 352  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 353  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 354  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 355  *
 356  * @post media_folder_update_to_db()
 357  */
 358 int media_folder_get_order(media_folder_h folder, int *order);
 359
 360 /**
 361  * @brief Gets the media folder from the media database.
 362  *
 363  * @details This function creates a new media folder handle from the media database by the given @a folder_id.
 364  *          Media folder will be created, which is filled with folder information.
 365  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 366  *
 367  * @remarks You must release @a folder using media_folder_destroy().
 368  *
 369  * @param[in]  folder_id The ID of the media folder
 370  * @param[out] folder    The media folder handle associated with the folder ID
 371  *
 372  * @return @c 0 on success,
 373  *         otherwise a negative error value
 374  *
 375  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 376  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 377  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 378  *
 379  * @pre This function requires opened connection to content service by media_content_connect().
 380  *
 381  * @see media_content_connect()
 382  * @see media_folder_destroy()
 383  *
 384  */
 385 int media_folder_get_folder_from_db(const char *folder_id, media_folder_h *folder);
 386
 387 /**
 388  * @brief Sets the folder name.
 389  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 390  *
 391  * @param[in] folder The handle to the media folder
 392  * @param[in] name   The name of the media folder
 393  *
 394  * @return @c 0 on success,
 395  *         otherwise a negative error value
 396  *
 397  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 398  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 399  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 400  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 401  *
 402  * @post media_folder_update_to_db()
 403  */
 404 int media_folder_set_name(media_folder_h folder, const char *name);
 405
 406 /**
 407  * @brief Sets the folder viewing order.
 408  * @details If you set the order value for each folder, you can sort in ascending or descending order as the set order values using the filter. \n
 409  *                 Moreover, more detailed settings are possible when used with the filter. \n
 410  *
 411  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 412  * @remarks  If you don't set the order value, the order value will be set default value. Default is 0. \n
 413  *                    If you don't use the filter, the set order value does not effect the folder viewing order.
 414  *
 415  * @param[in] folder The handle to the media folder
 416  * @param[in] order   The viewing order of the media folder
 417  *
 418  * @return @c 0 on success,
 419  *         otherwise a negative error value
 420  *
 421  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 422  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 423  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 424  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 425  *
 426  * @post media_folder_update_to_db()
 427  */
 428 int media_folder_set_order(media_folder_h folder, int order);
 429
 430 /**
 431  * @brief Updates the media folder to the media database.
 432  *
 433  * @details The function updates the given media folder in the media database. The function should be called after any change in folder attributes, to be updated to the media
 434  *          database. For example, after using media_folder_set_name() for setting the name of the folder, the media_folder_update_to_db() function should be called so as to update
 435  *          the given folder attributes in the media database.
 436  *
 437  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 438  *
 439  * @privlevel public
 440  * @privilege %http://tizen.org/privilege/content.write
 441  *
 442  * @param[in] folder The handle to the media folder
 443  *
 444  * @return @c 0 on success,
 445  *         otherwise a negative error value
 446  *
 447  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 448  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 449  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 450  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 451  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 452  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 453  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 454  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 455  *
 456  * @pre This function requires opened connection to content service by media_content_connect().
 457  * @pre If you do not set new name of folder by using media_folder_set_name(), your updating function is failed.
 458  *
 459  * @see media_content_connect()
 460  * @see media_folder_destroy()
 461  * @see media_folder_set_name()
 462  */
 463 int media_folder_update_to_db(media_folder_h folder);
 464
 465 int media_folder_get_scan_status(const char *storage_uuid, char* path, media_folder_scan_status_e *scan_status);
 466
 467
 468 /**
 469  * @}
 470  */
 471
 472 #ifdef __cplusplus
 473 }
 474 #endif /* __cplusplus */
 475
 476 #endif /* __TIZEN_MEDIA_FOLDER_H__ */