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() {
  30     return vpx_codec_get_frame(decoder_, &iter_);
  31   }
  32
  33  private:
  34   vpx_codec_ctx_t  *decoder_;
  35   vpx_codec_iter_t  iter_;
  36 };
  37
  38 // Provides a simplified interface to manage one video decoding.
  39 // Similar to Encoder class, the exact services should be added
  40 // as more tests are added.
  41 class Decoder {
  42  public:
  43   Decoder(vpx_codec_dec_cfg_t cfg, unsigned long deadline)
  44       : cfg_(cfg), flags_(0), deadline_(deadline), init_done_(false) {
  45     memset(&decoder_, 0, sizeof(decoder_));
  46   }
  47
  48   Decoder(vpx_codec_dec_cfg_t cfg, const vpx_codec_flags_t flag,
  49           unsigned long deadline)  // NOLINT
  50       : cfg_(cfg), flags_(flag), deadline_(deadline), init_done_(false) {
  51     memset(&decoder_, 0, sizeof(decoder_));
  52   }
  53
  54   virtual ~Decoder() {
  55     vpx_codec_destroy(&decoder_);
  56   }
  57
  58   vpx_codec_err_t PeekStream(const uint8_t *cxdata, size_t size,
  59                              vpx_codec_stream_info_t *stream_info);
  60
  61   vpx_codec_err_t DecodeFrame(const uint8_t *cxdata, size_t size);
  62
  63   vpx_codec_err_t DecodeFrame(const uint8_t *cxdata, size_t size,
  64                               void *user_priv);
  65
  66   DxDataIterator GetDxData() {
  67     return DxDataIterator(&decoder_);
  68   }
  69
  70   void set_deadline(unsigned long deadline) {
  71     deadline_ = deadline;
  72   }
  73
  74   void Control(int ctrl_id, int arg) {
  75     InitOnce();
  76     const vpx_codec_err_t res = vpx_codec_control_(&decoder_, ctrl_id, arg);
  77     ASSERT_EQ(VPX_CODEC_OK, res) << DecodeError();
  78   }
  79
  80   void Control(int ctrl_id, const void *arg) {
  81     InitOnce();
  82     const vpx_codec_err_t res = vpx_codec_control_(&decoder_, ctrl_id, arg);
  83     ASSERT_EQ(VPX_CODEC_OK, res) << DecodeError();
  84   }
  85
  86   const char* DecodeError() {
  87     const char *detail = vpx_codec_error_detail(&decoder_);
  88     return detail ? detail : vpx_codec_error(&decoder_);
  89   }
  90
  91   // Passes the external frame buffer information to libvpx.
  92   vpx_codec_err_t SetFrameBufferFunctions(
  93       vpx_get_frame_buffer_cb_fn_t cb_get,
  94       vpx_release_frame_buffer_cb_fn_t cb_release, void *user_priv) {
  95     InitOnce();
  96     return vpx_codec_set_frame_buffer_functions(
  97         &decoder_, cb_get, cb_release, user_priv);
  98   }
  99
 100   const char* GetDecoderName() {
 101     return vpx_codec_iface_name(CodecInterface());
 102   }
 103
 104  protected:
 105   virtual vpx_codec_iface_t* CodecInterface() const = 0;
 106
 107   void InitOnce() {
 108     if (!init_done_) {
 109       const vpx_codec_err_t res = vpx_codec_dec_init(&decoder_,
 110                                                      CodecInterface(),
 111                                                      &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
 130   virtual void set_cfg(const vpx_codec_dec_cfg_t &dec_cfg);
 131   virtual void set_flags(const vpx_codec_flags_t flags);
 132
 133   // Hook to be called before decompressing every frame.
 134   virtual void PreDecodeFrameHook(const CompressedVideoSource& video,
 135                                   Decoder *decoder) {}
 136
 137   // Hook to be called to handle decode result. Return true to continue.
 138   virtual bool HandleDecodeResult(const vpx_codec_err_t res_dec,
 139                                   const CompressedVideoSource& /* video */,
 140                                   Decoder *decoder) {
 141     EXPECT_EQ(VPX_CODEC_OK, res_dec) << decoder->DecodeError();
 142     return VPX_CODEC_OK == res_dec;
 143   }
 144
 145   // Hook to be called on every decompressed frame.
 146   virtual void DecompressedFrameHook(const vpx_image_t& img,
 147                                      const unsigned int frame_number) {}
 148
 149  protected:
 150   explicit DecoderTest(const CodecFactory *codec) : codec_(codec), flags_(0) {
 151     memset(&cfg_, 0, sizeof(cfg_));
 152   }
 153
 154   virtual ~DecoderTest() {}
 155
 156   const CodecFactory *codec_;
 157   vpx_codec_dec_cfg_t cfg_;
 158   vpx_codec_flags_t   flags_;
 159 };
 160
 161 }  // namespace libvpx_test
 162
 163 #endif  // TEST_DECODE_TEST_DRIVER_H_