gr_block_gateway.h

Go to the documentation of this file.

/*
 * Copyright 2011-2012 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 3, 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., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_GRBLOCK_GATEWAY_H
#define INCLUDED_GRBLOCK_GATEWAY_H

#include <gr_core_api.h>
#include <gr_block.h>
#include <gr_feval.h>

/*!
 * The work type enum tells the gateway what kind of block to implement.
 * The choices are familiar gnuradio block overloads (sync, decim, interp).
 */
enum gr_block_gw_work_type{
    GR_BLOCK_GW_WORK_GENERAL,
    GR_BLOCK_GW_WORK_SYNC,
    GR_BLOCK_GW_WORK_DECIM,
    GR_BLOCK_GW_WORK_INTERP,
};

/*!
 * Shared message structure between python and gateway.
 * Each action type represents a scheduler-called function.
 */
struct gr_block_gw_message_type{
    enum action_type{
        ACTION_GENERAL_WORK, //dispatch work
        ACTION_WORK, //dispatch work
        ACTION_FORECAST, //dispatch forecast
        ACTION_START, //dispatch start
        ACTION_STOP, //dispatch stop
    };

    action_type action;

    int general_work_args_noutput_items;
    std::vector<int> general_work_args_ninput_items;
    std::vector<void *> general_work_args_input_items; //TODO this should be const void*, but swig cant int cast it right
    std::vector<void *> general_work_args_output_items;
    int general_work_args_return_value;

    int work_args_ninput_items;
    int work_args_noutput_items;
    std::vector<void *> work_args_input_items; //TODO this should be const void*, but swig cant int cast it right
    std::vector<void *> work_args_output_items;
    int work_args_return_value;

    int forecast_args_noutput_items;
    std::vector<int> forecast_args_ninput_items_required;

    bool start_args_return_value;

    bool stop_args_return_value;
};

/*!
 * The gateway block which performs all the magic.
 *
 * The gateway provides access to all the gr_block routines.
 * The methods prefixed with gr_block__ are renamed
 * to class methods without the prefix in python.
 */
class GR_CORE_API gr_block_gateway : virtual public gr_block{
public:
    //! Provide access to the shared message object
    virtual gr_block_gw_message_type &gr_block_message(void) = 0;

    long gr_block__unique_id(void) const{
        return gr_block::unique_id();
    }

    std::string gr_block__name(void) const{
        return gr_block::name();
    }

    unsigned gr_block__history(void) const{
        return gr_block::history();
    }

    void gr_block__set_history(unsigned history){
        return gr_block::set_history(history);
    }

    void gr_block__set_fixed_rate(bool fixed_rate){
        return gr_block::set_fixed_rate(fixed_rate);
    }

    bool gr_block__fixed_rate(void) const{
        return gr_block::fixed_rate();
    }

    void gr_block__set_output_multiple(int multiple){
        return gr_block::set_output_multiple(multiple);
    }

    int gr_block__output_multiple(void) const{
        return gr_block::output_multiple();
    }

    void gr_block__consume(int which_input, int how_many_items){
        return gr_block::consume(which_input, how_many_items);
    }

    void gr_block__consume_each(int how_many_items){
        return gr_block::consume_each(how_many_items);
    }

    void gr_block__produce(int which_output, int how_many_items){
        return gr_block::produce(which_output, how_many_items);
    }

    void gr_block__set_relative_rate(double relative_rate){
        return gr_block::set_relative_rate(relative_rate);
    }

    double gr_block__relative_rate(void) const{
        return gr_block::relative_rate();
    }

    uint64_t gr_block__nitems_read(unsigned int which_input){
        return gr_block::nitems_read(which_input);
    }

    uint64_t gr_block__nitems_written(unsigned int which_output){
        return gr_block::nitems_written(which_output);
    }

    gr_block::tag_propagation_policy_t gr_block__tag_propagation_policy(void){
        return gr_block::tag_propagation_policy();
    }

    void gr_block__set_tag_propagation_policy(gr_block::tag_propagation_policy_t p){
        return gr_block::set_tag_propagation_policy(p);
    }

