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"
665 * gapless playback mode (int)
667 #define MM_PLAYER_GAPLESS_MODE "gapless_mode"
669 #define BUFFER_MAX_PLANE_NUM (4)
672 MMPixelFormatType format; /**< image format */
673 int width; /**< width of video buffer */
674 int height; /**< height of video buffer */
675 unsigned int timestamp; /**< timestamp of stream buffer (msec)*/
676 unsigned int length_total; /**< total length of stream buffer (in byte)*/
677 void *data[BUFFER_MAX_PLANE_NUM];
678 void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
679 void *internal_buffer; /**< Internal buffer pointer */
680 int stride[BUFFER_MAX_PLANE_NUM]; /**< stride of plane */
681 int elevation[BUFFER_MAX_PLANE_NUM]; /**< elevation of plane */
682 }MMPlayerVideoStreamDataType;
685 * Enumerations of player state.
688 MM_PLAYER_STATE_NULL, /**< Player is created, but not realized yet */
689 MM_PLAYER_STATE_READY, /**< Player is ready to play media */
690 MM_PLAYER_STATE_PLAYING, /**< Player is now playing media */
691 MM_PLAYER_STATE_PAUSED, /**< Player is paused while playing media */
692 MM_PLAYER_STATE_NONE, /**< Player is not created yet */
693 MM_PLAYER_STATE_NUM, /**< Number of player states */
697 * Enumerations of position formats.
698 * Used while invoking mm_player_get_position/mm_player_set_position APIs
701 MM_PLAYER_POS_FORMAT_TIME, /**< Format for time based */
702 MM_PLAYER_POS_FORMAT_PERCENT, /**< Format for percentage */
703 MM_PLAYER_POS_FORMAT_NUM, /**< Number of position formats */
704 } MMPlayerPosFormatType;
707 * Enumeration for attribute values types.
710 MM_PLAYER_ATTRS_TYPE_INVALID = -1, /**< Type is invalid */
711 MM_PLAYER_ATTRS_TYPE_INT, /**< Integer type */
712 MM_PLAYER_ATTRS_TYPE_DOUBLE, /**< Double type */
713 MM_PLAYER_ATTRS_TYPE_STRING, /**< UTF-8 String type */
714 MM_PLAYER_ATTRS_TYPE_DATA, /**< Pointer type */
715 MM_PLAYER_ATTRS_TYPE_ARRAY, /**< Array type */
716 MM_PLAYER_ATTRS_TYPE_RANGE, /**< Range type */
717 MM_PLAYER_ATTRS_TYPE_NUM, /**< Number of attribute type */
721 * Enumeration for attribute validation type.
724 MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1, /**< Invalid validation type */
725 MM_PLAYER_ATTRS_VALID_TYPE_NONE, /**< Do not check validity */
726 MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY, /**< validity checking type of integer array */
727 MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE, /**< validity checking type of integer range */
728 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY, /**< validity checking type of double array */
729 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE, /**< validity checking type of double range */
730 } MMPlayerAttrsValidType;
733 * Enumeration for attribute access flag.
736 MM_PLAYER_ATTRS_FLAG_NONE = 0, /**< None flag is set */
737 MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0, /**< Readable */
738 MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1, /**< Writable */
739 MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2, /**< Modified */
741 MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
745 * Enumeration for progressive download
748 MM_PLAYER_PD_MODE_NONE,
749 MM_PLAYER_PD_MODE_URI,
750 MM_PLAYER_PD_MODE_FILE // not tested yet, because of no fixed scenario
754 * Enumeration of track types
757 MM_PLAYER_TRACK_TYPE_AUDIO = 0,
758 MM_PLAYER_TRACK_TYPE_VIDEO,
759 MM_PLAYER_TRACK_TYPE_TEXT,
760 MM_PLAYER_TRACK_TYPE_MAX
764 * Enumeration of runtime buffering mode
767 MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0, /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
768 MM_PLAYER_BUFFERING_MODE_FIXED, /**< player will set buffer size with this fixed size value. */
769 MM_PLAYER_BUFFERING_MODE_SLINK, /**< If buffering is occurred, player will adjust buffer setting and no more buffering will be occurred again. */
770 MM_PLAYER_BUFFERING_MODE_MAX = MM_PLAYER_BUFFERING_MODE_SLINK,
771 }MMPlayerBufferingMode;
774 * Enumeration of audio channel for video share
778 MM_PLAYER_AUDIO_CH_MONO_LEFT = 0,
779 MM_PLAYER_AUDIO_CH_MONO_RIGHT,
780 MM_PLAYER_AUDIO_CH_STEREO,
781 } MMPlayerAudioChannel;
785 MM_PLAYER_FOCUS_CHANGED_COMPLETED = 0,
786 MM_PLAYER_FOCUS_CHANGED_BY_MEDIA,
787 MM_PLAYER_FOCUS_CHANGED_BY_CALL,
788 MM_PLAYER_FOCUS_CHANGED_BY_EARJACK_UNPLUG,
789 MM_PLAYER_FOCUS_CHANGED_BY_RESOURCE_CONFLICT,
790 MM_PLAYER_FOCUS_CHANGED_BY_ALARM,
791 MM_PLAYER_FOCUS_CHANGED_BY_EMERGENCY,
792 MM_PLAYER_FOCUS_CHANGED_BY_NOTIFICATION,
793 MM_PLAYER_FOCUS_CHANGED_BY_UNKNOWN,
794 } MMPlayerFocusChangedMsg;
798 * Edge Properties of the text.
802 MM_PLAYER_EDGE_RAISED,
803 MM_PLAYER_EDGE_DEPRESSED,
804 MM_PLAYER_EDGE_UNIFORM,
805 MM_PLAYER_EDGE_DROPSHADOW
806 } MMPlayerSubtitleEdge;
809 * Enumeration of media stream buffer status
813 MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
814 MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
815 } MMPlayerMediaStreamBufferStatus;
818 * 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 * Enumeration for pipeline type.
834 MM_PLAYER_PIPELINE_LEGACY, /**< Legacy pipeline */
835 MM_PLAYER_PIPELINE_SERVER, /**< Pipeline for server(src,decoder,demux...) */
836 MM_PLAYER_PIPELINE_CLIENT, /**< Pipeline for client(sink)*/
837 MM_PLAYER_PIPELINE_MAX
838 } MMPlayerPipelineType;
841 * Attribute validity structure
844 MMPlayerAttrsType type;
845 MMPlayerAttrsValidType validity_type;
846 MMPlayerAttrsFlag flag;
848 * a union that describes validity of the attribute.
849 * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
850 * the attribute can have validity.
854 * Validity structure for integer array.
857 int *array; /**< a pointer of array */
858 int count; /**< size of array */
862 * Validity structure for integer range.
865 int min; /**< minimum range */
866 int max; /**< maximum range */
870 * Validity structure for double array.
873 double * array; /**< a pointer of array */
874 int count; /**< size of array */
878 * Validity structure for double range.
881 double min; /**< minimum range */
882 double max; /**< maximum range */
891 * @see mm_player_set_volume, mm_player_get_volume
894 float level[MM_VOLUME_CHANNEL_NUM]; /**< Relative volume factor for each channels */
895 } MMPlayerVolumeType;
898 * Video stream info in external demux case
901 typedef struct _VideoStreamInfo
904 unsigned int framerate_num;
905 unsigned int framerate_den;
908 unsigned char *codec_extradata;
909 unsigned int extradata_size;
910 unsigned int version;
911 }MMPlayerVideoStreamInfo;
914 * Audio stream info in external demux case
917 typedef struct _AudioStreamInfo
920 unsigned int channels;
921 unsigned int sample_rate;
922 unsigned char *codec_extradata;
923 unsigned int extradata_size;
924 unsigned int version;
925 unsigned int user_info;
928 // unsigned int width;
929 // unsigned int depth;
930 // unsigned int endianness;
932 }MMPlayerAudioStreamInfo;
935 * Subtitle stream info in external demux case
938 typedef struct _SubtitleStreamInfo
941 unsigned int codec_tag;
942 void *context; //for smpte text
943 }MMPlayerSubtitleStreamInfo;
946 * Audio stream callback function type.
948 * @param stream [in] Reference pointer to audio frame data
949 * @param stream_size [in] Size of audio frame data
950 * @param user_param [in] User defined parameter which is passed when set
951 * audio stream callback
953 * @return This callback function have to return MM_ERROR_NONE.
955 typedef bool (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
959 * selected subtitle track number callback function type.
961 * @param track_num [in] Track number of subtitle
962 * @param user_param [in] User defined parameter
965 * @return This callback function have to return MM_ERROR_NONE.
967 typedef bool (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
970 * Buffer underrun / overflow data callback function type.
972 * @param status [in] buffer status
973 * @param user_param [in] User defined parameter which is passed when set
974 * to enough data callback or need data callback
976 * @return This callback function have to return MM_ERROR_NONE.
978 typedef bool (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, unsigned long long bytes, void *user_param);
981 * Buffer seek data callback function type.
983 * @param offset [in] offset for the buffer playback
984 * @param user_param [in] User defined parameter which is passed when set
985 * to seek data callback
987 * @return This callback function have to return MM_ERROR_NONE.
989 typedef bool (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
992 * Called to notify the stream changed.
994 * @param user_data [in] The user data passed from the callback registration function
996 * @return This callback function have to return MM_ERROR_NONE.
998 typedef bool (*mm_player_stream_changed_callback) (void *user_param);
1001 /*===========================================================================================
1003 | GLOBAL FUNCTION PROTOTYPES |
1005 ========================================================================================== */
1008 * This function creates a player object for playing multimedia contents. \n
1009 * The attributes of player are created to get/set some values with application. \n
1010 * And, mutex, gstreamer and other resources are initialized at this time. \n
1011 * If player is created, the state will become MM_PLAYER_STATE_NULL.
1013 * @param player [out] Handle of player
1015 * @return This function returns zero on success, or negative value with error code. \n
1016 * Please refer 'mm_error.h' to know it in detail.
1018 * @post MM_PLAYER_STATE_NULL
1019 * @see mm_player_destroy
1020 * @remark You can create multiple handles on a context at the same time. \n
1021 * However, player cannot guarantee proper operation because of limitation of resources, \n
1022 * such as audio device or display device.
1026 char *g_err_attr_name = NULL;
1028 if (mm_player_create(&g_player) != MM_ERROR_NONE)
1030 LOGE("failed to create player\n");
1033 if (mm_player_set_attribute(g_player,
1035 "profile_uri", filename, strlen(filename),
1036 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
1037 NULL) != MM_ERROR_NONE)
1039 LOGE("failed to set %s attribute\n", g_err_attr_name);
1040 free(g_err_attr_name);
1043 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1046 int mm_player_create(MMHandleType *player);
1049 * This function releases player object and all resources which were created by mm_player_create(). \n
1050 * And, player handle will also be destroyed.
1052 * @param player [in] Handle of player
1054 * @return This function returns zero on success, or negative value with error code.
1055 * @pre Player state may be MM_PLAYER_STATE_NULL. \n
1056 * But, it can be called in any state.
1057 * @post Because handle is released, there is no any state.
1058 * @see mm_player_create
1059 * @remark This method can be called with a valid player handle from any state to \n
1060 * completely shutdown the player operation.
1064 if (mm_player_destroy(g_player) != MM_ERROR_NONE)
1066 LOGE("failed to destroy player\n");
1070 int mm_player_destroy(MMHandleType player);
1073 * This function register the sound focus using application PID \n
1074 * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1076 * @param player [in] Handle of player
1077 * @param pid [in] application PID
1079 * @return This function returns zero on success, or negative value with error code.
1081 * @pre Player state should be MM_PLAYER_STATE_NULL.
1084 int mm_player_sound_register(MMHandleType player, int pid);
1087 * This function get the application PID that is registered \n
1088 * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1090 * @param player [in] Handle of player
1091 * @param pid [out] application PID
1093 * @return This function returns zero on success, or negative value with error code.
1095 * @pre Player state should be MM_PLAYER_STATE_NULL.
1098 int mm_player_get_client_pid (MMHandleType player, int* pid);
1101 * This function parses uri and makes gstreamer pipeline by uri scheme. \n
1102 * So, uri should be set before realizing with mm_player_set_attribute(). \n
1104 * @param player [in] Handle of player
1106 * @return This function returns zero on success, or negative value with error code.
1108 * @pre Player state should be MM_PLAYER_STATE_NULL.
1109 * @post Player state will be MM_PLAYER_STATE_READY.
1110 * @see mm_player_unrealize
1114 if (mm_player_realize(g_player) != MM_ERROR_NONE)
1116 LOGE("failed to realize player\n");
1120 int mm_player_realize(MMHandleType player) ;
1123 * This function uninitializes player object. So, resources and allocated memory \n
1124 * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
1125 * other contents, player should be created again after destruction or realized with new uri.
1127 * @param player [in] Handle of player
1129 * @return This function returns zero on success, or negative value with error code.
1130 * @pre Player state may be MM_PLAYER_STATE_READY to unrealize. \n
1131 * But, it can be called in any state.
1132 * @post Player state will be MM_PLAYER_STATE_NULL.
1133 * @see mm_player_realize
1134 * @remark This method can be called with a valid player handle from any state.
1138 if (mm_player_unrealize(g_player) != MM_ERROR_NONE)
1140 LOGE("failed to unrealize player\n");
1144 int mm_player_unrealize(MMHandleType player);
1147 * This function is to get current state of player. \n
1148 * Application have to check current state before doing some action.
1150 * @param player [in] Handle of player
1151 * @param state [out] current state of player on success
1153 * @return This function returns zero on success, or negative value with error code.
1155 * @see MMPlayerStateType
1159 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE)
1161 LOGE("failed to get state\n");
1165 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
1168 * This function is to set relative volume of player. \n
1169 * So, It controls logical volume value. \n
1170 * But, if developer want to change system volume, mm sound api should be used.
1172 * @param player [in] Handle of player
1173 * @param volume [in] Volume factor of each channel
1175 * @return This function returns zero on success, or negative value with error code.
1176 * @see MMPlayerVolumeType, mm_player_get_volume
1177 * @remark The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
1180 MMPlayerVolumeType volume;
1183 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1184 volume.level[i] = MM_VOLUME_LEVEL_MAX;
1186 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
1188 LOGE("failed to set volume\n");
1192 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
1195 * This function is to get current volume factor of player.
1197 * @param player [in] Handle of player.
1198 * @param volume [out] Volume factor of each channel.
1200 * @return This function returns zero on success, or negative value with error code.
1202 * @see MMPlayerVolumeType, mm_player_set_volume
1206 MMPlayerVolumeType volume;
1209 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
1211 LOGW("failed to get volume\n");
1214 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1215 LOGD("channel[%d] = %d \n", i, volume.level[i]);
1218 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
1221 * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
1222 * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
1223 * by mm_player_set_message_callback().
1225 * @param player [in] Handle of player
1227 * @return This function returns zero on success, or negative value with error code.
1230 * @pre Player state may be MM_PLAYER_STATE_READY.
1231 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1232 * @see mm_player_stop
1236 if (mm_player_start(g_player) != MM_ERROR_NONE)
1238 LOGE("failed to start player\n");
1242 int mm_player_start(MMHandleType player);
1245 * This function is to stop playing media contents and it's different with pause. \n
1246 * If mm_player_start() is called after this, content will be started again from the beginning. \n
1247 * So, it can be used to close current playback.
1249 * @param player [in] Handle of player
1251 * @return This function returns zero on success, or negative value with error code.
1253 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1254 * @post Player state will be MM_PLAYER_STATE_READY.
1255 * @see mm_player_start
1259 if (mm_player_stop(g_player) != MM_ERROR_NONE)
1261 LOGE("failed to stop player\n");
1265 int mm_player_stop(MMHandleType player);
1268 * This function is to pause playing media contents.
1270 * @param player [in] Handle of player.
1272 * @return This function returns zero on success, or negative value with error code.
1274 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1275 * @post Player state will be MM_PLAYER_STATE_PAUSED.
1276 * @see mm_player_resume
1280 if (mm_player_pause(g_player) != MM_ERROR_NONE)
1282 LOGE("failed to pause player\n");
1286 int mm_player_pause(MMHandleType player);
1289 * This function is to resume paused media contents.
1291 * @param player [in] Handle of player.
1293 * @return This function returns zero on success, or negative value with error code.
1295 * @pre Player state may be MM_PLAYER_STATE_PAUSED.
1296 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1297 * @see mm_player_pause
1301 if (mm_player_resume(g_player) != MM_ERROR_NONE)
1303 LOGE("failed to resume player\n");
1307 int mm_player_resume(MMHandleType player);
1310 * This function is to set the position for playback. \n
1311 * So, it can be seeked to requested position. \n
1313 * @param player [in] Handle of player
1314 * @param format [in] Format of position.
1315 * @param pos [in] Position for playback
1317 * @return This function returns zero on success, or negative value with error code.
1318 * @see MMPlayerPosFormatType, mm_player_get_position
1319 * @remark the unit of time-based format is millisecond and other case is percent.
1322 int position = 1000; //1sec
1324 if (mm_player_set_position(g_player, MM_PLAYER_POS_FORMAT_TIME, position) != MM_ERROR_NONE)
1326 LOGE("failed to set position\n");
1330 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1333 * This function is to get current position of playback content.
1335 * @param player [in] Handle of player.
1336 * @param format [in] Format of position.
1337 * @param pos [out] contains current position on success or zero in case of failure.
1339 * @return This function returns zero on success, or negative value with errors
1340 * @see MMPlayerPosFormatType, mm_player_set_position
1341 * @remark the unit of time-based format is millisecond and other case is percent.
1347 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1349 mm_player_get_attribute(g_player, &g_err_name, "content_duration", &duration, NULL);
1351 LOGD("pos: [%d/%d] msec\n", position, duration);
1354 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *pos);
1357 * This function is to get current buffer position of playback content.
1359 * @param player [in] Handle of player.
1360 * @param format [in] Format of position.
1361 * @param start_pos [out] contains buffer start position on success or zero in case of failure.
1362 * @param stop_pos [out] contains buffer current position on success or zero in case of failure.
1364 * @return This function returns zero on success, or negative value with errors
1365 * @see MMPlayerPosFormatType, mm_player_set_position
1366 * @remark the unit of time-based format is millisecond and other case is percent.
1369 int start_pos = 0, stop_pos = 0;
1371 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
1373 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
1376 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
1379 * This function is to activate the section repeat. If it's set, selected section will be played \n
1380 * continually before deactivating it by mm_player_deactivate_section_repeat(). \n
1381 * The unit for setting is millisecond.
1383 * @param player [in] Handle of player.
1384 * @param start_pos [in] start position.
1385 * @param end_pos [in] end position.
1387 * @return This function returns zero on success, or negative value with error code.
1388 * @see mm_player_deactivate_section_repeat
1393 int endtime = 4000; //msec
1395 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1397 mm_player_activate_section_repeat(g_player, position, position+endtime);
1400 int mm_player_activate_section_repeat(MMHandleType player, int start_pos, int end_pos);
1403 * This function is to deactivate the section repeat.
1405 * @param player [in] Handle of player.
1407 * @return This function returns zero on success, or negative value with error code.
1408 * @see mm_player_activate_section_repeat
1412 if ( mm_player_deactivate_section_repeat(g_player) != MM_ERROR_NONE)
1414 LOGW("failed to deactivate section repeat\n");
1418 int mm_player_deactivate_section_repeat(MMHandleType player);
1421 * This function sets callback function for receiving messages from player.
1422 * So, player can notify warning, error and normal cases to application.
1424 * @param player [in] Handle of player.
1425 * @param callback [in] Message callback function.
1426 * @param user_param [in] User parameter which is passed to callback function.
1428 * @return This function returns zero on success, or negative value with error code.
1429 * @see MMMessageCallback
1433 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1437 case MM_MESSAGE_ERROR:
1441 case MM_MESSAGE_END_OF_STREAM:
1445 case MM_MESSAGE_STATE_CHANGED:
1449 case MM_MESSAGE_BEGIN_OF_STREAM:
1459 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1462 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1465 * This function set callback function for receiving audio stream from player. \n
1466 * So, application can get raw audio data and modify it. \n
1467 * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
1468 * It's only supported when audio stream is included in file. \n
1469 * So, if there is video stream or DRM content, it can't be used.
1471 * @param player [in] Handle of player.
1472 * @param callback [in] Audio stream callback function.
1473 * @param user_param [in] User parameter.
1475 * @return This function returns zero on success, or negative value with error
1477 * @see mm_player_audio_stream_callback
1478 * @remark It can be used for audio playback only.
1481 bool audio_callback(void *stream, int stream_size, void *user_param)
1483 LOGD("audio stream callback\n");
1486 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
1489 int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
1492 * This function is to mute volume of player
1494 * @param player [in] Handle of player
1495 * @param mute [in] Mute(1) or not mute(0)
1497 * @return This function returns zero on success, or negative value with error code
1498 * @see mm_player_get_mute
1502 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
1504 LOGW("failed to set mute\n");
1508 int mm_player_set_mute(MMHandleType player, int mute);
1511 * This function is to get mute value of player
1513 * @param player [in] Handle of player
1514 * @param mute [out] Sound is muted
1516 * @return This function returns zero on success, or negative value with error code
1517 * @see mm_player_set_mute
1523 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
1525 LOGW("failed to get mute\n");
1528 LOGD("mute status:%d\n", mute);
1531 int mm_player_get_mute(MMHandleType player, int *mute);
1534 * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
1535 * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
1537 * @param player [in] Handle of player
1538 * @param pos [in] postion to be adjusted
1540 * @return This function returns zero on success, or negative value with error
1542 * @see mm_player_adjust_subtitle_position
1549 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1551 LOGW("failed to adjust subtitle postion.\n");
1556 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1559 * This function is to set the offset in timestamps of video so as to bring the a/v sync
1560 * @param player Handle of player
1561 * @param offset offset to be set in milliseconds(can be positive or negative both)
1562 * postive offset to make video lag
1563 * negative offset to make video lead
1565 int mm_player_adjust_video_position(MMHandleType player,int offset);
1567 * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1568 * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1569 * Player FW parses subtitle file and send text data including timestamp to application \n
1570 * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1571 * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1572 * So, it's not supported for embedded case.
1574 * @param player [in] Handle of player
1575 * @param silent [in] silent(integer value except 0) or not silent(0)
1577 * @return This function returns zero on success, or negative value with error
1579 * @see mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1583 mm_player_set_attribute(g_player,
1585 "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1589 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1591 LOGW("failed to set subtitle silent\n");
1595 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1598 * This function is to get silent status of subtitle.
1600 * @param player [in] Handle of player
1601 * @param silent [out] subtitle silent property
1603 * @return This function returns zero on success, or negative value with error
1605 * @see mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1611 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1613 LOGW("failed to set subtitle silent\n");
1617 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1620 * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1621 * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1623 * @param player [in] Handle of player.
1624 * @param err_attr_name [out] Name of attribute which is failed to set
1625 * @param first_attribute_name [in] Name of the first attribute to set
1626 * @param ... [in] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1627 * But, in the case of data or string type, it should be name/value/size.
1629 * @return This function returns zero on success, or negative value with error code.
1631 * @see mm_player_get_attribute
1632 * @remark This function must be terminated by NULL argument.
1633 * And, if this function is failed, err_attr_name param must be free.
1636 char *g_err_attr_name = NULL;
1638 if (mm_player_set_attribute(g_player,
1640 "profile_uri", filename, strlen(filename),
1641 "profile_play_count", count,
1642 NULL) != MM_ERROR_NONE)
1644 LOGW("failed to set %s attribute\n", g_err_attr_name);
1645 free(g_err_attr_name);
1650 int mm_player_set_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1653 * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1655 * @param player [in] Handle of player.
1656 * @param err_attr_name [out] Name of attribute which is failed to get
1657 * @param first_attribute_name [in] Name of the first attribute to get
1658 * @param ... [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1659 * But, in the case of data or string type, it should be name/value/size.
1661 * @return This function returns zero on success, or negative value with error
1663 * @see mm_player_set_attribute
1664 * @remark This function must be terminated by NULL argument.
1665 * And, if this function is failed, err_attr_name param must be free.
1668 char *g_err_attr_name = NULL;
1670 if (mm_player_get_attribute(g_player, &g_err_attr_name, "content_duration", &duration, NULL) != MM_ERROR_NONE)
1672 LOGW("failed to set %s attribute\n", g_err_attr_name);
1673 free(g_err_attr_name);
1677 int mm_player_get_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1680 * This function is to get detail information of attribute.
1682 * @param player [in] Handle of player.
1683 * @param attribute_name [in] Name of the attribute to get
1684 * @param info [out] Attribute infomation
1686 * @return This function returns zero on success, or negative value with error
1689 * @see mm_player_set_attribute, mm_player_get_attribute
1693 if (mm_player_get_attribute_info (g_player, "display_method", &method_info) != MM_ERROR_NONE)
1695 LOGW("failed to get info\n");
1698 LOGD("type:%d \n", method_info.type); //int, double..
1699 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1700 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1702 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE)
1704 LOGD("range min:%d\n", method_info.int_range.min);
1705 LOGD("range max:%d\n", method_info.int_range.max);
1709 int mm_player_get_attribute_info(MMHandleType player, const char *attribute_name, MMPlayerAttrsInfo *info);
1712 * This function is to get download position and total size of progressive download
1714 * @param player [in] Handle of player.
1715 * @param current_pos [in] Download position currently (bytes)
1716 * @param total_size [in] Total size of file (bytes)
1718 * @return This function returns zero on success, or negative value with error code.
1724 guint64 current_pos = 0LLU;
1725 guint64 total_size = 0LLU;
1727 if (mm_player_get_pd_status(g_player, ¤t_pos, &total_size, NULL) != MM_ERROR_NONE)
1729 LOGD("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1733 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1736 * This function sets callback function for receiving messages of PD downloader.
1738 * @param player [in] Handle of player.
1739 * @param callback [in] Message callback function.
1740 * @param user_param [in] User parameter which is passed to callback function.
1742 * @return This function returns zero on success, or negative value with error code.
1747 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1751 case MM_MESSAGE_PD_DOWNLOADER_START:
1752 LOGD("Progressive download is started...\n");
1754 case MM_MESSAGE_PD_DOWNLOADER_END:
1755 LOGD("Progressive download is ended...\n");
1763 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1766 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1769 * This function is to get the track count
1771 * @param player [in] handle of player.
1772 * @param track [in] type of the track type
1773 * @param info [out] the count of the track
1775 * @return This function returns zero on success, or negative value with error
1782 gint audio_count = 0;
1784 if (mm_player_get_track_count (g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE)
1786 LOGW("failed to get audio track count\n");
1789 LOGD("audio track count : %d \n", audio_count);
1792 int mm_player_get_track_count(MMHandleType player, MMPlayerTrackType type, int *count);
1795 * This function is to select the track
1797 * @param player [in] handle of player.
1798 * @param type [in] type of the track type
1799 * @param index [in] the index of the track
1801 * @return This function returns zero on success, or negative value with error
1807 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1810 * This function is to add the track when user want multi subtitle
1812 * @param player [in] handle of player.
1813 * @param index [in] the index of the track
1815 * @return This function returns zero on success, or negative value with error
1821 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1824 * This function is to remove the track when user want multi subtitle
1826 * @param player [in] handle of player.
1827 * @param index [in] the index of the track
1829 * @return This function returns zero on success, or negative value with error
1835 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1838 * This function is to notify which sutitle track is in use
1840 * @param player [in] handle of player.
1841 * @param callback [in] callback function to register
1842 * @param user_data [in] user data to be passed to the callback function
1844 * @return This function returns zero on success, or negative value with error
1850 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1853 * This function is to get the track language
1855 * @param player [in] handle of player.
1856 * @param type [in] type of the track type
1857 * @param index [in] the index of the track
1858 * @param code [out] language code in ISO 639-1(string)
1860 * @return This function returns zero on success, or negative value with error
1866 int mm_player_get_track_language_code(MMHandleType player, MMPlayerTrackType type, int index, char **code);
1869 * This function is to get the current running track
1871 * @param player [in] handle of player.
1872 * @param type [in] type of the track type
1873 * @param index [out] the index of the track
1875 * @return This function returns zero on success, or negative value with error
1882 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1885 * This function is to set the buffer size for streaming playback. \n
1887 * @param player [in] Handle of player
1888 * @param second [in] Size of initial buffer
1890 * @return This function returns zero on success, or negative value with error code.
1894 gint second = 10; //10sec
1896 if (mm_player_set_prepare_buffering_time(g_player, second) != MM_ERROR_NONE)
1898 LOGE("failed to set buffer size\n");
1903 int mm_player_set_prepare_buffering_time(MMHandleType player, int second);
1906 * This function is to set the runtime buffering mode for streaming playback. \n
1908 * @param player [in] Handle of player
1909 * @param mode [in] mode of runtime buffering
1910 * @param second [in] max size of buffering
1912 * @return This function returns zero on success, or negative value with error code.
1917 if (mm_player_set_runtime_buffering_mode(g_player, MM_PLAYER_BUFFERING_MODE_ADAPTIVE, 10) != MM_ERROR_NONE)
1919 LOGE("failed to set buffering mode\n");
1924 int mm_player_set_runtime_buffering_mode(MMHandleType player, MMPlayerBufferingMode mode, int second);
1927 * This function is to set the start position of zoom
1929 * @param player [in] handle of player
1930 * @param level [in] level of zoom
1931 * @param x [in] start x position
1932 * @param y [in] start y position
1934 * @return This function returns zero on success, or negative value with error
1940 int mm_player_set_display_zoom(MMHandleType player, float level, int x, int y);
1943 * This function is to get the start position of zoom
1945 * @param player [in] handle of player
1946 * @param type [out] current level of zoom
1947 * @param x [out] start x position
1948 * @param y [out] start y position
1950 * @return This function returns zero on success, or negative value with error
1956 int mm_player_get_display_zoom(MMHandleType player, float *level, int *x, int *y);
1959 * This function is to set the subtitle path
1961 * @param player [in] handle of player
1962 * @param path [in] subtitle path
1964 * @return This function returns zero on success, or negative value with error code.
1969 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1972 * This function is to set the clock which is from master player
1974 * @param player [in] handle of player
1975 * @param clock [in] clock of master player
1976 * @param clock_delta [in] clock difference between master and slave
1977 * @param video_time [in] current playing position
1978 * @param media_clock [in] media clock information
1979 * @param audio_time [in] audio timestamp information
1980 * @return This function returns zero on success, or negative value with error code.
1985 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);
1987 * This function is to get the master clock
1989 * @param player [in] handle of player
1990 * @param video_time [out] current playing position
1991 * @param media_clock [out] media clock information
1992 * @param audio_time [out] audio timestamp information
1993 * @return This function returns zero on success, or negative value with error code.
1998 int mm_player_get_video_share_master_clock(MMHandleType player, long long *video_time, long long *media_clock, long long *audio_time);
2000 * This function is to set audio channel
2002 * @param player [in] handle of player
2003 * @param ch [in] audio channel
2004 * @return This function returns zero on success, or negative value with error code.
2009 int mm_player_gst_set_audio_channel(MMHandleType player, MMPlayerAudioChannel ch);
2012 * This function is to get the content angle
2014 * @param player [in] handle of player
2015 * @param angle [out] orignal angle from content
2016 * @return This function returns zero on success, or negative value with error code.
2021 int mm_player_get_video_rotate_angle(MMHandleType player, int *angle);
2024 * This function is to set download mode of video hub
2026 * @param player [in] handle of player
2027 * @param mode [in] download mode
2028 * @return This function returns zero on success, or negative value with error code.
2033 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
2036 * This function is to set using sync handler.
2038 * @param player [in] handle of player
2039 * @param enable [in] enable/disable
2040 * @return This function returns zero on success, or negative value with error code.
2045 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
2048 * This function is to set uri.
2050 * @param player [in] handle of player
2051 * @param uri [in] uri
2052 * @return This function returns zero on success, or negative value with error code.
2057 int mm_player_set_uri(MMHandleType player, const char *uri);
2060 * This function is to set next uri.
2062 * @param player [in] handle of player
2063 * @param uri [in] uri
2064 * @return This function returns zero on success, or negative value with error code.
2069 int mm_player_set_next_uri(MMHandleType player, const char *uri);
2072 * This function is to get next uri.
2074 * @param player [in] handle of player
2075 * @param uri [out] uri
2076 * @return This function returns zero on success, or negative value with error code.
2081 int mm_player_get_next_uri(MMHandleType player, char **uri);
2083 int mm_player_enable_media_packet_video_stream(MMHandleType player, bool enable);
2086 * This function is to increase reference count of internal buffer.
2088 * @param buffer [in] video callback internal buffer
2089 * @return This function returns buffer point;
2094 void * mm_player_media_packet_video_stream_internal_buffer_ref(void *buffer);
2097 * This function is to decrease reference count of internal buffer.
2099 * @param buffer [in] video callback internal buffer
2105 void mm_player_media_packet_video_stream_internal_buffer_unref(void *buffer);
2107 /**mm_player_submit_packet
2108 * This function is to submit buffer to appsrc. \n
2109 * @param player [in] Handle of player.
2110 * @param buf [in] buffer to be submit in appsrc in external feeder case.
2111 * @param len [in] length of buffer.
2112 * @param pts [in] timestamp of buffer.
2113 * @param streamtype [in] stream type of buffer.
2114 * @return This function returns zero on success, or negative value with error code.
2119 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
2121 /**mm_player_set_video_info
2122 * This function is to set caps of src pad of video appsrc in external feeder case. \n
2123 * @param player [in] Handle of player.
2124 * @param media_format_h [in] Video stream info.
2125 * @return This function returns zero on success, or negative value with error code.
2130 int mm_player_set_video_info (MMHandleType player, media_format_h format);
2132 /**mm_player_set_audio_info
2133 * This function is to set caps of src pad of Audio appsrc in external feeder case. \n
2134 * @param player [in] Handle of player.
2135 * @param media_format_h [in] Audio stream info.
2136 * @return This function returns zero on success, or negative value with error code.
2141 int mm_player_set_audio_info (MMHandleType player, media_format_h format);
2143 /**mm_player_set_subtitle_info
2144 * This function is to set caps of src pad of subtitle appsrc in external feeder case. \n
2145 * @param player [in] Handle of player.
2146 * @param subtitle_stream_info [in] Subtitle stream info.
2147 * @return This function returns zero on success, or negative value with error code.
2152 int mm_player_set_subtitle_info (MMHandleType player, MMPlayerSubtitleStreamInfo *info);
2155 * This function set callback function for receiving need or enough data message from player.
2157 * @param player [in] Handle of player.
2158 * @param type [in] stream type
2159 * @param callback [in] data callback function for stream type.
2160 * @param user_param [in] User parameter.
2162 * @return This function returns zero on success, or negative value with error
2168 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
2171 * This function set callback function for receiving seek data message from player.
2173 * @param player [in] Handle of player.
2174 * @param type [in] stream type
2175 * @param callback [in] Seek data callback function for stream type.
2176 * @param user_param [in] User parameter.
2178 * @return This function returns zero on success, or negative value with error
2184 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
2187 * This function is to set max size of buffer(appsrc).
2189 * @param player [in] Handle of player.
2190 * @param type [in] stream type
2191 * @param max_size [in] max bytes of buffer.
2193 * @return This function returns zero on success, or negative value with error
2199 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
2202 * This function is to get max size of buffer(appsrc).
2204 * @param player [in] Handle of player.
2205 * @param type [in] stream type
2206 * @param max_size [out] max bytes of buffer.
2208 * @return This function returns zero on success, or negative value with error
2214 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
2217 * This function is to set min percent of buffer(appsrc).
2219 * @param player [in] Handle of player.
2220 * @param type [in] stream type
2221 * @param min_percent [in] min percent of buffer.
2223 * @return This function returns zero on success, or negative value with error
2229 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
2232 * This function is to get min percent of buffer(appsrc).
2234 * @param player [in] Handle of player.
2235 * @param type [in] stream type
2236 * @param min_percent [out] min percent of buffer.
2238 * @return This function returns zero on success, or negative value with error
2244 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
2247 * This function set callback function for changing audio stream from player. \n
2248 * It's only supported when audio stream is included in file. \n
2250 * @param player [in] Handle of player.
2251 * @param callback [in] Audio stream changed callback function.
2252 * @param user_param [in] User parameter.
2254 * @return This function returns zero on success, or negative value with error
2256 * @see mm_player_stream_changed_callback
2259 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2262 * This function set callback function for changing video stream from player. \n
2263 * It's only supported when video stream is included in file. \n
2265 * @param player [in] Handle of player.
2266 * @param callback [in] Video stream changed callback function.
2267 * @param user_param [in] User parameter.
2269 * @return This function returns zero on success, or negative value with error
2271 * @see mm_player_stream_changed_callback
2274 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2277 * This function is to get timeout value according to the content type for muse. \n
2278 * It's only supported when video stream is included in file. \n
2280 * @param player [in] Handle of player.
2281 * @param timeout [out] timeout value (sec).
2283 * @return This function returns zero on success, or negative value with error
2287 int mm_player_get_timeout(MMHandleType player, int *timeout);
2290 * This function is to get the number of video output buffers. \n
2291 * It's only supported when video stream is included in file. \n
2293 * @param player [in] Handle of player.
2294 * @param num [out] num of buffers.
2295 * @param extra_num [out] extra num of buffers.
2297 * @return This function returns zero on success, or negative value with error
2301 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
2304 * This function is to set the dynamic resolution information. \n
2305 * It's only supported when video stream is included in file. \n
2307 * @param player [in] Handle of player.
2308 * @param drc [in] dynamic resolution info of media stream data
2310 * @return This function returns zero on success, or negative value with error
2314 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
2317 * This function is to release the video stream bo to reuse. \n
2318 * It's only supported when sw codec is used to decode video stream. \n
2320 * @param player [in] Handle of player.
2321 * @param bo [in] bo address to be released
2323 * @return This function returns zero on success, or negative value with error
2327 int mm_player_release_video_stream_bo(MMHandleType player, void* bo);
2330 * This function is to set http file buffering path
2332 * @param player [in] handle of player
2333 * @param file_path [in] file path
2334 * @return This function returns zero on success, or negative value with error code.
2339 int mm_player_set_file_buffering_path(MMHandleType player, const char *file_path);
2349 #endif /* __MM_PLAYER_H__ */