[0.6.233] Execute commit after checking the return value of marking at resource destroy
[platform/core/multimedia/libmm-player.git] / src / include / mm_player_audioeffect.h
old mode 100755 (executable)
new mode 100644 (file)
index bde45e3..4920e71
@@ -69,7 +69,7 @@ typedef enum {
        MM_AUDIO_EFFECT_PRESET_STUDIO,       /**<  Preset type Studio */
        MM_AUDIO_EFFECT_PRESET_CLUB,         /**<  Preset type Club */
        MM_AUDIO_EFFECT_PRESET_NUM,          /**<  Number of Preset type */
-} MMAudioEffectPresetType;
+} mm_audio_effect_preset_type_e;
 
 /**
  * Enumerations of Audio Effect Custom Type
@@ -82,7 +82,7 @@ typedef enum {
        MM_AUDIO_EFFECT_CUSTOM_REVERB_LEVEL, /**<  Custom type Reverb Level */
        MM_AUDIO_EFFECT_CUSTOM_CLARITY,      /**<  Custom type Clarity */
        MM_AUDIO_EFFECT_CUSTOM_NUM,          /**<  Number of Custom type */
-} MMAudioEffectCustomType;
+} mm_audio_effect_custom_type_e;
 
 /**
  * Enumerations of Audio Effect Type
@@ -92,7 +92,7 @@ typedef enum {
        MM_AUDIO_EFFECT_TYPE_PRESET,
        MM_AUDIO_EFFECT_TYPE_CUSTOM,
        MM_AUDIO_EFFECT_TYPE_SQUARE,
-} MMAudioEffectType;
+} mm_audio_effect_type_e;
 
 
 /**
@@ -108,21 +108,21 @@ typedef enum {
        MM_AUDIO_EFFECT_OUTPUT_USB_AUDIO,
        MM_AUDIO_EFFECT_OUTPUT_HDMI,
        MM_AUDIO_EFFECT_OUTPUT_NUM
-} MMAudioEffectOutputMode;
+} mm_audio_effect_output_mode_e;
 
 
 /**
  * Structure of AudioEffectInfo
  */
 typedef struct {
-       MMAudioEffectType effect_type;      /**< effect type, (NONE,PRESET,CUSTOM)*/
-       MMAudioEffectPresetType preset;     /**< for preset type*/
+       mm_audio_effect_type_e effect_type;      /**< effect type, (NONE,PRESET,CUSTOM)*/
+       mm_audio_effect_preset_type_e preset;     /**< for preset type*/
        int *custom_ext_level_for_plugin;   /**< for custom type, level value list of Extension effects*/
        int custom_eq_level[MM_AUDIO_EFFECT_EQ_BAND_NUM_MAX];   /**< for custom type, EQ info*/
        int custom_ext_level[MM_AUDIO_EFFECT_CUSTOM_NUM-1];     /**< for custom type, Extension effect info*/
        int square_row;    /**< for square type, square row configure*/
        int square_col;    /**< for square type, square col configure*/
-} MMAudioEffectInfo;
+} mm_audio_effect_info_t;
 
 
 /**
@@ -135,7 +135,7 @@ typedef struct {
  * @return     True to continue with the next iteration of the loop, False to break out of the loop.
  * @see                mm_player_get_foreach_present_supported_effect_type()
  */
-typedef bool (*mmplayer_supported_audio_effect_cb) (int effect_type, int type, void *user_data);
+typedef bool (*mmplayer_supported_audio_effect_cb)(int effect_type, int type, void *user_data);
 
 /**
  * This function is to get supported effect type.
@@ -151,7 +151,7 @@ typedef bool (*mmplayer_supported_audio_effect_cb) (int effect_type, int type, v
  * @see
  * @since
  */
-int mm_player_get_foreach_present_supported_effect_type(MMHandleType player, MMAudioEffectType effect_type, mmplayer_supported_audio_effect_cb foreach_cb, void *user_data);
+int mm_player_get_foreach_present_supported_effect_type(MMHandleType player, mm_audio_effect_type_e effect_type, mmplayer_supported_audio_effect_cb foreach_cb, void *user_data);
 
 /**
  * This function is to bypass audio effect.
@@ -164,7 +164,7 @@ int mm_player_get_foreach_present_supported_effect_type(MMHandleType player, MMA
  * @see
  * @since
  */
