src/include/mm_player.h

   1 /*
   2  * libmm-player
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: JongHyuk Choi <jhchoi.choi@samsung.com>, YeJin Cho <cho.yejin@samsung.com>,
   7  * Seungbae Shin <seungbae.shin@samsung.com>, YoungHwan An <younghwan_.an@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23 #ifndef __MM_PLAYER_H__
  24 #define __MM_PLAYER_H__
  25
  26
  27 /*===========================================================================================
  28 |                                                                                           |
  29 |  INCLUDE FILES                                        |
  30 |                                                                                           |
  31 ========================================================================================== */
  32
  33 #include <glib.h>
  34
  35 #include <mm_types.h>
  36 #include <mm_message.h>
  37 #include <media_packet.h>
  38
  39 #ifdef __cplusplus
  40         extern "C" {
  41 #endif
  42
  43 /*===========================================================================================
  44 |                                                                                           |
  45 |  GLOBAL DEFINITIONS AND DECLARATIONS                                        |
  46 |                                                                                           |
  47 ========================================================================================== */
  48
  49 /**
  50  * MM_PLAYER_URI:
  51  *
  52  * uri to play (string)
  53  *
  54  */
  55 #define MM_PLAYER_CONTENT_URI               "profile_uri"
  56 /**
  57  * MM_PLAYER_VIDEO_ROTATION
  58  *
  59  * can change video angle (int)
  60  * @see MMDisplayRotationType
  61  */
  62 #define MM_PLAYER_VIDEO_ROTATION            "display_rotation"
  63 /**
  64  * MM_PLAYER_VIDEO_WIDTH:
  65  *
  66  * get the video width (int), It's guaranteed after calling mm_player_start() or
  67  * receiving MM_MESSAGE_BEGIN_OF_STREAM.
  68  *
  69  */
  70 #define MM_PLAYER_VIDEO_WIDTH               "content_video_width"
  71 /**
  72  * MM_PLAYER_VIDEO_HEIGHT:
  73  *
  74  * get the video height (int), It's guaranteed after calling mm_player_start() or
  75  * receiving MM_MESSAGE_BEGIN_OF_STREAM.
  76  *
  77  */
  78 #define MM_PLAYER_VIDEO_HEIGHT              "content_video_height"
  79 /**
  80  * MM_PLAYER_VIDEO_EVAS_SURFACE_SINK:
  81  *
  82  * get the video evas surface sink plugin name (string), It's guaranteed after calling mm_player_create()
  83  *
  84  */
  85 #define MM_PLAYER_VIDEO_EVAS_SURFACE_SINK          "display_evas_surface_sink"
  86 /**
  87  * MM_PLAYER_MEM_SRC:
  88  *
  89  * set memory pointer to play (data)
  90  *
  91  */
  92 #define MM_PLAYER_MEMORY_SRC                "profile_user_param"
  93 /**
  94  * MM_PLAYER_PLAYBACK_COUNT
  95  *
  96  * can set playback count (int), Default value is 1 and -1 is for infinity playing until releasing it.
  97  *
  98  */
  99 #define MM_PLAYER_PLAYBACK_COUNT            "profile_play_count"
 100 /**
 101  * MM_PLAYER_SUBTITLE_URI
 102  *
 103  * set the subtitle path (string)
 104  */
 105 #define MM_PLAYER_SUBTITLE_URI              "subtitle_uri"
 106 /**
 107  * MM_PLAYER_STREAMING_USER_AGENT
 108  *
 109  * set the streaming user agent (string)
 110  */
 111 #define MM_PLAYER_STREAMING_USER_AGENT      "streaming_user_agent"
 112 /**
 113  * MM_PLAYER_STREAMING_COOKIE
 114  *
 115  * set the streaming cookie (int)
 116  */
 117 #define MM_PLAYER_STREAMING_COOKIE          "streaming_cookie"
 118 /**
 119  * MM_PLAYER_VIDEO_CODEC
 120  *
 121  * codec the video data is stored in (string)
 122  */
 123 #define MM_PLAYER_VIDEO_CODEC               "content_video_codec"
 124 /**
 125  * MM_PLAYER_AUDIO_CODEC
 126  *
 127  * codec the audio data is stored in (string)
 128  */
 129 #define MM_PLAYER_AUDIO_CODEC               "content_audio_codec"
 130 /**
 131  * MM_PLAYER_AUDIO_BITRATE
 132  *
 133  * set the streaming proxy port (int)
 134  */
 135 #define MM_PLAYER_AUDIO_BITRATE             "content_audio_bitrate"
 136 /**
 137  * MM_PLAYER_AUDIO_CHANNEL
 138  *
 139  * the number of audio channel (int)
 140  */
 141 #define MM_PLAYER_AUDIO_CHANNEL             "content_audio_channels"
 142 /**
 143  * MM_PLAYER_AUDIO_SAMPLERATE
 144  *
 145  * audio samplerate  (int)
 146  */
 147 #define MM_PLAYER_AUDIO_SAMPLERATE          "content_audio_samplerate"
 148 /**
 149  * MM_PLAYER_AUDIO_TRACK_NUM
 150  *
 151  * track number inside a collection (int)
 152  */
 153 #define MM_PLAYER_AUDIO_TRACK_NUM           "content_audio_track_num"
 154 /**
 155  * MM_PLAYER_TEXT_TRACK_NUM
 156  *
 157  * track number inside a collection (int)
 158  */
 159 #define MM_PLAYER_TEXT_TRACK_NUM            "content_text_track_num"
 160 /**
 161  * MM_PLAYER_TAG_ARTIST
 162  *
 163  * person(s) responsible for the recording (string)
 164  */
 165 #define MM_PLAYER_TAG_ARTIST                "tag_artist"
 166 /**
 167  * MM_PLAYER_TAG_TITLE
 168  *
 169  * title (string)
 170  */
 171 #define MM_PLAYER_TAG_TITLE                 "tag_title"
 172 /**
 173  * MM_PLAYER_TAG_ALBUM
 174  *
 175  * album containing this data (string)
 176  */
 177 #define MM_PLAYER_TAG_ALBUM                 "tag_album"
 178 /**
 179  * MM_PLAYER_TAG_GENRE
 180  *
 181  * genre this data belongs to (string)
 182  */
 183 #define MM_PLAYER_TAG_GENRE                 "tag_genre"
 184 /**
 185  * MM_PLAYER_TAG_AUTHOUR
 186  *
 187  * author (string)
 188  */
 189 #define MM_PLAYER_TAG_AUTHOUR               "tag_author"
 190 /**
 191  * MM_PLAYER_TAG_COPYRIGHT
 192  *
 193  * copyright notice of the data (string)
 194  */
 195 #define MM_PLAYER_TAG_COPYRIGHT             "tag_copyright"
 196 /**
 197  * MM_PLAYER_TAG_DATE
 198  *
 199  * date the data was created (string)
 200  */
 201 #define MM_PLAYER_TAG_DATE                  "tag_date"
 202 /**
 203  * MM_PLAYER_TAG_DESCRIPRION
 204  *
 205  * short text describing the content of the data (string)
 206  */
 207 #define MM_PLAYER_TAG_DESCRIPRION           "tag_description"
 208 /**
 209  * MM_PLAYER_TAG_TRACK_NUM
 210  *
 211  * track number inside a collection (int)
 212  */
 213 #define MM_PLAYER_TAG_TRACK_NUM             "tag_track_num"
 214 /**
 215  * MM_PLAYER_PD_MODE
 216  *
 217  * progressive download mode (int)
 218  */
 219 #define MM_PLAYER_PD_MODE                   "pd_mode"
 220
 221 /**
 222  * MM_PLAYER_DRC_MODE
 223  *
 224  * dynamic resolution change mode (int)
 225  */
 226 #define MM_PLAYER_DRC_MODE                  "drc_mode"
 227
 228 /**
 229  * MM_PLAYER_GAPLESS_MODE
 230  *
 231  * gapless playback mode (int)
 232  */
 233 #define MM_PLAYER_GAPLESS_MODE              "gapless_mode"
 234
 235 /**
 236  * MM_PLAYER_ENABLE_VIDEO_DECODED_CB
 237  *
 238  * enable video decoded callback (int)
 239  */
 240 #define MM_PLAYER_ENABLE_VIDEO_DECODED_CB   "enable_video_decoded_cb"
 241
 242 /**
 243  * MM_PLAYER_VIDEO_CODEC_TYPE
 244  *
 245  * video codec type (int)
 246  */
 247 #define MM_PLAYER_VIDEO_CODEC_TYPE          "video_codec_type"
 248
 249 /**
 250  * MM_PLAYER_AUDIO_CODEC_TYPE
 251  *
 252  * audio codec type (int)
 253  */
 254 #define MM_PLAYER_AUDIO_CODEC_TYPE          "audio_codec_type"
 255
 256 #define BUFFER_MAX_PLANE_NUM (4)
 257
 258 typedef struct {
 259         MMPixelFormatType format;              /**< image format */
 260         int width;                             /**< width of video buffer */
 261         int height;                            /**< height of video buffer */
 262         unsigned int timestamp;                /**< timestamp of stream buffer (msec)*/
 263         unsigned int length_total;             /**< total length of stream buffer (in byte)*/
 264         void *data[BUFFER_MAX_PLANE_NUM];
 265         void *bo[BUFFER_MAX_PLANE_NUM];        /**< TBM buffer object */
 266         void *internal_buffer;                 /**< Internal buffer pointer */
 267         int stride[BUFFER_MAX_PLANE_NUM];      /**< stride of plane */
 268         int elevation[BUFFER_MAX_PLANE_NUM];   /**< elevation of plane */
 269         int orientation;                       /**< orientation */
 270 } MMPlayerVideoStreamDataType;
 271
 272 /**
 273  * Enumerations of player state.
 274  */
 275 typedef enum {
 276         MM_PLAYER_STATE_NULL,                           /**< Player is created, but not realized yet */
 277         MM_PLAYER_STATE_READY,                          /**< Player is ready to play media */
 278         MM_PLAYER_STATE_PLAYING,                        /**< Player is now playing media */
 279         MM_PLAYER_STATE_PAUSED,                         /**< Player is paused while playing media */
 280         MM_PLAYER_STATE_NONE,                           /**< Player is not created yet */
 281         MM_PLAYER_STATE_NUM,                            /**< Number of player states */
 282 } MMPlayerStateType;
 283
 284 /**
 285  * Enumerations of position formats.
 286  * Used while invoking mm_player_get_position/mm_player_set_position APIs
 287  */
 288 typedef enum {
 289         MM_PLAYER_POS_FORMAT_TIME,                      /**< Format for time based */
 290         MM_PLAYER_POS_FORMAT_PERCENT,                   /**< Format for percentage */
 291         MM_PLAYER_POS_FORMAT_NUM,                       /**< Number of position formats */
 292 } MMPlayerPosFormatType;
 293
 294 /**
 295  * Enumeration for attribute values types.
 296  */
 297 typedef enum {
 298         MM_PLAYER_ATTRS_TYPE_INVALID = -1,        /**< Type is invalid */
 299         MM_PLAYER_ATTRS_TYPE_INT,                 /**< Integer type */
 300         MM_PLAYER_ATTRS_TYPE_DOUBLE,              /**< Double type */
 301         MM_PLAYER_ATTRS_TYPE_STRING,              /**< UTF-8 String type */
 302         MM_PLAYER_ATTRS_TYPE_DATA,                /**< Pointer type */
 303         MM_PLAYER_ATTRS_TYPE_ARRAY,               /**< Array type */
 304         MM_PLAYER_ATTRS_TYPE_RANGE,               /**< Range type */
 305         MM_PLAYER_ATTRS_TYPE_NUM,                 /**< Number of attribute type */
 306 } MMPlayerAttrsType;
 307
 308 /**
 309  * Enumeration for attribute validation type.
 310  */
 311 typedef enum {
 312         MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1,                /**< Invalid validation type */
 313         MM_PLAYER_ATTRS_VALID_TYPE_NONE,                                /**< Do not check validity */
 314         MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY,          /**< validity checking type of integer array */
 315         MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE,          /**< validity checking type of integer range */
 316         MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY,                /**< validity checking type of double array */
 317         MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE,       /**< validity checking type of double range */
 318 } MMPlayerAttrsValidType;
 319
 320 /**
 321  * Enumeration for attribute access flag.
 322  */
 323 typedef enum {
 324         MM_PLAYER_ATTRS_FLAG_NONE = 0,                                  /**< None flag is set */
 325         MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0,                 /**< Readable */
 326         MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1,                 /**< Writable */
 327         MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2,                 /**< Modified */
 328
 329         MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
 330 } MMPlayerAttrsFlag;
 331
 332 /**
 333  * Enumeration for progressive download
 334  */
 335 typedef enum {
 336         MM_PLAYER_PD_MODE_NONE,
 337         MM_PLAYER_PD_MODE_URI,
 338         MM_PLAYER_PD_MODE_FILE  // not tested yet, because of no fixed scenario
 339 } MMPlayerPDMode;
 340
 341 /**
 342  * Enumeration of track types
 343  */
 344 typedef enum {
 345         MM_PLAYER_TRACK_TYPE_AUDIO = 0,
 346         MM_PLAYER_TRACK_TYPE_VIDEO,
 347         MM_PLAYER_TRACK_TYPE_TEXT,
 348         MM_PLAYER_TRACK_TYPE_MAX
 349 } MMPlayerTrackType;
 350
 351 /**
 352  * Enumeration of runtime buffering mode
 353  */
 354 typedef enum {
 355         MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0,  /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
 356         MM_PLAYER_BUFFERING_MODE_FIXED,                 /**< player will set buffer size with this fixed size value. */
 357         MM_PLAYER_BUFFERING_MODE_MAX,
 358 } MMPlayerBufferingMode;
 359
 360 /**
 361  * Edge Properties of the text.
 362  */
 363 typedef enum {
 364         MM_PLAYER_EDGE_NO,
 365         MM_PLAYER_EDGE_RAISED,
 366         MM_PLAYER_EDGE_DEPRESSED,
 367         MM_PLAYER_EDGE_UNIFORM,
 368         MM_PLAYER_EDGE_DROPSHADOW
 369 } MMPlayerSubtitleEdge;
 370
 371 /**
 372  * Enumeration of media stream buffer status
 373  */
 374 typedef enum {
 375         MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
 376         MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
 377 } MMPlayerMediaStreamBufferStatus;
 378
 379 /**
 380  * Enumeration for stream type.
 381  */
 382 typedef enum {
 383         MM_PLAYER_STREAM_TYPE_DEFAULT,  /**< Container type */
 384         MM_PLAYER_STREAM_TYPE_AUDIO,    /**< Audio element stream type */
 385         MM_PLAYER_STREAM_TYPE_VIDEO,    /**< Video element stream type */
 386         MM_PLAYER_STREAM_TYPE_TEXT,     /**< Text type */
 387         MM_PLAYER_STREAM_TYPE_MAX,
 388 } MMPlayerStreamType;
 389
 390 typedef enum {
 391         MM_PLAYER_CODEC_TYPE_DEFAULT = 0, /**< codec is selected by the priority */
 392         MM_PLAYER_CODEC_TYPE_HW,          /**< HW codec can only be selected */
 393         MM_PLAYER_CODEC_TYPE_SW,          /**< SW codec can only be selected */
 394 } MMPlayerVideoCodecType;
 395
 396 /**
 397  * Attribute validity structure
 398  */
 399 typedef struct {
 400          MMPlayerAttrsType type;
 401          MMPlayerAttrsValidType validity_type;
 402          MMPlayerAttrsFlag flag;
 403         /**
 404           * a union that describes validity of the attribute.
 405           * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
 406           * the attribute can have validity.
 407          */
 408          union {
 409                 /**
 410                    * Validity structure for integer array.
 411                  */
 412                 struct {
 413                         int *array;  /**< a pointer of array */
 414                         int count;   /**< size of array */
 415                         int d_val;
 416                 } int_array;
 417                 /**
 418                    * Validity structure for integer range.
 419                  */
 420                 struct {
 421                         int min;   /**< minimum range */
 422                         int max;   /**< maximum range */
 423                         int d_val;
 424                 } int_range;
 425                 /**
 426                 * Validity structure for double array.
 427                 */
 428                 struct {
 429                         double   * array;  /**< a pointer of array */
 430                         int    count;   /**< size of array */
 431                         double d_val;
 432                 } double_array;
 433                 /**
 434                 * Validity structure for double range.
 435                 */
 436                 struct {
 437                         double   min;   /**< minimum range */
 438                         double   max;   /**< maximum range */
 439                         double d_val;
 440                 } double_range;
 441         };
 442 } MMPlayerAttrsInfo;
 443
 444 /**
 445  * Volume type.
 446  *
 447  * @see         mm_player_set_volume, mm_player_get_volume
 448  */
 449 typedef struct {
 450         float   level[MM_VOLUME_CHANNEL_NUM];   /**< Relative volume factor for each channels */
 451 } MMPlayerVolumeType;
 452
 453 /**
 454  * Video stream info in external demux case
 455  *
 456 **/
 457 typedef struct _VideoStreamInfo {
 458         const char *mime;
 459         unsigned int framerate_num;
 460         unsigned int framerate_den;
 461         unsigned int width;
 462         unsigned int height;
 463         unsigned char *codec_extradata;
 464         unsigned int extradata_size;
 465         unsigned int version;
 466 } MMPlayerVideoStreamInfo;
 467
 468 /**
 469  * Audio stream info in external demux case
 470  *
 471 **/
 472 typedef struct _AudioStreamInfo {
 473         const char *mime;
 474         unsigned int channels;
 475         unsigned int sample_rate;
 476         unsigned char *codec_extradata;
 477         unsigned int extradata_size;
 478         unsigned int version;
 479         unsigned int user_info;
 480
 481         /* for pcm */
 482 //      unsigned int width;
 483 //      unsigned int depth;
 484 //      unsigned int endianness;
 485 //      bool signedness;
 486 } MMPlayerAudioStreamInfo;
 487
 488 /**
 489  * Subtitle stream info in external demux case
 490  *
 491 **/
 492 typedef struct _SubtitleStreamInfo {
 493         const char *mime;
 494         unsigned int codec_tag;
 495         void *context;  //for smpte text
 496 } MMPlayerSubtitleStreamInfo;
 497
 498 /**
 499  * Audio stream callback function type.
 500  *
 501  * @param       stream          [in]    Reference pointer to audio frame data
 502  * @param       stream_size     [in]    Size of audio frame data
 503  * @param       user_param      [in]    User defined parameter which is passed when set
 504  *                                                              audio stream callback
 505  *
 506  * @return      This callback function have to return MM_ERROR_NONE.
 507  */
 508 typedef bool    (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
 509
 510
 511 /**
 512  * selected subtitle track number callback function type.
 513  *
 514  * @param       track_num       [in]    Track number of subtitle
 515  * @param       user_param      [in]    User defined parameter
 516  *
 517  *
 518  * @return      This callback function have to return MM_ERROR_NONE.
 519  */
 520 typedef bool            (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
 521
 522 /**
 523  * Buffer underrun / overflow data callback function type.
 524  *
 525  * @param       status     [in] buffer status
 526  * @param       user_param [in] User defined parameter which is passed when set
 527  *                          to enough data callback or need data callback
 528  *
 529  * @return      This callback function have to return MM_ERROR_NONE.
 530  */
 531 typedef bool    (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, unsigned long long bytes, void *user_param);
 532
 533 /**
 534  * Buffer seek data callback function type.
 535  *
 536  * @param       offset     [in] offset for the buffer playback
 537  * @param       user_param [in] User defined parameter which is passed when set
 538  *                          to seek data callback
 539  *
 540  * @return      This callback function have to return MM_ERROR_NONE.
 541  */
 542 typedef bool    (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
 543
 544 /**
 545  * Called to notify the stream changed.
 546  *
 547  * @param user_data [in] The user data passed from the callback registration function
 548  *
 549  * @return      This callback function have to return MM_ERROR_NONE.
 550  */
 551 typedef bool    (*mm_player_stream_changed_callback) (void *user_param);
 552
 553
 554 /*===========================================================================================
 555 |                                                                                           |
 556 |  GLOBAL FUNCTION PROTOTYPES                                        |
 557 |                                                                                           |
 558 ========================================================================================== */
 559
 560 /**
 561  * This function creates a player object for playing multimedia contents. \n
 562  * The attributes of player are created to get/set some values with application. \n
 563  * And, mutex, gstreamer and other resources are initialized at this time. \n
 564  * If player is created, the state will become MM_PLAYER_STATE_NULL.
 565  *
 566  * @param   player [out] Handle of player
 567  *
 568  * @return  This function returns zero on success, or negative value with error code. \n
 569  *          Please refer 'mm_error.h' to know it in detail.
 570  * @pre     None
 571  * @post    MM_PLAYER_STATE_NULL
 572  * @see     mm_player_destroy
 573  * @remark  You can create multiple handles on a context at the same time. \n
 574  *          However, player cannot guarantee proper operation because of limitation of resources, \n
 575  *          such as audio device or display device.
 576  *
 577  * @par Example
 578  * @code
 579 char *g_err_attr_name = NULL;
 580
 581 if (mm_player_create(&g_player) != MM_ERROR_NONE) {
 582         LOGE("failed to create player\n");
 583 }
 584
 585 if (mm_player_set_attribute(g_player,
 586                                                 &g_err_attr_name,
 587                                                 "profile_uri", filename, strlen(filename),
 588                                                 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
 589                                                 NULL) != MM_ERROR_NONE) {
 590         LOGE("failed to set %s attribute\n", g_err_attr_name);
 591         free(g_err_attr_name);
 592 }
 593
 594 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
 595  * @endcode
 596  */
 597 int mm_player_create(MMHandleType *player);
 598
 599 /**
 600  * This function releases player object and all resources which were created by mm_player_create(). \n
 601  * And, player handle will also be destroyed.
 602  *
 603  * @param   player [in] Handle of player
 604  *
 605  * @return  This function returns zero on success, or negative value with error code.
 606  * @pre     Player state may be MM_PLAYER_STATE_NULL. \n
 607  *          But, it can be called in any state.
 608  * @post    Because handle is released, there is no any state.
 609  * @see     mm_player_create
 610  * @remark  This method can be called with a valid player handle from any state to \n
 611  *          completely shutdown the player operation.
 612  *
 613  * @par Example
 614  * @code
 615 if (mm_player_destroy(g_player) != MM_ERROR_NONE) {
 616         LOGE("failed to destroy player\n");
 617 }
 618  * @endcode
 619  */
 620 int mm_player_destroy(MMHandleType player);
 621
 622 /**
 623  * This function parses uri and makes gstreamer pipeline by uri scheme. \n
 624  * So, uri should be set before realizing with mm_player_set_attribute(). \n
 625  *
 626  * @param   player [in] Handle of player
 627  *
 628  * @return  This function returns zero on success, or negative value with error code.
 629  *
 630  * @pre     Player state should be MM_PLAYER_STATE_NULL.
 631  * @post    player state will be MM_PLAYER_STATE_READY.
 632  * @see     mm_player_unrealize
 633  * @remark  None
 634  * @par Example
 635  * @code
 636 if (mm_player_realize(g_player) != MM_ERROR_NONE) {
 637         LOGE("failed to realize player\n");
 638 }
 639  * @endcode
 640  */
 641 int mm_player_realize(MMHandleType player);
 642
 643 /**
 644  * This function uninitializes player object. So, resources and allocated memory \n
 645  * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
 646  * other contents, player should be created again after destruction or realized with new uri.
 647  *
 648  * @param   player [in] Handle of player
 649  *
 650  * @return  This function returns zero on success, or negative value with error code.
 651  * @pre     Player state may be MM_PLAYER_STATE_READY to unrealize. \n
 652  *          But, it can be called in any state.
 653  * @post    Player state will be MM_PLAYER_STATE_NULL.
 654  * @see     mm_player_realize
 655  * @remark  This method can be called with a valid player handle from any state.
 656  *
 657  * @par Example
 658  * @code
 659 if (mm_player_unrealize(g_player) != MM_ERROR_NONE) {
 660         LOGE("failed to unrealize player\n");
 661 }
 662  * @endcode
 663  */
 664 int mm_player_unrealize(MMHandleType player);
 665
 666 /**
 667  * This function is to get current state of player. \n
 668  * Application have to check current state before doing some action.
 669  *
 670  * @param player [in]  Handle of player
 671  * @param state  [out] current state of player on success
 672  *
 673  * @return   This function returns zero on success, or negative value with error code.
 674  *
 675  * @see      MMPlayerStateType
 676  * @remark   None
 677  * @par Example
 678  * @code
 679 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE) {
 680         LOGE("failed to get state\n");
 681 }
 682  * @endcode
 683  */
 684 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
 685
 686 /**
 687  * This function is to set relative volume of player. \n
 688  * So, It controls logical volume value. \n
 689  * But, if developer want to change system volume, mm sound api should be used.
 690  *
 691  * @param       player          [in]    Handle of player
 692  * @param       volume          [in]    Volume factor of each channel
 693  *
 694  * @return      This function returns zero on success, or negative value with error code.
 695  * @see         MMPlayerVolumeType, mm_player_get_volume
 696  * @remark      The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
 697  * @par Example
 698  * @code
 699 MMPlayerVolumeType volume;
 700 int i = 0;
 701
 702 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
 703         volume.level[i] = MM_VOLUME_LEVEL_MAX;
 704
 705 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
 706 {
 707     LOGE("failed to set volume\n");
 708 }
 709  * @endcode
 710  */
 711 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
 712
 713 /**
 714  * This function is to get current volume factor of player.
 715  *
 716  * @param       player          [in]    Handle of player.
 717  * @param       volume          [out]   Volume factor of each channel.
 718  *
 719  * @return      This function returns zero on success, or negative value with error code.
 720  *
 721  * @see         MMPlayerVolumeType, mm_player_set_volume
 722  * @remark  None
 723  * @par Example
 724  * @code
 725 MMPlayerVolumeType volume;
 726 int i;
 727
 728 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
 729 {
 730         LOGW("failed to get volume\n");
 731 }
 732
 733 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
 734         LOGD("channel[%d] = %d \n", i, volume.level[i]);
 735  * @endcode
 736  */
 737 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
 738
 739 /**
 740  * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
 741  * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
 742  * by mm_player_set_message_callback().
 743  *
 744  * @param       player          [in]    Handle of player
 745  *
 746  * @return      This function returns zero on success, or negative value with error code.
 747  * @remark
 748  *
 749  * @pre         Player state may be MM_PLAYER_STATE_READY.
 750  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
 751  * @see         mm_player_stop
 752  * @remark  None
 753  * @par Example
 754  * @code
 755 if (mm_player_start(g_player) != MM_ERROR_NONE)
 756 {
 757         LOGE("failed to start player\n");
 758 }
 759  * @endcode
 760  */
 761 int mm_player_start(MMHandleType player);
 762
 763 /**
 764  * This function is to stop playing media contents and it's different with pause. \n
 765  * If mm_player_start() is called after this, content will be started again from the beginning. \n
 766  * So, it can be used to close current playback.
 767  *
 768  * @param       player          [in]    Handle of player
 769  *
 770  * @return      This function returns zero on success, or negative value with error code.
 771  *
 772  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
 773  * @post                Player state will be MM_PLAYER_STATE_READY.
 774  * @see         mm_player_start
 775  * @remark  None
 776  * @par Example
 777  * @code
 778 if (mm_player_stop(g_player) != MM_ERROR_NONE)
 779 {
 780         LOGE("failed to stop player\n");
 781 }
 782  * @endcode
 783  */
 784 int mm_player_stop(MMHandleType player);
 785
 786 /**
 787  * This function is to pause playing media contents.
 788  *
 789  * @param       player          [in]    Handle of player.
 790  *
 791  * @return      This function returns zero on success, or negative value with error code.
 792  *
 793  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
 794  * @post                Player state will be MM_PLAYER_STATE_PAUSED.
 795  * @see         mm_player_resume
 796  * @remark  None
 797  * @par Example
 798  * @code
 799 if (mm_player_pause(g_player) != MM_ERROR_NONE)
 800 {
 801         LOGE("failed to pause player\n");
 802 }
 803  * @endcode
 804  */
 805 int mm_player_pause(MMHandleType player);
 806
 807 /**
 808  * This function is to resume paused media contents.
 809  *
 810  * @param       player          [in]    Handle of player.
 811  *
 812  * @return      This function returns zero on success, or negative value with error code.
 813  *
 814  * @pre         Player state may be MM_PLAYER_STATE_PAUSED.
 815  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
 816  * @see         mm_player_pause
 817  * @remark  None
 818  * @par Example
 819  * @code
 820 if (mm_player_resume(g_player) != MM_ERROR_NONE)
 821 {
 822         LOGE("failed to resume player\n");
 823 }
 824  * @endcode
 825  */
 826 int mm_player_resume(MMHandleType player);
 827
 828 /**
 829  * This function is to set the position for playback. \n
 830  * So, it can be seeked to requested position. \n
 831  *
 832  * @param       player          [in]    Handle of player
 833  * @param       format          [in]    Format of position.
 834  * @param       pos                     [in]    Position for playback
 835  *
 836  * @return      This function returns zero on success, or negative value with error code.
 837  * @see         MMPlayerPosFormatType, mm_player_get_position
 838  * @remark  the unit of time-based format is millisecond and other case is percent.
 839  */
 840 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int64_t pos);
 841
 842 /**
 843  * This function is to get current position of playback content.
 844  *
 845  * @param       player          [in]    Handle of player.
 846  * @param       format          [in]    Format of position.
 847  * @param    pos        [out] contains current position on success or zero in case of failure.
 848  *
 849  * @return      This function returns zero on success, or negative value with errors
 850  * @see         MMPlayerPosFormatType, mm_player_set_position
 851  * @remark  the unit of time-based format is millisecond and other case is percent.
 852  */
 853 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, int64_t *pos);
 854
 855 /**
 856  * This function is to get the content time duration.
 857  */
 858 int mm_player_get_duration(MMHandleType player, int64_t *dur);
 859
 860 /**
 861  * This function is to get current buffer position of playback content.
 862  *
 863  * @param   player      [in]    Handle of player.
 864  * @param   format      [in]    Format of position.
 865  * @param   start_pos   [out] contains buffer start  position on success or zero in case of failure.
 866  * @param   stop_pos    [out] contains buffer current  position on success or zero in case of failure.
 867  *
 868  * @return      This function returns zero on success, or negative value with errors
 869  * @see         MMPlayerPosFormatType, mm_player_set_position
 870  * @remark  the unit of time-based format is millisecond and other case is percent.
 871  * @par Example
 872  * @code
 873 int start_pos = 0, stop_pos = 0;
 874
 875 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
 876
 877 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
 878  * @endcode
 879  */
 880 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
 881
 882 /**
 883  * This function sets callback function for receiving messages from player.
 884  * So, player can notify warning, error and normal cases to application.
 885  *
 886  * @param       player          [in]    Handle of player.
 887  * @param       callback        [in]    Message callback function.
 888  * @param       user_param      [in]    User parameter which is passed to callback function.
 889  *
 890  * @return      This function returns zero on success, or negative value with error code.
 891  * @see         MMMessageCallback
 892  * @remark  None
 893  * @par Example
 894  * @code
 895 int msg_callback(int message, MMMessageParamType *param, void *user_param)
 896 {
 897         switch (message)
 898         {
 899                 case MM_MESSAGE_ERROR:
 900                         //do something
 901                         break;
 902
 903                 case MM_MESSAGE_END_OF_STREAM:
 904                         //do something
 905                         break;
 906
 907                 case MM_MESSAGE_STATE_CHANGED:
 908                         //do something
 909                         break;
 910
 911                 case MM_MESSAGE_BEGIN_OF_STREAM:
 912                         //do something
 913                         break;
 914
 915                 default:
 916                         break;
 917         }
 918         return TRUE;
 919 }
 920
 921 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
 922  * @endcode
 923  */
 924 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
 925
 926 /**
 927  * This function set callback function for receiving audio stream from player. \n
 928  * So, application can get raw audio data and modify it. \n
 929  * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
 930  * It's only supported when audio stream is included in file. \n
 931  * So, if there is video stream or DRM content, it can't be used.
 932  *
 933  * @param   player     [in] Handle of player.
 934  * @param   callback   [in] Audio stream callback function.
 935  * @param   user_param [in] User parameter.
 936  *
 937  * @return  This function returns zero on success, or negative value with error
 938  *          code.
 939  * @see     mm_player_audio_stream_callback
 940  * @remark  It can be used for audio playback only.
 941  * @par Example
 942  * @code
 943 bool audio_callback(void *stream, int stream_size, void *user_param)
 944 {
 945         LOGD("audio stream callback\n");
 946         return TRUE;
 947 }
 948 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
 949  * @endcode
 950  */
 951 int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
 952
 953 /**
 954  * This function is to mute volume of player
 955  *
 956  * @param       player  [in]    Handle of player
 957  * @param       mute    [in]    Mute(1) or not mute(0)
 958  *
 959  * @return      This function returns zero on success, or negative value with error code
 960  * @see         mm_player_get_mute
 961  * @remark  None
 962  * @par Example
 963  * @code
 964 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
 965 {
 966         LOGW("failed to set mute\n");
 967 }
 968  * @endcode
 969  */
 970 int mm_player_set_mute(MMHandleType player, int mute);
 971
 972 /**
 973  * This function is to get mute value of player
 974  *
 975  * @param       player  [in]    Handle of player
 976  * @param       mute    [out]   Sound is muted
 977  *
 978  * @return      This function returns zero on success, or negative value with error code
 979  * @see         mm_player_set_mute
 980  * @remark  None
 981  * @par Example
 982  * @code
 983 int mute;
 984
 985 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
 986 {
 987         LOGW("failed to get mute\n");
 988 }
 989
 990 LOGD("mute status:%d\n", mute);
 991  * @endcode
 992  */
 993 int mm_player_get_mute(MMHandleType player, int *mute);
 994
 995 /**
 996  * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
 997  * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
 998  *
 999  * @param       player  [in]    Handle of player
1000  * @param       pos             [in]    postion to be adjusted
1001  *
1002  * @return      This function returns zero on success, or negative value with error
1003  *                      code
1004  * @see         mm_player_adjust_subtitle_position
1005  * @remark  None
1006  * @par Example
1007  * @code
1008 int pos;
1009
1010 pos = 5000;
1011 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1012 {
1013         LOGW("failed to adjust subtitle postion.\n");
1014 }
1015  * @endcode
1016  */
1017
1018 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1019
1020 /**
1021  * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1022  * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1023  * Player FW parses subtitle file and send text data including timestamp to application \n
1024  * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1025  * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1026  * So, it's not supported for embedded case.
1027  *
1028  * @param       player  [in]    Handle of player
1029  * @param       silent  [in]    silent(integer value except 0) or not silent(0)
1030  *
1031  * @return      This function returns zero on success, or negative value with error
1032  *                      code
1033  * @see         mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1034  * @remark  None
1035  * @par Example
1036  * @code
1037 mm_player_set_attribute(g_player,
1038                                         &g_err_name,
1039                                         "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1040                                         NULL
1041                                         );
1042
1043 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1044 {
1045         LOGW("failed to set subtitle silent\n");
1046 }
1047  * @endcode
1048  */
1049 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1050
1051 /**
1052  * This function is to get silent status of subtitle.
1053  *
1054  * @param       player  [in]    Handle of player
1055  * @param       silent  [out]   subtitle silent property
1056  *
1057  * @return      This function returns zero on success, or negative value with error
1058  *                      code
1059  * @see         mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1060  * @remark  None
1061  * @par Example
1062  * @code
1063 int silent = FALSE;
1064
1065 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1066 {
1067         LOGW("failed to set subtitle silent\n");
1068 }
1069  * @endcode
1070  */
1071 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1072
1073 /**
1074  * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1075  * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1076  *
1077  * @param   player                 [in]   Handle of player.
1078  * @param   err_attr_name          [out]  Name of attribute which is failed to set
1079  * @param   first_attribute_name   [in]   Name of the first attribute to set
1080  * @param   ...                    [in]   Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1081  *                                        But, in the case of data or string type, it should be name/value/size.
1082  *
1083  * @return  This function returns zero on success, or negative value with error code.
1084  *
1085  * @see     mm_player_get_attribute
1086  * @remark  This function must be terminated by NULL argument.
1087  *          And, if this function is failed, err_attr_name param must be free.
1088  * @par Example
1089  * @code
1090 char *g_err_attr_name = NULL;
1091
1092 if (mm_player_set_attribute(g_player,
1093                                                 &g_err_attr_name,
1094                                                 "profile_uri", filename, strlen(filename),
1095                                                 "profile_play_count", count,
1096                                                 NULL) != MM_ERROR_NONE) {
1097         LOGW("failed to set %s attribute\n", g_err_attr_name);
1098         free(g_err_attr_name);
1099 }
1100
1101  * @endcode
1102  */
1103 int mm_player_set_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1104
1105 /**
1106  * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1107  *
1108  * @param   player                [in]  Handle of player.
1109  * @param   err_attr_name         [out] Name of attribute which is failed to get
1110  * @param   first_attribute_name  [in]  Name of the first attribute to get
1111  * @param   ...                   [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1112  *                                      But, in the case of data or string type, it should be name/value/size.
1113  *
1114  * @return  This function returns zero on success, or negative value with error
1115  *          code.
1116  * @see     mm_player_set_attribute
1117  * @remark  This function must be terminated by NULL argument.
1118  *          And, if this function is failed, err_attr_name param must be free.
1119  */
1120 int mm_player_get_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1121
1122 /**
1123  * This function is to get detail information of attribute.
1124  *
1125  * @param   player          [in]  Handle of player.
1126  * @param   attribute_name  [in]  Name of the attribute to get
1127  * @param   info            [out] Attribute infomation
1128  *
1129  * @return  This function returns zero on success, or negative value with error
1130  *          code.
1131  *
1132  * @see     mm_player_set_attribute, mm_player_get_attribute
1133  * @remark  None
1134  * @par Example
1135  * @code
1136 if (mm_player_get_attribute_info(g_player, "display_method", &method_info) != MM_ERROR_NONE) {
1137         LOGW("failed to get info\n");
1138 }
1139
1140 LOGD("type:%d \n", method_info.type); //int, double..
1141 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1142 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1143
1144 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE) {
1145         LOGD("range min:%d\n", method_info.int_range.min);
1146         LOGD("range max:%d\n", method_info.int_range.max);
1147 }
1148  * @endcode
1149  */
1150 int mm_player_get_attribute_info(MMHandleType player,  const char *attribute_name, MMPlayerAttrsInfo *info);
1151
1152 /**
1153  * This function is to get download position and total size of progressive download
1154  *
1155  * @param   player      [in] Handle of player.
1156  * @param   current_pos [in] Download position currently (bytes)
1157  * @param   total_size  [in] Total size of file (bytes)
1158  *
1159  * @return  This function returns zero on success, or negative value with error code.
1160  * @par Example
1161  * @code
1162 guint64 current_pos = 0LLU;
1163 guint64 total_size = 0LLU;
1164
1165 if (mm_player_get_pd_status(g_player, &current_pos, &total_size, NULL) != MM_ERROR_NONE)
1166 {
1167         LOGD("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1168 }
1169  * @endcode
1170  */
1171 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1172
1173 /**
1174  * This function sets callback function for receiving messages of PD downloader.
1175  *
1176  * @param   player     [in] Handle of player.
1177  * @param   callback   [in] Message callback function.
1178  * @param   user_param [in] User parameter which is passed to callback function.
1179  *
1180  * @return  This function returns zero on success, or negative value with error code.
1181  * @see
1182  * @remark  None
1183  * @par Example
1184  * @code
1185 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1186 {
1187         switch (message)
1188         {
1189                 case MM_MESSAGE_PD_DOWNLOADER_START:
1190                         LOGD("Progressive download is started...\n");
1191                         break;
1192                 case MM_MESSAGE_PD_DOWNLOADER_END:
1193                         LOGD("Progressive download is ended...\n");
1194                         break;
1195                 default:
1196                         break;
1197         }
1198         return TRUE;
1199 }
1200
1201 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1202  * @endcode
1203  */
1204 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1205
1206 /**
1207  * This function is to get the track count
1208  *
1209  * @param   player [in]  handle of player.
1210  * @param   track  [in]  type of the track type
1211  * @param   info   [out] the count of the track
1212  *
1213  * @return  This function returns zero on success, or negative value with error
1214  *          code.
1215  *
1216  * @par Example
1217  * @code
1218 gint audio_count = 0;
1219
1220 if (mm_player_get_track_count(g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE) {
1221         LOGW("failed to get audio track count\n");
1222 }
1223
1224 LOGD("audio track count : %d \n", audio_count);
1225  * @endcode
1226  */
1227 int mm_player_get_track_count(MMHandleType player,  MMPlayerTrackType type, int *count);
1228
1229 /**
1230  * This function is to select the track
1231  *
1232  * @param   player [in] handle of player.
1233  * @param   type   [in] type of the track type
1234  * @param   index  [in] the index of the track
1235  *
1236  * @return  This function returns zero on success, or negative value with error
1237  *          code.
1238  */
1239 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1240 #ifdef _MULTI_TRACK
1241 /**
1242  * This function is to add the track when user want multi subtitle
1243  *
1244  * @param   player              [in]    handle of player.
1245  * @param   index               [in]    the index of the track
1246  *
1247  * @return  This function returns zero on success, or negative value with error
1248  *          code.
1249  */
1250 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1251
1252 /**
1253  * This function is to remove the track when user want multi subtitle
1254  *
1255  * @param   player  [in] handle of player.
1256  * @param   index   [in] the index of the track
1257  *
1258  * @return  This function returns zero on success, or negative value with error
1259  *          code.
1260  */
1261 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1262
1263 /**
1264  * This function is to notify which sutitle track is in use
1265  *
1266  * @param   player    [in] handle of player.
1267  * @param   callback  [in] callback function to register
1268  * @param   user_data [in] user data to be passed to the callback function
1269  *
1270  * @return  This function returns zero on success, or negative value with error
1271  *          code.
1272  */
1273 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1274 #endif
1275 /**
1276  * This function is to get the track language
1277  *
1278  * @param   player [in]  handle of player.
1279  * @param   type   [in]  type of the track type
1280  * @param   index  [in]  the index of the track
1281  * @param   code   [out] language code in ISO 639-1(string)
1282  *
1283  * @return  This function returns zero on success, or negative value with error
1284  *          code.
1285  */
1286 int mm_player_get_track_language_code(MMHandleType player,  MMPlayerTrackType type, int index, char **code);
1287
1288 /**
1289  * This function is to get the current running track
1290  *
1291  * @param       player          [in]    handle of player.
1292  * @param       type                    [in]    type of the track type
1293  * @param       index           [out]    the index of the track
1294  *
1295  * @return      This function returns zero on success, or negative value with error
1296  *                      code.
1297  */
1298
1299 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1300
1301 /**
1302  * This function is to set the subtitle path
1303  *
1304  * @param       player  [in]    handle of player
1305  * @param       path    [in]    subtitle path
1306  *
1307  * @return      This function returns zero on success, or negative value with error code.
1308  */
1309 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1310
1311 /**
1312  * This function is to set the clock which is from master player
1313  *
1314  * @param       player  [in]    handle of player
1315  * @param       clock   [in]    clock of master player
1316  * @param       clock_delta [in]        clock difference between master and slave
1317  * @param       video_time      [in]    current playing position
1318  * @param       media_clock     [in]    media clock information
1319  * @param       audio_time      [in]    audio timestamp information
1320  * @return      This function returns zero on success, or negative value with error code.
1321  */
1322 int mm_player_set_video_share_master_clock(MMHandleType player, int64_t clock, int64_t clock_delta, int64_t video_time, int64_t media_clock, int64_t audio_time);
1323 /**
1324  * This function is to get the master clock
1325  *
1326  * @param       player          [in]    handle of player
1327  * @param       video_time      [out]   current playing position
1328  * @param       media_clock     [out]   media clock information
1329  * @param       audio_time      [out]   audio timestamp information
1330  * @return      This function returns zero on success, or negative value with error code.
1331  */
1332 int mm_player_get_video_share_master_clock(MMHandleType player, int64_t *video_time, int64_t *media_clock, int64_t *audio_time);
1333
1334 /**
1335  * This function is to set download mode of video hub
1336  *
1337  * @param       player          [in]    handle of player
1338  * @param       mode            [in]    download mode
1339  * @return      This function returns zero on success, or negative value with error code.
1340  */
1341 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
1342
1343 /**
1344  * This function is to set using sync handler.
1345  *
1346  * @param       player          [in]    handle of player
1347  * @param       enable          [in]    enable/disable
1348  * @return      This function returns zero on success, or negative value with error code.
1349  */
1350 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
1351
1352 /**
1353  * This function is to set uri.
1354  *
1355  * @param   player [in] handle of player
1356  * @param   uri    [in] uri
1357  * @return  This function returns zero on success, or negative value with error code.
1358  */
1359 int mm_player_set_uri(MMHandleType player, const char *uri);
1360
1361 /**
1362  * This function is to set next uri.
1363  *
1364  * @param   player [in] handle of player
1365  * @param   uri    [in] uri
1366  * @return  This function returns zero on success, or negative value with error code.
1367  */
1368 int mm_player_set_next_uri(MMHandleType player, const char *uri);
1369
1370 /**
1371  * This function is to get next uri.
1372  *
1373  * @param   player   [in]  handle of player
1374  * @param   uri      [out] uri
1375  * @return  This function returns zero on success, or negative value with error code.
1376  */
1377 int mm_player_get_next_uri(MMHandleType player, char **uri);
1378
1379 /**
1380  * This function is to decrease reference count of internal buffer.
1381  *
1382  * @param    buffer [in] video callback internal buffer
1383  * @return   None;
1384  */
1385 void mm_player_video_stream_internal_buffer_unref(void *buffer);
1386
1387 /**mm_player_submit_packet
1388  * This function is to submit buffer to appsrc.  \n
1389  * @param   player                      [in]    Handle of player.
1390  * @param   buf             [in]    buffer to be submit in appsrc in external feeder case.
1391  * @param   len                         [in]    length of buffer.
1392  * @param   pts                         [in]    timestamp of buffer.
1393  * @param   streamtype          [in]    stream type of buffer.
1394  * @return  This function returns zero on success, or negative value with error code.
1395  */
1396 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
1397
1398 /**mm_player_set_video_info
1399  * This function is to set caps of src pad of video appsrc in external feeder case.  \n
1400  * @param   player         [in] Handle of player.
1401  * @param   media_format_h [in] Video stream info.
1402  * @return  This function returns zero on success, or negative value with error code.
1403  */
1404 int mm_player_set_video_info(MMHandleType player, media_format_h format);
1405
1406 /**mm_player_set_audio_info
1407  * This function is to set caps of src pad of Audio appsrc in external feeder case.  \n
1408  * @param       player                       [in]    Handle of player.
1409  * @param       media_format_h               [in]    Audio stream info.
1410  * @return      This function returns zero on success, or negative value with error code.
1411  */
1412 int mm_player_set_audio_info(MMHandleType player, media_format_h format);
1413
1414 /**mm_player_set_subtitle_info
1415  * This function is to set caps of src pad of subtitle appsrc in external feeder case.  \n
1416  * @param       player                          [in]    Handle of player.
1417  * @param       subtitle_stream_info               [in]    Subtitle stream info.
1418  * @return      This function returns zero on success, or negative value with error code.
1419  */
1420 int mm_player_set_subtitle_info(MMHandleType player, MMPlayerSubtitleStreamInfo *info);
1421
1422 /**
1423  * This function set callback function for receiving need or enough data message from player.
1424  *
1425  * @param   player     [in] Handle of player.
1426  * @param   type       [in] stream type
1427  * @param   callback   [in] data callback function for stream type.
1428  * @param   user_param [in] User parameter.
1429  *
1430  * @return  This function returns zero on success, or negative value with error
1431  *          code.
1432  */
1433 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
1434
1435 /**
1436  * This function set callback function for receiving seek data message from player.
1437  *
1438  * @param       player          [in]    Handle of player.
1439  * @param       type            [in]    stream type
1440  * @param       callback        [in]    Seek data callback function for stream type.
1441  * @param       user_param      [in]    User parameter.
1442  *
1443  * @return      This function returns zero on success, or negative value with error
1444  *                      code.
1445  */
1446 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
1447
1448 /**
1449  * This function is to set max size of buffer(appsrc).
1450  *
1451  * @param       player          [in]    Handle of player.
1452  * @param       type            [in]    stream type
1453  * @param       max_size        [in]    max bytes of buffer.
1454  *
1455  * @return      This function returns zero on success, or negative value with error
1456  *                      code.
1457  */
1458 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
1459
1460 /**
1461  * This function is to get max size of buffer(appsrc).
1462  *
1463  * @param       player          [in]    Handle of player.
1464  * @param       type            [in]    stream type
1465  * @param       max_size        [out]   max bytes of buffer.
1466  *
1467  * @return      This function returns zero on success, or negative value with error
1468  *                      code.
1469  */
1470 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
1471
1472 /**
1473  * This function is to set min percent of buffer(appsrc).
1474  *
1475  * @param       player          [in]    Handle of player.
1476  * @param       type            [in]    stream type
1477  * @param       min_percent     [in]    min percent of buffer.
1478  *
1479  * @return      This function returns zero on success, or negative value with error
1480  *                      code.
1481  */
1482 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
1483
1484 /**
1485  * This function is to get min percent of buffer(appsrc).
1486  *
1487  * @param       player          [in]    Handle of player.
1488  * @param       type            [in]    stream type
1489  * @param       min_percent     [out]   min percent of buffer.
1490  *
1491  * @return      This function returns zero on success, or negative value with error
1492  *                      code.
1493  */
1494 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
1495
1496 /**
1497  * This function set callback function for changing audio stream from player. \n
1498  * It's only supported when audio stream is included in file. \n
1499  *
1500  * @param       player   [in] Handle of player.
1501  * @param       callback [in] Audio stream changed callback function.
1502  * @param       user_param [in] User parameter.
1503  *
1504  * @return      This function returns zero on success, or negative value with error
1505  *                      code.
1506  * @see         mm_player_stream_changed_callback
1507  * @since
1508  */
1509 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1510
1511 /**
1512  * This function set callback function for changing video stream from player. \n
1513  * It's only supported when video stream is included in file. \n
1514  *
1515  * @param       player   [in] Handle of player.
1516  * @param       callback [in] Video stream changed callback function.
1517  * @param       user_param [in] User parameter.
1518  *
1519  * @return      This function returns zero on success, or negative value with error
1520  *                      code.
1521  * @see         mm_player_stream_changed_callback
1522  */
1523 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1524
1525 /**
1526  * This function is to get timeout value according to the content type for muse. \n
1527  * It's only supported when video stream is included in file. \n
1528  *
1529  * @param       player  [in] Handle of player.
1530  * @param       timeout [out] timeout value (sec).
1531  *
1532  * @return      This function returns zero on success, or negative value with error
1533  *                      code.
1534  * @since 3.0
1535  */
1536 int mm_player_get_timeout(MMHandleType player, int *timeout);
1537
1538 /**
1539  * This function is to get the number of video output buffers. \n
1540  * It's only supported when video stream is included in file. \n
1541  *
1542  * @param       player  [in] Handle of player.
1543  * @param       num     [out] num of buffers.
1544  * @param       extra_num [out] extra num of buffers.
1545  *
1546  * @return      This function returns zero on success, or negative value with error
1547  *                      code.
1548  * @since 3.0
1549  */
1550 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
1551
1552 /**
1553  * This function is to set the dynamic resolution information. \n
1554  * It's only supported when video stream is included in file. \n
1555  *
1556  * @param       player  [in] Handle of player.
1557  * @param       drc     [in] dynamic resolution info of media stream data
1558  *
1559  * @return      This function returns zero on success, or negative value with error
1560  *                      code.
1561  * @since 3.0
1562  */
1563 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
1564
1565 /**
1566  * This function is to release the video stream bo to reuse. \n
1567  * It's only supported when sw codec is used to decode video stream. \n
1568  *
1569  * @param       player  [in] Handle of player.
1570  * @param       bo     [in] bo address to be released
1571  *
1572  * @return      This function returns zero on success, or negative value with error
1573  *                      code.
1574  * @since 3.0
1575  */
1576 int mm_player_release_video_stream_bo(MMHandleType player, void* bo);
1577
1578 /**
1579  * This function is to set http file buffering path
1580  *
1581  * @param       player          [in]    handle of player
1582  * @param       file_path       [in]    file path
1583  * @return      This function returns zero on success, or negative value with error code.
1584  */
1585 int mm_player_set_file_buffering_path(MMHandleType player, const char *file_path);
1586
1587 /**
1588  * This function is to set sound stream info
1589  */
1590 int mm_player_set_sound_stream_info(MMHandleType player, char *stream_type, int stream_index);
1591
1592 /**
1593  * This function is to manage the playback according to the external storage state
1594  */
1595 int mm_player_manage_external_storage_state(MMHandleType player, int id, int state);
1596
1597 /**
1598  * These functions are to set/get the max variant of HAS
1599  */
1600 int mm_player_get_adaptive_variant_info(MMHandleType player, int *num, char **var_info);
1601 int mm_player_set_max_adaptive_variant_limit(MMHandleType player, int bandwidth, int width, int height);
1602 int mm_player_get_max_adaptive_variant_limit(MMHandleType player, int *bandwidth, int *width, int *height);
1603
1604 /**
1605  * These functions are to set/get the audio only mode
1606  */
1607 int mm_player_set_audio_only(MMHandleType player, bool audio_only);
1608 int mm_player_get_audio_only(MMHandleType player, bool *audio_only);
1609
1610 /**
1611  * These functions are to set/get the streaming bufferint time
1612  */
1613 int mm_player_set_streaming_buffering_time(MMHandleType player, int buffer_ms, int rebuffer_ms);
1614 int mm_player_get_streaming_buffering_time(MMHandleType player, int *buffer_ms, int *rebuffer_ms);
1615
1616 /**
1617  * These functions are to display the 360 video content
1618  */
1619 int mm_player_360_is_content_spherical(MMHandleType player, bool *is_spherical);
1620 int mm_player_360_set_enabled(MMHandleType player, bool enabled);
1621 int mm_player_360_is_enabled(MMHandleType player, bool *enabled);
1622
1623 int mm_player_360_set_direction_of_view(MMHandleType player, float yaw, float pitch);
1624 int mm_player_360_get_direction_of_view(MMHandleType player, float *yaw, float *pitch);
1625
1626 int mm_player_360_set_zoom(MMHandleType player, float level);
1627 int mm_player_360_get_zoom(MMHandleType player, float *level);
1628
1629 int mm_player_360_set_field_of_view(MMHandleType player, int horizontal_degrees, int vertical_degrees);
1630 int mm_player_360_get_field_of_view(MMHandleType player, int *horizontal_degrees, int *vertical_degrees);
1631
1632 /**
1633  * This function is to set codec type
1634  */
1635 int mm_player_set_codec_type(MMHandleType player, MMPlayerStreamType stream_type, MMPlayerVideoCodecType codec_type);
1636
1637 /**
1638  * These functions are to apply the replaygain
1639  */
1640 int mm_player_set_replaygain_enabled(MMHandleType player, bool enabled);
1641 int mm_player_is_replaygain_enabled(MMHandleType player, bool *enabled);
1642 /**
1643         @}
1644  */
1645
1646 #ifdef __cplusplus
1647         }
1648 #endif
1649
1650 #endif  /* __MM_PLAYER_H__ */