encode_test_driver.h 7.82 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1 2 3 4 5 6 7 8 9 10 11
/*
 *  Copyright (c) 2012 The WebM 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 TEST_ENCODE_TEST_DRIVER_H_
#define TEST_ENCODE_TEST_DRIVER_H_
12

John Koleszar's avatar
John Koleszar committed
13 14
#include <string>
#include <vector>
15 16

#include "./vpx_config.h"
John Koleszar's avatar
John Koleszar committed
17 18
#include "third_party/googletest/src/include/gtest/gtest.h"
#include "vpx/vpx_encoder.h"
Alex Converse's avatar
Alex Converse committed
19 20 21
#if CONFIG_VP8_ENCODER || CONFIG_VP9_ENCODER
#include "vpx/vp8cx.h"
#endif
John Koleszar's avatar
John Koleszar committed
22 23 24

namespace libvpx_test {

25
class CodecFactory;
John Koleszar's avatar
John Koleszar committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
class VideoSource;

enum TestMode {
  kRealTime,
  kOnePassGood,
  kOnePassBest,
  kTwoPassGood,
  kTwoPassBest
};
#define ALL_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
                                         ::libvpx_test::kOnePassGood, \
                                         ::libvpx_test::kOnePassBest, \
                                         ::libvpx_test::kTwoPassGood, \
                                         ::libvpx_test::kTwoPassBest)

John Koleszar's avatar
John Koleszar committed
41 42 43 44
#define ONE_PASS_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
                                              ::libvpx_test::kOnePassGood, \
                                              ::libvpx_test::kOnePassBest)

45 46 47
#define TWO_PASS_TEST_MODES ::testing::Values(::libvpx_test::kTwoPassGood, \
                                              ::libvpx_test::kTwoPassBest)

John Koleszar's avatar
John Koleszar committed
48 49 50 51 52

// Provides an object to handle the libvpx get_cx_data() iteration pattern
class CxDataIterator {
 public:
  explicit CxDataIterator(vpx_codec_ctx_t *encoder)
53
      : encoder_(encoder), iter_(NULL) {}
John Koleszar's avatar
John Koleszar committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

  const vpx_codec_cx_pkt_t *Next() {
    return vpx_codec_get_cx_data(encoder_, &iter_);
  }

 private:
  vpx_codec_ctx_t  *encoder_;
  vpx_codec_iter_t  iter_;
};

// Implements an in-memory store for libvpx twopass statistics
class TwopassStatsStore {
 public:
  void Append(const vpx_codec_cx_pkt_t &pkt) {
    buffer_.append(reinterpret_cast<char *>(pkt.data.twopass_stats.buf),
                   pkt.data.twopass_stats.sz);
  }

  vpx_fixed_buf_t buf() {
    const vpx_fixed_buf_t buf = { &buffer_[0], buffer_.size() };
    return buf;
  }

77 78 79 80
  void Reset() {
    buffer_.clear();
  }

John Koleszar's avatar
John Koleszar committed
81 82 83 84 85 86 87 88 89 90 91 92 93
 protected:
  std::string  buffer_;
};


// Provides a simplified interface to manage one video encoding pass, given
// a configuration and video source.
//
// TODO(jkoleszar): The exact services it provides and the appropriate
// level of abstraction will be fleshed out as more tests are written.
class Encoder {
 public:
  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) {
John Koleszar's avatar
John Koleszar committed
96 97 98
    memset(&encoder_, 0, sizeof(encoder_));
  }

99
  virtual ~Encoder() {
John Koleszar's avatar
John Koleszar committed
100 101 102 103 104 105 106
    vpx_codec_destroy(&encoder_);
  }

  CxDataIterator GetCxData() {
    return CxDataIterator(&encoder_);
  }

107 108 109
  const vpx_image_t *GetPreviewFrame() {
    return vpx_codec_get_preview_frame(&encoder_);
  }
John Koleszar's avatar
John Koleszar committed
110 111
  // This is a thin wrapper around vpx_codec_encode(), so refer to
  // vpx_encoder.h for its semantics.
112
  void EncodeFrame(VideoSource *video, const unsigned long frame_flags);
John Koleszar's avatar
John Koleszar committed
113 114 115 116 117 118

  // Convenience wrapper for EncodeFrame()
  void EncodeFrame(VideoSource *video) {
    EncodeFrame(video, 0);
  }

119 120 121 122 123
  void Control(int ctrl_id, int arg) {
    const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
    ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
  }

124 125 126 127 128
  void Control(int ctrl_id, struct vpx_scaling_mode *arg) {
    const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
    ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
  }

129 130 131 132 133
  void Control(int ctrl_id, struct vpx_svc_layer_id *arg) {
    const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
    ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
  }

Alex Converse's avatar
Alex Converse committed
134 135 136 137 138 139 140
#if CONFIG_VP8_ENCODER || CONFIG_VP9_ENCODER
  void Control(int ctrl_id, vpx_active_map_t *arg) {
    const vpx_codec_err_t res = vpx_codec_control_(&encoder_, ctrl_id, arg);
    ASSERT_EQ(VPX_CODEC_OK, res) << EncoderError();
  }
#endif

John Koleszar's avatar
John Koleszar committed
141 142 143 144 145
  void set_deadline(unsigned long deadline) {
    deadline_ = deadline;
  }

 protected:
146
  virtual vpx_codec_iface_t* CodecInterface() const = 0;
147

John Koleszar's avatar
John Koleszar committed
148 149 150 151 152 153
  const char *EncoderError() {
    const char *detail = vpx_codec_error_detail(&encoder_);
    return detail ? detail : vpx_codec_error(&encoder_);
  }

  // Encode an image
154 155
  void EncodeFrameInternal(const VideoSource &video,
                           const unsigned long frame_flags);
John Koleszar's avatar
John Koleszar committed
156 157 158 159 160 161 162

  // Flush the encoder on EOS
  void Flush();

  vpx_codec_ctx_t      encoder_;
  vpx_codec_enc_cfg_t  cfg_;
  unsigned long        deadline_;
163
  unsigned long        init_flags_;
John Koleszar's avatar
John Koleszar committed
164 165 166 167 168 169 170 171 172 173 174 175
  TwopassStatsStore   *stats_;
};

// Common test functionality for all Encoder tests.
//
// This class is a mixin which provides the main loop common to all
// encoder tests. It provides hooks which can be overridden by subclasses
// to implement each test's specific behavior, while centralizing the bulk
// of the boilerplate. Note that it doesn't inherit the gtest testing
// classes directly, so that tests can be parameterized differently.
class EncoderTest {
 protected:
176 177 178
  explicit EncoderTest(const CodecFactory *codec)
      : codec_(codec), abort_(false), init_flags_(0), frame_flags_(0),
        last_pts_(0) {}
John Koleszar's avatar
John Koleszar committed
179 180 181 182

  virtual ~EncoderTest() {}

  // Initialize the cfg_ member with the default configuration.
183
  void InitializeConfig();
John Koleszar's avatar
John Koleszar committed
184 185 186 187

  // Map the TestMode enum to the deadline_ and passes_ variables.
  void SetMode(TestMode mode);

188
  // Main loop
John Koleszar's avatar
John Koleszar committed
189 190 191
  virtual void RunLoop(VideoSource *video);

  // Hook to be called at the beginning of a pass.
192
  virtual void BeginPassHook(unsigned int /*pass*/) {}
