atsc_rs_decoder.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2014 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */
 
#ifndef INCLUDED_DTV_ATSC_RS_DECODER_H
#define INCLUDED_DTV_ATSC_RS_DECODER_H
 
#include <gnuradio/dtv/api.h>
#include <gnuradio/sync_block.h>
 
namespace gr {
namespace dtv {
 
/*!
 * \brief ATSC Receiver Reed-Solomon Decoder
 *
 * \ingroup dtv_atsc
 */
class DTV_API atsc_rs_decoder : virtual public gr::sync_block
{
public:
    // gr::dtv::atsc_rs_decoder::sptr
    typedef std::shared_ptr<atsc_rs_decoder> sptr;
 
    /*!
     * Returns the number of errors corrected by the decoder.
     */
    virtual int num_errors_corrected() const = 0;
 
    /*!
     * Returns the number of bad packets rejected by the decoder.
     */
    virtual int num_bad_packets() const = 0;
 
    /*!
     * Returns the total number of packets seen by the decoder.
     */
    virtual int num_packets() const = 0;
 
    /*!
     * \brief Make a new instance of gr::dtv::atsc_rs_decoder.
     */
    static sptr make();
};
 
} /* namespace dtv */
} /* namespace gr */
 
#endif /* INCLUDED_DTV_ATSC_RS_DECODER_H */