RDKTV-32538: The HDMI volume Icon is not smooth

Reason for change: Optimize Audio Status Request on Volume Key Press
Test Procedure: refer the ticket
Risks: None
Signed-off-by: Neethu A S [email protected]

Author: Neethu379

HdmiCecSink/HdmiCecSink.cpp

@@ -75,6 +75,7 @@
 #define HDMICECSINK_NUMBER_TV_ADDR 					2
 #define HDMICECSINK_UPDATE_POWER_STATUS_INTERVA_MS    (60 * 1000)
 #define HDMISINK_ARC_START_STOP_MAX_WAIT_MS           4000
+#define HDMICECSINK_UPDATE_AUDIO_STATUS_INTERVAL_MS    500
 
 
 #define SAD_FMT_CODE_AC3 2
@@ -173,10 +174,8 @@ static std::vector<RcProfile> rcProfile = {RC_PROFILE_TV};
 static std::vector<DeviceFeatures> deviceFeatures = {DEVICE_FEATURES_TV};
 
 #define API_VERSION_NUMBER_MAJOR 1
-#define API_VERSION_NUMBER_MINOR 3
-#define API_VERSION_NUMBER_PATCH 8
-
-using PowerState = WPEFramework::Exchange::IPowerManager::PowerState;
+#define API_VERSION_NUMBER_MINOR 4
+#define API_VERSION_NUMBER_PATCH 0
 
 namespace WPEFramework
 {
@@ -710,7 +709,10 @@ namespace WPEFramework
 		   m_currentActiveSource = -1;
 		   m_isHdmiInConnected = false;
 		   hdmiCecAudioDeviceConnected = false;
-		   m_audioDevicePowerStatusRequested = false;
+		   m_isAudioStatusInfoUpdated = false;
+		   m_audioStatusReceived = false;
+		   m_audioStatusTimerStarted = false;
+                   m_audioDevicePowerStatusRequested = false;
 		   m_pollNextState = POLL_THREAD_STATE_NONE;
 		   m_pollThreadState = POLL_THREAD_STATE_NONE;
 		   m_video_latency = DEFAULT_VIDEO_LATENCY;
@@ -758,6 +760,8 @@ namespace WPEFramework
            m_semSignaltoArcRoutingThread.acquire();
            m_arcRoutingThread = std::thread(threadArcRouting);
 
+	   m_audioStatusDetectionTimer.connect( std::bind( &HdmiCecSink::audioStatusTimerFunction, this ) );
+	   m_audioStatusDetectionTimer.setSingleShot(true);
            m_arcStartStopTimer.connect( std::bind( &HdmiCecSink::arcStartStopTimerFunction, this ) );
            m_arcStartStopTimer.setSingleShot(true);
             // get power state:
@@ -1146,6 +1150,18 @@ namespace WPEFramework
             JsonObject params;
             if(!HdmiCecSink::_instance)
                return;
+	    if (m_audioStatusTimerStarted)
+	    {
+		    m_audioStatusReceived = true;
+		    m_isAudioStatusInfoUpdated = true;
+		    m_audioStatusTimerStarted = false;
+		    if (m_audioStatusDetectionTimer.isActive())
+		    {
+			    LOGINFO("AudioStatus received from the Audio Device and the timer is still active. So stopping the timer!\n");
+			    m_audioStatusDetectionTimer.stop();
+		    }
+		    LOGINFO("AudioStatus received from the Audio Device. Updating the AudioStatus info! m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ", m_isAudioStatusInfoUpdated,m_audioStatusReceived,m_audioStatusTimerStarted);
+	    }
 			LOGINFO("Command: ReportAudioStatus  %s audio Mute status %d  means %s  and current Volume level is %d \n",GetOpName(msg.opCode()),msg.status.getAudioMuteStatus(),msg.status.toString().c_str(),msg.status.getAudioVolume());
             params["muteStatus"]  = msg.status.getAudioMuteStatus();
             params["volumeLevel"] = msg.status.getAudioVolume();
@@ -2476,7 +2492,14 @@ namespace WPEFramework
                                         params["status"] = string("success");
                                         params["audioDeviceConnected"] = string("false");
 					hdmiCecAudioDeviceConnected = false;
-                                        sendNotify(eventString[HDMICECSINK_EVENT_AUDIO_DEVICE_CONNECTED_STATUS], params);
+					if (m_audioStatusDetectionTimer.isActive()){
+						m_audioStatusDetectionTimer.stop();
+					}
+					m_isAudioStatusInfoUpdated = false;
+					m_audioStatusReceived = false;
+					m_audioStatusTimerStarted = false;
+					LOGINFO("Audio device removed, reset the audio status info.  m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ", m_isAudioStatusInfoUpdated,m_audioStatusReceived,m_audioStatusTimerStarted);
+                                        sendNotify(eventString[HDMICECSINK_EVENT_AUDIO_DEVICE_CONNECTED_STATUS], params)
                                 }
 
 				_instance->deviceList[logicalAddress].m_isRequestRetry = 0;
