/* -*- c++ -*- */

/*

 * Copyright 2004,206 Free Software Foundation, Inc.

 * 

 * This file is part of GNU Radio

 * 

 * GNU Radio 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 2, or (at your option)

 * any later version.

 * 

 * GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to

 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

#ifndef INCLUDED_GR_PLL_CARRIERTRACKING_CC_H

#define INCLUDED_GR_PLL_CARRIERTRACKING_CC_H

#include <gr_sync_block.h>

class gr_pll_carriertracking_cc;

typedef boost::shared_ptr<gr_pll_carriertracking_cc> gr_pll_carriertracking_cc_sptr;

gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,

                                               float max_freq, float min_freq);

/*!

 * \brief Implements a PLL which locks to the input frequency and outputs the 

 * input signal mixed with that carrier.

 * \ingroup block

 *

 * input: stream of complex; output: stream of complex

 *

 * This PLL locks onto a [possibly noisy] reference carrier on

 * the input and outputs that signal, downconverted to DC

 * 

 * All settings max_freq and min_freq are in terms of radians per sample, 

 * NOT HERTZ.  Alpha is the phase gain (first order, units of radians per radian) 

 * and beta is the frequency gain (second order, units of radians per sample per radian)

 * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc

 */

class gr_pll_carriertracking_cc : public gr_sync_block

{

  friend gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, float beta,

                                                        float max_freq, float min_freq);

  float d_alpha,d_beta,d_max_freq,d_min_freq,d_phase,d_freq,d_locksig,d_lock_threshold;

  bool d_squelch_enable;

  gr_pll_carriertracking_cc (float alpha, float beta, float max_freq, float min_freq);

  int work (int noutput_items,

            gr_vector_const_void_star &input_items,

            gr_vector_void_star &output_items);

private:

  float mod_2pi (float in);

  float phase_detector(gr_complex sample,float ref_phase);

public:

  bool lock_detector(void);

  bool  squelch_enable(bool);

  float set_lock_threshold(float);

};

#endif