VPLAY-11213 [VIPA] No need to reset TSB when Closed Caption Lang changed (#581)

VPLAY-11213 [VIPA] No need to reset TSB when Closed Caption Lang changed

Reason for Change: With in-band subtitles then all subtitle tracks are in the video segments and stored in the local TSB. Changing closed caption language does not need the TSB to be reset. I.E a tune does not need to happen

Test Guidance: Refer Ticket

Risk: Low

Signed-off-by: Philip Stroffolino <[email protected]>

Author: cpc005

priv_aamp.cpp

@@ -12503,7 +12503,7 @@ void PrivateInstanceAAMP::SetPreferredTextLanguages(const char *param)
 			{
 				/**< Avoid retuning in case of HEMIIN and COMPOSITE IN*/
 			}
-			else if (isSelectionChange) /**< call the tune only if there is a change in the language, rendition or accessibility.*/
+			else if (isSelectionChange && closedCaptionTrackId == -1) /* dont tune if we are using closedCaptions*/
 			{
 				discardEnteringLiveEvt = true;
 				mOffsetFromTunetimeForSAPWorkaround = (double)(aamp_GetCurrentTimeMS() / 1000) - mLiveOffset;
@@ -12563,12 +12563,11 @@ void PrivateInstanceAAMP::SetPreferredTextLanguages(const char *param)
 					discardEnteringLiveEvt = false;
 				}
 				ReleaseStreamLock();
-
-				if (closedCaptionTrackId >= 0)
-				{
-					TextTrackInfo track = trackInfo[closedCaptionTrackId];
-					SetClosedCaptionsFromTextTrack(track);
-				}
+			}
+			if (closedCaptionTrackId >= 0)
+			{
+				TextTrackInfo track = trackInfo[closedCaptionTrackId];
+				SetClosedCaptionsFromTextTrack(track);
 			}
 		}
 	}

priv_aamp.h

@@ -599,6 +599,14 @@ class PrivateInstanceAAMP : public DrmCallbacks, public std::enable_shared_from_
 	 * @return index of closed caption track otherwise -1 if not found
 	 */
 	int FindClosedCaptionTrackIndex(const std::vector<TextTrackInfo> &trackInfo) const;
+	/**
+	 * @fn CheckPreferredTextLanguages
+	 * @param[in] trackInfo - Text track information
+	 * @param[out] isSelectionChange true if preferences now select a different track to the current selection
+ 	 * @param[out] isAvailableInManifest true if new selection is available in the manifest
+	 * @param[out] closedCaptionTrackIdx - closed caption track index
+	 */
+	void CheckPreferredTextLanguages(const std::vector<TextTrackInfo> &trackInfo,bool &isInManifest, bool &isPresent, int &closedCaptionTrackIdx);
 
 public:
 	/* @fn RecalculatePTS
@@ -859,14 +867,6 @@ class PrivateInstanceAAMP : public DrmCallbacks, public std::enable_shared_from_
 	 * This function is invoked continuously when ever there is an update in manifest
 	 */
 	void updateManifest(const char *manifestData);
-	/**
-	 * @fn CheckPreferredTextLanguages
-	 * @param[in] trackInfo - Text track information
-	 * @param[out] isSelectionChange true if preferences now select a different track to the current selection
- 	 * @param[out] isAvailableInManifest true if new selection is available in the manifest
-	 * @param[out] closedCaptionTrackIdx - closed caption track index
-	 */
-	void CheckPreferredTextLanguages(const std::vector<TextTrackInfo> &trackInfo,bool &isInManifest, bool &isPresent, int &closedCaptionTrackIdx);
 
 	bool mDiscontinuityFound;
 	int mTelemetryInterval;

test/utests/tests/PreferredLanguages/SetPreferredTextLanguagesTests.cpp

@@ -783,8 +783,8 @@ TEST_F(SetPreferredTextLanguagesTests, ChangePrefTextLangWithTSB)
 
 /**
  * @brief Change between closed caption tracks
- * Check that a new closed caption track is selected in PlayerCCManager
- * There will be a channel change but this will be removed in future change
+ * Check that a new closed caption track is selected in PlayerCCManagerBase
+ * Check that there is no tune (Stop) called on StreamAbstractionAAMP
  */
 TEST_F(SetPreferredTextLanguagesTests, ClosedCaptionTest1)
 {
@@ -803,9 +803,7 @@ TEST_F(SetPreferredTextLanguagesTests, ClosedCaptionTest1)
 
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, GetAvailableTextTracks(_))
 		.WillOnce(ReturnRef(tracks));
-	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_))
-		.WillOnce(Invoke(this, &SetPreferredTextLanguagesTests::Stop));
-
+	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_)).Times(0);
 	EXPECT_CALL(*g_mockPlayerCCManager, SetTrack("CC1",eCLOSEDCAPTION_FORMAT_608)).Times(1).WillRepeatedly(Return(0));
 
 	mPrivateInstanceAAMP->SetPreferredTextLanguages("lang1");
@@ -871,33 +869,3 @@ TEST_F(SetPreferredTextLanguagesTests, Accessibility2)
 	mPrivateInstanceAAMP->SetPreferredTextLanguages("{\"accessibility\":{\"scheme\":\"return_from_mock\",\"string_value\":\"return_from_mock\"}}");
 
 }
-/**
- * @brief Test new func pulled out through refactoring.
- * changing between closed caption tracks
- */
-TEST_F(SetPreferredTextLanguagesTests, CheckPreferredTextLanguages1)
-{
-	std::vector<TextTrackInfo> tracks;
-
-	//TextTrackInfo(std::string idx, std::string lang, bool cc, std::string rend, std::string trackName, std::string id, std::string cha, int pk):
-	tracks.push_back(TextTrackInfo("idx0", "lang0", true, "rend0", "trackName0", "CC0", "cha0", 0));
-	tracks.push_back(TextTrackInfo("idx1", "lang1", true, "rend1", "trackName1", "CC1", "cha1", 1));
-
-	bool isSelectionChange = false;
-	bool isAvailableInManifest = false;
-	int closedCaptionTrackId = -1;
-
-	/*
-	 * The mock for GetTextTrack() will return 0 I.E the first entry in tracks
-	 * set preferred language to lang1 so a change is expected
-	 */
-	mPrivateInstanceAAMP->preferredTextLanguagesString = "lang1";
-	mPrivateInstanceAAMP->preferredTextLanguagesList.clear();
-	mPrivateInstanceAAMP->preferredTextLanguagesList.push_back("lang1");
-	mPrivateInstanceAAMP->subtitles_muted = false;
-
-	mPrivateInstanceAAMP->CheckPreferredTextLanguages(tracks, isAvailableInManifest, isSelectionChange, closedCaptionTrackId);
-
-	EXPECT_EQ(isAvailableInManifest, true);
-	EXPECT_EQ(isSelectionChange, true);
-}