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 #define BUFFER_MAX_PLANE_NUM (4)
 656
 657 typedef struct {
 658         MMPixelFormatType format;                       /**< image format */
 659         int width;                                              /**< width of video buffer */
 660         int height;                                             /**< height of video buffer */
 661         unsigned int timestamp;                         /**< timestamp of stream buffer (msec)*/
 662         unsigned int length_total;                      /**< total length of stream buffer (in byte)*/
 663         void *data[BUFFER_MAX_PLANE_NUM];
 664         void *bo[BUFFER_MAX_PLANE_NUM];  /**< TBM buffer object */
 665         void *internal_buffer;                          /**< Internal buffer pointer */
 666         int stride[BUFFER_MAX_PLANE_NUM];               /**< stride of plane */
 667         int elevation[BUFFER_MAX_PLANE_NUM];    /**< elevation of plane */
 668 }MMPlayerVideoStreamDataType;
 669
 670 /**
 671  * Enumerations of player state.
 672  */
 673 typedef enum {
 674         MM_PLAYER_STATE_NULL,                           /**< Player is created, but not realized yet */
 675         MM_PLAYER_STATE_READY,                          /**< Player is ready to play media */
 676         MM_PLAYER_STATE_PLAYING,                        /**< Player is now playing media */
 677         MM_PLAYER_STATE_PAUSED,                         /**< Player is paused while playing media */
 678         MM_PLAYER_STATE_NONE,                           /**< Player is not created yet */
 679         MM_PLAYER_STATE_NUM,                            /**< Number of player states */
 680 } MMPlayerStateType;
 681
 682 /**
 683  * Enumerations of position formats.
 684  * Used while invoking mm_player_get_position/mm_player_set_position APIs
 685  */
 686 typedef enum {
 687         MM_PLAYER_POS_FORMAT_TIME,                      /**< Format for time based */
 688         MM_PLAYER_POS_FORMAT_PERCENT,                   /**< Format for percentage */
 689         MM_PLAYER_POS_FORMAT_NUM,                       /**< Number of position formats */
 690 } MMPlayerPosFormatType;
 691
 692 /**
 693  * Enumeration for attribute values types.
 694  */
 695 typedef enum {
 696  MM_PLAYER_ATTRS_TYPE_INVALID = -1,        /**< Type is invalid */
 697  MM_PLAYER_ATTRS_TYPE_INT,                 /**< Integer type */
 698  MM_PLAYER_ATTRS_TYPE_DOUBLE,              /**< Double type */
 699  MM_PLAYER_ATTRS_TYPE_STRING,              /**< UTF-8 String type */
 700  MM_PLAYER_ATTRS_TYPE_DATA,                /**< Pointer type */
 701  MM_PLAYER_ATTRS_TYPE_ARRAY,               /**< Array type */
 702  MM_PLAYER_ATTRS_TYPE_RANGE,               /**< Range type */
 703  MM_PLAYER_ATTRS_TYPE_NUM,                 /**< Number of attribute type */
 704 } MMPlayerAttrsType;
 705
 706 /**
 707  * Enumeration for attribute validation type.
 708  */
 709 typedef enum {
 710  MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1,               /**< Invalid validation type */
 711  MM_PLAYER_ATTRS_VALID_TYPE_NONE,                               /**< Do not check validity */
 712  MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY,          /**< validity checking type of integer array */
 713  MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE,          /**< validity checking type of integer range */
 714  MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY,               /**< validity checking type of double array */
 715  MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE,       /**< validity checking type of double range */
 716 } MMPlayerAttrsValidType;
 717
 718 /**
 719  * Enumeration for attribute access flag.
 720  */
 721 typedef enum {
 722  MM_PLAYER_ATTRS_FLAG_NONE = 0,                                 /**< None flag is set */
 723  MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0,                        /**< Readable */
 724  MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1,                        /**< Writable */
 725  MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2,                        /**< Modified */
 726
 727  MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
 728 } MMPlayerAttrsFlag;
 729
 730 /**
 731  * Enumeration for progressive download
 732  */
 733 typedef enum {
 734         MM_PLAYER_PD_MODE_NONE,
 735         MM_PLAYER_PD_MODE_URI,
 736         MM_PLAYER_PD_MODE_FILE  // not tested yet, because of no fixed scenario
 737 }MMPlayerPDMode;
 738
 739 /**
 740  * Enumeration of track types
 741  */
 742 typedef enum {
 743         MM_PLAYER_TRACK_TYPE_AUDIO = 0,
 744         MM_PLAYER_TRACK_TYPE_VIDEO,
 745         MM_PLAYER_TRACK_TYPE_TEXT,
 746         MM_PLAYER_TRACK_TYPE_MAX
 747 }MMPlayerTrackType;
 748
 749 /**
 750  * Enumeration of runtime buffering mode
 751  */
 752 typedef enum {
 753         MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0,  /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
 754         MM_PLAYER_BUFFERING_MODE_FIXED,                 /**< player will set buffer size with this fixed size value. */
 755         MM_PLAYER_BUFFERING_MODE_SLINK,                 /**< If buffering is occurred, player will adjust buffer setting and no more buffering will be occurred again. */
 756         MM_PLAYER_BUFFERING_MODE_MAX = MM_PLAYER_BUFFERING_MODE_SLINK,
 757 }MMPlayerBufferingMode;
 758
 759 /**
 760  * Enumeration of audio channel for video share
 761  */
 762 typedef enum
 763 {
 764         MM_PLAYER_AUDIO_CH_MONO_LEFT = 0,
 765         MM_PLAYER_AUDIO_CH_MONO_RIGHT,
 766         MM_PLAYER_AUDIO_CH_STEREO,
 767 } MMPlayerAudioChannel;
 768
 769 typedef enum
 770 {
 771         MM_PLAYER_SOUND_RESOURCE_PRELISTENING_RINGTONE = 0,
 772         MM_PLAYER_SOUND_RESOURCE_PRELISTENING_NOTIFICATION,
 773         MM_PLAYER_SOUND_RESOURCE_PRELISTENING_ALARM,
 774         MM_PLAYER_SOUND_RESOURCE_PRELISTENING_MEDIA,
 775 } MMPlayerSoundResource;
 776
 777 typedef enum
 778 {
 779         MM_PLAYER_FOCUS_CHANGED_COMPLETED = 0,
 780         MM_PLAYER_FOCUS_CHANGED_BY_MEDIA,
 781         MM_PLAYER_FOCUS_CHANGED_BY_CALL,
 782         MM_PLAYER_FOCUS_CHANGED_BY_EARJACK_UNPLUG,
 783         MM_PLAYER_FOCUS_CHANGED_BY_RESOURCE_CONFLICT,
 784         MM_PLAYER_FOCUS_CHANGED_BY_ALARM,
 785         MM_PLAYER_FOCUS_CHANGED_BY_EMERGENCY,
 786         MM_PLAYER_FOCUS_CHANGED_BY_NOTIFICATION,
 787         MM_PLAYER_FOCUS_CHANGED_BY_UNKNOWN,
 788 } MMPlayerFocusChangedMsg;
 789
 790
 791 /**
 792  * Edge Properties of the text.
 793  */
 794 typedef enum {
 795         MM_PLAYER_EDGE_NO,
 796         MM_PLAYER_EDGE_RAISED,
 797         MM_PLAYER_EDGE_DEPRESSED,
 798         MM_PLAYER_EDGE_UNIFORM,
 799         MM_PLAYER_EDGE_DROPSHADOW
 800 } MMPlayerSubtitleEdge;
 801
 802 /**
 803  * Enumeration of media stream buffer status
 804  */
 805 typedef enum
 806 {
 807         MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
 808         MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
 809 } MMPlayerMediaStreamBufferStatus;
 810
 811 /**
 812  * Enumeration for stream type.
 813  */
 814 typedef enum
 815 {
 816         MM_PLAYER_STREAM_TYPE_DEFAULT,  /**< Container type */
 817         MM_PLAYER_STREAM_TYPE_AUDIO,    /**< Audio element stream type */
 818         MM_PLAYER_STREAM_TYPE_VIDEO,    /**< Video element stream type */
 819         MM_PLAYER_STREAM_TYPE_TEXT,     /**< Text type */
 820         MM_PLAYER_STREAM_TYPE_MAX,
 821 } MMPlayerStreamType;
 822
 823 /**
 824  * Attribute validity structure
 825  */
 826 typedef struct {
 827          MMPlayerAttrsType type;
 828          MMPlayerAttrsValidType validity_type;
 829          MMPlayerAttrsFlag flag;
 830         /**
 831           * a union that describes validity of the attribute.
 832           * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
 833           * the attribute can have validity.
 834          */
 835          union {
 836                 /**
 837                    * Validity structure for integer array.
 838                  */
 839                 struct {
 840                         int *array;  /**< a pointer of array */
 841                         int count;   /**< size of array */
 842                         int d_val;
 843                 } int_array;
 844                 /**
 845                    * Validity structure for integer range.
 846                  */
 847                 struct {
 848                         int min;   /**< minimum range */
 849                         int max;   /**< maximum range */
 850                         int d_val;
 851                 } int_range;
 852                 /**
 853                 * Validity structure for double array.
 854                 */
 855                 struct {
 856                         double   * array;  /**< a pointer of array */
 857                         int    count;   /**< size of array */
 858                         double d_val;
 859                 } double_array;
 860                 /**
 861                 * Validity structure for double range.
 862                 */
 863                 struct {
 864                         double   min;   /**< minimum range */
 865                         double   max;   /**< maximum range */
 866                         double d_val;
 867                 } double_range;
 868         };
 869 } MMPlayerAttrsInfo;
 870
 871 /**
 872  * Volume type.
 873  *
 874  * @see         mm_player_set_volume, mm_player_get_volume
 875  */
 876 typedef struct {
 877         float   level[MM_VOLUME_CHANNEL_NUM];   /**< Relative volume factor for each channels */
 878 } MMPlayerVolumeType;
 879
 880 /**
 881  * Video stream info in external demux case
 882  *
 883 **/
 884 typedef struct _VideoStreamInfo
 885 {
 886         const char *mime;
 887         unsigned int framerate_num;
 888         unsigned int framerate_den;
 889         unsigned int width;
 890         unsigned int height;
 891         unsigned char *codec_extradata;
 892         unsigned int extradata_size;
 893         unsigned int version;
 894 }MMPlayerVideoStreamInfo;
 895
 896 /**
 897  * Audio stream info in external demux case
 898  *
 899 **/
 900 typedef struct _AudioStreamInfo
 901 {
 902         const char *mime;
 903         unsigned int channels;
 904         unsigned int sample_rate;
 905         unsigned char *codec_extradata;
 906         unsigned int extradata_size;
 907         unsigned int version;
 908         unsigned int user_info;
 909
 910         /* for pcm */
 911 //      unsigned int width;
 912 //      unsigned int depth;
 913 //      unsigned int endianness;
 914 //      bool signedness;
 915 }MMPlayerAudioStreamInfo;
 916
 917 /**
 918  * Subtitle stream info in external demux case
 919  *
 920 **/
 921 typedef struct _SubtitleStreamInfo
 922 {
 923         const char *mime;
 924         unsigned int codec_tag;
 925         void *context;  //for smpte text
 926 }MMPlayerSubtitleStreamInfo;
 927
 928 /**
 929  * Audio stream callback function type.
 930  *
 931  * @param       stream          [in]    Reference pointer to audio frame data
 932  * @param       stream_size     [in]    Size of audio frame data
 933  * @param       user_param      [in]    User defined parameter which is passed when set
 934  *                                                              audio stream callback
 935  *
 936  * @return      This callback function have to return MM_ERROR_NONE.
 937  */
 938 typedef bool    (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
 939
 940
 941 /**
 942  * selected subtitle track number callback function type.
 943  *
 944  * @param       track_num       [in]    Track number of subtitle
 945  * @param       user_param      [in]    User defined parameter
 946  *
 947  *
 948  * @return      This callback function have to return MM_ERROR_NONE.
 949  */
 950 typedef bool            (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
 951
 952 /**
 953  * Buffer underrun / overflow data callback function type.
 954  *
 955  * @param       status     [in] buffer status
 956  * @param       user_param [in] User defined parameter which is passed when set
 957  *                              to enough data callback or need data callback
 958  *
 959  * @return      This callback function have to return MM_ERROR_NONE.
 960  */
 961 typedef bool    (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, void *user_param);
 962
 963 /**
 964  * Buffer seek data callback function type.
 965  *
 966  * @param       offset     [in] offset for the buffer playback
 967  * @param       user_param [in] User defined parameter which is passed when set
 968  *                              to seek data callback
 969  *
 970  * @return      This callback function have to return MM_ERROR_NONE.
 971  */
 972 typedef bool    (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
 973
 974 /**
 975  * Called to notify the stream changed.
 976  *
 977  * @param user_data [in] The user data passed from the callback registration function
 978  *
 979  * @return      This callback function have to return MM_ERROR_NONE.
 980  */
 981 typedef bool    (*mm_player_stream_changed_callback) (void *user_param);
 982
 983
 984 /*===========================================================================================
 985 |                                                                                           |
 986 |  GLOBAL FUNCTION PROTOTYPES                                        |
 987 |                                                                                           |
 988 ========================================================================================== */
 989
 990 /**
 991  * This function creates a player object for playing multimedia contents. \n
 992  * The attributes of player are created to get/set some values with application. \n
 993  * And, mutex, gstreamer and other resources are initialized at this time. \n
 994  * If player is created, the state will become MM_PLAYER_STATE_NULL.
 995  *
 996  * @param       player          [out]   Handle of player
 997  *
 998  * @return      This function returns zero on success, or negative value with error code. \n
 999  *                      Please refer 'mm_error.h' to know it in detail.
1000  * @pre         None
1001  * @post        MM_PLAYER_STATE_NULL
1002  * @see         mm_player_destroy
1003  * @remark      You can create multiple handles on a context at the same time. \n
1004  *                      However, player cannot guarantee proper operation because of limitation of resources, \n
1005  *                      such as audio device or display device.
1006  *
1007  * @par Example
1008  * @code
1009 char *g_err_attr_name = NULL;
1010
1011 if (mm_player_create(&g_player) != MM_ERROR_NONE)
1012 {
1013         debug_error("failed to create player\n");
1014 }
1015
1016 if (mm_player_set_attribute(g_player,
1017                                                 &g_err_attr_name,
1018                                                 "profile_uri", filename, strlen(filename),
1019                                                 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
1020                                                 NULL) != MM_ERROR_NONE)
1021 {
1022         debug_error("failed to set %s attribute\n", g_err_attr_name);
1023         free(g_err_attr_name);
1024 }
1025
1026 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1027  * @endcode
1028  */
1029 int mm_player_create(MMHandleType *player);
1030
1031 /**
1032  * This function releases player object and all resources which were created by mm_player_create(). \n
1033  * And, player handle will also be destroyed.
1034  *
1035  * @param       player          [in]    Handle of player
1036  *
1037  * @return      This function returns zero on success, or negative value with error code.
1038  * @pre         Player state may be MM_PLAYER_STATE_NULL. \n
1039  *                      But, it can be called in any state.
1040  * @post                Because handle is released, there is no any state.
1041  * @see         mm_player_create
1042  * @remark      This method can be called with a valid player handle from any state to \n
1043  *                      completely shutdown the player operation.
1044  *
1045  * @par Example
1046  * @code
1047 if (mm_player_destroy(g_player) != MM_ERROR_NONE)
1048 {
1049         debug_error("failed to destroy player\n");
1050 }
1051  * @endcode
1052  */
1053 int mm_player_destroy(MMHandleType player);
1054
1055 /**
1056  * This function parses uri and makes gstreamer pipeline by uri scheme. \n
1057  * So, uri should be set before realizing with mm_player_set_attribute(). \n
1058  *
1059  * @param       player          [in]    Handle of player
1060  *
1061  * @return      This function returns zero on success, or negative value with error code.
1062  *
1063  * @pre         Player state should be MM_PLAYER_STATE_NULL.
1064  * @post                Player state will be MM_PLAYER_STATE_READY.
1065  * @see         mm_player_unrealize
1066  * @remark      None
1067  * @par Example
1068  * @code
1069 if (mm_player_realize(g_player) != MM_ERROR_NONE)
1070 {
1071         debug_error("failed to realize player\n");
1072 }
1073  * @endcode
1074  */
1075 int mm_player_realize(MMHandleType player) ;
1076
1077 /**
1078  * This function uninitializes player object. So, resources and allocated memory \n
1079  * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
1080  * other contents, player should be created again after destruction or realized with new uri.
1081  *
1082  * @param       player          [in]    Handle of player
1083  *
1084  * @return      This function returns zero on success, or negative value with error code.
1085  * @pre         Player state may be MM_PLAYER_STATE_READY to unrealize. \n
1086  *                      But, it can be called in any state.
1087  * @post                Player state will be MM_PLAYER_STATE_NULL.
1088  * @see         mm_player_realize
1089  * @remark      This method can be called with a valid player handle from any state.
1090  *
1091  * @par Example
1092  * @code
1093 if (mm_player_unrealize(g_player) != MM_ERROR_NONE)
1094 {
1095         debug_error("failed to unrealize player\n");
1096 }
1097  * @endcode
1098  */
1099 int mm_player_unrealize(MMHandleType player);
1100
1101 /**
1102  * This function is to get current state of player. \n
1103  * Application have to check current state before doing some action.
1104  *
1105  * @param       player          [in]    Handle of player
1106  * @param       state       [out] current state of player on success
1107  *
1108  * @return      This function returns zero on success, or negative value with error code.
1109  *
1110  * @see         MMPlayerStateType
1111  * @remark      None
1112  * @par Example
1113  * @code
1114 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE)
1115 {
1116         debug_error("failed to get state\n");
1117 }
1118  * @endcode
1119  */
1120 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
1121
1122 /**
1123  * This function is to set relative volume of player. \n
1124  * So, It controls logical volume value. \n
1125  * But, if developer want to change system volume, mm sound api should be used.
1126  *
1127  * @param       player          [in]    Handle of player
1128  * @param       volume          [in]    Volume factor of each channel
1129  *
1130  * @return      This function returns zero on success, or negative value with error code.
1131  * @see         MMPlayerVolumeType, mm_player_get_volume
1132  * @remark      The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
1133  * @par Example
1134  * @code
1135 MMPlayerVolumeType volume;
1136 int i = 0;
1137
1138 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1139         volume.level[i] = MM_VOLUME_LEVEL_MAX;
1140
1141 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
1142 {
1143     debug_error("failed to set volume\n");
1144 }
1145  * @endcode
1146  */
1147 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
1148
1149 /**
1150  * This function is to get current volume factor of player.
1151  *
1152  * @param       player          [in]    Handle of player.
1153  * @param       volume          [out]   Volume factor of each channel.
1154  *
1155  * @return      This function returns zero on success, or negative value with error code.
1156  *
1157  * @see         MMPlayerVolumeType, mm_player_set_volume
1158  * @remark      None
1159  * @par Example
1160  * @code
1161 MMPlayerVolumeType volume;
1162 int i;
1163
1164 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
1165 {
1166         debug_warning("failed to get volume\n");
1167 }
1168
1169 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1170         debug_log("channel[%d] = %d \n", i, volume.level[i]);
1171  * @endcode
1172  */
1173 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
1174
1175 /**
1176  * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
1177  * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
1178  * by mm_player_set_message_callback().
1179  *
1180  * @param       player          [in]    Handle of player
1181  *
1182  * @return      This function returns zero on success, or negative value with error code.
1183  * @remark
1184  *
1185  * @pre         Player state may be MM_PLAYER_STATE_READY.
1186  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
1187  * @see         mm_player_stop
1188  * @remark      None
1189  * @par Example
1190  * @code
1191 if (mm_player_start(g_player) != MM_ERROR_NONE)
1192 {
1193         debug_error("failed to start player\n");
1194 }
1195  * @endcode
1196  */
1197 int mm_player_start(MMHandleType player);
1198
1199 /**
1200  * This function is to stop playing media contents and it's different with pause. \n
1201  * If mm_player_start() is called after this, content will be started again from the beginning. \n
1202  * So, it can be used to close current playback.
1203  *
1204  * @param       player          [in]    Handle of player
1205  *
1206  * @return      This function returns zero on success, or negative value with error code.
1207  *
1208  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
1209  * @post                Player state will be MM_PLAYER_STATE_READY.
1210  * @see         mm_player_start
1211  * @remark      None
1212  * @par Example
1213  * @code
1214 if (mm_player_stop(g_player) != MM_ERROR_NONE)
1215 {
1216         debug_error("failed to stop player\n");
1217 }
1218  * @endcode
1219  */
1220 int mm_player_stop(MMHandleType player);
1221
1222 /**
1223  * This function is to pause playing media contents.
1224  *
1225  * @param       player          [in]    Handle of player.
1226  *
1227  * @return      This function returns zero on success, or negative value with error code.
1228  *
1229  * @pre         Player state may be MM_PLAYER_STATE_PLAYING.
1230  * @post                Player state will be MM_PLAYER_STATE_PAUSED.
1231  * @see         mm_player_resume
1232  * @remark      None
1233  * @par Example
1234  * @code
1235 if (mm_player_pause(g_player) != MM_ERROR_NONE)
1236 {
1237         debug_error("failed to pause player\n");
1238 }
1239  * @endcode
1240  */
1241 int mm_player_pause(MMHandleType player);
1242
1243 /**
1244  * This function is to resume paused media contents.
1245  *
1246  * @param       player          [in]    Handle of player.
1247  *
1248  * @return      This function returns zero on success, or negative value with error code.
1249  *
1250  * @pre         Player state may be MM_PLAYER_STATE_PAUSED.
1251  * @post                Player state will be MM_PLAYER_STATE_PLAYING.
1252  * @see         mm_player_pause
1253  * @remark      None
1254  * @par Example
1255  * @code
1256 if (mm_player_resume(g_player) != MM_ERROR_NONE)
1257 {
1258         debug_error("failed to resume player\n");
1259 }
1260  * @endcode
1261  */
1262 int mm_player_resume(MMHandleType player);
1263
1264 /**
1265  * This function is to set the position for playback. \n
1266  * So, it can be seeked to requested position. \n
1267  *
1268  * @param       player          [in]    Handle of player
1269  * @param       format          [in]    Format of position.
1270  * @param       pos                     [in]    Position for playback
1271  *
1272  * @return      This function returns zero on success, or negative value with error code.
1273  * @see         MMPlayerPosFormatType, mm_player_get_position
1274  * @remark  the unit of time-based format is millisecond and other case is percent.
1275  * @par Example
1276  * @code
1277 int position = 1000; //1sec
1278
1279 if (mm_player_set_position(g_player, MM_PLAYER_POS_FORMAT_TIME, position) != MM_ERROR_NONE)
1280 {
1281         debug_error("failed to set position\n");
1282 }
1283  * @endcode
1284  */
1285 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1286
1287 /**
1288  * This function is to get current position of playback content.
1289  *
1290  * @param       player          [in]    Handle of player.
1291  * @param       format          [in]    Format of position.
1292  * @param    pos        [out] contains current position on success or zero in case of failure.
1293  *
1294  * @return      This function returns zero on success, or negative value with errors
1295  * @see         MMPlayerPosFormatType, mm_player_set_position
1296  * @remark      the unit of time-based format is millisecond and other case is percent.
1297  * @par Example
1298  * @code
1299 int position = 0;
1300 int duration = 0;
1301
1302 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1303
1304 mm_player_get_attribute(g_player, &g_err_name, "content_duration", &duration, NULL);
1305
1306 debug_log("pos: [%d/%d] msec\n", position, duration);
1307  * @endcode
1308  */
1309 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *pos);
1310
1311 /**
1312  * This function is to get current buffer position of playback content.
1313  *
1314  * @param       player          [in]    Handle of player.
1315  * @param       format          [in]    Format of position.
1316  * @param       start_pos               [out] contains buffer start  position on success or zero in case of failure.
1317  * @param       stop_pos        [out] contains buffer current  position on success or zero in case of failure.
1318  *
1319  * @return      This function returns zero on success, or negative value with errors
1320  * @see         MMPlayerPosFormatType, mm_player_set_position
1321  * @remark      the unit of time-based format is millisecond and other case is percent.
1322  * @par Example
1323  * @code
1324 int start_pos = 0, stop_pos = 0;
1325
1326 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
1327
1328 debug_log("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
1329  * @endcode
1330  */
1331 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
1332
1333 /**
1334  * This function is to activate the section repeat. If it's set, selected section will be played \n
1335  * continually before deactivating it by mm_player_deactivate_section_repeat(). \n
1336  * The unit for setting is millisecond.
1337  *
1338  * @param       player          [in]    Handle of player.
1339  * @param       start_pos               [in]    start position.
1340  * @param       end_pos                 [in]    end position.
1341  *
1342  * @return      This function returns zero on success, or negative value with error code.
1343  * @see         mm_player_deactivate_section_repeat
1344  * @remark      None
1345  * @par Example
1346  * @code
1347 int position;
1348 int endtime = 4000; //msec
1349
1350 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1351
1352 mm_player_activate_section_repeat(g_player, position, position+endtime);
1353  * @endcode
1354  */
1355 int mm_player_activate_section_repeat(MMHandleType player, int start_pos, int end_pos);
1356
1357 /**
1358  * This function is to deactivate the section repeat.
1359  *
1360  * @param       player          [in]    Handle of player.
1361  *
1362  * @return      This function returns zero on success, or negative value with error code.
1363  * @see         mm_player_activate_section_repeat
1364  * @remark      None
1365  * @par Example
1366  * @code
1367 if ( mm_player_deactivate_section_repeat(g_player) != MM_ERROR_NONE)
1368 {
1369         debug_warning("failed to deactivate section repeat\n");
1370 }
1371  * @endcode
1372  */
1373 int mm_player_deactivate_section_repeat(MMHandleType player);
1374
1375 /**
1376  * This function sets callback function for receiving messages from player.
1377  * So, player can notify warning, error and normal cases to application.
1378  *
1379  * @param       player          [in]    Handle of player.
1380  * @param       callback        [in]    Message callback function.
1381  * @param       user_param      [in]    User parameter which is passed to callback function.
1382  *
1383  * @return      This function returns zero on success, or negative value with error code.
1384  * @see         MMMessageCallback
1385  * @remark      None
1386  * @par Example
1387  * @code
1388 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1389 {
1390         switch (message)
1391         {
1392                 case MM_MESSAGE_ERROR:
1393                         //do something
1394                         break;
1395
1396                 case MM_MESSAGE_END_OF_STREAM:
1397                         //do something
1398                         break;
1399
1400                 case MM_MESSAGE_STATE_CHANGED:
1401                         //do something
1402                         break;
1403
1404                 case MM_MESSAGE_BEGIN_OF_STREAM:
1405                         //do something
1406                         break;
1407
1408                 default:
1409                         break;
1410         }
1411         return TRUE;
1412 }
1413
1414 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1415  * @endcode
1416  */
1417 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1418
1419 /**
1420  * This function set callback function for receiving audio stream from player. \n
1421  * So, application can get raw audio data and modify it. \n
1422  * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
1423  * It's only supported when audio stream is included in file. \n
1424  * So, if there is video stream or DRM content, it can't be used.
1425  *
1426  * @param       player          [in]    Handle of player.
1427  * @param       callback                [in]    Audio stream callback function.
1428  * @param       user_param      [in]    User parameter.
1429  *
1430  * @return      This function returns zero on success, or negative value with error
1431  *                      code.
1432  * @see         mm_player_audio_stream_callback
1433  * @remark      It can be used for audio playback only.
1434  * @par Example
1435  * @code
1436 bool audio_callback(void *stream, int stream_size, void *user_param)
1437 {
1438         debug_log("audio stream callback\n");
1439         return TRUE;
1440 }
1441 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
1442  * @endcode
1443  */
1444  int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
1445
1446 /**
1447  * This function is to mute volume of player
1448  *
1449  * @param       player  [in]    Handle of player
1450  * @param       mute    [in]    Mute(1) or not mute(0)
1451  *
1452  * @return      This function returns zero on success, or negative value with error code
1453  * @see         mm_player_get_mute
1454  * @remark      None
1455  * @par Example
1456  * @code
1457 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
1458 {
1459         debug_warning("failed to set mute\n");
1460 }
1461  * @endcode
1462  */
1463 int mm_player_set_mute(MMHandleType player, int mute);
1464
1465 /**
1466  * This function is to get mute value of player
1467  *
1468  * @param       player  [in]    Handle of player
1469  * @param       mute    [out]   Sound is muted
1470  *
1471  * @return      This function returns zero on success, or negative value with error code
1472  * @see         mm_player_set_mute
1473  * @remark      None
1474  * @par Example
1475  * @code
1476 int mute;
1477
1478 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
1479 {
1480         debug_warning("failed to get mute\n");
1481 }
1482
1483 debug_log("mute status:%d\n", mute);
1484  * @endcode
1485  */
1486 int mm_player_get_mute(MMHandleType player, int *mute);
1487
1488 /**
1489  * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
1490  * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
1491  *
1492  * @param       player  [in]    Handle of player
1493  * @param       pos             [in]    postion to be adjusted
1494  *
1495  * @return      This function returns zero on success, or negative value with error
1496  *                      code
1497  * @see         mm_player_adjust_subtitle_position
1498  * @remark      None
1499  * @par Example
1500  * @code
1501 int pos;
1502
1503 pos = 5000;
1504 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1505 {
1506         debug_warning("failed to adjust subtitle postion.\n");
1507 }
1508  * @endcode
1509  */
1510
1511 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1512
1513 /**
1514  * This function is to set the offset in timestamps of video so as to bring the a/v sync
1515  * @param      player          Handle of player
1516  * @param      offset          offset to be set in milliseconds(can be positive or negative both)
1517  * postive offset to make video lag
1518  * negative offset to make video lead
1519  */
1520 int mm_player_adjust_video_position(MMHandleType player,int offset);
1521 /**
1522  * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1523  * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1524  * Player FW parses subtitle file and send text data including timestamp to application \n
1525  * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1526  * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1527  * So, it's not supported for embedded case.
1528  *
1529  * @param       player  [in]    Handle of player
1530  * @param       silent  [in]    silent(integer value except 0) or not silent(0)
1531  *
1532  * @return      This function returns zero on success, or negative value with error
1533  *                      code
1534  * @see         mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1535  * @remark      None
1536  * @par Example
1537  * @code
1538 mm_player_set_attribute(g_player,
1539                                         &g_err_name,
1540                                         "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1541                                         NULL
1542                                         );
1543
1544 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1545 {
1546         debug_warning("failed to set subtitle silent\n");
1547 }
1548  * @endcode
1549  */
1550 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1551
1552 /**
1553  * This function is to get silent status of subtitle.
1554  *
1555  * @param       player  [in]    Handle of player
1556  * @param       silent  [out]   subtitle silent property
1557  *
1558  * @return      This function returns zero on success, or negative value with error
1559  *                      code
1560  * @see         mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1561  * @remark      None
1562  * @par Example
1563  * @code
1564 int silent = FALSE;
1565
1566 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1567 {
1568         debug_warning("failed to set subtitle silent\n");
1569 }
1570  * @endcode
1571  */
1572 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1573
1574 /**
1575  * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1576  * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1577  *
1578  * @param       player                          [in]    Handle of player.
1579  * @param       err_attr_name                   [out]  Name of attribute which is failed to set
1580  * @param       first_attribute_name    [in]    Name of the first attribute to set
1581  * @param   ...                                 [in]    Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1582  *                                                                       But, in the case of data or string type, it should be name/value/size.
1583  *
1584  * @return      This function returns zero on success, or negative value with error code.
1585  *
1586  * @see         mm_player_get_attribute
1587  * @remark      This function must be terminated by NULL argument.
1588  *                      And, if this function is failed, err_attr_name param must be free.
1589  * @par Example
1590  * @code
1591 char *g_err_attr_name = NULL;
1592
1593 if (mm_player_set_attribute(g_player,
1594                                                 &g_err_attr_name,
1595                                                 "profile_uri", filename, strlen(filename),
1596                                                 "profile_play_count", count,
1597                                                 NULL) != MM_ERROR_NONE)
1598 {
1599         debug_warning("failed to set %s attribute\n", g_err_attr_name);
1600         free(g_err_attr_name);
1601 }
1602
1603  * @endcode
1604  */
1605 int mm_player_set_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1606
1607 /**
1608  * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1609  *
1610  * @param       player                          [in]    Handle of player.
1611  * @param       err_attr_name                   [out]  Name of attribute which is failed to get
1612  * @param       first_attribute_name    [in]    Name of the first attribute to get
1613  * @param       ...                                     [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1614  *                                                                       But, in the case of data or string type, it should be name/value/size.
1615  *
1616  * @return      This function returns zero on success, or negative value with error
1617  *                      code.
1618  * @see         mm_player_set_attribute
1619  * @remark      This function must be terminated by NULL argument.
1620  *                      And, if this function is failed, err_attr_name param must be free.
1621  * @par Example
1622  * @code
1623 char *g_err_attr_name = NULL;
1624
1625 if (mm_player_get_attribute(g_player, &g_err_attr_name, "content_duration", &duration, NULL) != MM_ERROR_NONE)
1626 {
1627         debug_warning("failed to set %s attribute\n", g_err_attr_name);
1628         free(g_err_attr_name);
1629 }
1630  * @endcode
1631  */
1632 int mm_player_get_attribute(MMHandleType player,  char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1633
1634 /**
1635  * This function is to get detail information of attribute.
1636  *
1637  * @param       player                           [in]   Handle of player.
1638  * @param   attribute_name               [in]   Name of the attribute to get
1639  * @param   info                                 [out]  Attribute infomation
1640  *
1641  * @return      This function returns zero on success, or negative value with error
1642  *                      code.
1643  *
1644  * @see         mm_player_set_attribute, mm_player_get_attribute
1645  * @remark      None
1646  * @par Example
1647  * @code
1648 if (mm_player_get_attribute_info (g_player, "display_method", &method_info) != MM_ERROR_NONE)
1649 {
1650         debug_warning("failed to get info\n");
1651 }
1652
1653 debug_log("type:%d \n", method_info.type); //int, double..
1654 debug_log("flag:%d \n", method_info.flag); //readable, writable..
1655 debug_log("validity type:%d \n", method_info.validity_type); //range, array..
1656
1657 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE)
1658 {
1659         debug_log("range min:%d\n", method_info.int_range.min);
1660         debug_log("range max:%d\n", method_info.int_range.max);
1661 }
1662  * @endcode
1663  */
1664 int mm_player_get_attribute_info(MMHandleType player,  const char *attribute_name, MMPlayerAttrsInfo *info);
1665
1666 /**
1667  * This function is to get download position and total size of progressive download
1668  *
1669  * @param       player          [in]    Handle of player.
1670  * @param       current_pos     [in]    Download position currently (bytes)
1671  * @param       total_size      [in]    Total size of file (bytes)
1672  *
1673  * @return      This function returns zero on success, or negative value with error code.
1674  *
1675  * @see
1676  * @remark
1677  * @par Example
1678  * @code
1679 guint64 current_pos = 0LLU;
1680 guint64 total_size = 0LLU;
1681
1682 if (mm_player_get_pd_status(g_player, &current_pos, &total_size, NULL) != MM_ERROR_NONE)
1683 {
1684         debug_log("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1685 }
1686  * @endcode
1687  */
1688 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1689
1690 /**
1691  * This function sets callback function for receiving messages of PD downloader.
1692  *
1693  * @param       player          [in]    Handle of player.
1694  * @param       callback                [in]    Message callback function.
1695  * @param       user_param      [in]    User parameter which is passed to callback function.
1696  *
1697  * @return      This function returns zero on success, or negative value with error code.
1698  * @see
1699  * @remark      None
1700  * @par Example
1701  * @code
1702 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1703 {
1704         switch (message)
1705         {
1706                 case MM_MESSAGE_PD_DOWNLOADER_START:
1707                         debug_log("Progressive download is started...\n");
1708                         break;
1709                 case MM_MESSAGE_PD_DOWNLOADER_END:
1710                         debug_log("Progressive download is ended...\n");
1711                         break;
1712                 default:
1713                         break;
1714         }
1715         return TRUE;
1716 }
1717
1718 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1719  * @endcode
1720  */
1721 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1722
1723 /**
1724  * This function is to get the track count
1725  *
1726  * @param       player          [in]    handle of player.
1727  * @param       track                   [in]    type of the track type
1728  * @param       info                    [out]   the count of the track
1729  *
1730  * @return      This function returns zero on success, or negative value with error
1731  *                      code.
1732  *
1733  * @see
1734  * @remark      None
1735  * @par Example
1736  * @code
1737 gint audio_count = 0;
1738
1739 if (mm_player_get_track_count (g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE)
1740 {
1741         debug_warning("failed to get audio track count\n");
1742 }
1743
1744 debug_log("audio track count : %d \n", audio_count);
1745  * @endcode
1746  */
1747 int mm_player_get_track_count(MMHandleType player,  MMPlayerTrackType type, int *count);
1748
1749 /**
1750  * This function is to select the track
1751  *
1752  * @param       player          [in]    handle of player.
1753  * @param       type                    [in]    type of the track type
1754  * @param       index           [in]    the index of the track
1755  *
1756  * @return      This function returns zero on success, or negative value with error
1757  *                      code.
1758  *
1759  * @see
1760  * @remark      None
1761  */
1762 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1763 #ifdef _MULTI_TRACK
1764 /**
1765  * This function is to add the track when user want multi subtitle
1766  *
1767  * @param       player          [in]    handle of player.
1768  * @param       index           [in]    the index of the track
1769  *
1770  * @return      This function returns zero on success, or negative value with error
1771  *                      code.
1772  *
1773  * @see
1774  * @remark      None
1775  */
1776 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1777
1778 /**
1779  * This function is to remove the track when user want multi subtitle
1780  *
1781  * @param       player          [in]    handle of player.
1782  * @param       index           [in]    the index of the track
1783  *
1784  * @return      This function returns zero on success, or negative value with error
1785  *                      code.
1786  *
1787  * @see
1788  * @remark      None
1789  */
1790 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1791
1792 /**
1793  * This function is to notify which sutitle track is in use
1794  *
1795  * @param       player          [in]    handle of player.
1796  * @param       callback                        [in]    callback function to register
1797  * @param       user_data       [in]    user data to be passed to the callback function
1798  *
1799  * @return      This function returns zero on success, or negative value with error
1800  *                      code.
1801  *
1802  * @see
1803  * @remark      None
1804  */
1805 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1806 #endif
1807 /**
1808  * This function is to get the track language
1809  *
1810  * @param       player          [in]    handle of player.
1811  * @param       type                    [in]    type of the track type
1812  * @param       index           [in]    the index of the track
1813  * @param       code                    [out] language code in ISO 639-1(string)
1814  *
1815  * @return      This function returns zero on success, or negative value with error
1816  *                      code.
1817  *
1818  * @see
1819  * @remark      None
1820  */
1821 int mm_player_get_track_language_code(MMHandleType player,  MMPlayerTrackType type, int index, char **code);
1822
1823 /**
1824  * This function is to get the current running track
1825  *
1826  * @param       player          [in]    handle of player.
1827  * @param       type                    [in]    type of the track type
1828  * @param       index           [out]    the index of the track
1829  *
1830  * @return      This function returns zero on success, or negative value with error
1831  *                      code.
1832  *
1833  * @see
1834  * @remark      None
1835  */
1836
1837 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1838
1839 /**
1840  * This function is to set the buffer size for streaming playback. \n
1841  *
1842  * @param       player          [in]    Handle of player
1843  * @param       second          [in]    Size of initial buffer
1844  *
1845  * @return      This function returns zero on success, or negative value with error code.
1846  * @remark  None
1847  * @par Example
1848  * @code
1849 gint second = 10; //10sec
1850
1851 if (mm_player_set_prepare_buffering_time(g_player, second) != MM_ERROR_NONE)
1852 {
1853         debug_error("failed to set buffer size\n");
1854 }
1855  * @endcode
1856  */
1857
1858 int mm_player_set_prepare_buffering_time(MMHandleType player, int second);
1859
1860 /**
1861  * This function is to set the runtime buffering mode for streaming playback. \n
1862  *
1863  * @param       player          [in]    Handle of player
1864  * @param       mode            [in]    mode of runtime buffering
1865  * @param       second          [in]    max size of buffering
1866  *
1867  * @return      This function returns zero on success, or negative value with error code.
1868  * @remark  None
1869  * @par Example
1870  * @code
1871
1872 if (mm_player_set_runtime_buffering_mode(g_player, MM_PLAYER_BUFFERING_MODE_ADAPTIVE, 10) != MM_ERROR_NONE)
1873 {
1874         debug_error("failed to set buffering mode\n");
1875 }
1876  * @endcode
1877  */
1878
1879 int mm_player_set_runtime_buffering_mode(MMHandleType player, MMPlayerBufferingMode mode, int second);
1880
1881 /**
1882  * This function is to set the start position of zoom
1883  *
1884  * @param       player          [in]    handle of player
1885  * @param       level           [in]    level of zoom
1886  * @param       x               [in]    start x position
1887  * @param       y               [in]    start y position
1888  *
1889  * @return      This function returns zero on success, or negative value with error
1890  *                      code.
1891  *
1892  * @see
1893  * @remark      None
1894  */
1895 int mm_player_set_display_zoom(MMHandleType player, float level, int x, int y);
1896
1897 /**
1898  * This function is to get the start position of zoom
1899  *
1900  * @param       player           [in]    handle of player
1901  * @param       type            [out]    current level of zoom
1902  * @param       x               [out]    start x position
1903  * @param       y               [out]    start y position
1904  *
1905  * @return      This function returns zero on success, or negative value with error
1906  *                      code.
1907  *
1908  * @see
1909  * @remark      None
1910  */
1911 int mm_player_get_display_zoom(MMHandleType player, float *level, int *x, int *y);
1912
1913 /**
1914  * This function is to set the subtitle path
1915  *
1916  * @param       player  [in]    handle of player
1917  * @param       path    [in]    subtitle path
1918  *
1919  * @return      This function returns zero on success, or negative value with error code.
1920  *
1921  * @see
1922  * @remark      None
1923  */
1924 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1925
1926 /**
1927  * This function is to change clock provider to system clock
1928  *
1929  * @param       player  [in]    handle of player
1930  * @return      This function returns zero on success, or negative value with error code.
1931  *
1932  * @see
1933  * @remark      None
1934  */
1935 int mm_player_use_system_clock(MMHandleType player);
1936
1937 /**
1938  * This function is to set the clock which is from master player
1939  *
1940  * @param       player  [in]    handle of player
1941  * @param       clock   [in]    clock of master player
1942  * @param       clock_delta [in]        clock difference between master and slave
1943  * @param       video_time      [in]    current playing position
1944  * @param       media_clock     [in]    media clock information
1945  * @param       audio_time      [in]    audio timestamp information
1946  * @return      This function returns zero on success, or negative value with error code.
1947  *
1948  * @see
1949  * @remark      None
1950  */
1951 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);
1952 /**
1953  * This function is to get the master clock
1954  *
1955  * @param       player          [in]    handle of player
1956  * @param       video_time      [out]   current playing position
1957  * @param       media_clock     [out]   media clock information
1958  * @param       audio_time      [out]   audio timestamp information
1959  * @return      This function returns zero on success, or negative value with error code.
1960  *
1961  * @see
1962  * @remark      None
1963  */
1964 int mm_player_get_video_share_master_clock(MMHandleType player, long long *video_time, long long *media_clock, long long *audio_time);
1965 /**
1966  * This function is to set audio channel
1967  *
1968  * @param       player          [in]    handle of player
1969  * @param       ch                      [in]    audio channel
1970  * @return      This function returns zero on success, or negative value with error code.
1971  *
1972  * @see
1973  * @remark      None
1974  */
1975 int mm_player_gst_set_audio_channel(MMHandleType player, MMPlayerAudioChannel ch);
1976
1977 /**
1978  * This function is to get the content angle
1979  *
1980  * @param       player          [in]    handle of player
1981  * @param       angle           [out]   orignal angle from content
1982  * @return      This function returns zero on success, or negative value with error code.
1983  *
1984  * @see
1985  * @remark      None
1986  */
1987 int mm_player_get_video_rotate_angle(MMHandleType player, int *angle);
1988
1989 /**
1990  * This function is to set download mode of video hub
1991  *
1992  * @param       player          [in]    handle of player
1993  * @param       mode            [in]    download mode
1994  * @return      This function returns zero on success, or negative value with error code.
1995  *
1996  * @see
1997  * @remark      None
1998  */
1999 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
2000
2001 /**
2002  * This function is to set using sync handler.
2003  *
2004  * @param       player          [in]    handle of player
2005  * @param       enable          [in]    enable/disable
2006  * @return      This function returns zero on success, or negative value with error code.
2007  *
2008  * @see
2009  * @remark      None
2010  */
2011 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
2012
2013 /**
2014  * This function is to set uri.
2015  *
2016  * @param       player          [in]    handle of player
2017  * @param       uri             [in]    uri
2018  * @return      This function returns zero on success, or negative value with error code.
2019  *
2020  * @see
2021  * @remark      None
2022  */
2023 int mm_player_set_uri(MMHandleType player, const char *uri);
2024
2025 /**
2026  * This function is to set next uri.
2027  *
2028  * @param       player          [in]    handle of player
2029  * @param       uri             [in]    uri
2030  * @return      This function returns zero on success, or negative value with error code.
2031  *
2032  * @see
2033  * @remark      None
2034  */
2035 int mm_player_set_next_uri(MMHandleType player, const char *uri);
2036
2037 /**
2038  * This function is to get next uri.
2039  *
2040  * @param       player          [in]    handle of player
2041  * @param       uri             [out]   uri
2042  * @return      This function returns zero on success, or negative value with error code.
2043  *
2044  * @see
2045  * @remark      None
2046  */
2047 int mm_player_get_next_uri(MMHandleType player, char **uri);
2048
2049 int mm_player_enable_media_packet_video_stream(MMHandleType player, bool enable);
2050
2051 /**
2052  * This function is to increase reference count of internal buffer.
2053  *
2054  * @param       buffer          [in]   video callback internal buffer
2055  * @return      This function returns buffer point;
2056  *
2057  * @see
2058  * @remark      None
2059  */
2060 void * mm_player_media_packet_video_stream_internal_buffer_ref(void *buffer);
2061
2062 /**
2063  * This function is to decrease reference count of internal buffer.
2064  *
2065  * @param       buffer          [in]   video callback internal buffer
2066  * @return      None;
2067  *
2068  * @see
2069  * @remark      None
2070  */
2071 void mm_player_media_packet_video_stream_internal_buffer_unref(void *buffer);
2072
2073 /**mm_player_submit_packet
2074  * This function is to submit buffer to appsrc.  \n
2075  * @param       player                  [in]    Handle of player.
2076  * @param       buf             [in]    buffer to be submit in appsrc in external feeder case.
2077  * @param       len                             [in]    length of buffer.
2078  * @param       pts                             [in]    timestamp of buffer.
2079  * @param       streamtype              [in]    stream type of buffer.
2080  * @return      This function returns zero on success, or negative value with error code.
2081  * @par Example
2082  *
2083  * @endcode
2084  */
2085 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
2086
2087 /**mm_player_set_video_info
2088  * This function is to set caps of src pad of video appsrc in external feeder case.  \n
2089  * @param       player                          [in]    Handle of player.
2090  * @param       media_format_h                  [in]    Video stream info.
2091  * @return      This function returns zero on success, or negative value with error code.
2092  * @par Example
2093  *
2094  * @endcode
2095  */
2096
2097 int mm_player_set_video_info (MMHandleType player, media_format_h format);
2098
2099 /**mm_player_set_audio_info
2100  * This function is to set caps of src pad of Audio appsrc in external feeder case.  \n
2101  * @param       player                       [in]    Handle of player.
2102  * @param       media_format_h               [in]    Audio stream info.
2103  * @return      This function returns zero on success, or negative value with error code.
2104  * @par Example
2105  *
2106  * @endcode
2107  */
2108
2109 int mm_player_set_audio_info (MMHandleType player, media_format_h format);
2110
2111 /**mm_player_set_subtitle_info
2112  * This function is to set caps of src pad of subtitle appsrc in external feeder case.  \n
2113  * @param       player                          [in]    Handle of player.
2114  * @param       subtitle_stream_info               [in]    Subtitle stream info.
2115  * @return      This function returns zero on success, or negative value with error code.
2116  * @par Example
2117  *
2118  * @endcode
2119  */
2120
2121 int mm_player_set_subtitle_info (MMHandleType player, MMPlayerSubtitleStreamInfo *info);
2122
2123 /**
2124  * This function set callback function for receiving need or enough data message from player.
2125  *
2126  * @param       player          [in]    Handle of player.
2127  * @param       type            [in]    stream type
2128  * @param       callback        [in]    data callback function for stream type.
2129  * @param       user_param      [in]    User parameter.
2130  *
2131  * @return      This function returns zero on success, or negative value with error
2132  *                      code.
2133  * @remark
2134  * @see
2135  * @since
2136  */
2137 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
2138
2139 /**
2140  * This function set callback function for receiving seek data message from player.
2141  *
2142  * @param       player          [in]    Handle of player.
2143  * @param       type            [in]    stream type
2144  * @param       callback        [in]    Seek 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_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
2154
2155 /**
2156  * This function is to set max size of buffer(appsrc).
2157  *
2158  * @param       player          [in]    Handle of player.
2159  * @param       type            [in]    stream type
2160  * @param       max_size        [in]    max bytes of buffer.
2161  *
2162  * @return      This function returns zero on success, or negative value with error
2163  *                      code.
2164  * @remark
2165  * @see
2166  * @since
2167  */
2168 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
2169
2170 /**
2171  * This function is to get max size of buffer(appsrc).
2172  *
2173  * @param       player          [in]    Handle of player.
2174  * @param       type            [in]    stream type
2175  * @param       max_size        [out]   max bytes of buffer.
2176  *
2177  * @return      This function returns zero on success, or negative value with error
2178  *                      code.
2179  * @remark
2180  * @see
2181  * @since
2182  */
2183 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
2184
2185 /**
2186  * This function is to set min percent of buffer(appsrc).
2187  *
2188  * @param       player          [in]    Handle of player.
2189  * @param       type            [in]    stream type
2190  * @param       min_percent     [in]    min percent of buffer.
2191  *
2192  * @return      This function returns zero on success, or negative value with error
2193  *                      code.
2194  * @remark
2195  * @see
2196  * @since
2197  */
2198 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
2199
2200 /**
2201  * This function is to get min percent of buffer(appsrc).
2202  *
2203  * @param       player          [in]    Handle of player.
2204  * @param       type            [in]    stream type
2205  * @param       min_percent     [out]   min percent of buffer.
2206  *
2207  * @return      This function returns zero on success, or negative value with error
2208  *                      code.
2209  * @remark
2210  * @see
2211  * @since
2212  */
2213 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
2214
2215 /**
2216  * This function set callback function for changing audio stream from player. \n
2217  * It's only supported when audio stream is included in file. \n
2218  *
2219  * @param       player   [in] Handle of player.
2220  * @param       callback [in] Audio stream changed callback function.
2221  * @param       user_param [in] User parameter.
2222  *
2223  * @return      This function returns zero on success, or negative value with error
2224  *                      code.
2225  * @see         mm_player_stream_changed_callback
2226  * @since
2227  */
2228 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2229
2230 /**
2231  * This function set callback function for changing video stream from player. \n
2232  * It's only supported when video stream is included in file. \n
2233  *
2234  * @param       player   [in] Handle of player.
2235  * @param       callback [in] Video stream changed callback function.
2236  * @param       user_param [in] User parameter.
2237  *
2238  * @return      This function returns zero on success, or negative value with error
2239  *                      code.
2240  * @see         mm_player_stream_changed_callback
2241  * @since
2242  */
2243 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2244
2245 /**
2246         @}
2247  */
2248
2249 #ifdef __cplusplus
2250         }
2251 #endif
2252
2253 #endif  /* __MM_PLAYER_H__ */