    void gr_block__add_item_tag(
        unsigned int which_output, const gr_tag_t &tag
    ){
        return gr_block::add_item_tag(which_output, tag);
    }

    void gr_block__add_item_tag(
        unsigned int which_output,
        uint64_t abs_offset,
        const pmt::pmt_t &key,
        const pmt::pmt_t &value,
        const pmt::pmt_t &srcid=pmt::PMT_F
    ){
        return gr_block::add_item_tag(which_output, abs_offset, key, value, srcid);
    }

    std::vector<gr_tag_t> gr_block__get_tags_in_range(
        unsigned int which_input,
        uint64_t abs_start,
        uint64_t abs_end
    ){
        std::vector<gr_tag_t> tags;
        gr_block::get_tags_in_range(tags, which_input, abs_start, abs_end);
        return tags;
    }

    std::vector<gr_tag_t> gr_block__get_tags_in_range(
        unsigned int which_input,
        uint64_t abs_start,
        uint64_t abs_end,
        const pmt::pmt_t &key
    ){
        std::vector<gr_tag_t> tags;
        gr_block::get_tags_in_range(tags, which_input, abs_start, abs_end, key);
        return tags;
    }

    /* Message passing interface */
    void gr_block__message_port_register_in(pmt::pmt_t port_id){
        gr_basic_block::message_port_register_in(port_id);
    }

    void gr_block__message_port_register_out(pmt::pmt_t port_id){
        gr_basic_block::message_port_register_out(port_id);
    }

    void gr_block__message_port_pub(pmt::pmt_t port_id, pmt::pmt_t msg){
        gr_basic_block::message_port_pub(port_id, msg);
    }

    void gr_block__message_port_sub(pmt::pmt_t port_id, pmt::pmt_t target){
        gr_basic_block::message_port_sub(port_id, target);
    }

    void gr_block__message_port_unsub(pmt::pmt_t port_id, pmt::pmt_t target){
        gr_basic_block::message_port_unsub(port_id, target);
    }
    
    pmt::pmt_t gr_block__message_ports_in(){
        return gr_basic_block::message_ports_in();
    }

    pmt::pmt_t gr_block__message_ports_out(){
        return gr_basic_block::message_ports_out();
    }

    void set_msg_handler_feval(pmt::pmt_t which_port, gr_feval_p *msg_handler)
    {
        if(msg_queue.find(which_port) == msg_queue.end()){ 
            throw std::runtime_error("attempt to set_msg_handler_feval() on bad input message port!"); 
        }
        d_msg_handlers_feval[which_port] = msg_handler;
    }

protected:
    typedef std::map<pmt::pmt_t, gr_feval_p *, pmt::pmt_comperator> msg_handlers_feval_t;
    msg_handlers_feval_t d_msg_handlers_feval;

    void dispatch_msg(pmt::pmt_t which_port, pmt::pmt_t msg){
        // Is there a handler?
        if (d_msg_handlers_feval.find(which_port) != d_msg_handlers_feval.end()){
            d_msg_handlers_feval[which_port]->calleval(msg); // Yes, invoke it.
        }
        else {
            // Pass to generic dispatcher if not found
            gr_basic_block::dispatch_msg(which_port, msg);
        }
    }
};

/*!
 * Make a new gateway block.
 * \param handler the swig director object with callback
 * \param name the name of the block (Ex: "Shirley")
 * \param in_sig the input signature for this block
 * \param out_sig the output signature for this block
 * \param work_type the type of block overload to implement
 * \param factor the decimation or interpolation factor
 * \return a new gateway block
 */
GR_CORE_API boost::shared_ptr<gr_block_gateway> gr_make_block_gateway(
    gr_feval_ll *handler,
    const std::string &name,
    gr_io_signature_sptr in_sig,
    gr_io_signature_sptr out_sig,
    const gr_block_gw_work_type work_type,
    const unsigned factor
);

#endif /* INCLUDED_GRBLOCK_GATEWAY_H */