Bug 753453. Add a way for us to pass a high-res timestamp to requestAnimationFrame callbacks. r=roc

Author: bzbarsky

content/base/public/nsIDocument.h

@@ -94,6 +94,7 @@ class DOMImplementation;
 class Element;
 struct ElementRegistrationOptions;
 class EventTarget;
+class FrameRequestCallback;
 class GlobalObject;
 class HTMLBodyElement;
 class Link;
@@ -1772,11 +1773,14 @@ class nsIDocument : public nsINode
 
   virtual already_AddRefed<mozilla::dom::UndoManager> GetUndoManager() = 0;
 
-  nsresult ScheduleFrameRequestCallback(nsIFrameRequestCallback* aCallback,
+  typedef mozilla::dom::CallbackObjectHolder<
+    mozilla::dom::FrameRequestCallback,
+    nsIFrameRequestCallback> FrameRequestCallbackHolder;
+  nsresult ScheduleFrameRequestCallback(const FrameRequestCallbackHolder& aCallback,
                                         int32_t *aHandle);
   void CancelFrameRequestCallback(int32_t aHandle);
 
-  typedef nsTArray< nsCOMPtr<nsIFrameRequestCallback> > FrameRequestCallbackList;
+  typedef nsTArray<FrameRequestCallbackHolder> FrameRequestCallbackList;
   /**
    * Put this document's frame request callbacks into the provided
    * list, and forget about them.
@@ -2369,29 +2373,7 @@ class nsIDocument : public nsINode
 
   nsCOMPtr<nsIDocumentEncoder> mCachedEncoder;
 
-  struct FrameRequest {
-    FrameRequest(nsIFrameRequestCallback* aCallback,
-                 int32_t aHandle) :
-      mCallback(aCallback),
-      mHandle(aHandle)
-    {}
-
-    // Conversion operator so that we can append these to a
-    // FrameRequestCallbackList
-    operator nsIFrameRequestCallback* const () const { return mCallback; }
-
-    // Comparator operators to allow RemoveElementSorted with an
-    // integer argument on arrays of FrameRequest
-    bool operator==(int32_t aHandle) const {
-      return mHandle == aHandle;
-    }
-    bool operator<(int32_t aHandle) const {
-      return mHandle < aHandle;
-    }
-    
-    nsCOMPtr<nsIFrameRequestCallback> mCallback;
-    int32_t mHandle;
-  };
+  struct FrameRequest;
 
   nsTArray<FrameRequest> mFrameRequestCallbacks;
 

content/base/src/nsDocument.cpp

@@ -1302,6 +1302,35 @@ nsDOMStyleSheetSetList::GetSets(nsTArray<nsString>& aStyleSets)
   return NS_OK;
 }
 
+// ==================================================================
+
+struct nsIDocument::FrameRequest
+{
+  FrameRequest(const FrameRequestCallbackHolder& aCallback,
+               int32_t aHandle) :
+    mCallback(aCallback),
+    mHandle(aHandle)
+  {}
+
+  // Conversion operator so that we can append these to a
+  // FrameRequestCallbackList
+  operator const FrameRequestCallbackHolder& () const {
+    return mCallback;
+  }
+
+  // Comparator operators to allow RemoveElementSorted with an
+  // integer argument on arrays of FrameRequest
+  bool operator==(int32_t aHandle) const {
+    return mHandle == aHandle;
+  }
+  bool operator<(int32_t aHandle) const {
+    return mHandle < aHandle;
+  }
+
+  FrameRequestCallbackHolder mCallback;
+  int32_t mHandle;
+};
+
 // ==================================================================
 // =
 // ==================================================================
@@ -1720,7 +1749,7 @@ NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INTERNAL(nsDocument)
 
   for (uint32_t i = 0; i < tmp->mFrameRequestCallbacks.Length(); ++i) {
     NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(cb, "mFrameRequestCallbacks[i]");
-    cb.NoteXPCOMChild(tmp->mFrameRequestCallbacks[i]);
+    cb.NoteXPCOMChild(tmp->mFrameRequestCallbacks[i].mCallback.GetISupports());
   }
 
   // Traverse animation components
@@ -8736,7 +8765,7 @@ nsIDocument::CreateStaticClone(nsISupports* aCloneContainer)
 }
 
 nsresult
-nsIDocument::ScheduleFrameRequestCallback(nsIFrameRequestCallback* aCallback,
+nsIDocument::ScheduleFrameRequestCallback(const FrameRequestCallbackHolder& aCallback,
                                           int32_t *aHandle)
 {
   if (mFrameRequestCallbackCounter == INT32_MAX) {

dom/base/nsGlobalWindow.cpp

@@ -4341,7 +4341,8 @@ nsGlobalWindow::MozRequestAnimationFrame(nsIFrameRequestCallback* aCallback,
   if (mJSObject)
     js::NotifyAnimationActivity(mJSObject);
 
-  return mDoc->ScheduleFrameRequestCallback(aCallback, aHandle);
+  nsIDocument::FrameRequestCallbackHolder holder(aCallback);
+  return mDoc->ScheduleFrameRequestCallback(holder, aHandle);
 }
 
 NS_IMETHODIMP

dom/webidl/DummyBinding.webidl

@@ -19,6 +19,7 @@ interface DummyInterface {
   void funcHttpConnDict(optional HttpConnDict arg);
   void funcWebSocketDict(optional WebSocketDict arg);
   void funcDNSCacheDict(optional DNSCacheDict arg);
+  void frameRequestCallback(FrameRequestCallback arg);
 };
 
 interface DummyInterfaceWorkers {

dom/webidl/WebIDL.mk

@@ -308,6 +308,7 @@ webidl_files = \
   URLUtils.webidl \
   USSDReceivedEvent.webidl \
   VideoStreamTrack.webidl \
+  Window.webidl \
   XMLDocument.webidl \
   XMLHttpRequest.webidl \
   XMLHttpRequestEventTarget.webidl \

dom/webidl/Window.webidl

@@ -0,0 +1,10 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * The origin of this IDL file is:
+ * https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/RequestAnimationFrame/Overview.html
+ */
+
+callback FrameRequestCallback = void (DOMHighResTimeStamp time);

layout/base/nsRefreshDriver.cpp

@@ -42,6 +42,8 @@
 #include "nsViewManager.h"
 #include "GeckoProfiler.h"
 #include "nsNPAPIPluginInstance.h"
+#include "nsPerformance.h"
+#include "mozilla/dom/WindowBinding.h"
 
 using mozilla::TimeStamp;
 using mozilla::TimeDuration;
@@ -816,6 +818,15 @@ nsRefreshDriver::DoTick()
   }
 }
 
