集成准备
开发者环境要求
开发工具 XCode 11 及以上:App Store 或单击 下载地址。
建议运行环境:
设备要求:iPhone 5 及以上;iPhone 6 及以下前置摄像头最多支持到 720p,不支持 1080p。
系统要求:iOS 10.0 及以上。
C/C++层开发环境
XCode 默认 C++ 环境。
类型 | 依赖库 |
系统依赖库 | AVFoundation Accelerate AssetsLibrary CoreML JavaScriptCore CoreFoundation MetalPerformanceShaders CoreTelephony libc++.tbd |
自带的库 | YTCommon(鉴权静态库) XMagic(美颜静态库) libpag(视频解码动态库) |
导入资源
资源
必需资源包:
LightCore.bundle
分割功能包:
LightSegmentPlugin.bundle
手势功能包:
LightHandPlugin.bundle
3D 功能包:
Light3DPlugin.bundle
导入方法
方法一:加入到工程资源中即可。
方法二:如果需要指定路径
initWithRenderSize:assetsDict: (XMagic)
可通过这里的 assetsDict
配置每个资源路径。配置权限
在 Info.plist 文件中添加相应权限的说明,否则程序在 iOS 10 系统上会出现崩溃。请在 Privacy - Camera Usage Description 中开启相机权限,允许 App 使用相机。
集成步骤
步骤一:签名准备
framework 签名可以直接在 General-->Masonry.framework 和 libpag.framework 选 Embed & Sign。
步骤二:鉴权
1. 申请授权,得到 LicenseURL 和 LicenseKEY,请参见 License 指引。
注意
不需要把 License 文件下载下来放到本地工程里。
2. 在工程 AppDelegate 的 didFinishLaunchingWithOptions 中添加如下代码,触发 license 下载,避免在使用前才临时去下载。其中,LicenseURL 和 LicenseKey 是控制台绑定 License 时生成的授权信息。
[TESign setKeyUrl:LicenseKey url:LicenseURL];
3. 然后在真正要使用美颜功能时,再去做鉴权。
注意
部分代码与 Demo 工程中的代码有差异,请以本文档描述为准。
licenseObserver = [[NSNotificationCenter defaultCenter] addObserverForName:@"kTESignLicenceLoadNotification" object:nil queue:[NSOperationQueue mainQueue] usingBlock:^(NSNotification * _Nonnull note) {NSLog(@"test --%@",note.object);if(note.object != nil){int code = [[note.object objectForKey:@"result"] intValue];NSLog(@"code --%d",code);if(code == 0){NSString* lic = [TESign getLicenceInfo];if(lic == nil){lic = @"";}int authRet = 0;NSError* error = noErr;NSData * getJsonData = [lic dataUsingEncoding:NSUTF8StringEncoding];NSDictionary * getDict = [NSJSONSerialization JSONObjectWithData:getJsonData options:NSJSONReadingMutableContainers error:&error];authRet = [XMagicAuthManager initAuthByString:[getDict objectForKey:@"TELicense"] withSecretKey:@""];NSLog(@"errorCode: %@, authRet: %d", error, authRet);if(authRet!=0){NSLog(@"licenseInfo: %@", lic);UIAlertView * alert = [[UIAlertView alloc] initWithTitle:@"提醒" message:@"授权失败" delegate:nil cancelButtonTitle:@"取消" otherButtonTitles: nil];[alert show];return;}}}[[NSNotificationCenter defaultCenter] removeObserver:licenseObserver];}];[TESign setKeyUrl:@"Key" url:@"LicenseURL"];
步骤三:加载 SDK:XMagic.framework
使用腾讯特效 SDK 生命周期大致如下:
1. 加载美颜相关资源。
NSDictionary *assetsDict = @{@"core_name":@"LightCore.bundle",@"root_path":[[NSBundle mainBundle] bundlePath]};
2. 初始化腾讯特效 SDK。
initWithRenderSize:assetsDict: (XMagic)self.beautyKit = [[XMagic alloc] initWithRenderSize:previewSize assetsDict:assetsDict];
3. 腾讯特效 SDK 处理每帧数据并返回相应处理结果。
process: (XMagic)
// 在摄像头回调传入帧数据- (void)captureOutput:(AVCaptureOutput *)captureOutput didOutputSampleBuffer:(CMSampleBufferRef)sampleBuffer fromConnection:(AVCaptureConnection *)connection;// 获取原始数据,处理每帧的渲染信息- (void)mycaptureOutput:(AVCaptureOutput *)captureOutput didOutputSampleBuffer:(CMSampleBufferRef)inputSampleBuffer fromConnection:(AVCaptureConnection *)connection originImageProcess:(BOOL)originImageProcess;// 使用CPU处理数据- (YTProcessOutput*)processDataWithCpuFuc:(CMSampleBufferRef)inputSampleBuffer;// 使用GPU处理数据- (YTProcessOutput*)processDataWithGpuFuc:(CMSampleBufferRef)inputSampleBuffer;// 腾讯特效 SDK处理数据接口/// @param input 输入处理数据信息/// @return 输出处理后的数据信息- (YTProcessOutput* _Nonnull)process:(YTProcessInput * _Nonnull)input;
4. 释放腾讯特效 SDK。
deinit (XMagic)// 在需要释放SDK资源的地方调用[self.beautyKit deinit]
说明
完成上述步骤后,用户即可根据自己的实际需求控制展示时机以及其他设备相关环境。
常见问题
问题1:编译报错:“unexpected service error: build aborted due to an internal error: unable to write manifest to-xxxx-manifest.xcbuild': mkdir(/data, S_IRWXU | S_IRWXG | S_IRWXO): Read-only file system (30):”?
1. 前往 File > Project settings > Build System 选择 Legacy Build System。
2. Xcode 13.0++ 需要在 File >Workspace Settings 勾选 Do not show a diagnostic issue about build system deprecation。
问题2:iOS 导入资源运行后报错:“Xcode 12.X 版本编译提示 Building for iOS Simulator, but the linked and embedded framework '.framework'...”?
将 Buil Settings > Build Options > Validate Workspace 改为 Yes,再单击运行。
说明
Validate Workspace 改为 Yes 之后编译完成,再改回 No,也可以正常运行,所以这里有这个问题注意下即可。
问题3:滤镜设置没反应?
检查下设置的值是否正确,范围为 0-100,可能值太小了效果不明显。
问题4:iOS demo编译,生成 dSYM 时报错?
PhaseScriptExecution CMake\\ PostBuild\\ Rules build/XMagicDemo.build/Debug-iphoneos/XMagicDemo.build/Script-81731F743E244CF2B089C1BF.shcd /Users/zhenli/Downloads/xmagic_s106/bin/sh -c /Users/zhenli/Downloads/xmagic_s106/build/XMagicDemo.build/Debug-iphoneos/XMagicDemo.build/Script-81731F743E244CF2B089C1BF.shCommand /bin/sh failed with exit code 1
问题原因:
libpag.framework和Masonary.framework
重签名失败。解决方法:
1.1 打开
demo/copy_framework.sh
。1.2 用下述命令查看本机 cmake 的路径,将
$(which cmake)
改为本地 cmake 绝对路径。which cmake
1.3 用自己的签名替换所有
Apple Development: ......
。