android TTS TextToSpeech

前言

最近公司产品提出需求:要在一个收音机广告app上新增一个小说文本朗读的功能。我第一反应是接入讯飞或者其他平台的语音sdk，可是产品说预算有限，而那些平台需要收费，而且价格不低，让我想其他方法实现。

后面再经过baidu google之后发现android原生提供了 TextToSpeech来处理文字转语音的功能。

TextToSpeech存在的问题:

目前只支持 英文、法文、意大利文、德文、西班牙文,暂不支持中文播放

测试

我在小米手机上跑了 TextToSpeech的测试demo，发现能播报中文，查看小米手机的系统设置里发现其默认的tts是小爱同学引擎。

后来测试了华为，vivo等国产手机机型，发现都够正常播放中文文字。因为手头没有google的nexus设备，因此没有测试，但是应该是没有办法播放的。

确认详细需求

后期跟产品确定详细需求时，发现他的要求大致是希望能做一个小说朗读播放器，可以拖动播放进度，有总时长，当前播放长度，暂停、开始，播放下一章，上一章文本，以及定时关闭等功能。

开始实现

• 先引用一个网上使用textToSpeech的原文

public class MainActivity extends AppCompatActivity  implements View.OnClickListener, TextToSpeech.OnInitListener {
    private Button speechBtn; // 按钮控制开始朗读
    private EditText speechTxt; // 需要朗读的内容
    private TextToSpeech textToSpeech; // TTS对象
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        speechBtn = (Button) findViewById(R.id.btn_read);
        speechBtn.setOnClickListener(this);
        speechTxt = (EditText) findViewById(R.id.editText);
        textToSpeech = new TextToSpeech(this, this); // 参数Context,TextToSpeech.OnInitListener
    }
    /**
     * 用来初始化TextToSpeech引擎
     * status:SUCCESS或ERROR这2个值
     * setLanguage设置语言，帮助文档里面写了有22种
     * TextToSpeech.LANG_MISSING_DATA：表示语言的数据丢失。
     * TextToSpeech.LANG_NOT_SUPPORTED:不支持
     */
    @Override
    public void onInit(int status) {
        if (status == TextToSpeech.SUCCESS) {
            int result = textToSpeech.setLanguage(Locale.CHINA);
            if (result == TextToSpeech.LANG_MISSING_DATA
                    || result == TextToSpeech.LANG_NOT_SUPPORTED) {
                Toast.makeText(this, "数据丢失或不支持", Toast.LENGTH_SHORT).show();
            }
        }
    }
    @Override
    public void onClick(View v) {
        if (textToSpeech != null && !textToSpeech.isSpeaking()) {
          // 设置音调，值越大声音越尖（女生），值越小则变成男声,1.0是常规
            textToSpeech.setPitch(0.5f);
          //设定语速 ，默认1.0正常语速
           textToSpeech.setSpeechRate(1.5f);
          //朗读，注意这里三个参数的added in API level 4   四个参数的added in API level 21
            textToSpeech.speak(speechTxt.getText().toString(), TextToSpeech.QUEUE_FLUSH, null);
        }
    }
    @Override
    protected void onStop() {
        super.onStop();
        textToSpeech.stop(); // 不管是否正在朗读TTS都被打断
        textToSpeech.shutdown(); // 关闭，释放资源
    }
}

• 其中主要的几个方法有:

/**
 * text 需要转成语音的文字 
 * queueMode 队列方式： 
 * QUEUE_ADD：播放完之前的语音任务后才播报本次内容 
 * QUEUE_FLUSH：丢弃之前的播报任务，立即播报本次内容 
 * params 设置TTS参数，可以是null。 
 * KEY_PARAM_STREAM：音频通道，可以是：STREAM_MUSIC、STREAM_NOTIFICATION、STREAM_RING等 
 * KEY_PARAM_VOLUME：音量大小，0-1f 
 * utteranceId：当前朗读文本的id
 */
textToSpeech.speak(content, TextToSpeech.QUEUE_FLUSH, null,i+"");
// 不管是否正在朗读TTS都被打断
textToSpeech.stop();       
// 关闭，释放资源
textToSpeech.shutdown(); 
// 设置音调,值越大声音越尖（女生），值越小则变成男声,1.0是常规
textToSpeech.setPitch(0.5f);
// 设定语速,默认1.0正常语速
textToSpeech.setSpeechRate(1.5f);

• 在我获取content文本 调用

