UHD  003.001.002
Typedefs | Enumerations | Functions
uhd::convert Namespace Reference

Typedefs

typedef uhd::ref_vector< void * > output_type
 
typedef uhd::ref_vector< const void * > input_type
 
typedef boost::function< void(const input_type &, const output_type &, size_t)> function_type
 

Enumerations

enum  priority_type { PRIORITY_GENERAL = 0, PRIORITY_LIBORC = 1, PRIORITY_CUSTOM = 2, PRIORITY_EMPTY = -1 }
 

Functions

UHD_API void register_converter (const std::string &markup, function_type fcn, priority_type prio)
 
UHD_API const function_typeget_converter_cpu_to_otw (const io_type_t &io_type, const otw_type_t &otw_type, size_t num_input_buffs, size_t num_output_buffs)
 
UHD_API const function_typeget_converter_otw_to_cpu (const io_type_t &io_type, const otw_type_t &otw_type, size_t num_input_buffs, size_t num_output_buffs)
 

Typedef Documentation

◆ function_type

typedef boost::function<void(const input_type&, const output_type&, size_t)> uhd::convert::function_type

◆ input_type

◆ output_type

Enumeration Type Documentation

◆ priority_type

Describe the priority of a converter function. A higher priority function takes precedence. The general case function are the lowest. Next comes the liborc implementations. Custom intrinsics implementations are highest.

Enumerator
PRIORITY_GENERAL 
PRIORITY_LIBORC 
PRIORITY_CUSTOM 
PRIORITY_EMPTY 

Function Documentation

◆ get_converter_cpu_to_otw()

UHD_API const function_type& uhd::convert::get_converter_cpu_to_otw ( const io_type_t io_type,
const otw_type_t otw_type,
size_t  num_input_buffs,
size_t  num_output_buffs 
)

Get a converter function that converts cpu to otw.

Parameters
io_typethe type of the input samples
otw_typethe type of the output samples
num_input_buffsthe number of inputs
num_output_buffsthe number of outputs

◆ get_converter_otw_to_cpu()

UHD_API const function_type& uhd::convert::get_converter_otw_to_cpu ( const io_type_t io_type,
const otw_type_t otw_type,
size_t  num_input_buffs,
size_t  num_output_buffs 
)

Get a converter function that converts otw to cpu.

Parameters
io_typethe type of the input samples
otw_typethe type of the output samples
num_input_buffsthe number of inputs
num_output_buffsthe number of outputs

◆ register_converter()

UHD_API void uhd::convert::register_converter ( const std::string &  markup,
function_type  fcn,
priority_type  prio 
)

Register a converter function that converts cpu type to/from otw type.

Parameters
markuprepresenting the signature
fcna pointer to the converter
priothe function priority