Skip to content

rust: Port libobs/obs-type-catalog-enum.c.h to obs-core #5202

Closed

Description

@zackees

Phase 6 core metadata; follow-up to the behavior-neutral characterization/extraction prerequisite #5170. Wait for that prerequisite PR to merge, then start from current origin/master.

Port exactly libobs/obs-type-catalog-enum.c.h to obs-core: obs_enum_input_types, obs_enum_filter_types, obs_enum_transition_types, obs_enum_output_types, obs_enum_encoder_types and obs_enum_service_types. Preserve the existing C API/ABI, signatures and catalog selection. Keep obs_enum_source_types, obs_enum_input_types2, obs_get_latest_input_type_id, callback-based obs_enum_output_types_with_protocol and all registration/instance operations unchanged. Reuse existing source_type_enum safe bounds/output machinery where applicable; this unit has no intentional behavior differences.

Use the unchanged test/cmocka/test_type_catalog_enum.c as the characterization. Mirror every assertion in safe Rust Tier 1 with a committed failing stub before GREEN: empty catalogs, independent counts, test-owned insertion order, first/last test entries, num/num+1/SIZE_MAX failure, distinct no-write sentinels, borrowed pointer identity and NULL output only on failure. No-core and successful NULL-output calls remain outside the C contract. Do not assert on platform/module-provided IDs; the CMake executable also runs against the Cargo-native C-reference library on macOS/Windows (#5182). Platform C long widths differ; type helpers as c_long/c_ulong directly rather than adding Windows-useless conversions.

Tier 2 keeps the new characterization and existing source_registration/source_type_enum/register_short_info/module_type_rules_steps/encoder_type_info/output_type_info tests unchanged against both C-reference and hybrid libobs, with identical public symbols. Any exposed layout needs real-header size/alignment/all-field-offset coverage. Tier 3 compares original C oracle, ABI shim and safe core with bounded edge/random cases and a demonstrated mutation failure. Tier 4 is inapplicable to this non-protocol metadata swap; preserve the unchanged C++ WebSocket plugin and public headers.

Use existing Core state / obs-data --test obs-tests-core modules, never a new Rust executable. NULL-check permitted owner tokens before field adapters. Every real adapter must be linked into all standalone Rust-static consumers through tests.d link support and canonical graph; never add aborting link stubs. Run ci/windows_link_check.py and a focused Linux Tier 2 build including at least two unrelated *_rust targets to catch adapter archive-member link failures. Run the whole native_build module and lint once.

Move the whole extracted source to a ported unity group and register canonical source/module/export/oracle metadata. Keep unity and graph membership sorted. Coordinate same-group siblings #5169/#5171-#5173 and #5175 without expanding scope. No existing C-test/public-header edits, workflow additions, CI work or WebSocket plugin edits. Rust through soldr, Python through uv, publish through ./push. Refs #4781; Refs #4648.

Prerequisite PR: #5201 (Refs #5170), published head a572cc2. Characterization/extraction is C-only; do not begin the swap until that prerequisite lands and #5170 is completed. The producer ran nine focused Linux Tier 2 targets three times against each library (1,769 identical exports), whole native_build, MSVC workspace test linking and full lint; fresh push proofs passed all six targets and 9,130 host tests. Native macOS/Windows C runtime remains queue-owned acceptance.

Activity

  1. added
    portPort a C unit to Rust (four-tier policy)
    readyMeets the definition of Ready; claimable
    P2Normal priority
    on Nov 19, 2026
  2. zackees commented on Nov 19, 2026

    @zackees
    MemberAuthor

    Claiming: #5202 type-catalog enumeration swap in obs-studio5.

    1. Mirror the unchanged libobs: characterize and extract core type-catalog enumeration (Refs #5170) #5201 characterization in safe obs-core tests and commit a failing stub.
    2. Replace exactly the six enumeration bodies with thin ABI shims, reuse shared demand-linked adapter support, and add original-C differential and mutation coverage.
    3. Run obs-core, whole native_build, focused OFF/ON Tier 2 plus every *_rust target, Windows/Darwin links, formatting and lint; publish when backpressure permits.

    First PR expected after GREEN verification in this worker session. Refs #5202.

  3. zackees commented on Nov 19, 2026

    @zackees
    MemberAuthor

    Landed on master in #5211 (7ff5724): the six core type-catalog enumerators now run in safe Rust in obs-core, through #5190's shared adapter archive.

  4. moved this from In progress to Done in obs-rust Multiviewon Nov 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P2Normal priorityportPort a C unit to Rust (four-tier policy)readyMeets the definition of Ready; claimablesize:SHours

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions