How to install on Ubuntu?

[thinkmassive]

I'm interested in trying this plugin on Ubuntu, but I haven't been able to get the Filters to appear.

Based on the readme updates in #76, here's what I tried so far...

Download the latest version of obs-virtualbg-X.X.X-Linux.deb. And run sudo dpkg -i obs-virtualbg-X.X.X-Linux.deb

There are no .deb packages in the github release page, so I built one from source.

First I cloned the git repo, and I modified install_pkgs_linux.sh slightly, since ubuntu:20.04 was missing some packages:

#!/bin/bash

export DEBIAN_FRONTEND=noninteractive
apt-get update
apt-get install -y software-properties-common curl git
add-apt-repository -y ppa:obsproject/obs-studio -y
apt-get update
apt-get install -y obs-studio
apt-get install -y python3-pip
pip3 install cmake

DEPS_DIR=$(cd $(dirname $0)/..;pwd)/deps
[ -d ${DEPS_DIR} ] || mkdir ${DEPS_DIR}

Then I ran a container to perform the build as closely as possible to the github workflow:

docker run --rm --name obs-build -it -v $(pwd):/obs ubuntu:20.04 /bin/bash

Inside the container:

cd /obs
scripts/install_pkgs_linux.sh
scripts/install_deps_linux.sh

# allow git to use the repo that's owned by my non-root user
git config --global --add safe.directory /obs

scripts/build_linux.sh

The build appears to complete successfully:

build output

