StreamFX 0.12.0 Beta 164

[Xaymar]

⚠ Preview Release not for Production! ⚠

This release is meant for testing in isolated conditions and early adopters only, and should never be used in production. If you use one of these releases, all promises of support, warranty, functionality, and similar are immediately void and if things break you are on your own. The latest production ready release can be found here.

Please read the Installation Guide and System Requirements!

The installation of StreamFX requires that you follow certain instructions, as well as fulfill a minimum hardware and software requirement. Please ensure that you have read and verified both before asking for help, as many issues can be fixed by reading both of them in their entirety.

Support StreamFX on Github Sponsors or Patreon!

The StreamFX project is only possible through your support, either as a translator or as a Supporter on either Patreon or Github. Your support helps keep StreamFX free from Ads, even if it's just translating a few lines per month, or 1$ per month. If continuous support isn't your thing, maybe a one-time donation via PayPal is?

System Requirements

		Windows	Linux	MacOS
OS	Minimum	Windows 10 21H2 (or newer)	Ubuntu 20.04 (or equivalent) Ubuntu 22.04 (or equivalent)	MacOS 10.15 (or newer)
	Recommended	Windows 10 21H2 (or newer)	Ubuntu 20.04 (or equivalent) Ubuntu 22.04 (or equivalent)	MacOS 12 (or newer)
CPU	Minimum	Any x86-64-v3 compatible: AMD Excavator Series, Intel Haswell Series Required Instruction Sets: x86-64-v2, AVX, BMI1, BMI2, F16C, FMA, MOVBE
				Any ARM64-v8.5-A compatible: Apple M1 Series
	Recommended	Any x86-64-v3 compatible: AMD Zen 2 Series, Intel Comet Lake Series Required Instruction Sets: x86-64-v2, AVX, BMI1, BMI2, F16C, FMA, MOVBE
				Any ARM64-v8.5-A compatible: Apple M1 Series
Memory (RAM)	Minimum	4 GiB (free)
	Recommended	8 GiB (free)	6 GiB (free)
Video (GPU)	Minimum	DirectX 11 / OpenGL 3 capable, Shader Model 4, 4 GiB VRAM (total)
	Recommended	DirectX 12 / OpenGL 4 capable, Shader Model 5, 6 GiB VRAM (total)
Disk Space	Minimum	~50 MiB (free)
	Recommended	~50 MiB (free)
OBS Version	Minimum	29.0.0-beta2
	Recommended	29.0.0
Other		Microsoft Visual C/C++ Redistributable 2017-2022	Qt for obs-studio FFmpeg for obs-studio System Libraries must match chosen Ubuntu version!

What's Changed

New Release process: Alpha -> Beta -> Candidate -> Release!

The old two stage system didn't work out quite as I'd have hoped: It didn't communicate the dangers of Testing well, and did not differentiate between different stability levels. To solve this I've adopted a new release process now available in StreamFX, which follows the usual development cycle of Software itself: Alpha -> Beta -> Candidate -> Release. The further right you go in that graph, the more stable software is supposed to be, at the cost of new features and changes. The further left you go, the more up-to-date things will be, but you sacrifice stability and safety.

🔧 Fixes

Shader Texture Inputs no longer corrupt Scene Collections

For quite some time, Shader Texture Inputs were haunted by ghosts from the past, also known as work-arounds and deprecated code. This resulted in Shader Texture Inputs keeping stale references around and requiring an OBS Studio restart to actually update. Several code modernization cycles later, this is now fixed and Shader Texture Inputs immediately update as expected - while also no longer keeping stale references around, so your Scene Collections are safe again.

Dynamic Mask no longer self-references and double-frees its Input mask

This should have gone up in flames way sooner than it did, and yet it was almost completely invisible until OBS Studio 27.1. The bug dates as far back as v0.7 and is pretty severe: The Dynamic Mask filter would increment their own reference count every frame if no Input was selected, and would double-free the Input without clearing the pointer to it. And somehow, this didn't explode until now.

➕ Additions & improvements

Loadable Bundles on MacOS

With OBS Studio 28.0 came the introduction of Loadable Bundles, a variation of MacOS's Bundle format. This format offers a lot of advantages for almost no drawbacks, and StreamFX from now on uses this packaging format on MacOS. As a bonus, FFmpeg Encoders should now be available on MacOS too.

