Feature/vplay 11969 text lang bug fix

AampCacheHandler.cpp

@@ -59,23 +59,19 @@ void AampCacheHandler::StopPlaylistCache( void )
 	mCondVar.notify_one();
 }
 
-bool AampCacheHandler::RetrieveFromPlaylistCache( const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType  )
+bool AampCacheHandler::RetrieveFromPlaylistCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType)
 {
 	bool ret = false;
 	std::lock_guard<std::mutex> lock(mCacheAccessMutex);
 	AampCachedData *cachedData = mPlaylistCache.Find(url);
-	if( cachedData )
+	if (cachedData)
 	{
-		effectiveUrl = cachedData->effectiveUrl;
-		if( effectiveUrl.empty() )
-		{
-			effectiveUrl = url;
-		}
+		effectiveUrl = cachedData->effectiveUrl.empty() ? url : cachedData->effectiveUrl;
 		buffer->Clear();
-		buffer->AppendBytes( cachedData->buffer->GetPtr(), cachedData->buffer->GetLen() );
+		buffer->AppendBytes(cachedData->buffer->GetPtr(), cachedData->buffer->GetLen());
 		// below fails when playing an HLS playlist directly, then seeking or retuning
 		// assert( mediaType == cachedData->mediaType );
-		AAMPLOG_TRACE( "%s %s found", GetMediaTypeName(cachedData->mediaType), url.c_str() );
+		AAMPLOG_TRACE("%s %s found", GetMediaTypeName(cachedData->mediaType), url.c_str());
 		ret = true;
 	}
 	else
@@ -119,24 +115,17 @@ void AampCacheHandler::InsertToInitFragCache( const std::string &url, const Aamp
 	mInitFragmentCache.Insert( url, buffer, effectiveUrl, mediaType );
 }
 
-bool AampCacheHandler::RetrieveFromInitFragmentCache(const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl)
+bool AampCacheHandler::RetrieveFromInitFragmentCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl)
 {
 	bool ret = false;
 	std::lock_guard<std::mutex> lock(mCacheAccessMutex);
 	AampCachedData *cachedData = mInitFragmentCache.Find(url);
-	if( cachedData )
+	if (cachedData)
 	{
 		std::shared_ptr<AampGrowableBuffer> buf = cachedData->buffer;
-		if (cachedData->effectiveUrl.empty())
-		{
-			effectiveUrl = url;
-		}
-		else
-		{
-			effectiveUrl = cachedData->effectiveUrl;
-		}
+		effectiveUrl = cachedData->effectiveUrl.empty() ? url : cachedData->effectiveUrl;
 		buffer->Clear();
-		buffer->AppendBytes( buf->GetPtr(), buf->GetLen() );
+		buffer->AppendBytes(buf->GetPtr(), buf->GetLen());
 		AAMPLOG_INFO("%s %s found", GetMediaTypeName(cachedData->mediaType), url.c_str());
 		ret = true;
 	}

AampCacheHandler.h

@@ -447,7 +447,7 @@ class AampCacheHandler
 	 *   @param[out] effectiveUrl - Final URL
 	 *   @return true: found, false: not found
 	 */
-	bool RetrieveFromPlaylistCache( const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType );
+	bool RetrieveFromPlaylistCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType);
 
 	/**
 	 * @brief Remove playlist from cache
@@ -493,7 +493,7 @@ class AampCacheHandler
 	 *
 	 *   @return true: found, false: not found
 	 */
-	bool RetrieveFromInitFragmentCache(const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl);
+	bool RetrieveFromInitFragmentCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl);
 
 	/**
 	*   @brief set max initialization fragments allowed in cache (per track)

StreamAbstractionAAMP.h

@@ -1909,6 +1909,14 @@ class StreamAbstractionAAMP : public AampLicenseFetcher
 	 */
 	void SetCurrentAudioTrackIndex(std::string& index) { mAudioTrackIndex = index; }
 
