Step #4: Run VideoProcessor integration test batch mode on task queue.

webrtc/modules/video_coding/codecs/test/videoprocessor.h

 /*
  *  Copyright (c) 2012 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_MODULES_VIDEO_CODING_CODECS_TEST_VIDEOPROCESSOR_H_
 #define WEBRTC_MODULES_VIDEO_CODING_CODECS_TEST_VIDEOPROCESSOR_H_
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "webrtc/api/video/video_frame.h"
 #include "webrtc/base/buffer.h"
 #include "webrtc/base/checks.h"
+#include "webrtc/base/sequenced_task_checker.h"
 #include "webrtc/common_video/libyuv/include/webrtc_libyuv.h"
 #include "webrtc/modules/video_coding/include/video_codec_interface.h"
 #include "webrtc/modules/video_coding/codecs/test/packet_manipulator.h"
 #include "webrtc/modules/video_coding/codecs/test/stats.h"
 #include "webrtc/modules/video_coding/utility/ivf_file_writer.h"
 #include "webrtc/test/testsupport/frame_reader.h"
 #include "webrtc/test/testsupport/frame_writer.h"
 
 namespace webrtc {
 
@@ skipping 90 matching lines @@
 // Regarding packet loss: Note that keyframes are excluded (first or all
 // depending on the ExcludeFrameTypes setting). This is because if key frames
 // would be altered, all the following delta frames would be pretty much
 // worthless. VP8 has an error-resilience feature that makes it able to handle
 // packet loss in key non-first keyframes, which is why only the first is
 // excluded by default.
 // Packet loss in such important frames is handled on a higher level in the
 // Video Engine, where signaling would request a retransmit of the lost packets,
 // since they're so important.
 //
-// Note this class is not thread safe in any way and is meant for simple testing
-// purposes.
+// This class should be run on a single thread, or a single task queue.
 class VideoProcessor {
  public:
-  virtual ~VideoProcessor() {}
+  virtual ~VideoProcessor() = default;
 
   // Performs initial calculations about frame size, sets up callbacks etc.
   // Returns false if an error has occurred, in addition to printing to stderr.
   virtual bool Init() = 0;
 
+  virtual void DeregisterCallbacks() = 0;
+
   // Processes a single frame. Returns true as long as there's more frames
   // available in the source clip.
   // Frame number must be an integer >= 0.
   virtual bool ProcessFrame(int frame_number) = 0;
 
   // Updates the encoder with the target bit rate and the frame rate.
   virtual void SetRates(int bit_rate, int frame_rate) = 0;
 
   // Return the size of the encoded frame in bytes. Dropped frames by the
   // encoder are regarded as zero size.
@@ skipping 14 matching lines @@
   VideoProcessorImpl(webrtc::VideoEncoder* encoder,
                      webrtc::VideoDecoder* decoder,
                      FrameReader* analysis_frame_reader,
                      FrameWriter* analysis_frame_writer,
                      PacketManipulator* packet_manipulator,
                      const TestConfig& config,
                      Stats* stats,
                      FrameWriter* source_frame_writer,
                      IvfFileWriter* encoded_frame_writer,
                      FrameWriter* decoded_frame_writer);
-  virtual ~VideoProcessorImpl();
+  ~VideoProcessorImpl() override;
   bool Init() override;
+  void DeregisterCallbacks() override;
   bool ProcessFrame(int frame_number) override;
 
  private:
   // Container that holds per-frame information that needs to be stored between
   // calls to Encode and Decode, as well as the corresponding callbacks. It is
   // not directly used for statistics -- for that, test::FrameStatistic is used.
   struct FrameInfo {
     FrameInfo()
         : timestamp(0),
           encode_start_ns(0),
@@ skipping 77 matching lines @@
 
   // Return the encoded frame type (key or delta).
   FrameType EncodedFrameType(int frame_number) override;
 
   // Return the number of dropped frames.
   int NumberDroppedFrames() override;
 
   // Return the number of spatial resizes.
   int NumberSpatialResizes() override;
 
-  webrtc::VideoEncoder* const encoder_;
-  webrtc::VideoDecoder* const decoder_;
-  const std::unique_ptr<VideoBitrateAllocator> bitrate_allocator_;
+  webrtc::VideoEncoder* const encoder_ PT_GUARDED_BY(task_checker_);
+  webrtc::VideoDecoder* const decoder_ PT_GUARDED_BY(task_checker_);
+  const std::unique_ptr<VideoBitrateAllocator> bitrate_allocator_
+      PT_GUARDED_BY(task_checker_);
 
   // Adapters for the codec callbacks.
   const std::unique_ptr<EncodedImageCallback> encode_callback_;
   const std::unique_ptr<DecodedImageCallback> decode_callback_;
 
-  PacketManipulator* const packet_manipulator_;
+  PacketManipulator* const packet_manipulator_ PT_GUARDED_BY(task_checker_);
   const TestConfig& config_;
 
   // These (mandatory) file manipulators are used for, e.g., objective PSNR and
   // SSIM calculations at the end of a test run.
-  FrameReader* const analysis_frame_reader_;
-  FrameWriter* const analysis_frame_writer_;
+  FrameReader* const analysis_frame_reader_ PT_GUARDED_BY(task_checker_);
+  FrameWriter* const analysis_frame_writer_ PT_GUARDED_BY(task_checker_);
   const int num_frames_;
 
   // These (optional) file writers are used for persistently storing the output
   // of the coding pipeline at different stages: pre encode (source), post
   // encode (encoded), and post decode (decoded). The purpose is to give the
   // experimenter an option to subjectively evaluate the quality of the
   // encoding, given the test settings. Each frame writer is enabled by being
   // non-null.
-  FrameWriter* const source_frame_writer_;
-  IvfFileWriter* const encoded_frame_writer_;
-  FrameWriter* const decoded_frame_writer_;
+  FrameWriter* const source_frame_writer_ PT_GUARDED_BY(task_checker_);
+  IvfFileWriter* const encoded_frame_writer_ PT_GUARDED_BY(task_checker_);
+  FrameWriter* const decoded_frame_writer_ PT_GUARDED_BY(task_checker_);
 
-  bool initialized_;
+  bool initialized_ GUARDED_BY(task_checker_);
 
   // Frame metadata for all frames that have been added through a call to
   // ProcessFrames(). We need to store this metadata over the course of the
   // test run, to support pipelining HW codecs.
-  std::vector<FrameInfo> frame_infos_;
-  int last_encoded_frame_num_;
-  int last_decoded_frame_num_;
+  std::vector<FrameInfo> frame_infos_ GUARDED_BY(task_checker_);
+  int last_encoded_frame_num_ GUARDED_BY(task_checker_);
+  int last_decoded_frame_num_ GUARDED_BY(task_checker_);
 
   // Keep track of if we have excluded the first key frame from packet loss.
-  bool first_key_frame_has_been_excluded_;
+  bool first_key_frame_has_been_excluded_ GUARDED_BY(task_checker_);
 
   // Keep track of the last successfully decoded frame, since we write that
   // frame to disk when decoding fails.
-  rtc::Buffer last_decoded_frame_buffer_;
+  rtc::Buffer last_decoded_frame_buffer_ GUARDED_BY(task_checker_);
 
   // Statistics.
-  Stats* stats_;
-  int num_dropped_frames_;
-  int num_spatial_resizes_;
-  double bit_rate_factor_;  // Multiply frame length with this to get bit rate.
+  Stats* stats_ PT_GUARDED_BY(task_checker_);
+  int num_dropped_frames_ GUARDED_BY(task_checker_);
+  int num_spatial_resizes_ GUARDED_BY(task_checker_);
+  // Multiply frame length with this to get bit rate.
+  double bit_rate_factor_ GUARDED_BY(task_checker_);
+
+  rtc::SequencedTaskChecker task_checker_;
 };
 
 }  // namespace test
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_VIDEO_CODING_CODECS_TEST_VIDEOPROCESSOR_H_