4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
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>
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 #ifndef __MM_PLAYER_H__
24 #define __MM_PLAYER_H__
27 /*===========================================================================================
31 ========================================================================================== */
36 #include <mm_message.h>
37 #include <media_packet.h>
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.
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.
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.
64 Player can have 5 states, and each state can be changed by calling
65 described functions on "Figure1. State of Player".
68 @image html player_state.jpg "Figure1. State of Player" width=12cm
69 @image latex player_state.jpg "Figure1. State of Player" width=12cm
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.
78 Note that "None" and Null" state could be reached from any state
79 by calling mm_player_destroy() and mm_player_unrealize().
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>
90 <td>mm_player_create()</td>
96 <td>mm_player_destroy()</td>
102 <td>mm_player_realize()</td>
108 <td>mm_player_unrealize()</td>
114 <td>mm_player_start()</td>
120 <td>mm_player_stop()</td>
126 <td>mm_player_pause()</td>
132 <td>mm_player_resume()</td>
138 <td>mm_player_set_message_callback()</td>
144 <td>mm_player_get_state()</td>
150 <td>mm_player_set_volume()</td>
156 <td>mm_player_get_volume()</td>
162 <td>mm_player_set_position()</td>
168 <td>mm_player_get_position()</td>
174 <td>mm_player_get_attribute()</td>
180 <td>mm_player_set_attribute()</td>
188 Following are the attributes supported in player which may be set after initialization. \n
189 Those are handled as a string.
199 <td>"profile_uri"</td>
204 <td>"content_duration"</td>
209 <td>"content_video_width"</td>
214 <td>"content_video_height"</td>
219 <td>"display_evas_do_scaling"</td>
224 <td>"display_evas_surface_sink"</td>
229 <td>"profile_user_param"</td>
234 <td>"profile_play_count"</td>
239 <td>"streaming_type"</td>
244 <td>"streaming_udp_timeout"</td>
249 <td>"streaming_user_agent"</td>
254 <td>"streaming_wap_profile"</td>
259 <td>"streaming_network_bandwidth"</td>
264 <td>"streaming_cookie"</td>
269 <td>"streaming_proxy_ip"</td>
274 <td>"streaming_proxy_port"</td>
279 <td>"streaming_timeout"</td>
284 <td>"display_overlay"</td>
289 <td>"display_rotation"</td>
294 <td>"subtitle_uri"</td>
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.
312 <td>"content_video_found"</td>
317 <td>"content_video_codec"</td>
322 <td>"content_video_track_num"</td>
327 <td>"content_audio_found"</td>
332 <td>"content_audio_codec"</td>
337 <td>"content_audio_bitrate"</td>
342 <td>"content_audio_channels"</td>
347 <td>"content_audio_samplerate"</td>
352 <td>"content_audio_track_num"</td>
357 <td>"content_text_track_num"</td>
362 <td>"tag_artist"</td>
382 <td>"tag_author"</td>
387 <td>"tag_copyright"</td>
397 <td>"tag_description"</td>
402 <td>"tag_track_num"</td>
411 /*===========================================================================================
413 | GLOBAL DEFINITIONS AND DECLARATIONS |
415 ========================================================================================== */
420 * uri to play (string)
423 #define MM_PLAYER_CONTENT_URI "profile_uri"
425 * MM_PLAYER_CONTENT_DURATION:
427 * get the duration (int) as millisecond, It's guaranteed after calling mm_player_start() or
428 * receiving MM_MESSAGE_BEGIN_OF_STREAM.
431 #define MM_PLAYER_CONTENT_DURATION "content_duration"
433 * MM_PLAYER_VIDEO_ROTATION
435 * can change video angle (int)
436 * @see MMDisplayRotationType
438 #define MM_PLAYER_VIDEO_ROTATION "display_rotation"
440 * MM_PLAYER_VIDEO_WIDTH:
442 * get the video width (int), It's guaranteed after calling mm_player_start() or
443 * receiving MM_MESSAGE_BEGIN_OF_STREAM.
446 #define MM_PLAYER_VIDEO_WIDTH "content_video_width"
448 * MM_PLAYER_VIDEO_HEIGHT:
450 * get the video height (int), It's guaranteed after calling mm_player_start() or
451 * receiving MM_MESSAGE_BEGIN_OF_STREAM.
454 #define MM_PLAYER_VIDEO_HEIGHT "content_video_height"
456 * MM_PLAYER_VIDEO_EVAS_SURFACE_DO_SCALING:
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.
463 #define MM_PLAYER_VIDEO_EVAS_SURFACE_DO_SCALING "display_evas_do_scaling"
465 * MM_PLAYER_VIDEO_EVAS_SURFACE_SINK:
467 * get the video evas surface sink plugin name (string), It's guaranteed after calling mm_player_create()
470 #define MM_PLAYER_VIDEO_EVAS_SURFACE_SINK "display_evas_surface_sink"
474 * set memory pointer to play (data)
477 #define MM_PLAYER_MEMORY_SRC "profile_user_param"
479 * MM_PLAYER_PLAYBACK_COUNT
481 * can set playback count (int), Default value is 1 and -1 is for infinity playing until releasing it.
484 #define MM_PLAYER_PLAYBACK_COUNT "profile_play_count"
486 * MM_PLAYER_SUBTITLE_URI
488 * set the subtitle path (string)
490 #define MM_PLAYER_SUBTITLE_URI "subtitle_uri"
492 * MM_PLAYER_STREAMING_TYPE
494 * set the streaming type (int)
495 * @see MMStreamingType
497 #define MM_PLAYER_STREAMING_TYPE "streaming_type"
499 * MM_PLAYER_STREAMING_UDP_TIMEOUT
501 * set the streaming udp timeout(int)
503 #define MM_PLAYER_STREAMING_UDP_TIMEOUT "streaming_udp_timeout"
505 * MM_PLAYER_STREAMING_USER_AGENT
507 * set the streaming user agent (string)
509 #define MM_PLAYER_STREAMING_USER_AGENT "streaming_user_agent"
511 * MM_PLAYER_STREAMING_WAP_PROFILE
513 * set the streaming wap profile (int)
515 #define MM_PLAYER_STREAMING_WAP_PROFILE "streaming_wap_profile"
517 * MM_PLAYER_STREAMING_NET_BANDWIDTH
519 * set the streaming network bandwidth (int)
521 #define MM_PLAYER_STREAMING_NET_BANDWIDTH "streaming_network_bandwidth"
523 * MM_PLAYER_STREAMING_COOKIE
525 * set the streaming cookie (int)
527 #define MM_PLAYER_STREAMING_COOKIE "streaming_cookie"
529 * MM_PLAYER_STREAMING_PROXY_IP
531 * set the streaming proxy ip (string)
533 #define MM_PLAYER_STREAMING_PROXY_IP "streaming_proxy_ip"
535 * MM_PLAYER_STREAMING_PROXY_PORT
537 * set the streaming proxy port (int)
539 #define MM_PLAYER_STREAMING_PROXY_PORT "streaming_proxy_port"
541 * MM_PLAYER_STREAMING_TIMEOUT
543 * set the streaming timeout (int)
545 #define MM_PLAYER_STREAMING_TIMEOUT "streaming_timeout"
547 * MM_PLAYER_VIDEO_CODEC
549 * codec the video data is stored in (string)
551 #define MM_PLAYER_VIDEO_CODEC "content_video_codec"
553 * MM_PLAYER_VIDEO_TRACK_NUM
555 * track number inside a collection (int)
557 #define MM_PLAYER_VIDEO_TRACK_NUM "content_video_track_num"
559 * MM_PLAYER_AUDIO_CODEC
561 * codec the audio data is stored in (string)
563 #define MM_PLAYER_AUDIO_CODEC "content_audio_codec"
565 * MM_PLAYER_AUDIO_BITRATE
567 * set the streaming proxy port (int)
569 #define MM_PLAYER_AUDIO_BITRATE "content_audio_bitrate"
571 * MM_PLAYER_AUDIO_CHANNEL
573 * the number of audio channel (int)
575 #define MM_PLAYER_AUDIO_CHANNEL "content_audio_channels"
577 * MM_PLAYER_AUDIO_SAMPLERATE
579 * audio samplerate (int)
581 #define MM_PLAYER_AUDIO_SAMPLERATE "content_audio_samplerate"
583 * MM_PLAYER_AUDIO_TRACK_NUM
585 * track number inside a collection (int)
587 #define MM_PLAYER_AUDIO_TRACK_NUM "content_audio_track_num"
589 * MM_PLAYER_TEXT_TRACK_NUM
591 * track number inside a collection (int)
593 #define MM_PLAYER_TEXT_TRACK_NUM "content_text_track_num"
595 * MM_PLAYER_TAG_ARTIST
597 * person(s) responsible for the recording (string)
599 #define MM_PLAYER_TAG_ARTIST "tag_artist"
601 * MM_PLAYER_TAG_ARTIST
605 #define MM_PLAYER_TAG_TITLE "tag_title"
607 * MM_PLAYER_TAG_ARTIST
609 * album containing this data (string)
611 #define MM_PLAYER_TAG_ALBUM "tag_album"
613 * MM_PLAYER_TAG_ARTIST
615 * genre this data belongs to (string)
617 #define MM_PLAYER_TAG_GENRE "tag_genre"
619 * MM_PLAYER_TAG_ARTIST
623 #define MM_PLAYER_TAG_AUTHOUR "tag_author"
625 * MM_PLAYER_TAG_ARTIST
627 * copyright notice of the data (string)
629 #define MM_PLAYER_TAG_COPYRIGHT "tag_copyright"
631 * MM_PLAYER_TAG_ARTIST
633 * date the data was created (string)
635 #define MM_PLAYER_TAG_DATE "tag_date"
637 * MM_PLAYER_TAG_ARTIST
639 * short text describing the content of the data (string)
641 #define MM_PLAYER_TAG_DESCRIPRION "tag_description"
643 * MM_PLAYER_TAG_ARTIST
645 * track number inside a collection (int)
647 #define MM_PLAYER_TAG_TRACK_NUM "tag_track_num"
651 * progressive download mode (int)
653 #define MM_PLAYER_PD_MODE "pd_mode"
658 * dynamic resolution change mode (int)
660 #define MM_PLAYER_DRC_MODE "drc_mode"
663 * MM_PLAYER_GAPLESS_MODE
665 * gapless playback mode (int)
667 #define MM_PLAYER_GAPLESS_MODE "gapless_mode"
670 * MM_PLAYER_ENABLE_VIDEO_DECODED_CB
672 * enable video decoded callback (int)
674 #define MM_PLAYER_ENABLE_VIDEO_DECODED_CB "enable_video_decoded_cb"
677 * MM_PLAYER_VIDEO_CODEC_TYPE
679 * video codec type (int)
681 #define MM_PLAYER_VIDEO_CODEC_TYPE "video_codec_type"
683 #define BUFFER_MAX_PLANE_NUM (4)
686 MMPixelFormatType format; /**< image format */
687 int width; /**< width of video buffer */
688 int height; /**< height of video buffer */
689 unsigned int timestamp; /**< timestamp of stream buffer (msec)*/
690 unsigned int length_total; /**< total length of stream buffer (in byte)*/
691 void *data[BUFFER_MAX_PLANE_NUM];
692 void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
693 void *internal_buffer; /**< Internal buffer pointer */
694 int stride[BUFFER_MAX_PLANE_NUM]; /**< stride of plane */
695 int elevation[BUFFER_MAX_PLANE_NUM]; /**< elevation of plane */
696 } MMPlayerVideoStreamDataType;
699 * Enumerations of player state.
702 MM_PLAYER_STATE_NULL, /**< Player is created, but not realized yet */
703 MM_PLAYER_STATE_READY, /**< Player is ready to play media */
704 MM_PLAYER_STATE_PLAYING, /**< Player is now playing media */
705 MM_PLAYER_STATE_PAUSED, /**< Player is paused while playing media */
706 MM_PLAYER_STATE_NONE, /**< Player is not created yet */
707 MM_PLAYER_STATE_NUM, /**< Number of player states */
711 * Enumerations of position formats.
712 * Used while invoking mm_player_get_position/mm_player_set_position APIs
715 MM_PLAYER_POS_FORMAT_TIME, /**< Format for time based */
716 MM_PLAYER_POS_FORMAT_PERCENT, /**< Format for percentage */
717 MM_PLAYER_POS_FORMAT_NUM, /**< Number of position formats */
718 } MMPlayerPosFormatType;
721 * Enumeration for attribute values types.
724 MM_PLAYER_ATTRS_TYPE_INVALID = -1, /**< Type is invalid */
725 MM_PLAYER_ATTRS_TYPE_INT, /**< Integer type */
726 MM_PLAYER_ATTRS_TYPE_DOUBLE, /**< Double type */
727 MM_PLAYER_ATTRS_TYPE_STRING, /**< UTF-8 String type */
728 MM_PLAYER_ATTRS_TYPE_DATA, /**< Pointer type */
729 MM_PLAYER_ATTRS_TYPE_ARRAY, /**< Array type */
730 MM_PLAYER_ATTRS_TYPE_RANGE, /**< Range type */
731 MM_PLAYER_ATTRS_TYPE_NUM, /**< Number of attribute type */
735 * Enumeration for attribute validation type.
738 MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1, /**< Invalid validation type */
739 MM_PLAYER_ATTRS_VALID_TYPE_NONE, /**< Do not check validity */
740 MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY, /**< validity checking type of integer array */
741 MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE, /**< validity checking type of integer range */
742 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY, /**< validity checking type of double array */
743 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE, /**< validity checking type of double range */
744 } MMPlayerAttrsValidType;
747 * Enumeration for attribute access flag.
750 MM_PLAYER_ATTRS_FLAG_NONE = 0, /**< None flag is set */
751 MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0, /**< Readable */
752 MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1, /**< Writable */
753 MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2, /**< Modified */
755 MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
759 * Enumeration for progressive download
762 MM_PLAYER_PD_MODE_NONE,
763 MM_PLAYER_PD_MODE_URI,
764 MM_PLAYER_PD_MODE_FILE // not tested yet, because of no fixed scenario
768 * Enumeration of track types
771 MM_PLAYER_TRACK_TYPE_AUDIO = 0,
772 MM_PLAYER_TRACK_TYPE_VIDEO,
773 MM_PLAYER_TRACK_TYPE_TEXT,
774 MM_PLAYER_TRACK_TYPE_MAX
778 * Enumeration of runtime buffering mode
781 MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0, /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
782 MM_PLAYER_BUFFERING_MODE_FIXED, /**< player will set buffer size with this fixed size value. */
783 MM_PLAYER_BUFFERING_MODE_MAX,
784 } MMPlayerBufferingMode;
787 MM_PLAYER_FOCUS_CHANGED_COMPLETED = 0,
788 MM_PLAYER_FOCUS_CHANGED_BY_MEDIA,
789 MM_PLAYER_FOCUS_CHANGED_BY_CALL,
790 MM_PLAYER_FOCUS_CHANGED_BY_EARJACK_UNPLUG,
791 MM_PLAYER_FOCUS_CHANGED_BY_RESOURCE_CONFLICT,
792 MM_PLAYER_FOCUS_CHANGED_BY_ALARM,
793 MM_PLAYER_FOCUS_CHANGED_BY_EMERGENCY,
794 MM_PLAYER_FOCUS_CHANGED_BY_NOTIFICATION,
795 MM_PLAYER_FOCUS_CHANGED_BY_UNKNOWN,
796 } MMPlayerFocusChangedMsg;
800 * Edge Properties of the text.
804 MM_PLAYER_EDGE_RAISED,
805 MM_PLAYER_EDGE_DEPRESSED,
806 MM_PLAYER_EDGE_UNIFORM,
807 MM_PLAYER_EDGE_DROPSHADOW
808 } MMPlayerSubtitleEdge;
811 * Enumeration of media stream buffer status
814 MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
815 MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
816 } MMPlayerMediaStreamBufferStatus;
819 * Enumeration for stream type.
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;
830 MM_PLAYER_VIDEO_CODEC_TYPE_DEFAULT = 0, /**< codec is selected by the priority */
831 MM_PLAYER_VIDEO_CODEC_TYPE_HW, /**< HW codec can only be selected */
832 MM_PLAYER_VIDEO_CODEC_TYPE_SW, /**< SW codec can only be selected */
833 } MMPlayerVideoCodecType;
836 * Attribute validity structure
839 MMPlayerAttrsType type;
840 MMPlayerAttrsValidType validity_type;
841 MMPlayerAttrsFlag flag;
843 * a union that describes validity of the attribute.
844 * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
845 * the attribute can have validity.
849 * Validity structure for integer array.
852 int *array; /**< a pointer of array */
853 int count; /**< size of array */
857 * Validity structure for integer range.
860 int min; /**< minimum range */
861 int max; /**< maximum range */
865 * Validity structure for double array.
868 double * array; /**< a pointer of array */
869 int count; /**< size of array */
873 * Validity structure for double range.
876 double min; /**< minimum range */
877 double max; /**< maximum range */
886 * @see mm_player_set_volume, mm_player_get_volume
889 float level[MM_VOLUME_CHANNEL_NUM]; /**< Relative volume factor for each channels */
890 } MMPlayerVolumeType;
893 * Video stream info in external demux case
896 typedef struct _VideoStreamInfo {
898 unsigned int framerate_num;
899 unsigned int framerate_den;
902 unsigned char *codec_extradata;
903 unsigned int extradata_size;
904 unsigned int version;
905 } MMPlayerVideoStreamInfo;
908 * Audio stream info in external demux case
911 typedef struct _AudioStreamInfo {
913 unsigned int channels;
914 unsigned int sample_rate;
915 unsigned char *codec_extradata;
916 unsigned int extradata_size;
917 unsigned int version;
918 unsigned int user_info;
921 // unsigned int width;
922 // unsigned int depth;
923 // unsigned int endianness;
925 } MMPlayerAudioStreamInfo;
928 * Subtitle stream info in external demux case
931 typedef struct _SubtitleStreamInfo {
933 unsigned int codec_tag;
934 void *context; //for smpte text
935 } MMPlayerSubtitleStreamInfo;
938 * Audio stream callback function type.
940 * @param stream [in] Reference pointer to audio frame data
941 * @param stream_size [in] Size of audio frame data
942 * @param user_param [in] User defined parameter which is passed when set
943 * audio stream callback
945 * @return This callback function have to return MM_ERROR_NONE.
947 typedef bool (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
951 * selected subtitle track number callback function type.
953 * @param track_num [in] Track number of subtitle
954 * @param user_param [in] User defined parameter
957 * @return This callback function have to return MM_ERROR_NONE.
959 typedef bool (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
962 * Buffer underrun / overflow data callback function type.
964 * @param status [in] buffer status
965 * @param user_param [in] User defined parameter which is passed when set
966 * to enough data callback or need data callback
968 * @return This callback function have to return MM_ERROR_NONE.
970 typedef bool (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, unsigned long long bytes, void *user_param);
973 * Buffer seek data callback function type.
975 * @param offset [in] offset for the buffer playback
976 * @param user_param [in] User defined parameter which is passed when set
977 * to seek data callback
979 * @return This callback function have to return MM_ERROR_NONE.
981 typedef bool (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
984 * Called to notify the stream changed.
986 * @param user_data [in] The user data passed from the callback registration function
988 * @return This callback function have to return MM_ERROR_NONE.
990 typedef bool (*mm_player_stream_changed_callback) (void *user_param);
993 /*===========================================================================================
995 | GLOBAL FUNCTION PROTOTYPES |
997 ========================================================================================== */
1000 * This function creates a player object for playing multimedia contents. \n
1001 * The attributes of player are created to get/set some values with application. \n
1002 * And, mutex, gstreamer and other resources are initialized at this time. \n
1003 * If player is created, the state will become MM_PLAYER_STATE_NULL.
1005 * @param player [out] Handle of player
1007 * @return This function returns zero on success, or negative value with error code. \n
1008 * Please refer 'mm_error.h' to know it in detail.
1010 * @post MM_PLAYER_STATE_NULL
1011 * @see mm_player_destroy
1012 * @remark You can create multiple handles on a context at the same time. \n
1013 * However, player cannot guarantee proper operation because of limitation of resources, \n
1014 * such as audio device or display device.
1018 char *g_err_attr_name = NULL;
1020 if (mm_player_create(&g_player) != MM_ERROR_NONE) {
1021 LOGE("failed to create player\n");
1024 if (mm_player_set_attribute(g_player,
1026 "profile_uri", filename, strlen(filename),
1027 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
1028 NULL) != MM_ERROR_NONE) {
1029 LOGE("failed to set %s attribute\n", g_err_attr_name);
1030 free(g_err_attr_name);
1033 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1036 int mm_player_create(MMHandleType *player);
1039 * This function releases player object and all resources which were created by mm_player_create(). \n
1040 * And, player handle will also be destroyed.
1042 * @param player [in] Handle of player
1044 * @return This function returns zero on success, or negative value with error code.
1045 * @pre Player state may be MM_PLAYER_STATE_NULL. \n
1046 * But, it can be called in any state.
1047 * @post Because handle is released, there is no any state.
1048 * @see mm_player_create
1049 * @remark This method can be called with a valid player handle from any state to \n
1050 * completely shutdown the player operation.
1054 if (mm_player_destroy(g_player) != MM_ERROR_NONE) {
1055 LOGE("failed to destroy player\n");
1059 int mm_player_destroy(MMHandleType player);
1062 * This function register the sound focus using application PID \n
1063 * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1065 * @param player [in] Handle of player
1066 * @param pid [in] application PID
1068 * @return This function returns zero on success, or negative value with error code.
1070 * @pre Player state should be MM_PLAYER_STATE_NULL.
1073 int mm_player_sound_register(MMHandleType player, int pid);
1076 * This function get the application PID that is registered \n
1077 * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1079 * @param player [in] Handle of player
1080 * @param pid [out] application PID
1082 * @return This function returns zero on success, or negative value with error code.
1084 * @pre Player state should be MM_PLAYER_STATE_NULL.
1087 int mm_player_get_client_pid(MMHandleType player, int* pid);
1090 * This function parses uri and makes gstreamer pipeline by uri scheme. \n
1091 * So, uri should be set before realizing with mm_player_set_attribute(). \n
1093 * @param player [in] Handle of player
1095 * @return This function returns zero on success, or negative value with error code.
1097 * @pre Player state should be MM_PLAYER_STATE_NULL.
1098 * @post player state will be MM_PLAYER_STATE_READY.
1099 * @see mm_player_unrealize
1103 if (mm_player_realize(g_player) != MM_ERROR_NONE) {
1104 LOGE("failed to realize player\n");
1108 int mm_player_realize(MMHandleType player);
1111 * This function uninitializes player object. So, resources and allocated memory \n
1112 * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
1113 * other contents, player should be created again after destruction or realized with new uri.
1115 * @param player [in] Handle of player
1117 * @return This function returns zero on success, or negative value with error code.
1118 * @pre Player state may be MM_PLAYER_STATE_READY to unrealize. \n
1119 * But, it can be called in any state.
1120 * @post Player state will be MM_PLAYER_STATE_NULL.
1121 * @see mm_player_realize
1122 * @remark This method can be called with a valid player handle from any state.
1126 if (mm_player_unrealize(g_player) != MM_ERROR_NONE) {
1127 LOGE("failed to unrealize player\n");
1131 int mm_player_unrealize(MMHandleType player);
1134 * This function is to get current state of player. \n
1135 * Application have to check current state before doing some action.
1137 * @param player [in] Handle of player
1138 * @param state [out] current state of player on success
1140 * @return This function returns zero on success, or negative value with error code.
1142 * @see MMPlayerStateType
1146 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE) {
1147 LOGE("failed to get state\n");
1151 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
1154 * This function is to set relative volume of player. \n
1155 * So, It controls logical volume value. \n
1156 * But, if developer want to change system volume, mm sound api should be used.
1158 * @param player [in] Handle of player
1159 * @param volume [in] Volume factor of each channel
1161 * @return This function returns zero on success, or negative value with error code.
1162 * @see MMPlayerVolumeType, mm_player_get_volume
1163 * @remark The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
1166 MMPlayerVolumeType volume;
1169 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1170 volume.level[i] = MM_VOLUME_LEVEL_MAX;
1172 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
1174 LOGE("failed to set volume\n");
1178 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
1181 * This function is to get current volume factor of player.
1183 * @param player [in] Handle of player.
1184 * @param volume [out] Volume factor of each channel.
1186 * @return This function returns zero on success, or negative value with error code.
1188 * @see MMPlayerVolumeType, mm_player_set_volume
1192 MMPlayerVolumeType volume;
1195 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
1197 LOGW("failed to get volume\n");
1200 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1201 LOGD("channel[%d] = %d \n", i, volume.level[i]);
1204 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
1207 * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
1208 * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
1209 * by mm_player_set_message_callback().
1211 * @param player [in] Handle of player
1213 * @return This function returns zero on success, or negative value with error code.
1216 * @pre Player state may be MM_PLAYER_STATE_READY.
1217 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1218 * @see mm_player_stop
1222 if (mm_player_start(g_player) != MM_ERROR_NONE)
1224 LOGE("failed to start player\n");
1228 int mm_player_start(MMHandleType player);
1231 * This function is to stop playing media contents and it's different with pause. \n
1232 * If mm_player_start() is called after this, content will be started again from the beginning. \n
1233 * So, it can be used to close current playback.
1235 * @param player [in] Handle of player
1237 * @return This function returns zero on success, or negative value with error code.
1239 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1240 * @post Player state will be MM_PLAYER_STATE_READY.
1241 * @see mm_player_start
1245 if (mm_player_stop(g_player) != MM_ERROR_NONE)
1247 LOGE("failed to stop player\n");
1251 int mm_player_stop(MMHandleType player);
1254 * This function is to pause playing media contents.
1256 * @param player [in] Handle of player.
1258 * @return This function returns zero on success, or negative value with error code.
1260 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1261 * @post Player state will be MM_PLAYER_STATE_PAUSED.
1262 * @see mm_player_resume
1266 if (mm_player_pause(g_player) != MM_ERROR_NONE)
1268 LOGE("failed to pause player\n");
1272 int mm_player_pause(MMHandleType player);
1275 * This function is to resume paused media contents.
1277 * @param player [in] Handle of player.
1279 * @return This function returns zero on success, or negative value with error code.
1281 * @pre Player state may be MM_PLAYER_STATE_PAUSED.
1282 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1283 * @see mm_player_pause
1287 if (mm_player_resume(g_player) != MM_ERROR_NONE)
1289 LOGE("failed to resume player\n");
1293 int mm_player_resume(MMHandleType player);
1296 * This function is to set the position for playback. \n
1297 * So, it can be seeked to requested position. \n
1299 * @param player [in] Handle of player
1300 * @param format [in] Format of position.
1301 * @param pos [in] Position for playback
1303 * @return This function returns zero on success, or negative value with error code.
1304 * @see MMPlayerPosFormatType, mm_player_get_position
1305 * @remark the unit of time-based format is millisecond and other case is percent.
1308 int position = 1000; //1sec
1310 if (mm_player_set_position(g_player, MM_PLAYER_POS_FORMAT_TIME, position) != MM_ERROR_NONE)
1312 LOGE("failed to set position\n");
1316 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1319 * This function is to get current position of playback content.
1321 * @param player [in] Handle of player.
1322 * @param format [in] Format of position.
1323 * @param pos [out] contains current position on success or zero in case of failure.
1325 * @return This function returns zero on success, or negative value with errors
1326 * @see MMPlayerPosFormatType, mm_player_set_position
1327 * @remark the unit of time-based format is millisecond and other case is percent.
1333 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1335 mm_player_get_attribute(g_player, &g_err_name, "content_duration", &duration, NULL);
1337 LOGD("pos: [%d/%d] msec\n", position, duration);
1340 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *pos);
1343 * This function is to get current buffer position of playback content.
1345 * @param player [in] Handle of player.
1346 * @param format [in] Format of position.
1347 * @param start_pos [out] contains buffer start position on success or zero in case of failure.
1348 * @param stop_pos [out] contains buffer current position on success or zero in case of failure.
1350 * @return This function returns zero on success, or negative value with errors
1351 * @see MMPlayerPosFormatType, mm_player_set_position
1352 * @remark the unit of time-based format is millisecond and other case is percent.
1355 int start_pos = 0, stop_pos = 0;
1357 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
1359 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
1362 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
1365 * This function is to activate the section repeat. If it's set, selected section will be played \n
1366 * continually before deactivating it by mm_player_deactivate_section_repeat(). \n
1367 * The unit for setting is millisecond.
1369 * @param player [in] Handle of player.
1370 * @param start_pos [in] start position.
1371 * @param end_pos [in] end position.
1373 * @return This function returns zero on success, or negative value with error code.
1374 * @see mm_player_deactivate_section_repeat
1379 int endtime = 4000; //msec
1381 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1383 mm_player_activate_section_repeat(g_player, position, position+endtime);
1386 int mm_player_activate_section_repeat(MMHandleType player, int start_pos, int end_pos);
1389 * This function is to deactivate the section repeat.
1391 * @param player [in] Handle of player.
1393 * @return This function returns zero on success, or negative value with error code.
1394 * @see mm_player_activate_section_repeat
1398 if ( mm_player_deactivate_section_repeat(g_player) != MM_ERROR_NONE)
1400 LOGW("failed to deactivate section repeat\n");
1404 int mm_player_deactivate_section_repeat(MMHandleType player);
1407 * This function sets callback function for receiving messages from player.
1408 * So, player can notify warning, error and normal cases to application.
1410 * @param player [in] Handle of player.
1411 * @param callback [in] Message callback function.
1412 * @param user_param [in] User parameter which is passed to callback function.
1414 * @return This function returns zero on success, or negative value with error code.
1415 * @see MMMessageCallback
1419 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1423 case MM_MESSAGE_ERROR:
1427 case MM_MESSAGE_END_OF_STREAM:
1431 case MM_MESSAGE_STATE_CHANGED:
1435 case MM_MESSAGE_BEGIN_OF_STREAM:
1445 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1448 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1451 * This function set callback function for receiving audio stream from player. \n
1452 * So, application can get raw audio data and modify it. \n
1453 * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
1454 * It's only supported when audio stream is included in file. \n
1455 * So, if there is video stream or DRM content, it can't be used.
1457 * @param player [in] Handle of player.
1458 * @param callback [in] Audio stream callback function.
1459 * @param user_param [in] User parameter.
1461 * @return This function returns zero on success, or negative value with error
1463 * @see mm_player_audio_stream_callback
1464 * @remark It can be used for audio playback only.
1467 bool audio_callback(void *stream, int stream_size, void *user_param)
1469 LOGD("audio stream callback\n");
1472 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
1475 int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
1478 * This function is to mute volume of player
1480 * @param player [in] Handle of player
1481 * @param mute [in] Mute(1) or not mute(0)
1483 * @return This function returns zero on success, or negative value with error code
1484 * @see mm_player_get_mute
1488 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
1490 LOGW("failed to set mute\n");
1494 int mm_player_set_mute(MMHandleType player, int mute);
1497 * This function is to get mute value of player
1499 * @param player [in] Handle of player
1500 * @param mute [out] Sound is muted
1502 * @return This function returns zero on success, or negative value with error code
1503 * @see mm_player_set_mute
1509 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
1511 LOGW("failed to get mute\n");
1514 LOGD("mute status:%d\n", mute);
1517 int mm_player_get_mute(MMHandleType player, int *mute);
1520 * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
1521 * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
1523 * @param player [in] Handle of player
1524 * @param pos [in] postion to be adjusted
1526 * @return This function returns zero on success, or negative value with error
1528 * @see mm_player_adjust_subtitle_position
1535 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1537 LOGW("failed to adjust subtitle postion.\n");
1542 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1545 * This function is to set the offset in timestamps of video so as to bring the a/v sync
1546 * @param player Handle of player
1547 * @param offset offset to be set in milliseconds(can be positive or negative both)
1548 * postive offset to make video lag
1549 * negative offset to make video lead
1551 int mm_player_adjust_video_position(MMHandleType player, int offset);
1553 * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1554 * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1555 * Player FW parses subtitle file and send text data including timestamp to application \n
1556 * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1557 * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1558 * So, it's not supported for embedded case.
1560 * @param player [in] Handle of player
1561 * @param silent [in] silent(integer value except 0) or not silent(0)
1563 * @return This function returns zero on success, or negative value with error
1565 * @see mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1569 mm_player_set_attribute(g_player,
1571 "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1575 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1577 LOGW("failed to set subtitle silent\n");
1581 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1584 * This function is to get silent status of subtitle.
1586 * @param player [in] Handle of player
1587 * @param silent [out] subtitle silent property
1589 * @return This function returns zero on success, or negative value with error
1591 * @see mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1597 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1599 LOGW("failed to set subtitle silent\n");
1603 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1606 * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1607 * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1609 * @param player [in] Handle of player.
1610 * @param err_attr_name [out] Name of attribute which is failed to set
1611 * @param first_attribute_name [in] Name of the first attribute to set
1612 * @param ... [in] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1613 * But, in the case of data or string type, it should be name/value/size.
1615 * @return This function returns zero on success, or negative value with error code.
1617 * @see mm_player_get_attribute
1618 * @remark This function must be terminated by NULL argument.
1619 * And, if this function is failed, err_attr_name param must be free.
1622 char *g_err_attr_name = NULL;
1624 if (mm_player_set_attribute(g_player,
1626 "profile_uri", filename, strlen(filename),
1627 "profile_play_count", count,
1628 NULL) != MM_ERROR_NONE) {
1629 LOGW("failed to set %s attribute\n", g_err_attr_name);
1630 free(g_err_attr_name);
1635 int mm_player_set_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1638 * This function is to get attributes from player. Multiple attributes can be got simultaneously.
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.
1646 * @return This function returns zero on success, or negative value with error
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.
1653 char *g_err_attr_name = NULL;
1655 if (mm_player_get_attribute(g_player, &g_err_attr_name, "content_duration", &duration, NULL) != MM_ERROR_NONE) {
1656 LOGW("failed to set %s attribute\n", g_err_attr_name);
1657 free(g_err_attr_name);
1661 int mm_player_get_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1664 * This function is to get detail information of attribute.
1666 * @param player [in] Handle of player.
1667 * @param attribute_name [in] Name of the attribute to get
1668 * @param info [out] Attribute infomation
1670 * @return This function returns zero on success, or negative value with error
1673 * @see mm_player_set_attribute, mm_player_get_attribute
1677 if (mm_player_get_attribute_info(g_player, "display_method", &method_info) != MM_ERROR_NONE) {
1678 LOGW("failed to get info\n");
1681 LOGD("type:%d \n", method_info.type); //int, double..
1682 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1683 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1685 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE) {
1686 LOGD("range min:%d\n", method_info.int_range.min);
1687 LOGD("range max:%d\n", method_info.int_range.max);
1691 int mm_player_get_attribute_info(MMHandleType player, const char *attribute_name, MMPlayerAttrsInfo *info);
1694 * This function is to get download position and total size of progressive download
1696 * @param player [in] Handle of player.
1697 * @param current_pos [in] Download position currently (bytes)
1698 * @param total_size [in] Total size of file (bytes)
1700 * @return This function returns zero on success, or negative value with error code.
1703 guint64 current_pos = 0LLU;
1704 guint64 total_size = 0LLU;
1706 if (mm_player_get_pd_status(g_player, ¤t_pos, &total_size, NULL) != MM_ERROR_NONE)
1708 LOGD("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1712 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1715 * This function sets callback function for receiving messages of PD downloader.
1717 * @param player [in] Handle of player.
1718 * @param callback [in] Message callback function.
1719 * @param user_param [in] User parameter which is passed to callback function.
1721 * @return This function returns zero on success, or negative value with error code.
1726 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1730 case MM_MESSAGE_PD_DOWNLOADER_START:
1731 LOGD("Progressive download is started...\n");
1733 case MM_MESSAGE_PD_DOWNLOADER_END:
1734 LOGD("Progressive download is ended...\n");
1742 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1745 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1748 * This function is to get the track count
1750 * @param player [in] handle of player.
1751 * @param track [in] type of the track type
1752 * @param info [out] the count of the track
1754 * @return This function returns zero on success, or negative value with error
1759 gint audio_count = 0;
1761 if (mm_player_get_track_count(g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE) {
1762 LOGW("failed to get audio track count\n");
1765 LOGD("audio track count : %d \n", audio_count);
1768 int mm_player_get_track_count(MMHandleType player, MMPlayerTrackType type, int *count);
1771 * This function is to select the track
1773 * @param player [in] handle of player.
1774 * @param type [in] type of the track type
1775 * @param index [in] the index of the track
1777 * @return This function returns zero on success, or negative value with error
1780 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1783 * This function is to add the track when user want multi subtitle
1785 * @param player [in] handle of player.
1786 * @param index [in] the index of the track
1788 * @return This function returns zero on success, or negative value with error
1791 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1794 * This function is to remove the track when user want multi subtitle
1796 * @param player [in] handle of player.
1797 * @param index [in] the index of the track
1799 * @return This function returns zero on success, or negative value with error
1802 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1805 * This function is to notify which sutitle track is in use
1807 * @param player [in] handle of player.
1808 * @param callback [in] callback function to register
1809 * @param user_data [in] user data to be passed to the callback function
1811 * @return This function returns zero on success, or negative value with error
1814 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1817 * This function is to get the track language
1819 * @param player [in] handle of player.
1820 * @param type [in] type of the track type
1821 * @param index [in] the index of the track
1822 * @param code [out] language code in ISO 639-1(string)
1824 * @return This function returns zero on success, or negative value with error
1827 int mm_player_get_track_language_code(MMHandleType player, MMPlayerTrackType type, int index, char **code);
1830 * This function is to get the current running track
1832 * @param player [in] handle of player.
1833 * @param type [in] type of the track type
1834 * @param index [out] the index of the track
1836 * @return This function returns zero on success, or negative value with error
1840 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1843 * This function is to set the subtitle path
1845 * @param player [in] handle of player
1846 * @param path [in] subtitle path
1848 * @return This function returns zero on success, or negative value with error code.
1850 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1853 * This function is to set the clock which is from master player
1855 * @param player [in] handle of player
1856 * @param clock [in] clock of master player
1857 * @param clock_delta [in] clock difference between master and slave
1858 * @param video_time [in] current playing position
1859 * @param media_clock [in] media clock information
1860 * @param audio_time [in] audio timestamp information
1861 * @return This function returns zero on success, or negative value with error code.
1863 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);
1865 * This function is to get the master clock
1867 * @param player [in] handle of player
1868 * @param video_time [out] current playing position
1869 * @param media_clock [out] media clock information
1870 * @param audio_time [out] audio timestamp information
1871 * @return This function returns zero on success, or negative value with error code.
1873 int mm_player_get_video_share_master_clock(MMHandleType player, long long *video_time, long long *media_clock, long long *audio_time);
1876 * This function is to get the content angle
1878 * @param player [in] handle of player
1879 * @param angle [out] orignal angle from content
1880 * @return This function returns zero on success, or negative value with error code.
1882 int mm_player_get_video_rotate_angle(MMHandleType player, int *angle);
1885 * This function is to set download mode of video hub
1887 * @param player [in] handle of player
1888 * @param mode [in] download mode
1889 * @return This function returns zero on success, or negative value with error code.
1891 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
1894 * This function is to set using sync handler.
1896 * @param player [in] handle of player
1897 * @param enable [in] enable/disable
1898 * @return This function returns zero on success, or negative value with error code.
1900 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
1903 * This function is to set uri.
1905 * @param player [in] handle of player
1906 * @param uri [in] uri
1907 * @return This function returns zero on success, or negative value with error code.
1909 int mm_player_set_uri(MMHandleType player, const char *uri);
1912 * This function is to set next uri.
1914 * @param player [in] handle of player
1915 * @param uri [in] uri
1916 * @return This function returns zero on success, or negative value with error code.
1918 int mm_player_set_next_uri(MMHandleType player, const char *uri);
1921 * This function is to get next uri.
1923 * @param player [in] handle of player
1924 * @param uri [out] uri
1925 * @return This function returns zero on success, or negative value with error code.
1927 int mm_player_get_next_uri(MMHandleType player, char **uri);
1930 * This function is to increase reference count of internal buffer.
1932 * @param buffer [in] video callback internal buffer
1933 * @return This function returns buffer point;
1935 void * mm_player_media_packet_video_stream_internal_buffer_ref(void *buffer);
1938 * This function is to decrease reference count of internal buffer.
1940 * @param buffer [in] video callback internal buffer
1943 void mm_player_media_packet_video_stream_internal_buffer_unref(void *buffer);
1945 /**mm_player_submit_packet
1946 * This function is to submit buffer to appsrc. \n
1947 * @param player [in] Handle of player.
1948 * @param buf [in] buffer to be submit in appsrc in external feeder case.
1949 * @param len [in] length of buffer.
1950 * @param pts [in] timestamp of buffer.
1951 * @param streamtype [in] stream type of buffer.
1952 * @return This function returns zero on success, or negative value with error code.
1954 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
1956 /**mm_player_set_video_info
1957 * This function is to set caps of src pad of video appsrc in external feeder case. \n
1958 * @param player [in] Handle of player.
1959 * @param media_format_h [in] Video stream info.
1960 * @return This function returns zero on success, or negative value with error code.
1962 int mm_player_set_video_info(MMHandleType player, media_format_h format);
1964 /**mm_player_set_audio_info
1965 * This function is to set caps of src pad of Audio appsrc in external feeder case. \n
1966 * @param player [in] Handle of player.
1967 * @param media_format_h [in] Audio stream info.
1968 * @return This function returns zero on success, or negative value with error code.
1970 int mm_player_set_audio_info(MMHandleType player, media_format_h format);
1972 /**mm_player_set_subtitle_info
1973 * This function is to set caps of src pad of subtitle appsrc in external feeder case. \n
1974 * @param player [in] Handle of player.
1975 * @param subtitle_stream_info [in] Subtitle stream info.
1976 * @return This function returns zero on success, or negative value with error code.
1978 int mm_player_set_subtitle_info(MMHandleType player, MMPlayerSubtitleStreamInfo *info);
1981 * This function set callback function for receiving need or enough data message from player.
1983 * @param player [in] Handle of player.
1984 * @param type [in] stream type
1985 * @param callback [in] data callback function for stream type.
1986 * @param user_param [in] User parameter.
1988 * @return This function returns zero on success, or negative value with error
1991 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
1994 * This function set callback function for receiving seek data message from player.
1996 * @param player [in] Handle of player.
1997 * @param type [in] stream type
1998 * @param callback [in] Seek data callback function for stream type.
1999 * @param user_param [in] User parameter.
2001 * @return This function returns zero on success, or negative value with error
2004 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
2007 * This function is to set max size of buffer(appsrc).
2009 * @param player [in] Handle of player.
2010 * @param type [in] stream type
2011 * @param max_size [in] max bytes of buffer.
2013 * @return This function returns zero on success, or negative value with error
2016 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
2019 * This function is to get max size of buffer(appsrc).
2021 * @param player [in] Handle of player.
2022 * @param type [in] stream type
2023 * @param max_size [out] max bytes of buffer.
2025 * @return This function returns zero on success, or negative value with error
2028 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
2031 * This function is to set min percent of buffer(appsrc).
2033 * @param player [in] Handle of player.
2034 * @param type [in] stream type
2035 * @param min_percent [in] min percent of buffer.
2037 * @return This function returns zero on success, or negative value with error
2040 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
2043 * This function is to get min percent of buffer(appsrc).
2045 * @param player [in] Handle of player.
2046 * @param type [in] stream type
2047 * @param min_percent [out] min percent of buffer.
2049 * @return This function returns zero on success, or negative value with error
2052 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
2055 * This function set callback function for changing audio stream from player. \n
2056 * It's only supported when audio stream is included in file. \n
2058 * @param player [in] Handle of player.
2059 * @param callback [in] Audio stream changed callback function.
2060 * @param user_param [in] User parameter.
2062 * @return This function returns zero on success, or negative value with error
2064 * @see mm_player_stream_changed_callback
2067 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2070 * This function set callback function for changing video stream from player. \n
2071 * It's only supported when video stream is included in file. \n
2073 * @param player [in] Handle of player.
2074 * @param callback [in] Video stream changed callback function.
2075 * @param user_param [in] User parameter.
2077 * @return This function returns zero on success, or negative value with error
2079 * @see mm_player_stream_changed_callback
2081 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2084 * This function is to get timeout value according to the content type for muse. \n
2085 * It's only supported when video stream is included in file. \n
2087 * @param player [in] Handle of player.
2088 * @param timeout [out] timeout value (sec).
2090 * @return This function returns zero on success, or negative value with error
2094 int mm_player_get_timeout(MMHandleType player, int *timeout);
2097 * This function is to get the number of video output buffers. \n
2098 * It's only supported when video stream is included in file. \n
2100 * @param player [in] Handle of player.
2101 * @param num [out] num of buffers.
2102 * @param extra_num [out] extra num of buffers.
2104 * @return This function returns zero on success, or negative value with error
2108 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
2111 * This function is to set the dynamic resolution information. \n
2112 * It's only supported when video stream is included in file. \n
2114 * @param player [in] Handle of player.
2115 * @param drc [in] dynamic resolution info of media stream data
2117 * @return This function returns zero on success, or negative value with error
2121 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
2124 * This function is to release the video stream bo to reuse. \n
2125 * It's only supported when sw codec is used to decode video stream. \n
2127 * @param player [in] Handle of player.
2128 * @param bo [in] bo address to be released
2130 * @return This function returns zero on success, or negative value with error
2134 int mm_player_release_video_stream_bo(MMHandleType player, void* bo);
2137 * This function is to set http file buffering path
2139 * @param player [in] handle of player
2140 * @param file_path [in] file path
2141 * @return This function returns zero on success, or negative value with error code.
2143 int mm_player_set_file_buffering_path(MMHandleType player, const char *file_path);
2146 * This function is to set sound stream info
2148 int mm_player_set_sound_stream_info(MMHandleType player, char *stream_type, int stream_index);
2151 * This function is to manage the playback according to the external storage state
2153 int mm_player_manage_external_storage_state(MMHandleType player, int id, int state);
2156 * These functions are to set/get the max variant of HAS
2158 int mm_player_get_adaptive_variant_info(MMHandleType player, int *num, char **var_info);
2159 int mm_player_set_max_adaptive_variant_limit(MMHandleType player, int bandwidth, int width, int height);
2160 int mm_player_get_max_adaptive_variant_limit(MMHandleType player, int *bandwidth, int *width, int *height);
2163 * These functions are to set/get the audio only mode
2165 int mm_player_set_audio_only(MMHandleType player, bool audio_only);
2166 int mm_player_get_audio_only(MMHandleType player, bool *audio_only);
2169 * These functions are to set/get the streaming bufferint time
2171 int mm_player_set_streaming_buffering_time(MMHandleType player, int buffer_ms, int rebuffer_ms);
2172 int mm_player_get_streaming_buffering_time(MMHandleType player, int *buffer_ms, int *rebuffer_ms);
2175 * These functions are to display the 360 video content
2177 int mm_player_360_set_enable(MMHandleType player, bool enable);
2178 int mm_player_360_is_enabled(MMHandleType player, bool *enabled);
2180 int mm_player_360_set_direction_of_view(MMHandleType player, float yaw, float pitch);
2181 int mm_player_360_get_direction_of_view(MMHandleType player, float *yaw, float *pitch);
2183 int mm_player_360_set_zoom(MMHandleType player, float level);
2184 int mm_player_360_get_zoom(MMHandleType player, float *level);
2186 int mm_player_360_set_field_of_view(MMHandleType player, int horizontal_degrees, int vertical_degrees);
2187 int mm_player_360_get_field_of_view(MMHandleType player, int *horizontal_degrees, int *vertical_degrees);
2197 #endif /* __MM_PLAYER_H__ */