///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2012 maintech GmbH, Otto-Hahn-Str. 15, 97204 Hoechberg, Germany //
// written by Christian Daniel                                                   //
// Copyright (C) 2015-2016, 2018-2019 Edouard Griffiths, F4EXB <f4exb06@gmail.com> //
//                                                                               //
// This program is free software; you can redistribute it and/or modify          //
// it under the terms of the GNU General Public License as published by          //
// the Free Software Foundation as version 3 of the License, or                  //
// (at your option) any later version.                                           //
//                                                                               //
// This program is distributed in the hope that it will be useful,               //
// but WITHOUT ANY WARRANTY; without even the implied warranty of                //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                  //
// GNU General Public License V3 for more details.                               //
//                                                                               //
// You should have received a copy of the GNU General Public License             //
// along with this program. If not, see <http://www.gnu.org/licenses/>.          //
///////////////////////////////////////////////////////////////////////////////////

#ifndef SDRBASE_UTIL_FIXEDTRAITS_H_
#define SDRBASE_UTIL_FIXEDTRAITS_H_

#include <stdint.h>

#include "export.h"

template<uint32_t IntBits>
class FixedTraits
{
};

template<>
struct SDRBASE_API FixedTraits<28>
{
    static const uint32_t fixed_resolution_shift = 28; //!< 1.0 representation. 28 is the highest power of two that can represent 9.99999... safely on 64 bits internally
    static const int64_t  fixed_resolution       = 1LL << fixed_resolution_shift;
    static const int32_t  max_power              = 63 - fixed_resolution_shift;
    static const int64_t  internal_pi            = 0x3243f6a8;
    static const int64_t  internal_two_pi        = 0x6487ed51;
    static const int64_t  internal_half_pi       = 0x1921fb54;
    static const int64_t  internal_quarter_pi    = 0xc90fdaa;
    static const int64_t  log_two_power_n_reversed[35]; // 35 = 63 - 28
    static const int64_t  log_one_plus_two_power_minus_n[28];
    static const int64_t  log_one_over_one_minus_two_power_minus_n[28];
    static const int64_t  arctantab[32];
};

template<>
struct SDRBASE_API FixedTraits<16>
{
    static const uint32_t fixed_resolution_shift = 16;
    static const int64_t  fixed_resolution       = 1LL << fixed_resolution_shift;
    static const int32_t  max_power              = 63 - fixed_resolution_shift;
    static const int64_t  internal_pi            = 205887;
    static const int64_t  internal_two_pi        = 411775;
    static const int64_t  internal_half_pi       = 102944;
    static const int64_t  internal_quarter_pi    = 51472;
    static const int64_t  log_two_power_n_reversed[47]; // 47 = 63 - 16
    static const int64_t  log_one_plus_two_power_minus_n[16];
    static const int64_t  log_one_over_one_minus_two_power_minus_n[16];
    static const int64_t  arctantab[32];
};

template<>
struct SDRBASE_API FixedTraits<23>
{
    static const uint32_t fixed_resolution_shift = 23;
    static const int64_t  fixed_resolution       = 1LL << fixed_resolution_shift;
    static const int32_t  max_power              = 63 - fixed_resolution_shift;
    static const int64_t  internal_pi            = 26353589;
    static const int64_t  internal_two_pi        = 52707179;
    static const int64_t  internal_half_pi       = 13176795;
    static const int64_t  internal_quarter_pi    = 6588397;
    static const int64_t  log_two_power_n_reversed[40]; // 40 = 63 - 23
    static const int64_t  log_one_plus_two_power_minus_n[23];
    static const int64_t  log_one_over_one_minus_two_power_minus_n[23];
    static const int64_t  arctantab[32];
};

template<>
struct SDRBASE_API FixedTraits<24>
{
    static const uint32_t fixed_resolution_shift = 24;
    static const int64_t  fixed_resolution       = 1LL << fixed_resolution_shift;
    static const int32_t  max_power              = 63 - fixed_resolution_shift;
    static const int64_t  internal_pi            = 52707179;
    static const int64_t  internal_two_pi        = 105414357;
    static const int64_t  internal_half_pi       = 26353589;
    static const int64_t  internal_quarter_pi    = 13176795;
    static const int64_t  log_two_power_n_reversed[39]; // 39 = 63 - 24
    static const int64_t  log_one_plus_two_power_minus_n[24];
    static const int64_t  log_one_over_one_minus_two_power_minus_n[24];
    static const int64_t  arctantab[32];
};

#endif /* SDRBASE_UTIL_FIXEDTRAITS_H_ */
