RemoteClockOffsetEstimator class - #1882
Conversation
# Details - Related to issue #1881 "Do not make RTCP Sender Reports depend on packet arrival time". - Added a new class ` RemoteClockOffsetEstimator` that estimates the offset between the wall clock of a remote sender, as reported in the NTP field of the RTCP Sender Reports it sends, and the mediasoup's monotonic clock, so that a time expressed in the former can be translated into the latter. - `RTC::Packet`: Added `captureMs` getter/setter (will be needed later). - Not yet used.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| feed(estimator, RemoteBaseMs + elapsedMs, LocalBaseMs + elapsedMs, 1, 0, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().has_value()); | ||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| { | ||
| feed(estimator, RemoteBaseMs, LocalBaseMs, minSampleCount, 40, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 40); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 40);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| { | ||
| feed(estimator, RemoteBaseMs, LocalBaseMs, minSampleCount, 40, 80); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| { | ||
| feed(estimator, RemoteBaseMs, LocalBaseMs, windowSize, 20, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 20); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 20);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^|
|
||
| feed(estimator, RemoteBaseMs + elapsedMs, LocalBaseMs + elapsedMs, 1, 500, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 20); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs + 20);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| estimator.AddSenderReport(RemoteBaseMs + 1001, LocalBaseMs + 1000, 0); | ||
| estimator.AddSenderReport(RemoteBaseMs + 2000, LocalBaseMs + 2000, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^|
|
||
| SECTION("remote times are translated into our clock") | ||
| { | ||
| RTC::RemoteClockOffsetEstimator untrainedEstimator; |
There was a problem hiding this comment.
warning: variable 'untrainedEstimator' of type 'RTC::RemoteClockOffsetEstimator' can be declared 'const' [misc-const-correctness]
| RTC::RemoteClockOffsetEstimator untrainedEstimator; | |
| RTC::RemoteClockOffsetEstimator const untrainedEstimator; |
|
|
||
| feed(estimator, RemoteBaseMs, LocalBaseMs, minSampleCount, 0, 0); | ||
|
|
||
| REQUIRE(estimator.RemoteMsToLocalMs(RemoteBaseMs).value() == LocalBaseMs); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.RemoteMsToLocalMs(RemoteBaseMs).value() == LocalBaseMs);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| feed(estimator, RemoteBaseMs, LocalBaseMs, minSampleCount, 0, 0); | ||
|
|
||
| REQUIRE(estimator.RemoteMsToLocalMs(RemoteBaseMs).value() == LocalBaseMs); | ||
| REQUIRE(estimator.RemoteMsToLocalMs(RemoteBaseMs + 500).value() == LocalBaseMs + 500); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.RemoteMsToLocalMs(RemoteBaseMs + 500).value() == LocalBaseMs + 500);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^| // the very same times as before the reset are not taken as duplicates. | ||
| feed(estimator, RemoteBaseMs, LocalBaseMs, minSampleCount, 0, 0); | ||
|
|
||
| REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs); |
There was a problem hiding this comment.
warning: unchecked access to optional value [bugprone-unchecked-optional-access]
REQUIRE(estimator.GetOffsetMs().value() == BaseOffsetMs);
^Additional context
worker/subprojects/Catch2-3.14.0/src/catch2/catch_test_macros.hpp:133: expanded from macro 'REQUIRE'
#define REQUIRE( ... ) INTERNAL_CATCH_TEST( "REQUIRE", Catch::ResultDisposition::Normal, __VA_ARGS__ )
^worker/subprojects/Catch2-3.14.0/src/catch2/internal/catch_test_macro_impl.hpp:49: expanded from macro 'INTERNAL_CATCH_TEST'
catchAssertionHandler.handleExpr( Catch::Decomposer() <= __VA_ARGS__ ); /* NOLINT(bugprone-chained-comparison) */ \
^1 participant
Details
RemoteClockOffsetEstimatorthat estimates the offset between the wall clock of a remote sender, as reported in the NTP field of the RTCP Sender Reports it sends, and the mediasoup's monotonic clock, so that a time expressed in the former can be translated into the latter.RTC::Packet: AddedcaptureMsgetter/setter (will be needed later).