include/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 2.3
  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 2.3
  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 2.3
 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 2.3
 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 /**
 164  * @brief Clones the media folder.
 165  * @details This function copies the media folder handle from a source to
 166  *          destination. There is no media_folder_create() function. The media_folder_h is created internally and available through
 167  *          media folder foreach function such as media_folder_foreach_folder_from_db(). To use this handle outside of these foreach functions,
 168  *          use this function.
 169  *
 170  * @since_tizen 2.3
 171  *
 172  * @remarks The destination handle must be released with media_folder_destroy().
 173  *
 174  * @param[out] dst The destination handle to the media folder
 175  * @param[in]  src The source handle to the media folder
 176  *
 177  * @return @c 0 on success,
 178  *         otherwise a negative error value
 179  *
 180  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 181  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 182  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 183  *
 184  * @see media_folder_destroy()
 185  * @see media_folder_foreach_folder_from_db()
 186  */
 187 int media_folder_clone(media_folder_h *dst, media_folder_h src);
 188
 189 /**
 190  * @brief Destroys the media folder.
 191  * @details The function frees all resources related to the folder handle. This handle
 192  *          no longer can be used to perform any operation. A new handle has to
 193  *          be created before the next use.
 194  *
 195  * @since_tizen 2.3
 196  *
 197  * @param[in] folder The handle to the media folder
 198  *
 199  * @return @c 0 on success,
 200  *         otherwise a negative error value
 201  *
 202  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 203  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 204  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 205  *
 206  * @pre A copy of the media folder handle created by calling media_folder_clone().
 207  *
 208  * @see media_folder_clone()
 209  */
 210 int media_folder_destroy(media_folder_h folder);
 211
 212 /**
 213  * @brief Gets the media folder ID.
 214  * @since_tizen 2.3
 215  *
 216  * @remarks You must release @a folder_id using free().
 217  *
 218  * @param[in]  folder    The handle to the media folder
 219  * @param[out] folder_id The ID of the media folder
 220  *
 221  * @return @c 0 on success,
 222  *         otherwise a negative error value
 223  *
 224  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 225  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 226  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 227  */
 228 int media_folder_get_folder_id(media_folder_h folder, char **folder_id);
 229
 230 /**
 231  * @brief Gets the absolute path to the media folder.
 232  * @since_tizen 2.3
 233  *
 234  * @remarks You must release @a path using free().
 235  *
 236  * @param[in]  folder The handle to the media folder
 237  * @param[out] path   The path of the media folder
 238  *
 239  * @return @c 0 on success,
 240  *         otherwise a negative error value
 241  *
 242  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 243  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 244  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 245  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 246  *
 247  */
 248 int media_folder_get_path(media_folder_h folder, char **path);
 249
 250 /**
 251  * @brief Gets the media folder name.
 252  * @since_tizen 2.3
 253  *
 254  * @remarks You must release @a folder_name using free().
 255  *
 256  * @param[in]  folder      The handle to the media folder
 257  * @param[out] folder_name The name of the media folder
 258  *
 259  * @return @c 0 on success,
 260  *         otherwise a negative error value
 261  *
 262  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 263  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 264  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 265  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 266  */
 267 int media_folder_get_name(media_folder_h folder, char **folder_name);
 268
 269 /**
 270  * @brief Gets the modified date of the folder.
 271  * @since_tizen 2.3
 272  *
 273  * @param[in]  folder The handle to the media folder
 274  * @param[out] date   The modified date of the folder
 275  *
 276  * @return @c 0 on success,
 277  *         otherwise a negative error value
 278  *
 279  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 280  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 281  */
 282 int media_folder_get_modified_time(media_folder_h folder, time_t *date);
 283
 284 /**
 285  * @brief Gets the folder storage type.
 286  * @since_tizen 2.3
 287  *
 288  * @param[in]  folder       The handle to the media folder
 289  * @param[out] storage_type The storage type of the media folder
 290  *
 291  * @return @c 0 on success,
 292  *         otherwise a negative error value
 293  *
 294  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 295  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 296  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 297  */
 298 int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e *storage_type);
 299
 300 /**
 301  * @brief Gets the storage id of the folder.
 302  * @since_tizen 2.4
 303  *
 304  * @remarks You must release @a storage_id using free().
 305  *
 306  * @param[in]  folder      The handle to the media folder
 307  * @param[out] storage_id The storage id of the media folder
 308  *
 309  * @return @c 0 on success,
 310  *         otherwise a negative error value
 311  *
 312  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 313  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 314  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 315  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 316  */
 317 int media_folder_get_storage_id(media_folder_h folder, char **storage_id);
 318
 319 /**
 320  * @brief Gets the folder viewing order.
 321  * @since_tizen 2.4
 322  *
 323  * @param[in] folder The handle to the media folder
 324  * @param[out] order   The viewing order of the media folder
 325  *
 326  * @return @c 0 on success,
 327  *         otherwise a negative error value
 328  *
 329  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 330  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 331  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 332  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 333  *
 334  * @post media_folder_update_to_db()
 335  */
 336 int media_folder_get_order(media_folder_h folder, int *order);
 337
 338 /**
 339  * @brief Gets the media folder from the media database.
 340  *
 341  * @details This function creates a new media folder handle from the media database by the given @a folder_id.
 342  *          Media folder will be created, which is filled with folder information.
 343  * @since_tizen 2.3
 344  *
 345  * @remarks You must release @a folder using media_folder_destroy().
 346  *
 347  * @param[in]  folder_id The ID of the media folder
 348  * @param[out] folder    The media folder handle associated with the folder ID
 349  *
 350  * @return @c 0 on success,
 351  *         otherwise a negative error value
 352  *
 353  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 354  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 355  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 356  *
 357  * @pre This function requires opened connection to content service by media_content_connect().
 358  *
 359  * @see media_content_connect()
 360  * @see media_folder_destroy()
 361  *
 362  */
 363 int media_folder_get_folder_from_db(const char *folder_id, media_folder_h *folder);
 364
 365 /**
 366  * @brief Sets the folder name.
 367  * @since_tizen 2.3
 368  *
 369  * @param[in] folder The handle to the media folder
 370  * @param[in] name   The name of the media folder
 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_OUT_OF_MEMORY     Out of memory
 378  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 379  *
 380  * @post media_folder_update_to_db()
 381  */
 382 int media_folder_set_name(media_folder_h folder, const char *name);
 383
 384 /**
 385  * @brief Sets the folder viewing order.
 386  * @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
 387  *                 Moreover, more detailed settings are possible when used with the filter. \n
 388  *
 389  * @since_tizen 2.4
 390  * @remarks  If you don't set the order value, the order value will be set default value. Default is 0. \n
 391  *                    If you don't use the filter, the set order value does not effect the folder viewing order.
 392  *
 393  * @param[in] folder The handle to the media folder
 394  * @param[in] order   The viewing order of the media folder
 395  *
 396  * @return @c 0 on success,
 397  *         otherwise a negative error value
 398  *
 399  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 400  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 401  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 402  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 403  *
 404  * @post media_folder_update_to_db()
 405  */
 406 int media_folder_set_order(media_folder_h folder, int order);
 407
 408 /**
 409  * @brief Updates the media folder to the media database.
 410  *
 411  * @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
 412  *          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
 413  *          the given folder attributes in the media database.
 414  *
 415  * @since_tizen 2.3
 416  *
 417  * @privlevel public
 418  * @privilege %http://tizen.org/privilege/content.write
 419  *
 420  * @param[in] folder The handle to the media folder
 421  *
 422  * @return @c 0 on success,
 423  *         otherwise a negative error value
 424  *
 425  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 426  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 427  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 428  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 429  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 430  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 431  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 432  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 433  *
 434  * @pre This function requires opened connection to content service by media_content_connect().
 435  * @pre If you do not set new name of folder by using media_folder_set_name(), your updating function is failed.
 436  *
 437  * @see media_content_connect()
 438  * @see media_folder_destroy()
 439  * @see media_folder_set_name()
 440  */
 441 int media_folder_update_to_db(media_folder_h folder);
 442
 443 /**
 444  * @}
 445  */
 446
 447 #ifdef __cplusplus
 448 }
 449 #endif /* __cplusplus */
 450
 451 #endif /* __TIZEN_MEDIA_FOLDER_H__ */