include/media_content_internal.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
  19 #ifndef __TIZEN_MEDIA_CONTENT_INTERNAL_H__
  20 #define __TIZEN_MEDIA_CONTENT_INTERNAL_H__
  21
  22 #include <media_content_type.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif /* __cplusplus */
  27
  28 /**
  29  * @internal
  30  * @file media_content_internal.h
  31  * @brief This file contains API on main functional operations with storage that are related to media resources in the media database. \n
  32  *        Operations include: inserting a new storage in media to the media database, removing storage from database, \n
  33  */
  34
  35 /**
  36  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  37  * @brief Enumeration for a media storage scan status.
  38  * @since_tizen 2.4
  39  */
  40 typedef enum{
  41         MEDIA_STORAGE_SCAN_NONE = 0,                            /**< Media Scanner not detect storage yet*/
  42         MEDIA_STORAGE_SCAN_PREPARE,                             /**< Media Scanner detect storage but not scanning yet*/
  43         MEDIA_STORAGE_SCAN_PROCESSING,                  /**< Media Scanner Start Scanning storage*/
  44         MEDIA_STORAGE_SCAN_STOP,                                        /**< Media Scanner Stop Scanning storage. Not scanning items can be exist*/
  45         MEDIA_STORAGE_SCAN_DONE,                                        /**< Scanning Done but need to extract metadata*/
  46         MEDIA_STORAGE_SCAN_META_PROCESSING,             /**< Scanning Done and start to extract metadata*/
  47         MEDIA_STORAGE_SCAN_META_STOP,                   /**< Stop extract metadata*/
  48         MEDIA_STORAGE_SCAN_COMPLETE     ,                       /**< Complete scanning*/
  49 }media_storage_scan_status_e;
  50
  51 /**
  52 * @internal
  53 * @brief Insert media storage to database.
  54 * @since_tizen 2.4
  55 *
  56 * @remarks You must release @a storage using media_storage_destroy().
  57 *
  58 * @privlevel platform
  59 * @privilege %http://tizen.org/privilege/content.write
  60 *
  61 * @param[in] storage_name The storage name to insert to database
  62 * @param[in] storage_path The storage path to insert to database
  63 * @param[in] storage_account The storage account to insert to database
  64 * @param[in] storage_type The storage type to insert to database
  65 * @param[out] storage The media storage handle
  66 *
  67 * @return @c 0 on success,
  68 *           otherwise a negative error value
  69 *
  70 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  71 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  72 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
  73 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  74 *
  75 * @see media_storage_delete_from_db()
  76 */
  77 int media_storage_insert_to_db(const char *storage_name, const char *storage_path, const char *storage_account, media_content_storage_e storage_type, media_storage_h *storage);
  78
  79 /**
  80 * @internal
  81 * @brief Deletes the database for media storage.
  82 * @since_tizen 2.4
  83 *
  84 * @privlevel platform
  85 * @privilege %http://tizen.org/privilege/content.write
  86 *
  87 * @param[in] storage_id The storage ID to delete from database
  88 *
  89 * @return @c 0 on success,
  90 *           otherwise a negative error value
  91 *
  92 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  93 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  94 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
  95 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  96 *
  97 * @see media_storage_insert_to_db()
  98 */
  99 int media_storage_delete_from_db(const char *storage_id);
 100
 101 /**
 102  * @brief Gets the storage account of media storage.
 103  * @since_tizen 2.4
 104  *
 105  * @remarks You must release @a storage_account using free().
 106  *
 107  * @param[in]  storage The media storage handle
 108  * @param[out] storage_account  The storage account of the media storage
 109  *
 110  * @return @c 0 on success,
 111  *         otherwise a negative error value
 112  *
 113  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 114  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 115  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 116  */
 117 int media_storage_get_storage_account(media_storage_h storage, char **storage_account);
 118
 119 /**
 120 * @internal
 121 * @brief Creates the media info handle.
 122 * @since_tizen 2.4
 123 *
 124 * @remarks You must release @a media using media_info_destroy().
 125 *
 126 * @param[out] media The media info handle
 127 *
 128 * @return @c 0 on success,
 129 *           otherwise a negative error value
 130 *
 131 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 132 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 133 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 134 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 135 *
 136 * @see media_info_destroy()
 137 */
 138 int media_info_create_handle(media_info_h *media);
 139 int media_info_create(const char *path, media_info_h *media);
 140
 141 /**
 142 * @internal
 143 * @brief Inserts media info to database with media info data.
 144 * @since_tizen 2.4
 145 *
 146 * @remarks You must release @a info using media_info_destroy().
 147 *
 148 * @privlevel platform
 149 * @privilege %http://tizen.org/privilege/content.write
 150 *
 151 * @param[in] media The media info handle
 152 * @param[out] info The media info handle to get data from database
 153 *
 154 * @return @c 0 on success,
 155 *           otherwise a negative error value
 156 *
 157 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 158 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 159 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 160 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 161 */
 162 int media_info_insert_to_db_with_data(media_info_h media, media_info_h *info);
 163
 164 /**
 165 * @internal
 166 * @brief Sets the path of media info handle.
 167 * @since_tizen 2.4
 168 *
 169 * @param[in] media The media info handle
 170 * @param[in] path The path of the media info
 171 *
 172 * @return @c 0 on success,
 173 *           otherwise a negative error value
 174 *
 175 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 176 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 177 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 178 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 179 *
 180 * @post media_info_insert_to_db_with_data()
 181 */
 182 int media_info_set_path(media_info_h media, const char *path);
 183
 184 /**
 185 * @internal
 186 * @brief Sets the MIME type of media info handle.
 187 * @since_tizen 2.4
 188 *
 189 * @param[in] media The media info handle
 190 * @param[in] mime_type The MIME type of the media info
 191 *
 192 * @return @c 0 on success,
 193 *           otherwise a negative error value
 194 *
 195 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 196 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 197 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 198 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 199 *
 200 * @post media_info_insert_to_db_with_data()
 201 */
 202 int media_info_set_mime_type(media_info_h media, const char *mime_type);
 203
 204 /**
 205 * @internal
 206 * @brief Sets the title of media info handle.
 207 * @since_tizen 2.4
 208 *
 209 * @param[in] media The media info handle
 210 * @param[in] title The title of media info handle
 211 *
 212 * @return @c 0 on success,
 213 *           otherwise a negative error value
 214 *
 215 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 216 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 217 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 218 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 219 *
 220 * @post media_info_insert_to_db_with_data()
 221 */
 222 int media_info_set_title(media_info_h media, const char *title);
 223
 224 /**
 225 * @internal
 226 * @brief Sets the album of media info handle.
 227 * @since_tizen 2.4
 228 *
 229 * @param[in] media The media info handle
 230 * @param[in] album The album of media info handle
 231 *
 232 * @return @c 0 on success,
 233 *           otherwise a negative error value
 234 *
 235 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 236 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 237 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 238 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 239 *
 240 * @post media_info_insert_to_db_with_data()
 241 */
 242 int media_info_set_album(media_info_h media, const char *album);
 243
 244 /**
 245 * @internal
 246 * @brief Sets the artist of media info handle.
 247 * @since_tizen 2.4
 248 *
 249 * @param[in] media The media info handle
 250 * @param[in] artist The artist of media info handle
 251 *
 252 * @return @c 0 on success,
 253 *           otherwise a negative error value
 254 *
 255 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 256 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 257 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 258 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 259 *
 260 * @post media_info_insert_to_db_with_data()
 261 */
 262 int media_info_set_artist(media_info_h media, const char *artist);
 263
 264 /**
 265 * @internal
 266 * @brief Sets the genre of media info handle.
 267 * @since_tizen 2.4
 268 *
 269 * @param[in] media The media info handle
 270 * @param[in] genre The genre of media info handle
 271 *
 272 * @return @c 0 on success,
 273 *           otherwise a negative error value
 274 *
 275 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 276 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 277 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 278 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 279 *
 280 * @post media_info_insert_to_db_with_data()
 281 */
 282 int media_info_set_genre(media_info_h media, const char *genre);
 283
 284 /**
 285 * @internal
 286 * @brief Sets the recorded date of media info handle.
 287 * @since_tizen 2.4
 288 *
 289 * @param[in] media The media info handle
 290 * @param[in] recorded_date The recorded date of media info handle
 291 *
 292 * @return @c 0 on success,
 293 *           otherwise a negative error value
 294 *
 295 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 296 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 297 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 298 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 299 *
 300 * @post media_info_insert_to_db_with_data()
 301 */
 302 int media_info_set_recorded_date(media_info_h media, const char *recorded_date);
 303
 304 /**
 305 * @internal
 306 * @brief Sets the thumbnail path of media info handle.
 307 * @since_tizen 2.4
 308 *
 309 * @param[in] media The media info handle
 310 * @param[in] thumbnail_path The thumbnail path of media info handle
 311 *
 312 * @return @c 0 on success,
 313 *           otherwise a negative error value
 314 *
 315 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 316 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 317 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 318 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 319 *
 320 * @post media_info_insert_to_db_with_data()
 321 */
 322 int media_info_set_thumbnail_path(media_info_h media, const char *thumbnail_path);
 323
 324 /**
 325 * @internal
 326 * @brief Sets the size of media info handle.
 327 * @since_tizen 2.4
 328 *
 329 * @param[in] media The media info handle
 330 * @param[in] size The size of media info handle
 331 *
 332 * @return @c 0 on success,
 333 *           otherwise a negative error value
 334 *
 335 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 336 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 337 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 338 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 339 *
 340 * @post media_info_insert_to_db_with_data()
 341 */
 342 int media_info_set_size(media_info_h media, unsigned long long size);
 343
 344 /**
 345 * @internal
 346 * @brief Sets the modified time of media info handle.
 347 * @since_tizen 2.4
 348 *
 349 * @param[in] media The media info handle
 350 * @param[in] modified_time The modified time of media info handle
 351 *
 352 * @return @c 0 on success,
 353 *           otherwise a negative error value
 354 *
 355 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 356 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 357 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 358 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 359 *
 360 * @post media_info_insert_to_db_with_data()
 361 */
 362 int media_info_set_modified_time(media_info_h media, time_t modified_time);
 363
 364 /**
 365 * @internal
 366 * @brief Sets the media type of media info handle.
 367 * @since_tizen 2.4
 368 *
 369 * @param[in] media The media info handle
 370 * @param[in] type The media type of media info handle
 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_DB_FAILED                 DB operation failed
 378 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 379 *
 380 * @post media_info_insert_to_db_with_data()
 381 */
 382 int media_info_set_media_type(media_info_h media, media_content_type_e type);
 383
 384 /**
 385 * @internal
 386 * @brief Sets the duration of media info handle.
 387 * @since_tizen 2.4
 388 *
 389 * @param[in] media The media info handle
 390 * @param[in] duration The duration of media info handle
 391 *
 392 * @return @c 0 on success,
 393 *           otherwise a negative error value
 394 *
 395 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 396 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 397 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 398 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 399 *
 400 * @post media_info_insert_to_db_with_data()
 401 */
 402 int media_info_set_duration(media_info_h media, int duration);
 403
 404 /**
 405 * @internal
 406 * @brief Sets the width of media info handle.
 407 * @since_tizen 2.4
 408 *
 409 * @param[in] media The media info handle
 410 * @param[in] width The width of media info handle
 411 *
 412 * @return @c 0 on success,
 413 *           otherwise a negative error value
 414 *
 415 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 416 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 417 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 418 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 419 *
 420 * @post media_info_insert_to_db_with_data()
 421 */
 422 int media_info_set_width(media_info_h media, int width);
 423
 424 /**
 425 * @internal
 426 * @brief Sets the height of media info handle.
 427 * @since_tizen 2.4
 428 *
 429 * @param[in] media The media info handle
 430 * @param[in] height The height of media info handle
 431 *
 432 * @return @c 0 on success,
 433 *           otherwise a negative error value
 434 *
 435 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 436 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 437 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 438 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 439 *
 440 * @post media_info_insert_to_db_with_data()
 441 */
 442 int media_info_set_height(media_info_h media, int height);
 443
 444 /**
 445 * @internal
 446 * @brief Sets the storage type of media info handle.
 447 * @since_tizen 2.4
 448 *
 449 * @param[in] media The media info handle
 450 * @param[in] storage_type The storage type of media info handle
 451 *
 452 * @return @c 0 on success,
 453 *           otherwise a negative error value
 454 *
 455 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 456 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 457 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 458 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 459 *
 460 * @post media_info_insert_to_db_with_data()
 461 */
 462 int media_info_set_storage_type(media_info_h media, media_content_storage_e storage_type);
 463
 464 /**
 465 * @internal
 466 * @brief Sets the storage type of media info handle.
 467 * @since_tizen 2.4
 468 *
 469 * @param[in] media The media info handle
 470 * @param[in] storage_id The storage id of media info handle
 471 *
 472 * @return @c 0 on success,
 473 *           otherwise a negative error value
 474 *
 475 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 476 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 477 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
 478 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 479 *
 480 * @post media_info_insert_to_db_with_data()
 481 */
 482 int media_info_set_storage_id(media_info_h media, const char *storage_id);
 483
 484 /**
 485  * @brief Gets the storage scan status of media storage.
 486  * @since_tizen 2.4
 487  *
 488  * @param[in]  storage The media storage handle
 489  * @param[out] scan_status  The storage type of the media storage
 490  *
 491  * @return @c 0 on success,
 492  *         otherwise a negative error value
 493  *
 494  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 495  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 496  */
 497 int media_storage_get_scan_status(const char *storage_uuid, media_storage_scan_status_e *scan_status);
 498
 499 #ifdef __cplusplus
 500 }
 501 #endif /* __cplusplus */
 502 #endif /*__TIZEN_MEDIA_CONTENT_INTERNAL_H__*/