2 * Copyright (c) 2012 The WebM project authors. All Rights Reserved.
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.
10 #ifndef TEST_ENCODE_TEST_DRIVER_H_
11 #define TEST_ENCODE_TEST_DRIVER_H_
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"
23 namespace libvpx_test {
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)
41 #define ONE_PASS_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
42 ::libvpx_test::kOnePassGood, \
43 ::libvpx_test::kOnePassBest)
45 #define TWO_PASS_TEST_MODES ::testing::Values(::libvpx_test::kTwoPassGood, \
46 ::libvpx_test::kTwoPassBest)
49 // Provides an object to handle the libvpx get_cx_data() iteration pattern
50 class CxDataIterator {
52 explicit CxDataIterator(vpx_codec_ctx_t *encoder)
53 : encoder_(encoder), iter_(NULL) {}
55 const vpx_codec_cx_pkt_t *Next() {
56 return vpx_codec_get_cx_data(encoder_, &iter_);
60 vpx_codec_ctx_t *encoder_;
61 vpx_codec_iter_t iter_;
64 // Implements an in-memory store for libvpx twopass statistics
65 class TwopassStatsStore {
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);
72 vpx_fixed_buf_t buf() {
73 const vpx_fixed_buf_t buf = { &buffer_[0], buffer_.size() };
86 // Provides a simplified interface to manage one video encoding pass, given
87 // a configuration and video source.
89 // TODO(jkoleszar): The exact services it provides and the appropriate
90 // level of abstraction will be fleshed out as more tests are written.
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_));
100 vpx_codec_destroy(&encoder_);
103 CxDataIterator GetCxData() {
104 return CxDataIterator(&encoder_);
107 void InitEncoder(VideoSource *video);
109 const vpx_image_t *GetPreviewFrame() {
110 return vpx_codec_get_preview_frame(&encoder_);
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);
116 // Convenience wrapper for EncodeFrame()
117 void EncodeFrame(VideoSource *video) {
118 EncodeFrame(video, 0);
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();
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();
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();
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();
143 void Config(const vpx_codec_enc_cfg_t *cfg) {
144 const vpx_codec_err_t res = vpx_codec_enc_config_set(&encoder_, cfg);
145 ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
149 void set_deadline(unsigned long deadline) {
150 deadline_ = deadline;
154 virtual vpx_codec_iface_t* CodecInterface() const = 0;
156 const char *EncoderError() {
157 const char *detail = vpx_codec_error_detail(&encoder_);
158 return detail ? detail : vpx_codec_error(&encoder_);
162 void EncodeFrameInternal(const VideoSource &video,
163 const unsigned long frame_flags);
165 // Flush the encoder on EOS
168 vpx_codec_ctx_t encoder_;
169 vpx_codec_enc_cfg_t cfg_;
170 unsigned long deadline_;
171 unsigned long init_flags_;
172 TwopassStatsStore *stats_;
175 // Common test functionality for all Encoder tests.
177 // This class is a mixin which provides the main loop common to all
178 // encoder tests. It provides hooks which can be overridden by subclasses
179 // to implement each test's specific behavior, while centralizing the bulk
180 // of the boilerplate. Note that it doesn't inherit the gtest testing
181 // classes directly, so that tests can be parameterized differently.
184 explicit EncoderTest(const CodecFactory *codec)
185 : codec_(codec), abort_(false), init_flags_(0), frame_flags_(0),
188 virtual ~EncoderTest() {}
190 // Initialize the cfg_ member with the default configuration.
191 void InitializeConfig();
193 // Map the TestMode enum to the deadline_ and passes_ variables.
194 void SetMode(TestMode mode);
197 void set_init_flags(unsigned long flag) { // NOLINT(runtime/int)
202 virtual void RunLoop(VideoSource *video);
204 // Hook to be called at the beginning of a pass.
205 virtual void BeginPassHook(unsigned int /*pass*/) {}
207 // Hook to be called at the end of a pass.
208 virtual void EndPassHook() {}
210 // Hook to be called before encoding a frame.
211 virtual void PreEncodeFrameHook(VideoSource* /*video*/) {}
212 virtual void PreEncodeFrameHook(VideoSource* /*video*/,
213 Encoder* /*encoder*/) {}
215 // Hook to be called on every compressed data packet.
216 virtual void FramePktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
218 // Hook to be called on every PSNR packet.
219 virtual void PSNRPktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
221 // Hook to determine whether the encode loop should continue.
222 virtual bool Continue() const {
223 return !(::testing::Test::HasFatalFailure() || abort_);
226 const CodecFactory *codec_;
227 // Hook to determine whether to decode frame after encoding
228 virtual bool DoDecode() const { return 1; }
230 // Hook to handle encode/decode mismatch
231 virtual void MismatchHook(const vpx_image_t *img1,
232 const vpx_image_t *img2);
234 // Hook to be called on every decompressed frame.
235 virtual void DecompressedFrameHook(const vpx_image_t& /*img*/,
236 vpx_codec_pts_t /*pts*/) {}
238 // Hook to be called to handle decode result. Return true to continue.
239 virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec,
240 const VideoSource& /*video*/,
242 EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError();
243 return VPX_CODEC_OK == res_dec;
246 // Hook that can modify the encoder's output data
247 virtual const vpx_codec_cx_pkt_t *MutateEncoderOutputHook(
248 const vpx_codec_cx_pkt_t *pkt) {
253 vpx_codec_enc_cfg_t cfg_;
254 vpx_codec_dec_cfg_t dec_cfg_;
255 unsigned int passes_;
256 unsigned long deadline_;
257 TwopassStatsStore stats_;
258 unsigned long init_flags_;
259 unsigned long frame_flags_;
260 vpx_codec_pts_t last_pts_;
263 } // namespace libvpx_test
265 #endif // TEST_ENCODE_TEST_DRIVER_H_