RDKEMW-18059 : Player Failure observed with a "technical fault" OSM on performing HDMI unplug/replug

middleware/drm/DrmCallbacks.h

@@ -26,6 +26,7 @@
  */
 
 #include <string>
+#include "DrmSession.h"
 
 /**
  * @class DrmCallbacks
@@ -36,6 +37,7 @@ class DrmCallbacks
 public:
 	virtual void Individualization(const std::string& payload) = 0;
 	virtual void LicenseRenewal(DrmHelperPtr drmHelper, void* userData) = 0;
+	virtual void NotifyKeyStatus(PlayerKeyStatus keyStatus) = 0;
 	virtual ~DrmCallbacks() {};
 };
 

middleware/drm/DrmSession.h

@@ -32,6 +32,22 @@
 #include "DrmUtils.h"
 #include "ContentSecurityManagerSession.h"
 
+/**
+ * @enum PlayerKeyStatus
+ * @brief DRM key status values, independent of OCDM.
+ */
+typedef enum {
+	PLAYER_KEY_Usable = 0,
+	PLAYER_KEY_Expired,
+	PLAYER_KEY_Released,
+	PLAYER_KEY_OutputRestricted,
+	PLAYER_KEY_OutputRestrictedHDCP22,
+	PLAYER_KEY_OutputDownscaled,
+	PLAYER_KEY_StatusPending,
+	PLAYER_KEY_InternalError,
+	PLAYER_KEY_HWError
+} PlayerKeyStatus;
+
 using namespace std;
 
 #define PLAYREADY_KEY_SYSTEM_STRING "com.microsoft.playready"

middleware/drm/ocdm/opencdmsessionadapter.cpp

@@ -24,6 +24,23 @@
 #include "opencdmsessionadapter.h"
 
 #include "DrmHelper.h"
+
+/**
+ * @brief Convert OCDM KeyStatus to PlayerKeyStatus.
+ */
+static PlayerKeyStatus toPlayerKeyStatus(KeyStatus ocdmStatus) {
+	switch (ocdmStatus) {
+		case Usable:                 return PlayerKeyStatus::PLAYER_KEY_Usable;
+		case Expired:                return PlayerKeyStatus::PLAYER_KEY_Expired;
+		case Released:               return PlayerKeyStatus::PLAYER_KEY_Released;
+		case OutputRestricted:       return PlayerKeyStatus::PLAYER_KEY_OutputRestricted;
+		case OutputRestrictedHDCP22: return PlayerKeyStatus::PLAYER_KEY_OutputRestrictedHDCP22;
+		case OutputDownscaled:       return PlayerKeyStatus::PLAYER_KEY_OutputDownscaled;
+		case StatusPending:          return PlayerKeyStatus::PLAYER_KEY_StatusPending;
+		case HWError:                return PlayerKeyStatus::PLAYER_KEY_HWError;
+		case InternalError: default: return PlayerKeyStatus::PLAYER_KEY_InternalError;
+	}
+}
 #include "PlayerUtils.h"
 
 #include "ProcessHandler.h"
@@ -248,6 +265,10 @@ void OCDMSessionAdapter::keyUpdateOCDM(const uint8_t key[], const uint8_t keySiz
 void OCDMSessionAdapter::keysUpdatedOCDM() {
 	MW_LOG_INFO("at %p, with %p, %p", this , m_pOpenCDMSystem, m_pOpenCDMSession);
 	m_keyStatusReady.signal();
+	if (m_drmCallbacks && ((m_keyStatus == OutputRestricted) || (m_keyStatus == Usable) || (m_keyStatus == OutputRestrictedHDCP22) || (m_keyStatus == OutputDownscaled)))
+	{
+		m_drmCallbacks->NotifyKeyStatus(toPlayerKeyStatus(m_keyStatus));
+	}
 }
 
 

priv_aamp.cpp

@@ -11455,6 +11455,14 @@ void PrivateInstanceAAMP::Individualization(const std::string& payload)
 	SendEvent(event,AAMP_EVENT_ASYNC_MODE);
 }
 
+/**
+ * @brief DRM key status notification callback
+ */
+void PrivateInstanceAAMP::NotifyKeyStatus(PlayerKeyStatus keyStatus)
+{
+	AAMPLOG_WARN("NotifyKeyStatus: keyStatus=%d", static_cast<int>(keyStatus));
+}
+
 /**
  * @brief Get current initial buffer duration in seconds
  */

priv_aamp.h

@@ -1336,6 +1336,13 @@ class PrivateInstanceAAMP : public DrmCallbacks, public std::enable_shared_from_
 	 * @return void
 	 */
 	void LicenseRenewal(DrmHelperPtr drmHelper,void* userData) override;
+	/**
+	 * @fn NotifyKeyStatus
+	 *
+	 * @param[in] keyStatus - Key status received from OCDM
+	 * @return void
+	 */
+	void NotifyKeyStatus(PlayerKeyStatus keyStatus) override;
 	/**
 	 * @fn CurlTerm
 	 *

test/utests/drm/mocks/aampMocks.cpp

@@ -545,6 +545,11 @@ void PrivateInstanceAAMP::UnlockGetPositionMilliseconds()
 {
 }
 
+void PrivateInstanceAAMP::NotifyKeyStatus(PlayerKeyStatus keyStatus)
+{
+	(void)keyStatus;
+}
+
 void PrivateInstanceAAMP::SetPreferredLanguages(const char *, const char *, const char *,
 												const char *, const char *, const Accessibility *,
 												const char *)

test/utests/fakes/FakePrivateInstanceAAMP.cpp

@@ -688,6 +688,10 @@ void PrivateInstanceAAMP::UnlockGetPositionMilliseconds()
 {
 }
 
+void PrivateInstanceAAMP::NotifyKeyStatus(PlayerKeyStatus keyStatus)
+{
+}
+
 void PrivateInstanceAAMP::SetPreferredLanguages(char const*, char const*, char const*, char const*, char const*, const Accessibility*, char const*)
 {
 }
@@ -1913,4 +1917,4 @@ bool PrivateInstanceAAMP::CheckForChunkEarlyAbort(CurlCallbackContext *context)
 
 void PrivateInstanceAAMP::EnableLatencyMonitor(bool enabled)
 {
-}
+}