#
# Copyright 2011-2012, 2018 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.
#
from __future__ import print_function
from __future__ import unicode_literals
import numpy
from . import runtime_swig as gr
from .runtime_swig import io_signature, io_signaturev
from .runtime_swig import block_gw_message_type
from .runtime_swig import block_gateway
########################################################################
# Magic to turn pointers into numpy arrays
# http://docs.scipy.org/doc/numpy/reference/arrays.interface.html
########################################################################
def pointer_to_ndarray(addr, dtype, nitems):
class array_like(object):
__array_interface__ = {
'data' : (int(addr), False),
'typestr' : dtype.base.str,
'descr' : dtype.base.descr,
'shape' : (nitems,) + dtype.shape,
'strides' : None,
'version' : 3
}
return numpy.asarray(array_like()).view(dtype.base)
########################################################################
# Handler that does callbacks from C++
########################################################################
class gateway_handler(gr.feval_ll):
#don't put a constructor, it won't work
def init(self, callback):
self._callback = callback
def eval(self, arg):
try: self._callback()
except Exception as ex:
print("handler caught exception: %s"%ex)
import traceback; traceback.print_exc()
raise ex
return 0
########################################################################
# Handler that does callbacks from C++
########################################################################
class msg_handler(gr.feval_p):
#don't put a constructor, it won't work
def init(self, callback):
self._callback = callback
def eval(self, arg):
try: self._callback(arg)
except Exception as ex:
print("handler caught exception: %s"%ex)
import traceback; traceback.print_exc()
raise ex
return 0
########################################################################
# io_signature for Python
########################################################################
class py_io_signature(object):
"""
Describes the type/number of ports for block input or output.
"""
# Minimum and maximum number of ports, and a list of numpy types.
def __init__(self, min_ports, max_ports, type_list):
"""
Args:
min_ports (int): minimum number of connected ports.
max_ports (int): maximum number of connected ports. -1 indicates
no limit.
type_list (list[str]): numpy type names for each port. If the
number of connected ports is greater than the number of types
provided, the last type in the list is repeated.
"""
self.__min_ports = min_ports
self.__max_ports = max_ports
self.__types = tuple( numpy.dtype(t) for t in type_list )
def gr_io_signature(self):
"""
Make/return a gr.io_signature. A non-empty list of sizes is
required, even if there are no ports.
"""
return io_signaturev(self.__min_ports, self.__max_ports,
[t.itemsize for t in self.__types] or [0])
def port_types(self, nports):
"""
Return data types for the first nports ports. If nports is
smaller than the provided type list, return a truncated list. If
larger, fill with the last type.
"""
ntypes = len(self.__types)
if ntypes == 0:
return ()
if nports <= ntypes:
return self.__types[:nports]
return self.__types + [self.__types[-1]]*(nports-ntypes)
def __iter__(self):
"""
Return the iterator over the maximum ports type list.
"""
return iter(self.port_types(self.__max_ports))
def __hash__(self):
return hash((self.__min_ports, self.__max_ports, self.__types))
########################################################################
# The guts that make this into a gr block
########################################################################
class gateway_block(object):
def __init__(self, name, in_sig, out_sig, work_type, factor):
# Normalize the many Python ways of saying 'nothing' to '()'
in_sig = in_sig or ()
out_sig = out_sig or ()
# Backward compatibility: array of type strings -> py_io_signature
if type(in_sig) is py_io_signature:
self.__in_sig = in_sig
else:
self.__in_sig = py_io_signature(len(in_sig), len(in_sig), in_sig)
if type(out_sig) is py_io_signature:
self.__out_sig = out_sig
else:
self.__out_sig = py_io_signature(len(out_sig), len(out_sig), out_sig)
#create internal gateway block
self.__handler = gateway_handler()
self.__handler.init(self.__gr_block_handle)
self.__gateway = block_gateway(
self.__handler, name,
self.__in_sig.gr_io_signature(), self.__out_sig.gr_io_signature(),
work_type, factor)
self.__message = self.__gateway.block_message()
#dict to keep references to all message handlers
self.__msg_handlers = {}
#register block functions
prefix = 'block__'
for attr in [x for x in dir(self.__gateway) if x.startswith(prefix)]:
setattr(self, attr.replace(prefix, ''), getattr(self.__gateway, attr))
self.pop_msg_queue = lambda: gr.block_gw_pop_msg_queue_safe(self.__gateway)
def to_basic_block(self):
"""
Makes this block connectable by hier/top block python
"""
return self.__gateway.to_basic_block()
def __gr_block_handle(self):
"""
Dispatch tasks according to the action type specified in the message.
"""
if self.__message.action == gr.block_gw_message_type.ACTION_GENERAL_WORK:
# Actual number of inputs/output from scheduler
ninputs = len(self.__message.general_work_args_input_items)
noutputs = len(self.__message.general_work_args_output_items)
in_types = self.__in_sig.port_types(ninputs)
out_types = self.__out_sig.port_types(noutputs)
self.__message.general_work_args_return_value = self.general_work(
input_items=[pointer_to_ndarray(
self.__message.general_work_args_input_items[i],
in_types[i],
self.__message.general_work_args_ninput_items[i]
) for i in range(ninputs)],
output_items=[pointer_to_ndarray(
self.__message.general_work_args_output_items[i],
out_types[i],
self.__message.general_work_args_noutput_items
) for i in range(noutputs)],
)
elif self.__message.action == gr.block_gw_message_type.ACTION_WORK:
# Actual number of inputs/output from scheduler
ninputs = len(self.__message.work_args_input_items)
noutputs = len(self.__message.work_args_output_items)
in_types = self.__in_sig.port_types(ninputs)
out_types = self.__out_sig.port_types(noutputs)
self.__message.work_args_return_value = self.work(
input_items=[pointer_to_ndarray(
self.__message.work_args_input_items[i],
in_types[i],
self.__message.work_args_ninput_items
) for i in range(ninputs)],
output_items=[pointer_to_ndarray(
self.__message.work_args_output_items[i],
out_types[i],
self.__message.work_args_noutput_items
) for i in range(noutputs)],
)
elif self.__message.action == gr.block_gw_message_type.ACTION_FORECAST:
self.forecast(
noutput_items=self.__message.forecast_args_noutput_items,
ninput_items_required=self.__message.forecast_args_ninput_items_required,
)
elif self.__message.action == gr.block_gw_message_type.ACTION_START:
self.__message.start_args_return_value = self.start()
elif self.__message.action == gr.block_gw_message_type.ACTION_STOP:
self.__message.stop_args_return_value = self.stop()
def forecast(self, noutput_items, ninput_items_required):
"""
forecast is only called from a general block
this is the default implementation
"""
for i in range(len(ninput_items_required)):
ninput_items_required[i] = noutput_items + self.history() - 1
def general_work(self, *args, **kwargs):
"""general work to be overloaded in a derived class"""
raise NotImplementedError("general work not implemented")
def work(self, *args, **kwargs):
"""work to be overloaded in a derived class"""
raise NotImplementedError("work not implemented")
def start(self):
return True
def stop(self):
return True
def set_msg_handler(self, which_port, handler_func):
handler = msg_handler()
handler.init(handler_func)
self.__gateway.set_msg_handler_feval(which_port, handler)
# Save handler object in class so it's not garbage collected
self.__msg_handlers[which_port] = handler
def in_sig(self):
return self.__in_sig
def out_sig(self):
return self.__out_sig
########################################################################
# Wrappers for the user to inherit from
########################################################################
class basic_block(gateway_block):
"""Args:
name (str): block name
in_sig (gr.py_io_signature): input port signature
out_sig (gr.py_io_signature): output port signature
For backward compatibility, a sequence of numpy type names is also
accepted as an io signature.
"""
def __init__(self, name, in_sig, out_sig):
gateway_block.__init__(self,
name=name,
in_sig=in_sig,
out_sig=out_sig,
work_type=gr.GR_BLOCK_GW_WORK_GENERAL,
factor=1, #not relevant factor
)
class sync_block(gateway_block):
"""
Args:
name (str): block name
in_sig (gr.py_io_signature): input port signature
out_sig (gr.py_io_signature): output port signature
For backward compatibility, a sequence of numpy type names is also
accepted as an io signature.
"""
def __init__(self, name, in_sig, out_sig):
gateway_block.__init__(self,
name=name,
in_sig=in_sig,
out_sig=out_sig,
work_type=gr.GR_BLOCK_GW_WORK_SYNC,
factor=1,
)
class decim_block(gateway_block):
"""
Args:
name (str): block name
in_sig (gr.py_io_signature): input port signature
out_sig (gr.py_io_signature): output port signature
For backward compatibility, a sequence of numpy type names is also
accepted as an io signature.
"""
def __init__(self, name, in_sig, out_sig, decim):
gateway_block.__init__(self,
name=name,
in_sig=in_sig,
out_sig=out_sig,
work_type=gr.GR_BLOCK_GW_WORK_DECIM,
factor=decim,
)
class interp_block(gateway_block):
"""
Args:
name (str): block name
in_sig (gr.py_io_signature): input port signature
out_sig (gr.py_io_signature): output port signature
For backward compatibility, a sequence of numpy type names is also
accepted as an io signature.
"""
def __init__(self, name, in_sig, out_sig, interp):
gateway_block.__init__(self,
name=name,
in_sig=in_sig,
out_sig=out_sig,
work_type=gr.GR_BLOCK_GW_WORK_INTERP,
factor=interp,
)