stream.hpp

Go to the documentation of this file.

//
// Copyright 2011-2013 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#pragma once
 
#include <uhd/config.hpp>
#include <uhd/rfnoc/actions.hpp>
#include <uhd/types/device_addr.hpp>
#include <uhd/types/ref_vector.hpp>
#include <uhd/types/stream_cmd.hpp>
#include <uhd/utils/noncopyable.hpp>
#include <cstddef>
#include <memory>
#include <string>
#include <vector>
 
namespace uhd {
struct async_metadata_t;
struct rx_metadata_t;
struct tx_metadata_t;
 
struct UHD_API stream_args_t
{
    stream_args_t(const std::string& cpu = "", const std::string& otw = "")
    {
        cpu_format = cpu;
        otw_format = otw;
    }
 
    std::string cpu_format;
 
    std::string otw_format;
 
    device_addr_t args;
 
    std::vector<size_t> channels;
};
 
class UHD_API rx_streamer : uhd::noncopyable
{
public:
    typedef std::shared_ptr<rx_streamer> sptr;
 
    virtual ~rx_streamer(void);
 
    virtual size_t get_num_channels(void) const = 0;
 
    virtual size_t get_max_num_samps(void) const = 0;
 
    typedef ref_vector<void*> buffs_type;
 
    virtual size_t recv(const buffs_type& buffs,
        const size_t nsamps_per_buff,
        rx_metadata_t& metadata,
        const double timeout  = 0.1,
        const bool one_packet = false) = 0;
 
    virtual void issue_stream_cmd(const stream_cmd_t& stream_cmd) = 0;
 
    virtual void post_input_action(
        const std::shared_ptr<uhd::rfnoc::action_info>& action, const size_t port) = 0;
};
 
class UHD_API tx_streamer : uhd::noncopyable
{
public:
    typedef std::shared_ptr<tx_streamer> sptr;
 
    virtual ~tx_streamer(void);
 
    virtual size_t get_num_channels(void) const = 0;
 
    virtual size_t get_max_num_samps(void) const = 0;
 
    typedef ref_vector<const void*> buffs_type;
 
    virtual size_t send(const buffs_type& buffs,
        const size_t nsamps_per_buff,
        const tx_metadata_t& metadata,
        const double timeout = 0.1) = 0;
 
    virtual bool recv_async_msg(
        async_metadata_t& async_metadata, double timeout = 0.1) = 0;
 
    virtual void post_output_action(
        const std::shared_ptr<uhd::rfnoc::action_info>& action, const size_t port) = 0;
};
 
} // namespace uhd