⚠ This change requires that you cleanly remove old versions of StreamFX first!

As the packaging and installation method has changed, please follow the Uninstallation guide to clean up any left over old files. Failure to do so will result in undefined behavior and may render OBS Studio entirely unusable. You have been warned!

Improved System-wide installation on Windows

Investigation into how OBS Studio actually loads plugins revealed a change that had gone under the radar entirely. Since OBS Studio v0.15.0 it is possible to load plugins from %ProgramData%\obs-studio\plugins, which is a much safer option and now the only supported System-wide installation mode for StreamFX. This functionality has been so hidden that even the official obs-plugintemplate doesn't make use of it. An added bonus is that this should support Steam users of OBS Studio.

User-only installation on Windows

StreamFX can now be installed for individual users, instead of installing for everyone on the system! This is possible thanks to a PR by @abcdw, which allows us to set two environment variable to install and load plugins from %LocalAppData%\Programs\obs-studio\plugins in addition to all the other locations. These installations will conflict with a System-wide install and as such can't coexist, but may still work with the Steam release of OBS Studio.

Avid DNxHR Encoder (via FFmpeg) by @IceStormNG

A new contender for the visually lossless intermediate codec arrives: Avid DNxHR! Thanks to work done by @IceStormNG, it is now possible to use this encoder without configuration trickery and directly configure it with a proper user interface. As this encoder is based on the real codec specification, it may perform better than the Apple ProRes encoder while being way more compatible with video editing software.

Split Framerate support for FFmpeg Encoders

All FFmpeg Encoders now support encoding a different framerate than OBS Studio itself is running at. This allows for streaming at 30 FPS while recording at 60 FPS, or even recording at 120 FPS, or other strange things. Note that this is quite literally breaking several specifications, so use at your own risk - if things break, be happy that at least they broke with a noticable impact!

Universal Binaries for x86 & ARM64 support on MacOS

Users on ARM64 devices can now enjoy native ARM64 binaries for less CPU usage, and as such more overall performance on CPU focused tasks. While StreamFX is mostly GPU workloads, some of the internal code does actually do very heavy lifting that benefits from this.

Initial sRGB and HDR support for Sources/Filters/Transitions

With HDR support in OBS Studio finally being available, it was necessary to finally tackle the issue of sRGB and HDR support once and for all. Many Sources/Filters/Transitions will get proper sRGB and HDR support over future releases to catch up with OBS Studio. You can check the Version Information on the wiki to see if a certain feature supports sRGB or HDR yet.

➖ Deprecations & Removals

Deprecation of the AMD AMF (via FFmpeg) encoders

With OBS Studio 28.0 the old obs-amd-encoder project is finally laid to rest and a new AMD AMF integration is provided. This AMD AMF integration is technically and functionally superior to both the old obs-amd-encoder and FFmpegs AMD AMF integration. All users are urged to migrate as soon as possible, as no guarantees are made for how long this deprecated encoder will remain. Additionally, users on Linux should put their focus on the open Pull Requests for Linux support (1, 2).

Deprecation of the AV1 (via AOM) Encoder

With OBS Studio 27.2.4, the SVT-AV1 and AOM-AV1 encoders were integrated into OBS Studio directly. This integration is functionally identical, and as such replaces the StreamFX provided AOM-AV1 encoder. All users are urged to migrate as soon as possible, as no guaratees are made for how long this deprecated encoder will remain.

Detailed Changelog

0.12.0b164

• plugin: Only initialize GLAD on OpenGL graphics backend by @Xaymar in plugin: Only initialize GLAD on OpenGL graphics backend #983
• project: Improve templates and UX by @Xaymar in project: Improve templates and UX #984
• Code Cleanup by @Xaymar in Code Cleanup #985
• gfx/blur/box: Initialize streamfx::gfx::util by @Xaymar in gfx/blur/box: Initialize streamfx::gfx::util #986
• Blur with a "Source" Mask performs double addref #818 Don't self-reference when masking is enabled by @Xaymar in #818 Don't self-reference when masking is enabled #987
• New Crowdin updates by @Xaymar in New Crowdin updates #959
• Fix CI and update Third Party code by @Xaymar in Fix CI and update Third Party code #988

0.12.0a151

