Source release v3.5.0

core/include/cdm_session.h

@@ -12,9 +12,11 @@
 #include "file_store.h"
 #include "initialization_data.h"
 #include "license.h"
+#include "metrics_collections.h"
 #include "oemcrypto_adapter.h"
 #include "policy_engine.h"
 #include "scoped_ptr.h"
+#include "timer_metric.h"
 #include "wv_cdm_types.h"
 
 namespace wvcdm {
@@ -22,25 +24,42 @@ namespace wvcdm {
 class CdmClientPropertySet;
 class ServiceCertificate;
 class WvCdmEventListener;
+class UsageTableHeader;
 
 class CdmSession {
  public:
-  CdmSession(FileSystem* file_system);
+  // Creates a new instance of the CdmSession with the given |file_system|
+  // and |metrics| parameters. Both parameters are owned by the caller and
+  // must remain in scope througout the scope of the new instance. |metrics|
+  // must not be null.
+  CdmSession(FileSystem* file_system, metrics::SessionMetrics* metrics);
   virtual ~CdmSession();
 
   void Close() { closed_ = true; }
   bool IsClosed() { return closed_; }
 
+  // Initializes this instance of CdmSession with the given property set.
+  // |cdm_client_property_set| MAY be null, is owned by the caller,
+  // and must remain in scope throughout the scope of this session.
   virtual CdmResponseType Init(CdmClientPropertySet* cdm_client_property_set);
-  virtual CdmResponseType Init(ServiceCertificate* service_certificate,
-                               CdmClientPropertySet* cdm_client_property_set,
+
+  // Initializes this instance of CdmSession with the given parmeters.
+  // All parameters are owned by the caller.
+  // |service_certificate| is caller owned, cannot be null, and must be in
+  //     scope as long as the session is in scope.
+  // |cdm_client_property_set| is caller owned, may be null, but must be
+  //     in scope as long as the session is in scope.
+  // |forced_session_id| is caller owned and may be null.
+  // |event_listener| is caller owned, may be null, but must be in scope
+  //     as long as the session is in scope.
+  virtual CdmResponseType Init(CdmClientPropertySet* cdm_client_property_set,
                                const CdmSessionId* forced_session_id,
                                WvCdmEventListener* event_listener);
 
   virtual CdmResponseType RestoreOfflineSession(
       const CdmKeySetId& key_set_id, const CdmLicenseType license_type);
   virtual CdmResponseType RestoreUsageSession(
-      const CdmKeyMessage& key_request, const CdmKeyResponse& key_response);
+      const DeviceFiles::CdmUsageData& usage_data);
 
   virtual const CdmSessionId& session_id() { return session_id_; }
   virtual const CdmKeySetId& key_set_id() { return key_set_id_; }
@@ -84,6 +103,8 @@ class CdmSession {
   // ReleaseKey() - Accept response and release key.
   virtual CdmResponseType ReleaseKey(const CdmKeyResponse& key_response);
 
+  virtual CdmResponseType DeleteUsageEntry(uint32_t usage_entry_number);
+
   virtual bool IsKeyLoaded(const KeyId& key_id);
   virtual int64_t GetDurationRemaining();
 
@@ -102,7 +123,8 @@ class CdmSession {
   // Delete usage information for the list of tokens, |provider_session_tokens|.
   virtual CdmResponseType DeleteMultipleUsageInformation(
       const std::vector<std::string>& provider_session_tokens);
-  virtual CdmResponseType UpdateUsageInformation();
+  virtual CdmResponseType UpdateUsageTableInformation();
+  virtual CdmResponseType UpdateUsageEntryInformation();
 
   virtual bool is_initial_usage_update() { return is_initial_usage_update_; }
   virtual bool is_usage_update_needed() { return is_usage_update_needed_; }
@@ -115,6 +137,13 @@ class CdmSession {
   virtual bool is_offline() { return is_offline_; }
   virtual bool is_temporary() { return is_temporary_; }
   virtual bool license_received() { return license_received_; }
+  virtual bool has_provider_session_token() {
+    return (license_parser_.get() != NULL &&
+        license_parser_->provider_session_token().size() > 0);
+  }
+
+  virtual CdmUsageSupportType get_usage_support_type()
+      { return usage_support_type_; }
 
   // ReleaseCrypto() - Closes the underlying crypto session but leaves this
   // object alive. It is invalid to call any method that requires a crypto
@@ -158,6 +187,8 @@ class CdmSession {
                                         CdmSigningAlgorithm algorithm,
                                         const std::string& signature);
 
+  virtual metrics::SessionMetrics* GetMetrics() { return metrics_; }
+
  private:
   friend class CdmSessionTest;
 
@@ -166,6 +197,8 @@ class CdmSession {
   CdmResponseType StoreLicense();
   bool StoreLicense(DeviceFiles::LicenseState state);
 
+  bool UpdateUsageInfo();
+
   // These setters are for testing only. Takes ownership of the pointers.
   void set_license_parser(CdmLicense* license_parser);
   void set_crypto_session(CryptoSession* crypto_session);
@@ -173,9 +206,14 @@ class CdmSession {
   void set_file_handle(DeviceFiles* file_handle);
 
   // instance variables
+  metrics::SessionMetrics* metrics_;
+  metrics::CryptoMetrics* crypto_metrics_;
+  metrics::TimerMetric life_span_;
+
   bool initialized_;
   bool closed_;  // Session closed, but final shared_ptr has not been released.
   CdmSessionId session_id_;
+  FileSystem* file_system_;
   scoped_ptr<CdmLicense> license_parser_;
   scoped_ptr<CryptoSession> crypto_session_;
   scoped_ptr<PolicyEngine> policy_engine_;
@@ -188,11 +226,18 @@ class CdmSession {
   SecurityLevel requested_security_level_;
   CdmAppParameterMap app_parameters_;
 
-  // decryption and usage flags
+  // decryption flags
   bool is_initial_decryption_;
   bool has_decrypted_since_last_report_;  // ... last report to policy engine.
+
+  // Usage related flags and data
   bool is_initial_usage_update_;
   bool is_usage_update_needed_;
+  CdmUsageSupportType usage_support_type_;
+  UsageTableHeader* usage_table_header_;
+  uint32_t usage_entry_number_;
+  CdmUsageEntry usage_entry_;
+  std::string usage_provider_session_token_;
 
   // information useful for offline and usage scenarios
   CdmKeyMessage key_request_;