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