如何下载安装、使用语音合成PythonSDK及代码示例_智能语音交互(ISI)-阿里云帮助中心

本文介绍如何使用阿里云智能语音服务提供的Python SDK，包括SDK的安装方法及SDK代码示例。

前提条件

在使用SDK前，请先阅读接口说明，详情请参见接口说明。

下载安装

说明

SDK仅支持Python3，暂不支持Python2。
请确认已安装Python包管理工具setuptools。如果没有安装，请在终端使用以下命令安装：
```
pip install setuptools
```

下载Python SDK。
从Github获取Python SDK，或直接下载alibabacloud-nls-python-sdk-1.0.0.zip。
安装SDK依赖。
进入SDK根目录使用如下命令安装SDK依赖：
```
python -m pip install -r requirements.txt
```
安装SDK。
依赖安装完成后使用如下命令安装SDK：
```
python -m pip install .
```
安装完成后通过以下代码导入SDK。
```
# -*- coding: utf-8 -*-
import nls
```

重要

上述命令均需要在SDK根目录中执行。

多线程和多并发

在CPython中，由于存在全局解释器锁，同一时刻只有一个线程可以执行Python代码（虽然某些性能导向的库可能会去除此限制）。如果您想更好地利用多核心计算机的计算资源，推荐你使用multiprocessing或concurrent.futures.ProcessPoolExecutor。如果你想要同时运行多个I/O密集型任务，则多线程仍然是一个合适的模型。

如果单解释器有太多线程，将会在线程间切换造成更多消耗，有可能会导致SDK出现错误。不建议使用超过200线程，推荐使用multiprocessing技术或者手动使用脚本创建多个解释器。

关键接口

语音合成对应的类为NlsSpeechSynthesizer，其核心方法如下：

1. 初始化（init）

参数说明

参数	类型	参数说明
url	String	网关WebSocket URL地址，默认为`wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1`。
appkey	String	Appkey，获取方式请参见管理项目。
long_tts	bool	语音合成方式，取值说明如下： True：使用实时长文本语音合成，详情请参见接口说明。 False：使用实时短文本合成，默认为False。
token	String	访问Token，详情可参见获取Token概述。
on_metainfo	Function	如果start方法中通过ex参数传递enable_subtitle，则会返回对应字幕信息。回调参数包含以下两种： JSON形式的字符串用户自定义参数其中，用户自定义参数为下方callback_args字段中返回的参数内容。
on_data	Function	当存在合成数据后的回调参数。回调参数包含以下两种：对应start方法中aformat的二进制音频数据用户自定义参数其中，用户自定义参数为下方callback_args字段中返回的参数内容。
on_error	Function	当SDK或云端出现错误时的回调参数。回调参数包含以下两种： JSON形式的字符串用户自定义参数其中，用户自定义参数为下方callback_args字段中返回的参数内容。
on_close	Function	当和云端连接断开时的回调参数。回调参数为用户自定义参数，即用户自定义参数为下方callback_args字段中返回的参数内容。
callback_args	List	用户自定义参数列表，列表中的内容会打包（pack）成List数据结构传递给各个回调的最后一个参数。

返回值：无

2. start

同步开始语音合成，如果wait_complete为True（默认），则会阻塞直到所有音频合成完毕（on_completed返回之后）返回，否则会立即返回。

参数说明

参数	类型	参数说明
text	String	要合成的文字。
aformat	String	合成出来音频的格式，支持输出PCM、WAV和MP3编码格式数据，默认为pcm。
voice	String	发音人，默认为xiaoyun。
sample_rate	Integer	识别音频采样率，默认值：16000 Hz。
volume	Integer	音量大小，取值范围0~100，默认值：50。
speech_rate	Integer	语速，取值范围-500~500，默认值：0。
pitch_rate	Integer	语调，取值范围-500~500，默认值：0。
wait_complete	Boolean	是否阻塞到合成完成。
start_timeout	Integer	和云端连接建立超时，默认值：10秒。
completed_timeout	Integer	从连接建立到合成完成超时，默认值：60秒
ping_interval	Integer	Ping包发送间隔，默认值：8秒。无需间隔可设置为0或None。
ping_timeout	Integer	是否检查Pong包超时，默认值：None。None为不检查Pong包是否超时。
ex	Dict	用户提供的额外参数，该字典内容会以`key:value`形式合并进请求的payload段中，详情可参见接口说明章节中的请求数据。

返回值：Boolean类型，False为失败，True为成功。

3. shutdown

强行关闭当前请求，重复调用无副作用。

参数说明：无
返回值：无

代码示例

说明

本示例中将合成的音频保存在文件中，如果您需要播放音频且对实时性要求较高，建议使用流式播放，即边接收语音数据边播放，减少延时。
本示例中使用SDK内置的默认外网访问服务端URL，如果您使用阿里云上海地域的ECS，并需要通过内网访问服务端URL，请使用如下URL：URL="wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1"。

import time
import threading
import sys

import nls

URL="wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1"
TOKEN="yourToken"  #参考https://help.aliyun.com/document_detail/450255.html获取token
APPKEY="yourAppkey"       #获取Appkey请前往控制台：https://nls-portal.console.aliyun.com/applist



TEXT='大壮正想去摘取花瓣，谁知阿丽和阿强突然内讧，阿丽拿去手枪向树干边的阿强射击，两声枪响，阿强直接倒入水中'

#以下代码会根据上述TEXT文本反复进行语音合成
class TestTts:
    def __init__(self, tid, test_file):
        self.__th = threading.Thread(target=self.__test_run)
        self.__id = tid
        self.__test_file = test_file
   
    def start(self, text):
        self.__text = text
        self.__f = open(self.__test_file, "wb")
        self.__th.start()
    
    def test_on_metainfo(self, message, *args):
        print("on_metainfo message=>{}".format(message))  

    def test_on_error(self, message, *args):
        print("on_error args=>{}".format(args))

    def test_on_close(self, *args):
        print("on_close: args=>{}".format(args))
        try:
            self.__f.close()
        except Exception as e:
            print("close file failed since:", e)

    def test_on_data(self, data, *args):
        try:
            self.__f.write(data)
        except Exception as e:
            print("write data failed:", e)

    def test_on_completed(self, message, *args):
        print("on_completed:args=>{} message=>{}".format(args, message))


    def __test_run(self):
      	print("thread:{} start..".format(self.__id))
      	tts = nls.NlsSpeechSynthesizer(url=URL,
      	      	      	      	       token=TOKEN,
      	      	      	      	       appkey=APPKEY,
      	      	      	      	       on_metainfo=self.test_on_metainfo,
      	      	      	      	       on_data=self.test_on_data,
      	      	      	      	       on_completed=self.test_on_completed,
      	      	      	      	       on_error=self.test_on_error,
      	      	      	      	       on_close=self.test_on_close,
      	      	      	      	       callback_args=[self.__id])
      	print("{}: session start".format(self.__id))
      	r = tts.start(self.__text, voice="ailun")
      	print("{}: tts done with result:{}".format(self.__id, r))

def multiruntest(num=500):
    for i in range(0, num):
        name = "thread" + str(i)
        t = TestTts(name, "tests/test_tts.pcm")
        t.start(TEXT)

nls.enableTrace(True)
multiruntest(1)