Add optional visualization file writers to VideoProcessor tests.

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 "webrtc/api/video/video_frame.h"
 #include "webrtc/base/checks.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 {
 
 class VideoBitrateAllocator;
 
 namespace test {
 
 // Defines which frame types shall be excluded from packet loss and when.
@@ skipping 121 matching lines @@
   virtual int NumberDroppedFrames() = 0;
 
   // Return the number of spatial resizes.
   virtual int NumberSpatialResizes() = 0;
 };
 
 class VideoProcessorImpl : public VideoProcessor {
  public:
   VideoProcessorImpl(webrtc::VideoEncoder* encoder,
                      webrtc::VideoDecoder* decoder,
-                     FrameReader* frame_reader,
-                     FrameWriter* frame_writer,
+                     FrameReader* analysis_frame_reader,
+                     FrameWriter* analysis_frame_writer,
                      PacketManipulator* packet_manipulator,
                      const TestConfig& config,
-                     Stats* stats);
+                     Stats* stats,
+                     FrameWriter* source_frame_writer,
+                     IvfFileWriter* encoded_frame_writer,
+                     FrameWriter* decoded_frame_writer);
   virtual ~VideoProcessorImpl();
   bool Init() override;
   bool ProcessFrame(int frame_number) override;
 
  private:
   // Callback class required to implement according to the VideoEncoder API.
   class VideoProcessorEncodeCompleteCallback
       : public webrtc::EncodedImageCallback {
    public:
     explicit VideoProcessorEncodeCompleteCallback(VideoProcessorImpl* vp)
@@ skipping 62 matching lines @@
 
   // 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_;
   std::unique_ptr<VideoBitrateAllocator> bitrate_allocator_;
-  FrameReader* const frame_reader_;
-  FrameWriter* const frame_writer_;
+  // 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_;
   PacketManipulator* const packet_manipulator_;
   const TestConfig& config_;
   Stats* stats_;
+  // 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_;
 
+  // Adapters for the codec callbacks.
   std::unique_ptr<EncodedImageCallback> encode_callback_;
   std::unique_ptr<DecodedImageCallback> decode_callback_;
 
   // Keep track of the last successful frame, since we need to write that
   // when decoding fails.
   std::unique_ptr<uint8_t[]> last_successful_frame_buffer_;
   // To keep track of if we have excluded the first key frame from packet loss.
   bool first_key_frame_has_been_excluded_;
   // To tell the decoder previous frame have been dropped due to packet loss.
   bool last_frame_missing_;
@@ skipping 10 matching lines @@
   // Statistics.
   double bit_rate_factor_;  // Multiply frame length with this to get bit rate.
   int64_t encode_start_ns_;
   int64_t decode_start_ns_;
 };
 
 }  // namespace test
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_VIDEO_CODING_CODECS_TEST_VIDEOPROCESSOR_H_