-int mm_player_audio_effect_bypass (MMHandleType hplayer);
+int mm_player_audio_effect_bypass(MMHandleType hplayer);
 
 /**
  * This function is to apply custom effect(Equalizer and Extension effects).
@@ -260,10 +260,10 @@ int mm_player_audio_effect_custom_get_eq_bands_freq(MMHandleType hplayer, int ba
  * @return     This function returns zero on success, or negative value with error code.
  *
  * @remark
- * @see                MMAudioEffectCustomType
+ * @see                mm_audio_effect_custom_type_e
  * @since
  */
-int mm_player_audio_effect_custom_get_level(MMHandleType hplayer, MMAudioEffectCustomType type, int eq_index, int *level);
+int mm_player_audio_effect_custom_get_level(MMHandleType hplayer, mm_audio_effect_custom_type_e type, int eq_index, int *level);
 
 /**
  * This function is to get range of the level of the custom effect.
@@ -276,10 +276,10 @@ int mm_player_audio_effect_custom_get_level(MMHandleType hplayer, MMAudioEffectC
  * @return     This function returns zero on success, or negative value with error code.
  *
  * @remark
- * @see                MMAudioEffectCustomType
+ * @see                mm_audio_effect_custom_type_e
  * @since
  */
-int mm_player_audio_effect_custom_get_level_range(MMHandleType hplayer, MMAudioEffectCustomType type, int *min, int *max);
+int mm_player_audio_effect_custom_get_level_range(MMHandleType hplayer, mm_audio_effect_custom_type_e type, int *min, int *max);
 
 /**
  * This function is to set the level of the custom effect.
@@ -292,10 +292,10 @@ int mm_player_audio_effect_custom_get_level_range(MMHandleType hplayer, MMAudioE
  * @return     This function returns zero on success, or negative value with error code.
  *
  * @remark
- * @see                MMAudioEffectCustomType
+ * @see                mm_audio_effect_custom_type_e
  * @since
  */
-int mm_player_audio_effect_custom_set_level(MMHandleType hplayer, MMAudioEffectCustomType effect_custom_type, int eq_index, int level);
+int mm_player_audio_effect_custom_set_level(MMHandleType hplayer, mm_audio_effect_custom_type_e effect_custom_type, int eq_index, int level);
 
 /**
  * This function is to set the bands level of equalizer custom effect using input list.
@@ -313,32 +313,14 @@ int mm_player_audio_effect_custom_set_level(MMHandleType hplayer, MMAudioEffectC
 int mm_player_audio_effect_custom_set_level_eq_from_list(MMHandleType hplayer, int *level_list, int size);
 
 /**
- * This function is to decide if the preset type effect is supported or not
- *
- * @param      hplayer         [in]    Handle of player.
- * @param      effect          [in]    Preset type effect.
- *
- * @return     This function returns zero on success, or negative value with error code.
- *
- * @remark
- * @see
- * @since
+ * This function is to check whether the setting preset type effect is available or not
  */
-int mm_player_is_supported_preset_effect_type(MMHandleType hplayer, MMAudioEffectPresetType effect);
+int mm_player_is_available_preset_effect(MMHandleType hplayer, mm_audio_effect_preset_type_e effect, bool *available);
 
 /**
- * This function is to decide if the custom type effect is supported or not
- *
- * @param      hplayer         [in]    Handle of player.
- * @param      effect          [in]    Custom type effect.
- *
- * @return     This function returns zero on success, or negative value with error code.
- *
- * @remark
- * @see
- * @since
+ * This function is to check whether the setting custom type effect is available or not
  */
-int mm_player_is_supported_custom_effect_type(MMHandleType hplayer, MMAudioEffectCustomType effect);
+int mm_player_is_available_custom_effect(MMHandleType hplayer, mm_audio_effect_custom_type_e effect, bool *available);
 
 /**
        @}