textToSpeech.speak(content, TextToSpeech.QUEUE_FLUSH, null,i+"");

却没有正常播放声音。在对照之前可播放声音的demo后，发现除了文本外，其余内容一致。TextToSpeech的最大播放文本长度是4000字。因此我采取的策略是将一段长文本拆分成多段短文本内容，然后播报时采用

for (int i = 0; i < readContentList.size(); i++) {
    textToSpeech.speak(readContentList.get(i), TextToSpeech.QUEUE_ADD, null,i+"");
}

拆分长文本代码如下:

//长文本拆分
    public static List<String> splitContent(String content){
        //[\u4E00-\u9FA5]是unicode2的中文区间
        Pattern pattern = Pattern.compile("[^\u4E00-\u9FA5]");
        Matcher matcher = pattern.matcher(content);
        content = matcher.replaceAll("");           //提取中文文本

        int startIndex = 0;
        int contentLength = 10;
        List<String> contentList = new ArrayList<>();
        while(startIndex<content.length()-1){
            if (startIndex + contentLength > content.length()){
                contentLength = content.length()-startIndex;
            }
            String contentTemp = content.substring(startIndex,startIndex+contentLength);
            contentList.add(contentTemp);
            startIndex = startIndex + contentLength;
        }
        return contentList;
    }

我个人是将文本拆成10个字一段。

• 总结一下:
  其实目前下来 文本朗读功能基本完成了，只需要将小说文本拆解成多段文本，然后添加到TextToSpeech中就可以了。剩下来的难点我认为主要在于播放器这一块。
  播放器的功能点有以下几点:

1. 播放/暂停按钮
2. 上一章/下一章文本
3. 可拖动的进度条
4. 定时关闭

下面开始一点一点处理，因为是公司项目，所以可能主要是记录自己开发过程中的逻辑处理思路:

首先 下面这段代码是TextToSpeech的朗读监听方法，我们可以根据 onStart(String utteranceId),和onDone(String utteranceId) 来判断 当前播放的是第几段声音(utteranceId是在调用 TextToSpeech.speak(...)时设置的最后一个参数)。

我们可以在onStart(String utteranceId)中记录当前播放的是第几段声音

textToSpeech.setOnUtteranceProgressListener(new UtteranceProgressListener() {
                @Override
                public void onStart(String utteranceId) {
                    // TODO: 2019/8/15 textToSpeech 开始播放 
                    // TODO: 2019/8/15 utteranceId即为 textToSpeech.speak("","",null,i)最后一个参数i
                    
                }

                @Override
                public void onDone(String utteranceId) {
                    // TODO: 2019/8/15 当前文本播放完毕 
            
                }

                @Override
                public void onError(String utteranceId) {

                }
            });

• 播放器 播放/暂停按钮

点击暂停时调用:

 if (textToSpeech!=null){
    textToSpeech.stop();        //退出循环播放或者说停止播报
 }

在点击播放 按钮时重新调用：

// progressIndex 为朗读监听方法onStart(String utteranceId){}中记录的当前文本进度
for (int i = progressIndex; i < readContentList.size(); i++) {
    textToSpeech.speak(readContentList.get(i), TextToSpeech.QUEUE_ADD, null,i+"");
 }

这样恢复播放会存在一个问题，例如上一段文本正朗读到第8个字，我点击暂停后再重新朗读，又会从第一个字开始朗读。
可以将每段文本拆分的更细，甚至一个字为1段来解决这个问题(我试过，但是朗读过程会有卡顿的感觉)。

• 上/下一章播放
  获取新文本内容，清除旧文本数据后，将新文本拆分重新调用 TextToSpeech.speak()方法即可

• 可拖动进度条
  前面已经提到，将一章小说拆分成多段文本(readContentList)，那么进度条的总长度就可以根据这个多段文本的长度来设置

seekbar.setMax(readContentList.size());

其进度条时长可以通过每段朗读所需时间 * 文本长度

long seekbarTime = readTime * readContentList.size();

每段文本朗读所需时长 可根据监听方法里的两次onStart(...)做一个时间差，来计算朗读一段文本所需时长。但经过本人计算，每次朗读第一次会特别耗时，其大致每10个字的粗略值是需要耗时2800毫秒。

每次拖动进度条，根据其progress来重新定位播放位置。

• 定时关闭
  可以重开一个子线程进行倒计时，然后执行 TextToSpeech.stop()即可