hiroi-sora / Umi-OCR

OCR software, free and offline. 开源、免费的离线OCR软件。支持截屏/批量导入图片,PDF文档识别,排除水印/页眉页脚,扫描/生成二维码。内置多国语言库。
MIT License
26.05k stars 2.64k forks source link
ocr ocr-python paddleocr qml qt screenshot umi-ocr

中文 English 日本語

Umi-OCR

Umi-OCR 文字识别工具

Umi-OCR LICENSE forks stars forks 翻译状态

使用说明 下载地址 更新日志 提交Bug


免费,开源,可批量的离线OCR软件
适用于 Windows7 x64 、Linux x64

- **免费**:本项目所有代码开源,完全免费。 - **方便**:解压即用,离线运行,无需网络。 - **高效**:自带高效率的离线OCR引擎,内置多种语言识别库。 - **灵活**:支持命令行、HTTP接口等外部调用方式。 - **功能**:截图OCR / 批量OCR / PDF识别 / 二维码 / 公式识别

1-标题-1.png

![1-标题-2.png](https://tupian.li/images/2023/11/19/6559909fdeeba.png) ## 目录 - [截图识别](#截图OCR) - [排版解析](#文本后处理) - 识别不同排版,按正确顺序输出文字 - [批量识别](#批量OCR) - [忽略区域](#忽略区域) - 排除截图水印处的文字 - [二维码](#二维码) 支持扫码或生成二维码图片 - [文档识别](#文档识别) 从PDF扫描件中提取文本,或转为双层可搜索PDF - [全局设置](#全局设置) - [命令行调用](docs/README_CLI.md) - [HTTP接口](docs/http/README.md) - [构建项目(Windows、Linux)](#构建项目) ## 使用源码 开发者请务必阅读 [构建项目](#构建项目) 。 ## 下载发行版 以下发布链接均长期维护,提供稳定版本的下载。 - **蓝奏云** https://hiroi-sora.lanzoul.com/s/umi-ocr (国内推荐,免注册/无限速) - **GitHub** https://github.com/hiroi-sora/Umi-OCR/releases/latest - **Source Forge** https://sourceforge.net/projects/umi-ocr
•  Scoop Installer(点击展开) [Scoop](https://scoop.sh/) 是一款Windows下的命令行安装程序,可方便地管理多个应用。您可以先安装 Scoop ,再使用以下指令安装 `Umi-OCR` : - 添加 `extras` 桶: ``` scoop bucket add extras ``` - (可选1)安装 Umi-OCR(自带 `Rapid-OCR` 引擎,兼容性好): ``` scoop install extras/umi-ocr ``` - (可选2)安装 Umi-OCR(自带 `Paddle-OCR` 引擎,速度稍快): ``` scoop install extras/umi-ocr-paddle ``` - 不要同时安装二者,快捷方式可能会被覆盖。但您可以额外导入 [插件](https://github.com/hiroi-sora/Umi-OCR_plugins) ,随时切换不同OCR引擎。

## 开始使用 软件发布包下载为 `.7z` 压缩包或 `.7z.exe` 自解压包。自解压包可在没有安装压缩软件的电脑上,解压文件。 本软件无需安装。解压后,点击 `Umi-OCR.exe` 即可启动程序。 遇到任何问题,请提 [Issue](https://github.com/hiroi-sora/Umi-OCR/issues) ,我会尽可能帮助你。 ## 界面语言 Umi-OCR 支持的界面多国语言。在第一次打开软件时,将会按照你的电脑的系统设置,自动切换语言。 如果需要手动切换语言,请参考下图,`全局设置`→`语言/Language` 。

1-标题-1.png

## 标签页 Umi-OCR v2 由一系列灵活好用的**标签页**组成。您可按照自己的喜好,打开需要的标签页。 标签栏左上角可以切换**窗口置顶**。右上角能够**锁定标签页**,以防止日常使用中误触关闭标签页。 ### 截图OCR

2-截图-1.png

**截图OCR**:打开这一页后,就可以用快捷键唤起截图,识别图中的文字。 - 左侧的图片预览栏,可直接用鼠标划选复制。 - 右侧的识别记录栏,可以编辑文字,允许划选多个记录复制。 - 也支持在别处复制图片,粘贴到Umi-OCR进行识别。 - 关于 [公式识别](https://github.com/hiroi-sora/Umi-OCR/issues/254) 功能 #### 文本后处理

2-截图-2.png

关于 **OCR文本后处理 - 排版解析方案**: 可以整理OCR结果的排版和顺序,使文本更适合阅读和使用。预设方案: - `多栏-按自然段换行`:适合大部分情景,自动识别多栏布局,按自然段规则进行换行。 - `多栏-总是换行`:每段语句都进行换行。 - `多栏-无换行`:强制将所有语句合并到同一行。 - `单栏-按自然段换行`/`总是换行`/`无换行`:与上述类似,不过 不区分多栏布局。 - `单栏-保留缩进`:适用于解析代码截图,保留行首缩进和行中空格。 - `不做处理`:OCR引擎的原始输出,默认每段语句都进行换行。 上述方案,均能自动处理横排和竖排(从右到左)的排版。(竖排文字还需要OCR引擎本身支持) --- ### 批量OCR

3-批量-1.png

**批量OCR**:这一页用于批量导入本地图片进行识别。 - 支持格式:`jpg, jpe, jpeg, jfif, png, webp, bmp, tif, tiff`。 - 保存识别结果的支持格式:`txt, jsonl, md, csv(Excel)`。 - 与截图OCR一样,支持`文本后处理`功能,整理OCR文本的排版和顺序。 - 没有数量上限,可一次性导入几百张图片进行任务。 - 支持任务完成后自动关机/待机。 - 如果要识别像素超大的长图或大图,请调整:**页面的设置→文字识别→限制图像边长→【调高数值】**。 - 拥有特殊功能 `忽略区域` 。 #### 忽略区域

3-批量-2.png

关于 **OCR文本后处理 - 忽略区域**: 批量OCR中的一种特殊功能,适用于排除图片中的不想要的文字。 - 在批量识别页的右栏设置中可进入忽略区域编辑器。 - 如上方样例,图片顶部和右下角存在多个水印 / LOGO。如果批量识别这类图片,水印会对识别结果造成干扰。 - 按住右键,绘制多个矩形框。这些区域内的文字将在任务中被忽略。 - 请尽量将矩形框画得大一些,完全包裹住水印所有可能出现的位置。 - 注意,只有处于忽略区域框内部的整个文本块(而不是单个字符)会被忽略。如下图所示,黄色边框的深色矩形是一个忽略区域。那么只有`key_mouse`才会被忽略。`pubsub_connector.py`、`pubsub_service.py` 这两个文本块得以保留。

忽略区域范围示例.png

--- ### 文档识别

**文档识别**: - 支持格式:`pdf, xps, epub, mobi, fb2, cbz`。 - 对扫描件进行OCR,或提取原有文本。可输出为 **双层可搜索PDF** 。 - 支持设定 **忽略区域** ,可用于排除页眉页脚的文字。 - 可设置任务完成后 **自动关机/休眠** 。 --- ### 二维码

4-二维码-1.png

**扫码**: - 截图/粘贴/拖入本地图片,读取其中的二维码、条形码。 - 支持一图多码。 - 支持19种协议,如下: `Aztec`,`Codabar`,`Code128`,`Code39`,`Code93`,`DataBar`,`DataBarExpanded`,`DataMatrix`,`EAN13`,`EAN8`,`ITF`,`LinearCodes`,`MatrixCodes`,`MaxiCode`,`MicroQRCode`,`PDF417`,`QRCode`,`UPCA`,`UPCE`

4-二维码-2.png

**生成码**: - 输入文本,生成二维码图片。 - 支持19种协议和**纠错等级**等参数。 --- ### 全局设置

5-全局设置-1.png

**全局设置**:在这里可以调整软件的全局参数。常用功能如下: - 一键添加快捷方式或设置开机自启。 - 更改界面**语言**。Umi支持繁中、英语、日语等语言。 - 切换界面**主题**。Umi拥有多个亮/暗主题。 - 调整界面**文字的大小**和**字体**。 - 切换OCR插件。 - **渲染器**:软件界面默认支持显卡加速渲染。如果在你的机器上出现截屏闪烁、UI错位的情况,请调整`界面和外观` → `渲染器` ,尝试切换到不同渲染方案,或关闭硬件加速。 ## 调用接口: - [命令行手册](docs/README_CLI.md) - [HTTP接口手册](docs/http/README.md) --- ## 软件本地化翻译: 感谢以下译者,为 Umi-OCR 贡献了本地化翻译工作:(排名不分先后) | 译者 | 贡献语言 | | --------------------------------------------------------------- | ------------------------- | | [bob](https://hosted.weblate.org/user/q021) | English, 繁體中文, 日本語 | | [Qingzheng Gao](https://github.com/QZGao) | English, 繁體中文 | | [Weng, Chia-Ling](https://hosted.weblate.org/user/ChiaLingWeng) | English, 繁體中文 | | [linzow](https://hosted.weblate.org/user/linzow) | English, 繁體中文 | | [Eric Guo](https://hosted.weblate.org/user/qwedc001) | English | | [steven0081](https://hosted.weblate.org/user/steven0081) | English | | [Marcos i](https://hosted.weblate.org/user/ultramarkorj9) | English | | [plum7x](https://hosted.weblate.org/user/plum7x) | 繁體中文 | | [hugoalh](https://hosted.weblate.org/user/hugoalh) | 繁體中文 | | [ドコモ光](https://hosted.weblate.org/user/umren190402) | 日本語 | | [杨鹏](https://hosted.weblate.org/user/ypf) | Português | 如果有信息错误或人员缺漏,请在 [这个讨论](https://github.com/hiroi-sora/Umi-OCR/discussions/449) 中回复。 本项目使用在线平台 [Weblate: Umi-OCR](https://hosted.weblate.org/engage/umi-ocr/) 进行本地化翻译协作。我们欢迎任何用户参与翻译工作,您可校对、补充现有语言,或添加新语言。 --- ## 关于项目结构 ### 各仓库: - [主仓库](https://github.com/hiroi-sora/Umi-OCR) 👈 - [插件库](https://github.com/hiroi-sora/Umi-OCR_plugins) - [Windows 运行库](https://github.com/hiroi-sora/Umi-OCR_runtime_windows) - [Linux 运行库](https://github.com/hiroi-sora/Umi-OCR_runtime_linux) ### 工程结构: `**` 后缀表示本仓库(`主仓库`)包含的内容。 ``` Umi-OCR ├─ Umi-OCR.exe ├─ umi-ocr.sh └─ UmiOCR-data ├─ main.py ** ├─ version.py ** ├─ qt_res ** │ └─ 项目qt资源,包括图标和qml源码 ├─ py_src ** │ └─ 项目python源码 ├─ plugins │ └─ 插件 └─ i18n ** └─ 翻译文件 ``` 支持的离线OCR引擎: - [PaddleOCR-json](https://github.com/hiroi-sora/PaddleOCR-json) - [RapidOCR-json](https://github.com/hiroi-sora/RapidOCR-json) 运行环境框架: - [PyStand](https://github.com/skywind3000/PyStand) 定制版 ## 构建项目 ### 第零步:(可选)fork本项目 ### 第一步:下载代码 请参考 [更新日志](CHANGE_LOG.md) 开头的说明。 ### 后续步骤: 请跳转下述仓库,完成对应平台的开发/运行环境部署。 - [Windows](https://github.com/hiroi-sora/Umi-OCR_runtime_windows) - [Linux](https://github.com/hiroi-sora/Umi-OCR_runtime_linux) --- ## 赞助 Umi-OCR 项目主要由作者 [hiroi-sora](https://github.com/hiroi-sora) 用业余时间在开发和维护。如果您喜欢这款软件,欢迎赞助。 - 国内用户可通过 [爱发电](https://afdian.com/a/hiroi-sora) 赞助作者。 ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=hiroi-sora/Umi-OCR&type=Date)](https://star-history.com/#hiroi-sora/Umi-OCR&Date) ## [更新日志](CHANGE_LOG.md) ## 开发计划
已完成的工作 - 标签页框架。 - OCR API控制器。 - OCR 任务控制器。 - 主题管理器,支持切换浅色/深色主题主题。 - 实现 **批量OCR**。 - 实现 **截图OCR**。 - 快捷键机制。 - 系统托盘菜单。 - 文本块后处理(排版优化)。 - 引擎内存清理。 - 软件界面多国语言。 - 命令行模式。 - Win7兼容。 - Excel(csv)输出格式。 - `Esc`中断截图操作 - 外置主题文件 - 字体切换 - 加载动画 - 忽略区域。 - 二维码识别。 - 批量识别页面的图片预览窗口。 - PDF识别。 - 调用本地图片浏览器打开图片。 [#335](https://github.com/hiroi-sora/Umi-OCR/issues/335) - 重复上一次截图。 [#357](https://github.com/hiroi-sora/Umi-OCR/issues/357) - 修Bug:文档识别在Windows7系统的兼容性问题。 - HTTP/命令行接口添加二维码识别/生成功能。 (#423) - 二维码接口的文档。 - Linux 平台移植。 - HTTP 文档识别接口。
##### 远期计划
展开 这些是预想中的功能,在开发初期已预留好接口,将在远期慢慢实现。 但开发途中受限于实际情况,可能更改功能设计、新增及取消功能。 - [ ] 重构底层插件机制。 - [ ] 在线 OCR API 插件。 - [ ] 独立的数学公式识别插件。 - [ ] “数学公式”标签页,提供独立的数学公式识别/Latex渲染。 - [ ] 检查更新机制。 - [ ] 排版解析之外的文本后处理模块(如保留数字、半全角字符转换、文本纠错)。 - [ ] 关键接口函数添加事件触发方式。 - 基于GPU的离线OCR。 - 图片翻译 - 离线翻译。 - 固定区域识别。 - 识别表格图片,输出为Excel。 - 历史记录系统。 - 兼容 MacOS / Ubuntu 等平台。