+	/**
+	 *   @brief Set current text track index
+	 *
+	 *   @param[in] string index
+	 *   @return void
+	 */
+	void SetCurrentTextTrackIndex(std::string& index);
+
 	/**
 	 *   @brief Change muxed audio track index
 	 *

fragmentcollector_hls.cpp

@@ -3450,19 +3450,26 @@ AAMPStatusType StreamAbstractionAAMP_HLS::Init(TuneType tuneType)
 				// Generate audio and text track structures
 				PopulateAudioAndTextTracks();
 
-				// Select preferred text track based on user language preferences
-				TextTrackInfo selectedTextTrack;
-				if (SelectPreferredTextTrack(selectedTextTrack))
+				if (aamp->GetPreferredTextTrack().index.empty())
 				{
-					AAMPLOG_INFO("Selected text track - lang:%s, name:%s, rendition:%s",
-								 selectedTextTrack.language.c_str(),
-								 selectedTextTrack.name.c_str(),
-								 selectedTextTrack.rendition.c_str());
-					aamp->SetPreferredTextTrack(std::move(selectedTextTrack));
+					// Select preferred text track based on user language preferences
+					TextTrackInfo selectedTextTrack;
+					if (SelectPreferredTextTrack(selectedTextTrack))
+					{
+						AAMPLOG_INFO("Selected text track - lang:%s, name:%s, rendition:%s",
+									 selectedTextTrack.language.c_str(),
+									 selectedTextTrack.name.c_str(),
+									 selectedTextTrack.rendition.c_str());
+						aamp->SetPreferredTextTrack(std::move(selectedTextTrack));
+					}
+					else
+					{
+						AAMPLOG_WARN("No text track matched user preferences, will use default selection");
+					}
 				}
 				else
 				{
-					AAMPLOG_WARN("No text track matched user preferences, will use default selection");
+					AAMPLOG_INFO("Preferred text track set, so not looking at the list of preferred languages");
 				}
 
 				// Configure Subtitle track for the playback
@@ -7593,6 +7600,7 @@ void StreamAbstractionAAMP_HLS::SelectSubtitleTrack()
 bool StreamAbstractionAAMP_HLS::SelectPreferredTextTrack(TextTrackInfo &selectedTextTrack)
 {
 	std::vector<TextTrackInfo> availableTracks = GetAvailableTextTracks();
+
 	if (availableTracks.empty())
 	{
 		AAMPLOG_WARN("No text tracks available");

priv_aamp.cpp

@@ -12607,6 +12607,8 @@ void PrivateInstanceAAMP::SetPreferredTextLanguages(const char *param)
 			if (closedCaptionTrackId >= 0)
 			{
 				TextTrackInfo track = trackInfo[closedCaptionTrackId];
+				SetPreferredTextTrack(track); // If we found the track via CheckPreferredTextLanguages() it may not be the current preferred text track
+				mpStreamAbstractionAAMP->SetCurrentTextTrackIndex(track.index); // Normally set as part of parsing the manifest during tune, but if we don't tune we should keep it consistent
 				SetClosedCaptionsFromTextTrack(track);
 			}
 		}

streamabstraction.cpp

@@ -3824,6 +3824,15 @@ bool StreamAbstractionAAMP::GetCurrentTextTrack(TextTrackInfo &textTrack)
 	}
 	return bFound;
 }
+
+/**
+ *   @brief Set current text track index
+ */
+void StreamAbstractionAAMP::SetCurrentTextTrackIndex(std::string& index)
+{
+	mTextTrackIndex = index;
+}
+
 /**
 *   @brief verify in-band CC availability for a stream.
 */

test/utests/fakes/FakeAampCacheHandler.cpp

@@ -39,7 +39,7 @@ void AampCacheHandler::StopPlaylistCache()
 {
 }
 
-bool AampCacheHandler::RetrieveFromPlaylistCache(const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType)
+bool AampCacheHandler::RetrieveFromPlaylistCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl, AampMediaType mediaType)
 {
     return false;
 }
@@ -65,7 +65,7 @@ void AampCacheHandler::InsertToInitFragCache( const std::string &url, const Aamp
 {
 }
 
-bool AampCacheHandler::RetrieveFromInitFragmentCache(const std::string &url, AampGrowableBuffer* buffer, std::string& effectiveUrl)
+bool AampCacheHandler::RetrieveFromInitFragmentCache(std::string url, AampGrowableBuffer* buffer, std::string& effectiveUrl)
 {
     return false;
 }

test/utests/fakes/FakeStreamAbstractionAamp.cpp

@@ -111,6 +111,14 @@ bool StreamAbstractionAAMP::GetCurrentTextTrack(TextTrackInfo &textTrack)
 	return 0;
 }
 
+void StreamAbstractionAAMP::SetCurrentTextTrackIndex(std::string& index)
+{
+	if (g_mockStreamAbstractionAAMP != nullptr)
+	{
+		g_mockStreamAbstractionAAMP->SetCurrentTextTrackIndex(index);
+	}
+}
+
 bool StreamAbstractionAAMP::isInBandCcAvailable()
 {
 	return 0;

test/utests/mocks/MockStreamAbstractionAAMP.h

@@ -98,6 +98,8 @@ class MockStreamAbstractionAAMP : public StreamAbstractionAAMP
 	MOCK_METHOD(bool, DoEarlyStreamSinkFlush, (bool newTune, float rate), (override));
 
 	MOCK_METHOD(void, ReinitializeInjection, (double rate));
+
+	MOCK_METHOD(void, SetCurrentTextTrackIndex, (std::string& index));
 };
 
 extern MockStreamAbstractionAAMP *g_mockStreamAbstractionAAMP;

