语音合成 iOS SDK

1. 文档说明

2. 版本说明

2.1 版本升级改动点说明：

• 提升SDK稳定性；
• 离线发音人听感调优

3. SDK说明

1. 由于 BITCODE 开启会导致二进制文件体积增大，这部分会在 APPStore 发布时进行进一步编译优化，并不会引起最终文件的体积变化，故此处计算的是关闭 BITCODE 下的二进制增量。
2. .a中是多个架构做了合并，使用lipo可以看到细节。所以.a库文件本身很大，且打包出来的ipa也相对较大。但用户实际下载到手机中会被AppStore优化，只下载用户设备需要的架构，所以实际在手机上占用的空间很小。

Architectures in the fat file: libBaiduSpeechSDK.a are: armv7 i386 x86_64 arm64

1. 如果不需要离线功能，可以移除离线相关的资源文件(参考下一节)，并删除代码中所有调用离线引擎代码相关的片段。

以下是2.2.7.0在iPhone6中安装Demo后，实际系统计算出的App占用大小，根据机型可能会有差异。

开发包说明

4. Demo运行

4.1 配置包名和签名

从百度云控制台下载Demo，地址https://ai.baidu.com/sdk#tts（需要离线系在纯离线合成SDK，不需要离线下载纯在线SDK），需要在Bundle Identifier中配置好包名。

4.2 修改鉴权信息

离线合成需要另外填写申请授权SN码，具体流程参考 语音技术 (baidu.com)

全集搜索 填写应用的鉴权信息

然后编译测试

5. SDK集成

强烈建议用户首先运行SDK包中的Demo工程，Demo工程中详细说明了语音合成的使用方法，并提供了完整的示例。一般情况下，您只需参照demo工程即可完成所有的集成和配置工作。

添加BDSSpeechSynthesizer到工程

BDSSpeechSynthesizer使用了一些系统的framework，需要添加到工程里面。

添加方式: 右键点击 Xcode 中的工程文件,在出现的界面中,选中 TARGETS 下的应用,在出现的界面中选中 Build Phases->Link Binary With Libraries,点击界面中的“+”图标,在弹出的界面中选择需要的framework即可。请参考demo工程引入所需动态库framework和静态库。

开发者编译自己工程时，若报错 ld: Library xxxx not found，一般是库文件没有正确引入。请确保库文件在工程所能找到的位置之内(通过 LIBRARRY_SEARCH_PATH设置)

添加语音合成相关资源文件

将开发包中的BDSClientResource目录下的相关资源文件添加到工程或者安装app后部署到指定目录(代码中启动合成引擎时需要指定该资源文件的访问路径)。根据具体需求引入不同的资源即可。

引入BDSSpeechSynthesizer的头文件

首先将 BDSSpeechSynthesizer 提供的头文件拷贝到工程目录下,在 XCode 中添加此文件,引入 BDSSpeechSynthesizer提供的头文件。

添加如下头文件：

#import "BDSSpeechSynthesizer.h"

引入静态库文件

BDSSpeechSynthesizer提供了支持真机 armv7，armv7s，arm64及更新架构所使用的静态库文件,存放在开发包lib目录下。

引入静态库文件的具体方式为:将libBaiduSpeechSDK.a 采用添加文件方式添加到工程的Framework 目录下。

说明: libBaiduSpeechSDK.a 是一个通用的库文件，支持armv7、arm64、i386、x86_64, 避免开发者在 build 不同 target 时频繁替换.a 文件的问题

配置鉴权参数

离在线语音合成模式

请从官网控制台复制您的App密钥，设置APP_ID、API_KEY、SECRET_KEY参数。并绑定你的移动应用的BundleId。分别加载在线和离线引擎。

纯离线语音合成模式

请参考configureOfflineTTS方法配置离线资源文件和鉴权。 调用

[[BDSSpeechSynthesizer sharedInstance] loadOfflineEngine:offlineTextData speechDataPath:offlineSpeechData licenseFilePath:**nil** withAppCode:APP_ID withSn:SN];

加载离线引擎。

资源文件包括『Speech文件』和『Text文件』，音库名称对应如下

SDK默认自带离线资源文件

需要单独下载的精品音库资源文件

音库资源文件下载地址：https://console.bce.baidu.com/ai/#/ai/speech/offline/index

2.4.3之前版本，中文、粤语、英文因为使用不同的Text文件,之间通过reinitOfflineEngineData 无法完成切换。必须反初始化，再初始化。2.4.3之后版本无需重新初始化。

6. 相关授权文件

请将百度云控制台创建应用时获取的语音(APPID)、API/SECRET KEY 并填写包名。

在线合成和离线合成需要进行相关验证后方可使用：

7.重要接口说明

语音合成器

合成器，类名BDSSpeechSynthesizer，主要用来控制合成进程：设置参数，开始，结束，取消等。

获取合成器唯一实例

释放合成器唯一实例

设置合成器代理

设置合成参数

获取合成参数

设置认证信息

设置回调队列

获得当前回调队列

设置合成线程优先级

启动合成引擎

加载英文合成数据文件及模型文件

重新加载文本分析数据文件或者声学模型数据文件

加载定制库

卸载定制库

验证音库文件的有效性

获取音库文件相关参数

批量开始文本合成但不朗读或添加文本至当前合成过程

批量开始文本合成并朗读或添加文本至当前合成过程

取消本次合成并停止朗读

暂停文本合成并朗读

继续文本合成并朗读

获取合成器状态

设置播放器音量

设置AudioSessionCategory类型

语音合成器委托对象

