uhd/host/examples/tx_waveforms.cpp

//
// Copyright 2010 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/>.
//

#include <uhd/utils/thread_priority.hpp>
#include <uhd/utils/safe_main.hpp>
#include <uhd/utils/static.hpp>
#include <uhd/usrp/single_usrp.hpp>
#include <boost/program_options.hpp>
#include <boost/thread/thread_time.hpp> //system time
#include <boost/math/special_functions/round.hpp>
#include <boost/format.hpp>
#include <boost/function.hpp>
#include <iostream>
#include <complex>
#include <cmath>

namespace po = boost::program_options;

/***********************************************************************
 * Waveform generators
 **********************************************************************/
float gen_const(float){
    return 1;
}

float gen_square(float x){
    return float((std::fmod(x, 1) < float(0.5))? 0 : 1);
}

float gen_ramp(float x){
    return std::fmod(x, 1)*2 - 1;
}

#define sine_table_len 2048
static float sine_table[sine_table_len];
UHD_STATIC_BLOCK(gen_sine_table){
    static const float m_pi = std::acos(float(-1));
    for (size_t i = 0; i < sine_table_len; i++)
        sine_table[i] = std::sin((2*m_pi*i)/sine_table_len);
}

float gen_sine(float x){
    return sine_table[size_t(x*sine_table_len)%sine_table_len];
}

int UHD_SAFE_MAIN(int argc, char *argv[]){
    uhd::set_thread_priority_safe();

    //variables to be set by po
    std::string args, wave_type;
    size_t total_duration, spb;
    double rate, freq, wave_freq;
    float ampl, gain;

    //setup the program options
    po::options_description desc("Allowed options");
    desc.add_options()
        ("help", "help message")
        ("args", po::value<std::string>(&args)->default_value(""), "single uhd device address args")
        ("duration", po::value<size_t>(&total_duration)->default_value(3), "number of seconds to transmit")
        ("spb", po::value<size_t>(&spb)->default_value(10000), "samples per buffer")
        ("rate", po::value<double>(&rate)->default_value(1.5e6), "rate of outgoing samples")
        ("freq", po::value<double>(&freq)->default_value(0), "rf center frequency in Hz")
        ("ampl", po::value<float>(&ampl)->default_value(float(0.3)), "amplitude of the waveform")
        ("gain", po::value<float>(&gain)->default_value(float(0)), "gain for the RF chain")
        ("wave-type", po::value<std::string>(&wave_type)->default_value("CONST"), "waveform type (CONST, SQUARE, RAMP, SINE)")
        ("wave-freq", po::value<double>(&wave_freq)->default_value(0), "waveform frequency in Hz")
    ;
    po::variables_map vm;
    po::store(po::parse_command_line(argc, argv, desc), vm);
    po::notify(vm);

    //print the help message
    if (vm.count("help")){
        std::cout << boost::format("UHD TX Waveforms %s") % desc << std::endl;
        return ~0;
    }

    //create a usrp device
    std::cout << std::endl;
    std::cout << boost::format("Creating the usrp device with: %s...") % args << std::endl;
    uhd::usrp::single_usrp::sptr sdev = uhd::usrp::single_usrp::make(args);
    uhd::device::sptr dev = sdev->get_device();
    std::cout << boost::format("Using Device: %s") % sdev->get_pp_string() << std::endl;

    //set the tx sample rate
    std::cout << boost::format("Setting TX Rate: %f Msps...") % (rate/1e6) << std::endl;
    sdev->set_tx_rate(rate);
    std::cout << boost::format("Actual TX Rate: %f Msps...") % (sdev->get_tx_rate()/1e6) << std::endl << std::endl;

    //set the tx center frequency
    std::cout << boost::format("Setting TX Freq: %f Mhz...") % (freq/1e6) << std::endl;
    sdev->set_tx_freq(freq);
    std::cout << boost::format("Actual TX Freq: %f Mhz...") % (sdev->get_tx_freq()/1e6) << std::endl << std::endl;

    //set the tx rf gain
    std::cout << boost::format("Setting TX Gain: %f dB...") % gain << std::endl;
    sdev->set_tx_gain(gain);
    std::cout << boost::format("Actual TX Gain: %f dB...") % sdev->get_tx_gain() << std::endl << std::endl;

    //for the const wave, set the wave freq for small samples per period
    if (wave_freq == 0 and wave_type == "CONST"){
        wave_freq = sdev->get_tx_rate()/2;
    }

    //error when the waveform is not possible to generate
    if (std::abs(wave_freq) > sdev->get_tx_rate()/2){
        throw std::runtime_error("wave freq out of Nyquist zone");
    }
    if (sdev->get_tx_rate()/std::abs(wave_freq) > sine_table_len/2 and wave_type == "SINE"){
        throw std::runtime_error("sine freq too small for table");
    }

    //store the generator function for the selected waveform
    boost::function<float(float)> wave_gen;
    if      (wave_type == "CONST")  wave_gen = &gen_const;
    else if (wave_type == "SQUARE") wave_gen = &gen_square;
    else if (wave_type == "RAMP")   wave_gen = &gen_ramp;
    else if (wave_type == "SINE")   wave_gen = &gen_sine;
    else throw std::runtime_error("unknown waveform type: " + wave_type);

    //allocate the buffer and precalculate values
    std::vector<std::complex<float> > buff(spb);
    const float cps = float(wave_freq/sdev->get_tx_rate());
    const float i_off = (wave_freq > 0)? float(0.25) : 0;
    const float q_off = (wave_freq < 0)? float(0.25) : 0;
    float theta = 0;

    //setup the metadata flags
    uhd::tx_metadata_t md;
    md.start_of_burst = true; //always SOB (good for continuous streaming)
    md.end_of_burst   = false;

    //send the data in multiple packets
    boost::system_time end_time(boost::get_system_time() + boost::posix_time::seconds(total_duration));
    while(end_time > boost::get_system_time()){

        //fill the buffer with the waveform
        for (size_t n = 0; n < buff.size(); n++){
            buff[n] = std::complex<float>(
                ampl*wave_gen(i_off + theta),
                ampl*wave_gen(q_off + theta)
            );
            theta += cps;
        }

        //bring the theta back into range [0, 1)
        theta = std::fmod(theta, 1);

        //send the entire contents of the buffer
        dev->send(
            &buff.front(), buff.size(), md,
            uhd::io_type_t::COMPLEX_FLOAT32,
            uhd::device::SEND_MODE_FULL_BUFF
        );
    }

    //send a mini EOB packet
    md.start_of_burst = false;
    md.end_of_burst   = true;
    dev->send(NULL, 0, md,
        uhd::io_type_t::COMPLEX_FLOAT32,
        uhd::device::SEND_MODE_FULL_BUFF
    );

    //finished
    std::cout << std::endl << "Done!" << std::endl << std::endl;

    return 0;
}