/*!
 * \file pcps_acquisition_fine_doppler_cc.h
 * \brief This class implements a Parallel Code Phase Search Acquisition with multi-dwells and fine Doppler estimation
 * for GPS L1 C/A signal
 *
 *  Acquisition strategy (Kay Borre book).
 *  <ol>
 *  <li> Compute the input signal power estimation
 *  <li> Doppler serial search loop
 *  <li> Perform the FFT-based circular convolution (parallel time search)
 *  <li> Record the maximum peak and the associated synchronization parameters
 *  <li> Compute the test statistics and compare to the threshold
 *  <li> Declare positive or negative acquisition using a message port
 *  </ol>
 *
 * Kay Borre book: K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
 * "A Software-Defined GPS and Galileo Receiver. A Single-Frequency
 * Approach", Birkhauser, 2007. pp 81-84
 *
 * \authors <ul>
 *          <li> Javier Arribas, 2013. jarribas(at)cttc.es
 *          </ul>
 *
 * -----------------------------------------------------------------------------
 *
 * GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
 * This file is part of GNSS-SDR.
 *
 * Copyright (C) 2010-2020  (see AUTHORS file for a list of contributors)
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * -----------------------------------------------------------------------------
 */

#ifndef GNSS_SDR_PCPS_ACQUISITION_FINE_DOPPLER_CC_H
#define GNSS_SDR_PCPS_ACQUISITION_FINE_DOPPLER_CC_H

#include "acquisition_impl_interface.h"
#if ARMA_NO_BOUND_CHECKING
#define ARMA_NO_DEBUG 1
#endif

#include "acq_conf.h"
#include "channel_fsm.h"
#include "gnss_sdr_fft.h"
#include "gnss_synchro.h"
#include <armadillo>
#include <gnuradio/block.h>
#include <gnuradio/gr_complex.h>
#include <volk_gnsssdr/volk_gnsssdr_alloc.h>  // for volk_gnsssdr::vector
#include <cstdint>
#include <fstream>
#include <memory>
#include <string>
#include <utility>


/** \addtogroup Acquisition
 * \{ */
/** \addtogroup Acq_gnuradio_blocks
 * \{ */


class pcps_acquisition_fine_doppler_cc;

using pcps_acquisition_fine_doppler_cc_sptr = gnss_shared_ptr<pcps_acquisition_fine_doppler_cc>;

pcps_acquisition_fine_doppler_cc_sptr pcps_make_acquisition_fine_doppler_cc(const Acq_Conf& conf_);

/*!
 * \brief This class implements a Parallel Code Phase Search Acquisition.
 *
 */
class pcps_acquisition_fine_doppler_cc : public acquisition_impl_interface
{
public:
    /*!
     * \brief Default destructor.
     */
    ~pcps_acquisition_fine_doppler_cc() = default;

    /*!
     * \brief Set acquisition/tracking common Gnss_Synchro object pointer
     * to exchange synchronization data between acquisition and tracking blocks.
     * \param p_gnss_synchro Satellite information shared by the processing blocks.
     */
    inline void set_gnss_synchro(Gnss_Synchro* p_gnss_synchro) override
    {
        d_gnss_synchro = p_gnss_synchro;
    }

    /*!
     * \brief Returns the maximum peak of grid search.
     */
    inline unsigned int mag() const override
    {
        return d_test_statistics;
    }

    /*!
     * \brief Sets local code for PCPS acquisition algorithm.
     * \param code - Pointer to the PRN code.
     */
    void set_local_code(std::complex<float>* code) override;

    /*!
     * \brief Starts acquisition algorithm, turning from standby mode to
     * active mode
     * \param active - bool that activates/deactivates the block.
     */
    inline void set_active(bool active) override
    {
        if (!active)
            {
                d_state = 0;
            }

        d_active = active;
    }

    /*!
     * \brief Set acquisition channel unique ID
     * \param channel - receiver channel.
     */
    inline void set_channel(unsigned int channel) override
    {
        d_channel = channel;
        d_dump_channel = d_channel;
    }

    /*!
     * \brief Set channel fsm associated to this acquisition instance
     */
    inline void set_channel_fsm(std::weak_ptr<ChannelFsm> channel_fsm) override
    {
        d_channel_fsm = std::move(channel_fsm);
    }

    /*!
     * \brief Parallel Code Phase Search Acquisition signal processing.
     */
    int general_work(int noutput_items, gr_vector_int& ninput_items,
        gr_vector_const_void_star& input_items,
        gr_vector_void_star& output_items) override;

private:
    /*!
     * \brief Obtains the next power of 2 greater or equal to the input parameter
     * \param n - Integer value to obtain the next power of 2.
     */
    unsigned int nextPowerOf2(unsigned int n);

    void dump_results(int effective_fft_size);

    void forecast(int noutput_items, gr_vector_int& ninput_items_required) override;

    friend pcps_acquisition_fine_doppler_cc_sptr pcps_make_acquisition_fine_doppler_cc(const Acq_Conf& conf_);
    explicit pcps_acquisition_fine_doppler_cc(const Acq_Conf& conf_);

    int compute_and_accumulate_grid(gr_vector_const_void_star& input_items);
    int estimate_Doppler();
    float estimate_input_power(gr_vector_const_void_star& input_items);
    float compute_CAF();
    void reset_grid();
    void update_carrier_wipeoff();
    bool start() override;

    arma::fmat grid_;

    std::string d_satellite_str;

    const Acq_Conf d_acq_params;
    std::string d_dump_filename;

    Gnss_Synchro* d_gnss_synchro;

    int64_t d_dump_number;
    uint64_t d_sample_counter;

    float d_test_statistics;

    int d_positive_acq;
    int d_state;
    const int d_num_doppler_points;
    int d_well_count;
    int d_n_samples_in_buffer;
    const int d_fft_size;
    int d_gnuradio_forecast_samples;
    unsigned int d_channel;
    unsigned int d_dump_channel;

    bool d_active;
    bool d_dump;

    std::weak_ptr<ChannelFsm> d_channel_fsm;
    std::unique_ptr<gnss_fft_complex_fwd> d_fft_if;
    std::unique_ptr<gnss_fft_complex_rev> d_ifft;

    volk_gnsssdr::vector<volk_gnsssdr::vector<std::complex<float>>> d_grid_doppler_wipeoffs;
    volk_gnsssdr::vector<volk_gnsssdr::vector<float>> d_grid_data;
    volk_gnsssdr::vector<gr_complex> d_fft_codes;
    volk_gnsssdr::vector<gr_complex> d_10_ms_buffer;
    volk_gnsssdr::vector<float> d_magnitude;
};


/** \} */
/** \} */
#endif  // GNSS_SDR_PCPS_ACQUISITION_FINE_DOPPLER_CC_H