• Implement dynamically scaled Thread Pool by @Xaymar in Implement dynamically scaled Thread Pool #933
• Save configuration after ~100ms have passed by @Xaymar in Save configuration after ~100ms have passed #934
• templates/windows/installer: Don't create Icons in Portable mode by @Xaymar in templates/windows/installer: Don't create Icons in Portable mode #936
• templates/windows/installer: Implement /Portable installer flag for CLI users by @Xaymar in templates/windows/installer: Implement /Portable installer flag for CLI users #935
• cmake, templates: Remove code signing integration by @Xaymar in cmake, templates: Remove code signing integration #938
• Don't show path selection for System & User mode by @Xaymar in Don't show path selection for System & User mode #937
• Fix some Use-After-Free issues with the D3D11 integration with FFmpeg by @Xaymar in Fix some Use-After-Free issues with the D3D11 integration with FFmpeg #953
• encoder/ffmpeg: Remove usage of avcodec_close by @Xaymar in encoder/ffmpeg: Remove usage of avcodec_close #952
• New Crowdin updates by @Xaymar in New Crowdin updates #932
• Implement support for Color Spaces by @Xaymar in Implement support for Color Spaces #968
• Dynamic Mask: Implement sRGB and HDR support, and fix Dynamic Mask causes double free crash #819 by @Xaymar in Dynamic Mask: Implement sRGB and HDR support, and fix #819 #967

0.12.0a134

• cmake: Require nlohmann-json when building the front-end by @rmnvgr in cmake: Require nlohmann-json when building the front-end #914
• encoder/ffmpeg: Assume extra data and sei are present on first frame by @Xaymar in encoder/ffmpeg: Assume extra data and sei are present on first frame #919
• encoder/ffmpeg: Add split framerate with integer fractions by @Xaymar in encoder/ffmpeg: Add split framerate with integer fractions #921
• encoder/ffmpeg: Improve software scaling quality by @Xaymar in encoder/ffmpeg: Improve software scaling quality #925
• Add support for HDR formats by @Xaymar in Add support for HDR formats #922
• encoder/handler/prores_aw: Don't enable Key-Frame options by @Xaymar in encoder/handler/prores_aw: Don't enable Key-Frame options #926
• encoder/handler/dnxhd: Use endian-independent formats by @Xaymar in encoder/handler/dnxhd: Use endian-independent formats #927
• New Crowdin updates by @Xaymar in New Crowdin updates #915
• Improve Windows installer with proper System install location, Current User install method, and better UI by @Xaymar in Improve Windows installer with proper System install location, Current User install method, and better UI #930
• New Crowdin updates by @Xaymar in New Crowdin updates #928

0.12.0a117

• New Crowdin updates by @Xaymar in New Crowdin updates #907
• Improve Windows and Mac bundling by @Xaymar in Improve Windows and Mac bundling #912

0.12.0a106

• Shader: Texture Inputs cause crashes/freezes #881: Texture inputs to Shaders are unstable by @Xaymar in #881: Texture inputs to Shaders are unstable #884
• Deprecate AMD AMF encoders by @Xaymar in Deprecate AMD AMF encoders #885
• Deprecate AOM AV1 encoder by @Xaymar in Deprecate AOM AV1 encoder #886
• Add missing deprecation notices by @Xaymar in Add missing deprecation notices #889
• New Crowdin updates by @Xaymar in New Crowdin updates #867
• cmake: Fix bad version strings by @Xaymar in cmake: Fix bad version strings #887
• project: Updating contributing guidelines by @Xaymar in project: Updating contributing guidelines #894
• New Crowdin updates by @Xaymar in New Crowdin updates #890
• project: Updating contributing guidelines by @Xaymar in project: Updating contributing guidelines #895
• Fix a huge number of warnings by @Xaymar in Fix a huge number of warnings #893
• third-party: Update obs-studio to 28.0.0 by @Xaymar in third-party: Update obs-studio to 28.0.0 #901
• code: Fix GCC warning diagnostic pragmas by @Xaymar in code: Fix GCC warning diagnostic pragmas #902
• New Crowdin updates by @Xaymar in New Crowdin updates #897

0.12.0a77

