Skip to content

[osn-filter] Remove obsolete/deprecated/disabled filters #1743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sandboxcoder wants to merge 2 commits into from
Closed

[osn-filter] Remove obsolete/deprecated/disabled filters #1743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc08b22
[osn-filters] Remove obsolete/deprecated/disabled filters
sandboxcoder Jul 10, 2026
e69939a
add test to verify obsolete filters not returned
sandboxcoder Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion obs-studio-server/source/osn-filter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,17 @@ void osn::Filter::Types(void *data, const int64_t id, const std::vector<ipc::val
rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
const char *typeId = nullptr;
for (size_t idx = 0; obs_enum_filter_types(idx, &typeId); idx++) {
rval.push_back(ipc::value(typeId ? typeId : ""));
if (!typeId)
continue;
uint32_t caps = obs_get_source_output_flags(typeId);
Comment thread
Copilot marked this conversation as resolved.
if ((caps & OBS_SOURCE_DEPRECATED) != 0)
continue;
if ((caps & OBS_SOURCE_CAP_DISABLED) != 0)
continue;
if ((caps & OBS_SOURCE_CAP_OBSOLETE) != 0)
continue;

rval.push_back(ipc::value(typeId));
}
AUTO_DEBUG;
}
Expand Down
17 changes: 17 additions & 0 deletions tests/osn-tests/src/test_osn_filter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,21 @@ describe(testName, () => {
filter.release();
});
});

it('Verify obsolete filters are not returned to the caller', () => {
// These v1 filters are superseded by v2 equivalents and marked OBS_SOURCE_CAP_OBSOLETE.
const knownObsoleteFilters = [
'color_filter',
'color_key_filter',
'chroma_key_filter',
'sharpness_filter',
'mask_filter',
'luma_key_filter',
'noise_suppress_filter',
];

knownObsoleteFilters.forEach(function(id) {
expect(obs.filterTypes).to.not.include(id, `Obsolete filter '${id}' should not be returned to the caller`);
});
});
});
Loading