2012-05-17 00:27:00 +02:00
|
|
|
/*
|
|
|
|
* 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_
|
2013-01-15 15:43:35 +01:00
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
2013-05-04 04:08:08 +02:00
|
|
|
|
|
|
|
#include "./vpx_config.h"
|
2012-05-17 00:27:00 +02:00
|
|
|
#include "third_party/googletest/src/include/gtest/gtest.h"
|
|
|
|
#include "vpx/vpx_encoder.h"
|
|
|
|
|
|
|
|
namespace libvpx_test {
|
|
|
|
|
2013-01-18 20:51:12 +01:00
|
|
|
class CodecFactory;
|
2012-05-17 00:27:00 +02:00
|
|
|
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)
|
|
|
|
|
2012-05-23 21:55:27 +02:00
|
|
|
#define ONE_PASS_TEST_MODES ::testing::Values(::libvpx_test::kRealTime, \
|
|
|
|
::libvpx_test::kOnePassGood, \
|
|
|
|
::libvpx_test::kOnePassBest)
|
|
|
|
|
2013-01-18 20:51:12 +01:00
|
|
|
#define TWO_PASS_TEST_MODES ::testing::Values(::libvpx_test::kTwoPassGood, \
|
|
|
|
::libvpx_test::kTwoPassBest)
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
// Provides an object to handle the libvpx get_cx_data() iteration pattern
|
|
|
|
class CxDataIterator {
|
|
|
|
public:
|
|
|
|
explicit CxDataIterator(vpx_codec_ctx_t *encoder)
|
2013-05-04 04:08:08 +02:00
|
|
|
: encoder_(encoder), iter_(NULL) {}
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2012-10-02 18:36:41 +02:00
|
|
|
void Reset() {
|
|
|
|
buffer_.clear();
|
|
|
|
}
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
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,
|
2012-10-02 20:03:09 +02:00
|
|
|
const unsigned long init_flags, TwopassStatsStore *stats)
|
2013-01-18 20:51:12 +01:00
|
|
|
: cfg_(cfg), deadline_(deadline), init_flags_(init_flags), stats_(stats) {
|
2012-05-17 00:27:00 +02:00
|
|
|
memset(&encoder_, 0, sizeof(encoder_));
|
|
|
|
}
|
|
|
|
|
2013-05-04 04:08:08 +02:00
|
|
|
virtual ~Encoder() {
|
2012-05-17 00:27:00 +02:00
|
|
|
vpx_codec_destroy(&encoder_);
|
|
|
|
}
|
|
|
|
|
|
|
|
CxDataIterator GetCxData() {
|
|
|
|
return CxDataIterator(&encoder_);
|
|
|
|
}
|
|
|
|
|
2012-08-30 22:43:15 +02:00
|
|
|
const vpx_image_t *GetPreviewFrame() {
|
|
|
|
return vpx_codec_get_preview_frame(&encoder_);
|
|
|
|
}
|
2012-05-17 00:27:00 +02:00
|
|
|
// This is a thin wrapper around vpx_codec_encode(), so refer to
|
|
|
|
// vpx_encoder.h for its semantics.
|
2012-10-02 20:03:09 +02:00
|
|
|
void EncodeFrame(VideoSource *video, const unsigned long frame_flags);
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
// Convenience wrapper for EncodeFrame()
|
|
|
|
void EncodeFrame(VideoSource *video) {
|
|
|
|
EncodeFrame(video, 0);
|
|
|
|
}
|
|
|
|
|
2012-07-11 00:43:44 +02:00
|
|
|
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();
|
|
|
|
}
|
|
|
|
|
2013-02-06 21:44:20 +01:00
|
|
|
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();
|
|
|
|
}
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
void set_deadline(unsigned long deadline) {
|
|
|
|
deadline_ = deadline;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
2013-01-18 20:51:12 +01:00
|
|
|
virtual const vpx_codec_iface_t* CodecInterface() const = 0;
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
const char *EncoderError() {
|
|
|
|
const char *detail = vpx_codec_error_detail(&encoder_);
|
|
|
|
return detail ? detail : vpx_codec_error(&encoder_);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Encode an image
|
2012-10-02 20:03:09 +02:00
|
|
|
void EncodeFrameInternal(const VideoSource &video,
|
|
|
|
const unsigned long frame_flags);
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
// Flush the encoder on EOS
|
|
|
|
void Flush();
|
|
|
|
|
|
|
|
vpx_codec_ctx_t encoder_;
|
|
|
|
vpx_codec_enc_cfg_t cfg_;
|
|
|
|
unsigned long deadline_;
|
2012-10-02 20:03:09 +02:00
|
|
|
unsigned long init_flags_;
|
2012-05-17 00:27:00 +02:00
|
|
|
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:
|
2013-01-18 20:51:12 +01:00
|
|
|
explicit EncoderTest(const CodecFactory *codec)
|
|
|
|
: codec_(codec), abort_(false), init_flags_(0), frame_flags_(0),
|
|
|
|
last_pts_(0) {}
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
virtual ~EncoderTest() {}
|
|
|
|
|
|
|
|
// Initialize the cfg_ member with the default configuration.
|
2013-01-18 20:51:12 +01:00
|
|
|
void InitializeConfig();
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
// Map the TestMode enum to the deadline_ and passes_ variables.
|
|
|
|
void SetMode(TestMode mode);
|
|
|
|
|
2013-01-15 15:43:35 +01:00
|
|
|
// Main loop
|
2012-05-17 00:27:00 +02:00
|
|
|
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) {}
|
2012-07-11 00:43:44 +02:00
|
|
|
virtual void PreEncodeFrameHook(VideoSource *video, Encoder *encoder) {}
|
2012-05-17 00:27:00 +02:00
|
|
|
|
|
|
|
// Hook to be called on every compressed data packet.
|
|
|
|
virtual void FramePktHook(const vpx_codec_cx_pkt_t *pkt) {}
|
|
|
|
|
2012-10-02 20:27:29 +02:00
|
|
|
// Hook to be called on every PSNR packet.
|
|
|
|
virtual void PSNRPktHook(const vpx_codec_cx_pkt_t *pkt) {}
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
// Hook to determine whether the encode loop should continue.
|
|
|
|
virtual bool Continue() const { return !abort_; }
|
|
|
|
|
2013-01-18 20:51:12 +01:00
|
|
|
const CodecFactory *codec_;
|
2013-01-15 15:43:35 +01:00
|
|
|
// 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);
|
|
|
|
|
2013-02-06 21:44:20 +01:00
|
|
|
// Hook to be called on every decompressed frame.
|
|
|
|
virtual void DecompressedFrameHook(const vpx_image_t& img,
|
|
|
|
vpx_codec_pts_t pts) {}
|
|
|
|
|
2013-03-05 21:23:34 +01:00
|
|
|
// 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;
|
|
|
|
}
|
|
|
|
|
2012-05-17 00:27:00 +02:00
|
|
|
bool abort_;
|
|
|
|
vpx_codec_enc_cfg_t cfg_;
|
|
|
|
unsigned int passes_;
|
|
|
|
unsigned long deadline_;
|
|
|
|
TwopassStatsStore stats_;
|
2012-10-02 20:03:09 +02:00
|
|
|
unsigned long init_flags_;
|
|
|
|
unsigned long frame_flags_;
|
2012-08-08 23:16:08 +02:00
|
|
|
vpx_codec_pts_t last_pts_;
|
2012-05-17 00:27:00 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace libvpx_test
|
|
|
|
|
|
|
|
#endif // TEST_ENCODE_TEST_DRIVER_H_
|