uhd

//

// Copyright 2011 Ettus Research LLC

//

// This program 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 of the License, or

// (at your option) any later version.

//

// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

//

#ifndef INCLUDED_UHD_CONVERT_HPP

#define INCLUDED_UHD_CONVERT_HPP

#include <uhd/config.hpp>

#include <uhd/types/ref_vector.hpp>

#include <boost/function.hpp>

#include <boost/operators.hpp>

#include <string>

namespace uhd{ namespace convert{

    typedef uhd::ref_vector<void *> output_type;

    typedef uhd::ref_vector<const void *> input_type;

    //! input vectors, output vectors, num samples, scale factor

    typedef boost::function<void(const input_type&, const output_type&, const size_t, const double)> function_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.

     */

    enum priority_type{

        PRIORITY_GENERAL = 0,

        PRIORITY_LIBORC = 1,

        PRIORITY_CUSTOM = 2,

        PRIORITY_EMPTY = -1,

    };

    //! Identify a conversion routine in the registry

    struct id_type : boost::equality_comparable<id_type>{

        std::string input_markup;

        size_t num_inputs;

        std::string output_markup;

        size_t num_outputs;

        std::string args;

        std::string to_pp_string(void) const;

    };

    //! Implement equality_comparable interface

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

    /*!

     * Register a converter function.

     * \param id identify the conversion

     * \param fcn a pointer to the converter

     * \param prio the function priority

     */

    UHD_API void register_converter(

        const id_type &id,

        function_type fcn,

        priority_type prio

    );

    /*!

     * Get a converter function.

     * \param id identify the conversion

     * \return the converter function

     */

    UHD_API function_type get_converter(const id_type &id);

    /*!

     * Register the size of a particular item.

     * \param markup the item markup

     * \param size the size in bytes

     */

    UHD_API void register_bytes_per_item(

        const std::string &markup, const size_t size

    );

    //! Convert an item markup to a size in bytes

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

}} //namespace

#endif /* INCLUDED_UHD_CONVERT_HPP */