Merge pull request #584 from rdkcentral/feature/RDK-59589_federated_2510

RDK-59589, RDKEMW-9377: AAMP Federated Release for Sprint 2510 - Tag 3.0.0

Author: paulpandian25

.github/workflows/L1-tests.yml

@@ -50,4 +50,4 @@ jobs:
       # Show failure
       - name: Show failure details (if any)
         if: failure()
-        run: tail -n 50 test/utests/build/ctest-results.xml
+        run: tail -n 50 test/utests/build/ctest-results.xml

AAMP-UVE-API.md

@@ -1935,6 +1935,7 @@ Example:
 	- add -> Audio Decryption Duration - Audio fragment decrypt duration in ms
 	- gps -> gstPlaying: offset in ms from tunestart when pipeline first fed data
 	- gff -> Total tune time if successful - offset in ms from tunestart to when first frame of video is decoded/presented.
+	- gdt -> gstDecodeTime - Total time taken in ms to decode first frame.
 	- cnt -> Content Type
 		- Content Types: Unknown(0), CDVR(1), VOD(2), Linear(3), IVOD(4), EAS(5), Camera(6), DVR(7), MDVR(8), IPDVR(9), PPV(10), OTT(11), OTA(12), HDMI Input(13), COMPOSITE Input(14), SLE(15). Refer [load](#load-uri_autoplay_tuneparams) API
 	- stt -> Media stream Type + Drm codec Type
@@ -1953,7 +1954,7 @@ Example:
 	- app -> AppName
 	- tsb -> TSBEnabled or not - enabled(1) not enabled(0)
 	- tot -> TotalTime -for failure and interrupt tune -it is time at which failure /interrupt reported
-
+    - pst -> PreviousStopTime - total time (in milliseconds) it took previous playback to stop
 ---
 ### needManifest
 
@@ -2444,8 +2445,50 @@ When a player instance is no longer needed, recommend to call explicit release()
 
 ---
 
-## Inband Closed Caption Management
-To use inband closed captions, first register an event listener to discover decoder handle:
+## Global User Settings/Preferences Discovery
+
+Firebolt getter APIs may be used to discover user settings/preferences related to caption styling and language preferences.  These are not managed internally by AAMP.
+
+```
+import { Accessibility } from '@firebolt-js/sdk'
+
+let closedCaptionsSettings = await Accessibility.closedCaptionsSettings()
+console.log(closedCaptionsSettings)
+```
+
+Response:
+```
+{
+	"enabled": true,
+	"styles": {
+		"fontFamily": "monospaced_sanserif",
+		"fontSize": 1,
+		"fontColor": "#ffffff",
+		"fontEdge": "none",
+		"fontEdgeColor": "#7F7F7F",
+		"fontOpacity": 100,
+		"backgroundColor": "#000000",
+		"backgroundOpacity": 100,
+		"textAlign": "center",
+		"textAlignVertical": "middle",
+		"windowColor": "white",
+		"windowOpacity": 50
+	},
+	"preferredLanguages": [
+		"eng",
+		"spa"
+	]
+}
+```
+
+
+## Inband (CEA608/708) Closed Caption Management (legacy XREReceiver API) 
+* on scaled X1 devices this is mapped directly to receiver APIs interacting with RDK CC Manager
+    * here by default will inherit X1 caption style settings as set by user through guide settings
+    * apps can override caption styling, but typically wouldn't need to do so
+* on non-XRE devices this is implemented as a wrapper for backwards compatibility, but with limitations - only default styles will ever be applied, and with no way for app to change, and won't reflect guide settings
+ 
+To use legacy XREReceiver inband closed captions, first register an event listener to discover decoder handle:
 ```
 player.addEventListener("decoderAvailable", decoderHandleAvailable);
 ```
@@ -2461,41 +2504,44 @@ Toggle CC display on or off at runtime:
 XREReceiver.onEvent("onClosedCaptions", { enable: true });
 XREReceiver.onEvent("onClosedCaptions", { enable: false });
 ```
-Set CC track at runtime:
+Select CC track at runtime:
 ```
 XREReceiver.onEvent("onClosedCaptions", { setTrack: trackID });
 ```
-Set CC style options at runtime:
+Set CC style options at runtime, using stringified JSON object detailing styling options.
 ```
 XREReceiver.onEvent("onClosedCaptions", { setOptions: defaultCCOptions});
 ```
-defaultCCOptions is a JSON object of various style options and its values
 When closing stream, detach decoder handle:
 ```
 XREReceiver.onEvent("onDecoderAvailable", { decoderHandle: null });
 ```
-Environments without the XREReceiver JS object may exist in future.  Applications may use alternate CC rendering methods to avoid dependency on XREReceiver object.
 
-To use, turn on nativeCCRendering init configuration value to true as follows:
+## Inband (CEA608/708) Closed Caption Management (modern UVE/AAMP API)
+
+Configure nativeCCRendering to true to signal use of subtec for caption rendering. 
 ```
 player.initConfig( { nativeCCRendering: true } );
+
 ```
 Toggle CC display on or off at runtime:
 ```
-player.setClosedCaptionStatus(true);
-player.setClosedCaptionStatus(false);
+player.setClosedCaptionStatus(true); // show captions (off by default)
+player.setClosedCaptionStatus(false); // mute captions
 ```
 Get/Set CC track at runtime:
 ```
-player.getTextTrack();
-player.setTextTrack(trackIndex);
-```
-Get/Set CC style options at runtime:
+player.getTextTrack(); // returns json object listing track attributes
+player.setTextTrack(trackIdentifier);
+
+Get/Set CC style options at runtime
 ```
-player.getTextStyleOptions();
-player.setTextStyleOptions(options);
+player.getTextStyleOptions(); // returns JSON object reflecting currently styling options
+player.setTextStyleOptions(options); // TODO: include examples known to work with RDK CC Manager and/or subtec
+
+On newer devices there is no need to call setTextStyleOptions, as the Text Track plugin will automatically map guide-configured caption styling.
+
 ```
-options in a JSON formatted string of style options and its values.
 
 ---
 

AampCMCDCollector.cpp

@@ -345,7 +345,7 @@ void AampCMCDCollector::CMCDSetNextRangeRequest(std::string nextrange,long bandw
 		{
 			CMCDHeaders *pCMCDMetrics = it->second;
 			std::string CMCDNextRangeRequest;
-			CMCDNextRangeRequest = nextrange;
+			CMCDNextRangeRequest = std::move(nextrange);
 			pCMCDMetrics->SetBitrate((int)(bandwidth/1000));
 			pCMCDMetrics->SetNextRange(CMCDNextRangeRequest);
 		}

AampConfig.cpp

@@ -328,7 +328,6 @@ static const ConfigLookupEntryBool mConfigLookupTableBool[AAMPCONFIG_BOOL_COUNT]
 	{false,"useSecManager",eAAMPConfig_UseSecManager, true},
 	{false,"enablePTO", eAAMPConfig_EnablePTO,false},
 	{true,"enableFogConfig", eAAMPConfig_EnableAampConfigToFog, false},
-	{false,"xreSupportedTune",eAAMPConfig_XRESupportedTune,false},
 	{DEFAULT_VALUE_GST_SUBTEC_ENABLED,"gstSubtecEnabled",eAAMPConfig_GstSubtecEnabled,false},
 	{true,"allowPageHeaders",eAAMPConfig_AllowPageHeaders,false},
 	{false,"persistHighNetworkBandwidth",eAAMPConfig_PersistHighNetworkBandwidth,false},
@@ -863,6 +862,10 @@ void AampConfig::ApplyDeviceCapabilities()
 
 	bool isSecMgr = isSecManagerEnabled();
 	SetConfigValue(AAMP_DEFAULT_SETTING, eAAMPConfig_UseSecManager, isSecMgr);
+	
+	bool isGstSubtec = SocUtils::isGstSubtecEnabled();
+	SetConfigValue(AAMP_DEFAULT_SETTING, eAAMPConfig_GstSubtecEnabled, isGstSubtec);
+	
 }
 
 std::string AampConfig::GetUserAgentString() const
@@ -1130,7 +1133,7 @@ bool AampConfig::ProcessConfigJson(const cJSON *cfgdata, ConfigPriority owner )
 						channelInfo.uri = url;
 						channelInfo.name = name;
 						channelInfo.licenseUri = licenseUrl;
-						mChannelOverrideMap.push_back(channelInfo);
+						mChannelOverrideMap.push_back(std::move(channelInfo));
 					}
 				}
 			}
@@ -1269,9 +1272,9 @@ bool AampConfig::CustomSearch( std::string url, int playerId , std::string appna
 	}
 	bool found = false;
 	AAMPLOG_INFO("url %s playerid %d appname %s ",url.c_str(),playerId,appname.c_str());
-	std::string url_custom = url;
+	std::string url_custom = std::move(url);
 	std::string playerId_custom = std::to_string(playerId);
-	std::string appName_custom = appname;
+	std::string appName_custom = std::move(appname);
 	std::string keyname;
 	std::string urlName = "url";
 	std::string player = "playerId";
@@ -1420,7 +1423,7 @@ void AampConfig::ProcessConfigText(std::string &cfg, ConfigPriority owner )
 						channelInfo.name = token;
 					}
 				}
-				mChannelOverrideMap.push_back(channelInfo);
+				mChannelOverrideMap.push_back(std::move(channelInfo));
 			}
 		}
 		else
@@ -1474,9 +1477,14 @@ bool AampConfig::ReadAampCfgJsonFile()
 			std::filebuf* pbuf = f.rdbuf();
 			std::size_t size = pbuf->pubseekoff (0,f.end,f.in);
 			pbuf->pubseekpos (0,f.in);
-			char* jsonbuffer=new char[size+1];
-			pbuf->sgetn (jsonbuffer,size);
-			jsonbuffer[size] = 0x00;
+			std::size_t size_with_nul = size+1;
+			char* jsonbuffer = NULL;
+			if( size_with_nul>0 )
+			{
+				jsonbuffer = new char[size_with_nul];
+				pbuf->sgetn (jsonbuffer,size);
+				jsonbuffer[size] = 0x00;
+			}
 			f.close();
 
 			if( jsonbuffer )
@@ -1899,8 +1907,8 @@ void AampConfig::DoCustomSetting(ConfigPriority owner)
 
 		sessionToken = GetConfigValue(eAAMPConfig_AuthToken);
 		SetConfigValue(AAMP_TUNE_SETTING,eAAMPConfig_AuthToken,sessionToken);
-		configValueString[eAAMPConfig_AuthToken].lastowner = tempowner;
-		configValueString[eAAMPConfig_AuthToken].lastvalue = tempvalue;
+		configValueString[eAAMPConfig_AuthToken].lastowner = std::move(tempowner);
+		configValueString[eAAMPConfig_AuthToken].lastvalue = std::move(tempvalue);
 
 	}
 	if(GetConfigValue(eAAMPConfig_InitialBuffer) > 0)

AampConfig.h

@@ -175,7 +175,6 @@ typedef enum
 	eAAMPConfig_UseSecManager,                                              /**< Enable/Disable secmanager instead of secclient for license acquisition */
 	eAAMPConfig_EnablePTO,								/**< Enable/Disable PTO Handling */
 	eAAMPConfig_EnableAampConfigToFog,                                      /**< Enable/Disable player config to Fog on every tune*/
-	eAAMPConfig_XRESupportedTune,						/**< Enable/Disable XRE supported tune*/
 	eAAMPConfig_GstSubtecEnabled,								/**< Force Gstreamer subtec */
 	eAAMPConfig_AllowPageHeaders,						/**< Allow page http headers*/
 	eAAMPConfig_PersistHighNetworkBandwidth,				/** Flag to enable Persist High Network Bandwidth across Tunes */

AampConstants.h

@@ -32,7 +32,5 @@
 #define CONSEC_AGNOSTIC_UUID "afbcb50e-bf74-3d13-be8f-13930c783962"
 #define VERIMATRIX_UUID "9a27dd82-fde2-4725-8cbc-4234aa06ec09"
 
-#define AAMP_MAX_PIPE_DATA_SIZE 1024    /**< Max size of data send across pipe */
-
 #endif /* __AAMP_CONSTANTS_H__ */
 

AampDRMLicPreFetcher.cpp

@@ -148,7 +148,7 @@ bool AampLicensePreFetcher::QueueContentProtection(DrmHelperPtr drmHelper, std::
 			if(isVssPeriod)
 			{
 				std::lock_guard<std::mutex>lock(mQVssMutex);
-				mVssFetchQueue.push_back(fetchObject);
+				mVssFetchQueue.push_back(std::move(fetchObject));
 				if (!mVssPreFetchThreadStarted)
 				{
 					AAMPLOG_WARN("Starting mVssPreFetchThread");
@@ -173,7 +173,7 @@ bool AampLicensePreFetcher::QueueContentProtection(DrmHelperPtr drmHelper, std::
 					return true;
 				}
 
-				mFetchQueue.push_back(fetchObject);
+				mFetchQueue.push_back(std::move(fetchObject));
 				if (!mPreFetchThreadStarted)
 				{
 					AAMPLOG_WARN("Starting mPreFetchThread");
@@ -443,7 +443,7 @@ void AampLicensePreFetcher::NotifyDrmFailure(LicensePreFetchObjectPtr fetchObj,
 			AAMPLOG_WARN("Drm failure:%d response: %d isRetryEnabled:%d ",(int)failure,event->getResponseCode(),isRetryEnabled);
 			mPrivAAMP->SendDRMMetaData(event);	//Send Header response first for failure case.
 			AAMPLOG_ERR("Failed DRM Session sending error event");
-			mPrivAAMP->SendDrmErrorEvent(event, isRetryEnabled);
+			mPrivAAMP->SendDrmErrorEvent(event, std::move(isRetryEnabled));
 			mPrivAAMP->profiler.SetDrmErrorCode((int)failure);
 			mPrivAAMP->profiler.ProfileError(PROFILE_BUCKET_LA_TOTAL, (int)failure);
 		}
@@ -460,8 +460,8 @@ void AampLicensePreFetcher::NotifyDrmFailure(LicensePreFetchObjectPtr fetchObj,
 bool AampLicensePreFetcher::CreateDRMSession(LicensePreFetchObjectPtr fetchObj)
 {
 	bool ret = false;
-
-	DrmMetaDataEventPtr e = std::make_shared<DrmMetaDataEvent>(AAMP_TUNE_FAILURE_UNKNOWN, "", 0, 0, mIsSecClientError, mPrivAAMP->GetSessionId());
+	bool isSecClientError = isSecFeatureEnabled();
+	DrmMetaDataEventPtr e = std::make_shared<DrmMetaDataEvent>(AAMP_TUNE_FAILURE_UNKNOWN, "", 0, 0, isSecClientError, mPrivAAMP->GetSessionId());
 
 	if (mPrivAAMP == nullptr)
 	{
@@ -471,7 +471,7 @@ bool AampLicensePreFetcher::CreateDRMSession(LicensePreFetchObjectPtr fetchObj)
 	if (fetchObj->mHelper == nullptr)
 	{
 		AAMPLOG_ERR("Failed DRM Session Creation,  no helper");
-		NotifyDrmFailure(fetchObj, e);
+		NotifyDrmFailure(std::move(fetchObj), std::move(e));
 		return ret;
 	}
 	AampDRMLicenseManager* licenseManger= mPrivAAMP->mDRMLicenseManager;
@@ -491,15 +491,15 @@ bool AampLicensePreFetcher::CreateDRMSession(LicensePreFetchObjectPtr fetchObj)
 	if(NULL == drmSession)
 	{
 		AAMPLOG_ERR("Failed DRM Session Creation for systemId = %s", fetchObj->mHelper->getUuid().c_str());
-		NotifyDrmFailure(fetchObj, e);
+		NotifyDrmFailure(std::move(fetchObj), std::move(e));
 	}
 	else
 	{
 		ret = true;
 		if(e->getAccessStatusValue() != 3)
 		{
 			AAMPLOG_INFO("Sending DRMMetaData");
-			mPrivAAMP->SendDRMMetaData(e);
+			mPrivAAMP->SendDRMMetaData(std::move(e));
 		}
 	}
 	mPrivAAMP->profiler.ProfileEnd(PROFILE_BUCKET_LA_TOTAL);

AampDRMLicPreFetcher.h

@@ -61,7 +61,7 @@ struct LicensePreFetchObject
 	 * @param type media type
 	 */
 	LicensePreFetchObject(DrmHelperPtr drmHelper, std::string periodId, uint32_t adapIdx, AampMediaType type, bool isVssPeriod): mHelper(drmHelper),
-															mPeriodId(periodId),
+															mPeriodId(std::move(periodId)),
 															mAdaptationIdx(adapIdx),
 															mType(type),
 															mId(staticId++),

AampDefine.h

@@ -30,8 +30,8 @@
 #define AAMP_CFG_PATH "/opt/aamp.cfg"
 #define AAMP_JSON_PATH "/opt/aampcfg.json"
 
-#define AAMP_VERSION "7.07"
-#define AAMP_TUNETIME_VERSION 6
+#define AAMP_VERSION "7.08"
+#define AAMP_TUNETIME_VERSION 7
 
 //Stringification of Macro : use two levels of macros
 #define MACRO_TO_STRING(s) X_STR(s)

AampEvent.cpp

@@ -160,7 +160,7 @@ ProgressEvent::ProgressEvent(double duration, double position, double start, dou
 		mEnd(end), mSpeed(speed), mPTS(pts),
 		mVideoBufferedDurationMs(videoBufferedDuration),
 		mAudioBufferedDurationMs(audioBufferedDuration),
-		mSEITimecode(seiTimecode),
+		mSEITimecode(std::move(seiTimecode)),
 		mLiveLatency(liveLatency),
 		mProfileBandwidth(profileBandwidth),
 		mNetworkBandwidth(networkBandwidth),
@@ -1036,7 +1036,7 @@ void DrmMetaDataEvent::ConvertToVerboseErrorCode(int32_t httpCode, int32_t httpE
 	mSecManagerClass = CONTENT_SECURITY_MANAGER_CLASS_RESULT_DRM_FAIL;
 	mSecManagerReasonCode = CONTENT_SECURITY_MANAGER_REASON_DRM_GENERAL_FAILURE;
 	//look for the correct code from the lookup
-	if (getAsVerboseErrorCode(httpCode, mSecManagerClass, mSecManagerReasonCode)) 
+	if (getAsVerboseErrorCode(httpCode, mSecManagerClass, mSecManagerReasonCode))
 	{
 		if(412 == httpCode && 401 == httpExtStatusCode) 
 		{