VPLAY-12359 suboptimal UTCTiming behavior

Reason for change: Updates UTCTiming logic to skip sync if interval hasn’t elapsed. Add Configs to control the interval
Test Procedure: updated in ticket
Risks: Low

Signed-off-by: Anurag Krishnan <[email protected]>

Author: Anurag Krishnan

AampConfig.cpp

@@ -368,7 +368,8 @@ static const ConfigLookupEntryBool mConfigLookupTableBool[AAMPCONFIG_BOOL_COUNT]
 	{false, "curlThroughput", eAAMPConfig_CurlThroughput, false },
 	{false, "useFireboltSDK", eAAMPConfig_UseFireboltSDK, false},
 	{true, "enableChunkInjection", eAAMPConfig_EnableChunkInjection, true},
-	{false, "debugChunkTransfer", eAAMPConfig_DebugChunkTransfer, false}
+	{false, "debugChunkTransfer", eAAMPConfig_DebugChunkTransfer, false},
+	{true, "utcSyncOnStartup", eAAMPConfig_UTCSyncOnStartup, true}
 };
 
 #define CONFIG_INT_ALIAS_COUNT 2
@@ -471,6 +472,8 @@ static const ConfigLookupEntryInt mConfigLookupTableInt[AAMPCONFIG_INT_COUNT+CON
 	// aliases, kept for backwards compatibility
 	{DEFAULT_INIT_BITRATE,"defaultBitrate",eAAMPConfig_DefaultBitrate,true },
 	{DEFAULT_INIT_BITRATE_4K,"defaultBitrate4K",eAAMPConfig_DefaultBitrate4K,true },
+	{DEFAULT_UTC_SYNC_MIN_INTERVAL,"utcSyncMinIntervalSec",eAAMPConfig_UTCSyncMinIntervalSec,true },
+	{DEFAULT_UTC_SYNC_ON_ERROR_RETRY,"utcSyncOnErrorRetrySec",eAAMPConfig_UTCSyncOnErrorRetrySec,true },
 };
 
 /**

AampConfig.h

@@ -214,6 +214,7 @@ typedef enum
 	eAAMPConfig_UseFireboltSDK,						/**< Config to use Firebolt SDK for license Acquisition */
 	eAAMPConfig_EnableChunkInjection,					/**< Config to enable chunk injection for low latency DASH */
 	eAAMPConfig_DebugChunkTransfer,					/**< app-managed chunked transfer protocol */
+	eAAMPConfig_UTCSyncOnStartup,					/** Perform sync at startup */
 	eAAMPConfig_BoolMaxValue						/**< Max value of bool config always last element */
 
 } AAMPConfigSettingBool;
@@ -311,6 +312,8 @@ typedef enum
 	eAAMPConfig_MonitorAVJumpThreshold,				/**< configures threshold aligned audio,video positions advancing together by unexpectedly large delta to be reported as jump in milliseconds*/
 	eAAMPConfig_ProgressLoggingDivisor,				/**<  Divisor to avoid printing the progress report too frequently in the log */
 	eAAMPConfig_MonitorAVReportingInterval,			/**< Timeout in milliseconds for reporting MonitorAV events */
+	eAAMPConfig_UTCSyncMinIntervalSec,				/**< Minimum interval between sync attempts */
+	eAAMPConfig_UTCSyncOnErrorRetrySec,				/**<  Backoff after error */
 	eAAMPConfig_IntMaxValue							/**< Max value of int config always last element*/
 } AAMPConfigSettingInt;
 #define AAMPCONFIG_INT_COUNT (eAAMPConfig_IntMaxValue)

AampDefine.h

@@ -143,6 +143,9 @@
 #define DEFAULT_MONITOR_AV_JUMP_THRESHOLD_MS 100 	/**< default jump threshold to MonitorAV reporting */
 #define DEFAULT_MAX_DOWNLOAD_BUFFER 10	/**< Default maximum download buffer in seconds, this can be used to limit player download job scheduling for DASH */
 #define DEFAULT_MONITOR_AV_REPORTING_INTERVAL 1000 /**< time interval in ms for MonitorAV reporting */
+#define DEFAULT_UTC_SYNC_MIN_INTERVAL	60	/**< Minimum interval between sync attempts */
+#define DEFAULT_UTC_SYNC_ON_ERROR_RETRY 120	/**< Backoff after error */
+
 
 // We can enable the following once we have a thread monitoring video PTS progress and triggering subtec clock fast update when we detect video freeze. Disabled it for now for brute force fast refresh..
 //#define SUBTEC_VARIABLE_CLOCK_UPDATE_RATE   /* enable this to make the clock update rate dynamic*/

fragmentcollector_mpd.cpp

@@ -4505,16 +4505,26 @@ bool  StreamAbstractionAAMP_MPD::FindServerUTCTime(Node* root)
 							aamp_ResolveURL(ServerUrl, aamp->GetManifestUrl(), valueCopy.c_str(), false);
 						}
 
-						mLocalUtcTime = GetNetworkTime(ServerUrl, &http_error, aamp->GetNetworkProxy());
+						double elapsed = (double)(aamp_GetCurrentTimeMS() - mSyncIfNeeded.lastSync) / 1000;
+						if ((!mSyncIfNeeded.hasSynced && ISCONFIGSET(eAAMPConfig_UTCSyncOnStartup)) || (elapsed >= GETCONFIGVALUE(eAAMPConfig_UTCSyncMinIntervalSec)))
+						{
+							mLocalUtcTime = GetNetworkTime(ServerUrl, &http_error, aamp->GetNetworkProxy());
+						}else
+						{
+							mLocalUtcTime = 0;
+						}
+
 						if(mLocalUtcTime > 0 )
 						{
-							double currentTime = (double)aamp_GetCurrentTimeMS() / 1000;
-							mDeltaTime =  mLocalUtcTime - currentTime;
+							mSyncIfNeeded.lastSync = aamp_GetCurrentTimeMS();
+							mDeltaTime =  mLocalUtcTime - (double)mSyncIfNeeded.lastSync / 1000;
+							mSyncIfNeeded.lastOffset = mDeltaTime;
+							mSyncIfNeeded.hasSynced = true;
 							hasServerUtcTime = true;
 						}
 						else
 						{
-							AAMPLOG_ERR("Failed to read timeServer [%s] RetCode[%d]",ServerUrl.c_str(),http_error);
+							AAMPLOG_WARN("UTCTiming sync skipped or failed; using cached offset. timeServer [%s] RetCode[%d]",ServerUrl.c_str(),http_error);
 						}
 						break;
 					}

fragmentcollector_mpd.h

@@ -67,6 +67,19 @@ struct ProfileInfo
 	int representationIndex;
 };
 
+/**
+ * @struct TimeSyncClient
+ * @brief UTC time sync info
+ */
+struct TimeSyncClient
+{
+	long long lastSync;
+	double lastOffset;
+    bool hasSynced;
+	TimeSyncClient(): lastSync(0), lastOffset(0), hasSynced(false)
+	{}
+};
+
 class AampDashWorkerJob : public aamp::AampTrackWorkerJob
 {
 private:
@@ -1244,6 +1257,7 @@ class StreamAbstractionAAMP_MPD : public StreamAbstractionAAMP
 	bool mShortAdOffsetCalc;
 	AampTime mNextPts;					/*For PTS restamping*/
 	bool mIsFinalFirstPTS; /**< Flag to indicate if the first PTS is final or not */
+	TimeSyncClient mSyncIfNeeded;  
 };
 
 #endif //FRAGMENTCOLLECTOR_MPD_H_