+struct DocumentFrameCallbacks {
+  DocumentFrameCallbacks(nsIDocument* aDocument) :
+    mDocument(aDocument)
+  {}
+
+  nsCOMPtr<nsIDocument> mDocument;
+  nsIDocument::FrameRequestCallbackList mCallbacks;
+};
+
 void
 nsRefreshDriver::Tick(int64_t aNowEpoch, TimeStamp aNowTime)
 {
@@ -873,19 +884,41 @@ nsRefreshDriver::Tick(int64_t aNowEpoch, TimeStamp aNowTime)
 
     if (i == 0) {
       // Grab all of our frame request callbacks up front.
-      nsIDocument::FrameRequestCallbackList frameRequestCallbacks;
+      nsTArray<DocumentFrameCallbacks>
+        frameRequestCallbacks(mFrameRequestCallbackDocs.Length());
       for (uint32_t i = 0; i < mFrameRequestCallbackDocs.Length(); ++i) {
+        frameRequestCallbacks.AppendElement(mFrameRequestCallbackDocs[i]);
         mFrameRequestCallbackDocs[i]->
-          TakeFrameRequestCallbacks(frameRequestCallbacks);
+          TakeFrameRequestCallbacks(frameRequestCallbacks.LastElement().mCallbacks);
       }
       // OK, now reset mFrameRequestCallbackDocs so they can be
       // readded as needed.
       mFrameRequestCallbackDocs.Clear();
 
       int64_t eventTime = aNowEpoch / PR_USEC_PER_MSEC;
       for (uint32_t i = 0; i < frameRequestCallbacks.Length(); ++i) {
-        nsAutoMicroTask mt;
-        frameRequestCallbacks[i]->Sample(eventTime);
+        const DocumentFrameCallbacks& docCallbacks = frameRequestCallbacks[i];
+        DOMHighResTimeStamp timeStamp;
+        // XXXbz Bug 863140: GetInnerWindow can return the outer
+        // window in some cases.
+        nsPIDOMWindow* innerWindow = docCallbacks.mDocument->GetInnerWindow();
+        if (innerWindow && innerWindow->IsInnerWindow()) {
+          timeStamp = innerWindow->GetPerformance()->GetDOMTiming()->
+            TimeStampToDOMHighRes(aNowTime);
+        } else {
+          timeStamp = 0;
+        }
+        for (uint32_t j = 0; j < docCallbacks.mCallbacks.Length(); ++j) {
+          const nsIDocument::FrameRequestCallbackHolder& holder =
+            docCallbacks.mCallbacks[j];
+          nsAutoMicroTask mt;
+          if (holder.HasWebIDLCallback()) {
+            ErrorResult ignored;
+            holder.GetWebIDLCallback()->Call(timeStamp, ignored);
+          } else {
+            holder.GetXPCOMCallback()->Sample(eventTime);
+          }
+        }
       }
 
       // This is the Flush_Style case.