Measure encoding time on encode callbacks.

webrtc/video/overuse_frame_detector.h

 /*
  *  Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_VIDEO_OVERUSE_FRAME_DETECTOR_H_
 #define WEBRTC_VIDEO_OVERUSE_FRAME_DETECTOR_H_
 
+#include <list>
+
 #include "webrtc/base/constructormagic.h"
 #include "webrtc/base/criticalsection.h"
 #include "webrtc/base/scoped_ptr.h"
 #include "webrtc/base/exp_filter.h"
 #include "webrtc/base/thread_annotations.h"
 #include "webrtc/base/thread_checker.h"
 #include "webrtc/modules/include/module.h"
 
 namespace webrtc {
 
 class Clock;
+class EncodedImage;
+class VideoFrame;
 
 // CpuOveruseObserver is called when a system overuse is detected and
 // VideoEngine cannot keep up the encoding frequency.
 class CpuOveruseObserver {
  public:
   // Called as soon as an overuse is detected.
   virtual void OveruseDetected() = 0;
   // Called periodically when the system is not overused any longer.
   virtual void NormalUsage() = 0;
 
@@ skipping 26 matching lines @@
 struct CpuOveruseMetrics {
   CpuOveruseMetrics() : encode_usage_percent(-1) {}
 
   int encode_usage_percent;  // Average encode time divided by the average time
                              // difference between incoming captured frames.
 };
 
 class CpuOveruseMetricsObserver {
  public:
   virtual ~CpuOveruseMetricsObserver() {}
-  virtual void CpuOveruseMetricsUpdated(const CpuOveruseMetrics& metrics) = 0;
+  virtual void OnEncodedFrameTimeMeasured(int encode_time_ms,
+                                          const CpuOveruseMetrics& metrics) = 0;
 };
 
 
 // Use to detect system overuse based on the send-side processing time of
 // incoming frames.
 class OveruseFrameDetector : public Module {
  public:
   OveruseFrameDetector(Clock* clock,
                        const CpuOveruseOptions& options,
                        CpuOveruseObserver* overuse_observer,
                        CpuOveruseMetricsObserver* metrics_observer);
   ~OveruseFrameDetector();
 
   // Called for each captured frame.
-  void FrameCaptured(int width, int height, int64_t capture_time_ms);
+  void FrameCaptured(const VideoFrame& frame);
 
   // Called for each sent frame.
-  void FrameSent(int64_t capture_time_ms);
-
-  // Only public for testing.
-  int LastProcessingTimeMs() const;
-  int FramesInQueue() const;
+  void FrameSent(const EncodedImage& encoded_image);

[mflodman, 2016/01/21 08:00:05]

I'd prefer to only have the timing value as an argument, we don't use anything
else from the frame.

[pbos-webrtc, 2016/01/21 14:18:33]

Done.

 
   // Implements Module.
   int64_t TimeUntilNextProcess() override;
   int32_t Process() override;
 
  private:
   class SendProcessingUsage;
-  class FrameQueue;
+  struct FrameTiming {
+    FrameTiming(uint32_t timestamp, int64_t now)
+        : timestamp(timestamp), capture_ms(now), last_send_ms(-1) {}
+    uint32_t timestamp;
+    int64_t capture_ms;
+    int64_t last_send_ms;
+  };
 
-  void UpdateCpuOveruseMetrics() EXCLUSIVE_LOCKS_REQUIRED(crit_);
+  void EncodedFrameTimeMeasured(int encode_time_ms)
+      EXCLUSIVE_LOCKS_REQUIRED(crit_);
 
   // TODO(asapersson): This method is only used on one thread, so it shouldn't
   // need a guard.
   void AddProcessingTime(int elapsed_ms) EXCLUSIVE_LOCKS_REQUIRED(crit_);
 
   // Only called on the processing thread.
   bool IsOverusing(const CpuOveruseMetrics& metrics);
   bool IsUnderusing(const CpuOveruseMetrics& metrics, int64_t time_now);
 
   bool FrameTimeoutDetected(int64_t now) const EXCLUSIVE_LOCKS_REQUIRED(crit_);
   bool FrameSizeChanged(int num_pixels) const EXCLUSIVE_LOCKS_REQUIRED(crit_);
 
   void ResetAll(int num_pixels) EXCLUSIVE_LOCKS_REQUIRED(crit_);
 
   // Protecting all members except const and those that are only accessed on the
   // processing thread.
   // TODO(asapersson): See if we can reduce locking.  As is, video frame
   // processing contends with reading stats and the processing thread.
   mutable rtc::CriticalSection crit_;
 
   const CpuOveruseOptions options_;
 
   // Observer getting overuse reports.
   CpuOveruseObserver* const observer_;
 
   // Stats metrics.
   CpuOveruseMetricsObserver* const metrics_observer_;
+  int last_encode_time_ms_ GUARDED_BY(crit_);

[mflodman, 2016/01/21 08:00:05]

I prefer int64_t, following the rest of this class.

[pbos-webrtc, 2016/01/21 14:18:33]

Removed per other feedback.

   CpuOveruseMetrics metrics_ GUARDED_BY(crit_);
 
   Clock* const clock_;
   int64_t num_process_times_ GUARDED_BY(crit_);
 
   int64_t last_capture_time_ GUARDED_BY(crit_);
 
   // Number of pixels of last captured frame.
   int num_pixels_ GUARDED_BY(crit_);
 
   // These seven members are only accessed on the processing thread.
   int64_t next_process_time_;
   int64_t last_overuse_time_;
   int checks_above_threshold_;
   int num_overuse_detections_;
   int64_t last_rampup_time_;
   bool in_quick_rampup_;
   int current_rampup_delay_ms_;
 
   int64_t last_sample_time_ms_;    // Only accessed by one thread.
 
   // TODO(asapersson): Can these be regular members (avoid separate heap
   // allocs)?
   const rtc::scoped_ptr<SendProcessingUsage> usage_ GUARDED_BY(crit_);
-  const rtc::scoped_ptr<FrameQueue> frame_queue_ GUARDED_BY(crit_);
+  std::list<FrameTiming> frame_timing_ GUARDED_BY(crit_);
 
   rtc::ThreadChecker processing_thread_;
 
   RTC_DISALLOW_COPY_AND_ASSIGN(OveruseFrameDetector);
 };
 
 }  // namespace webrtc
 
 #endif  // WEBRTC_VIDEO_OVERUSE_FRAME_DETECTOR_H_