/*!
 * \file gps_l1_ca_dll_fll_pll_tracking_cc.h
 * \brief Interface of a code DLL + carrier FLL/PLL tracking block
 * \author Javier Arribas, 2011. jarribas(at)cttc.es
 *
 * This is the interface of a  code Delay Locked Loop (DLL) +
 * carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked
 * Loop (FLL) according to the algorithms described in:
 * E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
 * Applications, Second Edition, Artech House Publishers, 2005.
 *
 * -------------------------------------------------------------------------
 *
 * Copyright (C) 2010-2014  (see AUTHORS file for a list of contributors)
 *
 * GNSS-SDR is a software defined Global Navigation
 *          Satellite Systems receiver
 *
 * This file is part of GNSS-SDR.
 *
 * GNSS-SDR 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, either version 3 of the License, or
 * at your option) any later version.
 *
 * GNSS-SDR 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNSS-SDR. If not, see <http://www.gnu.org/licenses/>.
 *
 * -------------------------------------------------------------------------
 */

#ifndef GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H
#define	GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H

#include <fstream>
#include <queue>
#include <map>
#include <string>
#include <boost/thread/mutex.hpp>
#include <boost/thread/thread.hpp>
#include <gnuradio/block.h>
#include <gnuradio/msg_queue.h>
#include "concurrent_queue.h"
#include "gps_sdr_signal_processing.h"
#include "tracking_FLL_PLL_filter.h"
#include "tracking_2nd_DLL_filter.h"
#include "gnss_synchro.h"
#include "correlator.h"

class Gps_L1_Ca_Dll_Fll_Pll_Tracking_cc;

typedef boost::shared_ptr<Gps_L1_Ca_Dll_Fll_Pll_Tracking_cc>
gps_l1_ca_dll_fll_pll_tracking_cc_sptr;

gps_l1_ca_dll_fll_pll_tracking_cc_sptr
gps_l1_ca_dll_fll_pll_make_tracking_cc(
        long if_freq,
        long fs_in,
        unsigned int vector_length,
        boost::shared_ptr<gr::msg_queue> queue,
        bool dump,
        std::string dump_filename,
        int order,
        float fll_bw_hz,
        float pll_bw_hz,
        float dll_bw_hz,
        float early_late_space_chips);


/*!
 * \brief This class implements a DLL and a FLL assisted PLL tracking loop block
 */
class Gps_L1_Ca_Dll_Fll_Pll_Tracking_cc: public gr::block
{
public:
    ~Gps_L1_Ca_Dll_Fll_Pll_Tracking_cc();

    void set_channel(unsigned int channel);
    void start_tracking();
    void update_local_code();
    void update_local_carrier();
    void set_FLL_and_PLL_BW(float fll_bw_hz,float pll_bw_hz);
    /*
     * \brief Satellite signal synchronization parameters uses shared memory between acquisition and tracking
     */
    void set_gnss_synchro(Gnss_Synchro* p_gnss_synchro);
    void set_channel_queue(concurrent_queue<int> *channel_internal_queue);

    /*
     * \brief just like gr_block::general_work, only this arranges to call consume_each for you
     *
     * The user must override work to define the signal processing code
     */

    int general_work (int noutput_items, gr_vector_int &ninput_items,
            gr_vector_const_void_star &input_items, gr_vector_void_star &output_items);

    void forecast (int noutput_items, gr_vector_int &ninput_items_required);
private:
    friend gps_l1_ca_dll_fll_pll_tracking_cc_sptr
    gps_l1_ca_dll_fll_pll_make_tracking_cc(
            long if_freq,
            long fs_in, unsigned
            int vector_length,
            boost::shared_ptr<gr::msg_queue> queue,
            bool dump,
            std::string dump_filename,
            int order,
            float fll_bw_hz,
            float pll_bw_hz,
            float dll_bw_hz,
            float early_late_space_chips);

    Gps_L1_Ca_Dll_Fll_Pll_Tracking_cc(
            long if_freq,
            long fs_in, unsigned
            int vector_length,
            boost::shared_ptr<gr::msg_queue> queue,
            bool dump,
            std::string dump_filename,
            int order,
            float fll_bw_hz,
            float pll_bw_hz,
            float dll_bw_hz,
            float early_late_space_chips);

    void CN0_estimation_and_lock_detectors();

    // class private vars
    Gnss_Synchro *d_acquisition_gnss_synchro;
    boost::shared_ptr<gr::msg_queue> d_queue;
    concurrent_queue<int> *d_channel_internal_queue;
    unsigned int d_vector_length;
    bool d_dump;
    unsigned int d_channel;
    int d_last_seg;
    double d_if_freq;
    double d_fs_in;

    gr_complex* d_ca_code;

    gr_complex* d_early_code;
    gr_complex* d_late_code;
    gr_complex* d_prompt_code;

    gr_complex* d_carr_sign;

    gr_complex* d_Early;
    gr_complex* d_Prompt;
    gr_complex* d_Late;

    gr_complex d_Prompt_prev;

    double d_early_late_spc_chips;

    double d_carrier_doppler_hz;
    double d_code_freq_hz;
    double d_code_phase_samples;
    int d_current_prn_length_samples;
    //int d_next_prn_length_samples;
    int d_FLL_wait;
    double d_rem_carr_phase;
    double d_rem_code_phase_samples;
    //double d_next_rem_code_phase_samples;
    bool d_pull_in;

    // acquisition
    double d_acq_code_phase_samples;
    double d_acq_carrier_doppler_hz;

    // correlator
    Correlator d_correlator;

    // FLL + PLL filter
    double d_FLL_discriminator_hz; // This is a class variable because FLL needs to have memory
    Tracking_FLL_PLL_filter d_carrier_loop_filter;
    double d_acc_carrier_phase_rad;
    double d_acc_code_phase_samples;

    Tracking_2nd_DLL_filter d_code_loop_filter;

    unsigned long int d_sample_counter;

    unsigned long int d_acq_sample_stamp;

    // CN0 estimation and lock detector
    int d_cn0_estimation_counter;
    gr_complex* d_Prompt_buffer;
    double d_carrier_lock_test;
    double d_CN0_SNV_dB_Hz;

    double d_carrier_lock_threshold;

    int d_carrier_lock_fail_counter;

    bool d_enable_tracking;

    std::string d_dump_filename;
    std::ofstream d_dump_file;

    std::map<std::string, std::string> systemName;
    std::string sys;
};

#endif //GNSS_SDR_GPS_L1_CA_DLL_FLL_PLL_TRACKING_CC_H