1 files changed, 105 insertions, 0 deletions
diff --git a/gfx/layers/CompositionRecorder.h b/gfx/layers/CompositionRecorder.h
new file mode 100644
index 0000000000..59c6bafa82
--- /dev/null
+++ b/gfx/layers/CompositionRecorder.h
@@ -0,0 +1,105 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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/. */
+
+#ifndef mozilla_layers_CompositionRecorder_h
+#define mozilla_layers_CompositionRecorder_h
+
+#include "mozilla/RefPtr.h"
+#include "mozilla/TimeStamp.h"
+#include "nsISupportsImpl.h"
+#include "nsTArray.h"
+#include "nsString.h"
+
+namespace mozilla {
+
+namespace gfx {
+class DataSourceSurface;
+}
+
+namespace layers {
+
+/**
+ * A captured frame from a |LayerManager|.
+ */
+class RecordedFrame {
+ public:
+  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(RecordedFrame)
+
+  // The resulting DataSourceSurface must not be kept alive beyond the lifetime
+  // of the RecordedFrame object, since it may refer to data owned by the frame.
+  virtual already_AddRefed<gfx::DataSourceSurface> GetSourceSurface() = 0;
+  TimeStamp GetTimeStamp() { return mTimeStamp; }
+
+ protected:
+  virtual ~RecordedFrame() = default;
+  RecordedFrame(const TimeStamp& aTimeStamp) : mTimeStamp(aTimeStamp) {}
+
+ private:
+  TimeStamp mTimeStamp;
+};
+
+/**
+ * A recorded frame that has been encoded into a data: URI.
+ */
+struct CollectedFrame {
+  CollectedFrame(double aTimeOffset, nsCString&& aDataUri)
+      : mTimeOffset(aTimeOffset), mDataUri(std::move(aDataUri)) {}
+
+  double mTimeOffset;
+  nsCString mDataUri;
+};
+
+/**
+ * All of the frames collected during a composition recording session.
+ */
+struct CollectedFrames {
+  CollectedFrames(double aRecordingStart, nsTArray<CollectedFrame>&& aFrames)
+      : mRecordingStart(aRecordingStart), mFrames(std::move(aFrames)) {}
+
+  double mRecordingStart;
+  nsTArray<CollectedFrame> mFrames;
+};
+
+/**
+ * A recorder for composited frames.
+ *
+ * This object collects frames sent to it by a |LayerManager| and writes them
+ * out as a series of images until recording has finished.
+ *
+ * If GPU-accelerated rendering is used, the frames will not be mapped into
+ * memory until |WriteCollectedFrames| is called.
+ */
+class CompositionRecorder {
+ public:
+  explicit CompositionRecorder(TimeStamp aRecordingStart);
+
+  /**
+   * Record a composited frame.
+   */
+  void RecordFrame(RecordedFrame* aFrame);
+
+  /**
+   * Write out the collected frames as a series of timestamped images.
+   */
+  void WriteCollectedFrames();
+
+  /**
+   * Return the collected frames as an array of their timestamps and contents.
+   */
+  CollectedFrames GetCollectedFrames();
+
+ protected:
+  void ClearCollectedFrames();
+
+ private:
+  nsTArray<RefPtr<RecordedFrame>> mCollectedFrames;
+  TimeStamp mRecordingStart;
+};
+
+}  // namespace layers
+}  // namespace mozilla
+
+#endif  // mozilla_layers_CompositionRecorder_h