Report key request type in GenerateKeyRequest

Bug: 19771299

Merged from Widevine CDM repo:
https://widevine-internal-review.googlesource.com/#/c/13830/

Change-Id: Id9b4547febcabbb73a4be5dbb2e4c63b1c3eacd3

libwvdrmengine/cdm/core/include/cdm_engine.h

@@ -57,6 +57,9 @@ class CdmEngine {
   //                 and renewal requests.
   // key_request: This must be non-null and point to a CdmKeyMessage. The buffer
   //              will have its contents replaced with the key request.
+  // key_request_type: May be null. If it is non-null, it will be filled with
+  //                   key request type, whether it is an initial request,
+  //                   renewal request or release request etc.
   // server_url: This must be non-null and point to a string. The string will
   //             have its contents replaced with the default URL (if one is
   //             known) to send this key request to.
@@ -64,11 +67,14 @@ class CdmEngine {
   //                 will have its contents replaced with the key set ID of the
   //                 session. Note that for non-offline license requests, the
   //                 key set ID is empty, so the CdmKeySetId will be cleared.
+  // TODO(kqyang): Consider refactor GenerateKeyRequest to reduce the number of
+  // parameters.
   virtual CdmResponseType GenerateKeyRequest(
       const CdmSessionId& session_id, const CdmKeySetId& key_set_id,
       const InitializationData& init_data, const CdmLicenseType license_type,
       CdmAppParameterMap& app_parameters, CdmKeyMessage* key_request,
-      std::string* server_url, CdmKeySetId* key_set_id_out);
+      CdmKeyRequestType* key_request_type, std::string* server_url,
+      CdmKeySetId* key_set_id_out);
 
   // Accept license response and extract key info.
   virtual CdmResponseType AddKey(const CdmSessionId& session_id,

libwvdrmengine/cdm/core/include/cdm_session.h

@@ -37,7 +37,8 @@ class CdmSession {
   virtual CdmResponseType GenerateKeyRequest(
       const InitializationData& init_data, const CdmLicenseType license_type,
       const CdmAppParameterMap& app_parameters, CdmKeyMessage* key_request,
-      std::string* server_url, CdmKeySetId* key_set_id);
+      CdmKeyRequestType* key_request_type, std::string* server_url,
+      CdmKeySetId* key_set_id);
 
   // AddKey() - Accept license response and extract key info.
   virtual CdmResponseType AddKey(const CdmKeyResponse& key_response,

libwvdrmengine/cdm/core/include/wv_cdm_types.h

@@ -29,6 +29,13 @@ typedef std::string CdmUsageInfoReleaseMessage;
 typedef std::string CdmProvisioningRequest;
 typedef std::string CdmProvisioningResponse;
 
+enum CdmKeyRequestType {
+  kKeyRequestTypeUnknown,
+  kKeyRequestTypeInitial,
+  kKeyRequestTypeRenewal,
+  kKeyRequestTypeRelease,
+};
+
 enum CdmResponseType {
   NO_ERROR,
   UNKNOWN_ERROR,

libwvdrmengine/cdm/core/src/cdm_engine.cpp

@@ -166,7 +166,8 @@ CdmResponseType CdmEngine::GenerateKeyRequest(
     const CdmSessionId& session_id, const CdmKeySetId& key_set_id,
     const InitializationData& init_data, const CdmLicenseType license_type,
     CdmAppParameterMap& app_parameters, CdmKeyMessage* key_request,
-    std::string* server_url, CdmKeySetId* key_set_id_out) {
+    CdmKeyRequestType* key_request_type, std::string* server_url,
+    CdmKeySetId* key_set_id_out) {
   LOGI("CdmEngine::GenerateKeyRequest");
 
   CdmSessionId id = session_id;
@@ -217,9 +218,9 @@ CdmResponseType CdmEngine::GenerateKeyRequest(
     }
   }
 
-  sts =
-      iter->second->GenerateKeyRequest(init_data, license_type, app_parameters,
-                                       key_request, server_url, key_set_id_out);
+  sts = iter->second->GenerateKeyRequest(
+      init_data, license_type, app_parameters, key_request, key_request_type,
+      server_url, key_set_id_out);
 
   if (KEY_MESSAGE != sts) {
     if (sts == NEED_PROVISIONING) {

libwvdrmengine/cdm/core/src/cdm_session.cpp

@@ -154,7 +154,8 @@ CdmResponseType CdmSession::RestoreUsageSession(
 CdmResponseType CdmSession::GenerateKeyRequest(
     const InitializationData& init_data, const CdmLicenseType license_type,
     const CdmAppParameterMap& app_parameters, CdmKeyMessage* key_request,
-    std::string* server_url, CdmKeySetId* key_set_id) {
+    CdmKeyRequestType* key_request_type, std::string* server_url,
+    CdmKeySetId* key_set_id) {
   if (crypto_session_.get() == NULL) {
     LOGW("CdmSession::GenerateKeyRequest: Invalid crypto session");
     return UNKNOWN_ERROR;
@@ -182,10 +183,13 @@ CdmResponseType CdmSession::GenerateKeyRequest(
   }
 
   if (is_release_) {
+    if (key_request_type) *key_request_type = kKeyRequestTypeRelease;
     return GenerateReleaseRequest(key_request, server_url);
   } else if (license_received_) {  // renewal
+    if (key_request_type) *key_request_type = kKeyRequestTypeRenewal;
     return GenerateRenewalRequest(key_request, server_url);
   } else {
+    if (key_request_type) *key_request_type = kKeyRequestTypeInitial;
     if (!init_data.is_supported()) {
       LOGW("CdmSession::GenerateKeyRequest: unsupported init data type (%s)",
            init_data.type().c_str());

libwvdrmengine/cdm/core/test/cdm_engine_test.cpp

@@ -85,10 +85,12 @@ class WvCdmEngineTest : public testing::Test {
 
     InitializationData init_data(init_data_type_string, key_id);
 
-    EXPECT_EQ(KEY_MESSAGE,
-              cdm_engine_.GenerateKeyRequest(
-                  session_id_, key_set_id, init_data, kLicenseTypeStreaming,
-                  app_parameters, &key_msg_, &server_url, NULL));
+    CdmKeyRequestType key_request_type;
+    EXPECT_EQ(KEY_MESSAGE, cdm_engine_.GenerateKeyRequest(
+                               session_id_, key_set_id, init_data,
+                               kLicenseTypeStreaming, app_parameters, &key_msg_,
+                               &key_request_type, &server_url, NULL));
+    EXPECT_EQ(kKeyRequestTypeInitial, key_request_type);
   }
 
   void GenerateRenewalRequest() {