test/utests/tests/PreferredLanguages/SetPreferredTextLanguagesTests.cpp

@@ -255,6 +255,11 @@ TEST_F(SetPreferredTextLanguagesTests, LanguageListTest2)
 	EXPECT_STREQ(mPrivateInstanceAAMP->preferredTextLanguagesString.c_str(), "lang1");
 	EXPECT_EQ(mPrivateInstanceAAMP->preferredTextLanguagesList.size(), 1);
 	EXPECT_STREQ(mPrivateInstanceAAMP->preferredTextLanguagesList.at(0).c_str(), "lang1");
+
+	/* Verify SetPreferredTextTrack() was called and stored the track */
+	const TextTrackInfo& preferredTrack = mPrivateInstanceAAMP->GetPreferredTextTrack();
+	EXPECT_STREQ(preferredTrack.language.c_str(), "lang0");
+	EXPECT_STREQ(preferredTrack.index.c_str(), "idx0");
 }
 
 /**
@@ -452,14 +457,13 @@ TEST_F(SetPreferredTextLanguagesTests, RenditionTest1)
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, SelectPreferredTextTrack(_))
 		.WillOnce(::testing::DoAll(::testing::SetArgReferee<0>(tracks[0]),Return(true)));
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_))
-		.Times(1);
+		.WillOnce(Invoke(this, &SetPreferredTextLanguagesTests::Stop));
 	EXPECT_CALL(*g_mockAampGstPlayer, Flush(_,_,_))
 		.Times(1);
 	mPrivateInstanceAAMP->SetPreferredTextLanguages("{\"rendition\":\"rend0\"}");
 
 	/* Verify the preferred rendition list. */
 	EXPECT_STREQ(mPrivateInstanceAAMP->preferredTextRenditionString.c_str(), "rend0");
-	g_mockStreamAbstractionAAMP = NULL;
 }
 
 /**
@@ -710,6 +714,9 @@ TEST_F(SetPreferredTextLanguagesTests, SetTsbSessionManagerNull)
 
 	// This test sets IsLocalAAMPTsb=true, so the mock is not deleted by the code-under-test.
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_)).WillRepeatedly(Return());
+
+	EXPECT_CALL(*g_mockStreamAbstractionAAMP, SetCurrentTextTrackIndex(_))
+		.Times(1);
 
 	testp_aamp->SetPreferredTextLanguages("{\"languages\":\"lang1\"}");
 
@@ -763,6 +770,10 @@ TEST_F(SetPreferredTextLanguagesTests, ChangePrefTextLangWithTSB)
 		.WillOnce(::testing::DoAll(::testing::SetArgReferee<0>(tracks[0]),Return(true)));
 	// This test sets IsLocalAAMPTsb=true, so the mock is not deleted by the code-under-test.
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_)).Times(2).WillRepeatedly(Return());
+
+	// SetCurrentTextTrackIndex is called in TSB scenarios
+	EXPECT_CALL(*g_mockStreamAbstractionAAMP, SetCurrentTextTrackIndex(_))
+		.Times(1);
 
 	testp_aamp->SetPreferredTextLanguages("{\"languages\":\"lang1\"}");
 
@@ -805,6 +816,10 @@ TEST_F(SetPreferredTextLanguagesTests, ClosedCaptionTest1)
 		.WillOnce(ReturnRef(tracks));
 	EXPECT_CALL(*g_mockStreamAbstractionAAMP, Stop(_)).Times(0);
 	EXPECT_CALL(*g_mockPlayerCCManager, SetTrack("CC1",eCLOSEDCAPTION_FORMAT_608)).Times(1).WillRepeatedly(Return(0));
+
+	// SetCurrentTextTrackIndex is called for closed caption track changes
+	EXPECT_CALL(*g_mockStreamAbstractionAAMP, SetCurrentTextTrackIndex(_))
+		.Times(1);
 
 	mPrivateInstanceAAMP->SetPreferredTextLanguages("lang1");
 
@@ -813,6 +828,12 @@ TEST_F(SetPreferredTextLanguagesTests, ClosedCaptionTest1)
 	EXPECT_EQ(mPrivateInstanceAAMP->preferredTextLanguagesList.size(), 1);
 	EXPECT_STREQ(mPrivateInstanceAAMP->preferredTextLanguagesList.at(0).c_str(), "lang1");
 
+	/* Verify SetPreferredTextTrack() was called and stored the track */
+	const TextTrackInfo& preferredTrack = mPrivateInstanceAAMP->GetPreferredTextTrack();
+	EXPECT_STREQ(preferredTrack.language.c_str(), "lang1");
+	EXPECT_STREQ(preferredTrack.index.c_str(), "idx1");
+	EXPECT_TRUE(preferredTrack.isCC);
+
 }
 
 /**