MiMO_iOS/ByteEffectLib/effect-sdk.framework/Headers/bef_effect_ai_hal_api.h

#ifndef _BEF_EFFECT_AI_HAL_API_H_
#define _BEF_EFFECT_AI_HAL_API_H_

#include "bef_effect_ai_public_define.h"
//#include "bef_effect_ai_face_detect.h"

/**
 * @brief Initialize effect handle.
 * @param handle          Effect handle
 * @param model_path      model path
 * @param license_path    license path
 * @param type            process type
 * @return           If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_ai_public_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_init(bef_effect_handle_t *handle,
                                                      const char *model_path, 
                                                      const char *license_path,
                                                      bef_ai_process_type type,
                                                      int tmp,
                                                      int times=2);

/**
 * @param handle      Effect handle that will  destroy
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_destory(bef_effect_handle_t handle);

/**
 * process image
 * @param handle       Effect handle
 * @param image        imput image
 * @param out_image    output image
 * @param format_in    imput image format
 * @param width        image width
 * @param height       imput height
 * @param run_times    render times
 * @param orientation  image orientation
 * @return          If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_ai_public_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_process(bef_effect_handle_t handle, 
                                                          unsigned char* image,
                                                          unsigned char* out_image,
                                                          bef_ai_pixel_format format_in, 
                                                          bef_ai_camera_position is_front,
                                                          int width, 
                                                          int height,
                                                          bef_ai_rotate_type orientation);
/**
 * process image
 * @param handle       Effect handle
 * @param image        imput image
 * @param out_image    output image
 * @param format_in    imput image format
 * @param width        image width
 * @param height       imput height
 * @param orientation  image orientation
 * @param faceInfo     input face detect result
 * @return             If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_ai_public_define.h
 */
// BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_process_buffer_with_face_info(bef_effect_handle_t handle, 
//                                                                     unsigned char* in_image,
//                                                                     unsigned char* out_image,
//                                                                     bef_ai_pixel_format format_in, 
//                                                                     bef_ai_camera_position is_front,
//                                                                     int width, 
//                                                                     int height,
//                                                                     bef_ai_rotate_type orientation,
//                                                                     bef_ai_face_info *faceInfo,
//                                                                     unsigned char* filePath=nullptr);
/**
 * process image
 * @param handle       Effect handle
 * @param faceInfo     output face detect result
 * @return             If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_ai_public_define.h
 */
// BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_get_face_detect_result(bef_effect_handle_t handle, bef_ai_face_info *faceInfo);

/**
 * Set color filter with a specified string.
 * @param handle    Effect handle
 * @param filter_path   The absolute path of effect package.
 * @return          If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_ai_public_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_color_filter_v2(bef_effect_handle_t handle, const char* filter_path);

/**
 * @param handle      Effect handle that will be created
 * @param fIntensity  Filter smooth intensity, range in [0.0, 1.0]
 * if fIntensity is 0 , this filter would not work.
 * @return            if succeed return BEF_EFFECT_RESULT_SUC,  other value please see bef_effect_ai_public_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_intensity(bef_effect_handle_t handle, int intensityType, float fIntensity);

/**
 * @brief Set effect with a specified string.
 * @param handle    Effect handle
 * @param stickerPath   The absolute path of effect package.
 * @return          If succeed return BEF_EFFECT_RESULT_SUC, other value please see bef_effect_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_effect(bef_effect_handle_t handle, const char* stickerPath);

/**
 * @brief append composer effect path array
 * 追加资源包路径数组,通过追加数组设置特效的组合
 * @param nodePaths 特效资源路径的数组
 * @param nodeNum 特效资源路径的数组长度
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_composer_append_nodes(bef_effect_handle_t handle, 
                                                                        const char *nodePaths[], 
                                                                        int nodeNum);

/**
 * @brief remove composer effect path array
 * 删除资源包路径数组,通过删除数组设置特效的组合
 * @param nodePaths 特效资源路径的数组
 * @param nodeNum 特效资源路径的数组长度
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_composer_remove_nodes(bef_effect_handle_t handle, 
                                                                        const char *nodePaths[], 
                                                                        int nodeNum);

/**
 * @brief set composer effect path array
 * 设置资源包路径数组,通过更新数组设置特效的组合
 * @param nodePaths 特效资源路径的数组
 * @param nodeNum 特效资源路径的数组长度
 *
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_composer_set_nodes(bef_effect_handle_t handle, 
                                                                    const char *nodePaths[], 
                                                                    int nodeNum);

/// 设置资源包路径数组，可通过额外的 ndoeTags 设置附加信息
/// @param handle 创建的 handle
/// @param nodePaths 特效资源路径数组
/// @param nodeTags 特效资源附加信息，与nodePaths 一一对应
/// @param nodeNum 特效资源数组的长度
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_composer_set_nodes_with_tags(bef_effect_handle_t handle, 
                                                                                const char *nodePaths[],
                                                                                int nodeNum,
                                                                                const char *nodeTags[]=nullptr);

/**
* @brief 清理并行框架残余算法任务，在切后台、切换分辨率或切相机时使用。总之画面会不连续出现的时候都应该调用
* @param handle     Effect handle
*/
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_clean_pipeline_processor_task(bef_effect_handle_t handle);

/**
 * @brief Set camera toward
 * @param handle        Effect handle that  initialized
 * @param position      Camera positin
 * @return if succeed return IES_RESULT_SUC,  other value please see bef_effect_base_define.h
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_camera_device_position(bef_effect_handle_t handle,  
                                                                            bef_ai_camera_position position);

/**
 * @brief set composer node intensity
 * 设置组合特效的单个节点的强度
 * @param handle Effect Handle
 * @param key 特效资源的路径
 * @param value 特效的强度
 */
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_composer_update_node(bef_effect_handle_t handle, 
                                                                    const char *nodePath,
                                                                    const char *nodeTag, 
                                                                    float value,
                                                                    bool update_times=false);

/// @brief 处理触摸事件
/// @param handle 已创建的句柄
/// @param event 触摸事件类型
/// @param x 触摸位置
/// @param y 触摸位置
/// @param force 压力值
/// @param majorRadius 触摸范围
/// @param pointerId 触摸点id
/// @param pointerCount 触摸点数量
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_process_touch(bef_effect_handle_t handle, bef_ai_touch_event_code event, float x, float y, float force, float majorRadius, int pointerId, int pointerCount);

/// @brief 处理手势事件
/// @param handle 已创建的句柄
/// @param gesture 手势类型
/// @param x 触摸位置，缩放手势表示缩放比例，旋转手势表示旋转角度
/// @param y 触摸位置
/// @param dx 移动距离
/// @param dy 移动距离
/// @param factor 缩放因数
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_process_gesture(bef_effect_handle_t handle, bef_ai_gesture_event_code gesture, float x, float y, float dx, float dy, float factor);

/// @brief 处理虚拟背景事件
/// @param handle 已创建的句柄
/// @param key key参数
/// @param image 图像参数
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_render_cache_texture_with_buffer(bef_effect_handle_t handle, const char* key, bef_ai_image* image);

/// @brief 处理虚拟背景事件
/// @param handle 已创建的句柄
/// @param key key参数
/// @param image 背景路径
BEF_SDK_API bef_effect_result_t bef_effect_ai_hal_set_render_cache_texture(bef_effect_handle_t handle, const char* key, const char* image_path);
#endif