Plugin Power Saver: Improve Poster behavior for essential plugins.

content/public/renderer/render_frame.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 CONTENT_PUBLIC_RENDERER_RENDER_FRAME_H_
 #define CONTENT_PUBLIC_RENDERER_RENDER_FRAME_H_
 
 #include "base/callback_forward.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
@@ skipping 11 matching lines @@
 class WebLocalFrame;
 class WebNode;
 class WebPlugin;
 class WebURLRequest;
 class WebURLResponse;
 struct WebPluginParams;
 }
 
 namespace gfx {
 class Range;
+class Size;
 }
 
 namespace url {
 class Origin;
 }
 
 namespace v8 {
 template <typename T> class Local;
 class Context;
 class Isolate;
 }
 
 namespace content {
 class ContextMenuClient;
 class PluginInstanceThrottler;
 class RenderView;
 class ServiceRegistry;
 struct ContextMenuParams;
 struct WebPluginInfo;
 struct WebPreferences;
 
 // This interface wraps functionality, which is specific to frames, such as
 // navigation. It provides communication with a corresponding RenderFrameHost
 // in the browser process.
 class CONTENT_EXPORT RenderFrame : public IPC::Listener,
                                    public IPC::Sender {
  public:
+  // These numeric values are used in UMA logs; do not change them.
+  enum PeripheralContentStatus {
+    // Content is peripheral because it doesn't meet any of the below criteria.
+    CONTENT_STATUS_PERIPHERAL = 0,
+    // Content is essential because it's same-origin with the top-level frame.
+    CONTENT_STATUS_ESSENTIAL_SAME_ORIGIN = 1,
+    // Content is essential even though it's cross-origin, because it's large.
+    CONTENT_STATUS_ESSENTIAL_CROSS_ORIGIN_BIG = 2,
+    // Content is essential because there's large content from the same origin.
+    CONTENT_STATUS_ESSENTIAL_CROSS_ORIGIN_WHITELISTED = 3,
+    // Content is essential because it's tiny in size.
+    CONTENT_STATUS_ESSENTIAL_CROSS_ORIGIN_TINY = 4,
+    // Content is essential because it has an unknown size.
+    CONTENT_STATUS_ESSENTIAL_UNKNOWN_SIZE = 5,
+    // Must be last.
+    CONTENT_STATUS_NUM_ITEMS
+  };
+
   // Returns the RenderFrame given a WebFrame.
   static RenderFrame* FromWebFrame(blink::WebFrame* web_frame);
 
   // Returns the RenderFrame given a routing id.
   static RenderFrame* FromRoutingID(int routing_id);
 
   // Returns the RenderView associated with this frame.
   virtual RenderView* GetRenderView() = 0;
 
   // Get the routing ID of the frame.
@@ skipping 55 matching lines @@
   virtual ServiceRegistry* GetServiceRegistry() = 0;
 
 #if defined(ENABLE_PLUGINS)
   // Registers a plugin that has been marked peripheral. If the origin
   // whitelist is later updated and includes |content_origin|, then
   // |unthrottle_callback| will be called.
   virtual void RegisterPeripheralPlugin(
       const url::Origin& content_origin,
       const base::Closure& unthrottle_callback) = 0;
 
-  // Returns true if this plugin should have power saver enabled.
+  // Returns the peripheral content heuristic decision.
   //
   // Power Saver is enabled for plugin content that are cross-origin and
   // heuristically determined to be not essential to the web page content.
   //
   // Plugin content is defined to be cross-origin when the plugin source's
   // origin differs from the top level frame's origin. For example:
   //  - Cross-origin:  a.com -> b.com/plugin.swf
   //  - Cross-origin:  a.com -> b.com/iframe.html -> b.com/plugin.swf
   //  - Same-origin:   a.com -> b.com/iframe-to-a.html -> a.com/plugin.swf
   //
   // |main_frame_origin| is the origin of the main frame.
   //
   // |content_origin| is the origin of the plugin content.
   //
-  // |width| and |height| are zoom and device scale independent logical pixels.
-  //
-  // |cross_origin_main_content| may be NULL. It is set to true if the
-  // plugin content is cross-origin but still the "main attraction" of the page.
-  virtual bool ShouldThrottleContent(const url::Origin& main_frame_origin,
-                                     const url::Origin& content_origin,
-                                     int width,
-                                     int height,
-                                     bool* cross_origin_main_content) const = 0;
+  // |unobscured_size| are zoom and device scale independent logical pixels.
+  virtual PeripheralContentStatus GetPeripheralContentStatus(
+      const url::Origin& main_frame_origin,
+      const url::Origin& content_origin,
+      const gfx::Size& unobscured_size) const = 0;
 
   // Whitelists a |content_origin| so its content will never be throttled in
   // this RenderFrame. Whitelist is cleared by top level navigation.
   virtual void WhitelistContentOrigin(const url::Origin& content_origin) = 0;
 #endif
 
   // Returns true if this frame is a FTP directory listing.
   virtual bool IsFTPDirectoryListing() = 0;
 
   // Attaches the browser plugin identified by |element_instance_id| to guest
@@ skipping 29 matching lines @@
 
  private:
   // This interface should only be implemented inside content.
   friend class RenderFrameImpl;
   RenderFrame() {}
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_RENDERER_RENDER_FRAME_H_