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