From a5cefc983d178b2a01ebe71196a2d9d78250c8b1 Mon Sep 17 00:00:00 2001 From: Zach Vorhies Date: Thu, 19 Nov 2026 03:26:28 -0800 Subject: [PATCH 1/2] test: require characterized output encoder-demand/start extraction (Refs #5229) --- libobs/build/libobs.core-output+.h.c | 1 + test/cmocka/build/test-graph.json | 21 +++++ test/cmocka/test_output_starting_queries.c | 79 +++++++++++++++++++ .../test_output_starting_queries.cmake | 1 + 4 files changed, 102 insertions(+) create mode 100644 test/cmocka/test_output_starting_queries.c create mode 100644 test/cmocka/tests.d/test_output_starting_queries.cmake diff --git a/libobs/build/libobs.core-output+.h.c b/libobs/build/libobs.core-output+.h.c index ad2821422e..0ef0052580 100644 --- a/libobs/build/libobs.core-output+.h.c +++ b/libobs/build/libobs.core-output+.h.c @@ -66,6 +66,7 @@ #include "libobs/obs-output-set-media-fields.c.h" #include "libobs/obs-output-settings-fields.c.h" #include "libobs/obs-output-size-getters-fields.c.h" +#include "libobs/obs-output-starting-queries.c.h" #include "libobs/obs-output-supported-codecs-fields.c.h" #include "libobs/obs-output-total-bytes-query.c.h" #include "libobs/obs-output-total-frames-fields.c.h" diff --git a/test/cmocka/build/test-graph.json b/test/cmocka/build/test-graph.json index 8a3dffd34e..3b261a5d9a 100644 --- a/test/cmocka/build/test-graph.json +++ b/test/cmocka/build/test-graph.json @@ -10544,6 +10544,21 @@ "OBS::native-test-cmocka" ] }, + "test_output_starting_queries": { + "sources": [ + "test/cmocka/test_output_starting_queries.c" + ], + "libraries": [ + "OBS::libobs", + "OBS::caption", + "Uthash::Uthash", + "OBS::native-test-cmocka", + { + "name": "OBS::w32-pthreads", + "requires": "OS_WINDOWS" + } + ] + }, "test_output_stop_stats_steps": { "sources": [ "test/cmocka/test_output_stop_stats_steps.c", @@ -25445,6 +25460,12 @@ "${target}" ] }, + "test_output_starting_queries": { + "target": "test_output_starting_queries", + "command": [ + "${target}" + ] + }, "test_output_stop_stats_steps": { "target": "test_output_stop_stats_steps", "command": [ diff --git a/test/cmocka/test_output_starting_queries.c b/test/cmocka/test_output_starting_queries.c new file mode 100644 index 0000000000..36b28866c6 --- /dev/null +++ b/test/cmocka/test_output_starting_queries.c @@ -0,0 +1,79 @@ +/* C-source characterization of the private output predicates (#5229). + * Record atomic-load addresses, including skipped reads, using real layouts. + * A later Rust swap must relink this fixture through real private adapters; + * the unchanged failed-start/bind/reset tests also cover the live library. */ +#include +#include +#include +#include +#include +#include "obs-internal.h" + +static struct obs_output output; +static const volatile bool *expected_reads[4]; +static size_t expected_count, read_count; + +static bool recording_load_bool(const volatile bool *ptr) +{ + assert_true(read_count < expected_count); + assert_ptr_equal(ptr, expected_reads[read_count]); + read_count++; + return os_atomic_load_bool(ptr); +} + +/* The three same-group helpers retain their original atomic-load behavior. */ +static inline bool active(const struct obs_output *out) +{ + return recording_load_bool(&out->active); +} + +static inline bool reconnecting(const struct obs_output *out) +{ + return recording_load_bool(&out->reconnecting); +} + +static inline bool delay_active(const struct obs_output *out) +{ + return recording_load_bool(&out->delay_active); +} + +#define os_atomic_load_bool recording_load_bool +#include "libobs/obs-output-starting-queries.c.h" +#undef os_atomic_load_bool + +static void flag_matrix(void **state) +{ + (void)state; + for (unsigned flags = 0; flags < 16; flags++) { + memset(&output, 0, sizeof(output)); + output.active = (flags & 1) != 0; + output.starting = (flags & 2) != 0; + output.reconnecting = (flags & 4) != 0; + output.delay_active = (flags & 8) != 0; + /* Irrelevant flags must never be read, even when they are true. */ + output.delay_capturing = true; + output.data_active = true; + const volatile bool *fields[] = {&output.active, &output.starting, &output.reconnecting, + &output.delay_active}; + unsigned char before[sizeof(output)]; + memcpy(before, &output, sizeof(output)); + for (unsigned first = 0; first < 2; first++) { + expected_count = read_count = 0; + for (unsigned i = first; i < 4; i++) { + expected_reads[expected_count++] = fields[i]; + if ((flags & (1U << i)) != 0) + break; + } + bool actual = first == 0 ? obs_output_needs_encoders(&output) : obs_output_starting(&output); + assert_int_equal(actual, (flags & (first == 0 ? 15U : 14U)) != 0); + assert_int_equal(read_count, expected_count); + assert_memory_equal(&output, before, sizeof(output)); + } + } +} + +int main(void) +{ + const struct CMUnitTest tests[] = {cmocka_unit_test(flag_matrix)}; + return cmocka_run_group_tests(tests, NULL, NULL); +} diff --git a/test/cmocka/tests.d/test_output_starting_queries.cmake b/test/cmocka/tests.d/test_output_starting_queries.cmake new file mode 100644 index 0000000000..d85a840326 --- /dev/null +++ b/test/cmocka/tests.d/test_output_starting_queries.cmake @@ -0,0 +1 @@ +# Registered in the canonical native test graph (test/cmocka/build/test-graph.json). From eefff9ce4f3e9964c4c202347d845e305290bb8a Mon Sep 17 00:00:00 2001 From: Zach Vorhies Date: Thu, 19 Nov 2026 03:31:09 -0800 Subject: [PATCH 2/2] libobs: extract output encoder-demand/start predicates verbatim (Refs #5229) Ci-Attestation: {"at":1795089311,"gate":"data/all/compatibility","host":"linux-x86_64","key":"","lane":"client-checks","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":133,"stamp":"ec89e81ab761050c121400be6f9897c9","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089311,"gate":"data/all/flatpak-manifest","host":"linux-x86_64","key":"","lane":"client-checks","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":133,"stamp":"fdf2e504cee55aaa9289bcc409a5c40c","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089311,"gate":"data/all/qt-xml","host":"linux-x86_64","key":"","lane":"client-checks","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":133,"stamp":"4577ac7d883ec346a286280c5e48f51e","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089311,"gate":"data/all/services-schema","host":"linux-x86_64","key":"","lane":"client-checks","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":133,"stamp":"439879a17669ff38d4ceb6bc8a05e9d9","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"general/all/client-lint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"b2e3ab68a786d9dece6f5d697771f4ce","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089311,"gate":"python/all/self-test","host":"linux-x86_64","key":"","lane":"client-checks","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":133,"stamp":"1359a733082c07c2b98980765eabf92c","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/aarch64-apple-darwin/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"b4f7af564c5ad0c27db19ac3c85d40d4","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/aarch64-apple-darwin/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"017e8078db3018f2cd4f578300cbd7e2","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/aarch64-pc-windows-msvc/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"c3943d4ef82c94ebe7be1c14cce0e156","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/aarch64-pc-windows-msvc/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"207c1ca14bdec3706ac79d9449154b11","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/aarch64-unknown-linux-gnu/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"0b392207415f743c149a2d409bf7aa00","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/aarch64-unknown-linux-gnu/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"2a00acdd0fd895c9eabdcf12fcb3ed79","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/x86_64-apple-darwin/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"806ea82c92fe52826709319a5e6b9c5a","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089176,"gate":"rust/x86_64-apple-darwin/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"7657dfbd92f6679a3fcc78dbe1c579c7","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/x86_64-pc-windows-msvc/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"fb0011220e32172d7edb6c55bfa6efe7","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/x86_64-pc-windows-msvc/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"bb25b4dce39f0baaf82c69d30fd77421","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/x86_64-unknown-linux-gnu/client-clippy","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"9c5271380d5d8047ca33d3080f27e5f1","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795089175,"gate":"rust/x86_64-unknown-linux-gnu/client-dylint","host":"linux-x86_64","key":"d2ea0b6cad108788b7aca20db141423e2fd0a4b42c7a2821453d197456c34f9b","lane":"client-lint","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":150,"stamp":"e106e34872e53cbc624274ffa90cef2e","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Ci-Attestation: {"at":1795090027,"gate":"rust/x86_64-unknown-linux-gnu/client-test","host":"linux-x86_64","key":"8db27221917c322b41b11e6ad36abac0979aaa21d08d1088a514bf32a76ff8f8","lane":"client-test-x86_64-unknown-linux-gnu","parents":["a5cefc983d178b2a01ebe71196a2d9d78250c8b1"],"secs":714,"stamp":"4a78384ddbbaedea3d890a17459c4856","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d","v":1,"via":"run"} Client-Checks: {"checks":{"base":"7ff57244c874a81d1812a3d57d5253ee7d8c5e1d","coverage":"all-tracked-applicable-files","diff":["libobs/build/libobs.core+.h.c","libobs/build/libobs.core-output+.h.c","libobs/build/libobs.ported-type-catalog-enum+.h.c","libobs/build/ported-source-sets/type-catalog-enum.json","libobs/cmake/rust-exports.d/obs-core-type_catalog_enum.txt","libobs/obs-output-starting-queries.c.h","libobs/obs-output.c.h","libobs/obs-type-catalog-enum-fields.c.h","rust/README.md","rust/obs-build/tests/native.rs","rust/obs-build/tests/native/registration/canonical_type_catalog_enum_swap_is_registered.rs","rust/obs-c-oracle/oracle/type_catalog_enum.c","rust/obs-core/src/ffi/mod.rs","rust/obs-core/src/ffi/type_catalog_enum.rs","rust/obs-core/src/lib.rs","rust/obs-core/src/type_catalog_enum.rs","rust/obs-core/tests/obs_core/main.rs","rust/obs-core/tests/obs_core/type_catalog_enum.rs","rust/obs-core/tests/obs_core/type_catalog_enum_parity.rs","test/cmocka/build/test-graph.json","test/cmocka/test_output_starting_queries.c","test/cmocka/tests.d/test_output_starting_queries.cmake","test/cmocka/video-info-query-link-support.c"],"head":"d859b4b9317999200f3e7dac8b4c15a6cc7bcfcf","tools":{"orchestrator-python":"3.13.15 (main, Aug 14 2026, 15:34:59) [Clang 22.1.3 ]","schema-dependencies":"3.13.15 (main, Aug 14 2026, 15:34:59) [Clang 22.1.3 ]\n{'jsonschema': '4.26.0', 'json_source_map': '1.0.5'}","uv":"uv 0.13.5 (x86_64-unknown-linux-gnu)","xmllint":"xmllint: using libxml version 21504\n compiled with: Threads Tree Output Push Reader Patterns Writer SAXv1 DTDValid HTML C14N Catalog XPath XPointer XInclude Iconv ISO8859X Regexps Automata RelaxNG Schemas Modules Debug"},"tracked-digest":"d5309cdc3a2119c58bdee7379ab1e525f4012660e6d4560b0fb2fc6a53f0d52d","tree":"514fd2b9caeb134aefb6b0fbbc903936bc6a797d"}} --- libobs/obs-output-starting-queries.c.h | 20 ++++++++++++++++++++ libobs/obs-output.c.h | 14 -------------- test/cmocka/test_output_starting_queries.c | 16 +++++++++++----- 3 files changed, 31 insertions(+), 19 deletions(-) create mode 100644 libobs/obs-output-starting-queries.c.h diff --git a/libobs/obs-output-starting-queries.c.h b/libobs/obs-output-starting-queries.c.h new file mode 100644 index 0000000000..b2eed67c64 --- /dev/null +++ b/libobs/obs-output-starting-queries.c.h @@ -0,0 +1,20 @@ +#include "libobs/build/libobs.pch.h" + +/* Defined later by obs-output.c.h in the core-output unity group. */ +static inline bool active(const struct obs_output *output); +static inline bool reconnecting(const struct obs_output *output); +static inline bool delay_active(const struct obs_output *output); + +/* Whether the output is using its encoders or about to: it is starting, + * running, reconnecting or delaying. */ +bool obs_output_needs_encoders(const struct obs_output *output) +{ + return active(output) || os_atomic_load_bool(&output->starting) || reconnecting(output) || delay_active(output); +} + +/* Whether the output is about to use its encoders: it is starting (a stream + * still connecting), reconnecting or delaying. */ +bool obs_output_starting(const struct obs_output *output) +{ + return os_atomic_load_bool(&output->starting) || reconnecting(output) || delay_active(output); +} diff --git a/libobs/obs-output.c.h b/libobs/obs-output.c.h index 9a82a080ec..33d84eff5f 100644 --- a/libobs/obs-output.c.h +++ b/libobs/obs-output.c.h @@ -1956,20 +1956,6 @@ static void *end_data_capture_thread(void *data) return NULL; } -/* Whether the output is using its encoders or about to: it is starting, - * running, reconnecting or delaying. */ -bool obs_output_needs_encoders(const struct obs_output *output) -{ - return active(output) || os_atomic_load_bool(&output->starting) || reconnecting(output) || delay_active(output); -} - -/* Whether the output is about to use its encoders: it is starting (a stream - * still connecting), reconnecting or delaying. */ -bool obs_output_starting(const struct obs_output *output) -{ - return os_atomic_load_bool(&output->starting) || reconnecting(output) || delay_active(output); -} - static void shutdown_unstarted_encoders(obs_output_t *output) { for (size_t i = 0; i < MAX_OUTPUT_VIDEO_ENCODERS; i++) { diff --git a/test/cmocka/test_output_starting_queries.c b/test/cmocka/test_output_starting_queries.c index 36b28866c6..429913e5d9 100644 --- a/test/cmocka/test_output_starting_queries.c +++ b/test/cmocka/test_output_starting_queries.c @@ -13,7 +13,9 @@ static struct obs_output output; static const volatile bool *expected_reads[4]; static size_t expected_count, read_count; -static bool recording_load_bool(const volatile bool *ptr) +bool output_starting_recording_load_bool(const volatile bool *ptr); + +bool output_starting_recording_load_bool(const volatile bool *ptr) { assert_true(read_count < expected_count); assert_ptr_equal(ptr, expected_reads[read_count]); @@ -21,25 +23,29 @@ static bool recording_load_bool(const volatile bool *ptr) return os_atomic_load_bool(ptr); } +/* A later swap selects external predicates and links the real atomic adapter + * to output_starting_recording_load_bool without changing these assertions. */ +#ifndef OUTPUT_STARTING_QUERIES_EXTERNAL /* The three same-group helpers retain their original atomic-load behavior. */ static inline bool active(const struct obs_output *out) { - return recording_load_bool(&out->active); + return output_starting_recording_load_bool(&out->active); } static inline bool reconnecting(const struct obs_output *out) { - return recording_load_bool(&out->reconnecting); + return output_starting_recording_load_bool(&out->reconnecting); } static inline bool delay_active(const struct obs_output *out) { - return recording_load_bool(&out->delay_active); + return output_starting_recording_load_bool(&out->delay_active); } -#define os_atomic_load_bool recording_load_bool +#define os_atomic_load_bool output_starting_recording_load_bool #include "libobs/obs-output-starting-queries.c.h" #undef os_atomic_load_bool +#endif static void flag_matrix(void **state) {