Add latency info to input events sent to RenderWidget.

content/browser/renderer_host/render_widget_host_impl.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 CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_IMPL_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_IMPL_H_
 
 #include <deque>
 #include <list>
 #include <map>
 #include <queue>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/process_util.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "build/build_config.h"
+#include "cc/debug/latency_info.h"
 #include "content/common/view_message_enums.h"
 #include "content/port/common/input_event_ack_state.h"
 #include "content/public/browser/render_widget_host.h"
 #include "content/public/common/page_zoom.h"
 #include "ipc/ipc_listener.h"
 #include "ui/base/ime/text_input_type.h"
 #include "ui/gfx/native_widget_types.h"
 
 class WebCursor;
 struct AcceleratedSurfaceMsg_BufferPresented_Params;
@@ skipping 24 matching lines @@
 
 #if defined(OS_ANDROID)
 namespace WebKit {
 class WebLayer;
 }
 #endif
 
 namespace content {
 class BackingStore;
 class GestureEventFilter;
+class GestureEventLatency;
 class MockRenderWidgetHost;
 class OverscrollController;
 class RenderWidgetHostDelegate;
 class RenderWidgetHostViewPort;
 class SmoothScrollGesture;
 class TouchEventQueue;
 struct EditCommand;
 
 // This implements the RenderWidgetHost interface that is exposed to
 // embedders of content, and adds things only visible to content.
@@ skipping 166 matching lines @@
   // Stops all existing hang monitor timeouts and assumes the renderer is
   // responsive.
   void StopHangMonitorTimeout();
 
   // Forwards the given message to the renderer. These are called by the view
   // when it has received a message.
   void ForwardGestureEvent(const WebKit::WebGestureEvent& gesture_event);
   virtual void ForwardTouchEvent(const WebKit::WebTouchEvent& touch_event);
 
   // Forwards the given event immediately to the renderer.
-  void ForwardMouseEventImmediately(const WebKit::WebMouseEvent& mouse_event);
+  void ForwardMouseEventImmediately(const WebKit::WebMouseEvent& mouse_event,
+                                    const cc::LatencyInfo& latency_info);
   void ForwardTouchEventImmediately(const WebKit::WebTouchEvent& touch_event);
   void ForwardGestureEventImmediately(
       const WebKit::WebGestureEvent& gesture_event);
 
   void CancelUpdateTextDirection();
 
   // Called when a mouse click/gesture tap activates the renderer.
   virtual void OnPointerEventActivate();
 
   // Notifies the renderer whether or not the input method attached to this
@@ skipping 185 matching lines @@
 
   int SyntheticScrollMessageInterval() const;
 
   // Sets whether the overscroll controller should be enabled for this page.
   void SetOverscrollControllerEnabled(bool enabled);
 
   // Suppreses future char events until a keydown. See
   // suppress_next_char_events_.
   void SuppressNextCharEvents();
 
+  void FrameSwapped(const cc::LatencyInfo& latency_info);
+
+  // Returns the ID that uniquely describes this component to the latency
+  // subsystem.
+  int64 GetLatencyComponentId();
+
+  class FrameSwappedObserver {

[piman, 2013/04/22 20:46:38]

There doesn't seem to be any implementation of this in this patch - is this
"FrameSwapped" infrastructure for a later patch? Can you remove it from this
one, so that we can review that part later, in context?

+   public:
+    virtual void OnFrameSwapped(RenderWidgetHostImpl* rwhi,
+                                const cc::LatencyInfo& latency_info) = 0;
+  };
+
+  void AddFrameSwappedObserver(FrameSwappedObserver* observer);
+  void RemoveFrameSwappedObserver(FrameSwappedObserver* observer);
+
  protected:
   virtual RenderWidgetHostImpl* AsRenderWidgetHostImpl() OVERRIDE;
 
   // Transmits the given input event. This is an internal helper for
   // |ForwardInputEvent()| and should not be used directly from elsewhere.
   void SendInputEvent(const WebKit::WebInputEvent& input_event,
-                      int event_size, bool is_keyboard_shortcut);
+                      int event_size, const cc::LatencyInfo& latency_info,
+                      bool is_keyboard_shortcut);
 
   // Internal implementation of the public Forward*Event() methods.
   void ForwardInputEvent(const WebKit::WebInputEvent& input_event,
-                         int event_size, bool is_keyboard_shortcut);
+                         int event_size, const cc::LatencyInfo& latency_info,
+                         bool is_keyboard_shortcut);
+
+  // Internal forwarding implementations that take a LatencyInfo.
+  virtual void ForwardMouseEventWithLatencyInfo(
+      const WebKit::WebMouseEvent& mouse_event,
+      const cc::LatencyInfo& latency_info);
+  virtual void ForwardWheelEventWithLatencyInfo(
+      const WebKit::WebMouseWheelEvent& wheel_event,
+      const cc::LatencyInfo& latency_info);
+
+  // Create a LatencyInfo struct for a new input event that was just received.
+  cc::LatencyInfo NewInputLatencyInfo();
 
   // Called when we receive a notification indicating that the renderer
   // process has gone. This will reset our state so that our state will be
   // consistent if a new renderer is created.
   void RendererExited(base::TerminationStatus status, int exit_code);
 
   // Retrieves an id the renderer can use to refer to its view.
   // This is used for various IPC messages, including plugins.
   gfx::NativeViewId GetNativeViewId() const;
 
