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_TEXT_TRACK_NUM
 150  *
 151  * track number inside a collection (int)
 152  */
 153 #define MM_PLAYER_TEXT_TRACK_NUM            "content_text_track_num"
 154 /**
 155  * MM_PLAYER_TAG_ARTIST
 156  *
 157  * person(s) responsible for the recording (string)
 158  */
 159 #define MM_PLAYER_TAG_ARTIST                "tag_artist"
 160 /**
 161  * MM_PLAYER_TAG_TITLE
 162  *
 163  * title (string)
 164  */
 165 #define MM_PLAYER_TAG_TITLE                 "tag_title"
 166 /**
 167  * MM_PLAYER_TAG_ALBUM
 168  *
 169  * album containing this data (string)
 170  */
 171 #define MM_PLAYER_TAG_ALBUM                 "tag_album"
 172 /**
 173  * MM_PLAYER_TAG_GENRE
 174  *
 175  * genre this data belongs to (string)
 176  */
 177 #define MM_PLAYER_TAG_GENRE                 "tag_genre"
 178 /**
 179  * MM_PLAYER_TAG_AUTHOUR
 180  *
 181  * author (string)
 182  */
 183 #define MM_PLAYER_TAG_AUTHOUR               "tag_author"
 184 /**
 185  * MM_PLAYER_TAG_COPYRIGHT
 186  *
 187  * copyright notice of the data (string)
 188  */
 189 #define MM_PLAYER_TAG_COPYRIGHT             "tag_copyright"
 190 /**
 191  * MM_PLAYER_TAG_DATE
 192  *
 193  * date the data was created (string)
 194  */
 195 #define MM_PLAYER_TAG_DATE                  "tag_date"
 196 /**
 197  * MM_PLAYER_TAG_DESCRIPRION
 198  *
 199  * short text describing the content of the data (string)
 200  */
 201 #define MM_PLAYER_TAG_DESCRIPRION           "tag_description"
 202 /**
 203  * MM_PLAYER_TAG_TRACK_NUM
 204  *
 205  * track number inside a collection (int)
 206  */
 207 #define MM_PLAYER_TAG_TRACK_NUM             "tag_track_num"
 208
 209 /**
 210  * MM_PLAYER_DRC_MODE
 211  *
 212  * dynamic resolution change mode (int)
 213  */
 214 #define MM_PLAYER_DRC_MODE                  "drc_mode"
 215
 216 /**
 217  * MM_PLAYER_GAPLESS_MODE
 218  *
 219  * gapless playback mode (int)
 220  */
 221 #define MM_PLAYER_GAPLESS_MODE              "gapless_mode"
 222
 223 /**
 224  * MM_PLAYER_ENABLE_VIDEO_DECODED_CB
 225  *
 226  * enable video decoded callback (int)
 227  */
 228 #define MM_PLAYER_ENABLE_VIDEO_DECODED_CB   "enable_video_decoded_cb"
 229
 230 /**
 231  * MM_PLAYER_VIDEO_CODEC_TYPE
 232  *
 233  * video codec type (int)
 234  */
 235 #define MM_PLAYER_VIDEO_CODEC_TYPE          "video_codec_type"
 236
 237 /**
 238  * MM_PLAYER_AUDIO_CODEC_TYPE
 239  *
 240  * audio codec type (int)
 241  */
 242 #define MM_PLAYER_AUDIO_CODEC_TYPE          "audio_codec_type"
 243
 244 /**
 245  * MM_PLAYER_PREBUFFER_MS
 246  *
 247  * prebuffer ms (int)
 248  */
 249 #define MM_PLAYER_PREBUFFER_MS              "prebuffer_ms"
 250
 251 /**
 252  * MM_PLAYER_REBUFFER_MS
 253  *
 254  * rebuffer ms (int)
 255  */
 256 #define MM_PLAYER_REBUFFER_MS               "rebuffer_ms"
 257 /**
 258  * MM_PLAYER_AUDIO_OFFLOAD (int)
 259  */
 260 #define MM_PLAYER_AUDIO_OFFLOAD             "audio_offload"
 261
 262 /**
 263  * MM_PLAYER_PITCH_CONTROL (int)
 264  */
 265 #define MM_PLAYER_PITCH_CONTROL             "pitch_control"
 266
 267 /**
 268  * MM_PLAYER_PITCH_VALUE (double)
 269  */
 270 #define MM_PLAYER_PITCH_VALUE               "pitch_value"
 271
 272
 273 #define BUFFER_MAX_PLANE_NUM (4)
 274
 275 typedef struct {
 276         MMPixelFormatType format;              /**< image format */
 277         int width;                             /**< width of video buffer */
 278         int height;                            /**< height of video buffer */
 279         unsigned int timestamp;                /**< timestamp of stream buffer (msec)*/
 280         unsigned int length_total;             /**< total length of stream buffer (in byte)*/
 281         void *data[BUFFER_MAX_PLANE_NUM];
 282         void *bo[BUFFER_MAX_PLANE_NUM];        /**< TBM buffer object */
 283         void *internal_buffer;                 /**< Internal buffer pointer */
 284         int stride[BUFFER_MAX_PLANE_NUM];      /**< stride of plane */
 285         int elevation[BUFFER_MAX_PLANE_NUM];   /**< elevation of plane */
 286         int orientation;                       /**< orientation */
 287         int bo_size;                           /**< TBM buffer object size */
 288         int plane_num;                         /**< number of Plane */
 289 } mmplayer_video_decoded_data_info_t;
 290
 291 /**
 292  * Enumerations of player state.
 293  */
 294 typedef enum {
 295         MM_PLAYER_STATE_NULL,                           /**< Player is created, but not realized yet */
 296         MM_PLAYER_STATE_READY,                          /**< Player is ready to play media */
 297         MM_PLAYER_STATE_PLAYING,                        /**< Player is now playing media */
 298         MM_PLAYER_STATE_PAUSED,                         /**< Player is paused while playing media */
 299         MM_PLAYER_STATE_NONE,                           /**< Player is not created yet */
 300         MM_PLAYER_STATE_NUM,                            /**< Number of player states */
 301 } mmplayer_state_e;
 302
 303 /**
 304  * Enumeration for attribute values types.
 305  */
 306 typedef enum {
 307         MM_PLAYER_ATTRS_TYPE_INVALID = -1,        /**< Type is invalid */
 308         MM_PLAYER_ATTRS_TYPE_INT,                 /**< Integer type */
 309         MM_PLAYER_ATTRS_TYPE_DOUBLE,              /**< Double type */
 310         MM_PLAYER_ATTRS_TYPE_STRING,              /**< UTF-8 String type */
 311         MM_PLAYER_ATTRS_TYPE_DATA,                /**< Pointer type */
 312         MM_PLAYER_ATTRS_TYPE_ARRAY,               /**< Array type */
 313         MM_PLAYER_ATTRS_TYPE_RANGE,               /**< Range type */
 314         MM_PLAYER_ATTRS_TYPE_NUM,                 /**< Number of attribute type */
 315 } mmplayer_attrs_type_e;
 316
 317 /**
 318  * Enumeration for attribute validation type.
 319  */
 320 typedef enum {
 321         MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1,                /**< Invalid validation type */
 322         MM_PLAYER_ATTRS_VALID_TYPE_NONE,                                /**< Do not check validity */
 323         MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY,          /**< validity checking type of integer array */
 324         MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE,          /**< validity checking type of integer range */
 325         MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY,                /**< validity checking type of double array */
 326         MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE,       /**< validity checking type of double range */
 327 } mmplayer_attrs_valid_type_e;
 328
 329 /**
 330  * Enumeration for attribute access flag.
 331  */
 332 typedef enum {
 333         MM_PLAYER_ATTRS_FLAG_NONE = 0,                                  /**< None flag is set */
 334         MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0,                 /**< Readable */
 335         MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1,                 /**< Writable */
 336         MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2,                 /**< Modified */
 337
 338         MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
 339 } mmplayer_attrs_flag_e;
 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 } mmplayer_track_type_e;
 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 } mmplayer_buffering_mode_e;
 359
 360 /**
 361  * Enumeration of media stream buffer status
 362  */
 363 typedef enum {
 364         MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
 365         MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
 366 } mmplayer_media_stream_buffer_status_e;
 367
 368 /**
 369  * Enumeration for stream type.
 370  */
 371 typedef enum {
 372         MM_PLAYER_STREAM_TYPE_DEFAULT,  /**< Container type */
 373         MM_PLAYER_STREAM_TYPE_AUDIO,    /**< Audio element stream type */
 374         MM_PLAYER_STREAM_TYPE_VIDEO,    /**< Video element stream type */
 375         MM_PLAYER_STREAM_TYPE_TEXT,     /**< Text type */
 376         MM_PLAYER_STREAM_TYPE_MAX,
 377 } mmplayer_stream_type_e;
 378
 379 typedef enum {
 380         MM_PLAYER_CODEC_TYPE_DEFAULT = 0, /**< codec is selected by the priority */
 381         MM_PLAYER_CODEC_TYPE_HW,          /**< HW codec can only be selected */
 382         MM_PLAYER_CODEC_TYPE_SW,          /**< SW codec can only be selected */
 383 } mmplayer_video_codec_type_e;
 384
 385 typedef enum {
 386         MM_PLAYER_AUDIO_EXTRACT_DEFAULT                        = 0x00,   /**< Sync with the playback clock and multichannel audio stream */
 387         MM_PLAYER_AUDIO_EXTRACT_NO_SYNC_WITH_CLOCK             = 0x01,   /**< No sync with the playback clock */
 388         MM_PLAYER_AUDIO_EXTRACT_DEINTERLEAVE                   = 0x02,   /**< Splits one interleaved multichannel audio stream into many mono audio streams */
 389         MM_PLAYER_AUDIO_EXTRACT_NO_SYNC_AND_DEINTERLEAVE       = MM_PLAYER_AUDIO_EXTRACT_NO_SYNC_WITH_CLOCK | MM_PLAYER_AUDIO_EXTRACT_DEINTERLEAVE,
 390         MM_PLAYER_AUDIO_EXTRACT_WITH_PLAYBACK                  = 0x04,   /**< With audio playback synchronously (experimental) */
 391         MM_PLAYER_AUDIO_EXTRACT_DEINTERLEAVE_WITH_PLAYBACK     = MM_PLAYER_AUDIO_EXTRACT_DEINTERLEAVE | MM_PLAYER_AUDIO_EXTRACT_WITH_PLAYBACK,
 392 } mmplayer_audio_extract_opt_e;
 393
 394 /**
 395  * Attribute validity structure
 396  */
 397 typedef struct {
 398          mmplayer_attrs_type_e type;
 399          mmplayer_attrs_valid_type_e validity_type;
 400          mmplayer_attrs_flag_e flag;
 401         /**
 402           * a union that describes validity of the attribute.
 403           * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
 404           * the attribute can have validity.
 405          */
 406          union {
 407                 /**
 408                    * Validity structure for integer array.
 409                  */
 410                 struct {
 411                         int *array;  /**< a pointer of array */
 412                         int count;   /**< size of array */
 413                         int d_val;
 414                 } int_array;
 415                 /**
 416                    * Validity structure for integer range.
 417                  */
 418                 struct {
 419                         int min;   /**< minimum range */
 420                         int max;   /**< maximum range */
 421                         int d_val;
 422                 } int_range;
 423                 /**
 424                 * Validity structure for double array.
 425                 */
 426                 struct {
 427                         double *array;  /**< a pointer of array */
 428                         int count;   /**< size of array */
 429                         double d_val;
 430                 } double_array;
 431                 /**
 432                 * Validity structure for double range.
 433                 */
 434                 struct {
 435                         double min;   /**< minimum range */
 436                         double max;   /**< maximum range */
 437                         double d_val;
 438                 } double_range;
 439         };
 440 } mmplayer_attrs_info_t;
 441
 442 /**
 443  * Volume type.
 444  *
 445  * @see         mm_player_set_volume, mm_player_get_volume
 446  */
 447 typedef struct {
 448         float level[MM_VOLUME_CHANNEL_NUM];     /**< Relative volume factor for each channels */
 449 } mmplayer_volume_type_t;
 450
 451 /**
 452  * Video stream info in external demux case
 453  *
 454 **/
 455 typedef struct {
 456         const char *mime;
 457         unsigned int framerate_num;
 458         unsigned int framerate_den;
 459         unsigned int width;
 460         unsigned int height;
 461         unsigned char *codec_extradata;
 462         unsigned int extradata_size;
 463         unsigned int version;
 464 } mmplayer_video_stream_info_t;
 465
 466 /**
 467  * Audio stream info in external demux case
 468  *
 469 **/
 470 typedef struct {
 471         const char *mime;
 472         unsigned int channels;
 473         unsigned int sample_rate;
 474         unsigned char *codec_extradata;
 475         unsigned int extradata_size;
 476         unsigned int version;
 477         unsigned int user_info;
 478
 479         /* for pcm */
 480 //      unsigned int width;
 481 //      unsigned int depth;
 482 //      unsigned int endianness;
 483 //      bool signedness;
 484 } mmplayer_audio_stream_info_t;
 485
 486 /**
 487  * Subtitle stream info in external demux case
 488  *
 489 **/
 490 typedef struct _SubtitleStreamInfo {
 491         const char *mime;
 492         unsigned int codec_tag;
 493         void *context;  //for smpte text
 494 } mmplayer_subtitle_stream_info_t;
 495
 496 /**
 497  * selected subtitle track number callback function type.
 498  *
 499  * @param       track_num       [in]    Track number of subtitle
 500  * @param       user_param      [in]    User defined parameter
 501  *
 502  *
 503  * @return      This callback function have to return MM_ERROR_NONE.
 504  */
 505 typedef bool (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
 506
 507 /**
 508  * Buffer underrun / overflow data callback function type.
 509  *
 510  * @param       status     [in] buffer status
 511  * @param       user_param [in] User defined parameter which is passed when set
 512  *                          to enough data callback or need data callback
 513  *
 514  * @return      This callback function have to return MM_ERROR_NONE.
 515  */
 516 typedef bool (*mm_player_media_stream_buffer_status_callback)(mmplayer_stream_type_e type, mmplayer_media_stream_buffer_status_e status, unsigned long long bytes, void *user_param);
 517
 518 /**
 519  * Buffer seek data callback function type.
 520  *
 521  * @param       offset     [in] offset for the buffer playback
 522  * @param       user_param [in] User defined parameter which is passed when set
 523  *                          to seek data callback
 524  *
 525  * @return      This callback function have to return MM_ERROR_NONE.
 526  */
 527 typedef bool (*mm_player_media_stream_seek_data_callback)(mmplayer_stream_type_e type, unsigned long long offset, void *user_param);
 528
 529 /**
 530  * Called to notify the stream changed.
 531  *
 532  * @param user_data [in] The user data passed from the callback registration function
 533  *
 534  * @return      This callback function have to return MM_ERROR_NONE.
 535  */
 536 typedef bool (*mm_player_stream_changed_callback)(void *user_param);
 537
 538
 539 /*===========================================================================================
 540 |                                                                                           |
 541 |  GLOBAL FUNCTION PROTOTYPES                                        |
 542 |                                                                                           |
 543 ========================================================================================== */
 544
 545 /**
 546  * This function creates a player object for playing multimedia contents. \n
 547  * The attributes of player are created to get/set some values with application. \n
 548  * And, mutex, gstreamer and other resources are initialized at this time. \n
 549  * If player is created, the state will become MM_PLAYER_STATE_NULL.
 550  *
 551  * @param   player [out] Handle of player
 552  *
 553  * @return  This function returns zero on success, or negative value with error code. \n
 554  *          Please refer 'mm_error.h' to know it in detail.
 555  * @pre     None
 556  * @post    MM_PLAYER_STATE_NULL
 557  * @see     mm_player_destroy
 558  * @remark  You can create multiple handles on a context at the same time. \n
 559  *          However, player cannot guarantee proper operation because of limitation of resources, \n
 560  *          such as audio device or display device.
 561  *
 562  * @par Example
 563  * @code
 564 char *g_err_attr_name = NULL;
 565
 566 if (mm_player_create(&g_player) != MM_ERROR_NONE) {
 567         LOGE("failed to create player\n");
 568 }
 569
 570 if (mm_player_set_attribute(g_player,
 571                                                 &g_err_attr_name,
 572                                                 "profile_uri", filename, strlen(filename),
 573                                                 "display_overlay", (void *)&g_win.xid, sizeof(g_win.xid),
 574                                                 NULL) != MM_ERROR_NONE) {
 575         LOGE("failed to set %s attribute\n", g_err_attr_name);
 576         free(g_err_attr_name);
 577 }
 578
 579 mm_player_set_message_callback(g_player, msg_callback, (void *)g_player);
 580  * @endcode
 581  */
 582 int mm_player_create(MMHandleType *player);
 583
 584 /**
 585  * This function releases player object and all resources which were created by mm_player_create(). \n
 586  * And, player handle will also be destroyed.
 587  *
 588  * @param   player [in] Handle of player
 589  *
 590  * @return  This function returns zero on success, or negative value with error code.
 591  * @pre     Player state may be MM_PLAYER_STATE_NULL. \n
 592  *          But, it can be called in any state.
 593  * @post    Because handle is released, there is no any state.
 594  * @see     mm_player_create
 595  * @remark  This method can be called with a valid player handle from any state to \n
 596  *          completely shutdown the player operation.
 597  *
 598  * @par Example
 599  * @code
 600 if (mm_player_destroy(g_player) != MM_ERROR_NONE) {
 601         LOGE("failed to destroy player\n");
 602 }
 603  * @endcode
 604  */
 605 int mm_player_destroy(MMHandleType player);
 606
 607 /**
 608  * This function parses uri and makes gstreamer pipeline by uri scheme. \n
 609  * So, uri should be set before realizing with mm_player_set_attribute(). \n
 610  *
 611  * @param   player [in] Handle of player
 612  *
 613  * @return  This function returns zero on success, or negative value with error code.
 614  *
 615  * @pre     Player state should be MM_PLAYER_STATE_NULL.
 616  * @post    player state will be MM_PLAYER_STATE_READY.
 617  * @see     mm_player_unrealize
 618  * @remark  None
 619  * @par Example
 620  * @code
 621 if (mm_player_realize(g_player) != MM_ERROR_NONE) {
 622         LOGE("failed to realize player\n");
 623 }
 624  * @endcode
 625  */
 626 int mm_player_realize(MMHandleType player);
 627
 628 /**
 629  * This function uninitializes player object. So, resources and allocated memory \n
 630  * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
 631  * other contents, player should be created again after destruction or realized with new uri.
 632  *
 633  * @param   player [in] Handle of player
 634  *
 635  * @return  This function returns zero on success, or negative value with error code.
 636  * @pre     Player state may be MM_PLAYER_STATE_READY to unrealize. \n
 637  *          But, it can be called in any state.
 638  * @post    Player state will be MM_PLAYER_STATE_NULL.
 639  * @see     mm_player_realize
 640  * @remark  This method can be called with a valid player handle from any state.
 641  *
 642  * @par Example
 643  * @code
 644 if (mm_player_unrealize(g_player) != MM_ERROR_NONE) {
 645         LOGE("failed to unrealize player\n");
 646 }
 647  * @endcode
 648  */
 649 int mm_player_unrealize(MMHandleType player);
 650
 651 /**
 652  * This function is to abort pause state transition
 653  * for unrealize or destroy.
 654  */
 655 int mm_player_abort_pause(MMHandleType player);
 656
 657 /**
 658  * This function is to get current state of player. \n
 659  * Application have to check current state before doing some action.
 660  *
 661  * @param player [in]  Handle of player
 662  * @param state  [out] current state of player on success
 663  *
 664  * @return   This function returns zero on success, or negative value with error code.
 665  *
 666  * @see      mmplayer_state_e
 667  * @remark   None
 668  * @par Example
 669  * @code
 670 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE) {
 671         LOGE("failed to get state\n");
 672 }
 673  * @endcode
 674  */
 675 int mm_player_get_state(MMHandleType player, mmplayer_state_e *state);
 676
 677 /**
 678  * This function is to set relative volume of player. \n
 679  * So, It controls logical volume value. \n
 680  * But, if developer want to change system volume, mm sound api should be used.
 681  *
 682  * @param       player          [in]    Handle of player
 683  * @param       volume          [in]    Volume factor of each channel
 684  *
 685  * @return      This function returns zero on success, or negative value with error code.
 686  * @see         mmplayer_volume_type_t, mm_player_get_volume
 687  * @remark      The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
 688  * @par Example
 689  * @code
 690 mmplayer_volume_type_t volume;
 691 int i = 0;
 692
 693 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
 694         volume.level[i] = MM_VOLUME_LEVEL_MAX;
 695
 696 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
 697 {
 698     LOGE("failed to set volume\n");
 699 }
 700  * @endcode
 701  */
 702 int mm_player_set_volume(MMHandleType player, mmplayer_volume_type_t *volume);
 703
 704 /**
 705  * This function is to get current volume factor of player.
 706  *
 707  * @param       player          [in]    Handle of player.
 708  * @param       volume          [out]   Volume factor of each channel.
 709  *
 710  * @return      This function returns zero on success, or negative value with error code.
 711  *
 712  * @see         mmplayer_volume_type_t, mm_player_set_volume
 713  * @remark  None
 714  * @par Example
 715  * @code
 716 mmplayer_volume_type_t volume;
 717 int i;
 718
 719 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
 720 {
 721         LOGW("failed to get volume\n");
 722 }
 723
 724 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
 725         LOGD("channel[%d] = %d \n", i, volume.level[i]);
 726  * @endcode
 727  */
 728 int mm_player_get_volume(MMHandleType player, mmplayer_volume_type_t *volume);
 729
 730 /**
 731  * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
 732  * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
 733  * by mm_player_set_message_callback().
 734  *
 735  * @param       player          [in]    Handle of player
 736  *
 737  * @return      This function returns zero on success, or negative value with error code.
 738  * @remark
 739  *
 740  * @pre         Player state may be MM_PLAYER_STATE_READY.
 741  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
 742  * @see         mm_player_stop
 743  * @remark  None
 744  * @par Example
 745  * @code
 746 if (mm_player_start(g_player) != MM_ERROR_NONE)
 747 {
 748         LOGE("failed to start player\n");
 749 }
 750  * @endcode
 751  */
 752 int mm_player_start(MMHandleType player);
 753
 754 /**
 755  * This function is to stop playing media contents and it's different with pause. \n
 756  * If mm_player_start() is called after this, content will be started again from the beginning. \n
 757  * So, it can be used to close current playback.
 758  *
 759  * @param       player          [in]    Handle of player
 760  *
 761  * @return      This function returns zero on success, or negative value with error code.
 762  *
 763  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
 764  * @post                Player state will be MM_PLAYER_STATE_READY.
 765  * @see         mm_player_start
 766  * @remark  None
 767  * @par Example
 768  * @code
 769 if (mm_player_stop(g_player) != MM_ERROR_NONE)
 770 {
 771         LOGE("failed to stop player\n");
 772 }
 773  * @endcode
 774  */
 775 int mm_player_stop(MMHandleType player);
 776
 777 /**
 778  * This function is to pause playing media contents.
 779  *
 780  * @param       player          [in]    Handle of player.
 781  *
 782  * @return      This function returns zero on success, or negative value with error code.
 783  *
 784  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
 785  * @post                Player state will be MM_PLAYER_STATE_PAUSED.
 786  * @see         mm_player_resume
 787  * @remark  None
 788  * @par Example
 789  * @code
 790 if (mm_player_pause(g_player) != MM_ERROR_NONE)
 791 {
 792         LOGE("failed to pause player\n");
 793 }
 794  * @endcode
 795  */
 796 int mm_player_pause(MMHandleType player);
 797
 798 /**
 799  * This function is to resume paused media contents.
 800  *
 801  * @param       player          [in]    Handle of player.
 802  *
 803  * @return      This function returns zero on success, or negative value with error code.
 804  *
 805  * @pre         Player state may be MM_PLAYER_STATE_PAUSED.
 806  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
 807  * @see         mm_player_pause
 808  * @remark  None
 809  * @par Example
 810  * @code
 811 if (mm_player_resume(g_player) != MM_ERROR_NONE)
 812 {
 813         LOGE("failed to resume player\n");
 814 }
 815  * @endcode
 816  */
 817 int mm_player_resume(MMHandleType player);
 818
 819 /**
 820  * This function is to set the position for playback. \n
 821  * So, it can be seeked to requested position. \n
 822  *
 823  * @param       player          [in]    Handle of player
 824  * @param       pos                     [in]    Position for playback
 825  *
 826  * @return      This function returns zero on success, or negative value with error code.
 827  * @see         mm_player_get_position
 828  * @remark  the unit of time-based format is millisecond and other case is percent.
 829  */
 830 int mm_player_set_position(MMHandleType player, int64_t pos);
 831
 832 /**
 833  * This function is to get current position of playback content.
 834  *
 835  * @param       player          [in]    Handle of player.
 836  * @param       format          [in]    Format of position.
 837  * @param    pos        [out] contains current position on success or zero in case of failure.
 838  *
 839  * @return      This function returns zero on success, or negative value with errors
 840  * @see         mm_player_set_position
 841  * @remark  the unit of time-based format is millisecond and other case is percent.
 842  */
 843 int mm_player_get_position(MMHandleType player, int64_t *pos);
 844
 845 /**
 846  * This function is to get the content time duration.
 847  */
 848 int mm_player_get_duration(MMHandleType player, int64_t *dur);
 849
 850 /**
 851  * This function is to get current buffer position of playback content.
 852  *
 853  * @param   player      [in]    Handle of player.
 854  * @param   format      [in]    Format of position.
 855  * @param   start_pos   [out] contains buffer start  position on success or zero in case of failure.
 856  * @param   stop_pos    [out] contains buffer current  position on success or zero in case of failure.
 857  *
 858  * @return      This function returns zero on success, or negative value with errors
 859  * @see         mm_player_set_position
 860  * @remark  the unit of time-based format is millisecond and other case is percent.
 861  * @par Example
 862  * @code
 863 int start_pos = 0, stop_pos = 0;
 864
 865 mm_player_get_buffer_position(g_player, &start_pos, &end_pos );
 866
 867 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, end_pos );
 868  * @endcode
 869  */
 870 int mm_player_get_buffer_position(MMHandleType player, int *start_pos, int *end_pos);
 871
 872 /**
 873  * This function sets callback function for receiving messages from player.
 874  * So, player can notify warning, error and normal cases to application.
 875  *
 876  * @param       player          [in]    Handle of player.
 877  * @param       callback        [in]    Message callback function.
 878  * @param       user_param      [in]    User parameter which is passed to callback function.
 879  *
 880  * @return      This function returns zero on success, or negative value with error code.
 881  * @see         MMMessageCallback
 882  * @remark  None
 883  * @par Example
 884  * @code
 885 int msg_callback(int message, MMMessageParamType *param, void *user_param)
 886 {
 887         switch (message)
 888         {
 889                 case MM_MESSAGE_ERROR:
 890                         //do something
 891                         break;
 892
 893                 case MM_MESSAGE_END_OF_STREAM:
 894                         //do something
 895                         break;
 896
 897                 case MM_MESSAGE_STATE_CHANGED:
 898                         //do something
 899                         break;
 900
 901                 case MM_MESSAGE_BEGIN_OF_STREAM:
 902                         //do something
 903                         break;
 904
 905                 default:
 906                         break;
 907         }
 908         return TRUE;
 909 }
 910
 911 mm_player_set_message_callback(g_player, msg_callback, (void *)g_player);
 912  * @endcode
 913  */
 914 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
 915
 916 /**
 917  * This function is to mute volume of player
 918  *
 919  * @param       player  [in]    Handle of player
 920  * @param       mute    [in]    Mute(1) or not mute(0)
 921  *
 922  * @return      This function returns zero on success, or negative value with error code
 923  * @see         mm_player_get_mute
 924  * @remark  None
 925  * @par Example
 926  * @code
 927 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
 928 {
 929         LOGW("failed to set mute\n");
 930 }
 931  * @endcode
 932  */
 933 int mm_player_set_mute(MMHandleType player, int mute);
 934
 935 /**
 936  * This function is to get mute value of player
 937  *
 938  * @param       player  [in]    Handle of player
 939  * @param       mute    [out]   Sound is muted
 940  *
 941  * @return      This function returns zero on success, or negative value with error code
 942  * @see         mm_player_set_mute
 943  * @remark  None
 944  * @par Example
 945  * @code
 946 int mute;
 947
 948 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
 949 {
 950         LOGW("failed to get mute\n");
 951 }
 952
 953 LOGD("mute status:%d\n", mute);
 954  * @endcode
 955  */
 956 int mm_player_get_mute(MMHandleType player, int *mute);
 957
 958 /**
 959  * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
 960  * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
 961  *
 962  * @param       player  [in]    Handle of player
 963  * @param       pos             [in]    postion to be adjusted
 964  *
 965  * @return      This function returns zero on success, or negative value with error
 966  *                      code
 967  * @see         mm_player_adjust_subtitle_position
 968  * @remark  None
 969  * @par Example
 970  * @code
 971 int pos;
 972
 973 pos = 5000;
 974 if (mm_player_adjust_subtitle_position(g_player, pos) != MM_ERROR_NONE)
 975 {
 976         LOGW("failed to adjust subtitle postion.\n");
 977 }
 978  * @endcode
 979  */
 980
 981 int mm_player_adjust_subtitle_position(MMHandleType player, int pos);
 982
 983 /**
 984  * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
 985  * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
 986  * Player FW parses subtitle file and send text data including timestamp to application \n
 987  * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
 988  * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
 989  * So, it's not supported for embedded case.
 990  *
 991  * @param       player  [in]    Handle of player
 992  * @param       silent  [in]    silent(integer value except 0) or not silent(0)
 993  *
 994  * @return      This function returns zero on success, or negative value with error
 995  *                      code
 996  * @see         mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
 997  * @remark  None
 998  * @par Example
 999  * @code
1000 mm_player_set_attribute(g_player,
1001                                         &g_err_name,
1002                                         "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1003                                         NULL
1004                                         );
1005
1006 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1007 {
1008         LOGW("failed to set subtitle silent\n");
1009 }
1010  * @endcode
1011  */
1012 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1013
1014 /**
1015  * This function is to get silent status of subtitle.
1016  *
1017  * @param       player  [in]    Handle of player
1018  * @param       silent  [out]   subtitle silent property
1019  *
1020  * @return      This function returns zero on success, or negative value with error
1021  *                      code
1022  * @see         mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1023  * @remark  None
1024  * @par Example
1025  * @code
1026 int silent = FALSE;
1027
1028 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1029 {
1030         LOGW("failed to set subtitle silent\n");
1031 }
1032  * @endcode
1033  */
1034 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1035
1036 /**
1037  * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1038  * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1039  *
1040  * @param   player                 [in]   Handle of player.
1041  * @param   err_attr_name          [out]  Name of attribute which is failed to set
1042  * @param   first_attribute_name   [in]   Name of the first attribute to set
1043  * @param   ...                    [in]   Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1044  *                                        But, in the case of data or string type, it should be name/value/size.
1045  *
1046  * @return  This function returns zero on success, or negative value with error code.
1047  *
1048  * @see     mm_player_get_attribute
1049  * @remark  This function must be terminated by NULL argument.
1050  *          And, if this function is failed, err_attr_name param must be free.
1051  * @par Example
1052  * @code
1053 char *g_err_attr_name = NULL;
1054
1055 if (mm_player_set_attribute(g_player,
1056                                                 &g_err_attr_name,
1057                                                 "profile_uri", filename, strlen(filename),
1058                                                 "profile_play_count", count,
1059                                                 NULL) != MM_ERROR_NONE) {
1060         LOGW("failed to set %s attribute\n", g_err_attr_name);
1061         free(g_err_attr_name);
1062 }
1063
1064  * @endcode
1065  */
1066 int mm_player_set_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1067
1068 /**
1069  * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1070  *
1071  * @param   player                [in]  Handle of player.
1072  * @param   err_attr_name         [out] Name of attribute which is failed to get
1073  * @param   first_attribute_name  [in]  Name of the first attribute to get
1074  * @param   ...                   [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1075  *                                      But, in the case of data or string type, it should be name/value/size.
1076  *
1077  * @return  This function returns zero on success, or negative value with error
1078  *          code.
1079  * @see     mm_player_set_attribute
1080  * @remark  This function must be terminated by NULL argument.
1081  *          And, if this function is failed, err_attr_name param must be free.
1082  */
1083 int mm_player_get_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1084
1085 /**
1086  * This function is to get detail information of attribute.
1087  *
1088  * @param   player          [in]  Handle of player.
1089  * @param   attribute_name  [in]  Name of the attribute to get
1090  * @param   info            [out] Attribute infomation
1091  *
1092  * @return  This function returns zero on success, or negative value with error
1093  *          code.
1094  *
1095  * @see     mm_player_set_attribute, mm_player_get_attribute
1096  * @remark  None
1097  * @par Example
1098  * @code
1099 if (mm_player_get_attribute_info(g_player, "display_method", &method_info) != MM_ERROR_NONE) {
1100         LOGW("failed to get info\n");
1101 }
1102
1103 LOGD("type:%d \n", method_info.type); //int, double..
1104 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1105 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1106
1107 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE) {
1108         LOGD("range min:%d\n", method_info.int_range.min);
1109         LOGD("range max:%d\n", method_info.int_range.max);
1110 }
1111  * @endcode
1112  */
1113 int mm_player_get_attribute_info(MMHandleType player,  const char *attribute_name, mmplayer_attrs_info_t *info);
1114
1115 /**
1116  * This function is to get the track count
1117  *
1118  * @param   player [in]  handle of player.
1119  * @param   track  [in]  type of the track type
1120  * @param   info   [out] the count of the track
1121  *
1122  * @return  This function returns zero on success, or negative value with error
1123  *          code.
1124  *
1125  * @par Example
1126  * @code
1127 gint audio_count = 0;
1128
1129 if (mm_player_get_track_count(g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE) {
1130         LOGW("failed to get audio track count\n");
1131 }
1132
1133 LOGD("audio track count : %d \n", audio_count);
1134  * @endcode
1135  */
1136 int mm_player_get_track_count(MMHandleType player,  mmplayer_track_type_e type, int *count);
1137
1138 /**
1139  * This function is to select the track
1140  *
1141  * @param   player [in] handle of player.
1142  * @param   type   [in] type of the track type
1143  * @param   index  [in] the index of the track
1144  *
1145  * @return  This function returns zero on success, or negative value with error
1146  *          code.
1147  */
1148 int mm_player_select_track(MMHandleType player, mmplayer_track_type_e type, int index);
1149
1150 /**
1151  * This function is to get the track language
1152  *
1153  * @param   player [in]  handle of player.
1154  * @param   type   [in]  type of the track type
1155  * @param   index  [in]  the index of the track
1156  * @param   code   [out] language code in ISO 639-1(string)
1157  *
1158  * @return  This function returns zero on success, or negative value with error
1159  *          code.
1160  */
1161 int mm_player_get_track_language_code(MMHandleType player,  mmplayer_track_type_e type, int index, char **code);
1162
1163 /**
1164  * This function is to get the current running track
1165  *
1166  * @param       player          [in]    handle of player.
1167  * @param       type                    [in]    type of the track type
1168  * @param       index           [out]    the index of the track
1169  *
1170  * @return      This function returns zero on success, or negative value with error
1171  *                      code.
1172  */
1173
1174 int mm_player_get_current_track(MMHandleType hplayer, mmplayer_track_type_e type, int *index);
1175
1176 /**
1177  * This function is to set the subtitle path
1178  *
1179  * @param       player  [in]    handle of player
1180  * @param       path    [in]    subtitle path
1181  *
1182  * @return      This function returns zero on success, or negative value with error code.
1183  */
1184 int mm_player_set_external_subtitle_path(MMHandleType player, const char *path);
1185
1186 /**
1187  * This function is to set uri.
1188  *
1189  * @param   player [in] handle of player
1190  * @param   uri    [in] uri
1191  * @return  This function returns zero on success, or negative value with error code.
1192  */
1193 int mm_player_set_uri(MMHandleType player, const char *uri);
1194
1195 /**
1196  * This function is to set next uri.
1197  *
1198  * @param   player [in] handle of player
1199  * @param   uri    [in] uri
1200  * @return  This function returns zero on success, or negative value with error code.
1201  */
1202 int mm_player_set_next_uri(MMHandleType player, const char *uri);
1203
1204 /**
1205  * This function is to get next uri.
1206  *
1207  * @param   player   [in]  handle of player
1208  * @param   uri      [out] uri
1209  * @return  This function returns zero on success, or negative value with error code.
1210  */
1211 int mm_player_get_next_uri(MMHandleType player, char **uri);
1212
1213 /**
1214  * This function is to decrease reference count of internal buffer.
1215  *
1216  * @param    buffer [in] video callback internal buffer
1217  * @return   None;
1218  */
1219 void mm_player_video_stream_internal_buffer_unref(void *buffer);
1220
1221 /**mm_player_submit_packet
1222  * This function is to submit buffer to appsrc.  \n
1223  * @param   player                      [in]    Handle of player.
1224  * @param   buf             [in]    buffer to be submit in appsrc in external feeder case.
1225  * @param   len                         [in]    length of buffer.
1226  * @param   pts                         [in]    timestamp of buffer.
1227  * @param   streamtype          [in]    stream type of buffer.
1228  * @return  This function returns zero on success, or negative value with error code.
1229  */
1230 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
1231
1232 /**mm_player_set_video_info
1233  * This function is to set caps of src pad of video appsrc in external feeder case.  \n
1234  * @param   player         [in] Handle of player.
1235  * @param   media_format_h [in] Video stream info.
1236  * @return  This function returns zero on success, or negative value with error code.
1237  */
1238 int mm_player_set_video_info(MMHandleType player, media_format_h format);
1239
1240 /**mm_player_set_audio_info
1241  * This function is to set caps of src pad of Audio appsrc in external feeder case.  \n
1242  * @param       player                       [in]    Handle of player.
1243  * @param       media_format_h               [in]    Audio stream info.
1244  * @return      This function returns zero on success, or negative value with error code.
1245  */
1246 int mm_player_set_audio_info(MMHandleType player, media_format_h format);
1247
1248 /**mm_player_set_subtitle_info
1249  * This function is to set caps of src pad of subtitle appsrc in external feeder case.  \n
1250  * @param       player                          [in]    Handle of player.
1251  * @param       subtitle_stream_info               [in]    Subtitle stream info.
1252  * @return      This function returns zero on success, or negative value with error code.
1253  */
1254 int mm_player_set_subtitle_info(MMHandleType player, mmplayer_subtitle_stream_info_t *info);
1255
1256 /**
1257  * This function set callback function for receiving need or enough data message from player.
1258  *
1259  * @param   player     [in] Handle of player.
1260  * @param   type       [in] stream type
1261  * @param   callback   [in] data callback function for stream type.
1262  * @param   user_param [in] User parameter.
1263  *
1264  * @return  This function returns zero on success, or negative value with error
1265  *          code.
1266  */
1267 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, mmplayer_stream_type_e type, mm_player_media_stream_buffer_status_callback callback, void *user_param);
1268
1269 /**
1270  * This function set callback function for receiving seek data message from player.
1271  *
1272  * @param       player          [in]    Handle of player.
1273  * @param       type            [in]    stream type
1274  * @param       callback        [in]    Seek data callback function for stream type.
1275  * @param       user_param      [in]    User parameter.
1276  *
1277  * @return      This function returns zero on success, or negative value with error
1278  *                      code.
1279  */
1280 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, mmplayer_stream_type_e type, mm_player_media_stream_seek_data_callback callback, void *user_param);
1281
1282 /**
1283  * This function is to set max size of buffer(appsrc).
1284  *
1285  * @param       player          [in]    Handle of player.
1286  * @param       type            [in]    stream type
1287  * @param       max_size        [in]    max bytes of buffer.
1288  *
1289  * @return      This function returns zero on success, or negative value with error
1290  *                      code.
1291  */
1292 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, mmplayer_stream_type_e type, unsigned long long max_size);
1293
1294 /**
1295  * This function is to get max size of buffer(appsrc).
1296  *
1297  * @param       player          [in]    Handle of player.
1298  * @param       type            [in]    stream type
1299  * @param       max_size        [out]   max bytes of buffer.
1300  *
1301  * @return      This function returns zero on success, or negative value with error
1302  *                      code.
1303  */
1304 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, mmplayer_stream_type_e type, unsigned long long *max_size);
1305
1306 /**
1307  * This function is to set min percent of buffer(appsrc).
1308  *
1309  * @param       player          [in]    Handle of player.
1310  * @param       type            [in]    stream type
1311  * @param       min_percent     [in]    min percent of buffer.
1312  *
1313  * @return      This function returns zero on success, or negative value with error
1314  *                      code.
1315  */
1316 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, mmplayer_stream_type_e type, unsigned min_percent);
1317
1318 /**
1319  * This function is to get min percent of buffer(appsrc).
1320  *
1321  * @param       player          [in]    Handle of player.
1322  * @param       type            [in]    stream type
1323  * @param       min_percent     [out]   min percent of buffer.
1324  *
1325  * @return      This function returns zero on success, or negative value with error
1326  *                      code.
1327  */
1328 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, mmplayer_stream_type_e type, unsigned int *min_percent);
1329
1330 /**
1331  * This function set callback function for changing audio stream from player. \n
1332  * It's only supported when audio stream is included in file. \n
1333  *
1334  * @param       player   [in] Handle of player.
1335  * @param       callback [in] Audio stream changed callback function.
1336  * @param       user_param [in] User parameter.
1337  *
1338  * @return      This function returns zero on success, or negative value with error
1339  *                      code.
1340  * @see         mm_player_stream_changed_callback
1341  * @since
1342  */
1343 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1344
1345 /**
1346  * This function set callback function for changing video stream from player. \n
1347  * It's only supported when video stream is included in file. \n
1348  *
1349  * @param       player   [in] Handle of player.
1350  * @param       callback [in] Video stream changed callback function.
1351  * @param       user_param [in] User parameter.
1352  *
1353  * @return      This function returns zero on success, or negative value with error
1354  *                      code.
1355  * @see         mm_player_stream_changed_callback
1356  */
1357 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1358
1359 /**
1360  * This function is to get timeout value according to the content type for muse. \n
1361  * It's only supported when video stream is included in file. \n
1362  *
1363  * @param       player  [in] Handle of player.
1364  * @param       timeout [out] timeout value (sec).
1365  *
1366  * @return      This function returns zero on success, or negative value with error
1367  *                      code.
1368  * @since 3.0
1369  */
1370 int mm_player_get_timeout(MMHandleType player, int *timeout);
1371
1372 /**
1373  * This function is to get the number of video output buffers. \n
1374  * It's only supported when video stream is included in file. \n
1375  *
1376  * @param       player  [in] Handle of player.
1377  * @param       num     [out] num of buffers.
1378  * @param       extra_num [out] extra num of buffers.
1379  *
1380  * @return      This function returns zero on success, or negative value with error
1381  *                      code.
1382  * @since 3.0
1383  */
1384 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
1385
1386 /**
1387  * This function is to set the dynamic resolution information. \n
1388  * It's only supported when video stream is included in file. \n
1389  *
1390  * @param       player  [in] Handle of player.
1391  * @param       drc     [in] dynamic resolution info of media stream data
1392  *
1393  * @return      This function returns zero on success, or negative value with error
1394  *                      code.
1395  * @since 3.0
1396  */
1397 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
1398
1399 /**
1400  * This function is to release the video stream bo to reuse. \n
1401  * It's only supported when sw codec is used to decode video stream. \n
1402  *
1403  * @param       player  [in] Handle of player.
1404  * @param       bo     [in] bo address to be released
1405  *
1406  * @return      This function returns zero on success, or negative value with error
1407  *                      code.
1408  * @since 3.0
1409  */
1410 int mm_player_release_video_stream_bo(MMHandleType player, void *bo);
1411
1412 /**
1413  * This function is to set sound stream info
1414  */
1415 int mm_player_set_sound_stream_info(MMHandleType player, char *stream_type, int stream_index);
1416
1417 /**
1418  * This function is to manage the playback according to the external storage state
1419  */
1420 int mm_player_manage_external_storage_state(MMHandleType player, int id, int state);
1421
1422 /**
1423  * These functions are to set/get the max variant of HAS
1424  */
1425 int mm_player_get_adaptive_variant_info(MMHandleType player, int *num, char **var_info);
1426 int mm_player_set_max_adaptive_variant_limit(MMHandleType player, int bandwidth, int width, int height);
1427 int mm_player_get_max_adaptive_variant_limit(MMHandleType player, int *bandwidth, int *width, int *height);
1428
1429 /**
1430  * These functions are to set/get the audio only mode
1431  */
1432 int mm_player_set_audio_only(MMHandleType player, bool audio_only);
1433 int mm_player_get_audio_only(MMHandleType player, bool *audio_only);
1434
1435 /**
1436  * These functions are to get the streaming bufferint time
1437  */
1438 int mm_player_get_streaming_buffering_time(MMHandleType player, int *prebuffer_ms, int *rebuffer_ms);
1439
1440 /**
1441  * These functions are to display the 360 video content
1442  */
1443 int mm_player_360_is_content_spherical(MMHandleType player, bool *is_spherical);
1444 int mm_player_360_set_enabled(MMHandleType player, bool enabled);
1445 int mm_player_360_is_enabled(MMHandleType player, bool *enabled);
1446
1447 int mm_player_360_set_direction_of_view(MMHandleType player, float yaw, float pitch);
1448 int mm_player_360_get_direction_of_view(MMHandleType player, float *yaw, float *pitch);
1449
1450 int mm_player_360_set_zoom(MMHandleType player, float level);
1451 int mm_player_360_get_zoom(MMHandleType player, float *level);
1452
1453 int mm_player_360_set_field_of_view(MMHandleType player, int horizontal_degrees, int vertical_degrees);
1454 int mm_player_360_get_field_of_view(MMHandleType player, int *horizontal_degrees, int *vertical_degrees);
1455
1456 /**
1457  * This function is to set codec type
1458  */
1459 int mm_player_set_codec_type(MMHandleType player, mmplayer_stream_type_e stream_type, mmplayer_video_codec_type_e codec_type);
1460
1461 /**
1462  * These functions are to apply the replaygain
1463  */
1464 int mm_player_set_replaygain_enabled(MMHandleType player, bool enabled);
1465 int mm_player_is_replaygain_enabled(MMHandleType player, bool *enabled);
1466
1467 /**
1468  * This function is to set/get video content ROI area
1469  */
1470 int mm_player_set_video_roi_area(MMHandleType player, double scale_x, double scale_y, double scale_width, double scale_height);
1471 int mm_player_get_video_roi_area(MMHandleType player, double *scale_x, double *scale_y, double *scale_width, double *scale_height);
1472
1473 /**
1474         @}
1475  */
1476
1477 #ifdef __cplusplus
1478         }
1479 #endif
1480
1481 #endif  /* __MM_PLAYER_H__ */