docs: make Chinese README the default
This commit is contained in:
@@ -1,100 +1,106 @@
|
||||
<!-- WEHUB_ZH_README -->
|
||||
> [!NOTE]
|
||||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||||
> [English](./README.en.md) · [原始项目](https://github.com/Augani/openreel-video) · [上游 README](https://github.com/Augani/openreel-video/blob/HEAD/README.md)
|
||||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||||
|
||||
# OpenReel Video
|
||||
|
||||
> **The open source CapCut alternative. Professional video editing in your browser. No uploads. No installs. 100% open source.**
|
||||
> **开源 CapCut 替代方案。在浏览器中进行专业视频编辑。无需上传。无需安装。100% 开源。**
|
||||
|
||||
OpenReel Video is a fully-featured browser-based video editor that runs entirely client-side. Built with React, TypeScript, WebCodecs, and WebGPU for professional-grade video editing without the need for expensive software or cloud processing.
|
||||
OpenReel Video 是一款功能齐全的基于浏览器的视频编辑器,完全在客户端运行。基于 React、TypeScript、WebCodecs 和 WebGPU 构建,提供专业级视频编辑能力,无需昂贵软件或云端处理。
|
||||
|
||||
**[Try it Live](https://openreel.video)** | **[Documentation](CONTRIBUTING.md)** | **[Discussions](https://github.com/Augani/openreel-video/discussions)** | **[Twitter](https://x.com/python_xi)**
|
||||
**[在线试用](https://openreel.video)** | **[文档](CONTRIBUTING.md)** | **[讨论](https://github.com/Augani/openreel-video/discussions)** | **[Twitter](https://x.com/python_xi)**
|
||||
|
||||
   
|
||||
|
||||
---
|
||||
|
||||
## Why OpenReel?
|
||||
## 为什么选择 OpenReel?
|
||||
|
||||
- **100% Client-Side** - Your videos never leave your device. No uploads, no cloud processing, complete privacy.
|
||||
- **No Installation** - Works in Chrome/Edge. Just open and start editing.
|
||||
- **Professional Features** - Multi-track timeline, keyframe animations, color grading, audio effects, and more.
|
||||
- **GPU Accelerated** - WebGPU and WebCodecs for smooth 4K editing and fast exports.
|
||||
- **Free Forever** - MIT licensed, no subscriptions, no watermarks.
|
||||
- **100% 客户端** - 你的视频永远不会离开你的设备。无需上传,无需云端处理,完全隐私。
|
||||
- **无需安装** - 在 Chrome/Edge 中即可使用。打开即可开始编辑。
|
||||
- **专业功能** - 多轨道时间线、关键帧动画、调色、音频效果等。
|
||||
- **GPU 加速** - WebGPU 和 WebCodecs 实现流畅的 4K 编辑与快速导出。
|
||||
- **永久免费** - MIT 许可,无订阅,无水印。
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
## 功能
|
||||
|
||||
### Video Editing
|
||||
- **Multi-track timeline** - Unlimited video, audio, image, text, and graphics tracks
|
||||
- **Real-time preview** - Smooth playback with GPU acceleration
|
||||
- **Precision editing** - Frame-accurate scrubbing, cut, trim, split, ripple delete
|
||||
- **Transitions** - Crossfade, dip to black/white, wipe, slide effects
|
||||
- **Video effects** - Brightness, contrast, saturation, blur, sharpen, glow, vignette, chroma key
|
||||
- **Blend modes** - Multiply, screen, overlay, add, subtract, and more
|
||||
- **Speed control** - 0.25x to 4x with audio pitch preservation
|
||||
- **Crop & transform** - Position, scale, rotation with 3D perspective
|
||||
### 视频编辑
|
||||
- **多轨道时间线** - 无限视频、音频、图像、文本和图形轨道
|
||||
- **实时预览** - GPU 加速的流畅播放
|
||||
- **精确编辑** - 逐帧精确拖动、剪切、修剪、分割、波纹删除
|
||||
- **转场** - 交叉淡化、淡入黑/白、擦除、滑动效果
|
||||
- **视频效果** - 亮度、对比度、饱和度、模糊、锐化、发光、暗角、色度键(chroma key)
|
||||
- **混合模式** - 正片叠底(Multiply)、滤色(Screen)、叠加(Overlay)、相加(Add)、相减(Subtract)等
|
||||
- **速度控制** - 0.25x 至 4x,保留音频音调
|
||||
- **裁剪与变换** - 位置、缩放、旋转,支持 3D 透视
|
||||
|
||||
### Graphics & Text
|
||||
- **Professional text editor** - Rich styling, shadows, outlines, gradients
|
||||
- **20+ text animations** - Typewriter, fade, slide, bounce, pop, elastic, glitch
|
||||
- **Karaoke-style subtitles** - Word-by-word highlighting synced to audio
|
||||
- **Shape tools** - Rectangle, circle, arrow, polygon, star with fill/stroke
|
||||
- **SVG support** - Import SVGs with color tinting and animations
|
||||
- **Stickers & emoji** - Built-in library
|
||||
- **Background generator** - Solid colors, gradients, mesh gradients, patterns
|
||||
- **Keyframe animations** - Animate any property over time with 20+ easing curves
|
||||
### 图形与文本
|
||||
- **专业文本编辑器** - 丰富样式、阴影、描边、渐变
|
||||
- **20+ 文本动画** - 打字机、淡入淡出、滑动、弹跳、弹出、弹性、故障(glitch)
|
||||
- **卡拉 OK 风格字幕** - 逐词高亮,与音频同步
|
||||
- **形状工具** - 矩形、圆形、箭头、多边形、星形,支持填充/描边
|
||||
- **SVG 支持** - 导入 SVG,支持着色与动画
|
||||
- **贴纸与表情** - 内置素材库
|
||||
- **背景生成器** - 纯色、渐变、网格渐变、图案
|
||||
- **关键帧动画** - 随时间动画任意属性,20+ 缓动曲线
|
||||
|
||||
### Audio
|
||||
- **Multi-track mixing** - Unlimited audio tracks with real-time mixing
|
||||
- **Waveform visualization** - Visual audio editing
|
||||
- **Audio effects** - EQ, compressor, reverb, delay, chorus, flanger, distortion
|
||||
- **Volume & panning** - Per-clip controls with fade in/out
|
||||
- **Beat detection** - Auto-generate markers synced to music
|
||||
- **Audio ducking** - Auto-reduce music when dialog plays
|
||||
- **Noise reduction** - 3-pass noise removal (tonal, broadband, rumble)
|
||||
### 音频
|
||||
- **多轨道混音** - 无限音频轨道,实时混音
|
||||
- **波形可视化** - 可视化音频编辑
|
||||
- **音频效果** - EQ、压缩器、混响、延迟、合唱、镶边、失真
|
||||
- **音量与声像** - 逐片段控制,支持淡入/淡出
|
||||
- **节拍检测** - 自动生成与音乐同步的标记
|
||||
- **音频闪避(ducking)** - 对话播放时自动降低背景音乐音量
|
||||
- **降噪** - 三阶段降噪(音调、宽带、低频隆隆声)
|
||||
|
||||
### Color Grading
|
||||
- **Color wheels** - Lift, gamma, gain controls
|
||||
- **HSL adjustments** - Hue, saturation, lightness fine-tuning
|
||||
- **Curves editor** - RGB and individual channel curves
|
||||
- **LUT support** - Import and apply 3D LUTs
|
||||
- **Built-in presets** - One-click color grading
|
||||
### 调色
|
||||
- **色轮** - Lift、Gamma、Gain 控制
|
||||
- **HSL 调整** - 色相、饱和度、亮度精细调节
|
||||
- **曲线编辑器** - RGB 及各通道曲线
|
||||
- **LUT 支持** - 导入并应用 3D LUT
|
||||
- **内置预设** - 一键调色
|
||||
|
||||
### Export
|
||||
- **MP4 (H.264/H.265)** - Universal compatibility
|
||||
- **WebM (VP8/VP9/AV1)** - Web-optimized format
|
||||
- **ProRes** - Professional intermediate format (Proxy, LT, Standard, HQ, 4444)
|
||||
- **Quality presets** - 4K @ 60fps, 1080p, 720p, 480p
|
||||
- **Custom settings** - Bitrate, frame rate, codec options, color depth
|
||||
- **Hardware encoding** - WebCodecs for fast exports
|
||||
- **AI upscaling** - Enhance resolution with WebGPU shaders
|
||||
- **Audio export** - MP3, WAV, AAC, FLAC, OGG
|
||||
- **Image sequences** - JPG, PNG, WebP frame export
|
||||
- **Progress tracking** - Real-time progress with cancel support
|
||||
### 导出
|
||||
- **MP4 (H.264/H.265)** - 通用兼容格式
|
||||
- **WebM (VP8/VP9/AV1)** - Web 优化格式
|
||||
- **ProRes** - 专业中间格式(Proxy、LT、Standard、HQ、4444)
|
||||
- **质量预设** - 4K @ 60fps、1080p、720p、480p
|
||||
- **自定义设置** - 比特率、帧率、编解码器选项、色深
|
||||
- **硬件编码** - WebCodecs 实现快速导出
|
||||
- **AI 超分辨率** - 使用 WebGPU 着色器提升分辨率
|
||||
- **音频导出** - MP3、WAV、AAC、FLAC、OGG
|
||||
- **图像序列** - JPG、PNG、WebP 逐帧导出
|
||||
- **进度跟踪** - 实时进度,支持取消
|
||||
|
||||
### Professional Tools
|
||||
- **Unlimited undo/redo** - Full history with recovery
|
||||
- **Auto-save** - Never lose work (IndexedDB storage)
|
||||
- **Keyboard shortcuts** - Professional workflow
|
||||
- **Snap to grid** - Magnetic alignment
|
||||
- **Track management** - Show/hide, lock/unlock, reorder
|
||||
- **Subtitle support** - SRT import with customizable styling
|
||||
- **Screen recording** - Record screen, camera, or both
|
||||
- **Project sharing** - Export/import project files
|
||||
### 专业工具
|
||||
- **无限撤销/重做** - 完整历史记录与恢复
|
||||
- **自动保存** - 永不丢失工作(IndexedDB 存储)
|
||||
- **键盘快捷键** - 专业工作流
|
||||
- **吸附网格** - 磁性对齐
|
||||
- **轨道管理** - 显示/隐藏、锁定/解锁、重新排序
|
||||
- **字幕支持** - 导入 SRT,可自定义样式
|
||||
- **屏幕录制** - 录制屏幕、摄像头或两者
|
||||
- **项目共享** - 导出/导入项目文件
|
||||
|
||||
### Performance
|
||||
- **WebGPU rendering** - GPU-accelerated compositing
|
||||
- **WebCodecs API** - Hardware video decoding/encoding
|
||||
- **Frame caching** - LRU cache for smooth playback
|
||||
- **Web Workers** - Background processing
|
||||
- **4K support** - Edit and export in 4K resolution
|
||||
### 性能
|
||||
- **WebGPU 渲染** - GPU 加速合成
|
||||
- **WebCodecs API** - 硬件视频解码/编码
|
||||
- **帧缓存** - LRU 缓存实现流畅播放
|
||||
- **Web Workers** - 后台处理
|
||||
- **4K 支持** - 以 4K 分辨率编辑与导出
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
## 快速开始
|
||||
|
||||
### Try Online
|
||||
Visit **[openreel.video](https://openreel.video)** to start editing immediately.
|
||||
### 在线试用
|
||||
访问 **[openreel.video](https://openreel.video)** 即可立即开始编辑。
|
||||
|
||||
### Run Locally
|
||||
### 本地运行
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
@@ -110,7 +116,7 @@ pnpm dev
|
||||
# Open http://localhost:5173
|
||||
```
|
||||
|
||||
### Build for Production
|
||||
### 生产构建
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
@@ -119,7 +125,7 @@ pnpm preview
|
||||
|
||||
---
|
||||
|
||||
## Browser Requirements
|
||||
## 浏览器要求
|
||||
|
||||
| Browser | Version | Status |
|
||||
|---------|---------|--------|
|
||||
@@ -128,18 +134,18 @@ pnpm preview
|
||||
| Firefox | 130+ | Full support |
|
||||
| Safari | 16.4+ | Full support |
|
||||
|
||||
All major browsers now support WebCodecs for hardware-accelerated video encoding/decoding.
|
||||
所有主流浏览器现已支持 WebCodecs,可实现硬件加速的视频编码/解码。
|
||||
|
||||
**Recommended:**
|
||||
**推荐配置:**
|
||||
- 8GB+ RAM
|
||||
- Dedicated GPU for 4K editing
|
||||
- Modern multi-core CPU
|
||||
- 独立 GPU(用于 4K 编辑)
|
||||
- 现代多核 CPU
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
## 架构
|
||||
|
||||
### Monorepo Structure
|
||||
### Monorepo 结构
|
||||
|
||||
```
|
||||
openreel/
|
||||
@@ -161,58 +167,58 @@ openreel/
|
||||
└── storage/ # IndexedDB, serialization
|
||||
```
|
||||
|
||||
### Key Technologies
|
||||
### 核心技术
|
||||
|
||||
- **React 18** + **TypeScript** - Type-safe UI
|
||||
- **Zustand** - Lightweight state management
|
||||
- **MediaBunny** - Video/audio processing
|
||||
- **WebCodecs** - Hardware encoding/decoding
|
||||
- **WebGPU** - GPU-accelerated rendering
|
||||
- **Web Audio API** - Professional audio processing
|
||||
- **THREE.js** - 3D transforms and effects
|
||||
- **IndexedDB** - Local project storage
|
||||
- **React 18** + **TypeScript** - 类型安全的 UI
|
||||
- **Zustand** - 轻量级状态管理
|
||||
- **MediaBunny** - 视频/音频处理
|
||||
- **WebCodecs** - 硬件编码/解码
|
||||
- **WebGPU** - GPU 加速渲染
|
||||
- **Web Audio API** - 专业音频处理
|
||||
- **THREE.js** - 3D 变换与效果
|
||||
- **IndexedDB** - 本地项目存储
|
||||
|
||||
### Design Principles
|
||||
### 设计原则
|
||||
|
||||
- **Action-based editing** - Every edit is an undoable action
|
||||
- **Immutable state** - Predictable updates with Zustand
|
||||
- **Engine separation** - Video, audio, graphics engines are independent
|
||||
- **Progressive enhancement** - Graceful fallbacks (WebGPU → Canvas2D)
|
||||
- **基于操作的编辑** - 每次编辑都是可撤销的操作
|
||||
- **不可变状态** - 通过 Zustand 实现可预测的更新
|
||||
- **引擎分离** - 视频、音频、图形引擎相互独立
|
||||
- **渐进增强** - 优雅降级(WebGPU → Canvas2D)
|
||||
|
||||
---
|
||||
|
||||
## AI-Managed Development
|
||||
## AI 辅助开发
|
||||
|
||||
OpenReel is an experiment in AI-assisted open source development. Claude AI helps manage:
|
||||
OpenReel 是 AI 辅助开源开发的一次实验。Claude AI 协助管理:
|
||||
|
||||
- **Issue triage** - Reviews and responds to issues
|
||||
- **Code implementation** - Writes features and fixes bugs
|
||||
- **Code review** - Maintains quality standards
|
||||
- **Documentation** - Keeps docs up to date
|
||||
- **Issue 分类** - 审查并回复 issue
|
||||
- **代码实现** - 编写功能并修复 bug
|
||||
- **代码审查** - 维持质量标准
|
||||
- **文档** - 保持文档最新
|
||||
|
||||
Human oversight from Augustus ensures strategic direction and final approval on major changes. All code is public, tested, and follows best practices.
|
||||
Augustus 的人工监督确保战略方向,并对重大变更进行最终审批。所有代码公开、经过测试,并遵循最佳实践。
|
||||
|
||||
**What this means for contributors:**
|
||||
- Issues get reviewed quickly (usually within 24 hours)
|
||||
- Bug fixes ship fast
|
||||
- Clear, detailed responses to questions
|
||||
- High code quality standards
|
||||
**对贡献者而言这意味着:**
|
||||
- Issue 会快速得到审查(通常在 24 小时内)
|
||||
- Bug 修复快速发布
|
||||
- 对问题给出清晰、详细的回复
|
||||
- 高代码质量标准
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
## 贡献
|
||||
|
||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
欢迎贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解指南。
|
||||
|
||||
**Ways to contribute:**
|
||||
- Report bugs with reproduction steps
|
||||
- Suggest features in Discussions
|
||||
- Submit PRs for bugs or features
|
||||
- Improve documentation
|
||||
- Write tests
|
||||
- Share effect presets
|
||||
**贡献方式:**
|
||||
- 报告 bug 并提供复现步骤
|
||||
- 在 Discussions 中建议功能
|
||||
- 提交 bug 或功能的 PR
|
||||
- 改进文档
|
||||
- 编写测试
|
||||
- 分享效果预设
|
||||
|
||||
**Development workflow:**
|
||||
**开发工作流:**
|
||||
```bash
|
||||
# Fork and clone
|
||||
git clone https://github.com/Augani/openreel-video.git
|
||||
@@ -234,65 +240,65 @@ git push origin feat/your-feature
|
||||
|
||||
---
|
||||
|
||||
## Roadmap
|
||||
## 路线图
|
||||
|
||||
### Completed
|
||||
- Multi-track timeline with drag-and-drop
|
||||
- Real-time video preview with GPU acceleration
|
||||
- Full editing suite (cut, trim, split, transitions)
|
||||
- Text editor with 20+ animations
|
||||
- Graphics (shapes, SVG, stickers, backgrounds)
|
||||
- Audio mixing with effects and beat detection
|
||||
- Color grading with LUT support
|
||||
- Keyframe animation system
|
||||
- Export to MP4/WebM (4K supported)
|
||||
- Screen recording
|
||||
- AI upscaling
|
||||
- Undo/redo with auto-save
|
||||
### 已完成
|
||||
- 多轨道时间线,支持拖放
|
||||
- 实时视频预览,支持 GPU 加速
|
||||
- 完整编辑套件(剪切、修剪、分割、转场)
|
||||
- 文本编辑器,含 20+ 种动画
|
||||
- 图形(形状、SVG、贴纸、背景)
|
||||
- 音频混音,含特效与节拍检测
|
||||
- 调色,支持 LUT
|
||||
- 关键帧动画系统
|
||||
- 导出为 MP4/WebM(支持 4K)
|
||||
- 屏幕录制
|
||||
- AI 超分辨率放大
|
||||
- 撤销/重做,带自动保存
|
||||
|
||||
### In Progress
|
||||
- Nested sequences (timeline in timeline)
|
||||
- Motion tracking
|
||||
- More export formats (ProRes, GIF)
|
||||
- Plugin system
|
||||
### 进行中
|
||||
- 嵌套序列(时间线中的时间线)
|
||||
- 运动跟踪
|
||||
- 更多导出格式(ProRes、GIF)
|
||||
- 插件系统
|
||||
|
||||
### Planned
|
||||
- Adjustment layers
|
||||
- Advanced masking
|
||||
- Audio spectral editing
|
||||
- Collaborative editing
|
||||
- Mobile optimization
|
||||
### 计划中
|
||||
- 调整图层
|
||||
- 高级蒙版
|
||||
- 音频频谱编辑
|
||||
- 协作编辑
|
||||
- 移动端优化
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
## 许可证
|
||||
|
||||
MIT License - Use freely for personal and commercial projects.
|
||||
MIT License - 可免费用于个人和商业项目。
|
||||
|
||||
See [LICENSE](LICENSE) for details.
|
||||
详情请参阅 [LICENSE](LICENSE)。
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments
|
||||
## 致谢
|
||||
|
||||
**Built with:**
|
||||
- [MediaBunny](https://mediabunny.dev) - Media processing
|
||||
- [React](https://react.dev) - UI framework
|
||||
- [Zustand](https://zustand-demo.pmnd.rs/) - State management
|
||||
- [THREE.js](https://threejs.org) - 3D rendering
|
||||
- [TailwindCSS](https://tailwindcss.com) - Styling
|
||||
**构建技术栈:**
|
||||
- [MediaBunny](https://mediabunny.dev) - 媒体处理
|
||||
- [React](https://react.dev) - UI 框架
|
||||
- [Zustand](https://zustand-demo.pmnd.rs/) - 状态管理
|
||||
- [THREE.js](https://threejs.org) - 3D 渲染
|
||||
- [TailwindCSS](https://tailwindcss.com) - 样式
|
||||
|
||||
**Inspired by:**
|
||||
- DaVinci Resolve - Professional tools done right
|
||||
- CapCut - Accessible editing for everyone
|
||||
- Figma - Browser-based professional software
|
||||
**灵感来源:**
|
||||
- DaVinci Resolve - 专业工具的正确做法
|
||||
- CapCut - 人人可用的剪辑体验
|
||||
- Figma - 基于浏览器的专业软件
|
||||
|
||||
---
|
||||
|
||||
## Support
|
||||
## 支持
|
||||
|
||||
- **GitHub Issues** - Bug reports and feature requests
|
||||
- **GitHub Discussions** - Questions and community chat
|
||||
- **GitHub Issues** - 错误报告与功能请求
|
||||
- **GitHub Discussions** - 问答与社区交流
|
||||
- **Twitter/X** - [@python_xi](https://x.com/python_xi)
|
||||
|
||||
---
|
||||
@@ -303,6 +309,6 @@ CA: `B7wDnfrdtvdG7SCkRjSMJ6LkVwGWvdWrQ75iV8G9pump`
|
||||
|
||||
---
|
||||
|
||||
**Built with care by [@python_xi](https://x.com/python_xi) and AI working together.**
|
||||
**由 [@python_xi](https://x.com/python_xi) 与 AI 协作精心打造。**
|
||||
|
||||
*Making professional video editing accessible to everyone. Forever free. Forever open source.*
|
||||
*让专业视频剪辑人人可用。永久免费。永久开源。*
|
||||
|
||||
Reference in New Issue
Block a user