@@ skipping 250 matching lines @@
   gfx::Rect last_view_screen_rect_;
   gfx::Rect last_window_screen_rect_;
 
   // True if a mouse move event was sent to the render view and we are waiting
   // for a corresponding ViewHostMsg_HandleInputEvent_ACK message.
   bool mouse_move_pending_;
 
   // The next mouse move event to send (only non-null while mouse_move_pending_
   // is true).
   scoped_ptr<WebKit::WebMouseEvent> next_mouse_move_;
+  cc::LatencyInfo next_mouse_move_latency_info_;
 
   // (Similar to |mouse_move_pending_|.) True if a mouse wheel event was sent
   // and we are waiting for a corresponding ack.
   bool mouse_wheel_pending_;
   WebKit::WebMouseWheelEvent current_wheel_event_;
 
-  typedef std::deque<WebKit::WebMouseWheelEvent> WheelEventQueue;
+  typedef std::deque<std::pair<WebKit::WebMouseWheelEvent, cc::LatencyInfo> >

[piman, 2013/04/22 20:46:38]

nit: rather than a std::pair, an explicit struct is a lot more readable at the
call sites ("event", "latency_info" as fields instead of "first" and "second")

+      WheelEventQueue;
 
   // (Similar to |next_mouse_move_|.) The next mouse wheel events to send.
   // Unlike mouse moves, mouse wheel events received while one is pending are
   // coalesced (by accumulating deltas) if they match the previous event in
   // modifiers. On the Mac, in particular, mouse wheel events are received at a
   // high rate; not waiting for the ack results in jankiness, and using the same
   // mechanism as for mouse moves (just dropping old events when multiple ones
   // would be queued) results in very slow scrolling.
   WheelEventQueue coalesced_mouse_wheel_events_;
 
@@ skipping 111 matching lines @@
   scoped_ptr<GestureEventFilter> gesture_event_filter_;
   scoped_ptr<OverscrollController> overscroll_controller_;
 
 #if defined(OS_WIN)
   std::list<HWND> dummy_windows_for_activation_;
 #endif
 
   // List of callbacks for pending snapshot requests to the renderer.
   std::queue<base::Callback<void(bool, const SkBitmap&)> > pending_snapshots_;
 
+  int64 last_input_number_;
+
+  ObserverList<FrameSwappedObserver> frame_swapped_observer_list_;
+
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_IMPL_H_