include/media_storage.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_CONTENT_MEDIA_STORAGE_H__
  19 #define __TIZEN_CONTENT_MEDIA_STORAGE_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_storage.h
  31  * @brief This file contains API on main functional operations with external storage that are related to media resources in the media database. \n
  32  *        Operations include: getting number of storages, cloning and destroying storage, getting storage`s ID, name, path and type.
  33  */
  34
  35 /**
  36  * @addtogroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
  37  * @{
  38  */
  39
  40 /**
  41 * @brief Gets media storage from database.
  42 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  43 *
  44 * @remarks The @a storage should be released using media_storage_destroy().
  45 *
  46 * @param[in] storage_id The ID of the media storage
  47 * @param[out] storage The media storage handle
  48 *
  49 * @return @c 0 on success,
  50 *           otherwise a negative error value
  51 *
  52 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  53 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  54 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
  55 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED  DB Operation failed
  56 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
  57 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  58 *
  59 * @pre This function requires opened connection to content service by media_content_connect().
  60 *
  61 * @see media_content_connect()
  62 */
  63 int media_storage_get_storage_info_from_db(const char *storage_id, media_storage_h *storage);
  64
  65 /**
  66 * @brief Gets the count of media storage for the passed @a filter from the media database.
  67 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  68 *
  69 * @param[in] filter The handle to the media filter
  70 * @param[out] storage_count The count of storage
  71 *
  72 * @return @c 0 on success,
  73 *           otherwise a negative error value
  74 *
  75 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  76 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  77 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
  78 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
  79 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
  80 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  81 *
  82 * @pre This function requires opened connection to content service by media_content_connect().
  83 *
  84 * @see media_content_connect()
  85 */
  86 int media_storage_get_storage_count_from_db(filter_h filter, int *storage_count);
  87
  88 /**
  89  * @brief Iterates through media storage from the media database.
  90  * @details This function gets all media storage handles meeting the given @a filter.
  91  *          The @a callback function will be invoked for every retrieved media storage.
  92  *          If @c NULL is passed to the @a filter, then no filtering is applied.
  93  *
  94  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  95  *
  96  * @param[in] filter The handle to the media filter
  97  * @param[in] callback The callback function to be invoked
  98  * @param[in] user_data The user data to be passed to the callback function
  99  *
 100  * @return @c 0 on success,
 101  *         otherwise a negative error value
 102  *
 103  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 104  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 105  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 106  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 107  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 108  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 109  *
 110  * @pre  This function requires opened connection to content service by media_content_connect().
 111  * @post This function invokes media_storage_destroy().
 112  *
 113  * @see media_content_connect()
 114  * @see media_storage_destroy()
 115  */
 116 int media_storage_foreach_storage_from_db(filter_h filter, media_storage_cb callback, void *user_data);
 117
 118 /**
 119  * @brief Gets the count of media files for the passed @a filter in the given @a storage_id from the media database.
 120  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 121  *
 122  * @param[in] storage_id The ID of the media storage
 123  * @param[in] filter The handle to the media filter
 124  * @param[out] media_count The count of media storage items
 125  *
 126  * @return @c 0 on success,
 127  *         otherwise a negative error value
 128  *
 129  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 130  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 131  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 132  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 133  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 134  *
 135  * @pre This function requires opened connection to content service by media_content_connect().
 136  *
 137  * @see media_content_connect()
 138  */
 139 int media_storage_get_media_count_from_db(const char *storage_id, filter_h filter, int *media_count);
 140
 141 /**
 142  * @brief Iterates through the media files with an optional @a filter in the given @a storage_id from the media database.
 143  * @details This function gets all media files associated with the given storage and
 144  *          meeting desired filter option and calls @a callback for
 145  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
 146  *
 147  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 148  *
 149  * @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,
 150  *                    your callback function is invoked as inline function. \n
 151  *                    So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
 152  *                    We do not recommend you call updating DB function in callback of foreach function.
 153  *
 154  * @param[in] storage_id The ID of the media storage
 155  * @param[in] filter The handle to the media filter
 156  * @param[in] callback The callback function to be invoked
 157  * @param[in] user_data The user data to be passed to the callback function
 158  *
 159  * @return @c 0 on success,
 160  *         otherwise a negative error value
 161  *
 162  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 163  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 164  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 165  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 166  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 167  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 168  *
 169  * @pre  This function requires opened connection to content service by media_content_connect().
 170  * @post This function invokes media_info_cb().
 171  *
 172  * @see #media_info_cb
 173  * @see media_content_connect()
 174  * @see media_filter_create()
 175  */
 176 int media_storage_foreach_media_from_db(const char *storage_id, filter_h filter, media_info_cb callback, void *user_data);
 177
 178 /**
 179  * @brief Destroys media storage handle.
 180  * @details The function frees all resources related to the media storage handle. This handle
 181  *          can no longer be used to perform any operation. New media storage handle has to
 182  *          be created before the next usage.
 183  *
 184  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 185  *
 186  * @param[in] storage The media storage handle
 187  *
 188  * @return @c 0 on success,
 189  *         otherwise a negative error value
 190  *
 191  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 192  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 193  *
 194  * @pre Get copy of media_storage_h handle by calling media_storage_clone().
 195  *
 196  * @see media_storage_clone()
 197  */
 198 int media_storage_destroy(media_storage_h storage);
 199
 200 /**
 201  * @brief Clones the media storage handle.
 202  *
 203  * @details This function copies the media storage handle from a source to the destination.
 204  *          There is no media_storage_create() function. The media_storage_h is created internally and
 205  *          available through media storage foreach function such as media_storage_foreach_storage_from_db().
 206  *          To use this handle outside of these foreach functions, use this function.
 207  *
 208  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 209  *
 210  * @remarksThe @a dst should be released using media_storage_destroy().
 211  *
 212  * @param[out] dst The destination handle to the media storage
 213  * @param[in] src The source handle to the media storage
 214  *
 215  * @return @c 0 on success,
 216  *         otherwise a negative error value
 217  *
 218  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 219  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 220  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 221  *
 222  * @see media_storage_destroy()
 223  * @see media_storage_foreach_storage_from_db()
 224  * @see media_storage_get_storage_info_from_db()
 225  */
 226 int media_storage_clone(media_storage_h *dst, media_storage_h src);
 227
 228 /**
 229  * @brief Gets the storage id of media storage.
 230  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 231  *
 232  * @remarks The @a storage_id should be released using free().
 233  *
 234  * @param[in] storage The media storage handle
 235  * @param[out] storage_id The ID of the media storage
 236  *
 237  * @return @c 0 on success,
 238  *         otherwise a negative error value
 239  *
 240  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 241  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 242  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 243  */
 244 int media_storage_get_id(media_storage_h storage, char **storage_id);
 245
 246 /**
 247  * @deprecated Deprecated since 4.0.
 248  * @brief Gets the storage name of media storage.
 249  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 250  *
 251  * @remarks The @a storage_name should be released using free().
 252  *                   If the requested storage is not the cloud storage, this function returns NULL.
 253  *
 254  * @param[in] storage The media storage handle
 255  * @param[out] storage_name The storage name of the media storage
 256  *
 257  * @return @c 0 on success,
 258  *         otherwise a negative error value
 259  *
 260  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 261  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 262  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 263  */
 264 int media_storage_get_name(media_storage_h storage, char **storage_name) TIZEN_DEPRECATED_API;
 265
 266 /**
 267  * @brief Gets the storage path of media storage.
 268  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 269  *
 270  * @remarks The @a storage_path should be released using free().
 271  *
 272  * @param[in] storage The media storage handle
 273  * @param[out] storage_path The storage path of the media storage
 274  *
 275  * @return @c 0 on success,
 276  *         otherwise a negative error value
 277  *
 278  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 279  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 280  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 281  */
 282 int media_storage_get_path(media_storage_h storage, char **storage_path);
 283
 284 /**
 285  * @brief Gets the storage type of media storage.
 286  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 287  *
 288  * @param[in] storage The media storage handle
 289  * @param[out] storage_type The storage type of the media storage
 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  */
 297 int media_storage_get_type(media_storage_h storage, media_content_storage_e *storage_type);
 298
 299 /**
 300  * @}
 301  */
 302
 303 #ifdef __cplusplus
 304 }
 305 #endif /* __cplusplus */
 306
 307 #endif /* __TIZEN_CONTENT_MEDIA_STORAGE_H__ */