convert.hpp

Go to the documentation of this file.

//
// Copyright 2011-2012,2014 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_CONVERT_HPP
#define INCLUDED_UHD_CONVERT_HPP

#include <uhd/config.hpp>
#include <uhd/types/ref_vector.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <boost/operators.hpp>
#include <string>

namespace uhd{ namespace convert{

    class converter{
    public:
        typedef boost::shared_ptr<converter> sptr;
        typedef uhd::ref_vector<void *> output_type;
        typedef uhd::ref_vector<const void *> input_type;

        virtual ~converter(void) = 0;

        virtual void set_scalar(const double) = 0;

        UHD_INLINE void conv(const input_type &in, const output_type &out, const size_t num){
            if (num != 0) (*this)(in, out, num);
        }

    private:
        //
        // This is the guts of the converter. When deriving new converter types,
        // this is where the actual conversion routines go.
        //
        // \param in Pointers to the input buffers
        // \param out Pointers to the output buffers
        // \param num Number of items in the input buffers to convert
        virtual void operator()(const input_type& in, const output_type& out, const size_t num) = 0;
    };

    typedef boost::function<converter::sptr(void)> function_type;

    typedef int priority_type;

    struct UHD_API id_type : boost::equality_comparable<id_type>{
        std::string input_format;
        size_t num_inputs;
        std::string output_format;
        size_t num_outputs;
        std::string to_pp_string(void) const;
        std::string to_string(void) const;
    };

    UHD_API bool operator==(const id_type &, const id_type &);

    UHD_API void register_converter(
        const id_type &id,
        const function_type &fcn,
        const priority_type prio
    );

    UHD_API function_type get_converter(
        const id_type &id,
        const priority_type prio = -1
    );

    UHD_API void register_bytes_per_item(
        const std::string &format, const size_t size
    );

    UHD_API size_t get_bytes_per_item(const std::string &format);

}} //namespace

#endif /* INCLUDED_UHD_CONVERT_HPP */