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>
43 /*===========================================================================================
45 | GLOBAL DEFINITIONS AND DECLARATIONS |
47 ========================================================================================== */
52 * uri to play (string)
55 #define MM_PLAYER_CONTENT_URI "profile_uri"
57 * MM_PLAYER_VIDEO_ROTATION
59 * can change video angle (int)
60 * @see MMDisplayRotationType
62 #define MM_PLAYER_VIDEO_ROTATION "display_rotation"
64 * MM_PLAYER_VIDEO_WIDTH:
66 * get the video width (int), It's guaranteed after calling mm_player_start() or
67 * receiving MM_MESSAGE_BEGIN_OF_STREAM.
70 #define MM_PLAYER_VIDEO_WIDTH "content_video_width"
72 * MM_PLAYER_VIDEO_HEIGHT:
74 * get the video height (int), It's guaranteed after calling mm_player_start() or
75 * receiving MM_MESSAGE_BEGIN_OF_STREAM.
78 #define MM_PLAYER_VIDEO_HEIGHT "content_video_height"
80 * MM_PLAYER_VIDEO_EVAS_SURFACE_SINK:
82 * get the video evas surface sink plugin name (string), It's guaranteed after calling mm_player_create()
85 #define MM_PLAYER_VIDEO_EVAS_SURFACE_SINK "display_evas_surface_sink"
89 * set memory pointer to play (data)
92 #define MM_PLAYER_MEMORY_SRC "profile_user_param"
94 * MM_PLAYER_PLAYBACK_COUNT
96 * can set playback count (int), Default value is 1 and -1 is for infinity playing until releasing it.
99 #define MM_PLAYER_PLAYBACK_COUNT "profile_play_count"
101 * MM_PLAYER_SUBTITLE_URI
103 * set the subtitle path (string)
105 #define MM_PLAYER_SUBTITLE_URI "subtitle_uri"
107 * MM_PLAYER_STREAMING_USER_AGENT
109 * set the streaming user agent (string)
111 #define MM_PLAYER_STREAMING_USER_AGENT "streaming_user_agent"
113 * MM_PLAYER_STREAMING_COOKIE
115 * set the streaming cookie (int)
117 #define MM_PLAYER_STREAMING_COOKIE "streaming_cookie"
119 * MM_PLAYER_VIDEO_CODEC
121 * codec the video data is stored in (string)
123 #define MM_PLAYER_VIDEO_CODEC "content_video_codec"
125 * MM_PLAYER_AUDIO_CODEC
127 * codec the audio data is stored in (string)
129 #define MM_PLAYER_AUDIO_CODEC "content_audio_codec"
131 * MM_PLAYER_AUDIO_BITRATE
133 * set the streaming proxy port (int)
135 #define MM_PLAYER_AUDIO_BITRATE "content_audio_bitrate"
137 * MM_PLAYER_AUDIO_CHANNEL
139 * the number of audio channel (int)
141 #define MM_PLAYER_AUDIO_CHANNEL "content_audio_channels"
143 * MM_PLAYER_AUDIO_SAMPLERATE
145 * audio samplerate (int)
147 #define MM_PLAYER_AUDIO_SAMPLERATE "content_audio_samplerate"
149 * MM_PLAYER_AUDIO_TRACK_NUM
151 * track number inside a collection (int)
153 #define MM_PLAYER_AUDIO_TRACK_NUM "content_audio_track_num"
155 * MM_PLAYER_TEXT_TRACK_NUM
157 * track number inside a collection (int)
159 #define MM_PLAYER_TEXT_TRACK_NUM "content_text_track_num"
161 * MM_PLAYER_TAG_ARTIST
163 * person(s) responsible for the recording (string)
165 #define MM_PLAYER_TAG_ARTIST "tag_artist"
167 * MM_PLAYER_TAG_TITLE
171 #define MM_PLAYER_TAG_TITLE "tag_title"
173 * MM_PLAYER_TAG_ALBUM
175 * album containing this data (string)
177 #define MM_PLAYER_TAG_ALBUM "tag_album"
179 * MM_PLAYER_TAG_GENRE
181 * genre this data belongs to (string)
183 #define MM_PLAYER_TAG_GENRE "tag_genre"
185 * MM_PLAYER_TAG_AUTHOUR
189 #define MM_PLAYER_TAG_AUTHOUR "tag_author"
191 * MM_PLAYER_TAG_COPYRIGHT
193 * copyright notice of the data (string)
195 #define MM_PLAYER_TAG_COPYRIGHT "tag_copyright"
199 * date the data was created (string)
201 #define MM_PLAYER_TAG_DATE "tag_date"
203 * MM_PLAYER_TAG_DESCRIPRION
205 * short text describing the content of the data (string)
207 #define MM_PLAYER_TAG_DESCRIPRION "tag_description"
209 * MM_PLAYER_TAG_TRACK_NUM
211 * track number inside a collection (int)
213 #define MM_PLAYER_TAG_TRACK_NUM "tag_track_num"
217 * progressive download mode (int)
219 #define MM_PLAYER_PD_MODE "pd_mode"
224 * dynamic resolution change mode (int)
226 #define MM_PLAYER_DRC_MODE "drc_mode"
229 * MM_PLAYER_GAPLESS_MODE
231 * gapless playback mode (int)
233 #define MM_PLAYER_GAPLESS_MODE "gapless_mode"
236 * MM_PLAYER_ENABLE_VIDEO_DECODED_CB
238 * enable video decoded callback (int)
240 #define MM_PLAYER_ENABLE_VIDEO_DECODED_CB "enable_video_decoded_cb"
243 * MM_PLAYER_VIDEO_CODEC_TYPE
245 * video codec type (int)
247 #define MM_PLAYER_VIDEO_CODEC_TYPE "video_codec_type"
250 * MM_PLAYER_AUDIO_CODEC_TYPE
252 * audio codec type (int)
254 #define MM_PLAYER_AUDIO_CODEC_TYPE "audio_codec_type"
256 #define BUFFER_MAX_PLANE_NUM (4)
259 MMPixelFormatType format; /**< image format */
260 int width; /**< width of video buffer */
261 int height; /**< height of video buffer */
262 unsigned int timestamp; /**< timestamp of stream buffer (msec)*/
263 unsigned int length_total; /**< total length of stream buffer (in byte)*/
264 void *data[BUFFER_MAX_PLANE_NUM];
265 void *bo[BUFFER_MAX_PLANE_NUM]; /**< TBM buffer object */
266 void *internal_buffer; /**< Internal buffer pointer */
267 int stride[BUFFER_MAX_PLANE_NUM]; /**< stride of plane */
268 int elevation[BUFFER_MAX_PLANE_NUM]; /**< elevation of plane */
269 int orientation; /**< orientation */
270 int bo_size; /**< TBM buffer object size */
271 } MMPlayerVideoStreamDataType;
274 * Enumerations of player state.
277 MM_PLAYER_STATE_NULL, /**< Player is created, but not realized yet */
278 MM_PLAYER_STATE_READY, /**< Player is ready to play media */
279 MM_PLAYER_STATE_PLAYING, /**< Player is now playing media */
280 MM_PLAYER_STATE_PAUSED, /**< Player is paused while playing media */
281 MM_PLAYER_STATE_NONE, /**< Player is not created yet */
282 MM_PLAYER_STATE_NUM, /**< Number of player states */
286 * Enumerations of position formats.
289 MM_PLAYER_POS_FORMAT_TIME, /**< Format for time based */
290 MM_PLAYER_POS_FORMAT_PERCENT, /**< Format for percentage */
291 MM_PLAYER_POS_FORMAT_NUM, /**< Number of position formats */
292 } MMPlayerPosFormatType;
295 * Enumeration for attribute values types.
298 MM_PLAYER_ATTRS_TYPE_INVALID = -1, /**< Type is invalid */
299 MM_PLAYER_ATTRS_TYPE_INT, /**< Integer type */
300 MM_PLAYER_ATTRS_TYPE_DOUBLE, /**< Double type */
301 MM_PLAYER_ATTRS_TYPE_STRING, /**< UTF-8 String type */
302 MM_PLAYER_ATTRS_TYPE_DATA, /**< Pointer type */
303 MM_PLAYER_ATTRS_TYPE_ARRAY, /**< Array type */
304 MM_PLAYER_ATTRS_TYPE_RANGE, /**< Range type */
305 MM_PLAYER_ATTRS_TYPE_NUM, /**< Number of attribute type */
309 * Enumeration for attribute validation type.
312 MM_PLAYER_ATTRS_VALID_TYPE_INVALID = -1, /**< Invalid validation type */
313 MM_PLAYER_ATTRS_VALID_TYPE_NONE, /**< Do not check validity */
314 MM_PLAYER_ATTRS_VALID_TYPE_INT_ARRAY, /**< validity checking type of integer array */
315 MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE, /**< validity checking type of integer range */
316 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_ARRAY, /**< validity checking type of double array */
317 MM_PLAYER_ATTRS_VALID_TYPE_DOUBLE_RANGE, /**< validity checking type of double range */
318 } MMPlayerAttrsValidType;
321 * Enumeration for attribute access flag.
324 MM_PLAYER_ATTRS_FLAG_NONE = 0, /**< None flag is set */
325 MM_PLAYER_ATTRS_FLAG_READABLE = 1 << 0, /**< Readable */
326 MM_PLAYER_ATTRS_FLAG_WRITABLE = 1 << 1, /**< Writable */
327 MM_PLAYER_ATTRS_FLAG_MODIFIED = 1 << 2, /**< Modified */
329 MM_PLAYER_ATTRS_FLAG_RW = MM_PLAYER_ATTRS_FLAG_READABLE | MM_PLAYER_ATTRS_FLAG_WRITABLE, /**< Readable and Writable */
333 * Enumeration for progressive download
336 MM_PLAYER_PD_MODE_NONE,
337 MM_PLAYER_PD_MODE_URI,
338 MM_PLAYER_PD_MODE_FILE // not tested yet, because of no fixed scenario
342 * Enumeration of track types
345 MM_PLAYER_TRACK_TYPE_AUDIO = 0,
346 MM_PLAYER_TRACK_TYPE_VIDEO,
347 MM_PLAYER_TRACK_TYPE_TEXT,
348 MM_PLAYER_TRACK_TYPE_MAX
352 * Enumeration of runtime buffering mode
355 MM_PLAYER_BUFFERING_MODE_ADAPTIVE = 0, /**< default, If buffering is occurred, player will consider the bandwidth to adjust buffer setting. */
356 MM_PLAYER_BUFFERING_MODE_FIXED, /**< player will set buffer size with this fixed size value. */
357 MM_PLAYER_BUFFERING_MODE_MAX,
358 } MMPlayerBufferingMode;
361 * Edge Properties of the text.
365 MM_PLAYER_EDGE_RAISED,
366 MM_PLAYER_EDGE_DEPRESSED,
367 MM_PLAYER_EDGE_UNIFORM,
368 MM_PLAYER_EDGE_DROPSHADOW
369 } MMPlayerSubtitleEdge;
372 * Enumeration of media stream buffer status
375 MM_PLAYER_MEDIA_STREAM_BUFFER_UNDERRUN,
376 MM_PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
377 } MMPlayerMediaStreamBufferStatus;
380 * Enumeration for stream type.
383 MM_PLAYER_STREAM_TYPE_DEFAULT, /**< Container type */
384 MM_PLAYER_STREAM_TYPE_AUDIO, /**< Audio element stream type */
385 MM_PLAYER_STREAM_TYPE_VIDEO, /**< Video element stream type */
386 MM_PLAYER_STREAM_TYPE_TEXT, /**< Text type */
387 MM_PLAYER_STREAM_TYPE_MAX,
388 } MMPlayerStreamType;
391 MM_PLAYER_CODEC_TYPE_DEFAULT = 0, /**< codec is selected by the priority */
392 MM_PLAYER_CODEC_TYPE_HW, /**< HW codec can only be selected */
393 MM_PLAYER_CODEC_TYPE_SW, /**< SW codec can only be selected */
394 } MMPlayerVideoCodecType;
397 * Attribute validity structure
400 MMPlayerAttrsType type;
401 MMPlayerAttrsValidType validity_type;
402 MMPlayerAttrsFlag flag;
404 * a union that describes validity of the attribute.
405 * Only when type is 'MM_ATTRS_TYPE_INT' or 'MM_ATTRS_TYPE_DOUBLE',
406 * the attribute can have validity.
410 * Validity structure for integer array.
413 int *array; /**< a pointer of array */
414 int count; /**< size of array */
418 * Validity structure for integer range.
421 int min; /**< minimum range */
422 int max; /**< maximum range */
426 * Validity structure for double array.
429 double * array; /**< a pointer of array */
430 int count; /**< size of array */
434 * Validity structure for double range.
437 double min; /**< minimum range */
438 double max; /**< maximum range */
447 * @see mm_player_set_volume, mm_player_get_volume
450 float level[MM_VOLUME_CHANNEL_NUM]; /**< Relative volume factor for each channels */
451 } MMPlayerVolumeType;
454 * Video stream info in external demux case
457 typedef struct _VideoStreamInfo {
459 unsigned int framerate_num;
460 unsigned int framerate_den;
463 unsigned char *codec_extradata;
464 unsigned int extradata_size;
465 unsigned int version;
466 } MMPlayerVideoStreamInfo;
469 * Audio stream info in external demux case
472 typedef struct _AudioStreamInfo {
474 unsigned int channels;
475 unsigned int sample_rate;
476 unsigned char *codec_extradata;
477 unsigned int extradata_size;
478 unsigned int version;
479 unsigned int user_info;
482 // unsigned int width;
483 // unsigned int depth;
484 // unsigned int endianness;
486 } MMPlayerAudioStreamInfo;
489 * Subtitle stream info in external demux case
492 typedef struct _SubtitleStreamInfo {
494 unsigned int codec_tag;
495 void *context; //for smpte text
496 } MMPlayerSubtitleStreamInfo;
499 * selected subtitle track number callback function type.
501 * @param track_num [in] Track number of subtitle
502 * @param user_param [in] User defined parameter
505 * @return This callback function have to return MM_ERROR_NONE.
507 typedef bool (*mm_player_track_selected_subtitle_language_callback)(int track_num, void *user_param);
510 * Buffer underrun / overflow data callback function type.
512 * @param status [in] buffer status
513 * @param user_param [in] User defined parameter which is passed when set
514 * to enough data callback or need data callback
516 * @return This callback function have to return MM_ERROR_NONE.
518 typedef bool (*mm_player_media_stream_buffer_status_callback) (MMPlayerStreamType type, MMPlayerMediaStreamBufferStatus status, unsigned long long bytes, void *user_param);
521 * Buffer seek data callback function type.
523 * @param offset [in] offset for the buffer playback
524 * @param user_param [in] User defined parameter which is passed when set
525 * to seek data callback
527 * @return This callback function have to return MM_ERROR_NONE.
529 typedef bool (*mm_player_media_stream_seek_data_callback) (MMPlayerStreamType type, unsigned long long offset, void *user_param);
532 * Called to notify the stream changed.
534 * @param user_data [in] The user data passed from the callback registration function
536 * @return This callback function have to return MM_ERROR_NONE.
538 typedef bool (*mm_player_stream_changed_callback) (void *user_param);
541 /*===========================================================================================
543 | GLOBAL FUNCTION PROTOTYPES |
545 ========================================================================================== */
548 * This function creates a player object for playing multimedia contents. \n
549 * The attributes of player are created to get/set some values with application. \n
550 * And, mutex, gstreamer and other resources are initialized at this time. \n
551 * If player is created, the state will become MM_PLAYER_STATE_NULL.
553 * @param player [out] Handle of player
555 * @return This function returns zero on success, or negative value with error code. \n
556 * Please refer 'mm_error.h' to know it in detail.
558 * @post MM_PLAYER_STATE_NULL
559 * @see mm_player_destroy
560 * @remark You can create multiple handles on a context at the same time. \n
561 * However, player cannot guarantee proper operation because of limitation of resources, \n
562 * such as audio device or display device.
566 char *g_err_attr_name = NULL;
568 if (mm_player_create(&g_player) != MM_ERROR_NONE) {
569 LOGE("failed to create player\n");
572 if (mm_player_set_attribute(g_player,
574 "profile_uri", filename, strlen(filename),
575 "display_overlay", (void*)&g_win.xid, sizeof(g_win.xid),
576 NULL) != MM_ERROR_NONE) {
577 LOGE("failed to set %s attribute\n", g_err_attr_name);
578 free(g_err_attr_name);
581 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
584 int mm_player_create(MMHandleType *player);
587 * This function releases player object and all resources which were created by mm_player_create(). \n
588 * And, player handle will also be destroyed.
590 * @param player [in] Handle of player
592 * @return This function returns zero on success, or negative value with error code.
593 * @pre Player state may be MM_PLAYER_STATE_NULL. \n
594 * But, it can be called in any state.
595 * @post Because handle is released, there is no any state.
596 * @see mm_player_create
597 * @remark This method can be called with a valid player handle from any state to \n
598 * completely shutdown the player operation.
602 if (mm_player_destroy(g_player) != MM_ERROR_NONE) {
603 LOGE("failed to destroy player\n");
607 int mm_player_destroy(MMHandleType player);
610 * This function parses uri and makes gstreamer pipeline by uri scheme. \n
611 * So, uri should be set before realizing with mm_player_set_attribute(). \n
613 * @param player [in] Handle of player
615 * @return This function returns zero on success, or negative value with error code.
617 * @pre Player state should be MM_PLAYER_STATE_NULL.
618 * @post player state will be MM_PLAYER_STATE_READY.
619 * @see mm_player_unrealize
623 if (mm_player_realize(g_player) != MM_ERROR_NONE) {
624 LOGE("failed to realize player\n");
628 int mm_player_realize(MMHandleType player);
631 * This function uninitializes player object. So, resources and allocated memory \n
632 * will be freed. And, gstreamer pipeline is also destroyed. So, if you want to play \n
633 * other contents, player should be created again after destruction or realized with new uri.
635 * @param player [in] Handle of player
637 * @return This function returns zero on success, or negative value with error code.
638 * @pre Player state may be MM_PLAYER_STATE_READY to unrealize. \n
639 * But, it can be called in any state.
640 * @post Player state will be MM_PLAYER_STATE_NULL.
641 * @see mm_player_realize
642 * @remark This method can be called with a valid player handle from any state.
646 if (mm_player_unrealize(g_player) != MM_ERROR_NONE) {
647 LOGE("failed to unrealize player\n");
651 int mm_player_unrealize(MMHandleType player);
654 * This function is to abort pause state transition
655 * for unrealize or destroy.
657 int mm_player_abort_pause(MMHandleType player);
660 * This function is to get current state of player. \n
661 * Application have to check current state before doing some action.
663 * @param player [in] Handle of player
664 * @param state [out] current state of player on success
666 * @return This function returns zero on success, or negative value with error code.
668 * @see MMPlayerStateType
672 if (mm_player_get_state(g_player, &state) != MM_ERROR_NONE) {
673 LOGE("failed to get state\n");
677 int mm_player_get_state(MMHandleType player, MMPlayerStateType *state);
680 * This function is to set relative volume of player. \n
681 * So, It controls logical volume value. \n
682 * But, if developer want to change system volume, mm sound api should be used.
684 * @param player [in] Handle of player
685 * @param volume [in] Volume factor of each channel
687 * @return This function returns zero on success, or negative value with error code.
688 * @see MMPlayerVolumeType, mm_player_get_volume
689 * @remark The range of factor range is from 0 to 1.0. (1.0 = 100%) And, default value is 1.0.
692 MMPlayerVolumeType volume;
695 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
696 volume.level[i] = MM_VOLUME_LEVEL_MAX;
698 if (mm_player_set_volume(g_player, &volume) != MM_ERROR_NONE)
700 LOGE("failed to set volume\n");
704 int mm_player_set_volume(MMHandleType player, MMPlayerVolumeType *volume);
707 * This function is to get current volume factor of player.
709 * @param player [in] Handle of player.
710 * @param volume [out] Volume factor of each channel.
712 * @return This function returns zero on success, or negative value with error code.
714 * @see MMPlayerVolumeType, mm_player_set_volume
718 MMPlayerVolumeType volume;
721 if (mm_player_get_volume(g_player, &volume) != MM_ERROR_NONE)
723 LOGW("failed to get volume\n");
726 for (i = 0; i < MM_VOLUME_CHANNEL_NUM; i++)
727 LOGD("channel[%d] = %d \n", i, volume.level[i]);
730 int mm_player_get_volume(MMHandleType player, MMPlayerVolumeType *volume);
733 * This function is to start playing media contents. Demux(parser), codec and related plugins are decided \n
734 * at this time. And, MM_MESSAGE_BEGIN_OF_STREAM will be posted through callback function registered \n
735 * by mm_player_set_message_callback().
737 * @param player [in] Handle of player
739 * @return This function returns zero on success, or negative value with error code.
742 * @pre Player state may be MM_PLAYER_STATE_READY.
743 * @post Player state will be MM_PLAYER_STATE_PLAYING.
744 * @see mm_player_stop
748 if (mm_player_start(g_player) != MM_ERROR_NONE)
750 LOGE("failed to start player\n");
754 int mm_player_start(MMHandleType player);
757 * This function is to stop playing media contents and it's different with pause. \n
758 * If mm_player_start() is called after this, content will be started again from the beginning. \n
759 * So, it can be used to close current playback.
761 * @param player [in] Handle of player
763 * @return This function returns zero on success, or negative value with error code.
765 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
766 * @post Player state will be MM_PLAYER_STATE_READY.
767 * @see mm_player_start
771 if (mm_player_stop(g_player) != MM_ERROR_NONE)
773 LOGE("failed to stop player\n");
777 int mm_player_stop(MMHandleType player);
780 * This function is to pause playing media contents.
782 * @param player [in] Handle of player.
784 * @return This function returns zero on success, or negative value with error code.
786 * @pre Player state may be MM_PLAYER_STATE_PLAYING.
787 * @post Player state will be MM_PLAYER_STATE_PAUSED.
788 * @see mm_player_resume
792 if (mm_player_pause(g_player) != MM_ERROR_NONE)
794 LOGE("failed to pause player\n");
798 int mm_player_pause(MMHandleType player);
801 * This function is to resume paused media contents.
803 * @param player [in] Handle of player.
805 * @return This function returns zero on success, or negative value with error code.
807 * @pre Player state may be MM_PLAYER_STATE_PAUSED.
808 * @post Player state will be MM_PLAYER_STATE_PLAYING.
809 * @see mm_player_pause
813 if (mm_player_resume(g_player) != MM_ERROR_NONE)
815 LOGE("failed to resume player\n");
819 int mm_player_resume(MMHandleType player);
822 * This function is to set the position for playback. \n
823 * So, it can be seeked to requested position. \n
825 * @param player [in] Handle of player
826 * @param pos [in] Position for playback
828 * @return This function returns zero on success, or negative value with error code.
829 * @see mm_player_get_position
830 * @remark the unit of time-based format is millisecond and other case is percent.
832 int mm_player_set_position(MMHandleType player, int64_t pos);
835 * This function is to get current position of playback content.
837 * @param player [in] Handle of player.
838 * @param format [in] Format of position.
839 * @param pos [out] contains current position on success or zero in case of failure.
841 * @return This function returns zero on success, or negative value with errors
842 * @see mm_player_set_position
843 * @remark the unit of time-based format is millisecond and other case is percent.
845 int mm_player_get_position(MMHandleType player, int64_t *pos);
848 * This function is to get the content time duration.
850 int mm_player_get_duration(MMHandleType player, int64_t *dur);
853 * This function is to get current buffer position of playback content.
855 * @param player [in] Handle of player.
856 * @param format [in] Format of position.
857 * @param start_pos [out] contains buffer start position on success or zero in case of failure.
858 * @param stop_pos [out] contains buffer current position on success or zero in case of failure.
860 * @return This function returns zero on success, or negative value with errors
861 * @see MMPlayerPosFormatType, mm_player_set_position
862 * @remark the unit of time-based format is millisecond and other case is percent.
865 int start_pos = 0, stop_pos = 0;
867 mm_player_get_buffer_position(g_player, MM_PLAYER_POS_FORMAT_PERCENT, &start_pos, &stop_pos );
869 LOGD("buffer position: [%d] ~ [%d] \%\n", start_pos, stop_pos );
872 int mm_player_get_buffer_position(MMHandleType player, MMPlayerPosFormatType format, unsigned long *start_pos, unsigned long *stop_pos);
875 * This function sets callback function for receiving messages from player.
876 * So, player can notify warning, error and normal cases to application.
878 * @param player [in] Handle of player.
879 * @param callback [in] Message callback function.
880 * @param user_param [in] User parameter which is passed to callback function.
882 * @return This function returns zero on success, or negative value with error code.
883 * @see MMMessageCallback
887 int msg_callback(int message, MMMessageParamType *param, void *user_param)
891 case MM_MESSAGE_ERROR:
895 case MM_MESSAGE_END_OF_STREAM:
899 case MM_MESSAGE_STATE_CHANGED:
903 case MM_MESSAGE_BEGIN_OF_STREAM:
913 mm_player_set_message_callback(g_player, msg_callback, (void*)g_player);
916 int mm_player_set_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
919 * This function is to mute volume of player
921 * @param player [in] Handle of player
922 * @param mute [in] Mute(1) or not mute(0)
924 * @return This function returns zero on success, or negative value with error code
925 * @see mm_player_get_mute
929 if (mm_player_set_mute(g_player, TRUE) != MM_ERROR_NONE)
931 LOGW("failed to set mute\n");
935 int mm_player_set_mute(MMHandleType player, int mute);
938 * This function is to get mute value of player
940 * @param player [in] Handle of player
941 * @param mute [out] Sound is muted
943 * @return This function returns zero on success, or negative value with error code
944 * @see mm_player_set_mute
950 if (mm_player_get_mute(g_player, &mute) != MM_ERROR_NONE)
952 LOGW("failed to get mute\n");
955 LOGD("mute status:%d\n", mute);
958 int mm_player_get_mute(MMHandleType player, int *mute);
961 * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
962 * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
964 * @param player [in] Handle of player
965 * @param pos [in] postion to be adjusted
967 * @return This function returns zero on success, or negative value with error
969 * @see mm_player_adjust_subtitle_position
976 if (mm_player_adjust_subtitle_position(g_player, MM_PLAYER_POS_FORMAT_TIME, pos) != MM_ERROR_NONE)
978 LOGW("failed to adjust subtitle postion.\n");
983 int mm_player_adjust_subtitle_position(MMHandleType player, MMPlayerPosFormatType format, int pos);
986 * This function is to set subtitle silent status. So, subtitle can show or hide during playback \n
987 * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
988 * Player FW parses subtitle file and send text data including timestamp to application \n
989 * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
990 * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
991 * So, it's not supported for embedded case.
993 * @param player [in] Handle of player
994 * @param silent [in] silent(integer value except 0) or not silent(0)
996 * @return This function returns zero on success, or negative value with error
998 * @see mm_player_get_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1002 mm_player_set_attribute(g_player,
1004 "subtitle_uri", g_subtitle_uri, strlen(g_subtitle_uri),
1008 if (mm_player_set_subtitle_silent(g_player, TRUE) != MM_ERROR_NONE)
1010 LOGW("failed to set subtitle silent\n");
1014 int mm_player_set_subtitle_silent(MMHandleType player, int silent);
1017 * This function is to get silent status of subtitle.
1019 * @param player [in] Handle of player
1020 * @param silent [out] subtitle silent property
1022 * @return This function returns zero on success, or negative value with error
1024 * @see mm_player_set_subtitle_silent, MM_MESSAGE_UPDATE_SUBTITLE
1030 if (mm_player_get_subtitle_silent(g_player, &silent) != MM_ERROR_NONE)
1032 LOGW("failed to set subtitle silent\n");
1036 int mm_player_get_subtitle_silent(MMHandleType player, int *silent);
1039 * This function is to set attributes into player. Multiple attributes can be set simultaneously. \n
1040 * If one of attribute fails, this function will stop at the point and let you know the name which is failed. \n
1042 * @param player [in] Handle of player.
1043 * @param err_attr_name [out] Name of attribute which is failed to set
1044 * @param first_attribute_name [in] Name of the first attribute to set
1045 * @param ... [in] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1046 * But, in the case of data or string type, it should be name/value/size.
1048 * @return This function returns zero on success, or negative value with error code.
1050 * @see mm_player_get_attribute
1051 * @remark This function must be terminated by NULL argument.
1052 * And, if this function is failed, err_attr_name param must be free.
1055 char *g_err_attr_name = NULL;
1057 if (mm_player_set_attribute(g_player,
1059 "profile_uri", filename, strlen(filename),
1060 "profile_play_count", count,
1061 NULL) != MM_ERROR_NONE) {
1062 LOGW("failed to set %s attribute\n", g_err_attr_name);
1063 free(g_err_attr_name);
1068 int mm_player_set_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1071 * This function is to get attributes from player. Multiple attributes can be got simultaneously.
1073 * @param player [in] Handle of player.
1074 * @param err_attr_name [out] Name of attribute which is failed to get
1075 * @param first_attribute_name [in] Name of the first attribute to get
1076 * @param ... [out] Value for the first attribute, followed optionally by more name/value pairs, terminated by NULL.
1077 * But, in the case of data or string type, it should be name/value/size.
1079 * @return This function returns zero on success, or negative value with error
1081 * @see mm_player_set_attribute
1082 * @remark This function must be terminated by NULL argument.
1083 * And, if this function is failed, err_attr_name param must be free.
1085 int mm_player_get_attribute(MMHandleType player, char **err_attr_name, const char *first_attribute_name, ...)G_GNUC_NULL_TERMINATED;
1088 * This function is to get detail information of attribute.
1090 * @param player [in] Handle of player.
1091 * @param attribute_name [in] Name of the attribute to get
1092 * @param info [out] Attribute infomation
1094 * @return This function returns zero on success, or negative value with error
1097 * @see mm_player_set_attribute, mm_player_get_attribute
1101 if (mm_player_get_attribute_info(g_player, "display_method", &method_info) != MM_ERROR_NONE) {
1102 LOGW("failed to get info\n");
1105 LOGD("type:%d \n", method_info.type); //int, double..
1106 LOGD("flag:%d \n", method_info.flag); //readable, writable..
1107 LOGD("validity type:%d \n", method_info.validity_type); //range, array..
1109 if (method_info. validity_type == MM_PLAYER_ATTRS_VALID_TYPE_INT_RANGE) {
1110 LOGD("range min:%d\n", method_info.int_range.min);
1111 LOGD("range max:%d\n", method_info.int_range.max);
1115 int mm_player_get_attribute_info(MMHandleType player, const char *attribute_name, MMPlayerAttrsInfo *info);
1118 * This function is to get download position and total size of progressive download
1120 * @param player [in] Handle of player.
1121 * @param current_pos [in] Download position currently (bytes)
1122 * @param total_size [in] Total size of file (bytes)
1124 * @return This function returns zero on success, or negative value with error code.
1127 guint64 current_pos = 0LLU;
1128 guint64 total_size = 0LLU;
1130 if (mm_player_get_pd_status(g_player, ¤t_pos, &total_size, NULL) != MM_ERROR_NONE)
1132 LOGD("current download pos = %llu, total size = %llu\n", current_pos, total_size);
1136 int mm_player_get_pd_status(MMHandleType player, guint64 *current_pos, guint64 *total_size);
1139 * This function sets callback function for receiving messages of PD downloader.
1141 * @param player [in] Handle of player.
1142 * @param callback [in] Message callback function.
1143 * @param user_param [in] User parameter which is passed to callback function.
1145 * @return This function returns zero on success, or negative value with error code.
1150 int msg_callback(int message, MMMessageParamType *param, void *user_param)
1154 case MM_MESSAGE_PD_DOWNLOADER_START:
1155 LOGD("Progressive download is started...\n");
1157 case MM_MESSAGE_PD_DOWNLOADER_END:
1158 LOGD("Progressive download is ended...\n");
1166 mm_player_set_pd_message_callback(g_player, msg_callback, NULL);
1169 int mm_player_set_pd_message_callback(MMHandleType player, MMMessageCallback callback, void *user_param);
1172 * This function is to get the track count
1174 * @param player [in] handle of player.
1175 * @param track [in] type of the track type
1176 * @param info [out] the count of the track
1178 * @return This function returns zero on success, or negative value with error
1183 gint audio_count = 0;
1185 if (mm_player_get_track_count(g_player, MM_PLAYER_TRACK_TYPE_AUDIO, &audio_count) != MM_ERROR_NONE) {
1186 LOGW("failed to get audio track count\n");
1189 LOGD("audio track count : %d \n", audio_count);
1192 int mm_player_get_track_count(MMHandleType player, MMPlayerTrackType type, int *count);
1195 * This function is to select the track
1197 * @param player [in] handle of player.
1198 * @param type [in] type of the track type
1199 * @param index [in] the index of the track
1201 * @return This function returns zero on success, or negative value with error
1204 int mm_player_select_track(MMHandleType player, MMPlayerTrackType type, int index);
1207 * This function is to add the track when user want multi subtitle
1209 * @param player [in] handle of player.
1210 * @param index [in] the index of the track
1212 * @return This function returns zero on success, or negative value with error
1215 int mm_player_track_add_subtitle_language(MMHandleType player, int index);
1218 * This function is to remove the track when user want multi subtitle
1220 * @param player [in] handle of player.
1221 * @param index [in] the index of the track
1223 * @return This function returns zero on success, or negative value with error
1226 int mm_player_track_remove_subtitle_language(MMHandleType player, int index);
1229 * This function is to notify which sutitle track is in use
1231 * @param player [in] handle of player.
1232 * @param callback [in] callback function to register
1233 * @param user_data [in] user data to be passed to the callback function
1235 * @return This function returns zero on success, or negative value with error
1238 int mm_player_track_foreach_selected_subtitle_language(MMHandleType player, mm_player_track_selected_subtitle_language_callback callback, void *user_param);
1241 * This function is to get the track language
1243 * @param player [in] handle of player.
1244 * @param type [in] type of the track type
1245 * @param index [in] the index of the track
1246 * @param code [out] language code in ISO 639-1(string)
1248 * @return This function returns zero on success, or negative value with error
1251 int mm_player_get_track_language_code(MMHandleType player, MMPlayerTrackType type, int index, char **code);
1254 * This function is to get the current running track
1256 * @param player [in] handle of player.
1257 * @param type [in] type of the track type
1258 * @param index [out] the index of the track
1260 * @return This function returns zero on success, or negative value with error
1264 int mm_player_get_current_track(MMHandleType hplayer, MMPlayerTrackType type, int *index);
1267 * This function is to set the subtitle path
1269 * @param player [in] handle of player
1270 * @param path [in] subtitle path
1272 * @return This function returns zero on success, or negative value with error code.
1274 int mm_player_set_external_subtitle_path(MMHandleType player, const char* path);
1277 * This function is to set download mode of video hub
1279 * @param player [in] handle of player
1280 * @param mode [in] download mode
1281 * @return This function returns zero on success, or negative value with error code.
1283 int mm_player_set_video_hub_download_mode(MMHandleType player, bool mode);
1286 * This function is to set using sync handler.
1288 * @param player [in] handle of player
1289 * @param enable [in] enable/disable
1290 * @return This function returns zero on success, or negative value with error code.
1292 int mm_player_enable_sync_handler(MMHandleType player, bool enable);
1295 * This function is to set uri.
1297 * @param player [in] handle of player
1298 * @param uri [in] uri
1299 * @return This function returns zero on success, or negative value with error code.
1301 int mm_player_set_uri(MMHandleType player, const char *uri);
1304 * This function is to set next uri.
1306 * @param player [in] handle of player
1307 * @param uri [in] uri
1308 * @return This function returns zero on success, or negative value with error code.
1310 int mm_player_set_next_uri(MMHandleType player, const char *uri);
1313 * This function is to get next uri.
1315 * @param player [in] handle of player
1316 * @param uri [out] uri
1317 * @return This function returns zero on success, or negative value with error code.
1319 int mm_player_get_next_uri(MMHandleType player, char **uri);
1322 * This function is to decrease reference count of internal buffer.
1324 * @param buffer [in] video callback internal buffer
1327 void mm_player_video_stream_internal_buffer_unref(void *buffer);
1329 /**mm_player_submit_packet
1330 * This function is to submit buffer to appsrc. \n
1331 * @param player [in] Handle of player.
1332 * @param buf [in] buffer to be submit in appsrc in external feeder case.
1333 * @param len [in] length of buffer.
1334 * @param pts [in] timestamp of buffer.
1335 * @param streamtype [in] stream type of buffer.
1336 * @return This function returns zero on success, or negative value with error code.
1338 int mm_player_submit_packet(MMHandleType player, media_packet_h packet);
1340 /**mm_player_set_video_info
1341 * This function is to set caps of src pad of video appsrc in external feeder case. \n
1342 * @param player [in] Handle of player.
1343 * @param media_format_h [in] Video stream info.
1344 * @return This function returns zero on success, or negative value with error code.
1346 int mm_player_set_video_info(MMHandleType player, media_format_h format);
1348 /**mm_player_set_audio_info
1349 * This function is to set caps of src pad of Audio appsrc in external feeder case. \n
1350 * @param player [in] Handle of player.
1351 * @param media_format_h [in] Audio stream info.
1352 * @return This function returns zero on success, or negative value with error code.
1354 int mm_player_set_audio_info(MMHandleType player, media_format_h format);
1356 /**mm_player_set_subtitle_info
1357 * This function is to set caps of src pad of subtitle appsrc in external feeder case. \n
1358 * @param player [in] Handle of player.
1359 * @param subtitle_stream_info [in] Subtitle stream info.
1360 * @return This function returns zero on success, or negative value with error code.
1362 int mm_player_set_subtitle_info(MMHandleType player, MMPlayerSubtitleStreamInfo *info);
1365 * This function set callback function for receiving need or enough data message from player.
1367 * @param player [in] Handle of player.
1368 * @param type [in] stream type
1369 * @param callback [in] data callback function for stream type.
1370 * @param user_param [in] User parameter.
1372 * @return This function returns zero on success, or negative value with error
1375 int mm_player_set_media_stream_buffer_status_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_buffer_status_callback callback, void * user_param);
1378 * This function set callback function for receiving seek data message from player.
1380 * @param player [in] Handle of player.
1381 * @param type [in] stream type
1382 * @param callback [in] Seek data callback function for stream type.
1383 * @param user_param [in] User parameter.
1385 * @return This function returns zero on success, or negative value with error
1388 int mm_player_set_media_stream_seek_data_callback(MMHandleType player, MMPlayerStreamType type, mm_player_media_stream_seek_data_callback callback, void * user_param);
1391 * This function is to set max size of buffer(appsrc).
1393 * @param player [in] Handle of player.
1394 * @param type [in] stream type
1395 * @param max_size [in] max bytes of buffer.
1397 * @return This function returns zero on success, or negative value with error
1400 int mm_player_set_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long max_size);
1403 * This function is to get max size of buffer(appsrc).
1405 * @param player [in] Handle of player.
1406 * @param type [in] stream type
1407 * @param max_size [out] max bytes of buffer.
1409 * @return This function returns zero on success, or negative value with error
1412 int mm_player_get_media_stream_buffer_max_size(MMHandleType player, MMPlayerStreamType type, unsigned long long *max_size);
1415 * This function is to set min percent of buffer(appsrc).
1417 * @param player [in] Handle of player.
1418 * @param type [in] stream type
1419 * @param min_percent [in] min percent of buffer.
1421 * @return This function returns zero on success, or negative value with error
1424 int mm_player_set_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned min_percent);
1427 * This function is to get min percent of buffer(appsrc).
1429 * @param player [in] Handle of player.
1430 * @param type [in] stream type
1431 * @param min_percent [out] min percent of buffer.
1433 * @return This function returns zero on success, or negative value with error
1436 int mm_player_get_media_stream_buffer_min_percent(MMHandleType player, MMPlayerStreamType type, unsigned int *min_percent);
1439 * This function set callback function for changing audio stream from player. \n
1440 * It's only supported when audio stream is included in file. \n
1442 * @param player [in] Handle of player.
1443 * @param callback [in] Audio stream changed callback function.
1444 * @param user_param [in] User parameter.
1446 * @return This function returns zero on success, or negative value with error
1448 * @see mm_player_stream_changed_callback
1451 int mm_player_set_audio_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1454 * This function set callback function for changing video stream from player. \n
1455 * It's only supported when video stream is included in file. \n
1457 * @param player [in] Handle of player.
1458 * @param callback [in] Video stream changed callback function.
1459 * @param user_param [in] User parameter.
1461 * @return This function returns zero on success, or negative value with error
1463 * @see mm_player_stream_changed_callback
1465 int mm_player_set_video_stream_changed_callback(MMHandleType player, mm_player_stream_changed_callback callback, void *user_param);
1468 * This function is to get timeout value according to the content type for muse. \n
1469 * It's only supported when video stream is included in file. \n
1471 * @param player [in] Handle of player.
1472 * @param timeout [out] timeout value (sec).
1474 * @return This function returns zero on success, or negative value with error
1478 int mm_player_get_timeout(MMHandleType player, int *timeout);
1481 * This function is to get the number of video output buffers. \n
1482 * It's only supported when video stream is included in file. \n
1484 * @param player [in] Handle of player.
1485 * @param num [out] num of buffers.
1486 * @param extra_num [out] extra num of buffers.
1488 * @return This function returns zero on success, or negative value with error
1492 int mm_player_get_num_of_video_out_buffers(MMHandleType player, int *num, int *extra_num);
1495 * This function is to set the dynamic resolution information. \n
1496 * It's only supported when video stream is included in file. \n
1498 * @param player [in] Handle of player.
1499 * @param drc [in] dynamic resolution info of media stream data
1501 * @return This function returns zero on success, or negative value with error
1505 int mm_player_set_media_stream_dynamic_resolution(MMHandleType player, bool drc);
1508 * This function is to release the video stream bo to reuse. \n
1509 * It's only supported when sw codec is used to decode video stream. \n
1511 * @param player [in] Handle of player.
1512 * @param bo [in] bo address to be released
1514 * @return This function returns zero on success, or negative value with error
1518 int mm_player_release_video_stream_bo(MMHandleType player, void* bo);
1521 * This function is to set http file buffering path
1523 * @param player [in] handle of player
1524 * @param file_path [in] file path
1525 * @return This function returns zero on success, or negative value with error code.
1527 int mm_player_set_file_buffering_path(MMHandleType player, const char *file_path);
1530 * This function is to set sound stream info
1532 int mm_player_set_sound_stream_info(MMHandleType player, char *stream_type, int stream_index);
1535 * This function is to manage the playback according to the external storage state
1537 int mm_player_manage_external_storage_state(MMHandleType player, int id, int state);
1540 * These functions are to set/get the max variant of HAS
1542 int mm_player_get_adaptive_variant_info(MMHandleType player, int *num, char **var_info);
1543 int mm_player_set_max_adaptive_variant_limit(MMHandleType player, int bandwidth, int width, int height);
1544 int mm_player_get_max_adaptive_variant_limit(MMHandleType player, int *bandwidth, int *width, int *height);
1547 * These functions are to set/get the audio only mode
1549 int mm_player_set_audio_only(MMHandleType player, bool audio_only);
1550 int mm_player_get_audio_only(MMHandleType player, bool *audio_only);
1553 * These functions are to set/get the streaming bufferint time
1555 int mm_player_set_streaming_buffering_time(MMHandleType player, int buffer_ms, int rebuffer_ms);
1556 int mm_player_get_streaming_buffering_time(MMHandleType player, int *buffer_ms, int *rebuffer_ms);
1559 * These functions are to display the 360 video content
1561 int mm_player_360_is_content_spherical(MMHandleType player, bool *is_spherical);
1562 int mm_player_360_set_enabled(MMHandleType player, bool enabled);
1563 int mm_player_360_is_enabled(MMHandleType player, bool *enabled);
1565 int mm_player_360_set_direction_of_view(MMHandleType player, float yaw, float pitch);
1566 int mm_player_360_get_direction_of_view(MMHandleType player, float *yaw, float *pitch);
1568 int mm_player_360_set_zoom(MMHandleType player, float level);
1569 int mm_player_360_get_zoom(MMHandleType player, float *level);
1571 int mm_player_360_set_field_of_view(MMHandleType player, int horizontal_degrees, int vertical_degrees);
1572 int mm_player_360_get_field_of_view(MMHandleType player, int *horizontal_degrees, int *vertical_degrees);
1575 * This function is to set codec type
1577 int mm_player_set_codec_type(MMHandleType player, MMPlayerStreamType stream_type, MMPlayerVideoCodecType codec_type);
1580 * These functions are to apply the replaygain
1582 int mm_player_set_replaygain_enabled(MMHandleType player, bool enabled);
1583 int mm_player_is_replaygain_enabled(MMHandleType player, bool *enabled);
1586 * This function is to set/get video content ROI area
1588 int mm_player_set_video_roi_area(MMHandleType player, double scale_x, double scale_y, double scale_width, double scale_height);
1589 int mm_player_get_video_roi_area(MMHandleType player, double *scale_x, double *scale_y, double *scale_width, double *scale_height);
1599 #endif /* __MM_PLAYER_H__ */