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 "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_parameters *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 #if CONFIG_VP8_ENCODER || CONFIG_VP9_ENCODER 136 void Control(int ctrl_id, vpx_active_map_t *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 #endif 141 142 #if CONFIG_VP8_ENCODER 143 void Control(int ctrl_id, vpx_roi_map_t *arg) { 144 const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg); 145 ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError(); 146 } 147 #endif 148 149 void Config(const vpx_codec_enc_cfg_t *cfg) { 150 const vpx_codec_err_t res = vpx_codec_enc_config_set(&encoder_, cfg); 151 ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError(); 152 cfg_ = *cfg; 153 } 154 155 void set_deadline(unsigned long deadline) { deadline_ = deadline; } 156 157 protected: 158 virtual vpx_codec_iface_t *CodecInterface() const = 0; 159 160 const char *EncoderError() { 161 const char *detail = vpx_codec_error_detail(&encoder_); 162 return detail ? detail : vpx_codec_error(&encoder_); 163 } 164 165 // Encode an image 166 void EncodeFrameInternal(const VideoSource &video, 167 const unsigned long frame_flags); 168 169 // Flush the encoder on EOS 170 void Flush(); 171 172 vpx_codec_ctx_t encoder_; 173 vpx_codec_enc_cfg_t cfg_; 174 unsigned long deadline_; 175 unsigned long init_flags_; 176 TwopassStatsStore *stats_; 177 }; 178 179 // Common test functionality for all Encoder tests. 180 // 181 // This class is a mixin which provides the main loop common to all 182 // encoder tests. It provides hooks which can be overridden by subclasses 183 // to implement each test's specific behavior, while centralizing the bulk 184 // of the boilerplate. Note that it doesn't inherit the gtest testing 185 // classes directly, so that tests can be parameterized differently. 186 class EncoderTest { 187 protected: 188 explicit EncoderTest(const CodecFactory *codec) 189 : codec_(codec), abort_(false), init_flags_(0), frame_flags_(0), 190 last_pts_(0) { 191 // Default to 1 thread. 192 cfg_.g_threads = 1; 193 } 194 195 virtual ~EncoderTest() {} 196 197 // Initialize the cfg_ member with the default configuration. 198 void InitializeConfig(); 199 200 // Map the TestMode enum to the deadline_ and passes_ variables. 201 void SetMode(TestMode mode); 202 203 // Set encoder flag. 204 void set_init_flags(unsigned long flag) { // NOLINT(runtime/int) 205 init_flags_ = flag; 206 } 207 208 // Main loop 209 virtual void RunLoop(VideoSource *video); 210 211 // Hook to be called at the beginning of a pass. 212 virtual void BeginPassHook(unsigned int /*pass*/) {} 213 214 // Hook to be called at the end of a pass. 215 virtual void EndPassHook() {} 216 217 // Hook to be called before encoding a frame. 218 virtual void PreEncodeFrameHook(VideoSource * /*video*/) {} 219 virtual void PreEncodeFrameHook(VideoSource * /*video*/, 220 Encoder * /*encoder*/) {} 221 222 virtual void PostEncodeFrameHook(Encoder * /*encoder*/) {} 223 224 // Hook to be called on every compressed data packet. 225 virtual void FramePktHook(const vpx_codec_cx_pkt_t * /*pkt*/) {} 226 227 // Hook to be called on every PSNR packet. 228 virtual void PSNRPktHook(const vpx_codec_cx_pkt_t * /*pkt*/) {} 229 230 // Hook to be called on every first pass stats packet. 231 virtual void StatsPktHook(const vpx_codec_cx_pkt_t * /*pkt*/) {} 232 233 // Hook to determine whether the encode loop should continue. 234 virtual bool Continue() const { 235 return !(::testing::Test::HasFatalFailure() || abort_); 236 } 237 238 const CodecFactory *codec_; 239 // Hook to determine whether to decode frame after encoding 240 virtual bool DoDecode() const { return 1; } 241 242 // Hook to handle encode/decode mismatch 243 virtual void MismatchHook(const vpx_image_t *img1, const vpx_image_t *img2); 244 245 // Hook to be called on every decompressed frame. 246 virtual void DecompressedFrameHook(const vpx_image_t & /*img*/, 247 vpx_codec_pts_t /*pts*/) {} 248 249 // Hook to be called to handle decode result. Return true to continue. 250 virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec, 251 const VideoSource & /*video*/, 252 Decoder *decoder) { 253 EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError(); 254 return VPX_CODEC_OK == res_dec; 255 } 256 257 // Hook that can modify the encoder's output data 258 virtual const vpx_codec_cx_pkt_t *MutateEncoderOutputHook( 259 const vpx_codec_cx_pkt_t *pkt) { 260 return pkt; 261 } 262 263 bool abort_; 264 vpx_codec_enc_cfg_t cfg_; 265 vpx_codec_dec_cfg_t dec_cfg_; 266 unsigned int passes_; 267 unsigned long deadline_; 268 TwopassStatsStore stats_; 269 unsigned long init_flags_; 270 unsigned long frame_flags_; 271 vpx_codec_pts_t last_pts_; 272 }; 273 274 } // namespace libvpx_test 275 276 #endif // TEST_ENCODE_TEST_DRIVER_H_ 277