test/decode_test_driver.h

   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
  11 #ifndef TEST_DECODE_TEST_DRIVER_H_
  12 #define TEST_DECODE_TEST_DRIVER_H_
  13 #include <cstring>
  14 #include "third_party/googletest/src/include/gtest/gtest.h"
  15 #include "./vpx_config.h"
  16 #include "vpx/vpx_decoder.h"
  17
  18 namespace libvpx_test {
  19
  20 class CodecFactory;
  21 class CompressedVideoSource;
  22
  23 // Provides an object to handle decoding output
  24 class DxDataIterator {
  25  public:
  26   explicit DxDataIterator(vpx_codec_ctx_t *decoder)
  27       : decoder_(decoder), iter_(NULL) {}
  28
  29   const vpx_image_t *Next() { return vpx_codec_get_frame(decoder_, &iter_); }
  30
  31  private:
  32   vpx_codec_ctx_t *decoder_;
  33   vpx_codec_iter_t iter_;
  34 };
  35
  36 // Provides a simplified interface to manage one video decoding.
  37 // Similar to Encoder class, the exact services should be added
  38 // as more tests are added.
  39 class Decoder {
  40  public:
  41   Decoder(vpx_codec_dec_cfg_t cfg, unsigned long deadline)
  42       : cfg_(cfg), flags_(0), deadline_(deadline), init_done_(false) {
  43     memset(&decoder_, 0, sizeof(decoder_));
  44   }
  45
  46   Decoder(vpx_codec_dec_cfg_t cfg, const vpx_codec_flags_t flag,
  47           unsigned long deadline)  // NOLINT
  48       : cfg_(cfg),
  49         flags_(flag),
  50         deadline_(deadline),
  51         init_done_(false) {
  52     memset(&decoder_, 0, sizeof(decoder_));
  53   }
  54
  55   virtual ~Decoder() { vpx_codec_destroy(&decoder_); }
  56
  57   vpx_codec_err_t PeekStream(const uint8_t *cxdata, size_t size,
  58                              vpx_codec_stream_info_t *stream_info);
  59
  60   vpx_codec_err_t DecodeFrame(const uint8_t *cxdata, size_t size);
  61
  62   vpx_codec_err_t DecodeFrame(const uint8_t *cxdata, size_t size,
  63                               void *user_priv);
  64
  65   DxDataIterator GetDxData() { return DxDataIterator(&decoder_); }
  66
  67   void set_deadline(unsigned long deadline) { deadline_ = deadline; }
  68
  69   void Control(int ctrl_id, int arg) { Control(ctrl_id, arg, VPX_CODEC_OK); }
  70
  71   void Control(int ctrl_id, const void *arg) {
  72     InitOnce();
  73     const vpx_codec_err_t res = vpx_codec_control_(&decoder_, ctrl_id, arg);
  74     ASSERT_EQ(VPX_CODEC_OK, res) << DecodeError();
  75   }
  76
  77   void Control(int ctrl_id, int arg, vpx_codec_err_t expected_value) {
  78     InitOnce();
  79     const vpx_codec_err_t res = vpx_codec_control_(&decoder_, ctrl_id, arg);
  80     ASSERT_EQ(expected_value, res) << DecodeError();
  81   }
  82
  83   const char *DecodeError() {
  84     const char *detail = vpx_codec_error_detail(&decoder_);
  85     return detail ? detail : vpx_codec_error(&decoder_);
  86   }
  87
  88   // Passes the external frame buffer information to libvpx.
  89   vpx_codec_err_t SetFrameBufferFunctions(
  90       vpx_get_frame_buffer_cb_fn_t cb_get,
  91       vpx_release_frame_buffer_cb_fn_t cb_release, void *user_priv) {
  92     InitOnce();
  93     return vpx_codec_set_frame_buffer_functions(&decoder_, cb_get, cb_release,
  94                                                 user_priv);
  95   }
  96
  97   const char *GetDecoderName() const {
  98     return vpx_codec_iface_name(CodecInterface());
  99   }
 100
 101   bool IsVP8() const;
 102
 103   vpx_codec_ctx_t *GetDecoder() { return &decoder_; }
 104
 105  protected:
 106   virtual vpx_codec_iface_t *CodecInterface() const = 0;
 107
 108   void InitOnce() {
 109     if (!init_done_) {
 110       const vpx_codec_err_t res =
 111           vpx_codec_dec_init(&decoder_, CodecInterface(), &cfg_, flags_);
 112       ASSERT_EQ(VPX_CODEC_OK, res) << DecodeError();
 113       init_done_ = true;
 114     }
 115   }
 116
 117   vpx_codec_ctx_t decoder_;
 118   vpx_codec_dec_cfg_t cfg_;
 119   vpx_codec_flags_t flags_;
 120   unsigned int deadline_;
 121   bool init_done_;
 122 };
 123
 124 // Common test functionality for all Decoder tests.
 125 class DecoderTest {
 126  public:
 127   // Main decoding loop
 128   virtual void RunLoop(CompressedVideoSource *video);
 129   virtual void RunLoop(CompressedVideoSource *video,
 130                        const vpx_codec_dec_cfg_t &dec_cfg);
 131
 132   virtual void set_cfg(const vpx_codec_dec_cfg_t &dec_cfg);
 133   virtual void set_flags(const vpx_codec_flags_t flags);
 134
 135   // Hook to be called before decompressing every frame.
 136   virtual void PreDecodeFrameHook(const CompressedVideoSource & /*video*/,
 137                                   Decoder * /*decoder*/) {}
 138
 139   // Hook to be called to handle decode result. Return true to continue.
 140   virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec,
 141                                   const CompressedVideoSource & /*video*/,
 142                                   Decoder *decoder) {
 143     EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError();
 144     return VPX_CODEC_OK == res_dec;
 145   }
 146
 147   // Hook to be called on every decompressed frame.
 148   virtual void DecompressedFrameHook(const vpx_image_t & /*img*/,
 149                                      const unsigned int /*frame_number*/) {}
 150
 151   // Hook to be called on peek result
 152   virtual void HandlePeekResult(Decoder *const decoder,
 153                                 CompressedVideoSource *video,
 154                                 const vpx_codec_err_t res_peek);
 155
 156  protected:
 157   explicit DecoderTest(const CodecFactory *codec)
 158       : codec_(codec), cfg_(), flags_(0) {}
 159
 160   virtual ~DecoderTest() {}
 161
 162   const CodecFactory *codec_;
 163   vpx_codec_dec_cfg_t cfg_;
 164   vpx_codec_flags_t flags_;
 165 };
 166
 167 }  // namespace libvpx_test
 168
 169 #endif  // TEST_DECODE_TEST_DRIVER_H_