Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@SWHL
SWHL committed Sep 28, 2023
1 parent d879659 commit 626c3b0
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 72 deletions.
70 changes: 47 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,45 +19,69 @@
<summary>Contents</summary>

- [Introduction](#introduction)
- [Demo](#demo)
- [Overall framework](#overall-framework)
- [Installation](#installation)
- [Usage](#usage)
- [Changelog (more)](#changelog-more)
- [Documentation](#documentation)
- [Code Contributors](#code-contributors)
- [Contributing](#contributing)
- [Sponsor](#sponsor)
- [License](#license)

</details>

### Introduction
- Video hard subtitle extraction, automatically generate the corresponding `srt | txt` file.
- Supported subtitle languages: Chinese | English (For other supported languages, see: [List of supported languages](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.1/doc/doc_ch/multi_languages.md#%E8%AF%AD%E7%A7%8D%E7%BC%A9%E5%86%99))
- Extract video hard subtitles faster and more accurately, and provide output in two formats `srt|txt`:
- **Faster**: Combined with [VideoSubFinder](https://sourceforge.net/projects/videosubfinder/) software, extraction of key subtitle frames is faster.
- **More accurate**: [RapidOCR](https://github.com/RapidAI/RapidOCR) is used as the recognition library.
- **More convenient**: pip can be used directly after installation.
- **This tool is under development. During use, if you encounter any problems, please submit an issue or join the group for feedback. If you don't want to use it, just don't use it, don't affect your mood.**
- If it helps you, please give a little star ⭐ or sponsor a cup of coffee (click the link in Sponsor at the top of the page).
- The advantages are as follows:
- **Faster extraction**: Used in conjunction with [VideoSubFinder](https://sourceforge.net/projects/videosubfinder/) software to extract key subtitle frames faster.
- **More accurate recognition**: Use [RapidOCR](https://github.com/RapidAI/RapidOCR) as the recognition library.
- **More convenient to use**: pip can be installed directly and used.
- If it helps you, please give a little star ⭐.

### Demo
- TODO

### Overall framework
```mermaid
flowchart LR
A(VideoSubFinder) --Extract subtitle key frame--> B(RapidVideOCR) --OCR--> C(SRT)
A[/Video/] --Extract subtitle key frame--> B(VideoSubFinder) --OCR-->C(RapidVideOCR)
C --Convert--> D[/"SRT | TXT"/]
```

### Installation
```bash
pip install rapid_videocr
```

### Usage
- [☆ RapidVideOCR Primary Tutorial (Interface version, download and decompress)](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E5%88%9D%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88%E7%95%8C%E9%9D%A2%E7%89%88-%E4%B8%8B%E8%BD%BD%E8%A7%A3%E5%8E%8B%E4%BD%BF%E7%94%A8%EF%BC%89)
- [☆☆ RapidVideOCR Intermediate Tutorial (Python Xiaobai)](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E4%B8%AD%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88python%E5%B0%8F%E7%99%BD%EF%BC%89)
- [☆☆☆ RapidVideOCR Advanced Tutorial (Partners with python foundation)](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E9%AB%98%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88%E6%9C%89python%E5%9F%BA%E7%A1%80%E7%9A%84%E5%B0%8F%E4%BC%99%E4%BC%B4%EF%BC%89)

### Changelog ([more](https://github.com/SWHL/RapidVideOCR/wiki/Changelog))
- ♦ 2023-08-05 v2.2.4~2.2.6 update:
- Fixed index error in concat_rec_mode.
- Add logging module for easy feedback.
- 🛶 2023-07-19 v2.2.3 update:
- Increase the adaptation of VSF parameters. During command line mode and class initialization, it is possible to specify parameters with the same name for VSF commands.
- 🤓2023-07-08 v2.2.2 update:
- Fixed the problem that the Chinese path could not be read during batch recognition
- Skip issue in SRT when fixing missing axes. At present, when a certain axis fails to be recognized, the position will be vacated, which is convenient for proofreading.
- Keep the vsf results.
```bash
rapid_videocr -i RGBImages
```

### Documentation
Full documentation can be found on [docs](https://swhl.github.io/RapidVideOCR/docs), in Chinese.

### Code Contributors
<p align="left">
<a href="https://github.com/SWHL/RapidVideOCR/graphs/contributors">
<img src="https://contrib.rocks/image?repo=SWHL/RapidVideOCR" width="20%"/>
</a>
</p>

### Contributing
- Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
- Please make sure to update tests as appropriate.

### Sponsor

If you want to sponsor the project, you can directly click the **Buy me a coffee** image, please write a note (e.g. your github account name) to facilitate adding to the sponsorship list below.

<div align="left">
<a href="https://www.buymeacoffee.com/SWHL"><img src="https://raw.githubusercontent.com/RapidAI/.github/main/assets/buymeacoffe.png" width="30%" height="30%"></a>
</div>

### License
This project is released under the [Apache 2.0 license](./LICENSE).
This project is released under the [Apache 2.0 license](./LICENSE).
116 changes: 67 additions & 49 deletions docs/README_zh.md
View file
Original file line number Diff line number Diff line change
@@ -1,78 +1,96 @@
简体中文 | [English](https://github.com/SWHL/RapidVideOCR/blob/main/README.md)

<div align="center">
<img src="https://raw.githubusercontent.com/SWHL/RapidVideOCR/main/assets/logo.png" width="75%" height="75%">
<img src="https://raw.githubusercontent.com/SWHL/RapidVideOCR/main/assets/logo.png" width="55%" height="55%"/>

<div>&nbsp;</div>

<a href="https://colab.research.google.com/github/SWHL/RapidVideOCR/blob/75dae6e9804dec6e61bef98334601908dc9ec9fb/assets/RapidVideOCRDemo.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg"></a>
<a href=""><img src="https://img.shields.io/badge/Python->=3.6,<3.12-aff.svg"></a>
<a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
<a href="https://pypi.org/project/rapid-videocr/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rapid_videocr"></a>
<a href="https://github.com/SWHL/RapidVideOCR/stargazers"><img src="https://img.shields.io/github/stars/SWHL/RapidVideOCR?color=ccf"></a>
<a href="https://pepy.tech/project/rapid-videocr"><img src="https://static.pepy.tech/personalized-badge/rapid-videocr?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
<a href="https://semver.org/"><img alt="SemVer2.0" src="https://img.shields.io/badge/SemVer-2.0-brightgreen"></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>

简体中文 | [English](https://github.com/SWHL/RapidVideOCR)
</div>
<br/>

<p align="left">
<a href="https://colab.research.google.com/github/SWHL/RapidVideOCR/blob/75dae6e9804dec6e61bef98334601908dc9ec9fb/assets/RapidVideOCRDemo.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg"></a>
<a href=""><img src="https://img.shields.io/badge/Python->=3.6,<3.12-aff.svg"></a>
<a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
<a href="https://pypi.org/project/rapid-videocr/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rapid_videocr"></a>
<a href="https://github.com/SWHL/RapidVideOCR/stargazers"><img src="https://img.shields.io/github/stars/SWHL/RapidVideOCR?color=ccf"></a>
<a href="https://pepy.tech/project/rapid-videocr">
<img src="https://static.pepy.tech/personalized-badge/rapid-videocr?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads">
</a>
<a href='https://rapidvideocr.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/rapidvideocr/badge/?version=latest' alt='Documentation Status'/>
</a>
<a href="https://semver.org/"><img alt="SemVer2.0" src="https://img.shields.io/badge/SemVer-2.0-brightgreen"></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>

<details>
<summary>目录</summary>

- [简介](#简介)
- [Demo](#demo)
- [整体框架](#整体框架)
- [使用教程](#使用教程)
- [更新日志（more）](#更新日志more)
- [写在最后](#写在最后)
- [安装](#安装)
- [使用](#使用)
- [文档](#文档)
- [贡献者](#贡献者)
- [贡献指南](#贡献指南)
- [加入我们](#加入我们)
- [赞助](#赞助)
- [开源许可证](#开源许可证)

</details>

### 简介
- 视频硬字幕提取，自动生成对应`srt | txt`文件。
- 支持字幕语言：中文 | 英文 （其他可以支持的语言参见：[支持语种列表](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.1/doc/doc_ch/multi_languages.md#%E8%AF%AD%E7%A7%8D%E7%BC%A9%E5%86%99))
- 可加入QQ群：**706807542**
- 更快更准确地提取视频硬字幕，并提供`srt| txt`两种格式的输出：
- **更快**：与[VideoSubFinder](https://sourceforge.net/projects/videosubfinder/)软件结合使用，提取关键字幕帧更快。
- **更准**：采用[RapidOCR](https://github.com/RapidAI/RapidOCR)作为识别库。
- **更方便**：pip直接安装即可使用。
- 如果遇到问题，首先推荐阅读：[如何向开源社区提问题](https://mp.weixin.qq.com/s/4IZqIqE2Qf7mziQvjSP_aw)，之后再做决定。
- **该工具处于发展中。在使用过程中，如果遇到任何问题，欢迎提issue或者入群反馈。**
- 如果有帮助到您的话，请给个小星星⭐或者赞助一杯咖啡（点击页面最上面的Sponsor中链接）。
- 优势如下：
- **提取更快**：与[VideoSubFinder](https://sourceforge.net/projects/videosubfinder/)软件结合使用，提取关键字幕帧更快。
- **识别更准**：采用[RapidOCR](https://github.com/RapidAI/RapidOCR)作为识别库。
- **使用更方便**：pip直接安装即可使用。
- 如果有帮助到您的话，请给个小星星⭐。

### Demo
- TODO

### 整体框架
```mermaid
flowchart LR
A(VideoSubFinder) --提取字幕关键帧--> B(RapidVideOCR) --OCR--> C(SRT)
A[/Video/] --Extract subtitle key frame--> B(VideoSubFinder) --OCR-->C(RapidVideOCR)
C --Convert--> D[/"SRT | TXT"/]
```

### 使用教程
- [RapidVideOCR初级教程（界面版 下载解压使用）](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E5%88%9D%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88%E7%95%8C%E9%9D%A2%E7%89%88-%E4%B8%8B%E8%BD%BD%E8%A7%A3%E5%8E%8B%E4%BD%BF%E7%94%A8%EF%BC%89)
- [RapidVideOCR中级教程（python小白）](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E4%B8%AD%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88python%E5%B0%8F%E7%99%BD%EF%BC%89)
- [RapidVideOCR高级教程（有python基础的小伙伴）](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E9%AB%98%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88%E6%9C%89python%E5%9F%BA%E7%A1%80%E7%9A%84%E5%B0%8F%E4%BC%99%E4%BC%B4%EF%BC%89)

### 更新日志（[more](https://github.com/SWHL/RapidVideOCR/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97)）
- ♦ 2023-08-05 v2.2.4~2.2.6 update:
- 修复批量识别模式下，索引错误。
- 添加日志记录模块，便于使用桌面版，快速记录问题，便于反馈。
- 🛶2023-07-19 v2.2.3 update:
- 增加对VSF的参数的适配，命令行模式和类初始化时，可以指定VSF命令的同名参数。详细使用参见[link](https://github.com/SWHL/RapidVideOCR/wiki/RapidVideOCR%E9%AB%98%E7%BA%A7%E6%95%99%E7%A8%8B%EF%BC%88%E6%9C%89python%E5%9F%BA%E7%A1%80%E7%9A%84%E5%B0%8F%E4%BC%99%E4%BC%B4%EF%BC%89)
- 🤓2023-07-08 v2.2.2 update:
- 修复批量识别时，不能读取中文路径的问题
- 修复漏轴时，SRT中跳过问题。目前当出现某一轴未能识别，则会空出位置，便于校对。
- 保留VSF识别的中间结果

### 写在最后
### 安装
```bash
pip install rapid_videocr
```

### 使用
```bash
rapid_videocr -i RGBImages
```

### 文档
完整文档请移步：[docs](https://swhl.github.io/RapidVideOCR/docs)

### 贡献者
<p align="left">
<a href="https://github.com/SWHL/RapidVideOCR/graphs/contributors">
<img src="https://contrib.rocks/image?repo=SWHL/RapidVideOCR" width="20%"/>
</a>
</p>

### 贡献指南
我们感谢所有的贡献者为改进和提升 RapidVideOCR 所作出的努力。
- 欢迎提交请求。对于重大更改，请先打开issue讨论您想要改变的内容。
- 请确保适当更新测试。

### 加入我们
- 微信扫描以下二维码，关注**RapidAI公众号**，回复video即可加入RapidVideOCR微信交流群：
<div align="center">
<img src="https://raw.githubusercontent.com/RapidAI/.github/main/assets/RapidAI_WeChatAccount.jpg" width="25%" height="25%" align="center">
</div>

- 扫码加入QQ群：
- 扫码加入QQ群（706807542）：
<div align="center">
<img src="https://github.com/SWHL/RapidVideOCR/releases/download/v2.0.1/QQGroup.jpg" width="25%" height="25%" align="center">
</div>

### 赞助

如果您想要赞助该项目，可直接点击当前页最上面的Sponsor按钮，请写好备注(**您的Github账号名称**)，方便添加到赞助列表中。

### 开源许可证
该项目采用 [Apache 2.0 license](../LICENSE) 开源许可证。

0 comments on commit 626c3b0

Please sign in to comment.