Home | History | Annotate | Download | only in test
      1 /*
      2  * Copyright (c) 2016, Alliance for Open Media. All rights reserved
      3  *
      4  * This source code is subject to the terms of the BSD 2 Clause License and
      5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
      6  * was not distributed with this source code in the LICENSE file, you can
      7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
      8  * Media Patent License 1.0 was not distributed with this source code in the
      9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
     10  */
     11 
     12 #ifndef AOM_TEST_FUNCTION_EQUIVALENCE_TEST_H_
     13 #define AOM_TEST_FUNCTION_EQUIVALENCE_TEST_H_
     14 
     15 #include "third_party/googletest/src/googletest/include/gtest/gtest.h"
     16 #include "test/acm_random.h"
     17 #include "test/clear_system_state.h"
     18 #include "test/util.h"
     19 
     20 using libaom_test::ACMRandom;
     21 
     22 namespace libaom_test {
     23 // Base class for tests that compare 2 implementations of the same function
     24 // for equivalence. The template parameter should be pointer to a function
     25 // that is being tested.
     26 //
     27 // The test takes a 3-parameters encapsulating struct 'FuncParam', containing:
     28 //   - Pointer to reference function
     29 //   - Pointer to tested function
     30 //   - Integer bit depth (default to 0).
     31 //
     32 // These values are then accessible in the tests as member of params_:
     33 // params_.ref_func, params_.tst_func, and params_.bit_depth.
     34 //
     35 
     36 template <typename T>
     37 struct FuncParam {
     38   FuncParam(T ref = NULL, T tst = NULL, int bit_depth = 0)
     39       : ref_func(ref), tst_func(tst), bit_depth(bit_depth) {}
     40   T ref_func;
     41   T tst_func;
     42   int bit_depth;
     43 };
     44 
     45 template <typename T>
     46 std::ostream &operator<<(std::ostream &os, const FuncParam<T> &p) {
     47   return os << "bit_depth:" << p.bit_depth
     48             << " function:" << reinterpret_cast<const void *>(p.ref_func)
     49             << " function:" << reinterpret_cast<const void *>(p.tst_func);
     50 }
     51 
     52 template <typename T>
     53 class FunctionEquivalenceTest : public ::testing::TestWithParam<FuncParam<T> > {
     54  public:
     55   FunctionEquivalenceTest() : rng_(ACMRandom::DeterministicSeed()) {}
     56 
     57   virtual ~FunctionEquivalenceTest() {}
     58 
     59   virtual void SetUp() { params_ = this->GetParam(); }
     60 
     61   virtual void TearDown() { libaom_test::ClearSystemState(); }
     62 
     63  protected:
     64   ACMRandom rng_;
     65   FuncParam<T> params_;
     66 };
     67 
     68 }  // namespace libaom_test
     69 #endif  // AOM_TEST_FUNCTION_EQUIVALENCE_TEST_H_
     70