CdmAdapter: Add UMA for output protection queries and results.

media/cdm/ppapi/cdm_adapter.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef MEDIA_CDM_PPAPI_CDM_ADAPTER_H_
 #define MEDIA_CDM_PPAPI_CDM_ADAPTER_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 88 matching lines @@
       const char* challenge, uint32_t challenge_length) OVERRIDE;
   virtual void EnableOutputProtection(
       uint32_t desired_protection_mask) OVERRIDE;
   virtual void QueryOutputProtectionStatus() OVERRIDE;
   virtual void OnDeferredInitializationDone(
       cdm::StreamType stream_type,
       cdm::Status decoder_status) OVERRIDE;
   virtual cdm::FileIO* CreateFileIO(cdm::FileIOClient* client) OVERRIDE;
 
  private:
+  // These are reported to UMA server. Do not change the existing values!
+  enum OutputProtectionStatus {
+    OUTPUT_PROTECTION_QUERIED = 0,

[ddorwin, 2014/04/30 23:13:35]

It seems odd to have the "total" value in the same UMA. Shouldn't it be a
separate count?

[xhwang, 2014/04/30 23:48:16]

Agreed. But that makes it harder to dig out data. Also, UMA_Private doesn't
provide a way to send counts yet :(

https://code.google.com/p/chromium/codesearch#chromium/src/ppapi/cpp/private/...

+    OUTPUT_PROTECTION_QUERY_ERROR = 1,

[ddorwin, 2014/04/30 23:13:35]

This is not "positive". Should we just consider this negative and ignore it?

[xhwang, 2014/04/30 23:48:16]

Done.

+    OUTPUT_PROTECTION_NO_EXTERNAL_LINK = 2,
+    OUTPUT_PROTECTION_ALL_EXTERNAL_LINKS_PROTECTED = 3,
+    OUTPUT_PROTECTION_MAX = 4
+  };
+
   typedef linked_ptr<DecryptedBlockImpl> LinkedDecryptedBlock;
   typedef linked_ptr<VideoFrameImpl> LinkedVideoFrame;
   typedef linked_ptr<AudioFramesImpl> LinkedAudioFrames;
 
   bool CreateCdmInstance(const std::string& key_system);
 
   // <code>PPB_ContentDecryptor_Private</code> dispatchers. These are passed to
   // <code>callback_factory_</code> to ensure that calls into
   // <code>PPP_ContentDecryptor_Private</code> are asynchronous.
   void SendSessionCreatedInternal(int32_t result,
@@ skipping 39 matching lines @@
   bool IsValidVideoFrame(const LinkedVideoFrame& video_frame);
 
 #if !defined(NDEBUG)
   // Logs the given message to the JavaScript console associated with the
   // CDM adapter instance. The name of the CDM adapter issuing the log message
   // will be automatically prepended to the message.
   void LogToConsole(const pp::Var& value);
 #endif  // !defined(NDEBUG)
 
 #if defined(OS_CHROMEOS)
+  void ReportOutputProtectionStatus(OutputProtectionStatus status);
+  void ReportOutputProtectionQueryResult(int32_t result);
+
   void SendPlatformChallengeDone(int32_t result);
   void EnableProtectionDone(int32_t result);
   void QueryOutputProtectionStatusDone(int32_t result);
 
   pp::OutputProtection_Private output_protection_;
   pp::PlatformVerification platform_verification_;
 
   // Since PPAPI doesn't provide handlers for CompletionCallbacks with more than
   // one output we need to manage our own.  These values are only read by
   // SendPlatformChallengeDone().
   pp::Var signed_data_output_;
   pp::Var signed_data_signature_output_;
   pp::Var platform_key_certificate_output_;
   bool challenge_in_progress_;
 
   // Same as above, these are only read by QueryOutputProtectionStatusDone().
   uint32_t output_link_mask_;
   uint32_t output_protection_mask_;
   bool query_output_protection_in_progress_;
+
+  // We report the following stats to UMA:
+  // - Whether output protection has been queried.
+  // - Whether a positive result (no unprotected external link) is returned.

[ddorwin, 2014/04/30 23:13:35]

What about QUERY_ERROR? That's not positive.

"Whether" seems wrong. We report queries and positive results (+ query errors)

[xhwang, 2014/04/30 23:48:16]

Done.

+  // The following two variables help track the status of the UMA reporting.
+  bool uma_for_output_protection_query_reported_;
+  bool uma_for_output_protection_positive_result_reported_;
 #endif
 
   PpbBufferAllocator allocator_;
   pp::CompletionCallbackFactory<CdmAdapter> callback_factory_;
   linked_ptr<CdmWrapper> cdm_;
   std::string key_system_;
 
   // If the CDM returned kDeferredInitialization during InitializeAudioDecoder()
   // or InitializeVideoDecoder(), the (Audio|Video)DecoderConfig.request_id is
   // saved for the future call to OnDeferredInitializationDone().
   bool deferred_initialize_audio_decoder_;
   uint32_t deferred_audio_decoder_config_id_;
   bool deferred_initialize_video_decoder_;
   uint32_t deferred_video_decoder_config_id_;
 
   DISALLOW_COPY_AND_ASSIGN(CdmAdapter);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_CDM_PPAPI_CDM_ADAPTER_H_