VPLAY-12213: ABR Refactoring part 3 - encapsulate remaining abr logic

AampConfig.cpp

@@ -31,6 +31,7 @@
 #include "PlayerRfc.h"
 #include "PlayerExternalsInterface.h"
 #include "PlayerSecInterface.h"
+#include "abr.h"
 #include <time.h>
 #include <map>
 //////////////// CAUTION !!!! STOP !!! Read this before you proceed !!!!!!! /////////////
@@ -471,6 +472,7 @@ static const ConfigLookupEntryInt mConfigLookupTableInt[AAMPCONFIG_INT_COUNT+CON
 	{DEFAULT_PROGRESS_LOGGING_DIVISOR,"progressLoggingDivisor",eAAMPConfig_ProgressLoggingDivisor,false},
 	{DEFAULT_MONITOR_AV_REPORTING_INTERVAL, "monitorAVReportingInterval", eAAMPConfig_MonitorAVReportingInterval, false},
 	{DEFAULT_UTC_SYNC_MIN_INTERVAL_SEC,"utcSyncMinIntervalSec",eAAMPConfig_UTCSyncMinIntervalSec,true },
+	{DEFAULT_ABR_BANDWIDTH_ESTIMATION_ALGORITHM, "abrBandwidthEstimator", eAAMPConfig_ABRBandwidthEstimator, false, eCONFIG_RANGE_ANY},
 	{DEFAULT_EARLY_ABORT_PROFILE_BANDWIDTH_PERCENT,"earlyAbortProfileBandwidthPercent",eAAMPConfig_EarlyAbortProfileBandwidthPercent,true},
 	// Add new integer config entries above this line, before the aliases section.
 	//

AampConfig.h

@@ -314,6 +314,7 @@ typedef enum
 	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_ABRBandwidthEstimator,				/**< Select ABR bandwidth estimator */
 	eAAMPConfig_EarlyAbortProfileBandwidthPercent,	/**< Early abort threshold as percentage of profile bandwidth */
 	eAAMPConfig_IntMaxValue							/**< Max value of int config always last element*/
 } AAMPConfigSettingInt;

AampDefine.h

@@ -60,6 +60,7 @@
 #define DEFAULT_BUFFER_HEALTH_MONITOR_INTERVAL 5
 #define DEFAULT_ABR_CACHE_LENGTH 3                  		/**< Default ABR cache length */
 #define DEFAULT_ABR_BUFFER_COUNTER 4				/**< Default ABR Buffer Counter */
+#define DEFAULT_ABR_BANDWIDTH_ESTIMATION_ALGORITHM 0			/**< Default ABR Bandwidth Estimation Algorithm */
 #define DEFAULT_REPORT_PROGRESS_INTERVAL 1     			/**< Progress event reporting interval: 1sec */
 #define DEFAULT_PROGRESS_LOGGING_DIVISOR 4			/**< Divisor of progress logging frequency to print logging */
 #define DEFAULT_LICENSE_REQ_RETRY_WAIT_TIME 500			/**< Wait time in milliseconds before retrying for DRM license */
@@ -199,7 +200,6 @@
 
 #define DEFAULT_INITIAL_RATE_CORRECTION_SPEED 1.000001f	/**< Initial rate correction speed to avoid audio drop */
 #define DEFAULT_CACHED_FRAGMENT_CHUNKS_PER_TRACK	20					/**< Default cached fragment chunks per track */
-#define DEFAULT_ABR_CHUNK_CACHE_LENGTH			10					/**< Default ABR chunk cache length */
 #define DEFAULT_AAMP_ABR_CHUNK_THRESHOLD_SIZE		(DEFAULT_AAMP_ABR_THRESHOLD_SIZE)	/**< aamp abr Chunk threshold size */
 #define DEFAULT_ABR_CHUNK_SPEEDCNT			10					/**< Chunk Speed Count Store Size */
 #define DEFAULT_ABR_ELAPSED_MILLIS_FOR_ESTIMATE		100					/**< Duration(ms) to check Chunk Speed */

CMakeLists.txt

