jTTS与华为UAP3300挂接指导书

jTTS 与华为 UAP3300 挂接指导书 hwtts 接口 北京捷通华声语音技术有限公司 北京捷通华声语音技术有限公司 1 版本说明与修改记录 日期版本作者更新说明 2010 5 141 0黄凯创建 北京捷通华声语音技术有限公司 2 目录 1简介简介 3 2编写目的编写目的 3 3HWTTS 接口总述接口总述 3 4HWTTS 接口说明接口说明 4 5HWTTS 接口函数说明接口函数说明 4 5 1Synth2File 4 5 2CleanFiles 5 6HWTTS 接口文件列表接口文件列表 6 7HWTTS 接口安装部署接口安装部署 6 7 1文件部署文件部署 6 7 2修改配置文件修改配置文件 6 7 2 1hwtts ini 6 7 2 2jtts ini 9 7 3添加添加 IVR 流程流程 12 7 4执行执行 IVR 流程流程 13 8故障检查故障检查 13 8 1hwtts log TTS 客户端日志 客户端日志 13 8 2jtts log TTS 服务器日志 服务器日志 13 8 3UAP3300 平台平台 13 北京捷通华声语音技术有限公司 3 1 简介简介 TTS 接口以动态链接库的方式提供 IVR 系统调用 TTS 合成接口进行语音合成 语音文件生成后 IVR 系统进 行语音文件播放 播放完毕后 IVR 系统调用 TTS 清理接口 对本次 TTS 放音 产生的临时语音文件进行清理 2 编写目的编写目的 使用 hwtts 接口的系统集成时 提供该接口说明及使用方法 3 hwtts 接口总述接口总述 hwtts 为 jTTS 与华为呼叫中心系统接口组件 用于开发基于 jTTS 语音应用 程序 hwtts 接收来自 jTTS 客户端 IVR 的文本 并将此文本发送至 jTTS 语音 合成服务器 语音合成服务器接收来自 hwtts 的合成请求 并将合成的语音数 据返送给 hwtts hwtts 将接收到的语音数据根据用户指定的信息合成相对应的 一个或多个语音文件 hwtts jTTS 语音合成服务器及 IVR 工作示意图如下 语音合成服务器 语音合成服务器 语音合成服务器 hwtts IVR Server 北京捷通华声语音技术有限公司 4 4 hwtts 接口说明接口说明 hwtts 以动态链接库的方式提供给开发人员使用 进行语音应用程序开发 IVR 系统直接调用 hwtts 组件的语音合成接口进行语音合成 语音合成采用分 段异步实现方式 Synth2File 合成完第一个语音文件后即返回 后续的语音文 件在新的线程中后台合成 并将其信息写入临时文件中 合成的语音文件存放在本地目录 hwtts ini 中的 LocalTTSDir 如果需要 则可以将其以 FTP 方式传输至 FTP 服务器 hwtts ini 中的 FileServerFTPURL 语音文件生成之后 IVR 系统获取此语音文件并进行播放 而返回给调用程序 的语音文件全路径名为 hwtts ini 中的 RemoteTTSDir 文件名 当 IVR 系统播 放完毕之后 再调用 hwtts 清理接口对本次 hwtts 产生的临时文件进行清理操作 5 hwtts 接口函数说明接口函数说明 5 1Synth2File 功能描述TTS 语音合成接口 IVR 进行 TTS 放音前 调用该接口启动语音合成 该接口将合成好的第一个语音文件全路径作为输出参数 strDestFile 返回 然后启动线程进行后续语音的合成 后续语音文件全路径记录在一个 INI 文件中 该 INI 文件全路径作为输出参数 strTempIni 返回 原型extern C declspec dllexport int Synth2File int nSubCCNO int nVDNNO int nSSPFlag int bString int nUAPMid const char strSynth char strDestFile char strTempIni 输入参数int nSubCCNO 呼叫中心编号 int nVDNNO 虚拟呼叫中心编号 int nSSPFlag IVR 中的呼叫标志 int bString 1 合成字符串 2 合成文本文件 int nUAPMid UAP 模块号 const char strSynth 待合成文本字符串或文本文件全路径名 VOICE eVoice 语音合成使用的音库 输出参数char strDestFile 合成的第一个语音文件全路径名 如 d 1 1 8934 536939128 20090325 1237965800 1 wav char strTempIni 记录所有已合成语音文件名的 INI 文件全路径名 该 INI 文件格式如下 北京捷通华声语音技术有限公司 5 VOICEFILE File1 d 1 1 8934 536939128 20090325 1237965800 1 wav File2 d 1 1 8934 536939128 20090325 1237965800 2 wav File3 d 1 1 8934 536939128 20090325 1237965800 3 wav File4 d 1 1 8934 536939128 20090325 1237965800 4 wav File5 d 1 1 8934 536939128 20090325 1237965800 5 wav 其中后缀 表示该文件合成未完成 每个文件最后上传至文件服务 器成功才算完成 表示为最后一个文件 返回值0 成功 1 接口参数错误或加载 hwtt ini 失败 2 连接 TTS 服务器失败 3 合成过程异常 4 连接 TTS 服务器失败 其他说明 1 语音文件名命名规则 SUBCCNO VDNNO PROGID SSP DATE UTCSECONDS wav SUBCCNO 输入参数 nSubCCNO VDNNO 输入参数 nVDNNO PROGID 进程号 SSP 输入参数 nSSPFlag UTCSECONDS time 函数返回值 语音文件序号 从 1 开始 如 1 1 8934 536939128 20090325 1237965800 2 wav 2 记录已合成语音文件的INI文件名的命名规则 SUBCCNO VDNNO PROGID SSP DATE UTCSECONDS ini 如 1 1 8934 536939128 20090325 1237965800 ini 3 路径获取方法 Hwtts ini 中 LocalTTSDir RemoteTTSDir FileServerFTPURL 三个配置段中选用 哪个路径 由输入参数 nUAPMid 决定 5 2CleanFiles 功能描述启动线程 删除合成过程中产生的临时语音文件 IVR 服务器和 FTP 服 务器上的临时语音文件 和 INI 文件 原型extern C declspec dllexport int CleanFiles const char strTempIni 输入参数char strTempIni 记录所有已合成语音文件名的 INI 文件全路径名 对 应于 Synth2File 的输出参数 strTempIni 输出参数无 返回值0 成功 1 失败 其他说明如果 strTempIni 路径对应的 INI 文件不存在 返回成功 成功或失败只代表启动线程的结果 北京捷通华声语音技术有限公司 6 6 hwtts 接口文件列表接口文件列表 文件名称文件名称功能描述功能描述 hwtts dll动态链接库二进制文件 hwtts iniHwtts 配置文件 jtts inijTTS 参数配置文件 jTTS 与华为 UAP3300 挂接指导书配置开发手册 7 hwtts 接口安装部署接口安装部署 7 1文件部署文件部署 hwtts dll hwtts ini jtts ini 拷贝到 IVR 服务器 IVR 的安装路径下 默认路径为 huawei ivr 目录 7 2修改配置文件修改配置文件 根据系统环境 IP 地址 ftp 等 修改配置文件 hwtts ini 和 jtts ini 7 2 1hwtts ini 根据实际需求 检查配置文件各项是否与实际环境 需求 一致 COMMON 是否写日志 是否写日志 0 否 否 1 是 建议开启日志 是 建议开启日志 LogFlag 1 1 TTS 引擎是科大的引擎是科大的 InterPhonic 2 TTS 引擎是捷通华声的引擎是捷通华声的 jTTS TTSProvider 2 北京捷通华声语音技术有限公司 7 TTS Server 序列号 通过序列号 通过 TTS 服务器安装的系统检查工具查看 可参考下图 服务器安装的系统检查工具查看 可参考下图 TTSSerialNumber 49B11632B590A0E6 TTS Server 是否在是否在 Client 本机 本机 1 是 是 0 否 否 TTSServerIsLocal 0 TTS Server 的的 IP 地址地址 TTSServerIP 192 168 198 198 是否需要将语音文件是否需要将语音文件 FTP 至文件服务器 至文件服务器 0 否 否 1 是 是 IfNeedFTP 1 JTTS 在进行远程合成时在进行远程合成时 会设置一个默认音库 而服务端可能未安装此音库 造成合成失会设置一个默认音库 而服务端可能未安装此音库 造成合成失 败 但是在败 但是在 Synth2File 接口中的最后一个参数设置了使用的音库 在设置的音库不支持的接口中的最后一个参数设置了使用的音库 在设置的音库不支持的 情况下会通过读取配置文件获取音库情况下会通过读取配置文件获取音库 ID 如果在此处配置的音库无效 则自动启动服务器 如果在此处配置的音库无效 则自动启动服务器 上的第一个音库作为合成使用音库 上的第一个音库作为合成使用音库 VoiceID 84316E85 143E 4410 B00B 9DF681684C6C 北京捷通华声语音技术有限公司 8 TTS 语音文件合成后本地存放目录 每个语音文件合成后本地存放目录 每个 UAP 的模块号对应一个目录的模块号对应一个目录 如果是无效的模块号如果是无效的模块号 0 LocalDirNum 使用使用 LocalTTSDir 作为默认路径作为默认路径 LocalTTSDir LocalTTSDir home icd hwtts test LocalTTSDirNum 0 1 home icd hwtts test 2 home icd hwtts test TTS 语音文件合成后远端语音文件合成后远端 File Server 上播放目录 上播放目录 CTI 下发给下发给 UAP 的放音消息中所带目的放音消息中所带目 录 录 这个目录是这个目录是 BMRS 板最终播放语音的查找路径 物理上和板最终播放语音的查找路径 物理上和 FileServerFTPURL 指代的是指代的是 同一个目录 同一个目录 每个每个 UAP 的模块号对应一个目录的模块号对应一个目录 如果是无效的模块号如果是无效的模块号 0 RemoteTTSDirNum 使用使用 RemoteTTSDir 作为默认路径作为默认路径 RemoteTTSDir RemoteTTSDir d RemoteTTSDirNum 0 1 d 2 d 北京捷通华声语音技术有限公司 9 TTS 语音文件通过该语音文件通过该 URL 传送至传送至 FileServer 形如 形如 ftp username password ip port dir 每个每个 UAP 的模块号对应一个目录的模块号对应一个目录 如果是无效的模块号如果是无效的模块号 0 FileServerFTPURLNum 使用使用 FileServerFTPURL 作为默认作为默认 路径路径 FileServerFTPURL FileServerFTPURL ftp icd icd 192 168 198 198 21 test FileServerFTPURLNum 2 1 ftp icd icd 192 168 198 198 21 test 2 ftp icd icd 192 168 198 198 21 ttstext2 7 2 2jtts ini 根据实际需求 检查配置文件各项是否与实际环境 需求 一致 JTTS CONFIG 0 PCM Native 和音库一致 目前为 16KHz 16Bit 1 OKI ADPCM 6KHz 4bit Dialogic Vox 2 OKI ADPCM 8KHz 4bit Dialogic Vox 3 A 律 8KHz 8Bit 4 u 律 8KHz 8Bit 5 PCM 8KHz 8Bit 6 PCM 8KHz 16Bit 7 PCM 16KHz 8Bit 8 PCM 16KHz 16Bit 9 PCM 11 025KHz 8Bit 10 PCM 11 025KHz 16Bit nAudioFormat 5 所设置的代码集代号 系统内部缺省为 936 可能的取值如下 936 包括 GB2312 GBK GB18030 950 Big5 代码集 932 Shift JIS 代码集 用于日文合成 949 KCS 代码集 用于韩文合成 1252 ISO 8859 1 代码集 用于英文合成 1200 Unicode 代码集 1201 Unicode Big Endian 代码集 65001 UTF 8 代码集 wCodePage 936 领域设置 缺省为 DOMAIN COMMON 可能的取值如下 北京捷通华声语音技术有限公司 10 0 通用领域 新闻 社会 政治等 1 金融证券 2 天气预报 3 体育赛事 4 公交信息 5 旅游餐饮 6 汽运 7 排队叫号 8 名家金曲 9 保险 10 航空 11 税务 12 电力 30 一般定制领域 nDomain 0 合成语音的基频 按照 0 9 分为 10 级 缺省值为 5 数字越大基频越高 nPitch 5 合成语音的音量 按照 0 9 分为 10 级 缺省值为 9 数字越大音量越大 nVolume 5 合成语音的语速 按照 0 9 分为 10 级 缺省值为 5 数字越大语速越快 nSpeed 5 标点和回车的设置 系统内部缺省为 0 可能的取值如下 0 不阅读标点符号 自动判断回车换行是否分隔符 1 阅读标点符号 自动判断回车换行是否分隔符 2 不读符号 强制将回车换行作为分隔符 3 读符号 强制将回车换行作为分隔符 nPuncMode 0 数字串的阅读方式 缺省 0 可能的取值如下 0 自动方式 即根据上下文自动选择电报方式或数目方式阅读 如果无法判断 则使用 数目方式 1 电报方式 即一个数字一个数字阅读 例如 1997 读成 一九九七 2 数目方式 即连续的数字阅读 例如 1997 读成 一千九百九十七 3 自动方式 即根据上下文自动选择电报方式或数目方式阅读 如果无法判断 则使用 电报方式 0 等同于 DIGIT AUTO NUMBER 为 1 0 兼容而保留 nDigitMode 0 英文串的阅读方式 缺省为 0 可能的取值如下 0 自动判断 可能按字母 自录音词汇或者 SAPI 阅读 北京捷通华声语音技术有限公司 11 1 由于 4 0 版本中已经内嵌了同一音色的英文引擎 不再使用 SAPI 因此在此版本中 ENG SAPI 无效 等同于 ENG AUTO 2 强制所有英文按照单字母方式阅读 3 强制所有英文用用字母或自录音词汇阅读 不使用内嵌的英文引擎阅读 nEngMode 0 标注的处理方式 缺省为 0 可能的取值如下 0 自动判断 TAG 也即同时查询 JTTS Tag 和 SSMLTag 1 仅处理含有 jTTS 3 0 支持的 TAG 例如 read a1 2 仅处理 SSML TAG 例如 3 文本中无任何 TAG 上述 TAG 将会被读出 nTagMode 0 在连接服务器时的重试次数 有效值为 1 100 缺省为 10 nTryTimes 10 朗读风格 缺省为 1 0 抑扬顿挫 1 平稳庄重 nVoiceStyle 1 BACKAUDIO NONE 无背景音乐 取值为 0 BACKAUDIO MIN 1 BACKAUDIO MAX 10000 背景音乐序号 在资源管理中心 录 音管理器 中定义 nBackAudio 0 背景音乐的音量 从小到大为 0 100 默认值为 50 nBackAudioVolume 50 背景音乐是否循环播放 默认值为不循环播放 0 x01 循环播放 0 x00 不循环播放 wBackAudioFlag 0 数据的输出缓冲区大小 以 K 为单位 范围是 16 8192 也即从 16K 8M 默认值为 128 K 用户在获取数据时 每段的长度不会超过此缓冲区大小 nVoiceBufSize 128 插入信息的输出缓冲区大小 表示多少条插入信息 范围是 1 1000 默认值为 100 用户 在获取数据时 插入信息的数目不会超过此缓冲区大小 即使数据缓冲区仍有空间 如果 插入信息已经达到此缓冲区的最大值 仍然不会再填数据 nInsertInfoSize 100 套接字的超时时间 0 表示没有超时时间 北京捷通华声语音技术有限公司 1