Describe ObserveFirstPassStats with more details

Change-Id: I7c15aeaf0c0884b7c7b265fb03fbbb9ccc6b73be

diff --git a/vp9/simple_encode.h b/vp9/simple_encode.h
index f2344a24070e504b3ce2f9a83930ddb237cdde87..a05ef10cb32d8490a3b8b9700cb0022df4095d07 100644 (file)
--- 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.