OBS Studio <https://obsproject.com>

What is OBS Studio?

OBS Studio is software designed for capturing, compositing, encoding, recording, and streaming video content, efficiently.

It's distributed under the GNU General Public License v2 (or any later version) - see the accompanying COPYING file for more details.

Quick Links

• Website: https://obsproject.com
• Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
• Forums: https://obsproject.com/forum/
• Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
• Developer/API Documentation: https://obsproject.com/docs
• Donating/backing/sponsoring: https://obsproject.com/contribute
• Bug Tracker: https://github.com/obsproject/obs-studio/issues

Native Tests

Native tests run through CTest, with Catch2 v3.11.0 matching OSN. The normal OBS build dependencies are required; CMake downloads Catch2 on the first configure unless it is already cached.

Run the following commands from the repository root on Windows to configure, build, and run all native tests:

cmake --preset windows-ci-x64
cmake --build build_x64 --config RelWithDebInfo --target tests
ctest --test-dir build_x64 -C RelWithDebInfo --output-on-failure --no-tests=error

On macOS:

cmake --preset macos-ci
cmake --build build_macos --config RelWithDebInfo --target tests
ctest --test-dir build_macos -C RelWithDebInfo --output-on-failure --no-tests=error

The windows-ci-x64 and macos-ci presets enable BUILD_TESTING. It defaults to OFF for other presets; pass -DBUILD_TESTING=ON when configuring to enable it explicitly. CTest does not build tests, so repeat the build step after code changes. Test executables and Catch2 are excluded from installed product packages.

See test/libobs/README.md for details about the suite and adding cases.

Contributing

• If you would like to help fund or sponsor the project, you can do so via Patreon, OpenCollective, or PayPal. See our contribute page for more information.
• If you wish to contribute code to the project, please make sure to read the coding and commit guidelines: https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
• Developer/API documentation can be found here: https://obsproject.com/docs
• If you wish to contribute translations, do not submit pull requests. Instead, please use Crowdin. For more information read this page: https://obsproject.com/wiki/How-To-Contribute-Translations-For-OBS
• Contributors to OBS Studio and related repositories are expected to follow our Code of Conduct, which can be read here: https://github.com/obsproject/obs-studio/blob/master/COC.rst
• Other ways to contribute are by helping people out with support on our forums or in our community chat. Please limit support to topics you fully understand -- bad advice is worse than no advice. When it comes to something that you don't fully know or understand, please defer to the official help or official channels.

SAST Tools

PVS-Studio - static analyzer for C, C++, C#, and Java code.