granicus.if.org Git - libvpx/blob - test/encode_test_driver.h

   1 /*
   2  *  Copyright (c) 2012 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10 #ifndef TEST_ENCODE_TEST_DRIVER_H_
  11 #define TEST_ENCODE_TEST_DRIVER_H_
  12
  13 #include <string>
  14 #include <vector>
  15
  16 #include "./vpx_config.h"
  17 #include "third_party/googletest/src/include/gtest/gtest.h"
  18 #include "vpx/vpx_encoder.h"
  19 #if CONFIG_VP8_ENCODER || CONFIG_VP9_ENCODER
  20 #include "vpx/vp8cx.h"
  21 #endif
  22
  23 namespace libvpx_test {
  24
  25 class CodecFactory;
  26 class VideoSource;
  27
  28 enum TestMode {
  29   kRealTime,
  30   kOnePassGood,
  31   kOnePassBest,
  32   kTwoPassGood,
  33   kTwoPassBest
  34 };
  35 #define ALL_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
  36                                          ::libvpx_test::kOnePassGood, \
  37                                          ::libvpx_test::kOnePassBest, \
  38                                          ::libvpx_test::kTwoPassGood, \
  39                                          ::libvpx_test::kTwoPassBest)
  40
  41 #define ONE_PASS_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
  42                                               ::libvpx_test::kOnePassGood, \
  43                                               ::libvpx_test::kOnePassBest)
  44
  45 #define TWO_PASS_TEST_MODES ::testing::Values(::libvpx_test::kTwoPassGood, \
  46                                               ::libvpx_test::kTwoPassBest)
  47
  48
  49 // Provides an object to handle the libvpx get_cx_data() iteration pattern
  50 class CxDataIterator {
  51  public:
  52   explicit CxDataIterator(vpx_codec_ctx_t *encoder)
  53       : encoder_(encoder), iter_(NULL) {}
  54
  55   const vpx_codec_cx_pkt_t *Next() {
  56     return vpx_codec_get_cx_data(encoder_, &iter_);
  57   }
  58
  59  private:
  60   vpx_codec_ctx_t  *encoder_;
  61   vpx_codec_iter_t  iter_;
  62 };
  63
  64 // Implements an in-memory store for libvpx twopass statistics
  65 class TwopassStatsStore {
  66  public:
  67   void Append(const vpx_codec_cx_pkt_t &pkt) {
  68     buffer_.append(reinterpret_cast<char *>(pkt.data.twopass_stats.buf),
  69                    pkt.data.twopass_stats.sz);
  70   }
  71
  72   vpx_fixed_buf_t buf() {
  73     const vpx_fixed_buf_t buf = { &buffer_[0], buffer_.size() };
  74     return buf;
  75   }
  76
  77   void Reset() {
  78     buffer_.clear();
  79   }
  80
  81  protected:
  82   std::string  buffer_;
  83 };
  84
  85
  86 // Provides a simplified interface to manage one video encoding pass, given
  87 // a configuration and video source.
  88 //
  89 // TODO(jkoleszar): The exact services it provides and the appropriate
  90 // level of abstraction will be fleshed out as more tests are written.
  91 class Encoder {
  92  public:
  93   Encoder(vpx_codec_enc_cfg_t cfg, unsigned long deadline,
  94           const unsigned long init_flags, TwopassStatsStore *stats)
  95       : cfg_(cfg), deadline_(deadline), init_flags_(init_flags), stats_(stats) {
  96     memset(&encoder_, 0, sizeof(encoder_));
  97   }
  98
  99   virtual ~Encoder() {
 100     vpx_codec_destroy(&encoder_);
 101   }
 102
 103   CxDataIterator GetCxData() {
 104     return CxDataIterator(&encoder_);
 105   }
 106
 107   void InitEncoder(VideoSource *video);
 108
 109   const vpx_image_t *GetPreviewFrame() {
 110     return vpx_codec_get_preview_frame(&encoder_);
 111   }
 112   // This is a thin wrapper around vpx_codec_encode(), so refer to
 113   // vpx_encoder.h for its semantics.
 114   void EncodeFrame(VideoSource *video, const unsigned long frame_flags);
 115
 116   // Convenience wrapper for EncodeFrame()
 117   void EncodeFrame(VideoSource *video) {
 118     EncodeFrame(video, 0);
 119   }
 120
 121   void Control(int ctrl_id, int arg) {
 122     const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
 123     ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
 124   }
 125
 126   void Control(int ctrl_id, struct vpx_scaling_mode *arg) {
 127     const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
 128     ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
 129   }
 130
 131   void Control(int ctrl_id, struct vpx_svc_layer_id *arg) {
 132     const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
 133     ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
 134   }
 135
 136 #if CONFIG_VP8_ENCODER || CONFIG_VP9_ENCODER
 137   void Control(int ctrl_id, vpx_active_map_t *arg) {
 138     const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
 139     ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
 140   }
 141 #endif
 142
 143   void set_deadline(unsigned long deadline) {
 144     deadline_ = deadline;
 145   }
 146
 147  protected:
 148   virtual vpx_codec_iface_t* CodecInterface() const = 0;
 149
 150   const char *EncoderError() {
 151     const char *detail = vpx_codec_error_detail(&encoder_);
 152     return detail ? detail : vpx_codec_error(&encoder_);
 153   }
 154
 155   // Encode an image
 156   void EncodeFrameInternal(const VideoSource &video,
 157                            const unsigned long frame_flags);
 158
 159   // Flush the encoder on EOS
 160   void Flush();
 161
 162   vpx_codec_ctx_t      encoder_;
 163   vpx_codec_enc_cfg_t  cfg_;
 164   unsigned long        deadline_;
 165   unsigned long        init_flags_;
 166   TwopassStatsStore   *stats_;
 167 };
 168
 169 // Common test functionality for all Encoder tests.
 170 //
 171 // This class is a mixin which provides the main loop common to all
 172 // encoder tests. It provides hooks which can be overridden by subclasses
 173 // to implement each test's specific behavior, while centralizing the bulk
 174 // of the boilerplate. Note that it doesn't inherit the gtest testing
 175 // classes directly, so that tests can be parameterized differently.
 176 class EncoderTest {
 177  protected:
 178   explicit EncoderTest(const CodecFactory *codec)
 179       : codec_(codec), abort_(false), init_flags_(0), frame_flags_(0),
 180         last_pts_(0) {}
 181
 182   virtual ~EncoderTest() {}
 183
 184   // Initialize the cfg_ member with the default configuration.
 185   void InitializeConfig();
 186
 187   // Map the TestMode enum to the deadline_ and passes_ variables.
 188   void SetMode(TestMode mode);
 189
 190   // Set encoder flag.
 191   void set_init_flags(unsigned long flag) {  // NOLINT(runtime/int)
 192     init_flags_ = flag;
 193   }
 194
 195   // Main loop
 196   virtual void RunLoop(VideoSource *video);
 197
 198   // Hook to be called at the beginning of a pass.
 199   virtual void BeginPassHook(unsigned int /*pass*/) {}
 200
 201   // Hook to be called at the end of a pass.
 202   virtual void EndPassHook() {}
 203
 204   // Hook to be called before encoding a frame.
 205   virtual void PreEncodeFrameHook(VideoSource* /*video*/) {}
 206   virtual void PreEncodeFrameHook(VideoSource* /*video*/,
 207                                   Encoder* /*encoder*/) {}
 208
 209   // Hook to be called on every compressed data packet.
 210   virtual void FramePktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
 211
 212   // Hook to be called on every PSNR packet.
 213   virtual void PSNRPktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
 214
 215   // Hook to determine whether the encode loop should continue.
 216   virtual bool Continue() const {
 217     return !(::testing::Test::HasFatalFailure() || abort_);
 218   }
 219
 220   const CodecFactory   *codec_;
 221   // Hook to determine whether to decode frame after encoding
 222   virtual bool DoDecode() const { return 1; }
 223
 224   // Hook to handle encode/decode mismatch
 225   virtual void MismatchHook(const vpx_image_t *img1,
 226                             const vpx_image_t *img2);
 227
 228   // Hook to be called on every decompressed frame.
 229   virtual void DecompressedFrameHook(const vpx_image_t& /*img*/,
 230                                      vpx_codec_pts_t /*pts*/) {}
 231
 232   // Hook to be called to handle decode result. Return true to continue.
 233   virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec,
 234                                   const VideoSource& /*video*/,
 235                                   Decoder *decoder) {
 236     EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError();
 237     return VPX_CODEC_OK == res_dec;
 238   }
 239
 240   // Hook that can modify the encoder's output data
 241   virtual const vpx_codec_cx_pkt_t *MutateEncoderOutputHook(
 242       const vpx_codec_cx_pkt_t *pkt) {
 243     return pkt;
 244   }
 245
 246   bool                 abort_;
 247   vpx_codec_enc_cfg_t  cfg_;
 248   vpx_codec_dec_cfg_t  dec_cfg_;
 249   unsigned int         passes_;
 250   unsigned long        deadline_;
 251   TwopassStatsStore    stats_;
 252   unsigned long        init_flags_;
 253   unsigned long        frame_flags_;
 254   vpx_codec_pts_t      last_pts_;
 255 };
 256
 257 }  // namespace libvpx_test
 258
 259 #endif  // TEST_ENCODE_TEST_DRIVER_H_