Skip to content

Latest commit

 

History

History
200 lines (152 loc) · 5.53 KB

doc_iOS.md

File metadata and controls

200 lines (152 loc) · 5.53 KB

pixelFree 美颜SDK使用文档

iOS 接入方式

  1. 手动接入

    Demo 工程中有接入 PixelFree.framework，参考 demo 接入

  2. pod 导入

      pod 'PixelFree'

仅需四步，完成接入使用

  1. 初始化

    // 素材路径
 NSString *face_FiltePath = [[NSBundle mainBundle] pathForResource:@"filter_model.bundle" ofType:nil];
 
 // 授权文件
 NSString *authFile = [[NSBundle mainBundle] pathForResource:@"pixelfreeAuth.lic" ofType:nil];
 
 // 初始化实例
 self.mPixelFree = [[SMPixelFree alloc] initWithProcessContext:nil srcFilterPath:face_FiltePath authFile:authFile];

  2. 美颜参数设置

    // 大眼
[_mPixelFree pixelFreeSetBeautyFiterParam:PFBeautyFiterTypeFace_EyeStrength value:&value];

// 美牙
float whitenTeethValue = 0.5f;
[_mPixelFree pixelFreeSetBeautyFiterParam:PFBeautyFilterWhitenTeeth value:&whitenTeethValue];

  3. 滤镜设置 (内置 10 款滤镜 )

    // 滤镜类型，类型字段查看，滤镜表格
const char *aaa = [param.mParam UTF8String];
[_mPixelFree pixelFreeSetBeautyFiterParam:PFBeautyFiterName value:(void *)aaa];
// 滤镜程度
[_mPixelFree pixelFreeSetBeautyFiterParam:PFBeautyFiterStrength value:&value];

  4. 图像渲染处理，内部会内存回写

    // pixbuffer 视频数据
[_mPixelFree processWithBuffer:pixbuffer];

设置美颜参数说明,参数范围 （0.0~1.0）

typedef enum PFBeautyFiterType{
    PFBeautyFiterTypeFace_EyeStrength = 0,
    //瘦脸
    PFBeautyFiterTypeFace_thinning,
    //窄脸
    PFBeautyFiterTypeFace_narrow,
    //下巴 （默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_chin,
    //v脸
    PFBeautyFiterTypeFace_V,
    //small
    PFBeautyFiterTypeFace_small,
    //鼻子
    PFBeautyFiterTypeFace_nose,
    //额头（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_forehead,
    //嘴巴（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_mouth,
    //人中（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_philtrum,
    //长鼻（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_long_nose = 10,
    //眼距（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_eye_space,
    //微笑嘴角
    PFBeautyFiterTypeFace_smile,
    //旋转眼睛（默认0.5，两个方向调节）
    PFBeautyFiterTypeFace_eye_rotate,
    //开眼角
    PFBeautyFiterTypeFace_canthus,
    //磨皮
    PFBeautyFiterTypeFaceBlurStrength,
    //美白
    PFBeautyFiterTypeFaceWhitenStrength,
    //红润
    PFBeautyFiterTypeFaceRuddyStrength,
    //锐化
    PFBeautyFiterTypeFaceSharpenStrength,
    //新美白算法
    PFBeautyFiterTypeFaceM_newWhitenStrength,
    //画质增强
    PFBeautyFiterTypeFaceH_qualityStrength,
    //滤镜类型
    PFBeautyFiterName,
    //滤镜强度
    PFBeautyFiterStrength,
    //绿幕
    PFBeautyFiterLvmu,
    // 2D 贴纸
    PFBeautyFiterSticker2DFilter,
    // 一键美颜
    PFBeautyFiterTypeOneKey,
    // 扩展字段
    PFBeautyFiterExtend,
    // 祛法令纹
    PFBeautyFilterNasolabial,
    // 祛黑眼圈
    PFBeautyFilterBlackEye,
    // 美牙
    PFBeautyFilterWhitenTeeth,
} PFBeautyFiterType;

💄 美妆功能说明

美妆部位类型

美妆支持以下部位，可通过 pixelFreeSetMakeupPart:degree: 方法单独调节：

  • 眉毛 (PFMakeupPartBrow): 调节眉毛颜色和形状
  • 腮红 (PFMakeupPartBlusher): 调节腮红颜色和强度
  • 眼影 (PFMakeupPartEyeShadow): 调节眼影颜色和效果
  • 眼线 (PFMakeupPartEyeLiner): 调节眼线粗细和颜色
  • 睫毛 (PFMakeupPartEyeLash): 调节睫毛长度和浓密程度
  • 唇彩 (PFMakeupPartLip): 调节唇色和光泽度
  • 高光 (PFMakeupPartHighlight): 调节高光位置和强度
  • 阴影 (PFMakeupPartShadow): 调节阴影位置和强度
  • 粉底 (PFMakeupPartFoundation): 调节粉底颜色和遮瑕度

美妆加载方式

  1. Bundle 方式：推荐使用，性能更好

    • 将美妆资源打包为 .bundle 文件
    • 使用 createBeautyItemFormBundleKey:data:size: 加载

  2. JSON 配置方式：适合动态配置

    • 使用 JSON 文件配置美妆参数
    • 使用 pixelFreeSetMakeupWithJsonPath: 加载

美妆程度调节

  • 程度值范围：0.0 ~ 1.0
  • 与配置中的程度值叠乘，例如：配置中为 0.5，设置 degree 为 0.8，最终效果为 0.5 × 0.8 = 0.4
  • 可在加载美妆后随时调节各部位程度

💡 使用建议

  1. 性能优化

    • 建议在后台线程进行图像处理
    • 适当调整美颜参数，避免过度处理
    • 注意内存管理，及时释放资源

  2. 参数调节

    • 所有参数范围均为 0.0 ~ 1.0
    • 建议从较小值开始调节
    • 注意参数间的相互影响

  3. 美妆使用

    • 建议使用 bundle 方式加载美妆，性能更优
    • 美妆资源文件较大，注意内存管理
    • 切换美妆前建议先调用 clearMakeup 清除之前的美妆效果

  4. 常见问题

    • 确保授权文件正确配置
    • 检查资源文件路径是否正确
    • 注意内存使用和性能监控

📝 注意事项

  1. 请确保正确配置授权文件
  2. 注意资源文件的正确引入
  3. 建议在真机上进行测试
  4. 注意内存管理和性能优化

🔗 相关资源