{"id":19325207,"url":"https://github.com/locaal-ai/obs-ocr","last_synced_at":"2025-02-24T06:16:46.612Z","repository":{"id":215659505,"uuid":"739450181","full_name":"locaal-ai/obs-ocr","owner":"locaal-ai","description":"OCR Plugin for OBS based on Tesseract","archived":false,"fork":false,"pushed_at":"2024-12-19T16:29:34.000Z","size":20370,"stargazers_count":68,"open_issues_count":11,"forks_count":10,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T06:26:32.936Z","etag":null,"topics":["obs-plugin","obs-studio","obs-studio-plugin","ocr","optical-character-recognition","realtime-ocr","tesseract-ocr"],"latest_commit_sha":null,"homepage":"https://obsproject.com/forum/resources/ocr-text-recognition-detection-built-in-obs.1866/","language":"CMake","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/locaal-ai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-05T15:42:10.000Z","updated_at":"2025-02-22T16:49:02.000Z","dependencies_parsed_at":"2024-02-04T22:25:44.328Z","dependency_job_id":"205cfc79-48d4-4c00-8ee7-330a15f9c439","html_url":"https://github.com/locaal-ai/obs-ocr","commit_stats":{"total_commits":42,"total_committers":2,"mean_commits":21.0,"dds":0.2142857142857143,"last_synced_commit":"395d7d2a35141a5e4afb0b8db504f052f48a9c50"},"previous_names":["occ-ai/obs-ocr","locaal-ai/obs-ocr"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locaal-ai%2Fobs-ocr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locaal-ai%2Fobs-ocr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locaal-ai%2Fobs-ocr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locaal-ai%2Fobs-ocr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/locaal-ai","download_url":"https://codeload.github.com/locaal-ai/obs-ocr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240427327,"owners_count":19799471,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["obs-plugin","obs-studio","obs-studio-plugin","ocr","optical-character-recognition","realtime-ocr","tesseract-ocr"],"created_at":"2024-11-10T02:09:15.776Z","updated_at":"2025-02-24T06:16:46.552Z","avatar_url":"https://github.com/locaal-ai.png","language":"CMake","funding_links":["https://github.com/sponsors/royshil","https://www.patreon.com/RoyShilkrot"],"categories":[],"sub_categories":[],"readme":"# ⚠️ Stalled ⚠️ This project is not under active development\n\n## OCR - OBS Plugin\n\n\u003cdiv align=\"center\"\u003e\n\n[![GitHub](https://img.shields.io/github/license/occ-ai/obs-ocr)](https://github.com/occ-ai/obs-ocr/blob/main/LICENSE)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/occ-ai/obs-ocr/push.yaml)](https://github.com/occ-ai/obs-ocr/actions/workflows/push.yaml)\n[![Total downloads](https://img.shields.io/github/downloads/occ-ai/obs-ocr/total)](https://github.com/occ-ai/obs-ocr/releases)\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/occ-ai/obs-ocr)](https://github.com/occ-ai/obs-ocr/releases)\n[![Discord](https://img.shields.io/discord/1200229425141252116)](https://discord.gg/KbjGU2vvUz)\n\n\u003c/div\u003e\n\n## Introduction\n\nThe OCR Plugin for OBS provides real-time Optical Characted Recognition (OCR) or Text Recognition abilities over any OBS Source that provides an image - can be Image, Video, Browser or any other Source.\nIt is based on the incredible [Tesseract](https://github.com/tesseract-ocr/tesseract) open source OCR engine, compiled and running directly inside OBS for real-time operation on every frame rendered.\n\n### Usage Tutorials\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://youtu.be/Lnty2vuVr4I\" target=\"_blank\"\u003e\n    \u003cimg width=\"45%\" src=\"https://github-production-user-asset-6210df.s3.amazonaws.com/441170/297753085-277bc972-a878-47a6-957f-da99d7a8d6d4.jpeg\" /\u003e\n  \u003c/a\u003e\n  \u003cbr/\u003e\n  4 Minutes\n\u003c/div\u003e\n\n#### Do more with OCR Plugin\nOCR Plugin enables many use cases for enhancing your stream or recording:\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://youtu.be/vVclLhFpBc8\" target=\"_blank\"\u003e\n    \u003cimg width=\"27%\" src=\"https://github.com/occ-ai/obs-ocr/assets/441170/91febd15-a155-43fb-9b24-b1da99ad8c38\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://youtu.be/hQSCJaUgwhs\" target=\"_blank\"\u003e\n    \u003cimg width=\"27%\" src=\"https://github.com/occ-ai/obs-ocr/assets/441170/33bf35b3-0b98-4920-920b-9694beefd822\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\n### Features\nAvailable now:\n - Add OCR Filter to any source with image or video output\n - Choose from Scoreboard model or English, French, Spanish, German, Chinese, Japanese, Arabic, Turkish, Portugese, Hindi, Russian and Italian\n - Choose the segmentation mode: Word, Line, Page, etc.\n - \"Semantic Smoothing\": getting more consistent outputs with higher accuracy and confidence by \"averaging\" several text outputs\n - Timing/Running modes: per X-milliseconds\n - Output OCR result to an OBS Text Source\n - Output to a text file (with/out aggregation)\n - Output formatting (with inja): e.g. \"Score: {{score}}\"\n - Output text detection to image source (draws boxes, text, etc.)\n - Output to settings (e.g. for other plugins to use as triggers)\n - Binarization methods (threshold, Otsu, Triangle, adaptive)\n - Image Dilation\n - Rescale (optimal Tesseract performance is at 35 pixels / character)\n\nComing soon:\n - More languages built-in (pretrained Tesseract models)\n - Allowing external model files\n - More output capabilities e.g. Parsing, websocket event, etc.\n - Detection area selection (to prevent using Crop/Pad Filter)\n - Different timing/run modes: per X-frames, image change, etc.\n - Image stabilization\n - Optical flow tracking for fast moving text\n - Image processing: Perspective warping, auto-cropping, etc.\n - Advanced binarization: Niblack, Sauvola\n\nCheck out our other plugins:\n- [Background Removal](https://github.com/occ-ai/obs-backgroundremoval) removes background from webcam without a green screen.\n- [Detect](https://github.com/occ-ai/obs-detect) will detect and track \u003e80 types of objects in any OBS source.\n- [LocalVocal](https://github.com/occ-ai/obs-localvocal) speech AI assistant plugin for real-time, local transcription (captions), translation and more language functions\n- [Polyglot](https://github.com/occ-ai/obs-polyglot) translation AI plugin for real-time, local translation to hunderds of languages\n- [URL/API Source](https://github.com/occ-ai/obs-urlsource) will connect to any URL/API HTTP and get the data/image/audio to your scene.\n- 🚧 Experimental 🚧 [CleanStream](https://github.com/occ-ai/obs-cleanstream) for real-time filler word (uh,um) and profanity removal from live audio stream\n\nIf you like this work, which is given to you completely free of charge, please consider supporting it https://github.com/sponsors/royshil or https://www.patreon.com/RoyShilkrot\n\n## Download\nCheck out the [latest releases](https://github.com/occ-ai/obs-ocr/releases) for downloads and install instructions.\n\n\n## Building\n\nThe plugin was built and tested on Mac OSX  (Intel \u0026 Apple silicon), Windows and Linux.\n\nStart by cloning this repo to a directory of your choice.\n\n### Mac OSX\n\nUsing the CI pipeline scripts, locally you would just call the zsh script. By default this builds a universal binary for both Intel and Apple Silicon. To build for a specific architecture please see `.github/scripts/.build.zsh` for the `-arch` options.\n\n```sh\n$ ./.github/scripts/build-macos -c Release\n```\n\n#### Install\nThe above script should succeed and the plugin files (e.g. `obs-ocr.plugin`) will reside in the `./release/Release` folder off of the root. Copy the `.plugin` file to the OBS directory e.g. `~/Library/Application Support/obs-studio/plugins`.\n\nTo get `.pkg` installer file, run for example\n```sh\n$ ./.github/scripts/package-macos -c Release\n```\n(Note that maybe the outputs will be in the `Release` folder and not the `install` folder like `pakage-macos` expects, so you will need to rename the folder from `build_x86_64/Release` to `build_x86_64/install`)\n\n### Linux (Ubuntu)\n\nUse the CI scripts again\n```sh\n$ ./.github/scripts/build-linux.sh\n```\n\nCopy the results to the standard OBS folders on Ubuntu\n```sh\n$ sudo cp -R release/RelWithDebInfo/lib/* /usr/lib/x86_64-linux-gnu/\n$ sudo cp -R release/RelWithDebInfo/share/* /usr/share/\n```\nNote: The official [OBS plugins guide](https://obsproject.com/kb/plugins-guide) recommends adding plugins to the `~/.config/obs-studio/plugins` folder.\n\n### Windows\n\nUse the CI scripts again, for example:\n\n```powershell\n\u003e .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator \"Visual Studio 17 2022\"\n```\n\nThe build should exist in the `./release` folder off the root. You can manually install the files in the OBS directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocaal-ai%2Fobs-ocr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocaal-ai%2Fobs-ocr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocaal-ai%2Fobs-ocr/lists"}