GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
sync_interpolator.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2008,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_RUNTIME_SYNC_INTERPOLATOR_H
24#define INCLUDED_GR_RUNTIME_SYNC_INTERPOLATOR_H
25
26#include <gnuradio/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30
31/*!
32 * \brief synchronous 1:N input to output with history
33 * \ingroup base_blk
34 *
35 * Override work to provide the signal processing implementation.
36 */
38{
39private:
40 unsigned d_interpolation;
41
42protected:
43 sync_interpolator(void) {} // allows pure virtual interface sub-classes
44 sync_interpolator(const std::string& name,
45 gr::io_signature::sptr input_signature,
46 gr::io_signature::sptr output_signature,
47 unsigned interpolation);
48
49public:
50 unsigned interpolation() const { return d_interpolation; }
51 void set_interpolation(unsigned interpolation)
52 {
53 d_interpolation = interpolation;
54 set_relative_rate((uint64_t)interpolation, 1);
55 set_output_multiple(interpolation);
56 }
57
58 // gr::sync_interpolator overrides these to assist work
59 void forecast(int noutput_items, gr_vector_int& ninput_items_required);
60 int general_work(int noutput_items,
61 gr_vector_int& ninput_items,
62 gr_vector_const_void_star& input_items,
63 gr_vector_void_star& output_items);
64
65 // derived classes should override work
66
69};
70
71} /* namespace gr */
72
73#endif /* INCLUDED_GR_RUNTIME_SYNC_INTERPOLATOR_H */
boost::shared_ptr< io_signature > sptr
Definition io_signature.h:46
synchronous 1:1 input to output with history
Definition sync_block.h:38
synchronous 1:N input to output with history
Definition sync_interpolator.h:38
unsigned interpolation() const
Definition sync_interpolator.h:50
int fixed_rate_noutput_to_ninput(int noutput)
Given noutput samples, return number of input samples required to produce noutput....
sync_interpolator(const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature, unsigned interpolation)
int general_work(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
compute output items from input items
void forecast(int noutput_items, gr_vector_int &ninput_items_required)
Estimate input requirements given output request.
sync_interpolator(void)
Definition sync_interpolator.h:43
int fixed_rate_ninput_to_noutput(int ninput)
Given ninput samples, return number of output samples that will be produced. N.B. this is only define...
void set_interpolation(unsigned interpolation)
Definition sync_interpolator.h:51
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46
std::vector< const void * > gr_vector_const_void_star
Definition types.h:40
std::vector< void * > gr_vector_void_star
Definition types.h:39
std::vector< int > gr_vector_int
Definition types.h:35