Go to file
2023-09-11 00:48:49 -04:00
.github add zip to win pkg 2023-08-15 23:22:32 +03:00
build-aux Initial commit 2023-08-10 22:05:20 +03:00
cmake add openblas 2023-09-11 00:48:49 -04:00
data attempt fix 2023-08-20 01:25:19 +03:00
src logging level 2023-09-08 11:15:54 -04:00
vendor initial 2023-08-12 23:51:51 +03:00
.clang-format subtitles source working 2023-08-13 15:41:23 +03:00
.cmake-format.json Initial commit 2023-08-10 22:05:20 +03:00
.gitignore dont fail on patch 2023-08-13 18:00:23 +03:00
.gitmodules initial 2023-08-12 23:51:51 +03:00
buildspec.json initial 2023-08-12 23:51:51 +03:00
CMakeLists.txt whisper universal 2023-08-13 23:53:25 +03:00
CMakePresets.json add model downloader 2023-08-13 17:55:04 +03:00
LICENSE Initial commit 2023-08-10 22:05:20 +03:00
patch_libobs.diff dont fail on patch 2023-08-13 18:00:23 +03:00
README.md readme 2023-08-14 10:21:43 +03:00

LocalVocal - AI assistant OBS Plugin

GitHub GitHub Workflow Status Total downloads GitHub release (latest by date)

Introduction

LocalVocal live-streaming AI assistant plugin allows you to transcribe, locally on your machine, audio speech into text and perform various language processing functions on the text using AI / LLMs (Large Language Models). No GPU required, no cloud costs, no network and no downtime! Privacy first - all data stays on your machine.

Current Features:

  • Transcribe audio to text in real time in 100 languages
  • Display captions on screen using text sources

Roadmap:

  • Remove unwanted words from the transcription
  • Translate captions in real time to 50 languages
  • Summarize the text and show "highlights" on screen
  • Detect key moments in the stream and allow triggering events (like replay)
  • Detect emotions/sentiment and allow triggering events (like changing the scene or colors etc.)

Internally the plugin is running a neural network (OpenAI Whisper) locally to predict in real time the speech and provide captions.

It's using the Whisper.cpp project from ggerganov to run the Whisper network in a very efficient way on CPUs and GPUs.

Check out our other plugins:

  • Background Removal removes background from webcam without a green screen.
  • 🚧 Experimental 🚧 CleanStream for real-time filler word (uh,um) and profanity removal from live audio stream
  • URL/API Source that allows fetching live data from an API and displaying it in OBS.

If you like this work, which is given to you completely free of charge, please consider supporting it on GitHub: https://github.com/sponsors/royshil

Download

Check out the latest releases for downloads and install instructions.

Building

The plugin was built and tested on Mac OSX (Intel & Apple silicon), Windows and Linux.

Start by cloning this repo to a directory of your choice.

Mac OSX

Using 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.

$ ./.github/scripts/build-macos -c Release

Install

The above script should succeed and the plugin files (e.g. obs-urlsource.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.

To get .pkg installer file, run for example

$ ./.github/scripts/package-macos -c Release

(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)

Linux (Ubuntu)

Use the CI scripts again

$ ./.github/scripts/build-linux.sh

Windows

Use the CI scripts again, for example:

> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022"

The build should exist in the ./release folder off the root. You can manually install the files in the OBS directory.