Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
CuSO4Gem committed Jun 9, 2024
1 parent 5405aa1 commit 4cb0d9a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
</div>

# 简介

本项目着眼于从原始视频到翻译后最终视频的整个工作流程,确保从一而终的整个过程顺畅高效。项目提供了web后端,方便<br>
<br>
本方案优势:
- 本方案提供最简单易用的流程接口,功能严格精选,确保用户最简单有效的为视频翻译配音,避免被巨量的不靠普方案迷惑。<br>
- 方案简单好用,经过验证,十分可靠,避免被巨量的不靠普方案迷惑,节约用户选择成本。<br>
- 翻译结果质量高,大幅减少人工校对。前期项目<a href="https://github.com/CuSO4Gem/pytvzhen">pytvzhen</a>已经接受广大群友考验,倍受好评。<br>
- 方案开源可靠,免费使用。代码结构清晰,可读性强,可扩展性强,适合二次开发。

Expand Down Expand Up @@ -110,8 +111,7 @@ flask run --host=0.0.0.0 --debug
- [pytvzhen](https://github.com/CuSO4Gem/pytvzhen)
- [pytube](https://github.com/pytube/pytube)
- [ffmpeg](https://ffmpeg.org/)
- [stable-ts](https://github.com/jianfch/stable-ts)
- [whisper](https://github.com/openai/whisper)
- [faster-whisper](https://github.com/SYSTRAN/faster-whisper)
- [vocal-remover](https://github.com/tsurumeso/vocal-remover/releases)
- [srt](https://srt.readthedocs.io/en/latest/api.html)
- [pygtrans](https://github.com/foyoux/pygtrans)
Expand Down
58 changes: 29 additions & 29 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,143 +7,143 @@
- 请求方法:POST
- 返回:
- 成功:{"status": 200, "message": \[提示信息\], "video_id": \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:code:500 { "message": \[错误信息\]}

## youtube视频获取
- 说明:根据视频ID获取下载youtube视频
- 路径:/yt_download
- 请求方法:POST
- 返回:
- 成功:{"status": 200, "message": \[提示信息\], "video_id": \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:code:500 { "message": \[错误信息\]}

## 视频下载
- 说明:根据视频ID下载视频文件
- 路径:/yt/<video_id>
- 请求方法:GET
- 返回:
- 成功:视频文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 音视频分离
- 说明:根据视频ID分离音频和视频
- 路径:/extra_audio
- 请求方法:GET
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\], video_id: \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\], video_id: \[视频ID\]}
- 失败:code:500 { "message": \[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 执行背景声分离
- 说明:根据视频ID执行背景声分离,将音频分割成背景声和人声
- 路径:/remove_audio_bg
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\], video_id: \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\], video_id: \[视频ID\]}
- 失败:code:500 { "message": \[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 人声获取
- 说明:根据视频ID获取人声的音频文件
- 路径:/audio_no_bg/<video_id>
- 请求方法:GET
- 返回:
- 成功:音频文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 背景声获取
- 说明:根据视频ID获取背景声的音频文件
- 路径:/bg_audio/<video_id>
- 请求方法:GET
- 返回:
- 成功:音频文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 语言转字幕
- 说明:根据视频ID和语言,将音频转化为字幕
- 路径:/transcribe
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:code:500 { "message": \[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 获取语言字幕
- 说明:获取原音频对应的字幕文件
- 路径:/srt_en/<video_id>
- 请求方法:GET
- 返回:
- 成功:字幕文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 字幕翻译
- 说明:根据视频ID和语言,将字幕翻译为目标语言
- 路径:/translate_to_zh
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:{"status": 500, "message": \[错误信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:code:500 { "message": \[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 获取目标语言字幕
- 说明:获取原字幕对应的目标语言字幕文件
- 路径:/srt_zh_merged/<video_id>
- 请求方法:GET
- 返回:
- 成功:目标语言字幕文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 上传目标语言字幕
- 说明:上传目标语言字幕文件
- 路径:/translated_zh_upload
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\]}
- 成功:code:200 { “message”: \[提示信息\]}

## 视频配音
- 说明:根据视频ID和配音人ID,将视频配音序列
- 路径:/tts
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 获取配音包
- 说明:根据视频ID和配音人ID,获取视频配音包
- 路径:/tts/<video_id>
- 请求方法:GET
- 返回:
- 成功:配音序列压缩包
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 配音连接
- 说明:根据视频ID将配音序列连接成完整的人声轨道
- 路径:/voice_connect
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 获取人声轨道
- 说明:根据视频ID,获取人声轨道文件
- 路径:/voice_connect/<video_id>
- 请求方法:GET
- 返回:
- 成功:人声轨道文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 预览视频合成
- 说明:根据视频ID,配音,背景声合成预览效果
- 请求路径:/video_preview
- 请求方法:POST
- 返回:
- 成功:{“status”: 200, “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:{"status": 404, "message": "\[错误信息\]}
- 成功:code:200 { “message”: \[提示信息\], “video_id”: \[视频ID\]}
- 失败:code:404 { "message": "\[错误信息\]}

## 获取预览视频
- 说明:根据视频ID,获取预览视频文件
- 请求路径:/video_preview/<video_id>
- 请求方法:GET
- 返回:
- 成功:预览视频文件
- 失败:{"status": 404, "message": "\[错误信息\]}
- 失败:code:404 { "message": "\[错误信息\]}

0 comments on commit 4cb0d9a

Please sign in to comment.