新增示例库逻辑
This commit is contained in:
54
docs/zh/development/architecture.md
Normal file
54
docs/zh/development/architecture.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# 架构设计
|
||||
|
||||
Pixelle-Video 的技术架构概览。
|
||||
|
||||
---
|
||||
|
||||
## 核心架构
|
||||
|
||||
Pixelle-Video 采用分层架构设计:
|
||||
|
||||
- **Web 层**: Streamlit Web 界面
|
||||
- **服务层**: 核心业务逻辑
|
||||
- **ComfyUI 层**: 图像和TTS生成
|
||||
|
||||
---
|
||||
|
||||
## 主要组件
|
||||
|
||||
### PixelleVideoCore
|
||||
|
||||
核心服务类,协调各个子服务。
|
||||
|
||||
### LLM Service
|
||||
|
||||
负责调用大语言模型生成文案。
|
||||
|
||||
### Image Service
|
||||
|
||||
负责调用 ComfyUI 生成图像。
|
||||
|
||||
### TTS Service
|
||||
|
||||
负责调用 ComfyUI 生成语音。
|
||||
|
||||
### Video Generator
|
||||
|
||||
负责合成最终视频。
|
||||
|
||||
---
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **后端**: Python 3.10+, AsyncIO
|
||||
- **Web**: Streamlit
|
||||
- **AI**: OpenAI API, ComfyUI
|
||||
- **配置**: YAML
|
||||
- **工具**: uv (包管理)
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
详细的架构文档即将推出。
|
||||
|
||||
50
docs/zh/development/contributing.md
Normal file
50
docs/zh/development/contributing.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 贡献指南
|
||||
|
||||
感谢你对 Pixelle-Video 的贡献兴趣!
|
||||
|
||||
---
|
||||
|
||||
## 如何贡献
|
||||
|
||||
1. Fork 项目仓库
|
||||
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
|
||||
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||||
5. 开启 Pull Request
|
||||
|
||||
---
|
||||
|
||||
## 开发设置
|
||||
|
||||
```bash
|
||||
# 克隆你的 fork
|
||||
git clone https://github.com/your-username/Pixelle-Video.git
|
||||
cd Pixelle-Video
|
||||
|
||||
# 安装开发依赖
|
||||
uv sync
|
||||
|
||||
# 运行测试
|
||||
pytest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 代码规范
|
||||
|
||||
- 所有代码和注释使用英文
|
||||
- 遵循 PEP 8 规范
|
||||
- 添加适当的测试
|
||||
|
||||
---
|
||||
|
||||
## 提交 Issue
|
||||
|
||||
遇到问题或有功能建议?请在 [GitHub Issues](https://github.com/PixelleLab/Pixelle-Video/issues) 提交。
|
||||
|
||||
---
|
||||
|
||||
## 行为准则
|
||||
|
||||
请保持友好和尊重,我们致力于营造包容的社区环境。
|
||||
|
||||
78
docs/zh/faq.md
Normal file
78
docs/zh/faq.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# 常见问题
|
||||
|
||||
常见问题解答。
|
||||
|
||||
---
|
||||
|
||||
## 安装相关
|
||||
|
||||
### Q: 如何安装 uv?
|
||||
|
||||
```bash
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
### Q: 可以不用 uv 吗?
|
||||
|
||||
可以,你也可以使用传统的 pip + venv 方式。
|
||||
|
||||
---
|
||||
|
||||
## 配置相关
|
||||
|
||||
### Q: 必须要配置 ComfyUI 吗?
|
||||
|
||||
不一定。你可以使用 RunningHub 云端服务,无需本地部署。
|
||||
|
||||
### Q: 支持哪些 LLM?
|
||||
|
||||
支持所有 OpenAI 兼容接口的 LLM,包括:
|
||||
- 通义千问
|
||||
- GPT-4o
|
||||
- DeepSeek
|
||||
- Ollama(本地)
|
||||
|
||||
---
|
||||
|
||||
## 使用相关
|
||||
|
||||
### Q: 第一次使用需要多久?
|
||||
|
||||
生成一个 3-5 分镜的视频大约需要 2-5 分钟。
|
||||
|
||||
### Q: 视频效果不满意怎么办?
|
||||
|
||||
可以尝试:
|
||||
1. 更换 LLM 模型
|
||||
2. 调整图像尺寸和提示词前缀
|
||||
3. 更换 TTS 工作流
|
||||
4. 尝试不同的视频模板
|
||||
|
||||
### Q: 费用大概多少?
|
||||
|
||||
- **完全免费**: Ollama + 本地 ComfyUI = 0 元
|
||||
- **推荐方案**: 通义千问 + 本地 ComfyUI ≈ 0.01-0.05 元/视频
|
||||
- **云端方案**: OpenAI + RunningHub(费用较高)
|
||||
|
||||
---
|
||||
|
||||
## 故障排查
|
||||
|
||||
### Q: ComfyUI 连接失败
|
||||
|
||||
1. 确认 ComfyUI 正在运行
|
||||
2. 检查 URL 是否正确
|
||||
3. 在 Web 界面点击「测试连接」
|
||||
|
||||
### Q: LLM API 调用失败
|
||||
|
||||
1. 检查 API Key 是否正确
|
||||
2. 检查网络连接
|
||||
3. 查看错误提示
|
||||
|
||||
---
|
||||
|
||||
## 其他问题
|
||||
|
||||
有其他问题?请查看 [故障排查](troubleshooting.md) 或提交 [Issue](https://github.com/PixelleLab/Pixelle-Video/issues)。
|
||||
|
||||
45
docs/zh/gallery/index.md
Normal file
45
docs/zh/gallery/index.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# 🎬 视频示例库
|
||||
|
||||
展示使用 Pixelle-Video 制作的视频案例。点击卡片查看完整的工作流和配置文件。
|
||||
|
||||
---
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- **阅读习惯养成**
|
||||
|
||||
---
|
||||
|
||||
<video controls width="100%" style="border-radius: 8px;">
|
||||
<source src="https://your-oss-bucket.oss-cn-hangzhou.aliyuncs.com/pixelle-video/reading-habit/video.mp4" type="video/mp4">
|
||||
</video>
|
||||
|
||||
[:octicons-mark-github-16: 查看工作流和配置](https://github.com/PixelleLab/Pixelle-Video/tree/main/docs/gallery/reading-habit)
|
||||
|
||||
- **工作效率提升**
|
||||
|
||||
---
|
||||
|
||||
<video controls width="100%" style="border-radius: 8px;">
|
||||
<source src="https://your-oss-bucket.oss-cn-hangzhou.aliyuncs.com/pixelle-video/work-efficiency/video.mp4" type="video/mp4">
|
||||
</video>
|
||||
|
||||
[:octicons-mark-github-16: 查看工作流和配置](https://github.com/PixelleLab/Pixelle-Video/tree/main/docs/gallery/work-efficiency)
|
||||
|
||||
- **健康饮食**
|
||||
|
||||
---
|
||||
|
||||
<video controls width="100%" style="border-radius: 8px;">
|
||||
<source src="https://your-oss-bucket.oss-cn-hangzhou.aliyuncs.com/pixelle-video/healthy-diet/video.mp4" type="video/mp4">
|
||||
</video>
|
||||
|
||||
[:octicons-mark-github-16: 查看工作流和配置](https://github.com/PixelleLab/Pixelle-Video/tree/main/docs/gallery/healthy-diet)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
!!! tip "如何使用"
|
||||
点击案例卡片跳转到 GitHub,下载工作流文件和配置,即可一键复现视频效果。
|
||||
|
||||
60
docs/zh/getting-started/configuration.md
Normal file
60
docs/zh/getting-started/configuration.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# 配置说明
|
||||
|
||||
完成安装后,需要配置服务才能使用 Pixelle-Video。
|
||||
|
||||
---
|
||||
|
||||
## LLM 配置
|
||||
|
||||
LLM(大语言模型)用于生成视频文案。
|
||||
|
||||
### 快速选择预设
|
||||
|
||||
1. 从下拉菜单选择预设模型:
|
||||
- 通义千问(推荐,性价比高)
|
||||
- GPT-4o
|
||||
- DeepSeek
|
||||
- Ollama(本地运行,完全免费)
|
||||
|
||||
2. 系统会自动填充 `base_url` 和 `model`
|
||||
|
||||
3. 点击「🔑 获取 API Key」链接,注册并获取密钥
|
||||
|
||||
4. 填入 API Key
|
||||
|
||||
---
|
||||
|
||||
## 图像配置
|
||||
|
||||
支持两种方式:
|
||||
|
||||
### 本地部署(推荐)
|
||||
|
||||
使用本地 ComfyUI 服务:
|
||||
|
||||
1. 安装并启动 ComfyUI
|
||||
2. 填写 ComfyUI URL(默认 `http://127.0.0.1:8188`)
|
||||
3. 点击「测试连接」确认服务可用
|
||||
|
||||
### 云端部署
|
||||
|
||||
使用 RunningHub 云端服务:
|
||||
|
||||
1. 注册 RunningHub 账号
|
||||
2. 获取 API Key
|
||||
3. 在配置中填写 API Key
|
||||
|
||||
---
|
||||
|
||||
## 保存配置
|
||||
|
||||
填写完所有必需的配置后,点击「保存配置」按钮。
|
||||
|
||||
配置会保存到 `config.yaml` 文件中。
|
||||
|
||||
---
|
||||
|
||||
## 下一步
|
||||
|
||||
- [快速开始](quick-start.md) - 生成你的第一个视频
|
||||
|
||||
115
docs/zh/getting-started/installation.md
Normal file
115
docs/zh/getting-started/installation.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# 安装
|
||||
|
||||
本页面将指导你完成 Pixelle-Video 的安装。
|
||||
|
||||
---
|
||||
|
||||
## 系统要求
|
||||
|
||||
### 必需条件
|
||||
|
||||
- **Python**: 3.10 或更高版本
|
||||
- **操作系统**: Windows、macOS 或 Linux
|
||||
- **包管理器**: uv(推荐)或 pip
|
||||
|
||||
### 可选条件
|
||||
|
||||
- **GPU**: 如需本地运行 ComfyUI,建议配备 NVIDIA 显卡(6GB+ 显存)
|
||||
- **网络**: 稳定的网络连接(用于调用 LLM API 和图像生成服务)
|
||||
|
||||
---
|
||||
|
||||
## 安装步骤
|
||||
|
||||
### 第一步:克隆项目
|
||||
|
||||
```bash
|
||||
git clone https://github.com/PixelleLab/Pixelle-Video.git
|
||||
cd Pixelle-Video
|
||||
```
|
||||
|
||||
### 第二步:安装依赖
|
||||
|
||||
!!! tip "推荐使用 uv"
|
||||
本项目使用 `uv` 作为包管理器,它比传统的 pip 更快、更可靠。
|
||||
|
||||
#### 使用 uv(推荐)
|
||||
|
||||
```bash
|
||||
# 如果还没有安装 uv,先安装它
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
|
||||
# 安装项目依赖(uv 会自动创建虚拟环境)
|
||||
uv sync
|
||||
```
|
||||
|
||||
#### 使用 pip
|
||||
|
||||
```bash
|
||||
# 创建虚拟环境
|
||||
python -m venv venv
|
||||
|
||||
# 激活虚拟环境
|
||||
# Windows:
|
||||
venv\Scripts\activate
|
||||
# macOS/Linux:
|
||||
source venv/bin/activate
|
||||
|
||||
# 安装依赖
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 验证安装
|
||||
|
||||
运行以下命令验证安装是否成功:
|
||||
|
||||
```bash
|
||||
# 使用 uv
|
||||
uv run streamlit run web/app.py
|
||||
|
||||
# 或使用 pip(需先激活虚拟环境)
|
||||
streamlit run web/app.py
|
||||
```
|
||||
|
||||
浏览器应该会自动打开 `http://localhost:8501`,显示 Pixelle-Video 的 Web 界面。
|
||||
|
||||
!!! success "安装成功!"
|
||||
如果能看到 Web 界面,说明安装成功了!接下来请查看 [配置说明](configuration.md) 来设置服务。
|
||||
|
||||
---
|
||||
|
||||
## 可选:安装 ComfyUI(本地部署)
|
||||
|
||||
如果希望本地运行图像生成服务,需要安装 ComfyUI:
|
||||
|
||||
### 快速安装
|
||||
|
||||
```bash
|
||||
# 克隆 ComfyUI
|
||||
git clone https://github.com/comfyanonymous/ComfyUI.git
|
||||
cd ComfyUI
|
||||
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 启动 ComfyUI
|
||||
|
||||
```bash
|
||||
python main.py
|
||||
```
|
||||
|
||||
ComfyUI 默认运行在 `http://127.0.0.1:8188`
|
||||
|
||||
!!! info "ComfyUI 模型"
|
||||
ComfyUI 需要下载对应的模型文件才能工作。请参考 [ComfyUI 官方文档](https://github.com/comfyanonymous/ComfyUI) 了解如何下载和配置模型。
|
||||
|
||||
---
|
||||
|
||||
## 下一步
|
||||
|
||||
- [配置服务](configuration.md) - 配置 LLM 和图像生成服务
|
||||
- [快速开始](quick-start.md) - 生成第一个视频
|
||||
|
||||
107
docs/zh/getting-started/quick-start.md
Normal file
107
docs/zh/getting-started/quick-start.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# 快速开始
|
||||
|
||||
已经完成安装和配置?让我们生成第一个视频吧!
|
||||
|
||||
---
|
||||
|
||||
## 启动 Web 界面
|
||||
|
||||
```bash
|
||||
# 使用 uv 运行
|
||||
uv run streamlit run web/app.py
|
||||
```
|
||||
|
||||
浏览器会自动打开 `http://localhost:8501`
|
||||
|
||||
---
|
||||
|
||||
## 生成你的第一个视频
|
||||
|
||||
### 步骤一:检查配置
|
||||
|
||||
首次使用时,展开「⚙️ 系统配置」面板,确认已配置:
|
||||
|
||||
- **LLM 配置**: 选择 AI 模型(如通义千问、GPT 等)并填入 API Key
|
||||
- **图像配置**: 配置 ComfyUI 地址或 RunningHub API Key
|
||||
|
||||
如果还没有配置,请查看 [配置说明](configuration.md)。
|
||||
|
||||
配置好后点击「保存配置」。
|
||||
|
||||
---
|
||||
|
||||
### 步骤二:输入主题
|
||||
|
||||
在左侧栏的「📝 内容输入」区域:
|
||||
|
||||
1. 选择「**AI 生成内容**」模式
|
||||
2. 在文本框中输入一个主题,例如:
|
||||
```
|
||||
为什么要养成阅读习惯
|
||||
```
|
||||
3. (可选)设置场景数量,默认 5 个分镜
|
||||
|
||||
!!! tip "主题示例"
|
||||
- 为什么要养成阅读习惯
|
||||
- 如何提高工作效率
|
||||
- 健康饮食的重要性
|
||||
- 旅行的意义
|
||||
|
||||
---
|
||||
|
||||
### 步骤三:配置语音和视觉
|
||||
|
||||
在中间栏:
|
||||
|
||||
**语音设置**
|
||||
- 选择 TTS 工作流(默认 Edge-TTS 即可)
|
||||
- 如需声音克隆,可上传参考音频
|
||||
|
||||
**视觉设置**
|
||||
- 选择图像生成工作流(默认即可)
|
||||
- 设置图像尺寸(默认 1024x1024)
|
||||
- 选择视频模板(推荐竖屏 1080x1920)
|
||||
|
||||
---
|
||||
|
||||
### 步骤四:生成视频
|
||||
|
||||
点击右侧栏的「🎬 生成视频」按钮!
|
||||
|
||||
系统会显示实时进度:
|
||||
- 生成文案
|
||||
- 生成配图(每个分镜)
|
||||
- 合成语音
|
||||
- 合成视频
|
||||
|
||||
!!! info "生成时间"
|
||||
生成一个 5 分镜的视频大约需要 2-5 分钟,具体时间取决于:LLM API 响应速度、图像生成速度、TTS 工作流类型、网络状况
|
||||
|
||||
---
|
||||
|
||||
### 步骤五:预览视频
|
||||
|
||||
生成完成后,视频会自动在右侧栏播放!
|
||||
|
||||
你可以看到:
|
||||
- 📹 视频预览播放器
|
||||
- ⏱️ 视频时长
|
||||
- 📦 文件大小
|
||||
- 🎬 分镜数量
|
||||
- 📐 视频尺寸
|
||||
|
||||
视频文件保存在 `output/` 文件夹中。
|
||||
|
||||
---
|
||||
|
||||
## 下一步探索
|
||||
|
||||
恭喜!你已经成功生成了第一个视频 🎉
|
||||
|
||||
接下来你可以:
|
||||
|
||||
- **调整风格** - 查看 [自定义视觉风格](../tutorials/custom-style.md) 教程
|
||||
- **克隆声音** - 查看 [使用参考音频克隆声音](../tutorials/voice-cloning.md) 教程
|
||||
- **使用 API** - 查看 [API 使用指南](../user-guide/api.md)
|
||||
- **开发模板** - 查看 [模板开发指南](../user-guide/templates.md)
|
||||
|
||||
97
docs/zh/index.md
Normal file
97
docs/zh/index.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Pixelle-Video 🎬
|
||||
|
||||
<div align="center" markdown="1">
|
||||
|
||||
**AI 视频创作工具 - 3 分钟生成一个短视频**
|
||||
|
||||
[](https://github.com/PixelleLab/Pixelle-Video/stargazers)
|
||||
[](https://github.com/PixelleLab/Pixelle-Video/issues)
|
||||
[](https://github.com/PixelleLab/Pixelle-Video/blob/main/LICENSE)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🎯 项目简介
|
||||
|
||||
只需输入一个 **主题**,Pixelle-Video 就能自动完成:
|
||||
|
||||
- ✍️ 撰写视频文案
|
||||
- 🎨 生成 AI 配图
|
||||
- 🗣️ 合成语音解说
|
||||
- 🎵 添加背景音乐
|
||||
- 🎬 一键合成视频
|
||||
|
||||
**零门槛,零剪辑经验**,让视频创作成为一句话的事!
|
||||
|
||||
---
|
||||
|
||||
## ✨ 功能亮点
|
||||
|
||||
- ✅ **全自动生成** - 输入主题,3 分钟自动生成完整视频
|
||||
- ✅ **AI 智能文案** - 根据主题智能创作解说词,无需自己写脚本
|
||||
- ✅ **AI 生成配图** - 每句话都配上精美的 AI 插图
|
||||
- ✅ **AI 生成语音** - 支持 Edge-TTS、Index-TTS 等众多主流 TTS 方案
|
||||
- ✅ **背景音乐** - 支持添加 BGM,让视频更有氛围
|
||||
- ✅ **视觉风格** - 多种模板可选,打造独特视频风格
|
||||
- ✅ **灵活尺寸** - 支持竖屏、横屏等多种视频尺寸
|
||||
- ✅ **多种 AI 模型** - 支持 GPT、通义千问、DeepSeek、Ollama 等
|
||||
- ✅ **原子能力灵活组合** - 基于 ComfyUI 架构,可使用预置工作流,也可自定义任意能力
|
||||
|
||||
---
|
||||
|
||||
## 🎬 视频示例
|
||||
|
||||
!!! info "示例视频"
|
||||
待补充:这里可以添加一些生成的视频示例
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
想马上体验?只需三步:
|
||||
|
||||
1. **[安装 Pixelle-Video](getting-started/installation.md)** - 下载并安装项目
|
||||
2. **[配置服务](getting-started/configuration.md)** - 配置 LLM 和图像生成服务
|
||||
3. **[生成第一个视频](getting-started/quick-start.md)** - 开始创作你的第一个视频
|
||||
|
||||
---
|
||||
|
||||
## 💰 费用说明
|
||||
|
||||
!!! success "完全支持免费运行!"
|
||||
|
||||
- **完全免费方案**: LLM 使用 Ollama(本地运行)+ ComfyUI 本地部署 = 0 元
|
||||
- **推荐方案**: LLM 使用通义千问(生成一个 3 段视频约 0.01-0.05 元)+ ComfyUI 本地部署
|
||||
- **云端方案**: LLM 使用 OpenAI + 图像使用 RunningHub(费用较高但无需本地环境)
|
||||
|
||||
**选择建议**:本地有显卡建议完全免费方案,否则推荐使用通义千问(性价比高)
|
||||
|
||||
---
|
||||
|
||||
## 🤝 参考项目
|
||||
|
||||
Pixelle-Video 的设计受到以下优秀开源项目的启发:
|
||||
|
||||
- [Pixelle-MCP](https://github.com/AIDC-AI/Pixelle-MCP) - ComfyUI MCP 服务器,让 AI 助手直接调用 ComfyUI
|
||||
- [MoneyPrinterTurbo](https://github.com/harry0703/MoneyPrinterTurbo) - 优秀的视频生成工具
|
||||
- [NarratoAI](https://github.com/linyqh/NarratoAI) - 影视解说自动化工具
|
||||
- [MoneyPrinterPlus](https://github.com/ddean2009/MoneyPrinterPlus) - 视频创作平台
|
||||
- [ComfyKit](https://github.com/puke3615/ComfyKit) - ComfyUI 工作流封装库
|
||||
|
||||
感谢这些项目的开源精神!🙏
|
||||
|
||||
---
|
||||
|
||||
## 📢 反馈与支持
|
||||
|
||||
- 🐛 **遇到问题**: 提交 [Issue](https://github.com/PixelleLab/Pixelle-Video/issues)
|
||||
- 💡 **功能建议**: 提交 [Feature Request](https://github.com/PixelleLab/Pixelle-Video/issues)
|
||||
- ⭐ **给个 Star**: 如果这个项目对你有帮助,欢迎给个 Star 支持一下!
|
||||
|
||||
---
|
||||
|
||||
## 📝 许可证
|
||||
|
||||
本项目采用 MIT 许可证,详情请查看 [LICENSE](https://github.com/PixelleLab/Pixelle-Video/blob/main/LICENSE) 文件。
|
||||
|
||||
52
docs/zh/reference/api-overview.md
Normal file
52
docs/zh/reference/api-overview.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# API 概览
|
||||
|
||||
Pixelle-Video Python API 参考文档。
|
||||
|
||||
---
|
||||
|
||||
## 核心类
|
||||
|
||||
### PixelleVideoCore
|
||||
|
||||
主要服务类,提供视频生成功能。
|
||||
|
||||
```python
|
||||
from pixelle_video.service import PixelleVideoCore
|
||||
|
||||
pixelle = PixelleVideoCore()
|
||||
await pixelle.initialize()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 主要方法
|
||||
|
||||
### generate_video()
|
||||
|
||||
生成视频的主要方法。
|
||||
|
||||
**参数**:
|
||||
|
||||
- `text` (str): 主题或完整文案
|
||||
- `mode` (str): 生成模式 ("generate" 或 "fixed")
|
||||
- `n_scenes` (int): 分镜数量
|
||||
- `title` (str, optional): 视频标题
|
||||
- `tts_workflow` (str): TTS 工作流
|
||||
- `image_workflow` (str): 图像生成工作流
|
||||
- `frame_template` (str): 视频模板
|
||||
- `bgm_path` (str, optional): BGM 文件路径
|
||||
|
||||
**返回**: `VideoResult` 对象
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
查看 `examples/` 目录获取更多示例。
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
详细的 API 文档即将推出。
|
||||
|
||||
60
docs/zh/reference/config-schema.md
Normal file
60
docs/zh/reference/config-schema.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# 配置文件详解
|
||||
|
||||
`config.yaml` 配置文件的详细说明。
|
||||
|
||||
---
|
||||
|
||||
## 配置结构
|
||||
|
||||
```yaml
|
||||
llm:
|
||||
provider: openai
|
||||
api_key: "your-api-key"
|
||||
base_url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
|
||||
model: "qwen-plus"
|
||||
|
||||
comfyui:
|
||||
comfyui_url: "http://127.0.0.1:8188"
|
||||
runninghub_api_key: ""
|
||||
|
||||
image:
|
||||
default_workflow: "runninghub/image_flux.json"
|
||||
prompt_prefix: "Minimalist illustration style"
|
||||
|
||||
tts:
|
||||
default_workflow: "selfhost/tts_edge.json"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## LLM 配置
|
||||
|
||||
- `provider`: 提供商(目前仅支持 openai 兼容接口)
|
||||
- `api_key`: API 密钥
|
||||
- `base_url`: API 服务地址
|
||||
- `model`: 模型名称
|
||||
|
||||
---
|
||||
|
||||
## ComfyUI 配置
|
||||
|
||||
### 基础配置
|
||||
|
||||
- `comfyui_url`: 本地 ComfyUI 地址
|
||||
- `runninghub_api_key`: RunningHub API 密钥(可选)
|
||||
|
||||
### 图像配置
|
||||
|
||||
- `default_workflow`: 默认图像生成工作流
|
||||
- `prompt_prefix`: 提示词前缀
|
||||
|
||||
### TTS 配置
|
||||
|
||||
- `default_workflow`: 默认 TTS 工作流
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
配置文件会自动在首次运行时创建。
|
||||
|
||||
108
docs/zh/troubleshooting.md
Normal file
108
docs/zh/troubleshooting.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# 故障排查
|
||||
|
||||
遇到问题?这里有一些常见问题的解决方案。
|
||||
|
||||
---
|
||||
|
||||
## 安装问题
|
||||
|
||||
### 依赖安装失败
|
||||
|
||||
```bash
|
||||
# 清理缓存
|
||||
uv cache clean
|
||||
|
||||
# 重新安装
|
||||
uv sync
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 配置问题
|
||||
|
||||
### ComfyUI 连接失败
|
||||
|
||||
**可能原因**:
|
||||
- ComfyUI 未运行
|
||||
- URL 配置错误
|
||||
- 防火墙阻止
|
||||
|
||||
**解决方案**:
|
||||
1. 确认 ComfyUI 正在运行
|
||||
2. 检查 URL 配置(默认 `http://127.0.0.1:8188`)
|
||||
3. 在浏览器中访问 ComfyUI 地址测试
|
||||
4. 检查防火墙设置
|
||||
|
||||
### LLM API 调用失败
|
||||
|
||||
**可能原因**:
|
||||
- API Key 错误
|
||||
- 网络问题
|
||||
- 余额不足
|
||||
|
||||
**解决方案**:
|
||||
1. 检查 API Key 是否正确
|
||||
2. 检查网络连接
|
||||
3. 查看错误提示中的具体原因
|
||||
4. 检查账户余额
|
||||
|
||||
---
|
||||
|
||||
## 生成问题
|
||||
|
||||
### 视频生成失败
|
||||
|
||||
**可能原因**:
|
||||
- 工作流文件损坏
|
||||
- 模型未下载
|
||||
- 资源不足
|
||||
|
||||
**解决方案**:
|
||||
1. 检查工作流文件是否存在
|
||||
2. 确认 ComfyUI 已下载所需模型
|
||||
3. 检查磁盘空间和内存
|
||||
|
||||
### 图像生成失败
|
||||
|
||||
**解决方案**:
|
||||
1. 检查 ComfyUI 是否正常运行
|
||||
2. 尝试在 ComfyUI 中手动测试工作流
|
||||
3. 检查工作流配置
|
||||
|
||||
### TTS 生成失败
|
||||
|
||||
**解决方案**:
|
||||
1. 检查 TTS 工作流是否正确
|
||||
2. 如使用声音克隆,检查参考音频格式
|
||||
3. 查看错误日志
|
||||
|
||||
---
|
||||
|
||||
## 性能问题
|
||||
|
||||
### 生成速度慢
|
||||
|
||||
**优化建议**:
|
||||
1. 使用本地 ComfyUI(比云端快)
|
||||
2. 减少分镜数量
|
||||
3. 使用更快的 LLM(如 Qianwen)
|
||||
4. 检查网络连接
|
||||
|
||||
---
|
||||
|
||||
## 其他问题
|
||||
|
||||
仍有问题?
|
||||
|
||||
1. 查看项目 [GitHub Issues](https://github.com/PixelleLab/Pixelle-Video/issues)
|
||||
2. 提交新的 Issue 描述你的问题
|
||||
3. 包含错误日志和配置信息以便快速定位
|
||||
|
||||
---
|
||||
|
||||
## 日志查看
|
||||
|
||||
日志文件位于项目根目录:
|
||||
- `api_server.log` - API 服务日志
|
||||
- `test_output.log` - 测试日志
|
||||
|
||||
36
docs/zh/tutorials/custom-style.md
Normal file
36
docs/zh/tutorials/custom-style.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# 自定义视觉风格
|
||||
|
||||
学习如何调整图像生成参数以创建独特的视觉风格。
|
||||
|
||||
---
|
||||
|
||||
## 调整提示词前缀
|
||||
|
||||
提示词前缀控制整体视觉风格:
|
||||
|
||||
```
|
||||
Minimalist black-and-white illustration, clean lines, simple style
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 调整图像尺寸
|
||||
|
||||
不同尺寸适用于不同场景:
|
||||
|
||||
- **1024x1024**: 方形,适合小红书
|
||||
- **1080x1920**: 竖屏,适合抖音、快手
|
||||
- **1920x1080**: 横屏,适合B站、YouTube
|
||||
|
||||
---
|
||||
|
||||
## 预览效果
|
||||
|
||||
使用「预览风格」功能测试不同配置的效果。
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
即将推出更多风格定制技巧。
|
||||
|
||||
35
docs/zh/tutorials/voice-cloning.md
Normal file
35
docs/zh/tutorials/voice-cloning.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 声音克隆
|
||||
|
||||
使用参考音频实现声音克隆功能。
|
||||
|
||||
---
|
||||
|
||||
## 准备参考音频
|
||||
|
||||
1. 准备一段清晰的音频文件(MP3/WAV/FLAC)
|
||||
2. 建议时长 10-30 秒
|
||||
3. 避免背景噪音
|
||||
|
||||
---
|
||||
|
||||
## 使用步骤
|
||||
|
||||
1. 在语音设置中选择支持声音克隆的 TTS 工作流(如 Index-TTS)
|
||||
2. 上传参考音频文件
|
||||
3. 使用「预览语音」测试效果
|
||||
4. 生成视频
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 不是所有 TTS 工作流都支持声音克隆
|
||||
- 参考音频质量会影响克隆效果
|
||||
- Edge-TTS 不支持声音克隆
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
即将推出更详细的声音克隆教程。
|
||||
|
||||
33
docs/zh/tutorials/your-first-video.md
Normal file
33
docs/zh/tutorials/your-first-video.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 生成你的第一个视频
|
||||
|
||||
手把手教你使用 Pixelle-Video 生成第一个视频。
|
||||
|
||||
---
|
||||
|
||||
## 前置准备
|
||||
|
||||
确保已完成:
|
||||
|
||||
- ✅ [安装](../getting-started/installation.md)
|
||||
- ✅ [配置](../getting-started/configuration.md)
|
||||
|
||||
---
|
||||
|
||||
## 教程步骤
|
||||
|
||||
详细步骤请查看 [快速开始](../getting-started/quick-start.md)。
|
||||
|
||||
---
|
||||
|
||||
## 小贴士
|
||||
|
||||
- 选择合适的主题可以获得更好的效果
|
||||
- 首次生成建议使用3-5个分镜
|
||||
- 可以先预览语音和图像效果
|
||||
|
||||
---
|
||||
|
||||
## 常见问题
|
||||
|
||||
遇到问题?查看 [FAQ](../faq.md) 或 [故障排查](../troubleshooting.md)。
|
||||
|
||||
42
docs/zh/user-guide/api.md
Normal file
42
docs/zh/user-guide/api.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# API 使用
|
||||
|
||||
Pixelle-Video 提供完整的 Python API,方便集成到你的项目中。
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
```python
|
||||
from pixelle_video.service import PixelleVideoCore
|
||||
import asyncio
|
||||
|
||||
async def main():
|
||||
# 初始化
|
||||
pixelle = PixelleVideoCore()
|
||||
await pixelle.initialize()
|
||||
|
||||
# 生成视频
|
||||
result = await pixelle.generate_video(
|
||||
text="为什么要养成阅读习惯",
|
||||
mode="generate",
|
||||
n_scenes=5
|
||||
)
|
||||
|
||||
print(f"视频已生成: {result.video_path}")
|
||||
|
||||
# 运行
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 参考
|
||||
|
||||
详细 API 文档请查看 [API 概览](../reference/api-overview.md)。
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
更多使用示例请参考项目的 `examples/` 目录。
|
||||
|
||||
48
docs/zh/user-guide/templates.md
Normal file
48
docs/zh/user-guide/templates.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# 模板开发
|
||||
|
||||
如何创建自定义视频模板。
|
||||
|
||||
---
|
||||
|
||||
## 模板简介
|
||||
|
||||
视频模板使用 HTML 定义视频画面的布局和样式。
|
||||
|
||||
---
|
||||
|
||||
## 模板结构
|
||||
|
||||
模板位于 `templates/` 目录,按尺寸分组:
|
||||
|
||||
```
|
||||
templates/
|
||||
├── 1080x1920/ # 竖屏
|
||||
├── 1920x1080/ # 横屏
|
||||
└── 1080x1080/ # 方形
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 创建模板
|
||||
|
||||
1. 复制现有模板文件
|
||||
2. 修改 HTML 和 CSS
|
||||
3. 保存到对应尺寸目录
|
||||
4. 在 Web 界面中选择使用
|
||||
|
||||
---
|
||||
|
||||
## 模板变量
|
||||
|
||||
模板支持以下变量:
|
||||
|
||||
- `{{ title }}` - 视频标题
|
||||
- `{{ text }}` - 分镜文本
|
||||
- `{{ image }}` - 分镜图片
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
详细的模板开发指南即将推出。
|
||||
|
||||
77
docs/zh/user-guide/web-ui.md
Normal file
77
docs/zh/user-guide/web-ui.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Web 界面使用指南
|
||||
|
||||
详细介绍 Pixelle-Video Web 界面的各项功能。
|
||||
|
||||
---
|
||||
|
||||
## 界面布局
|
||||
|
||||
Web 界面采用三栏布局:
|
||||
|
||||
- **左侧栏**: 内容输入与音频设置
|
||||
- **中间栏**: 语音与视觉设置
|
||||
- **右侧栏**: 视频生成与预览
|
||||
|
||||
---
|
||||
|
||||
## 系统配置
|
||||
|
||||
首次使用需要配置 LLM 和图像生成服务。详见 [配置说明](../getting-started/configuration.md)。
|
||||
|
||||
---
|
||||
|
||||
## 内容输入
|
||||
|
||||
### 生成模式
|
||||
|
||||
- **AI 生成内容**: 输入主题,AI 自动创作文案
|
||||
- **固定文案内容**: 直接输入完整文案
|
||||
|
||||
### 背景音乐
|
||||
|
||||
- 支持内置音乐
|
||||
- 支持自定义音乐文件
|
||||
|
||||
---
|
||||
|
||||
## 语音设置
|
||||
|
||||
### TTS 工作流
|
||||
|
||||
- 选择 TTS 工作流
|
||||
- 支持 Edge-TTS、Index-TTS 等
|
||||
|
||||
### 参考音频
|
||||
|
||||
- 上传参考音频进行声音克隆
|
||||
- 支持 MP3/WAV/FLAC 等格式
|
||||
|
||||
---
|
||||
|
||||
## 视觉设置
|
||||
|
||||
### 图像生成
|
||||
|
||||
- 选择图像生成工作流
|
||||
- 设置图像尺寸
|
||||
- 调整提示词前缀控制风格
|
||||
|
||||
### 视频模板
|
||||
|
||||
- 选择视频模板
|
||||
- 支持竖屏/横屏/方形
|
||||
- 可预览模板效果
|
||||
|
||||
---
|
||||
|
||||
## 生成视频
|
||||
|
||||
点击「生成视频」按钮后,系统会:
|
||||
|
||||
1. 生成视频文案
|
||||
2. 为每个分镜生成配图
|
||||
3. 合成语音解说
|
||||
4. 合成最终视频
|
||||
|
||||
生成完成后自动预览。
|
||||
|
||||
37
docs/zh/user-guide/workflows.md
Normal file
37
docs/zh/user-guide/workflows.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# 工作流定制
|
||||
|
||||
如何自定义 ComfyUI 工作流以实现特定功能。
|
||||
|
||||
---
|
||||
|
||||
## 工作流简介
|
||||
|
||||
Pixelle-Video 基于 ComfyUI 架构,支持自定义工作流。
|
||||
|
||||
---
|
||||
|
||||
## 工作流类型
|
||||
|
||||
### TTS 工作流
|
||||
|
||||
位于 `workflows/selfhost/` 或 `workflows/runninghub/`
|
||||
|
||||
### 图像生成工作流
|
||||
|
||||
位于 `workflows/selfhost/` 或 `workflows/runninghub/`
|
||||
|
||||
---
|
||||
|
||||
## 自定义工作流
|
||||
|
||||
1. 在 ComfyUI 中设计你的工作流
|
||||
2. 导出为 JSON 文件
|
||||
3. 放置到 `workflows/` 目录
|
||||
4. 在 Web 界面中选择使用
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
即将推出更详细的工作流定制指南。
|
||||
|
||||
Reference in New Issue
Block a user