Pepper API implementation for output protection.

chromeos/display/output_configurator.h

 // Copyright (c) 2012 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 CHROMEOS_DISPLAY_OUTPUT_CONFIGURATOR_H_
 #define CHROMEOS_DISPLAY_OUTPUT_CONFIGURATOR_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/event_types.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/observer_list.h"
 #include "base/timer/timer.h"
 #include "chromeos/chromeos_export.h"
 #include "third_party/cros_system_api/dbus/service_constants.h"
 
 // Forward declarations for Xlib and Xrandr.
 // This is so unused X definitions don't pollute the namespace.
 typedef unsigned long XID;
 typedef XID RROutput;
 typedef XID RRCrtc;
 typedef XID RRMode;
 
+namespace chrome {
+class PepperOutputProtectionHost;

[Daniel Erat, 2013/09/18 22:39:16]

this doesn't appear to be used here

[kcwu, 2013/09/20 03:03:47]

Done.

+}  // namespace chrome
+
 namespace chromeos {
 
 // Used to describe the state of a multi-display configuration.
 enum OutputState {
   STATE_INVALID,
   STATE_HEADLESS,
   STATE_SINGLE,
   STATE_DUAL_MIRROR,
   STATE_DUAL_EXTENDED,
 };
 
+// Video output link types.

[marcheu, 2013/09/18 23:21:35]

The terminology "link" isn't used in this code, can we replace this with just
"output"?

[kcwu, 2013/09/20 03:03:47]

Done.

+enum OutputLinkType {
+  OUTPUT_LINK_TYPE_NONE = 0,
+  OUTPUT_LINK_TYPE_UNKNOWN = 1 << 0,
+  OUTPUT_LINK_TYPE_INTERNAL = 1 << 1,
+  OUTPUT_LINK_TYPE_VGA = 1 << 2,
+  OUTPUT_LINK_TYPE_HDMI = 1 << 3,
+  OUTPUT_LINK_TYPE_DVI = 1 << 4,
+  OUTPUT_LINK_TYPE_DISPLAYPORT = 1 << 5,
+};
+

[marcheu, 2013/09/18 23:21:35]

Same here, we just use the term "output", not "output link".

[kcwu, 2013/09/20 03:03:47]

Done.

+// Content protection methods applied on video output link.
+enum OutputProtectionMethod {
+  OUTPUT_PROTECTION_METHOD_NONE = 0,
+  OUTPUT_PROTECTION_METHOD_HDCP = 1 << 0,
+};
+
 // This class interacts directly with the underlying Xrandr API to manipulate
 // CTRCs and Outputs.
 class CHROMEOS_EXPORT OutputConfigurator
     : public base::MessageLoop::Dispatcher,
       public base::MessagePumpObserver {
  public:
   struct ModeInfo {
     ModeInfo();
     ModeInfo(int width, int height, bool interlaced);
 
@@ skipping 162 matching lines @@
     // |touch_device_id| the ID of the touchscreen device to configure.
     // |ctm| contains the desired transformation parameters.  The offsets
     // in it should be normalized so that 1 corresponds to the X or Y axis
     // size for the corresponding offset.
     virtual void ConfigureCTM(int touch_device_id,
                               const CoordinateTransformation& ctm) = 0;
 
     // Sends a D-Bus message to the power manager telling it that the
     // machine is or is not projecting.
     virtual void SendProjectingStateToPowerManager(bool projecting) = 0;
+
+    // Register a client for output protection and request a client id. Returns

[Daniel Erat, 2013/09/18 22:39:16]

nit: make these verbs match the tense in other comments (Registers, Unregisters,
Queries, etc.)

[kcwu, 2013/09/20 03:03:47]

Done.

+    // 0 if requesting failed.
+    virtual uint64_t RegisterOutputProtectionClient() = 0;

[Daniel Erat, 2013/09/18 22:39:16]

mind typedef-ing uint64_t to something like OutputProtectionClientId?

also document that the server doesn't need to be grabbed for this.

[kcwu, 2013/09/20 03:03:47]

Done.

+    // Unregister the client.

[Daniel Erat, 2013/09/18 22:39:16]

nit: please add blank lines between methods

[kcwu, 2013/09/20 03:03:47]

Done.

+    virtual void UnregisterOutputProtectionClient(uint64_t client_id) = 0;

[Daniel Erat, 2013/09/18 22:39:16]

document that the server _does_ need to be grabbed for this.

[kcwu, 2013/09/20 03:03:47]

This is done in output_configurator.cc

+    // Query link status and protection status. Returns true on success.
+    virtual bool QueryOutputProtectionStatus(
+        uint64_t client_id,
+        uint32_t* link_mask,
+        uint32_t* protection_mask) = 0;
+
+    // Request the desired protection methods. Returns true when the protection
+    // request has been made.
+    virtual bool EnableOutputProtection(
+        uint64_t client_id,
+        uint32_t desired_method_mask) = 0;

[Daniel Erat, 2013/09/18 22:39:16]

what does |desired_method_mask| contain? if it's or-ed OutputProtectionMethod
values, please rename it to |protection_mask| to match
QueryOutputProtectionStatus()

[kcwu, 2013/09/20 03:03:47]

This follows the naming in ppapi/api/private/ppb_output_protection_private.idl

   };
 
   // Helper class used by tests.
   class TestApi {
    public:
     TestApi(OutputConfigurator* configurator, int xrandr_event_base)
         : configurator_(configurator),
           xrandr_event_base_(xrandr_event_base) {}
     ~TestApi() {}
 
@@ skipping 110 matching lines @@
   void ResumeDisplays();
 
   const std::map<int, float>& GetMirroredDisplayAreaRatioMap() {
     return mirrored_display_area_ratio_map_;
   }
 
   // Configure outputs with |kConfigureDelayMs| delay,
   // so that time-consuming ConfigureOutputs() won't be called multiple times.
   void ScheduleConfigureOutputs();
 
+  // Register a client for output protection and request a client id. Returns
+  // 0 if requesting failed.
+  uint64_t RegisterOutputProtectionClient();

[Daniel Erat, 2013/09/18 22:39:16]

nit: please add comments between these methods too

[kcwu, 2013/09/20 03:03:47]

Do you mean blank line?

+  // Unregister the client.
+  void UnregisterOutputProtectionClient(uint64_t client_id);
+  // Query link status and protection status.
+  // |link_mask| is the type of connected output links, which is a bitmask
+  // of PP_OutputProtectionLinkType_Private values. |protection_mask| is the
+  // desired protection methods, which is a bitmask of the
+  // PP_OutputProtectionMethod_Private values.

[Daniel Erat, 2013/09/18 22:39:16]

are the masks actually PP_*_Private values, or are they the enums that are
defined above?

[kcwu, 2013/09/20 03:03:47]

Done.
Ah, forgot to change this. PP_*_Private values are identical to enums defined
here.

+  // Returns true on success.
+  bool QueryOutputProtectionStatus(
+      uint64_t client_id,
+      uint32_t* link_mask,
+      uint32_t* protection_mask);
+
+  // Request the desired protection methods.
+  // |protection_mask| is the desired protection methods, which is a bitmask
+  // of the PP_OutputProtectionMethod_Private values.
+  // Returns true when the protection request has been made.
+  bool EnableOutputProtection(
+      uint64_t client_id,
+      uint32_t desired_method_mask);
+
  private:
   // Configure outputs.
   void ConfigureOutputs();
 
   // Notifies observers about an attempted state change.
   void NotifyObservers(bool success, OutputState attempted_state);
 
   // Switches to the state specified in |output_state| and |power_state|.
   // If the hardware mirroring failed and |mirroring_controller_| is set,
   // it switches to |STATE_DUAL_EXTENDED| and calls |SetSoftwareMirroring()|
@@ skipping 68 matching lines @@
   scoped_ptr<base::OneShotTimer<OutputConfigurator> > configure_timer_;
 
   DISALLOW_COPY_AND_ASSIGN(OutputConfigurator);
 };
 
 typedef std::vector<OutputConfigurator::OutputSnapshot> OutputSnapshotList;
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DISPLAY_OUTPUT_CONFIGURATOR_H_