一、HeyGem是什么

Heygem是一款专为Windows系统设计的全离线视频合成工具，它能够精确克隆您的外貌和声音，让您的形象数字化。您可以通过文字和语音驱动虚拟形象，进行视频制作。无需联网，保护隐私的同时，也能享受到便捷和高效的数字体验。

二、依赖

1.Nodejs 18
2. Docker Image
docker pull guiji2025/fun-asr
docker pull guiji2025/fish-speech-ziming
docker pull guiji2025/heygem.ai

三、前置条件

1. 必须有 D 盘：主要用于后续数字人、作品等数据存储 (空间要求：大于30G)
2. C 盘：用于存储服务镜像文件 (空间要求：大于100G) .如果不足 100G，可以在安装完成docker后，在下图的位置重新选一个剩余空间大于 100G 的磁盘文件夹。
   
   3.系统要求：
   目前支持 Windows 10 19042.1526 或更高版本

4.推荐配置：
CPU：第13代英特尔酷睿 i5-13400F
内存：32G及以上（必要）
显卡：rtx-4070
5.确保有英伟达显卡，并正确安装显卡驱动（必要）官网下载对应驱动即可

四、开始安装

1. 安装node js （https://nodejs.org/zh-cn/download）选择 Windows 版下载并安装。(版本选择18以上即可)

2. 安装 WSL
   01.用wsl --list --verbose命令可以查看本机有没有安装过wsl，
   02.安装wsl的命令：wsl --install (终端执行)
   03.用wsl --update更新wsl
   

3. 安装docker (https://www.docker.com/) 根据机器 CPU 架构选择不同的安装包。

4.安装服务端。(https://github.com/duixcom/Duix.Heygem) 使用git拉取源码。
(1). 在 deploy 目录下 终端执行 docker-compose up -d
(2). 如果是50系显卡 终端执行 docker-compose -f docker-compose-5090.yml up -d
(3). 下载大概需要70G流量，( 需要魔法下载，国内镜像安装容易出错 )
(4). 安装成功后 如下图显示。确保所有的服务都在运行

5. 安装客户端 ( https://github.com/GuijiAI/HeyGem.ai/releases ) 直接下载exe文件执行安装就可。
   

五、开放API

1. http://127.0.0.1:18180/v1/preprocess_and_tran （记录下返回结果后续音频合成需要用到,只支持wav格式）

//参数示例：
{
  "format": ".wav",
  "reference_audio": "xxxxxx/xxxxx.wav",
  "lang": "zh"
}
//返回示例：
{
  "asr_format_audio_url": "xxxx/x/xxx/xxx.wav",
  "reference_audio_text": "xxxxxxxxxxxx"
}

2. 音频合成 http://127.0.0.1:18180/v1/invoke ( 返回的是文件流格式 )

// 请求参数
{
  "speaker": "{uuid}", // 一个UUID保持唯一即可
  "text": "xxxxxxxxxx", // 需要合成的文本内容
  "format": "wav", // 固定传参
  "topP": 0.7, // 固定传参
  "max_new_tokens": 1024, // 固定传参
  "chunk_length": 100, // 固定传参
  "repetition_penalty": 1.2, // 固定传
  "temperature": 0.7, // 固定传参
  "need_asr": false, // 固定传参
  "streaming": false, // 固定传参
  "is_fixed_seed": 0, // 固定传参
  "is_norm": 0, // 固定传参
  "reference_audio": "{voice.asr_format_audio_url}", // 上一步“模特训练”的返回值
  "reference_text": "{voice.reference_audio_text}" // 上一步“模特训练”的返回值
}

3.视频合成 http://127.0.0.1:8383/easy/submit ( 不会返回文件路径，只返回是否成功 )

// 请求参数
{
  "audio_url": "{audioPath}", // 音频路径  此时的音频不限制为wav格式，mp3格式也可以
  "video_url": "{videoPath}", // 视频路径
  "code": "{uuid}", // 唯一key
  "chaofen": 0, // 固定值
  "watermark_switch": 0, // 固定值
  "pn": 1 // 固定值
}

4. 视频合成进度查询 http://127.0.0.1:8383/easy/query?code=${taskCode}
   get 请求，参数taskCode是上面合成接口入参中的code

5. 视频默认生成文件夹在 D:\heygem_data 需要修改可在docker-compose中修改