John Koleszar's avatar
John Koleszar committed
193 194 195 196 197

  // Hook to be called at the end of a pass.
  virtual void EndPassHook() {}

  // Hook to be called before encoding a frame.
198 199 200
  virtual void PreEncodeFrameHook(VideoSource* /*video*/) {}
  virtual void PreEncodeFrameHook(VideoSource* /*video*/,
                                  Encoder* /*encoder*/) {}
John Koleszar's avatar
John Koleszar committed
201 202

  // Hook to be called on every compressed data packet.
203
  virtual void FramePktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
John Koleszar's avatar
John Koleszar committed
204

205
  // Hook to be called on every PSNR packet.
206
  virtual void PSNRPktHook(const vpx_codec_cx_pkt_t* /*pkt*/) {}
207

John Koleszar's avatar
John Koleszar committed
208
  // Hook to determine whether the encode loop should continue.
209 210 211
  virtual bool Continue() const {
    return !(::testing::Test::HasFatalFailure() || abort_);
  }
John Koleszar's avatar
John Koleszar committed
212

213
  const CodecFactory   *codec_;
214 215 216 217 218 219 220
  // Hook to determine whether to decode frame after encoding
  virtual bool DoDecode() const { return 1; }

  // Hook to handle encode/decode mismatch
  virtual void MismatchHook(const vpx_image_t *img1,
                            const vpx_image_t *img2);

221
  // Hook to be called on every decompressed frame.
222 223
  virtual void DecompressedFrameHook(const vpx_image_t& /*img*/,
                                     vpx_codec_pts_t /*pts*/) {}
224

225 226
  // Hook to be called to handle decode result. Return true to continue.
  virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec,
227
                                  const VideoSource& /*video*/,
228 229 230 231 232
                                  Decoder *decoder) {
    EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError();
    return VPX_CODEC_OK == res_dec;
  }

John Koleszar's avatar
John Koleszar committed
233
  // Hook that can modify the encoder's output data
234
  virtual const vpx_codec_cx_pkt_t *MutateEncoderOutputHook(
John Koleszar's avatar
John Koleszar committed
235 236 237 238
      const vpx_codec_cx_pkt_t *pkt) {
    return pkt;
  }

John Koleszar's avatar
John Koleszar committed
239 240
  bool                 abort_;
  vpx_codec_enc_cfg_t  cfg_;
241
  vpx_codec_dec_cfg_t  dec_cfg_;
John Koleszar's avatar
John Koleszar committed
242 243 244
  unsigned int         passes_;
  unsigned long        deadline_;
  TwopassStatsStore    stats_;
245 246
  unsigned long        init_flags_;
  unsigned long        frame_flags_;
247
  vpx_codec_pts_t      last_pts_;
John Koleszar's avatar
John Koleszar committed
248 249 250 251 252
};

}  // namespace libvpx_test

#endif  // TEST_ENCODE_TEST_DRIVER_H_