encode_test_driver.h 6.84 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
19
20
21
#include "third_party/googletest/src/include/gtest/gtest.h"
#include "vpx/vpx_encoder.h"

namespace libvpx_test {

22
class CodecFactory;
John Koleszar's avatar
John Koleszar committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
38
39
40
41
#define ONE_PASS_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
                                              ::libvpx_test::kOnePassGood, \
                                              ::libvpx_test::kOnePassBest)

42
43
44
#define TWO_PASS_TEST_MODES ::testing::Values(::libvpx_test::kTwoPassGood, \
                                              ::libvpx_test::kTwoPassBest)

John Koleszar's avatar
John Koleszar committed
45
46
47
48
49

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

  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;
  }

74
75
76
77
  void Reset() {
    buffer_.clear();
  }

John Koleszar's avatar
John Koleszar committed
78
79
80
81
82
83
84
85
86
87
88
89
90
 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,
91
          const unsigned long init_flags, TwopassStatsStore *stats)
92
      : cfg_(cfg), deadline_(deadline), init_flags_(init_flags), stats_(stats) {
John Koleszar's avatar
John Koleszar committed
93
94
95
    memset(&encoder_, 0, sizeof(encoder_));
  }

96
  virtual ~Encoder() {
John Koleszar's avatar
John Koleszar committed
97
98
99
100
101
102
103
    vpx_codec_destroy(&encoder_);
  }

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

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

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

116
117
118
119
120
  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();
  }

121
122
123
124
125
  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();
  }

John Koleszar's avatar
John Koleszar committed
126
127
128
129
130
  void set_deadline(unsigned long deadline) {
    deadline_ = deadline;
  }

 protected:
131
132
  virtual const vpx_codec_iface_t* CodecInterface() const = 0;

John Koleszar's avatar
John Koleszar committed
133
134
135
136
137
138
  const char *EncoderError() {
    const char *detail = vpx_codec_error_detail(&encoder_);
    return detail ? detail : vpx_codec_error(&encoder_);
  }

  // Encode an image
139
140
  void EncodeFrameInternal(const VideoSource &video,
                           const unsigned long frame_flags);
John Koleszar's avatar
John Koleszar committed
141
142
143
144
145
146
147

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

  vpx_codec_ctx_t      encoder_;
  vpx_codec_enc_cfg_t  cfg_;
  unsigned long        deadline_;
148
  unsigned long        init_flags_;
John Koleszar's avatar
John Koleszar committed
149
150
151
152
153
154
155
156
157
158
159
160
  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:
161
162
163
  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
164
165
166
167

  virtual ~EncoderTest() {}

  // Initialize the cfg_ member with the default configuration.
168
  void InitializeConfig();
John Koleszar's avatar
John Koleszar committed
169
170
171
172

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

173
  // Main loop
John Koleszar's avatar
John Koleszar committed
174
175
176
177
178
179
180
181
182
183
  virtual void RunLoop(VideoSource *video);

  // Hook to be called at the beginning of a pass.
  virtual void BeginPassHook(unsigned int pass) {}

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

  // Hook to be called before encoding a frame.
  virtual void PreEncodeFrameHook(VideoSource *video) {}
184
  virtual void PreEncodeFrameHook(VideoSource *video, Encoder *encoder) {}
John Koleszar's avatar
John Koleszar committed
185
186
187
188

  // Hook to be called on every compressed data packet.
  virtual void FramePktHook(const vpx_codec_cx_pkt_t *pkt) {}

189
190
191
  // Hook to be called on every PSNR packet.
  virtual void PSNRPktHook(const vpx_codec_cx_pkt_t *pkt) {}

John Koleszar's avatar
John Koleszar committed
192
193
194
  // Hook to determine whether the encode loop should continue.
  virtual bool Continue() const { return !abort_; }

195
  const CodecFactory   *codec_;
196
197
198
199
200
201
202
  // 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);

203
204
205
206
  // Hook to be called on every decompressed frame.
  virtual void DecompressedFrameHook(const vpx_image_t& img,
                                     vpx_codec_pts_t pts) {}

John Koleszar's avatar
John Koleszar committed
207
208
209
210
211
212
  // Hook that can modify the encoder's output data
  virtual const vpx_codec_cx_pkt_t * MutateEncoderOutputHook(
      const vpx_codec_cx_pkt_t *pkt) {
    return pkt;
  }

John Koleszar's avatar
John Koleszar committed
213
214
215
216
217
  bool                 abort_;
  vpx_codec_enc_cfg_t  cfg_;
  unsigned int         passes_;
  unsigned long        deadline_;
  TwopassStatsStore    stats_;
218
219
  unsigned long        init_flags_;
  unsigned long        frame_flags_;
220
  vpx_codec_pts_t      last_pts_;
John Koleszar's avatar
John Koleszar committed
221
222
223
224
225
};

}  // namespace libvpx_test

#endif  // TEST_ENCODE_TEST_DRIVER_H_