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"
655 #define BUFFER_MAX_PLANE_NUM (4)
658 MMPixelFormatType format; /**< image format */
659 int width; /**< width of video buffer */
660 int height; /**< height of video buffer */
661 unsigned int timestamp; /**< timestamp of stream buffer (msec)*/
662 unsigned int length_total; /**< total length of stream buffer (in byte)*/
663 void *data[BUFFER_MAX_PLANE_NUM];
664 void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
665 void *internal_buffer; /**< Internal buffer pointer */
666 int stride[BUFFER_MAX_PLANE_NUM]; /**< stride of plane */
667 int elevation[BUFFER_MAX_PLANE_NUM]; /**< elevation of plane */
668 }MMPlayerVideoStreamDataType;
671 * Enumerations of player state.
674 MM_PLAYER_STATE_NULL, /**< Player is created, but not realized yet */
675 MM_PLAYER_STATE_READY, /**< Player is ready to play media */
676 MM_PLAYER_STATE_PLAYING, /**< Player is now playing media */
677 MM_PLAYER_STATE_PAUSED, /**< Player is paused while playing media */
678 MM_PLAYER_STATE_NONE, /**< Player is not created yet */
679 MM_PLAYER_STATE_NUM, /**< Number of player states */
683 * Enumerations of position formats.
684 * Used while invoking mm_player_get_position/mm_player_set_position APIs
687 MM_PLAYER_POS_FORMAT_TIME, /**< Format for time based */
688 MM_PLAYER_POS_FORMAT_PERCENT, /**< Format for percentage */
689 MM_PLAYER_POS_FORMAT_NUM, /**< Number of position formats */
690 } MMPlayerPosFormatType;
693 * Enumeration for attribute values types.
696 MM_PLAYER_ATTRS_TYPE_INVALID = -1, /**< Type is invalid */
697 MM_PLAYER_ATTRS_TYPE_INT, /**< Integer type */
698 MM_PLAYER_ATTRS_TYPE_DOUBLE, /**< Double type */
699 MM_PLAYER_ATTRS_TYPE_STRING, /**< UTF-8 String type */
700 MM_PLAYER_ATTRS_TYPE_DATA, /**< Pointer type */
701 MM_PLAYER_ATTRS_TYPE_ARRAY, /**< Array type */
702 MM_PLAYER_ATTRS_TYPE_RANGE, /**< Range type */
703 MM_PLAYER_ATTRS_TYPE_NUM, /**< Number of attribute type */
707 * Enumeration for attribute validation type.
710 MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1, /**< Invalid validation type */
711 MM_PLAYER_ATTRS_VALID_TYPE_NONE, /**< Do not check validity */
712 MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY, /**< validity checking type of integer array */
713 MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE, /**< validity checking type of integer range */
714 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY, /**< validity checking type of double array */
715 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE, /**< validity checking type of double range */
716 } MMPlayerAttrsValidType;
719 * Enumeration for attribute access flag.
722 MM_PLAYER_ATTRS_FLAG_NONE = 0, /**< None flag is set */
723 MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0, /**< Readable */
724 MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1, /**< Writable */
725 MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2, /**< Modified */
727 MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
731 * Enumeration for progressive download
734 MM_PLAYER_PD_MODE_NONE,
735 MM_PLAYER_PD_MODE_URI,
736 MM_PLAYER_PD_MODE_FILE // not tested yet, because of no fixed scenario
740 * Enumeration of track types
743 MM_PLAYER_TRACK_TYPE_AUDIO = 0,
744 MM_PLAYER_TRACK_TYPE_VIDEO,
745 MM_PLAYER_TRACK_TYPE_TEXT,
746 MM_PLAYER_TRACK_TYPE_MAX
750 * Enumeration of runtime buffering mode
753 MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0, /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
754 MM_PLAYER_BUFFERING_MODE_FIXED, /**< player will set buffer size with this fixed size value. */
755 MM_PLAYER_BUFFERING_MODE_SLINK, /**< If buffering is occurred, player will adjust buffer setting and no more buffering will be occurred again. */
756 MM_PLAYER_BUFFERING_MODE_MAX = MM_PLAYER_BUFFERING_MODE_SLINK,
757 }MMPlayerBufferingMode;
760 * Enumeration of audio channel for video share
764 MM_PLAYER_AUDIO_CH_MONO_LEFT = 0,
765 MM_PLAYER_AUDIO_CH_MONO_RIGHT,
766 MM_PLAYER_AUDIO_CH_STEREO,
767 } MMPlayerAudioChannel;
771 MM_PLAYER_SOUND_RESOURCE_PRELISTENING_RINGTONE = 0,
772 MM_PLAYER_SOUND_RESOURCE_PRELISTENING_NOTIFICATION,
773 MM_PLAYER_SOUND_RESOURCE_PRELISTENING_ALARM,
774 MM_PLAYER_SOUND_RESOURCE_PRELISTENING_MEDIA,
775 } MMPlayerSoundResource;
779 MM_PLAYER_FOCUS_CHANGED_COMPLETED = 0,
780 MM_PLAYER_FOCUS_CHANGED_BY_MEDIA,
781 MM_PLAYER_FOCUS_CHANGED_BY_CALL,
782 MM_PLAYER_FOCUS_CHANGED_BY_EARJACK_UNPLUG,
783 MM_PLAYER_FOCUS_CHANGED_BY_RESOURCE_CONFLICT,
784 MM_PLAYER_FOCUS_CHANGED_BY_ALARM,
785 MM_PLAYER_FOCUS_CHANGED_BY_EMERGENCY,
786 MM_PLAYER_FOCUS_CHANGED_BY_NOTIFICATION,
787 MM_PLAYER_FOCUS_CHANGED_BY_UNKNOWN,
788 } MMPlayerFocusChangedMsg;
792 * Edge Properties of the text.
796 MM_PLAYER_EDGE_RAISED,
797 MM_PLAYER_EDGE_DEPRESSED,
798 MM_PLAYER_EDGE_UNIFORM,
799 MM_PLAYER_EDGE_DROPSHADOW
800 } MMPlayerSubtitleEdge;
803 * Enumeration of media stream buffer status
807 MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
808 MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
809 } MMPlayerMediaStreamBufferStatus;
812 * Enumeration for stream type.
816 MM_PLAYER_STREAM_TYPE_DEFAULT, /**< Container type */
817 MM_PLAYER_STREAM_TYPE_AUDIO, /**< Audio element stream type */
818 MM_PLAYER_STREAM_TYPE_VIDEO, /**< Video element stream type */
819 MM_PLAYER_STREAM_TYPE_TEXT, /**< Text type */
820 MM_PLAYER_STREAM_TYPE_MAX,
821 } MMPlayerStreamType;
824 * Attribute validity structure
827 MMPlayerAttrsType type;
828 MMPlayerAttrsValidType validity_type;
829 MMPlayerAttrsFlag flag;
831 * a union that describes validity of the attribute.
832 * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
833 * the attribute can have validity.
837 * Validity structure for integer array.
840 int *array; /**< a pointer of array */
841 int count; /**< size of array */
845 * Validity structure for integer range.
848 int min; /**< minimum range */
849 int max; /**< maximum range */
853 * Validity structure for double array.
856 double * array; /**< a pointer of array */
857 int count; /**< size of array */
861 * Validity structure for double range.
864 double min; /**< minimum range */
865 double max; /**< maximum range */
874 * @see mm_player_set_volume, mm_player_get_volume
877 float level[MM_VOLUME_CHANNEL_NUM]; /**< Relative volume factor for each channels */
878 } MMPlayerVolumeType;
881 * Video stream info in external demux case
884 typedef struct _VideoStreamInfo
887 unsigned int framerate_num;
888 unsigned int framerate_den;
891 unsigned char *codec_extradata;
892 unsigned int extradata_size;
893 unsigned int version;
894 }MMPlayerVideoStreamInfo;
897 * Audio stream info in external demux case
900 typedef struct _AudioStreamInfo
903 unsigned int channels;
904 unsigned int sample_rate;
905 unsigned char *codec_extradata;
906 unsigned int extradata_size;
907 unsigned int version;
908 unsigned int user_info;
911 // unsigned int width;
912 // unsigned int depth;
913 // unsigned int endianness;
915 }MMPlayerAudioStreamInfo;
918 * Subtitle stream info in external demux case
921 typedef struct _SubtitleStreamInfo
924 unsigned int codec_tag;
925 void *context; //for smpte text
926 }MMPlayerSubtitleStreamInfo;
929 * Audio stream callback function type.
931 * @param stream [in] Reference pointer to audio frame data
932 * @param stream_size [in] Size of audio frame data
933 * @param user_param [in] User defined parameter which is passed when set
934 * audio stream callback
936 * @return This callback function have to return MM_ERROR_NONE.
938 typedef bool (*mm_player_audio_stream_callback) (void *stream, int stream_size, void *user_param);
942 * selected subtitle track number callback function type.
944 * @param track_num [in] Track number of subtitle
945 * @param user_param [in] User defined parameter
948 * @return This callback function have to return MM_ERROR_NONE.
950 typedef bool (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
953 * Buffer underrun / overflow data callback function type.
955 * @param status [in] buffer status
956 * @param user_param [in] User defined parameter which is passed when set
957 * to enough data callback or need data callback
959 * @return This callback function have to return MM_ERROR_NONE.
961 typedef bool (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, void *user_param);
964 * Buffer seek data callback function type.
966 * @param offset [in] offset for the buffer playback
967 * @param user_param [in] User defined parameter which is passed when set
968 * to seek data callback
970 * @return This callback function have to return MM_ERROR_NONE.
972 typedef bool (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
975 * Called to notify the stream changed.
977 * @param user_data [in] The user data passed from the callback registration function
979 * @return This callback function have to return MM_ERROR_NONE.
981 typedef bool (*mm_player_stream_changed_callback) (void *user_param);
984 /*===========================================================================================
986 | GLOBAL FUNCTION PROTOTYPES |
988 ========================================================================================== */
991 * This function creates a player object for playing multimedia contents. \n
992 * The attributes of player are created to get/set some values with application. \n
993 * And, mutex, gstreamer and other resources are initialized at this time. \n
994 * If player is created, the state will become MM_PLAYER_STATE_NULL.
996 * @param player [out] Handle of player
998 * @return This function returns zero on success, or negative value with error code. \n
999 * Please refer 'mm_error.h' to know it in detail.
1001 * @post MM_PLAYER_STATE_NULL
1002 * @see mm_player_destroy
1003 * @remark You can create multiple handles on a context at the same time. \n
1004 * However, player cannot guarantee proper operation because of limitation of resources, \n
1005 * such as audio device or display device.
1009 char *g_err_attr_name = NULL;
1011 if (mm_player_create(&g_player) != MM_ERROR_NONE)
1013 debug_error("failed to create player\n");
1016 if (mm_player_set_attribute(g_player,
1018 "profile_uri", filename, strlen(filename),
1019 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
1020 NULL) != MM_ERROR_NONE)
1022 debug_error("failed to set %s attribute\n", g_err_attr_name);
1023 free(g_err_attr_name);
1026 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1029 int mm_player_create(MMHandleType *player);
1032 * This function releases player object and all resources which were created by mm_player_create(). \n
1033 * And, player handle will also be destroyed.
1035 * @param player [in] Handle of player
1037 * @return This function returns zero on success, or negative value with error code.
1038 * @pre Player state may be MM_PLAYER_STATE_NULL. \n
1039 * But, it can be called in any state.
1040 * @post Because handle is released, there is no any state.
1041 * @see mm_player_create
1042 * @remark This method can be called with a valid player handle from any state to \n
1043 * completely shutdown the player operation.
1047 if (mm_player_destroy(g_player) != MM_ERROR_NONE)
1049 debug_error("failed to destroy player\n");
1053 int mm_player_destroy(MMHandleType player);
1056 * This function register the sound focus using application PID \n
1057 * So, application PID should be set before realizing with mm_player_set_attribute(). \n
1059 * @param player [in] Handle of player
1061 * @return This function returns zero on success, or negative value with error code.
1063 * @pre Player state should be MM_PLAYER_STATE_NULL.
1066 int mm_player_sound_register(MMHandleType player, int pid);
1069 * This function parses uri and makes gstreamer pipeline by uri scheme. \n
1070 * So, uri should be set before realizing with mm_player_set_attribute(). \n
1072 * @param player [in] Handle of player
1074 * @return This function returns zero on success, or negative value with error code.
1076 * @pre Player state should be MM_PLAYER_STATE_NULL.
1077 * @post Player state will be MM_PLAYER_STATE_READY.
1078 * @see mm_player_unrealize
1082 if (mm_player_realize(g_player) != MM_ERROR_NONE)
1084 debug_error("failed to realize player\n");
1088 int mm_player_realize(MMHandleType player) ;
1091 * This function uninitializes player object. So, resources and allocated memory \n
1092 * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
1093 * other contents, player should be created again after destruction or realized with new uri.
1095 * @param player [in] Handle of player
1097 * @return This function returns zero on success, or negative value with error code.
1098 * @pre Player state may be MM_PLAYER_STATE_READY to unrealize. \n
1099 * But, it can be called in any state.
1100 * @post Player state will be MM_PLAYER_STATE_NULL.
1101 * @see mm_player_realize
1102 * @remark This method can be called with a valid player handle from any state.
1106 if (mm_player_unrealize(g_player) != MM_ERROR_NONE)
1108 debug_error("failed to unrealize player\n");
1112 int mm_player_unrealize(MMHandleType player);
1115 * This function is to get current state of player. \n
1116 * Application have to check current state before doing some action.
1118 * @param player [in] Handle of player
1119 * @param state [out] current state of player on success
1121 * @return This function returns zero on success, or negative value with error code.
1123 * @see MMPlayerStateType
1127 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE)
1129 debug_error("failed to get state\n");
1133 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
1136 * This function is to set relative volume of player. \n
1137 * So, It controls logical volume value. \n
1138 * But, if developer want to change system volume, mm sound api should be used.
1140 * @param player [in] Handle of player
1141 * @param volume [in] Volume factor of each channel
1143 * @return This function returns zero on success, or negative value with error code.
1144 * @see MMPlayerVolumeType, mm_player_get_volume
1145 * @remark The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
1148 MMPlayerVolumeType volume;
1151 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1152 volume.level[i] = MM_VOLUME_LEVEL_MAX;
1154 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
1156 debug_error("failed to set volume\n");
1160 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
1163 * This function is to get current volume factor of player.
1165 * @param player [in] Handle of player.
1166 * @param volume [out] Volume factor of each channel.
1168 * @return This function returns zero on success, or negative value with error code.
1170 * @see MMPlayerVolumeType, mm_player_set_volume
1174 MMPlayerVolumeType volume;
1177 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
1179 debug_warning("failed to get volume\n");
1182 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
1183 debug_log("channel[%d] = %d \n", i, volume.level[i]);
1186 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
1189 * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
1190 * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
1191 * by mm_player_set_message_callback().
1193 * @param player [in] Handle of player
1195 * @return This function returns zero on success, or negative value with error code.
1198 * @pre Player state may be MM_PLAYER_STATE_READY.
1199 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1200 * @see mm_player_stop
1204 if (mm_player_start(g_player) != MM_ERROR_NONE)
1206 debug_error("failed to start player\n");
1210 int mm_player_start(MMHandleType player);
1213 * This function is to stop playing media contents and it's different with pause. \n
1214 * If mm_player_start() is called after this, content will be started again from the beginning. \n
1215 * So, it can be used to close current playback.
1217 * @param player [in] Handle of player
1219 * @return This function returns zero on success, or negative value with error code.
1221 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1222 * @post Player state will be MM_PLAYER_STATE_READY.
1223 * @see mm_player_start
1227 if (mm_player_stop(g_player) != MM_ERROR_NONE)
1229 debug_error("failed to stop player\n");
1233 int mm_player_stop(MMHandleType player);
1236 * This function is to pause playing media contents.
1238 * @param player [in] Handle of player.
1240 * @return This function returns zero on success, or negative value with error code.
1242 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
1243 * @post Player state will be MM_PLAYER_STATE_PAUSED.
1244 * @see mm_player_resume
1248 if (mm_player_pause(g_player) != MM_ERROR_NONE)
1250 debug_error("failed to pause player\n");
1254 int mm_player_pause(MMHandleType player);
1257 * This function is to resume paused media contents.
1259 * @param player [in] Handle of player.
1261 * @return This function returns zero on success, or negative value with error code.
1263 * @pre Player state may be MM_PLAYER_STATE_PAUSED.
1264 * @post Player state will be MM_PLAYER_STATE_PLAYING.
1265 * @see mm_player_pause
1269 if (mm_player_resume(g_player) != MM_ERROR_NONE)
1271 debug_error("failed to resume player\n");
1275 int mm_player_resume(MMHandleType player);
1278 * This function is to set the position for playback. \n
1279 * So, it can be seeked to requested position. \n
1281 * @param player [in] Handle of player
1282 * @param format [in] Format of position.
1283 * @param pos [in] Position for playback
1285 * @return This function returns zero on success, or negative value with error code.
1286 * @see MMPlayerPosFormatType, mm_player_get_position
1287 * @remark the unit of time-based format is millisecond and other case is percent.
1290 int position = 1000; //1sec
1292 if (mm_player_set_position(g_player, MM_PLAYER_POS_FORMAT_TIME, position) != MM_ERROR_NONE)
1294 debug_error("failed to set position\n");
1298 int mm_player_set_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1301 * This function is to get current position of playback content.
1303 * @param player [in] Handle of player.
1304 * @param format [in] Format of position.
1305 * @param pos [out] contains current position on success or zero in case of failure.
1307 * @return This function returns zero on success, or negative value with errors
1308 * @see MMPlayerPosFormatType, mm_player_set_position
1309 * @remark the unit of time-based format is millisecond and other case is percent.
1315 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1317 mm_player_get_attribute(g_player, &g_err_name, "content_duration", &duration, NULL);
1319 debug_log("pos: [%d/%d] msec\n", position, duration);
1322 int mm_player_get_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *pos);
1325 * This function is to get current buffer position of playback content.
1327 * @param player [in] Handle of player.
1328 * @param format [in] Format of position.
1329 * @param start_pos [out] contains buffer start position on success or zero in case of failure.
1330 * @param stop_pos [out] contains buffer current position on success or zero in case of failure.
1332 * @return This function returns zero on success, or negative value with errors
1333 * @see MMPlayerPosFormatType, mm_player_set_position
1334 * @remark the unit of time-based format is millisecond and other case is percent.
1337 int start_pos = 0, stop_pos = 0;
1339 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
1341 debug_log("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
1344 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
1347 * This function is to activate the section repeat. If it's set, selected section will be played \n
1348 * continually before deactivating it by mm_player_deactivate_section_repeat(). \n
1349 * The unit for setting is millisecond.
1351 * @param player [in] Handle of player.
1352 * @param start_pos [in] start position.
1353 * @param end_pos [in] end position.
1355 * @return This function returns zero on success, or negative value with error code.
1356 * @see mm_player_deactivate_section_repeat
1361 int endtime = 4000; //msec
1363 mm_player_get_position(g_player, MM_PLAYER_POS_FORMAT_TIME, &position);
1365 mm_player_activate_section_repeat(g_player, position, position+endtime);
1368 int mm_player_activate_section_repeat(MMHandleType player, int start_pos, int end_pos);
1371 * This function is to deactivate the section repeat.
1373 * @param player [in] Handle of player.
1375 * @return This function returns zero on success, or negative value with error code.
1376 * @see mm_player_activate_section_repeat
1380 if ( mm_player_deactivate_section_repeat(g_player) != MM_ERROR_NONE)
1382 debug_warning("failed to deactivate section repeat\n");
1386 int mm_player_deactivate_section_repeat(MMHandleType player);
1389 * This function sets callback function for receiving messages from player.
1390 * So, player can notify warning, error and normal cases to application.
1392 * @param player [in] Handle of player.
1393 * @param callback [in] Message callback function.
1394 * @param user_param [in] User parameter which is passed to callback function.
1396 * @return This function returns zero on success, or negative value with error code.
1397 * @see MMMessageCallback
1401 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1405 case MM_MESSAGE_ERROR:
1409 case MM_MESSAGE_END_OF_STREAM:
1413 case MM_MESSAGE_STATE_CHANGED:
1417 case MM_MESSAGE_BEGIN_OF_STREAM:
1427 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
1430 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1433 * This function set callback function for receiving audio stream from player. \n
1434 * So, application can get raw audio data and modify it. \n
1435 * But, if callback don't return or holds it for long time, performance can be deteriorated. \n
1436 * It's only supported when audio stream is included in file. \n
1437 * So, if there is video stream or DRM content, it can't be used.
1439 * @param player [in] Handle of player.
1440 * @param callback [in] Audio stream callback function.
1441 * @param user_param [in] User parameter.
1443 * @return This function returns zero on success, or negative value with error
1445 * @see mm_player_audio_stream_callback
1446 * @remark It can be used for audio playback only.
1449 bool audio_callback(void *stream, int stream_size, void *user_param)
1451 debug_log("audio stream callback\n");
1454 mm_player_set_audio_stream_callback(g_player, audio_callback, NULL);
1457 int mm_player_set_audio_stream_callback(MMHandleType player, mm_player_audio_stream_callback callback, void *user_param);
1460 * This function is to mute volume of player
1462 * @param player [in] Handle of player
1463 * @param mute [in] Mute(1) or not mute(0)
1465 * @return This function returns zero on success, or negative value with error code
1466 * @see mm_player_get_mute
1470 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
1472 debug_warning("failed to set mute\n");
1476 int mm_player_set_mute(MMHandleType player, int mute);
1479 * This function is to get mute value of player
1481 * @param player [in] Handle of player
1482 * @param mute [out] Sound is muted
1484 * @return This function returns zero on success, or negative value with error code
1485 * @see mm_player_set_mute
1491 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
1493 debug_warning("failed to get mute\n");
1496 debug_log("mute status:%d\n", mute);
1499 int mm_player_get_mute(MMHandleType player, int *mute);
1502 * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
1503 * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
1505 * @param player [in] Handle of player
1506 * @param pos [in] postion to be adjusted
1508 * @return This function returns zero on success, or negative value with error
1510 * @see mm_player_adjust_subtitle_position
1517 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
1519 debug_warning("failed to adjust subtitle postion.\n");
1524 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
1527 * This function is to set the offset in timestamps of video so as to bring the a/v sync
1528 * @param player Handle of player
1529 * @param offset offset to be set in milliseconds(can be positive or negative both)
1530 * postive offset to make video lag
1531 * negative offset to make video lead
1533 int mm_player_adjust_video_position(MMHandleType player,int offset);
1535 * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
1536 * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
1537 * Player FW parses subtitle file and send text data including timestamp to application \n
1538 * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
1539 * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
1540 * So, it's not supported for embedded case.
1542 * @param player [in] Handle of player
1543 * @param silent [in] silent(integer value except 0) or not silent(0)
1545 * @return This function returns zero on success, or negative value with error
1547 * @see mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1551 mm_player_set_attribute(g_player,
1553 "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1557 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1559 debug_warning("failed to set subtitle silent\n");
1563 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1566 * This function is to get silent status of subtitle.
1568 * @param player [in] Handle of player
1569 * @param silent [out] subtitle silent property
1571 * @return This function returns zero on success, or negative value with error
1573 * @see mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1579 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1581 debug_warning("failed to set subtitle silent\n");
1585 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1588 * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1589 * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1591 * @param player [in] Handle of player.
1592 * @param err_attr_name [out] Name of attribute which is failed to set
1593 * @param first_attribute_name [in] Name of the first attribute to set
1594 * @param ... [in] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1595 * But, in the case of data or string type, it should be name/value/size.
1597 * @return This function returns zero on success, or negative value with error code.
1599 * @see mm_player_get_attribute
1600 * @remark This function must be terminated by NULL argument.
1601 * And, if this function is failed, err_attr_name param must be free.
1604 char *g_err_attr_name = NULL;
1606 if (mm_player_set_attribute(g_player,
1608 "profile_uri", filename, strlen(filename),
1609 "profile_play_count", count,
1610 NULL) != MM_ERROR_NONE)
1612 debug_warning("failed to set %s attribute\n", g_err_attr_name);
1613 free(g_err_attr_name);
1618 int mm_player_set_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1621 * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1623 * @param player [in] Handle of player.
1624 * @param err_attr_name [out] Name of attribute which is failed to get
1625 * @param first_attribute_name [in] Name of the first attribute to get
1626 * @param ... [out] 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
1631 * @see mm_player_set_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_get_attribute(g_player, &g_err_attr_name, "content_duration", &duration, NULL) != MM_ERROR_NONE)
1640 debug_warning("failed to set %s attribute\n", g_err_attr_name);
1641 free(g_err_attr_name);
1645 int mm_player_get_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1648 * This function is to get detail information of attribute.
1650 * @param player [in] Handle of player.
1651 * @param attribute_name [in] Name of the attribute to get
1652 * @param info [out] Attribute infomation
1654 * @return This function returns zero on success, or negative value with error
1657 * @see mm_player_set_attribute, mm_player_get_attribute
1661 if (mm_player_get_attribute_info (g_player, "display_method", &method_info) != MM_ERROR_NONE)
1663 debug_warning("failed to get info\n");
1666 debug_log("type:%d \n", method_info.type); //int, double..
1667 debug_log("flag:%d \n", method_info.flag); //readable, writable..
1668 debug_log("validity type:%d \n", method_info.validity_type); //range, array..
1670 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE)
1672 debug_log("range min:%d\n", method_info.int_range.min);
1673 debug_log("range max:%d\n", method_info.int_range.max);
1677 int mm_player_get_attribute_info(MMHandleType player, const char *attribute_name, MMPlayerAttrsInfo *info);
1680 * This function is to get download position and total size of progressive download
1682 * @param player [in] Handle of player.
1683 * @param current_pos [in] Download position currently (bytes)
1684 * @param total_size [in] Total size of file (bytes)
1686 * @return This function returns zero on success, or negative value with error code.
1692 guint64 current_pos = 0LLU;
1693 guint64 total_size = 0LLU;
1695 if (mm_player_get_pd_status(g_player, ¤t_pos, &total_size, NULL) != MM_ERROR_NONE)
1697 debug_log("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1701 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1704 * This function sets callback function for receiving messages of PD downloader.
1706 * @param player [in] Handle of player.
1707 * @param callback [in] Message callback function.
1708 * @param user_param [in] User parameter which is passed to callback function.
1710 * @return This function returns zero on success, or negative value with error code.
1715 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1719 case MM_MESSAGE_PD_DOWNLOADER_START:
1720 debug_log("Progressive download is started...\n");
1722 case MM_MESSAGE_PD_DOWNLOADER_END:
1723 debug_log("Progressive download is ended...\n");
1731 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1734 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1737 * This function is to get the track count
1739 * @param player [in] handle of player.
1740 * @param track [in] type of the track type
1741 * @param info [out] the count of the track
1743 * @return This function returns zero on success, or negative value with error
1750 gint audio_count = 0;
1752 if (mm_player_get_track_count (g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE)
1754 debug_warning("failed to get audio track count\n");
1757 debug_log("audio track count : %d \n", audio_count);
1760 int mm_player_get_track_count(MMHandleType player, MMPlayerTrackType type, int *count);
1763 * This function is to select the track
1765 * @param player [in] handle of player.
1766 * @param type [in] type of the track type
1767 * @param index [in] the index of the track
1769 * @return This function returns zero on success, or negative value with error
1775 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1778 * This function is to add the track when user want multi subtitle
1780 * @param player [in] handle of player.
1781 * @param index [in] the index of the track
1783 * @return This function returns zero on success, or negative value with error
1789 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1792 * This function is to remove the track when user want multi subtitle
1794 * @param player [in] handle of player.
1795 * @param index [in] the index of the track
1797 * @return This function returns zero on success, or negative value with error
1803 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1806 * This function is to notify which sutitle track is in use
1808 * @param player [in] handle of player.
1809 * @param callback [in] callback function to register
1810 * @param user_data [in] user data to be passed to the callback function
1812 * @return This function returns zero on success, or negative value with error
1818 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1821 * This function is to get the track language
1823 * @param player [in] handle of player.
1824 * @param type [in] type of the track type
1825 * @param index [in] the index of the track
1826 * @param code [out] language code in ISO 639-1(string)
1828 * @return This function returns zero on success, or negative value with error
1834 int mm_player_get_track_language_code(MMHandleType player, MMPlayerTrackType type, int index, char **code);
1837 * This function is to get the current running track
1839 * @param player [in] handle of player.
1840 * @param type [in] type of the track type
1841 * @param index [out] the index of the track
1843 * @return This function returns zero on success, or negative value with error
1850 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1853 * This function is to set the buffer size for streaming playback. \n
1855 * @param player [in] Handle of player
1856 * @param second [in] Size of initial buffer
1858 * @return This function returns zero on success, or negative value with error code.
1862 gint second = 10; //10sec
1864 if (mm_player_set_prepare_buffering_time(g_player, second) != MM_ERROR_NONE)
1866 debug_error("failed to set buffer size\n");
1871 int mm_player_set_prepare_buffering_time(MMHandleType player, int second);
1874 * This function is to set the runtime buffering mode for streaming playback. \n
1876 * @param player [in] Handle of player
1877 * @param mode [in] mode of runtime buffering
1878 * @param second [in] max size of buffering
1880 * @return This function returns zero on success, or negative value with error code.
1885 if (mm_player_set_runtime_buffering_mode(g_player, MM_PLAYER_BUFFERING_MODE_ADAPTIVE, 10) != MM_ERROR_NONE)
1887 debug_error("failed to set buffering mode\n");
1892 int mm_player_set_runtime_buffering_mode(MMHandleType player, MMPlayerBufferingMode mode, int second);
1895 * This function is to set the start position of zoom
1897 * @param player [in] handle of player
1898 * @param level [in] level of zoom
1899 * @param x [in] start x position
1900 * @param y [in] start y position
1902 * @return This function returns zero on success, or negative value with error
1908 int mm_player_set_display_zoom(MMHandleType player, float level, int x, int y);
1911 * This function is to get the start position of zoom
1913 * @param player [in] handle of player
1914 * @param type [out] current level of zoom
1915 * @param x [out] start x position
1916 * @param y [out] start y position
1918 * @return This function returns zero on success, or negative value with error
1924 int mm_player_get_display_zoom(MMHandleType player, float *level, int *x, int *y);
1927 * This function is to set the subtitle path
1929 * @param player [in] handle of player
1930 * @param path [in] subtitle path
1932 * @return This function returns zero on success, or negative value with error code.
1937 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1940 * This function is to set the clock which is from master player
1942 * @param player [in] handle of player
1943 * @param clock [in] clock of master player
1944 * @param clock_delta [in] clock difference between master and slave
1945 * @param video_time [in] current playing position
1946 * @param media_clock [in] media clock information
1947 * @param audio_time [in] audio timestamp information
1948 * @return This function returns zero on success, or negative value with error code.
1953 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);
1955 * This function is to get the master clock
1957 * @param player [in] handle of player
1958 * @param video_time [out] current playing position
1959 * @param media_clock [out] media clock information
1960 * @param audio_time [out] audio timestamp information
1961 * @return This function returns zero on success, or negative value with error code.
1966 int mm_player_get_video_share_master_clock(MMHandleType player, long long *video_time, long long *media_clock, long long *audio_time);
1968 * This function is to set audio channel
1970 * @param player [in] handle of player
1971 * @param ch [in] audio channel
1972 * @return This function returns zero on success, or negative value with error code.
1977 int mm_player_gst_set_audio_channel(MMHandleType player, MMPlayerAudioChannel ch);
1980 * This function is to get the content angle
1982 * @param player [in] handle of player
1983 * @param angle [out] orignal angle from content
1984 * @return This function returns zero on success, or negative value with error code.
1989 int mm_player_get_video_rotate_angle(MMHandleType player, int *angle);
1992 * This function is to set download mode of video hub
1994 * @param player [in] handle of player
1995 * @param mode [in] download mode
1996 * @return This function returns zero on success, or negative value with error code.
2001 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
2004 * This function is to set using sync handler.
2006 * @param player [in] handle of player
2007 * @param enable [in] enable/disable
2008 * @return This function returns zero on success, or negative value with error code.
2013 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
2016 * This function is to set uri.
2018 * @param player [in] handle of player
2019 * @param uri [in] uri
2020 * @return This function returns zero on success, or negative value with error code.
2025 int mm_player_set_uri(MMHandleType player, const char *uri);
2028 * This function is to set next uri.
2030 * @param player [in] handle of player
2031 * @param uri [in] uri
2032 * @return This function returns zero on success, or negative value with error code.
2037 int mm_player_set_next_uri(MMHandleType player, const char *uri);
2040 * This function is to get next uri.
2042 * @param player [in] handle of player
2043 * @param uri [out] uri
2044 * @return This function returns zero on success, or negative value with error code.
2049 int mm_player_get_next_uri(MMHandleType player, char **uri);
2051 int mm_player_enable_media_packet_video_stream(MMHandleType player, bool enable);
2054 * This function is to increase reference count of internal buffer.
2056 * @param buffer [in] video callback internal buffer
2057 * @return This function returns buffer point;
2062 void * mm_player_media_packet_video_stream_internal_buffer_ref(void *buffer);
2065 * This function is to decrease reference count of internal buffer.
2067 * @param buffer [in] video callback internal buffer
2073 void mm_player_media_packet_video_stream_internal_buffer_unref(void *buffer);
2075 /**mm_player_submit_packet
2076 * This function is to submit buffer to appsrc. \n
2077 * @param player [in] Handle of player.
2078 * @param buf [in] buffer to be submit in appsrc in external feeder case.
2079 * @param len [in] length of buffer.
2080 * @param pts [in] timestamp of buffer.
2081 * @param streamtype [in] stream type of buffer.
2082 * @return This function returns zero on success, or negative value with error code.
2087 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
2089 /**mm_player_set_video_info
2090 * This function is to set caps of src pad of video appsrc in external feeder case. \n
2091 * @param player [in] Handle of player.
2092 * @param media_format_h [in] Video stream info.
2093 * @return This function returns zero on success, or negative value with error code.
2099 int mm_player_set_video_info (MMHandleType player, media_format_h format);
2101 /**mm_player_set_audio_info
2102 * This function is to set caps of src pad of Audio appsrc in external feeder case. \n
2103 * @param player [in] Handle of player.
2104 * @param media_format_h [in] Audio stream info.
2105 * @return This function returns zero on success, or negative value with error code.
2111 int mm_player_set_audio_info (MMHandleType player, media_format_h format);
2113 /**mm_player_set_subtitle_info
2114 * This function is to set caps of src pad of subtitle appsrc in external feeder case. \n
2115 * @param player [in] Handle of player.
2116 * @param subtitle_stream_info [in] Subtitle stream info.
2117 * @return This function returns zero on success, or negative value with error code.
2123 int mm_player_set_subtitle_info (MMHandleType player, MMPlayerSubtitleStreamInfo *info);
2126 * This function set callback function for receiving need or enough data message from player.
2128 * @param player [in] Handle of player.
2129 * @param type [in] stream type
2130 * @param callback [in] data callback function for stream type.
2131 * @param user_param [in] User parameter.
2133 * @return This function returns zero on success, or negative value with error
2139 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
2142 * This function set callback function for receiving seek data message from player.
2144 * @param player [in] Handle of player.
2145 * @param type [in] stream type
2146 * @param callback [in] Seek data callback function for stream type.
2147 * @param user_param [in] User parameter.
2149 * @return This function returns zero on success, or negative value with error
2155 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
2158 * This function is to set max size of buffer(appsrc).
2160 * @param player [in] Handle of player.
2161 * @param type [in] stream type
2162 * @param max_size [in] max bytes of buffer.
2164 * @return This function returns zero on success, or negative value with error
2170 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
2173 * This function is to get max size of buffer(appsrc).
2175 * @param player [in] Handle of player.
2176 * @param type [in] stream type
2177 * @param max_size [out] max bytes of buffer.
2179 * @return This function returns zero on success, or negative value with error
2185 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
2188 * This function is to set min percent of buffer(appsrc).
2190 * @param player [in] Handle of player.
2191 * @param type [in] stream type
2192 * @param min_percent [in] min percent of buffer.
2194 * @return This function returns zero on success, or negative value with error
2200 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
2203 * This function is to get min percent of buffer(appsrc).
2205 * @param player [in] Handle of player.
2206 * @param type [in] stream type
2207 * @param min_percent [out] min percent of buffer.
2209 * @return This function returns zero on success, or negative value with error
2215 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
2218 * This function set callback function for changing audio stream from player. \n
2219 * It's only supported when audio stream is included in file. \n
2221 * @param player [in] Handle of player.
2222 * @param callback [in] Audio stream changed callback function.
2223 * @param user_param [in] User parameter.
2225 * @return This function returns zero on success, or negative value with error
2227 * @see mm_player_stream_changed_callback
2230 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2233 * This function set callback function for changing video stream from player. \n
2234 * It's only supported when video stream is included in file. \n
2236 * @param player [in] Handle of player.
2237 * @param callback [in] Video stream changed callback function.
2238 * @param user_param [in] User parameter.
2240 * @return This function returns zero on success, or negative value with error
2242 * @see mm_player_stream_changed_callback
2245 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
2255 #endif /* __MM_PLAYER_H__ */