[0.6.286] Change the property name for setting max-bitrate used in adaptivedemux
[platform/core/multimedia/libmm-player.git] / src / include / mm_player.h
index ec1fcb8..6ca6646 100644 (file)
  */
 #define MM_PLAYER_TAG_DATE                  "tag_date"
 /**
- * MM_PLAYER_TAG_DESCRIPRION
+ * MM_PLAYER_TAG_DESCRIPTION
  *
  * short text describing the content of the data (string)
  */
-#define MM_PLAYER_TAG_DESCRIPRION           "tag_description"
+#define MM_PLAYER_TAG_DESCRIPTION           "tag_description"
 /**
  * MM_PLAYER_TAG_TRACK_NUM
  *
  */
 #define MM_PLAYER_MEDIA_STREAM_INPUT_FORMAT "media_stream_input_format"
 
+/**
+ * MM_PLAYER_AUDIO_ONLY (int)
+ */
+#define MM_PLAYER_AUDIO_ONLY                "audio_only"
+
 #define BUFFER_MAX_PLANE_NUM (4)
 
 /**
@@ -407,10 +412,17 @@ typedef enum {
 } mmplayer_stream_type_e;
 
 typedef enum {
-       MM_PLAYER_CODEC_TYPE_DEFAULT = 0, /**< codec is selected by the priority */
        MM_PLAYER_CODEC_TYPE_HW,          /**< HW codec can only be selected */
        MM_PLAYER_CODEC_TYPE_SW,          /**< SW codec can only be selected */
-} mmplayer_video_codec_type_e;
+       MM_PLAYER_CODEC_TYPE_DEFAULT,     /**< codec is selected by the priority */
+} mmplayer_codec_type_e;
+
+typedef enum {
+       MM_PLAYER_AUDIO_CONTROL_OPT_EFFECT,
+       MM_PLAYER_AUDIO_CONTROL_OPT_REPLAYGAIN,
+       MM_PLAYER_AUDIO_CONTROL_OPT_PITCH,
+       MM_PLAYER_AUDIO_CONTROL_OPT_PCM_EXPORTING,
+} mmplayer_audio_control_opt_e;
 
 typedef enum {
        MM_PLAYER_AUDIO_EXTRACT_DEFAULT                        = 0x00,   /**< Sync with the playback clock and multichannel audio stream */
@@ -939,11 +951,11 @@ int mm_player_set_mute(MMHandleType player, bool mute);
 int mm_player_get_mute(MMHandleType player, bool *mute);
 
 /**
- * This function is to adjust subtitle postion. So, subtitle can show at the adjusted position. \n
+ * This function is to adjust subtitle position. So, subtitle can show at the adjusted position. \n
  * If pos is negative, subtitle will be displayed previous time, the other hand forward time. \n
  *
  * @param      player  [in]    Handle of player
- * @param      pos             [in]    postion to be adjusted
+ * @param      pos             [in]    position to be adjusted
  *
  * @return     This function returns zero on success, or negative value with error
  *                     code
@@ -956,7 +968,7 @@ int pos;
 pos = 5000;
 if (mm_player_adjust_subtitle_position(g_player, pos) != MM_ERROR_NONE)
 {
-       LOGW("failed to adjust subtitle postion.\n");
+       LOGW("failed to adjust subtitle position.\n");
 }
  * @endcode
  */
@@ -968,7 +980,7 @@ int mm_player_adjust_subtitle_position(MMHandleType player, int pos);
  * by this value. But, one subtitle file should be set with "subtitle_uri" attribute before calling mm_player_realize(); \n
  * Player FW parses subtitle file and send text data including timestamp to application \n
  * through message callback with MM_MESSAGE_UPDATE_SUBTITLE will be. \n
- * So, application have to render it. And, subtitle can be supported only in a seprate file. \n
+ * So, application have to render it. And, subtitle can be supported only in a separate file. \n
  * So, it's not supported for embedded case.
  *
  * @param      player  [in]    Handle of player
@@ -1070,7 +1082,7 @@ int mm_player_get_attribute(MMHandleType player,  char **err_attr_name, const ch
  *
  * @param   player          [in]  Handle of player.
  * @param   attribute_name  [in]  Name of the attribute to get
- * @param   info            [out] Attribute infomation
+ * @param   info            [out] Attribute information
  *
  * @return  This function returns zero on success, or negative value with error
  *          code.
@@ -1359,10 +1371,9 @@ int mm_player_get_max_adaptive_variant_limit(MMHandleType player, int *bandwidth
  * These functions are to set/get the audio only mode
  */
 int mm_player_set_audio_only(MMHandleType player, bool audio_only);
-int mm_player_get_audio_only(MMHandleType player, bool *audio_only);
 
 /**
- * These functions are to get the streaming bufferint time
+ * These functions are to get the streaming buffering time
  */
 int mm_player_get_streaming_buffering_time(MMHandleType player, int *prebuffer_ms, int *rebuffer_ms);
 
@@ -1385,7 +1396,7 @@ int mm_player_360_get_field_of_view(MMHandleType player, int *horizontal_degrees
 /**
  * This function is to set codec type
  */
-int mm_player_set_codec_type(MMHandleType player, mmplayer_stream_type_e stream_type, mmplayer_video_codec_type_e codec_type);
+int mm_player_set_codec_type(MMHandleType player, mmplayer_stream_type_e stream_type, mmplayer_codec_type_e codec_type);
 
 /**
  * These functions are to apply the replaygain
@@ -1408,7 +1419,7 @@ int mm_player_get_video_roi_area(MMHandleType player, double *scale_x, double *s
  * @return     This function returns zero on success, or negative value with error
  *                     code
  * @remark     The current supported range is from -64x to 64x.
- *             But, the quailty is dependent on codec performance.
+ *             But, the quality is dependent on codec performance.
  *             And, the sound is muted under normal speed and more than double speed.
  * @see
  * @since
@@ -1473,7 +1484,7 @@ int mm_player_do_video_capture(MMHandleType player);
  * @see
  * @since
  */
-int mm_player_change_videosink(MMHandleType player, MMDisplaySurfaceType display_surface_type, unsigned int wl_surface_id);
+int mm_player_change_videosink(MMHandleType player, MMDisplaySurfaceType display_surface_type, int wl_surface_id);
 
 /**
  * This function set the application PID.
@@ -1494,6 +1505,11 @@ int mm_player_set_client_pid(MMHandleType player, int pid);
 int mm_player_audio_offload_is_activated(MMHandleType player, bool *activated);
 
 /**
+ * This function checks whether the controlling audio with opt is available or not.
+ */
+int mm_player_is_audio_control_available(MMHandleType player, mmplayer_audio_control_opt_e opt, bool *available);
+
+/**
        @}
  */