@@ -3093,6 +3116,14 @@ namespace WPEFramework
 
 	    m_logicalAddressAllocated = LogicalAddress::UNREGISTERED;
             m_currentArcRoutingState = ARC_STATE_ARC_TERMINATED;
+	    if (m_audioStatusDetectionTimer.isActive()){
+			    m_audioStatusDetectionTimer.stop();
+	    }
+	    m_isAudioStatusInfoUpdated = false;
+	    m_audioStatusReceived = false;
+	    m_audioStatusTimerStarted = false;
+	    LOGINFO("CEC Disabled, reset the audio status info. m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ", m_isAudioStatusInfoUpdated,m_audioStatusReceived,m_audioStatusTimerStarted);
+
 
 	    for(int i=0; i< 16; i++)
             {
@@ -3348,12 +3379,43 @@ namespace WPEFramework
 
 		    if((_instance->m_SendKeyQueue.size()<=1 || (_instance->m_SendKeyQueue.size() % 2 == 0)) && ((keyInfo.keyCode == VOLUME_UP) || (keyInfo.keyCode == VOLUME_DOWN) || (keyInfo.keyCode == MUTE)) )
 		    {
-		        _instance->sendGiveAudioStatusMsg();
-		    }
+			if(keyInfo.keyCode == MUTE)
+			{
+				_instance->sendGiveAudioStatusMsg();
+			}
+			else
+			{
+				LOGINFO("m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ",_instance->m_isAudioStatusInfoUpdated,_instance->m_audioStatusReceived,_instance->m_audioStatusTimerStarted);
+				if (!_instance->m_isAudioStatusInfoUpdated)
+				{
+					if ( !(_instance->m_audioStatusDetectionTimer.isActive()))
+					{
+						LOGINFO("Audio status info not updated. Starting the Timer!");
+						_instance->m_audioStatusTimerStarted = true;
+						_instance->m_audioStatusDetectionTimer.start((HDMICECSINK_UPDATE_AUDIO_STATUS_INTERVAL_MS));
+					}
+					LOGINFO("m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ", _instance->m_isAudioStatusInfoUpdated,_instance->m_audioStatusReceived,_instance->m_audioStatusTimerStarted);
+				}
+				else
+				{
+					if (!_instance->m_audioStatusReceived){
+						_instance->sendGiveAudioStatusMsg();
+					}
+				}
+			}
+		}
 
             }//while(!_instance->m_sendKeyEventThreadExit)
         }//threadSendKeyEvent
 
+	void HdmiCecSink::audioStatusTimerFunction()
+	{
+		m_audioStatusTimerStarted = false;
+		m_isAudioStatusInfoUpdated = true;
+		LOGINFO("Timer Expired. Requesting the AudioStatus since not received.\n");
+		sendGiveAudioStatusMsg();
+		LOGINFO("m_isAudioStatusInfoUpdated :%d, m_audioStatusReceived :%d, m_audioStatusTimerStarted:%d ", m_isAudioStatusInfoUpdated,m_audioStatusReceived,m_audioStatusTimerStarted);
+	}
 
         void HdmiCecSink::threadArcRouting()
         {

HdmiCecSink/HdmiCecSink.h

@@ -668,6 +668,9 @@ namespace WPEFramework {
             /* Send Key event related */
             bool m_sendKeyEventThreadExit;
             bool m_sendKeyEventThreadRun;
+	    bool m_isAudioStatusInfoUpdated;
+	    bool m_audioStatusReceived;
+	    bool m_audioStatusTimerStarted;
             std::thread m_sendKeyEventThread;
             std::mutex m_sendKeyEventMutex;
             std::queue<SendKeyInfo> m_SendKeyQueue;
@@ -686,6 +689,7 @@ namespace WPEFramework {
 	    binary_semaphore m_semSignaltoArcRoutingThread;
             bool m_arcstarting;
             TpTimer m_arcStartStopTimer;
+	    TpTimer m_audioStatusDetectionTimer;
 
             Connection *smConnection;
 			std::vector<uint8_t> m_connectedDevices;
@@ -732,6 +736,7 @@ namespace WPEFramework {
             void Send_Request_Arc_Termination_Message();
             void Send_Report_Arc_Terminated_Message();
             void arcStartStopTimerFunction();
+	    void audioStatusTimerFunction();
 	    void getCecVersion();
         };
 	} // namespace Plugin