From f0878a719ab79c743e561e2eb35855219f73d969 Mon Sep 17 00:00:00 2001
From: angiebird <angiebird@google.com>
Date: Tue, 26 Nov 2019 13:43:03 -0800
Subject: [PATCH] Describe ObserveFirstPassStats with more details

Change-Id: I7c15aeaf0c0884b7c7b265fb03fbbb9ccc6b73be
---
 vp9/simple_encode.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/vp9/simple_encode.h b/vp9/simple_encode.h
index f2344a2..a05ef10 100644
--- a/vp9/simple_encode.h
+++ b/vp9/simple_encode.h
@@ -51,7 +51,10 @@ class SimpleEncode {
   // future encode.
   void ComputeFirstPassStats();
 
-  // Outputs the first pass stats.
+  // Outputs the first pass stats represented by a 2-D vector.
+  // One can use the frame index at first dimension to retrieve the stats for
+  // each video frame. The stats of each video frame is a vector of 25 double
+  // values. For details, please check FIRSTPASS_STATS in vp9_firstpass.h
   std::vector<std::vector<double>> ObserveFirstPassStats();
 
   // Initializes the encoder for actual encoding.
-- 
2.7.4