'commit'

XiaoZhi/xiaozhi-esp32-server/main/xiaozhi-server/test/tts_websocket_demo.py

@@ -0,0 +1,180 @@
+#coding=utf-8
+
+'''
+requires Python 3.6 or later
+
+pip install asyncio
+pip install websockets
+
+'''
+
+import asyncio
+import websockets
+import uuid
+import json
+import gzip
+import copy
+
+MESSAGE_TYPES = {11: "audio-only server response", 12: "frontend server response", 15: "error message from server"}
+MESSAGE_TYPE_SPECIFIC_FLAGS = {0: "no sequence number", 1: "sequence number > 0",
+                               2: "last message from server (seq < 0)", 3: "sequence number < 0"}
+MESSAGE_SERIALIZATION_METHODS = {0: "no serialization", 1: "JSON", 15: "custom type"}
+MESSAGE_COMPRESSIONS = {0: "no compression", 1: "gzip", 15: "custom compression method"}
+
+# Q1：哪里可以获取到以下参数appid，cluster，token，authorization_type，secret_key ？
+# https://www.volcengine.com/docs/6561/196768#q1%EF%BC%9A%E5%93%AA%E9%87%8C%E5%8F%AF%E4%BB%A5%E8%8E%B7%E5%8F%96%E5%88%B0%E4%BB%A5%E4%B8%8B%E5%8F%82%E6%95%B0appid%EF%BC%8Ccluster%EF%BC%8Ctoken%EF%BC%8Cauthorization-type%EF%BC%8Csecret-key-%EF%BC%9F
+
+# https://www.volcengine.com/docs/6561/1257544
+appid = "2258132518"
+token = "kwC-THR8FyGqwCfhSvQI0nqB_VBS9mGW"
+cluster = "volcano_tts"
+# 湾湾小何
+voice_type = "zh_female_wanwanxiaohe_moon_bigtts"
+host = "openspeech.bytedance.com"
+api_url = f"wss://{host}/api/v1/tts/ws_binary"
+
+# version: b0001 (4 bits)
+# header size: b0001 (4 bits)
+# message type: b0001 (Full client request) (4bits)
+# message type specific flags: b0000 (none) (4bits)
+# message serialization method: b0001 (JSON) (4 bits)
+# message compression: b0001 (gzip) (4bits)
+# reserved data: 0x00 (1 byte)
+default_header = bytearray(b'\x11\x10\x11\x00')
+
+request_json = {
+    "app": {
+        "appid": appid,
+        "token": "access_token",
+        "cluster": cluster
+    },
+    "user": {
+        "uid": "388808087185088"
+    },
+    "audio": {
+        "voice_type": "xxx",
+        "encoding": "mp3",
+        "speed_ratio": 1.0,
+        "volume_ratio": 1.0,
+        "pitch_ratio": 1.0,
+    },
+    "request": {
+        "reqid": "xxx",
+        "text": "字节跳动语音合成。",
+        "text_type": "plain",
+        "operation": "xxx"
+    }
+}
+
+
+async def test_submit():
+    submit_request_json = copy.deepcopy(request_json)
+    submit_request_json["audio"]["voice_type"] = voice_type
+    submit_request_json["request"]["reqid"] = str(uuid.uuid4())
+    submit_request_json["request"]["operation"] = "submit"
+    payload_bytes = str.encode(json.dumps(submit_request_json))
+    payload_bytes = gzip.compress(payload_bytes)  # if no compression, comment this line
+    full_client_request = bytearray(default_header)
+    full_client_request.extend((len(payload_bytes)).to_bytes(4, 'big'))  # payload size(4 bytes)
+    full_client_request.extend(payload_bytes)  # payload
+    print("\n------------------------ test 'submit' -------------------------")
+    print("request json: ", submit_request_json)
+    print("\nrequest bytes: ", full_client_request)
+    file_to_save = open("test_submit.mp3", "wb")
+    header = {"Authorization": f"Bearer; {token}"}
+    async with websockets.connect(api_url, extra_headers=header, ping_interval=None) as ws:
+        await ws.send(full_client_request)
+        while True:
+            res = await ws.recv()
+            done = parse_response(res, file_to_save)
+            if done:
+                file_to_save.close()
+                break
+        print("\nclosing the connection...")
+
+
+async def test_query():
+    query_request_json = copy.deepcopy(request_json)
+    query_request_json["audio"]["voice_type"] = voice_type
+    query_request_json["request"]["reqid"] = str(uuid.uuid4())
+    query_request_json["request"]["operation"] = "query"
+    payload_bytes = str.encode(json.dumps(query_request_json))
+    payload_bytes = gzip.compress(payload_bytes)  # if no compression, comment this line
+    full_client_request = bytearray(default_header)
+    full_client_request.extend((len(payload_bytes)).to_bytes(4, 'big'))  # payload size(4 bytes)
+    full_client_request.extend(payload_bytes)  # payload
+    print("\n------------------------ test 'query' -------------------------")
+    print("request json: ", query_request_json)
+    print("\nrequest bytes: ", full_client_request)
+    file_to_save = open("test_query.mp3", "wb")
+    header = {"Authorization": f"Bearer; {token}"}
+    async with websockets.connect(api_url, extra_headers=header, ping_interval=None) as ws:
+        await ws.send(full_client_request)
+        res = await ws.recv()
+        parse_response(res, file_to_save)
+        file_to_save.close()
+        print("\nclosing the connection...")
+
+
+def parse_response(res, file):
+    print("--------------------------- response ---------------------------")
+    # print(f"response raw bytes: {res}")
+    protocol_version = res[0] >> 4
+    header_size = res[0] & 0x0f
+    message_type = res[1] >> 4
+    message_type_specific_flags = res[1] & 0x0f
+    serialization_method = res[2] >> 4
+    message_compression = res[2] & 0x0f
+    reserved = res[3]
+    header_extensions = res[4:header_size*4]
+    payload = res[header_size*4:]
+    print(f"            Protocol version: {protocol_version:#x} - version {protocol_version}")
+    print(f"                 Header size: {header_size:#x} - {header_size * 4} bytes ")
+    print(f"                Message type: {message_type:#x} - {MESSAGE_TYPES[message_type]}")
+    print(f" Message type specific flags: {message_type_specific_flags:#x} - {MESSAGE_TYPE_SPECIFIC_FLAGS[message_type_specific_flags]}")
+    print(f"Message serialization method: {serialization_method:#x} - {MESSAGE_SERIALIZATION_METHODS[serialization_method]}")
+    print(f"         Message compression: {message_compression:#x} - {MESSAGE_COMPRESSIONS[message_compression]}")
+    print(f"                    Reserved: {reserved:#04x}")
+    if header_size != 1:
+        print(f"           Header extensions: {header_extensions}")
+    if message_type == 0xb:  # audio-only server response
+        if message_type_specific_flags == 0:  # no sequence number as ACK
+            print("                Payload size: 0")
+            return False
+        else:
+            sequence_number = int.from_bytes(payload[:4], "big", signed=True)
+            payload_size = int.from_bytes(payload[4:8], "big", signed=False)
+            payload = payload[8:]
+            print(f"             Sequence number: {sequence_number}")
+            print(f"                Payload size: {payload_size} bytes")
+        file.write(payload)
+        if sequence_number < 0:
+            return True
+        else:
+            return False
+    elif message_type == 0xf:
+        code = int.from_bytes(payload[:4], "big", signed=False)
+        msg_size = int.from_bytes(payload[4:8], "big", signed=False)
+        error_msg = payload[8:]
+        if message_compression == 1:
+            error_msg = gzip.decompress(error_msg)
+        error_msg = str(error_msg, "utf-8")
+        print(f"          Error message code: {code}")
+        print(f"          Error message size: {msg_size} bytes")
+        print(f"               Error message: {error_msg}")
+        return True
+    elif message_type == 0xc:
+        msg_size = int.from_bytes(payload[:4], "big", signed=False)
+        payload = payload[4:]
+        if message_compression == 1:
+            payload = gzip.decompress(payload)
+        print(f"            Frontend message: {payload}")
+    else:
+        print("undefined message type!")
+        return True
+
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(test_submit())
+    loop.run_until_complete(test_query())