@@ -389,7 +389,9 @@ set(LIBAAMP_SOURCES
 	AampCMCDCollector.cpp AampCMCDCollector.h
 	downloader/AampCurlDownloader.cpp downloader/AampCurlDownloader.h
 	ID3Metadata.cpp ID3Metadata.hpp
-	abr/abr.cpp abr/abr.h abr/NetworkBandwidthEstimator.cpp abr/NetworkBandwidthEstimator.h
+	abr/abr.cpp abr/abr.h
+	abr/RollingMedianOutlierEstimator.cpp abr/RollingMedianOutlierEstimator.h
+	abr/HarmonicEwmaEstimator.cpp abr/HarmonicEwmaEstimator.h
 	dash/xml/DomDocument.cpp
 	dash/xml/DomElement.cpp
 	dash/xml/DomNode.cpp
@@ -586,6 +588,9 @@ install(FILES
 	LangCodePreference.h StreamOutputFormat.h VideoZoomMode.h StreamSink.h TimedMetadata.h
 	AampDemuxDataTypes.h
 	abr/abr.h
+	abr/RollingMedianOutlierEstimator.h
+	abr/HarmonicEwmaEstimator.h
+	abr/BandwidthEstimatorBase.h
 	DESTINATION include
 )
 

abr/BandwidthEstimatorBase.h

@@ -0,0 +1,177 @@
+/*
+ * If not stated otherwise in this file or this component's license file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2026 RDK Management
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef AAMP_ABR_BANDWIDTH_ESTIMATOR_BASE_H
+#define AAMP_ABR_BANDWIDTH_ESTIMATOR_BASE_H
+
+#include <cstddef>
+
+#include "AampMediaType.h"
+
+#define DEFAULT_ABR_CHUNK_CACHE_LENGTH	10					/**< Default ABR chunk cache length */
+
+/**
+ * @brief Plain Old Data (POD) structure for profiling information from a
+ * given CURL instance.
+ */
+struct DownloadMetrics
+{
+	std::size_t m_size_download_bytes; // CURLINFO_SIZE_DOWNLOAD
+	double m_total_time_seconds; // CURLINFO_TOTAL_TIME
+	double m_time_to_first_byte_seconds; // CURLINFO_STARTTRANSFER_TIME
+};
+
+/**
+ * @brief POD structure for in-flight progress updates (xferinfo-style).
+ */
+struct DownloadProgressInfo
+{
+	double m_now_seconds;
+	std::size_t m_total_bytes;
+	std::size_t m_now_bytes;
+};
+
+/**
+ * @brief Optional configuration for bandwidth estimators.
+ *
+ * Not all estimators use every field. Estimators that do not support
+ * configuration should ignore it.
+ */
+struct BandwidthEstimatorConfig
+{
+	int mAbrCacheLife;
+	int mAbrCacheLength;
+	int mAbrCacheOutlier;
+	std::size_t mLowLatencyCacheLength;
+
+	/**
+	 * @brief Default constructor.
+	 */
+	BandwidthEstimatorConfig()
+		: mAbrCacheLife(0),
+		  mAbrCacheLength(0),
+		  mAbrCacheOutlier(0),
+		  mLowLatencyCacheLength(0)
+	{
+	}
+
+	/**
+	 * @brief Parameterized constructor.
+	 */
+	BandwidthEstimatorConfig(
+		int abrCacheLife,
+		int abrCacheLength,
+		int abrCacheOutlier,
+		std::size_t lowLatencyCacheLength)
+		: mAbrCacheLife(abrCacheLife),
+		  mAbrCacheLength(abrCacheLength),
+		  mAbrCacheOutlier(abrCacheOutlier),
+		  mLowLatencyCacheLength(lowLatencyCacheLength)
+	{
+	}
+};
+
+/**
+ * @brief Base interface for bandwidth estimation algorithms.
+ */
+class BandwidthEstimatorBase
+{
+public:
+	virtual ~BandwidthEstimatorBase() {}
+
+	/**
+	 * @brief Human-readable algorithm name.
+	 */
+	virtual const char* GetNetworkEstimatorName() const = 0;
+
+	/**
+	 * @brief Reset all internal state.
+	 */
+	virtual void Reset() = 0;
+
+	/**
+	 * @brief Add a bandwidth sample (bits per second).
+	 */
+	virtual void AddBandwidthSample(BitsPerSecond downloadbps, bool lowLatencyMode) = 0;
+
+	/**
+	 * @brief Add download metrics derived from curl (optional).
+	 */
+	virtual void UpdateDownloadMetrics(const DownloadMetrics &metrics ) = 0;
+
+	/**
+	 * @brief Provide in-flight download progress updates (optional).
+	 */
+	virtual void UpdateDownloadProgress(const DownloadProgressInfo &progressInfo)
+	{
+	}
+
+	/**
+	 * @brief Update estimator configuration (optional).
+	 *
+	 * Default implementation is a no-op.
+	 */
+	virtual void SetConfig(const BandwidthEstimatorConfig &config)
+	{
+	}
+
+	/**
+	 * @brief Return current bandwidth estimate (bits per second).
+	 *
+	 * @return Estimated bandwidth in bits per second, or -1 if unavailable.
+	 */
+	virtual BitsPerSecond GetBandwidthBitsPerSecond() = 0;
+
+	/**
+	 * @brief Return current robust throughput estimate (bytes/s).
+	 */
+	virtual double GetThroughputBytesPerSecond() = 0;
+
+	/**
+	 * @brief Return current overhead (TTFB) estimate (seconds).
+	 */
+	virtual double GetTimeToFirstByteSeconds() = 0;
+
+	/**
+	 * @brief Predict download completion time for a segment.
+	 *
+	 * Predicts how long it will take (wall-clock time) to download a
+	 * segment of the given size using the estimator's current state.
+	 *
+	 * Units:
+	 * - @p segment_size_bytes: bytes
+	 * - return value: seconds
+	 *
+	 * Semantics:
+	 * - Implementations may include protocol/connection overhead (e.g.
+	 *   time-to-first-byte) in addition to payload transfer time.
+	 * - If there is insufficient data to estimate bandwidth, or the
+	 *   estimate is not usable (e.g. <= 0), implementations should return
+	 *   0.0 to indicate "unavailable".
+	 */
+	virtual double GetPredictedDownloadTimeSeconds(std::size_t segment_size_bytes) = 0;
+
+	/**
+	 * @brief Reset only the currently available bandwidth estimate.
+	 */
+	virtual void ResetCurrentlyAvailableBandwidth()
+	{
+	}
+};
+
+#endif