语音合成器委托对象BDSSpeechSynthesizerDelegate，用来处理语音合成器的各种回调。

开始合成

结束合成

开始朗读

结束朗读

新的语音数据已经合成

播放进度变更

合成器发生错误

8.参数及完整示例

BDSSpeechSynthesizerParams.h 文件中包含了各类参数的使用说明，如果开发者想寻找一些功能的设置办法，请浏览该文件中的相关参数说明

语音合成器参数

合成参数

百度语音合成支持的参数用BDSSynthesizerParamKey类型表示，具体如下：

合成模式设置接口BDS_SYNTHESIZER_PARAM_SYNTH_STRATEGY，模式设置接口见下表：

语音合成文本语言

语音合成文本语言用BDSSynthesizerLanguages类型表示，具体如下：

语音合成文本编码格式

语音合成文本编码格式用BDSSynthesizerTextEncodings类型表示，具体如下：

语音合成音频编码格式

不支持 mp3，支持AMR、OPUS。 语音合成音频编码格式用BDSSynthesizerAudioEncoding类型表示，具体如下：

关于AVAudioSession

SDK默认会将AudioSession的Category设置为AVAudioSessionCategoryPlayback，并在必要的时候调用setActive接口对外部音频进行打断及恢复，如果开发者不希望SDK对AudioSession进行操作自己管理，可以通过参数配置接口，把BDS_SYNTHESIZER_PARAM_ENABLE_AVSESSION_MGMT对应的value设置为NO，即可屏蔽SDK内部的操作，按照需求，设置BDS_SYNTHESIZER_PARAM_AUDIO_SESSION_CATEGORY_OPTIONS自行配置AudioSession。

完整示例

语音合成完整示例

   
-(void)configureOnlineTTS{
    
    [[BDSSpeechSynthesizer sharedInstance] setApiKey:API_KEY withSecretKey:SECRET_KEY];
    
    [[AVAudioSession sharedInstance]setCategory:AVAudioSessionCategoryPlayback error:nil];
    [[BDSSpeechSynthesizer sharedInstance] setSynthParam:@(0) forKey:BDS_SYNTHESIZER_PARAM_SPEAKER];
    
}

-(void)configureOfflineTTS{
    
    NSError *err = nil;
    // 在这里选择不同的离线音库（请在XCode中Add相应的资源文件），同一时间只能load一个离线音库。根据网络状况和配置，SDK可能会自动切换到离线合成。
    NSString* offlineEngineSpeechData = [[NSBundle mainBundle] pathForResource:@"Chinese_And_English_Speech_Female" ofType:@"dat"];
    
    NSString* offlineChineseAndEnglishTextData = [[NSBundle mainBundle] pathForResource:@"Chinese_And_English_Text" ofType:@"dat"];
    
    err = [[BDSSpeechSynthesizer sharedInstance] loadOfflineEngine:offlineChineseAndEnglishTextData speechDataPath:offlineEngineSpeechData licenseFilePath:nil withAppCode:APP_ID];
    if(err){
        [self displayError:err withTitle:@"Offline TTS init failed"];
        return;
    }
    [TTSConfigViewController loadedAudioModelWithName:@"Chinese female" forLanguage:@"chn"];
    [TTSConfigViewController loadedAudioModelWithName:@"English female" forLanguage:@"eng"];
}

-(void)test : {
    	// 获得合成器实例
    [[BDSSpeechSynthesizer sharedInstance] setSynthesizerDelegate:self];
	
	// 设置委托对象
	[[BDSSpeechSynthesizer sharedInstance] setSynthesizerDelegate:self];
	
	// 开始合成并播放
	NSError* speakError = nil;
	if([[BDSSpeechSynthesizer sharedInstance] speakSentence:@"您好" withError:&speakError] == -1){
		// 错误
		NSLog("错误: %ld, %@", (long)speakError.code, speakError.localizedDescription);
	}
	if([[BDSSpeechSynthesizer sharedInstance] speakSentence:@"今天天气真不错" withError:&speakError] == -1){
		// 错误
		NSLog("错误: %ld, %@", (long)speakError.code, speakError.localizedDescription);
	}
	if([[BDSSpeechSynthesizer sharedInstance] speakSentence:@"Today's weather is really good!" withError:&speakError] == -1){
		// 错误
		NSLog("错误: %ld, %@", (long)speakError.code, speakError.localizedDescription);
	}
}
	
	
	- (void)synthesizerStartWorkingSentence:(NSInteger)SynthesizeSentence
{
    NSLog(@"Began synthesizing sentence %ld", (long)SynthesizeSentence);
}

- (void)synthesizerFinishWorkingSentence:(NSInteger)SynthesizeSentence
{
    NSLog(@"Finished synthesizing sentence %ld", (long)SynthesizeSentence);
}

- (void)synthesizerSpeechStartSentence:(NSInteger)SpeakSentence
{
    NSLog(@"Began playing sentence %ld", (long)SpeakSentence);
}

- (void)synthesizerSpeechEndSentence:(NSInteger)SpeakSentence
{
    NSLog(@"Finished playing sentence %ld", (long)SpeakSentence);
}

9. IOS错误码

开始合成错误

开始合成错误用BDSStartSynthesisError类型表示，具体如下：

合成错误（包含在线合成和离线合成错误）

合成错误用BDSSynthesisError类型表示，具体如下：

10. 权限

11. 不使用离线合成，只使用在线合成

不使用离线合成，只使用在线合成，可以单独下载纯在线合成sdk https://ai.baidu.com/download?sdkId=116

删除离线资源文件，并configureOnineTTS设置合成策略为TTS_MODE_ONLINE