• New Crowdin updates by @Xaymar in New Crowdin updates #817
• Improve GitHub integration by @Xaymar in Improve GitHub integration #841
• project: Fix incorrect tabs in YAML by @Xaymar in project: Fix incorrect tabs in YAML #842
• Improve metadata generation by @Xaymar in Improve metadata generation  #837
• cmake: Add support for Qt6 by @Xaymar in cmake: Add support for Qt6 #866
• New Crowdin updates by @Xaymar in New Crowdin updates #832
• Further improve CI and Github integration by @Xaymar in Further improve CI and Github integration #843
• ci: Remove Code Signing with self-signed certificate by @Xaymar in ci: Remove Code Signing with self-signed certificate #873
• Fix compilation errors with Debug and/or Profiling by @Xaymar in Fix compilation errors with Debug and/or Profiling #876
• Deduplicate CI build pipeline by @Xaymar in Deduplicate CI build pipeline #874
• Remove Auto-Dependency System by @Xaymar in Remove Auto-Dependency System #870
• Working on source code [Refactor] by @GermanAizek in Working on source code [Refactor] #836
• obs/gs/effect: Revert Working on source code [Refactor] #836 by @Xaymar in obs/gs/effect: Revert #836 #880
• Update libOBS to 28.0.0-rc1 by @Xaymar in Update libOBS to 28.0.0-rc1 #878

0.12.0a45

• Improve CMake build script(s) by @Xaymar in Improve CMake build script(s) #813
• ci: Add GCC back to the build by @Xaymar in ci: Add GCC back to the build #820
• Add ClangCL, and update Windows SDK requirements by @Xaymar in Add ClangCL, and update Windows SDK requirements #821
• ci: Allow failures for experimental CI tests by @Xaymar in ci: Allow failures for experimental CI tests #824
• ci: Use specific LLVM/Clang versions by @Xaymar in ci: Use specific LLVM/Clang versions #825
• project: Add support for multi stage release cycles by @Xaymar in project: Add support for multi stage release cycles #823

0.12.0a1

• New Crowdin updates by @Xaymar in New Crowdin updates #778
• ffmpeg-encoder/dnxhr: Added Avid DNxHR Encoder based on FFmpeg by @IceStormNG in ffmpeg-encoder/dnxhr: Added Avid DNxHR Encoder based on FFmpeg #784
• New Crowdin updates by @Xaymar in New Crowdin updates #786
• Refactor C++ wrappers for libOBS by @Xaymar in Refactor C++ wrappers for libOBS #806

---

This discussion was created from the release StreamFX 0.12.0 Beta 164.

[DaeTheDragon]

Building from Source is an option if your System does not meet the requirements set in the Release Notes. Note that self-built binaries recieve no support at all, even for bugs reproducible in a released version.

I see
Is there any reason why StreamFX specifically no longer supports the Xeon E5-1620 v2 when other intel processors also released in 2013 are?
I have never had a problem like this with any other programs I've used - even other rendering programs like face tracking software & any modern games - let alone a plugin for a program that works perfectly fine otherwise.
I'm just curious if there is a possibility to return support for sandy bridge CPUs in the future for non-alpha releases without building from source?

EDIT:
Apologies if my tone sounded combative, that was not my intention!

[Xaymar]

This was discussed quite extensively on Discord, but TL;DR: Open Source hobby project primarily made for me, then friends. There are no plans to downgrade from x86-64-v3 to x86-64-v2 or less. If someone doesn't like it, either pay up, or submit a PR, or fork the project.

[chillinwithdev]

I'm sure there are a tone of people saying the same thing, but the most recent OBS update 28.1.2 caused my StreamFX to no longer work. When I launch OBS I get the "broken plug-in" warning for StreamFX, and sadly a lot of my OBS scenes relied heavily on the features of StreamFX. Do we have an ETA on when this plug-in will be up and running again? It's been such an amazing tool and not having any updates or info is a bit disappointing. Obviously, I don't know the struggles and tolls involved in creating a plug-in like this, but I hope it gets fixed soon...

[Xaymar]

When it is done. If that's not to your liking, you can send in a comission.

[andlaw]

the most hated question from Devs.. ETA! a lot of us are and have been waiting, and if you've been watching since OBS 28.. you will have noticed there have been a lot of updates. the release process is also posted above, Alpha -> Beta -> Candidate -> Release! it's in the beta stage... soon! >:)

[eeproduktionen]

Workes great for me with OBS 29. My main effect is “blur” - no issues here.