obsproject / obsproject/obs-studio

VST Settings are not preserved properly

Open
#8,120 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
76.4k
Forks
10.2k
Avg merge
4d 23h
Merged PRs (30d)
12

Description

Operating System Info

Windows 10

Other OS

No response

OBS Studio Version

29.0.0

OBS Studio Version (Other)

No response

OBS Studio Log URL

https://obsproject.com/logs/YYZDFex1Q3vJy7Dy

OBS Studio Crash Log URL

No response

Expected Behavior

When setting some values inside a vst plugin and closing OBS, the next time OBS is opened the vst plugin should be with the values last set.

Current Behavior

Everything works as expected until I make an update to my vst plugin.
If updated, the plugin won't restore the values last saved.

Steps to Reproduce
  1. Install Youlean Loudness Meter 2 VST plugin latest release version 2.4.3 (or any other plugin)
  2. Open the plugin in OBS and set some values
  3. Close OBS
  4. Install Youlean Loudness Meter 2 VST plugin from latest beta version 2.5.2
  5. Open OBS
  6. See that the setting you made last, were not preserved
    ...
Anything else we should know?

This is happening due the fact that you use MD5 in order to verify if the plugin should get it's chunk.
So for any plugin update, plugin's session information is lost. That is not how it should behave.
Proper way to do it in VST is to compare the uniqueID member of the AEffect instance.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating OBS Studio's VST state handling and the MD5 verification mentioned in the issue. Reproduce the settings loss by updating a VST plugin, then inspect how the plugin's uniqueID is available through AEffect. Done means settings remain preserved across compatible plugin updates, with the existing reproduction behavior verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
audio-video-rtc, desktop
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.