https://github.com/norihiro/obs-virtualbg

An OBS plugin for Zoom/Meet-like virtual background feature.
https://github.com/norihiro/obs-virtualbg

Last synced: 8 days ago
JSON representation

An OBS plugin for Zoom/Meet-like virtual background feature.

• Host: GitHub
• URL: https://github.com/norihiro/obs-virtualbg
• Owner: norihiro
• License: mit
• Fork: true (kounoike/obs-virtualbg)
• Created: 2022-01-09T13:30:22.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-05T01:24:30.000Z (about 1 year ago)
• Last Synced: 2024-04-14T04:20:59.224Z (7 months ago)
• Language: C++
• Homepage:
• Size: 5.83 MB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OBS Virtual background plugin

English / [Japanese](./README_ja.md)

**OBS Virtual background plugin** is a plugin for OBS. This plugin allows you to crop the background area without a green screen like Zoom and Meet virtual backgrounds.

## Supported Operating System

Currently, this plugin supports only Windows 64bit environment.

## Install

Download the latest version of obs-virtualbg-vX.X.X-win64.zip from Releases on the right side of the [GitHub Page](https://github.com/kounoike/obs-virtualbg).

Extract the zip and copy the `data` and `obs-plugins` folders to your OBS Studio Folder (`C:\Program Files\obs-studio` by default).

Note: If you have the **OBS Background removal plugin** installed, uninstall it first, because the ONNXRuntime DLL will conflict.

## Usage

### filter settings

Add **Media source** or **Video capture device** to scene, and open Filters.

![](doc/scene_en.png)

![](doc/filter_en.png)

Add **Virtual Background Detector** to Audio/Video Filters. and also add **Virtual Background Renderer** to Effect Filters. **Both** filters required.

![](doc/filter_2_en.png)

Since v1.2.0, default inference engine is changed. Now, default inference engine is CPU. But, it is low accuracy, heavy to compute. If you can use GPU, changing to GPU is better. But some case, GPU engine is crashed at initialize phase.

### Background settings

Place a background image, window capture, or game capture source below the filtered source. Set the size, crop, etc. to complete the settings.

![](doc/scene_2_en.png)

## Caution

Since the human region is detected by inference using a deep learning model, detection error inevitably occur. In some cases, the person's area is not detected and is transparent, and in other cases, the background area is mis-detected and some of the room is shown. In particular, it is not good at recognizing hands, so it may not be suitable for performance. This is a limitation of the detection model and is not something that can be adjusted by adjusting parameters. If you need accurate cropping, please use the green background and chroma key filters.