root@6d04516ab4b9:/obs# scripts/build_linux.sh
++ dirname scripts/build_linux.sh
+ cd scripts/..                                  
++ pwd                                    
+ DEPS_DIR=/obs/deps 
+ mkdir -p build                                                                                                          
+ pushd build                                                                                                             
/obs/build /obs
+ cmake .. -DHalide_DIR=/obs/deps/Halide/lib/cmake/Halide -DHalideHelpers_DIR=/obs/deps/Halide/lib/cmake/HalideHelpers -DCMAKE_INSTALL_PREFIX=/usr -DOBS_PLUGIN_DESTINATION=/usr/lib/obs-plugins -DCMAKE_INSTALL_RPATH=/usr/lib/obs-virtualbg
OnnxRuntime_DEPS_DIR Found!!!!!! /obs/deps/onnxruntime /obs/deps/onnxruntime/lib/libonnxruntime.so;/obs/deps/onnxruntime/lib/libonnxruntime.so.1.10.0
-- Halide 'host' platform triple:   x86-64-linux
-- Halide 'cmake' platform triple:  x86-64-linux
-- Halide default AOT target:       host
-- Halide 'host' platform triple:   x86-64-linux
-- Halide 'cmake' platform triple:  x86-64-linux
-- Halide default AOT target:       host
-- Configuring done
-- Generating done
-- Build files have been written to: /obs/build
+ cmake --build . --config RelWithDebInfo
Consolidate compiler generated dependencies of target blur_generator
[  7%] Building CXX object CMakeFiles/blur_generator.dir/src/blur_gen.cpp.o
[ 15%] Building CXX object CMakeFiles/blur_generator.dir/deps/Halide/share/Halide/tools/GenGen.cpp.o
[ 23%] Linking CXX executable blur_generator
[ 23%] Built target blur_generator
[ 30%] Generating blur.runtime.o
[ 38%] Linking CXX static library libblur.runtime.a
[ 38%] Built target blur.runtime
[ 46%] Generating blur.h, blur.o, blur.schedule.h, blur.stmt.html
generate_schedule for target=x86-64-linux-avx-avx2-f16c-fma-no_runtime-sse41
Pass 0 of 5, cost: 0.00568104, time (ms): 97                                     
Pass 1 of 5, cost: 0.00545739, time (ms): 69                                     
Pass 2 of 5, cost: 0.00545739, time (ms): 61                                     
Pass 3 of 5, cost: 0.00556772, time (ms): 78                                     
Pass 4 of 5, cost: 0.00556772, time (ms): 84                                     
Best cost: 0.00545739
Cache (block) hits: 198
Cache (block) misses: 74
[ 46%] Built target blur.update
[ 53%] Linking CXX static library libblur.a
[ 61%] Built target blur
Consolidate compiler generated dependencies of target obs-virtualbg
[ 69%] Building CXX object CMakeFiles/obs-virtualbg.dir/src/plugin.cpp.o
[ 76%] Building CXX object CMakeFiles/obs-virtualbg.dir/src/obs-virtualbg-detector.cpp.o
/obs/src/obs-virtualbg-detector.cpp: In function ‘void detector_setup_preprocess_scaler(virtual_bg_filter_data*, obs_source_frame*)’:
/obs/src/obs-virtualbg-detector.cpp:301:90: warning: format ‘%d’ expects argument of type ‘int’, but argument 6 has type ‘int64_t’ {aka ‘long int’} [-Wformat=]
  301 |     blog(LOG_ERROR, "[Virtual BG detector] Can't create video_scaler_create %d %dx%d -> %dx%d", ret,
      |                                                                                         ~^
      |                                                                                          |
      |                                                                                          int
      |                                                                                         %ld
  302 |          filter_data->frame_width, filter_data->frame_height, filter_data->tensor_width,
      |                                                               ~~~~~~~~~~~~~~~~~~~~~~~~~   
      |                                                                            |
      |                                                                            int64_t {aka long int}
/obs/src/obs-virtualbg-detector.cpp:301:93: warning: format ‘%d’ expects argument of type ‘int’, but argument 7 has type ‘int64_t’ {aka ‘long int’} [-Wformat=]
  301 |     blog(LOG_ERROR, "[Virtual BG detector] Can't create video_scaler_create %d %dx%d -> %dx%d", ret,
      |                                                                                            ~^
      |                                                                                             |
      |                                                                                             int
      |                                                                                            %ld
  302 |          filter_data->frame_width, filter_data->frame_height, filter_data->tensor_width,
  303 |          filter_data->tensor_height);
      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~                                                          
      |                       |
      |                       int64_t {aka long int}
/obs/src/obs-virtualbg-detector.cpp:306:82: warning: format ‘%d’ expects argument of type ‘int’, but argument 5 has type ‘int64_t’ {aka ‘long int’} [-Wformat=]
  306 |     blog(LOG_INFO, "[Virtual BG detector] video_scaler_create success. %dx%d -> %dx%d",
      |                                                                                 ~^
      |                                                                                  |
      |                                                                                  int
      |                                                                                 %ld
  307 |          filter_data->frame_width, filter_data->frame_height, filter_data->tensor_width,
      |                                                               ~~~~~~~~~~~~~~~~~~~~~~~~~
      |                                                                            |
      |                                                                            int64_t {aka long int}
/obs/src/obs-virtualbg-detector.cpp:306:85: warning: format ‘%d’ expects argument of type ‘int’, but argument 6 has type ‘int64_t’ {aka ‘long int’} [-Wformat=]
  306 |     blog(LOG_INFO, "[Virtual BG detector] video_scaler_create success. %dx%d -> %dx%d",
      |                                                                                    ~^
      |                                                                                     |
      |                                                                                     int
      |                                                                                    %ld
  307 |          filter_data->frame_width, filter_data->frame_height, filter_data->tensor_width,
  308 |          filter_data->tensor_height);
      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~                                                  
      |                       |
      |                       int64_t {aka long int}
[ 84%] Building CXX object CMakeFiles/obs-virtualbg.dir/src/obs-virtualbg-render.cpp.o
[ 92%] Building CXX object CMakeFiles/obs-virtualbg.dir/deps/Halide/share/Halide/tools/RunGenMain.cpp.o
[100%] Linking CXX shared module obs-virtualbg.so
[100%] Built target obs-virtualbg
+ cpack
CPack: Create package using DEB
CPack: Install projects
CPack: - Run preinstall target for: obs-virtualbg
CPack: - Install project: obs-virtualbg []
CPack: Create package
-- CPACK_DEBIAN_PACKAGE_DEPENDS not set, the package will have no dependencies.
CPack: - package: /obs/build/obs-virtualbg-1.1.0-Linux.deb generated.
+ popd
/obs

Now I install the package:

sudo dpkg -i build/obs-virtualbg-1.1.0-Linux.deb

Comparing my filesystem with the contents of build/install_manifest.txt everything seems to be in place.

$ cat build/install_manifest.txt | xargs ls -l ;
lrwxrwxrwx 1 root root       24 May 20 14:06 /usr/lib/obs-plugins/../obs-virtualbg/libonnxruntime.so -> libonnxruntime.so.1.10.0
-rw-r--r-- 1 root root 14320080 Dec  6 20:14 /usr/lib/obs-plugins/../obs-virtualbg/libonnxruntime.so.1.10.0
-rw-r--r-- 1 root root  2277928 May 20 14:06 /usr/lib/obs-plugins/obs-virtualbg.so
-rw-r--r-- 1 root root      360 May 20 11:57 /usr/share/obs/obs-plugins/obs-virtualbg/locale/en-US.ini
-rw-r--r-- 1 root root      342 May 20 11:57 /usr/share/obs/obs-plugins/obs-virtualbg/locale/ja-JP.ini
-rw-r--r-- 1 root root   453843 May 20 11:57 /usr/share/obs/obs-plugins/obs-virtualbg/model.onnx
-rw-r--r-- 1 root root      629 May 20 11:57 /usr/share/obs/obs-plugins/obs-virtualbg/virtualbg-mask.effect
-rw-r--r-- 1 root root      710 May 20 11:57 /usr/share/obs/obs-plugins/obs-virtualbg/virtualbg.effect

When I launch OBS Studio and open Filters for my camera, I see the defaults and the StreamFX ones that I added in ~/.config/obs-studio/plugins/StreamFX (so I know plugins are working in general), but neither of the Virtual Background filters appear.

Based on this line, I wonder if I'm missing a dependency?

CPACK_DEBIAN_PACKAGE_DEPENDS not set, the package will have no dependencies

Here are my software versions:

• Ubuntu 21.10
• OBS Studio 27.0.1+dfsg1-1 (installed via apt from the Ubuntu repo)
• obs-virtualbg branch: main
• CPU/video: AMD Ryzen 7 PRO 5850U with Radeon Grphics

When I launch obs from the console I notice the following potential issues:

warning: Failed to load 'en-US' text for module: 'decklink-captions.so'
warning: Failed to load 'en-US' text for module: 'decklink-ouput-ui.so'
libDeckLinkAPI.so: cannot open shared object file: No such file or directory                                  
warning: A DeckLink iterator could not be created.  The DeckLink drivers may not be installed
info: No blackmagic support                                  
error: os_dlopen(libnvidia-encode.so.1->libnvidia-encode.so.1): libnvidia-encode.so.1: cannot open shared object file: No such file or directory

I assume @kounoike has this working, at least on Ubuntu 20.04, so I must have missed a step or part of my setup is incompatible. Since the readme mentioned "default inference engine is CPU" I figured it should work (possible w/poor performance), but the missing libnvidia-encode.so.1 has me wondering if this plugin requires an nvidia gpu. Please let me know anything else I can do to assist with testing Linux compatibility of this plugin.

[kounoike]

It's not merged PR, and not released now. Please don't ask questions about something that has not been released.
But, if you got more efficient way to build script, PRs are welcome.

[thinkmassive]

I’m not expecting free technical support or anything, only trying to figure out how to use the Linux build produced by the GitHub workflow that was merged a month ago. As I said, I’m glad to assist with improving Linux compatibility. I thought this was the purpose of having Discussions on a repo in GitHub, this isn’t a bug report or issue.

If someone has this OBS plugin working in Linux, it would be great to get any more details you can provide that might differ from my own setup described in OP. I’m glad to invest time getting it working, just wondering if I should start with another OS version, an nvidia card, building some dependencies differently, etc.

[Canuckfanatic80]

Yes I'ts not working on linux mint here.

I'm using:

Kernel: 5.15.0-126-generic x86_64 bits: 64 compiler: gcc v: 11.4.0 Desktop: MATE 1.26.0
info: mate-panel wm: marco 1.26.0 vt: 7 dm: LightDM 1.30.0 Distro: Linux Mint 21.1 Vera
base: Ubuntu 22.04 jammy