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         @addtogroup PLAYER
  45         @{
  46
  47         @par
  48         This part describes APIs used for playback of multimedia contents.
  49         All multimedia contents are created by a media player through handle of playback.
  50         In creating a player, it displays the player's status or information
  51         by registering callback function.
  52
  53         @par
  54         In case of streaming playback, network has to be opend by using datanetwork API.
  55         If proxy, cookies and the other attributes for streaming playback are needed,
  56         set those attributes using mm_player_set_attribute() before create player.
  57
  58         @par
  59         The subtitle for local video playback is supported. Set "subtitle_uri" attribute
  60         using mm_player_set_attribute() before the application creates the player.
  61         Then the application could receive MMMessageParamType which includes subtitle string and duration.
  62
  63         @par
  64         Player can have 5 states, and each state can be changed by calling
  65         described functions on "Figure1. State of Player".
  66
  67         @par
  68         @image html             player_state.jpg        "Figure1. State of Player"      width=12cm
  69         @image latex    player_state.jpg        "Figure1. State of Player"      width=12cm
  70
  71         @par
  72         Most of functions which change player state work as synchronous. But, mm_player_start() should be used
  73         asynchronously. Both mm_player_pause() and mm_player_resume() should also be used asynchronously
  74         in the case of streaming data.
  75         So, application have to confirm the result of those APIs through message callback function.
  76
  77         @par
  78         Note that "None" and Null" state could be reached from any state
  79         by calling mm_player_destroy() and mm_player_unrealize().
  80
  81         @par
  82         <div><table>
  83         <tr>
  84         <td><B>FUNCTION</B></td>
  85         <td><B>PRE-STATE</B></td>
  86         <td><B>POST-STATE</B></td>
  87         <td><B>SYNC TYPE</B></td>
  88         </tr>
  89         <tr>
  90         <td>mm_player_create()</td>
  91         <td>NONE</td>
  92         <td>NULL</td>
  93         <td>SYNC</td>
  94         </tr>
  95         <tr>
  96         <td>mm_player_destroy()</td>
  97         <td>NULL</td>
  98         <td>NONE</td>
  99         <td>SYNC</td>
 100         </tr>
 101         <tr>
 102         <td>mm_player_realize()</td>
 103         <td>NULL</td>
 104         <td>READY</td>
 105         <td>SYNC</td>
 106         </tr>
 107         <tr>
 108         <td>mm_player_unrealize()</td>
 109         <td>READY</td>
 110         <td>NULL</td>
 111         <td>SYNC</td>
 112         </tr>
 113         <tr>
 114         <td>mm_player_start()</td>
 115         <td>READY</td>
 116         <td>PLAYING</td>
 117         <td>ASYNC</td>
 118         </tr>
 119         <tr>
 120         <td>mm_player_stop()</td>
 121         <td>PLAYING</td>
 122         <td>READY</td>
 123         <td>SYNC</td>
 124         </tr>
 125         <tr>
 126         <td>mm_player_pause()</td>
 127         <td>PLAYING</td>
 128         <td>PAUSED</td>
 129         <td>ASYNC</td>
 130         </tr>
 131         <tr>
 132         <td>mm_player_resume()</td>
 133         <td>PAUSED</td>
 134         <td>PLAYING</td>
 135         <td>ASYNC</td>
 136         </tr>
 137         <tr>
 138         <td>mm_player_set_message_callback()</td>
 139         <td>N/A</td>
 140         <td>N/A</td>
 141         <td>SYNC</td>
 142         </tr>
 143         <tr>
 144         <td>mm_player_get_state()</td>
 145         <td>N/A</td>
 146         <td>N/A</td>
 147         <td>SYNC</td>
 148         </tr>
 149         <tr>
 150         <td>mm_player_set_volume()</td>
 151         <td>N/A</td>
 152         <td>N/A</td>
 153         <td>SYNC</td>
 154         </tr>
 155         <tr>
 156         <td>mm_player_get_volume()</td>
 157         <td>N/A</td>
 158         <td>N/A</td>
 159         <td>SYNC</td>
 160         </tr>
 161         <tr>
 162         <td>mm_player_set_position()</td>
 163         <td>N/A</td>
 164         <td>N/A</td>
 165         <td>SYNC</td>
 166         </tr>
 167         <tr>
 168         <td>mm_player_get_position()</td>
 169         <td>N/A</td>
 170         <td>N/A</td>
 171         <td>SYNC</td>
 172         </tr>
 173         <tr>
 174         <td>mm_player_get_attribute()</td>
 175         <td>N/A</td>
 176         <td>N/A</td>
 177         <td>SYNC</td>
 178         </tr>
 179         <tr>
 180         <td>mm_player_set_attribute()</td>
 181         <td>N/A</td>
 182         <td>N/A</td>
 183         <td>SYNC</td>
 184         </tr>
 185         </table></div>
 186
 187         @par
 188         Following are the attributes supported in player which may be set after initialization. \n
 189         Those are handled as a string.
 190
 191         @par
 192         <div><table>
 193         <tr>
 194         <td>PROPERTY</td>
 195         <td>TYPE</td>
 196         <td>VALID TYPE</td>
 197         </tr>
 198         <tr>
 199         <td>"profile_uri"</td>
 200         <td>string</td>
 201         <td>N/A</td>
 202         </tr>
 203         <tr>
 204         <td>"content_duration"</td>
 205         <td>int</td>
 206         <td>range</td>
 207         </tr>
 208         <tr>
 209         <td>"content_video_width"</td>
 210         <td>int</td>
 211         <td>range</td>
 212         </tr>
 213         <tr>
 214         <td>"content_video_height"</td>
 215         <td>int</td>
 216         <td>range</td>
 217         </tr>
 218         <tr>
 219         <td>"display_evas_do_scaling"</td>
 220         <td>int</td>
 221         <td>range</td>
 222         </tr>
 223         <tr>
 224         <td>"display_evas_surface_sink"</td>
 225         <td>string</td>
 226         <td>N/A</td>
 227         </tr>
 228         <tr>
 229         <td>"profile_user_param"</td>
 230         <td>data</td>
 231         <td>N/A</td>
 232         </tr>
 233         <tr>
 234         <td>"profile_play_count"</td>
 235         <td>int</td>
 236         <td>range</td>
 237         </tr>
 238         <tr>
 239         <td>"streaming_type"</td>
 240         <td>int</td>
 241         <td>range</td>
 242         </tr>
 243         <tr>
 244         <td>"streaming_udp_timeout"</td>
 245         <td>int</td>
 246         <td>range</td>
 247         </tr>
 248         <tr>
 249         <td>"streaming_user_agent"</td>
 250         <td>string</td>
 251         <td>N/A</td>
 252         </tr>
 253         <tr>
 254         <td>"streaming_wap_profile"</td>
 255         <td>string</td>
 256         <td>N/A</td>
 257         </tr>
 258         <tr>
 259         <td>"streaming_network_bandwidth"</td>
 260         <td>int</td>
 261         <td>range</td>
 262         </tr>
 263         <tr>
 264         <td>"streaming_cookie"</td>
 265         <td>string</td>
 266         <td>N/A</td>
 267         </tr>
 268         <tr>
 269         <td>"streaming_proxy_ip"</td>
 270         <td>string</td>
 271         <td>N/A</td>
 272         </tr>
 273         <tr>
 274         <td>"streaming_proxy_port"</td>
 275         <td>int</td>
 276         <td>range</td>
 277         </tr>
 278         <tr>
 279         <td>"streaming_timeout"</td>
 280         <td>int</td>
 281         <td>range</td>
 282         </tr>
 283         <tr>
 284         <td>"display_overlay"</td>
 285         <td>data</td>
 286         <td>N/A</td>
 287         </tr>
 288         <tr>
 289         <td>"display_rotation"</td>
 290         <td>int</td>
 291         <td>range</td>
 292         </tr>
 293         <tr>
 294         <td>"subtitle_uri"</td>
 295         <td>string</td>
 296         <td>N/A</td>
 297         </tr>
 298         </table></div>
 299
 300         @par
 301         Following attributes are supported for playing stream data. Those value can be readable only and valid after starting playback.\n
 302         Please use mm_fileinfo for local playback.
 303
 304         @par
 305         <div><table>
 306         <tr>
 307         <td>PROPERTY</td>
 308         <td>TYPE</td>
 309         <td>VALID TYPE</td>
 310         </tr>
 311         <tr>
 312         <td>"content_video_found"</td>
 313         <td>string</td>
 314         <td>N/A</td>
 315         </tr>
 316         <tr>
 317         <td>"content_video_codec"</td>
 318         <td>string</td>
 319         <td>N/A</td>
 320         </tr>
 321         <tr>
 322         <td>"content_video_track_num"</td>
 323         <td>int</td>
 324         <td>range</td>
 325         </tr>
 326         <tr>
 327         <td>"content_audio_found"</td>
 328         <td>string</td>
 329         <td>N/A</td>
 330         </tr>
 331         <tr>
 332         <td>"content_audio_codec"</td>
 333         <td>string</td>
 334         <td>N/A</td>
 335         </tr>
 336         <tr>
 337         <td>"content_audio_bitrate"</td>
 338         <td>int</td>
 339         <td>array</td>
 340         </tr>
 341         <tr>
 342         <td>"content_audio_channels"</td>
 343         <td>int</td>
 344         <td>range</td>
 345         </tr>
 346         <tr>
 347         <td>"content_audio_samplerate"</td>
 348         <td>int</td>
 349         <td>array</td>
 350         </tr>
 351         <tr>
 352         <td>"content_audio_track_num"</td>
 353         <td>int</td>
 354         <td>range</td>
 355         </tr>
 356         <tr>
 357         <td>"content_text_track_num"</td>
 358         <td>int</td>
 359         <td>range</td>
 360         </tr>
 361         <tr>
 362         <td>"tag_artist"</td>
 363         <td>string</td>
 364         <td>N/A</td>
 365         </tr>
 366         <tr>
 367         <td>"tag_title"</td>
 368         <td>string</td>
 369         <td>N/A</td>
 370         </tr>
 371         <tr>
 372         <td>"tag_album"</td>
 373         <td>string</td>
 374         <td>N/A</td>
 375         </tr>
 376         <tr>
 377         <td>"tag_genre"</td>
 378         <td>string</td>
 379         <td>N/A</td>
 380         </tr>
 381         <tr>
 382         <td>"tag_author"</td>
 383         <td>string</td>
 384         <td>N/A</td>
 385         </tr>
 386         <tr>
 387         <td>"tag_copyright"</td>
 388         <td>string</td>
 389         <td>N/A</td>
 390         </tr>
 391         <tr>
 392         <td>"tag_date"</td>
 393         <td>string</td>
 394         <td>N/A</td>
 395         </tr>
 396         <tr>
 397         <td>"tag_description"</td>
 398         <td>string</td>
 399         <td>N/A</td>
 400         </tr>
 401         <tr>
 402         <td>"tag_track_num"</td>
 403         <td>int</td>
 404         <td>range</td>
 405         </tr>
 406         </table></div>
 407
 408  */
 409
 410
 411 /*===========================================================================================
 412 |                                                                                           |
 413 |  GLOBAL DEFINITIONS AND DECLARATIONS                                        |
 414 |                                                                                           |
 415 ========================================================================================== */
 416
 417 /**
 418  * MM_PLAYER_URI:
 419  *
 420  * uri to play (string)
 421  *
 422  */
 423 #define MM_PLAYER_CONTENT_URI                                   "profile_uri"
 424 /**
 425  * MM_PLAYER_CONTENT_DURATION:
 426  *
 427  * get the duration (int) as millisecond, It's guaranteed after calling mm_player_start() or
 428  * receiving MM_MESSAGE_BEGIN_OF_STREAM.
 429  *
 430  */
 431 #define MM_PLAYER_CONTENT_DURATION                      "content_duration"
 432 /**
 433  * MM_PLAYER_VIDEO_ROTATION
 434  *
 435  * can change video angle (int)
 436  * @see MMDisplayRotationType
 437  */
 438 #define MM_PLAYER_VIDEO_ROTATION                                "display_rotation"
 439 /**
 440  * MM_PLAYER_VIDEO_WIDTH:
 441  *
 442  * get the video width (int), It's guaranteed after calling mm_player_start() or
 443  * receiving MM_MESSAGE_BEGIN_OF_STREAM.
 444  *
 445  */
 446 #define MM_PLAYER_VIDEO_WIDTH                           "content_video_width"
 447 /**
 448  * MM_PLAYER_VIDEO_HEIGHT:
 449  *
 450  * get the video height (int), It's guaranteed after calling mm_player_start() or
 451  * receiving MM_MESSAGE_BEGIN_OF_STREAM.
 452  *
 453  */
 454 #define MM_PLAYER_VIDEO_HEIGHT                          "content_video_height"
 455 /**
 456  * MM_PLAYER_VIDEO_EVAS_SURFACE_DO_SCALING:
 457  *
 458  * set whether or not to scale frames size for evas surface.
 459  * if TRUE, it scales down width, height size of frames with given size.
 460  * if FALSE, it does not scale down any frames.
 461  *
 462  */
 463 #define MM_PLAYER_VIDEO_EVAS_SURFACE_DO_SCALING         "display_evas_do_scaling"
 464 /**
 465  * MM_PLAYER_VIDEO_EVAS_SURFACE_SINK:
 466  *
 467  * get the video evas surface sink plugin name (string), It's guaranteed after calling mm_player_create()
 468  *
 469  */
 470 #define MM_PLAYER_VIDEO_EVAS_SURFACE_SINK               "display_evas_surface_sink"
 471 /**
 472  * MM_PLAYER_MEM_SRC:
 473  *
 474  * set memory pointer to play (data)
 475  *
 476  */
 477 #define MM_PLAYER_MEMORY_SRC                                    "profile_user_param"
 478 /**
 479  * MM_PLAYER_PLAYBACK_COUNT
 480  *
 481  * can set playback count (int), Default value is 1 and -1 is for infinity playing until releasing it.
 482  *
 483  */
 484 #define MM_PLAYER_PLAYBACK_COUNT                                "profile_play_count"
 485 /**
 486  * MM_PLAYER_SUBTITLE_URI
 487  *
 488  * set the subtitle path (string)
 489  */
 490 #define MM_PLAYER_SUBTITLE_URI                                  "subtitle_uri"
 491 /**
 492  * MM_PLAYER_STREAMING_TYPE
 493  *
 494  * set the streaming type (int)
 495  * @see MMStreamingType
 496  */
 497 #define MM_PLAYER_STREAMING_TYPE                                "streaming_type"
 498 /**
 499  * MM_PLAYER_STREAMING_UDP_TIMEOUT
 500  *
 501  * set the streaming udp timeout(int)
 502  */
 503 #define MM_PLAYER_STREAMING_UDP_TIMEOUT         "streaming_udp_timeout"
 504 /**
 505  * MM_PLAYER_STREAMING_USER_AGENT
 506  *
 507  * set the streaming user agent (string)
 508  */
 509 #define MM_PLAYER_STREAMING_USER_AGENT          "streaming_user_agent"
 510 /**
 511  * MM_PLAYER_STREAMING_WAP_PROFILE
 512  *
 513  * set the streaming wap profile (int)
 514  */
 515 #define MM_PLAYER_STREAMING_WAP_PROFILE         "streaming_wap_profile"
 516 /**
 517  * MM_PLAYER_STREAMING_NET_BANDWIDTH
 518  *
 519  * set the streaming network bandwidth (int)
 520  */
 521 #define MM_PLAYER_STREAMING_NET_BANDWIDTH       "streaming_network_bandwidth"
 522 /**
 523  * MM_PLAYER_STREAMING_COOKIE
 524  *
 525  * set the streaming cookie (int)
 526  */
 527 #define MM_PLAYER_STREAMING_COOKIE                      "streaming_cookie"
 528 /**
 529  * MM_PLAYER_STREAMING_PROXY_IP
 530  *
 531  * set the streaming proxy ip (string)
 532  */
 533 #define MM_PLAYER_STREAMING_PROXY_IP                    "streaming_proxy_ip"
 534 /**
 535  * MM_PLAYER_STREAMING_PROXY_PORT
 536  *
 537  * set the streaming proxy port (int)
 538  */
 539 #define MM_PLAYER_STREAMING_PROXY_PORT          "streaming_proxy_port"
 540 /**
 541  * MM_PLAYER_STREAMING_TIMEOUT
 542  *
 543  * set the streaming timeout (int)
 544  */
 545 #define MM_PLAYER_STREAMING_TIMEOUT                     "streaming_timeout"
 546 /**
 547  * MM_PLAYER_VIDEO_CODEC
 548  *
 549  * codec the video data is stored in (string)
 550  */
 551 #define MM_PLAYER_VIDEO_CODEC                           "content_video_codec"
 552 /**
 553  * MM_PLAYER_VIDEO_TRACK_NUM
 554  *
 555  * track number inside a collection  (int)
 556  */
 557 #define MM_PLAYER_VIDEO_TRACK_NUM                       "content_video_track_num"
 558 /**
 559  * MM_PLAYER_AUDIO_CODEC
 560  *
 561  * codec the audio data is stored in (string)
 562  */
 563 #define MM_PLAYER_AUDIO_CODEC                           "content_audio_codec"
 564 /**
 565  * MM_PLAYER_AUDIO_BITRATE
 566  *
 567  * set the streaming proxy port (int)
 568  */
 569 #define MM_PLAYER_AUDIO_BITRATE                         "content_audio_bitrate"
 570 /**
 571  * MM_PLAYER_AUDIO_CHANNEL
 572  *
 573  * the number of audio channel (int)
 574  */
 575 #define MM_PLAYER_AUDIO_CHANNEL                         "content_audio_channels"
 576 /**
 577  * MM_PLAYER_AUDIO_SAMPLERATE
 578  *
 579  * audio samplerate  (int)
 580  */
 581 #define MM_PLAYER_AUDIO_SAMPLERATE                      "content_audio_samplerate"
 582 /**
 583  * MM_PLAYER_AUDIO_TRACK_NUM
 584  *
 585  * track number inside a collection (int)
 586  */
 587 #define MM_PLAYER_AUDIO_TRACK_NUM                       "content_audio_track_num"
 588 /**
 589  * MM_PLAYER_TEXT_TRACK_NUM
 590  *
 591  * track number inside a collection (int)
 592  */
 593 #define MM_PLAYER_TEXT_TRACK_NUM                        "content_text_track_num"
 594 /**
 595  * MM_PLAYER_TAG_ARTIST
 596  *
 597  * person(s) responsible for the recording (string)
 598  */
 599 #define MM_PLAYER_TAG_ARTIST                                    "tag_artist"
 600 /**
 601  * MM_PLAYER_TAG_ARTIST
 602  *
 603  * title (string)
 604  */
 605 #define MM_PLAYER_TAG_TITLE                                     "tag_title"
 606 /**
 607  * MM_PLAYER_TAG_ARTIST
 608  *
 609  * album containing this data (string)
 610  */
 611 #define MM_PLAYER_TAG_ALBUM                                     "tag_album"
 612 /**
 613  * MM_PLAYER_TAG_ARTIST
 614  *
 615  * genre this data belongs to (string)
 616  */
 617 #define MM_PLAYER_TAG_GENRE                                     "tag_genre"
 618 /**
 619  * MM_PLAYER_TAG_ARTIST
 620  *
 621  * author (string)
 622  */
 623 #define MM_PLAYER_TAG_AUTHOUR                           "tag_author"
 624 /**
 625  * MM_PLAYER_TAG_ARTIST
 626  *
 627  * copyright notice of the data (string)
 628  */
 629 #define MM_PLAYER_TAG_COPYRIGHT                         "tag_copyright"
 630 /**
 631  * MM_PLAYER_TAG_ARTIST
 632  *
 633  * date the data was created (string)
 634  */
 635 #define MM_PLAYER_TAG_DATE                                      "tag_date"
 636 /**
 637  * MM_PLAYER_TAG_ARTIST
 638  *
 639  * short text describing the content of the data (string)
 640  */
 641 #define MM_PLAYER_TAG_DESCRIPRION                               "tag_description"
 642 /**
 643  * MM_PLAYER_TAG_ARTIST
 644  *
 645  * track number inside a collection (int)
 646  */
 647 #define MM_PLAYER_TAG_TRACK_NUM                         "tag_track_num"
 648 /**
 649  * MM_PLAYER_PD_MODE
 650  *
 651  * progressive download mode (int)
 652  */
 653 #define MM_PLAYER_PD_MODE                                               "pd_mode"
 654
 655 /**
 656  * MM_PLAYER_DRC_MODE
 657  *
 658  * dynamic resolution change mode (int)
 659  */
 660 #define MM_PLAYER_DRC_MODE                                              "drc_mode"
 661
 662 /**
 663  * MM_PLAYER_GAPLESS
 664  *
 665  * gapless playback mode (int)
 666  */
 667 #define MM_PLAYER_GAPLESS_MODE                                  "gapless_mode"
 668
 669 #define BUFFER_MAX_PLANE_NUM (4)
 670
 671 typedef struct {
 672         MMPixelFormatType format;                       /**< image format */
 673         int width;                                              /**< width of video buffer */
 674         int height;                                             /**< height of video buffer */
 675         unsigned int timestamp;                         /**< timestamp of stream buffer (msec)*/
 676         unsigned int length_total;                      /**< total length of stream buffer (in byte)*/
 677         void *data[BUFFER_MAX_PLANE_NUM];
 678         void *bo[BUFFER_MAX_PLANE_NUM];  /**< TBM buffer object */
 679         void *internal_buffer;                          /**< Internal buffer pointer */
 680         int stride[BUFFER_MAX_PLANE_NUM];               /**< stride of plane */
 681         int elevation[BUFFER_MAX_PLANE_NUM];    /**< elevation of plane */
 682 }MMPlayerVideoStreamDataType;
 683
 684 /**
 685  * Enumerations of player state.
 686  */
 687 typedef enum {
 688         MM_PLAYER_STATE_NULL,                           /**< Player is created, but not realized yet */
 689         MM_PLAYER_STATE_READY,                          /**< Player is ready to play media */
 690         MM_PLAYER_STATE_PLAYING,                        /**< Player is now playing media */
 691         MM_PLAYER_STATE_PAUSED,                         /**< Player is paused while playing media */
 692         MM_PLAYER_STATE_NONE,                           /**< Player is not created yet */
 693         MM_PLAYER_STATE_NUM,                            /**< Number of player states */
 694 } MMPlayerStateType;
 695
 696 /**
 697  * Enumerations of position formats.
 698  * Used while invoking mm_player_get_position/mm_player_set_position APIs
 699  */
 700 typedef enum {
 701         MM_PLAYER_POS_FORMAT_TIME,                      /**< Format for time based */
 702         MM_PLAYER_POS_FORMAT_PERCENT,                   /**< Format for percentage */
 703         MM_PLAYER_POS_FORMAT_NUM,                       /**< Number of position formats */
 704 } MMPlayerPosFormatType;
 705
 706 /**
 707  * Enumeration for attribute values types.
 708  */
 709 typedef enum {
 710  MM_PLAYER_ATTRS_TYPE_INVALID = -1,        /**< Type is invalid */
 711  MM_PLAYER_ATTRS_TYPE_INT,                 /**< Integer type */
 712  MM_PLAYER_ATTRS_TYPE_DOUBLE,              /**< Double type */
 713  MM_PLAYER_ATTRS_TYPE_STRING,              /**< UTF-8 String type */
 714  MM_PLAYER_ATTRS_TYPE_DATA,                /**< Pointer type */
 715  MM_PLAYER_ATTRS_TYPE_ARRAY,               /**< Array type */
 716  MM_PLAYER_ATTRS_TYPE_RANGE,               /**< Range type */
 717  MM_PLAYER_ATTRS_TYPE_NUM,                 /**< Number of attribute type */
 718 } MMPlayerAttrsType;
 719
 720 /**
 721  * Enumeration for attribute validation type.
 722  */
 723 typedef enum {
 724  MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1,               /**< Invalid validation type */
 725  MM_PLAYER_ATTRS_VALID_TYPE_NONE,                               /**< Do not check validity */
 726  MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY,          /**< validity checking type of integer array */
 727  MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE,          /**< validity checking type of integer range */
 728  MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY,               /**< validity checking type of double array */
 729  MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE,       /**< validity checking type of double range */
 730 } MMPlayerAttrsValidType;
 731
 732 /**
 733  * Enumeration for attribute access flag.
 734  */
 735 typedef enum {
 736  MM_PLAYER_ATTRS_FLAG_NONE = 0,                                 /**< None flag is set */
 737  MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0,                        /**< Readable */
 738  MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1,                        /**< Writable */
 739  MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2,                        /**< Modified */
 740
 741  MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
 742 } MMPlayerAttrsFlag;
 743
 744 /**
 745  * Enumeration for progressive download
 746  */
 747 typedef enum {
 748         MM_PLAYER_PD_MODE_NONE,
 749         MM_PLAYER_PD_MODE_URI,
 750         MM_PLAYER_PD_MODE_FILE  // not tested yet, because of no fixed scenario
 751 }MMPlayerPDMode;
 752
 753 /**
 754  * Enumeration of track types
 755  */
 756 typedef enum {
 757         MM_PLAYER_TRACK_TYPE_AUDIO = 0,
 758         MM_PLAYER_TRACK_TYPE_VIDEO,
 759         MM_PLAYER_TRACK_TYPE_TEXT,
 760         MM_PLAYER_TRACK_TYPE_MAX
 761 }MMPlayerTrackType;
 762
 763 /**
 764  * Enumeration of runtime buffering mode
 765  */
 766 typedef enum {
 767         MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0,  /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
 768         MM_PLAYER_BUFFERING_MODE_FIXED,                 /**< player will set buffer size with this fixed size value. */
 769         MM_PLAYER_BUFFERING_MODE_SLINK,                 /**< If buffering is occurred, player will adjust buffer setting and no more buffering will be occurred again. */
 770         MM_PLAYER_BUFFERING_MODE_MAX = MM_PLAYER_BUFFERING_MODE_SLINK,
 771 }MMPlayerBufferingMode;
 772
 773 /**
 774  * Enumeration of audio channel for video share
 775  */
 776 typedef enum
 777 {
 778         MM_PLAYER_AUDIO_CH_MONO_LEFT = 0,
 779         MM_PLAYER_AUDIO_CH_MONO_RIGHT,
 780         MM_PLAYER_AUDIO_CH_STEREO,
 781 } MMPlayerAudioChannel;
 782
 783 typedef enum
 784 {
 785         MM_PLAYER_FOCUS_CHANGED_COMPLETED = 0,
 786         MM_PLAYER_FOCUS_CHANGED_BY_MEDIA,
 787         MM_PLAYER_FOCUS_CHANGED_BY_CALL,
 788         MM_PLAYER_FOCUS_CHANGED_BY_EARJACK_UNPLUG,
 789         MM_PLAYER_FOCUS_CHANGED_BY_RESOURCE_CONFLICT,
 790         MM_PLAYER_FOCUS_CHANGED_BY_ALARM,
 791         MM_PLAYER_FOCUS_CHANGED_BY_EMERGENCY,
 792         MM_PLAYER_FOCUS_CHANGED_BY_NOTIFICATION,
 793         MM_PLAYER_FOCUS_CHANGED_BY_UNKNOWN,
 794 } MMPlayerFocusChangedMsg;
 795
 796
 797 /**
 798  * Edge Properties of the text.
 799  */
 800 typedef enum {
 801         MM_PLAYER_EDGE_NO,
 802         MM_PLAYER_EDGE_RAISED,
 803         MM_PLAYER_EDGE_DEPRESSED,
 804         MM_PLAYER_EDGE_UNIFORM,
 805         MM_PLAYER_EDGE_DROPSHADOW
 806 } MMPlayerSubtitleEdge;
 807
 808 /**
 809  * Enumeration of media stream buffer status
 810  */
 811 typedef enum
 812 {
 813         MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
 814         MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
 815 } MMPlayerMediaStreamBufferStatus;
 816
 817 /**
 818  * Enumeration for stream type.
 819  */
 820 typedef enum
 821 {
 822         MM_PLAYER_STREAM_TYPE_DEFAULT,  /**< Container type */
 823         MM_PLAYER_STREAM_TYPE_AUDIO,    /**< Audio element stream type */
 824         MM_PLAYER_STREAM_TYPE_VIDEO,    /**< Video element stream type */
 825         MM_PLAYER_STREAM_TYPE_TEXT,     /**< Text type */
 826         MM_PLAYER_STREAM_TYPE_MAX,
 827 } MMPlayerStreamType;
 828
 829 /**
 830  * Enumeration for pipeline type.
 831  */
 832 typedef enum
 833 {
 834         MM_PLAYER_PIPELINE_LEGACY,      /**< Legacy pipeline */
 835         MM_PLAYER_PIPELINE_SERVER,      /**< Pipeline for server(src,decoder,demux...) */
 836         MM_PLAYER_PIPELINE_CLIENT,      /**< Pipeline for client(sink)*/
 837         MM_PLAYER_PIPELINE_MAX
 838 } MMPlayerPipelineType;
 839
 840 /**
 841  * Attribute validity structure
 842  */
 843 typedef struct {
 844          MMPlayerAttrsType type;
 845          MMPlayerAttrsValidType validity_type;
 846          MMPlayerAttrsFlag flag;
 847         /**
 848           * a union that describes validity of the attribute.
 849           * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
 850           * the attribute can have validity.
 851          */
 852          union {
 853                 /**
 854                    * Validity structure for integer array.
 855                  */
 856                 struct {
 857                         int *array;  /**< a pointer of array */
 858                         int count;   /**< size of array */
 859                         int d_val;
 860                 } int_array;
 861                 /**
 862                    * Validity structure for integer range.
 863                  */
 864                 struct {
 865                         int min;   /**< minimum range */
 866                         int max;   /**< maximum range */
 867                         int d_val;
 868                 } int_range;
 869                 /**
 870                 * Validity structure for double array.
 871                 */
 872                 struct {
 873                         double   * array;  /**< a pointer of array */
 874                         int    count;   /**< size of array */
 875                         double d_val;
 876                 } double_array;
 877                 /**
 878                 * Validity structure for double range.
 879                 */
 880                 struct {
 881                         double   min;   /**< minimum range */
 882                         double   max;   /**< maximum range */
 883                         double d_val;
 884                 } double_range;
 885         };
 886 } MMPlayerAttrsInfo;
 887
 888 /**
 889  * Volume type.
 890  *
 891  * @see         mm_player_set_volume, mm_player_get_volume
 892  */
 893 typedef struct {
 894         float   level[MM_VOLUME_CHANNEL_NUM];   /**< Relative volume factor for each channels */
 895 } MMPlayerVolumeType;
 896
 897 /**
 898  * Video stream info in external demux case
 899  *
 900 **/
 901 typedef struct _VideoStreamInfo
 902 {
 903         const char *mime;
 904         unsigned int framerate_num;
 905         unsigned int framerate_den;
 906         unsigned int width;
 907         unsigned int height;
 908         unsigned char *codec_extradata;
 909         unsigned int extradata_size;
 910         unsigned int version;
 911 }MMPlayerVideoStreamInfo;
 912
 913 /**
 914  * Audio stream info in external demux case
 915  *
 916 **/
 917 typedef struct _AudioStreamInfo
 918 {
 919         const char *mime;
 920         unsigned int channels;
 921         unsigned int sample_rate;
 922         unsigned char *codec_extradata;
 923         unsigned int extradata_size;
 924         unsigned int version;
 925         unsigned int user_info;
 926
 927         /* for pcm */
 928 //      unsigned int width;
 929 //      unsigned int depth;
 930 //      unsigned int endianness;
 931 //      bool signedness;
 932 }MMPlayerAudioStreamInfo;
 933
 934 /**
 935  * Subtitle stream info in external demux case
 936  *
 937 **/
 938 typedef struct _SubtitleStreamInfo
 939 {
 940         const char *mime;
 941         unsigned int codec_tag;
 942         void *context;  //for smpte text
 943 }MMPlayerSubtitleStreamInfo;
 944
 945 /**
 946  * Audio stream callback function type.
 947  *
 948  * @param       stream          [in]    Reference pointer to audio frame data
 949  * @param       stream_size     [in]    Size of audio frame data
 950  * @param       user_param      [in]    User defined parameter which is passed when set
 951  *                                                              audio stream callback
 952  *
 953  * @return      This callback function have to return MM_ERROR_NONE.
 954  */
 955 typedef bool    (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
 956
 957
 958 /**
 959  * selected subtitle track number callback function type.
 960  *
 961  * @param       track_num       [in]    Track number of subtitle
 962  * @param       user_param      [in]    User defined parameter
 963  *
 964  *
 965  * @return      This callback function have to return MM_ERROR_NONE.
 966  */
 967 typedef bool            (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
 968
 969 /**
 970  * Buffer underrun / overflow data callback function type.
 971  *
 972  * @param       status     [in] buffer status
 973  * @param       user_param [in] User defined parameter which is passed when set
 974  *                              to enough data callback or need data callback
 975  *
 976  * @return      This callback function have to return MM_ERROR_NONE.
 977  */
 978 typedef bool    (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, unsigned long long bytes, void *user_param);
 979
 980 /**
 981  * Buffer seek data callback function type.
 982  *
 983  * @param       offset     [in] offset for the buffer playback
 984  * @param       user_param [in] User defined parameter which is passed when set
 985  *                              to seek data callback
 986  *
 987  * @return      This callback function have to return MM_ERROR_NONE.
 988  */
 989 typedef bool    (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
 990
 991 /**
 992  * Called to notify the stream changed.
 993  *
 994  * @param user_data [in] The user data passed from the callback registration function
 995  *
 996  * @return      This callback function have to return MM_ERROR_NONE.
 997  */
 998 typedef bool    (*mm_player_stream_changed_callback) (void *user_param);
 999
1000
1001 /*===========================================================================================
1002 |                                                                                           |
1003 |  GLOBAL FUNCTION PROTOTYPES                                        |
1004 |                                                                                           |
1005 ========================================================================================== */
1006
1007 /**
1008  * This function creates a player object for playing multimedia contents. \n
1009  * The attributes of player are created to get/set some values with application. \n
1010  * And, mutex, gstreamer and other resources are initialized at this time. \n
1011  * If player is created, the state will become MM_PLAYER_STATE_NULL.
1012  *
1013  * @param       player          [out]   Handle of player
1014  *
1015  * @return      This function returns zero on success, or negative value with error code. \n
1016  *                      Please refer 'mm_error.h' to know it in detail.
1017  * @pre         None
1018  * @post        MM_PLAYER_STATE_NULL
1019  * @see         mm_player_destroy
1020  * @remark      You can create multiple handles on a context at the same time. \n
1021  *                      However, player cannot guarantee proper operation because of limitation of resources, \n
1022  *                      such as audio device or display device.
1023  *
1024  * @par Example
1025  * @code
1026 char *g_err_attr_name = NULL;
1027
1028 if (mm_player_create(&g_player) != MM_ERROR_NONE)
1029 {
1030         LOGE("failed to create player\n");
1031 }
1032
1033 if (mm_player_set_attribute(g_player,
1034                                                 &g_err_attr_name,
1035                                                 "profile_uri", filename, strlen(filename),
1036                                                 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
1037                                                 NULL) != MM_ERROR_NONE)
1038 {
1039         LOGE("failed to set %s attribute\n", g_err_attr_name);
1040         free(g_err_attr_name);
1041 }
1042
1043 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1044  * @endcode
1045  */
1046 int mm_player_create(MMHandleType *player);
1047
1048 /**
1049  * This function releases player object and all resources which were created by mm_player_create(). \n
1050  * And, player handle will also be destroyed.
1051  *
1052  * @param       player          [in]    Handle of player
1053  *
1054  * @return      This function returns zero on success, or negative value with error code.
1055  * @pre         Player state may be MM_PLAYER_STATE_NULL. \n
1056  *                      But, it can be called in any state.
1057  * @post                Because handle is released, there is no any state.
1058  * @see         mm_player_create
1059  * @remark      This method can be called with a valid player handle from any state to \n
1060  *                      completely shutdown the player operation.
1061  *
1062  * @par Example
1063  * @code
1064 if (mm_player_destroy(g_player) != MM_ERROR_NONE)
1065 {
1066         LOGE("failed to destroy player\n");
1067 }
1068  * @endcode
1069  */
1070 int mm_player_destroy(MMHandleType player);
1071
1072 /**
1073  * This function register the sound focus using application PID \n
1074  * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1075  *
1076  * @param       player          [in]    Handle of player
1077  *
1078  * @return      This function returns zero on success, or negative value with error code.
1079  *
1080  * @pre         Player state should be MM_PLAYER_STATE_NULL.
1081  * @remark      None
1082  */
1083 int mm_player_sound_register(MMHandleType player, int pid);
1084
1085 /**
1086  * This function parses uri and makes gstreamer pipeline by uri scheme. \n
1087  * So, uri should be set before realizing with mm_player_set_attribute(). \n
1088  *
1089  * @param       player          [in]    Handle of player
1090  *
1091  * @return      This function returns zero on success, or negative value with error code.
1092  *
1093  * @pre         Player state should be MM_PLAYER_STATE_NULL.
1094  * @post                Player state will be MM_PLAYER_STATE_READY.
1095  * @see         mm_player_unrealize
1096  * @remark      None
1097  * @par Example
1098  * @code
1099 if (mm_player_realize(g_player) != MM_ERROR_NONE)
1100 {
1101         LOGE("failed to realize player\n");
1102 }
1103  * @endcode
1104  */
1105 int mm_player_realize(MMHandleType player) ;
1106
1107 /**
1108  * This function uninitializes player object. So, resources and allocated memory \n
1109  * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
1110  * other contents, player should be created again after destruction or realized with new uri.
1111  *
1112  * @param       player          [in]    Handle of player
1113  *
1114  * @return      This function returns zero on success, or negative value with error code.
1115  * @pre         Player state may be MM_PLAYER_STATE_READY to unrealize. \n
1116  *                      But, it can be called in any state.
1117  * @post                Player state will be MM_PLAYER_STATE_NULL.
1118  * @see         mm_player_realize
1119  * @remark      This method can be called with a valid player handle from any state.
1120  *
1121  * @par Example
1122  * @code
1123 if (mm_player_unrealize(g_player) != MM_ERROR_NONE)
1124 {
1125         LOGE("failed to unrealize player\n");
1126 }
1127  * @endcode
1128  */
1129 int mm_player_unrealize(MMHandleType player);
1130
1131 /**
1132  * This function is to get current state of player. \n
1133  * Application have to check current state before doing some action.
1134  *
1135  * @param       player          [in]    Handle of player
1136  * @param       state       [out] current state of player on success
1137  *
1138  * @return      This function returns zero on success, or negative value with error code.
1139  *
1140  * @see         MMPlayerStateType
1141  * @remark      None
1142  * @par Example
1143  * @code
1144 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE)
1145 {
1146         LOGE("failed to get state\n");
1147 }
1148  * @endcode
1149  */
1150 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
1151
1152 /**
1153  * This function is to set relative volume of player. \n
1154  * So, It controls logical volume value. \n
1155  * But, if developer want to change system volume, mm sound api should be used.
1156  *
1157  * @param       player          [in]    Handle of player
1158  * @param       volume          [in]    Volume factor of each channel
1159  *
1160  * @return      This function returns zero on success, or negative value with error code.
1161  * @see         MMPlayerVolumeType, mm_player_get_volume
1162  * @remark      The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
1163  * @par Example
1164  * @code
1165 MMPlayerVolumeType volume;
1166 int i = 0;
1167
1168 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1169         volume.level[i] = MM_VOLUME_LEVEL_MAX;
1170
1171 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
1172 {
1173     LOGE("failed to set volume\n");
1174 }
1175  * @endcode
1176  */
1177 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
1178
1179 /**
1180  * This function is to get current volume factor of player.
1181  *
1182  * @param       player          [in]    Handle of player.
1183  * @param       volume          [out]   Volume factor of each channel.
1184  *
1185  * @return      This function returns zero on success, or negative value with error code.
1186  *
1187  * @see         MMPlayerVolumeType, mm_player_set_volume
1188  * @remark      None
1189  * @par Example
1190  * @code
1191 MMPlayerVolumeType volume;
1192 int i;
1193
1194 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
1195 {
1196         LOGW("failed to get volume\n");
1197 }
1198
1199 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1200         LOGD("channel[%d] = %d \n", i, volume.level[i]);
1201  * @endcode
1202  */
1203 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
1204
1205 /**
1206  * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
1207  * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
1208  * by mm_player_set_message_callback().
1209  *
1210  * @param       player          [in]    Handle of player
1211  *
1212  * @return      This function returns zero on success, or negative value with error code.
1213  * @remark
1214  *
1215  * @pre         Player state may be MM_PLAYER_STATE_READY.
1216  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
1217  * @see         mm_player_stop
1218  * @remark      None
1219  * @par Example
1220  * @code
1221 if (mm_player_start(g_player) != MM_ERROR_NONE)
1222 {
1223         LOGE("failed to start player\n");
1224 }
1225  * @endcode
1226  */
1227 int mm_player_start(MMHandleType player);
1228
1229 /**
1230  * This function is to stop playing media contents and it's different with pause. \n
1231  * If mm_player_start() is called after this, content will be started again from the beginning. \n
1232  * So, it can be used to close current playback.
1233  *
1234  * @param       player          [in]    Handle of player
1235  *
1236  * @return      This function returns zero on success, or negative value with error code.
1237  *
1238  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
1239  * @post                Player state will be MM_PLAYER_STATE_READY.
1240  * @see         mm_player_start
1241  * @remark      None
1242  * @par Example
1243  * @code
1244 if (mm_player_stop(g_player) != MM_ERROR_NONE)
1245 {
1246         LOGE("failed to stop player\n");
1247 }
1248  * @endcode
1249  */
1250 int mm_player_stop(MMHandleType player);
1251
1252 /**
1253  * This function is to pause playing media contents.
1254  *
1255  * @param       player          [in]    Handle of player.
1256  *
1257  * @return      This function returns zero on success, or negative value with error code.
1258  *
1259  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
1260  * @post                Player state will be MM_PLAYER_STATE_PAUSED.
1261  * @see         mm_player_resume
1262  * @remark      None
1263  * @par Example
1264  * @code
1265 if (mm_player_pause(g_player) != MM_ERROR_NONE)
1266 {
1267         LOGE("failed to pause player\n");
1268 }
1269  * @endcode
1270  */
1271 int mm_player_pause(MMHandleType player);
1272
1273 /**
1274  * This function is to resume paused media contents.
1275  *
1276  * @param       player          [in]    Handle of player.
1277  *
1278  * @return      This function returns zero on success, or negative value with error code.
1279  *
1280  * @pre         Player state may be MM_PLAYER_STATE_PAUSED.
1281  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
1282  * @see         mm_player_pause
1283  * @remark      None
1284  * @par Example
1285  * @code
1286 if (mm_player_resume(g_player) != MM_ERROR_NONE)
1287 {
1288         LOGE("failed to resume player\n");
1289 }
1290  * @endcode
1291  */
1292 int mm_player_resume(MMHandleType player);
1293
1294 /**
1295  * This function is to set the position for playback. \n
1296  * So, it can be seeked to requested position. \n
1297  *
1298  * @param       player          [in]    Handle of player
1299  * @param       format          [in]    Format of position.
1300  * @param       pos                     [in]    Position for playback
1301  *
1302  * @return      This function returns zero on success, or negative value with error code.
1303  * @see         MMPlayerPosFormatType, mm_player_get_position
1304  * @remark  the unit of time-based format is millisecond and other case is percent.
1305  * @par Example
1306  * @code
1307 int position = 1000; //1sec
1308
1309 if (mm_player_set_position(g_player, MM_PLAYER_POS_FORMAT_TIME, position) != MM_ERROR_NONE)
1310 {
1311         LOGE("failed to set position\n");
1312 }
1313  * @endcode
1314  */
1315 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1316
1317 /**
1318  * This function is to get current position of playback content.
1319  *
1320  * @param       player          [in]    Handle of player.
1321  * @param       format          [in]    Format of position.
1322  * @param    pos        [out] contains current position on success or zero in case of failure.
1323  *
1324  * @return      This function returns zero on success, or negative value with errors
1325  * @see         MMPlayerPosFormatType, mm_player_set_position
1326  * @remark      the unit of time-based format is millisecond and other case is percent.
1327  * @par Example
1328  * @code
1329 int position = 0;
1330 int duration = 0;
1331
1332 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1333
1334 mm_player_get_attribute(g_player, &g_err_name, "content_duration", &duration, NULL);
1335
1336 LOGD("pos: [%d/%d] msec\n", position, duration);
1337  * @endcode
1338  */
1339 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *pos);
1340
1341 /**
1342  * This function is to get current buffer position of playback content.
1343  *
1344  * @param       player          [in]    Handle of player.
1345  * @param       format          [in]    Format of position.
1346  * @param       start_pos               [out] contains buffer start  position on success or zero in case of failure.
1347  * @param       stop_pos        [out] contains buffer current  position on success or zero in case of failure.
1348  *
1349  * @return      This function returns zero on success, or negative value with errors
1350  * @see         MMPlayerPosFormatType, mm_player_set_position
1351  * @remark      the unit of time-based format is millisecond and other case is percent.
1352  * @par Example
1353  * @code
1354 int start_pos = 0, stop_pos = 0;
1355
1356 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
1357
1358 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
1359  * @endcode
1360  */
1361 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
1362
1363 /**
1364  * This function is to activate the section repeat. If it's set, selected section will be played \n
1365  * continually before deactivating it by mm_player_deactivate_section_repeat(). \n
1366  * The unit for setting is millisecond.
1367  *
1368  * @param       player          [in]    Handle of player.
1369  * @param       start_pos               [in]    start position.
1370  * @param       end_pos                 [in]    end position.
1371  *
1372  * @return      This function returns zero on success, or negative value with error code.
1373  * @see         mm_player_deactivate_section_repeat
1374  * @remark      None
1375  * @par Example
1376  * @code
1377 int position;
1378 int endtime = 4000; //msec
1379
1380 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1381
1382 mm_player_activate_section_repeat(g_player, position, position+endtime);
1383  * @endcode
1384  */
1385 int mm_player_activate_section_repeat(MMHandleType player, int start_pos, int end_pos);
1386
1387 /**
1388  * This function is to deactivate the section repeat.
1389  *
1390  * @param       player          [in]    Handle of player.
1391  *
1392  * @return      This function returns zero on success, or negative value with error code.
1393  * @see         mm_player_activate_section_repeat
1394  * @remark      None
1395  * @par Example
1396  * @code
1397 if ( mm_player_deactivate_section_repeat(g_player) != MM_ERROR_NONE)
1398 {
1399         LOGW("failed to deactivate section repeat\n");
1400 }
1401  * @endcode
1402  */
1403 int mm_player_deactivate_section_repeat(MMHandleType player);
1404
1405 /**
1406  * This function sets callback function for receiving messages from player.
1407  * So, player can notify warning, error and normal cases to application.
1408  *
1409  * @param       player          [in]    Handle of player.
1410  * @param       callback        [in]    Message callback function.
1411  * @param       user_param      [in]    User parameter which is passed to callback function.
1412  *
1413  * @return      This function returns zero on success, or negative value with error code.
1414  * @see         MMMessageCallback
1415  * @remark      None
1416  * @par Example
1417  * @code
1418 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1419 {
1420         switch (message)
1421         {
1422                 case MM_MESSAGE_ERROR:
1423                         //do something
1424                         break;
1425
1426                 case MM_MESSAGE_END_OF_STREAM:
1427                         //do something
1428                         break;
1429
1430                 case MM_MESSAGE_STATE_CHANGED:
1431                         //do something
1432                         break;
1433
1434                 case MM_MESSAGE_BEGIN_OF_STREAM:
1435                         //do something
1436                         break;
1437
1438                 default:
1439                         break;
1440         }
1441         return TRUE;
1442 }
1443
1444 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1445  * @endcode
1446  */
1447 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1448
1449 /**
1450  * This function set callback function for receiving audio stream from player. \n
1451  * So, application can get raw audio data and modify it. \n
1452  * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
1453  * It's only supported when audio stream is included in file. \n
1454  * So, if there is video stream or DRM content, it can't be used.
1455  *
1456  * @param       player          [in]    Handle of player.
1457  * @param       callback                [in]    Audio stream callback function.
1458  * @param       user_param      [in]    User parameter.
1459  *
1460  * @return      This function returns zero on success, or negative value with error
1461  *                      code.
1462  * @see         mm_player_audio_stream_callback
1463  * @remark      It can be used for audio playback only.
1464  * @par Example
1465  * @code
1466 bool audio_callback(void *stream, int stream_size, void *user_param)
1467 {
1468         LOGD("audio stream callback\n");
1469         return TRUE;
1470 }
1471 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
1472  * @endcode
1473  */
1474  int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
1475
1476 /**
1477  * This function is to mute volume of player
1478  *
1479  * @param       player  [in]    Handle of player
1480  * @param       mute    [in]    Mute(1) or not mute(0)
1481  *
1482  * @return      This function returns zero on success, or negative value with error code
1483  * @see         mm_player_get_mute
1484  * @remark      None
1485  * @par Example
1486  * @code
1487 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
1488 {
1489         LOGW("failed to set mute\n");
1490 }
1491  * @endcode
1492  */
1493 int mm_player_set_mute(MMHandleType player, int mute);
1494
1495 /**
1496  * This function is to get mute value of player
1497  *
1498  * @param       player  [in]    Handle of player
1499  * @param       mute    [out]   Sound is muted
1500  *
1501  * @return      This function returns zero on success, or negative value with error code
1502  * @see         mm_player_set_mute
1503  * @remark      None
1504  * @par Example
1505  * @code
1506 int mute;
1507
1508 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
1509 {
1510         LOGW("failed to get mute\n");
1511 }
1512
1513 LOGD("mute status:%d\n", mute);
1514  * @endcode
1515  */
1516 int mm_player_get_mute(MMHandleType player, int *mute);
1517
1518 /**
1519  * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
1520  * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
1521  *
1522  * @param       player  [in]    Handle of player
1523  * @param       pos             [in]    postion to be adjusted
1524  *
1525  * @return      This function returns zero on success, or negative value with error
1526  *                      code
1527  * @see         mm_player_adjust_subtitle_position
1528  * @remark      None
1529  * @par Example
1530  * @code
1531 int pos;
1532
1533 pos = 5000;
1534 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1535 {
1536         LOGW("failed to adjust subtitle postion.\n");
1537 }
1538  * @endcode
1539  */
1540
1541 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1542
1543 /**
1544  * This function is to set the offset in timestamps of video so as to bring the a/v sync
1545  * @param      player          Handle of player
1546  * @param      offset          offset to be set in milliseconds(can be positive or negative both)
1547  * postive offset to make video lag
1548  * negative offset to make video lead
1549  */
1550 int mm_player_adjust_video_position(MMHandleType player,int offset);
1551 /**
1552  * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1553  * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1554  * Player FW parses subtitle file and send text data including timestamp to application \n
1555  * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1556  * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1557  * So, it's not supported for embedded case.
1558  *
1559  * @param       player  [in]    Handle of player
1560  * @param       silent  [in]    silent(integer value except 0) or not silent(0)
1561  *
1562  * @return      This function returns zero on success, or negative value with error
1563  *                      code
1564  * @see         mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1565  * @remark      None
1566  * @par Example
1567  * @code
1568 mm_player_set_attribute(g_player,
1569                                         &g_err_name,
1570                                         "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1571                                         NULL
1572                                         );
1573
1574 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1575 {
1576         LOGW("failed to set subtitle silent\n");
1577 }
1578  * @endcode
1579  */
1580 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1581
1582 /**
1583  * This function is to get silent status of subtitle.
1584  *
1585  * @param       player  [in]    Handle of player
1586  * @param       silent  [out]   subtitle silent property
1587  *
1588  * @return      This function returns zero on success, or negative value with error
1589  *                      code
1590  * @see         mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1591  * @remark      None
1592  * @par Example
1593  * @code
1594 int silent = FALSE;
1595
1596 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1597 {
1598         LOGW("failed to set subtitle silent\n");
1599 }
1600  * @endcode
1601  */
1602 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1603
1604 /**
1605  * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1606  * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1607  *
1608  * @param       player                          [in]    Handle of player.
1609  * @param       err_attr_name                   [out]  Name of attribute which is failed to set
1610  * @param       first_attribute_name    [in]    Name of the first attribute to set
1611  * @param   ...                                 [in]    Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1612  *                                                                       But, in the case of data or string type, it should be name/value/size.
1613  *
1614  * @return      This function returns zero on success, or negative value with error code.
1615  *
1616  * @see         mm_player_get_attribute
1617  * @remark      This function must be terminated by NULL argument.
1618  *                      And, if this function is failed, err_attr_name param must be free.
1619  * @par Example
1620  * @code
1621 char *g_err_attr_name = NULL;
1622
1623 if (mm_player_set_attribute(g_player,
1624                                                 &g_err_attr_name,
1625                                                 "profile_uri", filename, strlen(filename),
1626                                                 "profile_play_count", count,
1627                                                 NULL) != MM_ERROR_NONE)
1628 {
1629         LOGW("failed to set %s attribute\n", g_err_attr_name);
1630         free(g_err_attr_name);
1631 }
1632
1633  * @endcode
1634  */
1635 int mm_player_set_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1636
1637 /**
1638  * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1639  *
1640  * @param       player                          [in]    Handle of player.
1641  * @param       err_attr_name                   [out]  Name of attribute which is failed to get
1642  * @param       first_attribute_name    [in]    Name of the first attribute to get
1643  * @param       ...                                     [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1644  *                                                                       But, in the case of data or string type, it should be name/value/size.
1645  *
1646  * @return      This function returns zero on success, or negative value with error
1647  *                      code.
1648  * @see         mm_player_set_attribute
1649  * @remark      This function must be terminated by NULL argument.
1650  *                      And, if this function is failed, err_attr_name param must be free.
1651  * @par Example
1652  * @code
1653 char *g_err_attr_name = NULL;
1654
1655 if (mm_player_get_attribute(g_player, &g_err_attr_name, "content_duration", &duration, NULL) != MM_ERROR_NONE)
1656 {
1657         LOGW("failed to set %s attribute\n", g_err_attr_name);
1658         free(g_err_attr_name);
1659 }
1660  * @endcode
1661  */
1662 int mm_player_get_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1663
1664 /**
1665  * This function is to get detail information of attribute.
1666  *
1667  * @param       player                           [in]   Handle of player.
1668  * @param   attribute_name               [in]   Name of the attribute to get
1669  * @param   info                                 [out]  Attribute infomation
1670  *
1671  * @return      This function returns zero on success, or negative value with error
1672  *                      code.
1673  *
1674  * @see         mm_player_set_attribute, mm_player_get_attribute
1675  * @remark      None
1676  * @par Example
1677  * @code
1678 if (mm_player_get_attribute_info (g_player, "display_method", &method_info) != MM_ERROR_NONE)
1679 {
1680         LOGW("failed to get info\n");
1681 }
1682
1683 LOGD("type:%d \n", method_info.type); //int, double..
1684 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1685 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1686
1687 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE)
1688 {
1689         LOGD("range min:%d\n", method_info.int_range.min);
1690         LOGD("range max:%d\n", method_info.int_range.max);
1691 }
1692  * @endcode
1693  */
1694 int mm_player_get_attribute_info(MMHandleType player,  const char *attribute_name, MMPlayerAttrsInfo *info);
1695
1696 /**
1697  * This function is to get download position and total size of progressive download
1698  *
1699  * @param       player          [in]    Handle of player.
1700  * @param       current_pos     [in]    Download position currently (bytes)
1701  * @param       total_size      [in]    Total size of file (bytes)
1702  *
1703  * @return      This function returns zero on success, or negative value with error code.
1704  *
1705  * @see
1706  * @remark
1707  * @par Example
1708  * @code
1709 guint64 current_pos = 0LLU;
1710 guint64 total_size = 0LLU;
1711
1712 if (mm_player_get_pd_status(g_player, &current_pos, &total_size, NULL) != MM_ERROR_NONE)
1713 {
1714         LOGD("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1715 }
1716  * @endcode
1717  */
1718 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1719
1720 /**
1721  * This function sets callback function for receiving messages of PD downloader.
1722  *
1723  * @param       player          [in]    Handle of player.
1724  * @param       callback                [in]    Message callback function.
1725  * @param       user_param      [in]    User parameter which is passed to callback function.
1726  *
1727  * @return      This function returns zero on success, or negative value with error code.
1728  * @see
1729  * @remark      None
1730  * @par Example
1731  * @code
1732 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1733 {
1734         switch (message)
1735         {
1736                 case MM_MESSAGE_PD_DOWNLOADER_START:
1737                         LOGD("Progressive download is started...\n");
1738                         break;
1739                 case MM_MESSAGE_PD_DOWNLOADER_END:
1740                         LOGD("Progressive download is ended...\n");
1741                         break;
1742                 default:
1743                         break;
1744         }
1745         return TRUE;
1746 }
1747
1748 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1749  * @endcode
1750  */
1751 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1752
1753 /**
1754  * This function is to get the track count
1755  *
1756  * @param       player          [in]    handle of player.
1757  * @param       track                   [in]    type of the track type
1758  * @param       info                    [out]   the count of the track
1759  *
1760  * @return      This function returns zero on success, or negative value with error
1761  *                      code.
1762  *
1763  * @see
1764  * @remark      None
1765  * @par Example
1766  * @code
1767 gint audio_count = 0;
1768
1769 if (mm_player_get_track_count (g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE)
1770 {
1771         LOGW("failed to get audio track count\n");
1772 }
1773
1774 LOGD("audio track count : %d \n", audio_count);
1775  * @endcode
1776  */
1777 int mm_player_get_track_count(MMHandleType player,  MMPlayerTrackType type, int *count);
1778
1779 /**
1780  * This function is to select the track
1781  *
1782  * @param       player          [in]    handle of player.
1783  * @param       type                    [in]    type of the track type
1784  * @param       index           [in]    the index of the track
1785  *
1786  * @return      This function returns zero on success, or negative value with error
1787  *                      code.
1788  *
1789  * @see
1790  * @remark      None
1791  */
1792 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1793 #ifdef _MULTI_TRACK
1794 /**
1795  * This function is to add the track when user want multi subtitle
1796  *
1797  * @param       player          [in]    handle of player.
1798  * @param       index           [in]    the index of the track
1799  *
1800  * @return      This function returns zero on success, or negative value with error
1801  *                      code.
1802  *
1803  * @see
1804  * @remark      None
1805  */
1806 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1807
1808 /**
1809  * This function is to remove the track when user want multi subtitle
1810  *
1811  * @param       player          [in]    handle of player.
1812  * @param       index           [in]    the index of the track
1813  *
1814  * @return      This function returns zero on success, or negative value with error
1815  *                      code.
1816  *
1817  * @see
1818  * @remark      None
1819  */
1820 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1821
1822 /**
1823  * This function is to notify which sutitle track is in use
1824  *
1825  * @param       player          [in]    handle of player.
1826  * @param       callback                        [in]    callback function to register
1827  * @param       user_data       [in]    user data to be passed to the callback function
1828  *
1829  * @return      This function returns zero on success, or negative value with error
1830  *                      code.
1831  *
1832  * @see
1833  * @remark      None
1834  */
1835 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1836 #endif
1837 /**
1838  * This function is to get the track language
1839  *
1840  * @param       player          [in]    handle of player.
1841  * @param       type                    [in]    type of the track type
1842  * @param       index           [in]    the index of the track
1843  * @param       code                    [out] language code in ISO 639-1(string)
1844  *
1845  * @return      This function returns zero on success, or negative value with error
1846  *                      code.
1847  *
1848  * @see
1849  * @remark      None
1850  */
1851 int mm_player_get_track_language_code(MMHandleType player,  MMPlayerTrackType type, int index, char **code);
1852
1853 /**
1854  * This function is to get the current running track
1855  *
1856  * @param       player          [in]    handle of player.
1857  * @param       type                    [in]    type of the track type
1858  * @param       index           [out]    the index of the track
1859  *
1860  * @return      This function returns zero on success, or negative value with error
1861  *                      code.
1862  *
1863  * @see
1864  * @remark      None
1865  */
1866
1867 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1868
1869 /**
1870  * This function is to set the buffer size for streaming playback. \n
1871  *
1872  * @param       player          [in]    Handle of player
1873  * @param       second          [in]    Size of initial buffer
1874  *
1875  * @return      This function returns zero on success, or negative value with error code.
1876  * @remark  None
1877  * @par Example
1878  * @code
1879 gint second = 10; //10sec
1880
1881 if (mm_player_set_prepare_buffering_time(g_player, second) != MM_ERROR_NONE)
1882 {
1883         LOGE("failed to set buffer size\n");
1884 }
1885  * @endcode
1886  */
1887
1888 int mm_player_set_prepare_buffering_time(MMHandleType player, int second);
1889
1890 /**
1891  * This function is to set the runtime buffering mode for streaming playback. \n
1892  *
1893  * @param       player          [in]    Handle of player
1894  * @param       mode            [in]    mode of runtime buffering
1895  * @param       second          [in]    max size of buffering
1896  *
1897  * @return      This function returns zero on success, or negative value with error code.
1898  * @remark  None
1899  * @par Example
1900  * @code
1901
1902 if (mm_player_set_runtime_buffering_mode(g_player, MM_PLAYER_BUFFERING_MODE_ADAPTIVE, 10) != MM_ERROR_NONE)
1903 {
1904         LOGE("failed to set buffering mode\n");
1905 }
1906  * @endcode
1907  */
1908
1909 int mm_player_set_runtime_buffering_mode(MMHandleType player, MMPlayerBufferingMode mode, int second);
1910
1911 /**
1912  * This function is to set the start position of zoom
1913  *
1914  * @param       player          [in]    handle of player
1915  * @param       level           [in]    level of zoom
1916  * @param       x               [in]    start x position
1917  * @param       y               [in]    start y position
1918  *
1919  * @return      This function returns zero on success, or negative value with error
1920  *                      code.
1921  *
1922  * @see
1923  * @remark      None
1924  */
1925 int mm_player_set_display_zoom(MMHandleType player, float level, int x, int y);
1926
1927 /**
1928  * This function is to get the start position of zoom
1929  *
1930  * @param       player           [in]    handle of player
1931  * @param       type            [out]    current level of zoom
1932  * @param       x               [out]    start x position
1933  * @param       y               [out]    start y position
1934  *
1935  * @return      This function returns zero on success, or negative value with error
1936  *                      code.
1937  *
1938  * @see
1939  * @remark      None
1940  */
1941 int mm_player_get_display_zoom(MMHandleType player, float *level, int *x, int *y);
1942
1943 /**
1944  * This function is to set the subtitle path
1945  *
1946  * @param       player  [in]    handle of player
1947  * @param       path    [in]    subtitle path
1948  *
1949  * @return      This function returns zero on success, or negative value with error code.
1950  *
1951  * @see
1952  * @remark      None
1953  */
1954 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1955
1956 /**
1957  * This function is to set the clock which is from master player
1958  *
1959  * @param       player  [in]    handle of player
1960  * @param       clock   [in]    clock of master player
1961  * @param       clock_delta [in]        clock difference between master and slave
1962  * @param       video_time      [in]    current playing position
1963  * @param       media_clock     [in]    media clock information
1964  * @param       audio_time      [in]    audio timestamp information
1965  * @return      This function returns zero on success, or negative value with error code.
1966  *
1967  * @see
1968  * @remark      None
1969  */
1970 int mm_player_set_video_share_master_clock(MMHandleType player, long long clock, long long clock_delta, long long video_time, long long media_clock, long long audio_time);
1971 /**
1972  * This function is to get the master clock
1973  *
1974  * @param       player          [in]    handle of player
1975  * @param       video_time      [out]   current playing position
1976  * @param       media_clock     [out]   media clock information
1977  * @param       audio_time      [out]   audio timestamp information
1978  * @return      This function returns zero on success, or negative value with error code.
1979  *
1980  * @see
1981  * @remark      None
1982  */
1983 int mm_player_get_video_share_master_clock(MMHandleType player, long long *video_time, long long *media_clock, long long *audio_time);
1984 /**
1985  * This function is to set audio channel
1986  *
1987  * @param       player          [in]    handle of player
1988  * @param       ch                      [in]    audio channel
1989  * @return      This function returns zero on success, or negative value with error code.
1990  *
1991  * @see
1992  * @remark      None
1993  */
1994 int mm_player_gst_set_audio_channel(MMHandleType player, MMPlayerAudioChannel ch);
1995
1996 /**
1997  * This function is to get the content angle
1998  *
1999  * @param       player          [in]    handle of player
2000  * @param       angle           [out]   orignal angle from content
2001  * @return      This function returns zero on success, or negative value with error code.
2002  *
2003  * @see
2004  * @remark      None
2005  */
2006 int mm_player_get_video_rotate_angle(MMHandleType player, int *angle);
2007
2008 /**
2009  * This function is to set download mode of video hub
2010  *
2011  * @param       player          [in]    handle of player
2012  * @param       mode            [in]    download mode
2013  * @return      This function returns zero on success, or negative value with error code.
2014  *
2015  * @see
2016  * @remark      None
2017  */
2018 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
2019
2020 /**
2021  * This function is to set using sync handler.
2022  *
2023  * @param       player          [in]    handle of player
2024  * @param       enable          [in]    enable/disable
2025  * @return      This function returns zero on success, or negative value with error code.
2026  *
2027  * @see
2028  * @remark      None
2029  */
2030 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
2031
2032 /**
2033  * This function is to set uri.
2034  *
2035  * @param       player          [in]    handle of player
2036  * @param       uri             [in]    uri
2037  * @return      This function returns zero on success, or negative value with error code.
2038  *
2039  * @see
2040  * @remark      None
2041  */
2042 int mm_player_set_uri(MMHandleType player, const char *uri);
2043
2044 /**
2045  * This function is to set next uri.
2046  *
2047  * @param       player          [in]    handle of player
2048  * @param       uri             [in]    uri
2049  * @return      This function returns zero on success, or negative value with error code.
2050  *
2051  * @see
2052  * @remark      None
2053  */
2054 int mm_player_set_next_uri(MMHandleType player, const char *uri);
2055
2056 /**
2057  * This function is to get next uri.
2058  *
2059  * @param       player          [in]    handle of player
2060  * @param       uri             [out]   uri
2061  * @return      This function returns zero on success, or negative value with error code.
2062  *
2063  * @see
2064  * @remark      None
2065  */
2066 int mm_player_get_next_uri(MMHandleType player, char **uri);
2067
2068 int mm_player_enable_media_packet_video_stream(MMHandleType player, bool enable);
2069
2070 /**
2071  * This function is to increase reference count of internal buffer.
2072  *
2073  * @param       buffer          [in]   video callback internal buffer
2074  * @return      This function returns buffer point;
2075  *
2076  * @see
2077  * @remark      None
2078  */
2079 void * mm_player_media_packet_video_stream_internal_buffer_ref(void *buffer);
2080
2081 /**
2082  * This function is to decrease reference count of internal buffer.
2083  *
2084  * @param       buffer          [in]   video callback internal buffer
2085  * @return      None;
2086  *
2087  * @see
2088  * @remark      None
2089  */
2090 void mm_player_media_packet_video_stream_internal_buffer_unref(void *buffer);
2091
2092 /**mm_player_submit_packet
2093  * This function is to submit buffer to appsrc.  \n
2094  * @param       player                  [in]    Handle of player.
2095  * @param       buf             [in]    buffer to be submit in appsrc in external feeder case.
2096  * @param       len                             [in]    length of buffer.
2097  * @param       pts                             [in]    timestamp of buffer.
2098  * @param       streamtype              [in]    stream type of buffer.
2099  * @return      This function returns zero on success, or negative value with error code.
2100  * @par Example
2101  *
2102  * @endcode
2103  */
2104 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
2105
2106 /**mm_player_set_video_info
2107  * This function is to set caps of src pad of video appsrc in external feeder case.  \n
2108  * @param       player                          [in]    Handle of player.
2109  * @param       media_format_h                  [in]    Video stream info.
2110  * @return      This function returns zero on success, or negative value with error code.
2111  * @par Example
2112  *
2113  * @endcode
2114  */
2115 int mm_player_set_video_info (MMHandleType player, media_format_h format);
2116
2117 /**mm_player_set_audio_info
2118  * This function is to set caps of src pad of Audio appsrc in external feeder case.  \n
2119  * @param       player                       [in]    Handle of player.
2120  * @param       media_format_h               [in]    Audio stream info.
2121  * @return      This function returns zero on success, or negative value with error code.
2122  * @par Example
2123  *
2124  * @endcode
2125  */
2126 int mm_player_set_audio_info (MMHandleType player, media_format_h format);
2127
2128 /**mm_player_set_subtitle_info
2129  * This function is to set caps of src pad of subtitle appsrc in external feeder case.  \n
2130  * @param       player                          [in]    Handle of player.
2131  * @param       subtitle_stream_info               [in]    Subtitle stream info.
2132  * @return      This function returns zero on success, or negative value with error code.
2133  * @par Example
2134  *
2135  * @endcode
2136  */
2137 int mm_player_set_subtitle_info (MMHandleType player, MMPlayerSubtitleStreamInfo *info);
2138
2139 /**
2140  * This function set callback function for receiving need or enough data message from player.
2141  *
2142  * @param       player          [in]    Handle of player.
2143  * @param       type            [in]    stream type
2144  * @param       callback        [in]    data callback function for stream type.
2145  * @param       user_param      [in]    User parameter.
2146  *
2147  * @return      This function returns zero on success, or negative value with error
2148  *                      code.
2149  * @remark
2150  * @see
2151  * @since
2152  */
2153 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
2154
2155 /**
2156  * This function set callback function for receiving seek data message from player.
2157  *
2158  * @param       player          [in]    Handle of player.
2159  * @param       type            [in]    stream type
2160  * @param       callback        [in]    Seek data callback function for stream type.
2161  * @param       user_param      [in]    User parameter.
2162  *
2163  * @return      This function returns zero on success, or negative value with error
2164  *                      code.
2165  * @remark
2166  * @see
2167  * @since
2168  */
2169 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
2170
2171 /**
2172  * This function is to set max size of buffer(appsrc).
2173  *
2174  * @param       player          [in]    Handle of player.
2175  * @param       type            [in]    stream type
2176  * @param       max_size        [in]    max bytes of buffer.
2177  *
2178  * @return      This function returns zero on success, or negative value with error
2179  *                      code.
2180  * @remark
2181  * @see
2182  * @since
2183  */
2184 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
2185
2186 /**
2187  * This function is to get max size of buffer(appsrc).
2188  *
2189  * @param       player          [in]    Handle of player.
2190  * @param       type            [in]    stream type
2191  * @param       max_size        [out]   max bytes of buffer.
2192  *
2193  * @return      This function returns zero on success, or negative value with error
2194  *                      code.
2195  * @remark
2196  * @see
2197  * @since
2198  */
2199 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
2200
2201 /**
2202  * This function is to set min percent of buffer(appsrc).
2203  *
2204  * @param       player          [in]    Handle of player.
2205  * @param       type            [in]    stream type
2206  * @param       min_percent     [in]    min percent of buffer.
2207  *
2208  * @return      This function returns zero on success, or negative value with error
2209  *                      code.
2210  * @remark
2211  * @see
2212  * @since
2213  */
2214 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
2215
2216 /**
2217  * This function is to get min percent of buffer(appsrc).
2218  *
2219  * @param       player          [in]    Handle of player.
2220  * @param       type            [in]    stream type
2221  * @param       min_percent     [out]   min percent of buffer.
2222  *
2223  * @return      This function returns zero on success, or negative value with error
2224  *                      code.
2225  * @remark
2226  * @see
2227  * @since
2228  */
2229 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
2230
2231 /**
2232  * This function set callback function for changing audio stream from player. \n
2233  * It's only supported when audio stream is included in file. \n
2234  *
2235  * @param       player   [in] Handle of player.
2236  * @param       callback [in] Audio stream changed callback function.
2237  * @param       user_param [in] User parameter.
2238  *
2239  * @return      This function returns zero on success, or negative value with error
2240  *                      code.
2241  * @see         mm_player_stream_changed_callback
2242  * @since
2243  */
2244 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2245
2246 /**
2247  * This function set callback function for changing video stream from player. \n
2248  * It's only supported when video stream is included in file. \n
2249  *
2250  * @param       player   [in] Handle of player.
2251  * @param       callback [in] Video stream changed callback function.
2252  * @param       user_param [in] User parameter.
2253  *
2254  * @return      This function returns zero on success, or negative value with error
2255  *                      code.
2256  * @see         mm_player_stream_changed_callback
2257  * @since
2258  */
2259 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2260
2261 /**
2262  * This function is to get timeout value according to the content type for muse. \n
2263  * It's only supported when video stream is included in file. \n
2264  *
2265  * @param       player  [in] Handle of player.
2266  * @param       timeout [out] timeout value (sec).
2267  *
2268  * @return      This function returns zero on success, or negative value with error
2269  *                      code.
2270  * @since 3.0
2271  */
2272 int mm_player_get_timeout(MMHandleType player, int *timeout);
2273
2274 /**
2275  * This function is to get the number of video output buffers. \n
2276  * It's only supported when video stream is included in file. \n
2277  *
2278  * @param       player  [in] Handle of player.
2279  * @param       num     [out] num of buffers.
2280  * @param       extra_num [out] extra num of buffers.
2281  *
2282  * @return      This function returns zero on success, or negative value with error
2283  *                      code.
2284  * @since 3.0
2285  */
2286 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
2287
2288 /**
2289  * This function is to set the dynamic resolution information. \n
2290  * It's only supported when video stream is included in file. \n
2291  *
2292  * @param       player  [in] Handle of player.
2293  * @param       drc     [in] dynamic resolution info of media stream data
2294  *
2295  * @return      This function returns zero on success, or negative value with error
2296  *                      code.
2297  * @since 3.0
2298  */
2299 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
2300
2301 /**
2302         @}
2303  */
2304
2305 #ifdef __cplusplus
2306         }
2307 #endif
2308
2309 #endif  /* __MM_PLAYER_H__ */