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

#include "../../transport/super_recv_packet_handler.hpp"
#include "../../transport/super_send_packet_handler.hpp"
#include "b200_impl.hpp"
#include "b200_regs.hpp"
#include <uhd/utils/math.hpp>
#include <uhdlib/usrp/common/async_packet_handler.hpp>
#include <uhdlib/usrp/common/validate_subdev_spec.hpp>
#include <functional>
#include <memory>
#include <set>

using namespace uhd;
using namespace uhd::usrp;
using namespace uhd::transport;

/***********************************************************************
 * update streamer rates
 **********************************************************************/
void b200_impl::check_tick_rate_with_current_streamers(double rate)
{
    // Defined in b200_impl.cpp
    enforce_tick_rate_limits(max_chan_count("RX"), rate, "RX");
    enforce_tick_rate_limits(max_chan_count("TX"), rate, "TX");
}

// direction can either be "TX", "RX", or empty (default)
size_t b200_impl::max_chan_count(const std::string& direction /* = "" */)
{
    size_t max_count = 0;
    for (radio_perifs_t& perif : _radio_perifs) {
        if ((direction == "RX" or direction.empty())
            and not perif.rx_streamer.expired()) {
            std::shared_ptr<sph::recv_packet_streamer> rx_streamer =
                std::dynamic_pointer_cast<sph::recv_packet_streamer>(
                    perif.rx_streamer.lock());
            max_count = std::max(max_count, rx_streamer->get_num_channels());
        }
        if ((direction == "TX" or direction.empty())
            and not perif.tx_streamer.expired()) {
            std::shared_ptr<sph::send_packet_streamer> tx_streamer =
                std::dynamic_pointer_cast<sph::send_packet_streamer>(
                    perif.tx_streamer.lock());
            max_count = std::max(max_count, tx_streamer->get_num_channels());
        }
    }
    return max_count;
}

void b200_impl::check_streamer_args(const uhd::stream_args_t& args,
    double tick_rate,
    const std::string& direction /*= ""*/)
{
    std::set<size_t> chans_set;
    for (size_t stream_i = 0; stream_i < args.channels.size(); stream_i++) {
        const size_t chan = args.channels[stream_i];
        chans_set.insert(chan);
    }

    enforce_tick_rate_limits(
        chans_set.size(), tick_rate, direction); // Defined in b200_impl.cpp
}

void b200_impl::set_auto_tick_rate(
    const double rate, const fs_path& tree_dsp_path, size_t num_chans)
{
    if (num_chans == 0) { // Divine them
        num_chans = std::max(size_t(1), max_chan_count());
    }
    const double max_tick_rate = ad9361_device_t::AD9361_MAX_CLOCK_RATE / num_chans;
    using namespace uhd::math;
    if (rate != 0.0
        and (fp_compare::fp_compare_delta<double>(rate, FREQ_COMPARISON_DELTA_HZ)
                > max_tick_rate)) {
        throw uhd::value_error(str(boost::format("Requested sampling rate (%.2f Msps) "
                                                 "exceeds maximum tick rate of %.2f MHz.")
                                   % (rate / 1e6) % (max_tick_rate / 1e6)));
    }

    // See also the doxygen documentation for these steps in b200_impl.hpp
    // Step 1: Obtain LCM and max rate from all relevant dsps
    uint32_t lcm_rate = (rate == 0) ? 1 : static_cast<uint32_t>(floor(rate + 0.5));
    for (int i = 0; i < 2; i++) { // Loop through rx and tx
        std::string dir = (i == 0) ? "tx" : "rx";
        // We assume all 'set' DSPs are being used.
        for (const std::string& dsp_no :
            _tree->list(str(boost::format("/mboards/0/%s_dsps") % dir))) {
            fs_path dsp_path = str(boost::format("/mboards/0/%s_dsps/%s") % dir % dsp_no);
            if (dsp_path == tree_dsp_path) {
                continue;
            }
            if (not _tree->access<bool>(dsp_path / "rate/set").get()) {
                continue;
            }
            double this_dsp_rate = _tree->access<double>(dsp_path / "rate/value").get();
            // Check if the user selected something completely unreasonable:
            if (fp_compare::fp_compare_delta<double>(
                    this_dsp_rate, FREQ_COMPARISON_DELTA_HZ)
                > max_tick_rate) {
                throw uhd::value_error(
                    str(boost::format("Requested sampling rate (%.2f Msps) exceeds "
                                      "maximum tick rate of %.2f MHz.")
                        % (this_dsp_rate / 1e6) % (max_tick_rate / 1e6)));
            }
            // Clean up floating point rounding errors if they crept in
            this_dsp_rate = std::min(max_tick_rate, this_dsp_rate);
            lcm_rate      = uhd::math::lcm<uint32_t>(
                lcm_rate, static_cast<uint32_t>(floor(this_dsp_rate + 0.5)));
        }
    }
    if (lcm_rate == 1) {
        // In this case, no one has ever set a sampling rate.
        return;
    }

    double base_rate = static_cast<double>(lcm_rate);
    try {
        // Step 2: Get a good tick rate value
        const double new_rate = _codec_mgr->get_auto_tick_rate(base_rate, num_chans);
        // Step 3: Set the new tick rate value (if any change)
        if (!uhd::math::frequencies_are_equal(
                _tree->access<double>("/mboards/0/tick_rate").get(), new_rate)) {
            _tree->access<double>("/mboards/0/tick_rate").set(new_rate);
        }
    } catch (const uhd::value_error&) {
        UHD_LOGGER_WARNING("B200") << "Cannot automatically determine an appropriate "
                                      "tick rate for these sampling rates."
                                   << "Consider using different sampling rates, or "
                                      "manually specify a suitable master clock rate.";
        return; // Let the others handle this
    }
}

void b200_impl::update_tick_rate(const double new_tick_rate)
{
    check_tick_rate_with_current_streamers(new_tick_rate);

    for (radio_perifs_t& perif : _radio_perifs) {
        std::shared_ptr<sph::recv_packet_streamer> my_streamer =
            std::dynamic_pointer_cast<sph::recv_packet_streamer>(
                perif.rx_streamer.lock());
        if (my_streamer)
            my_streamer->set_tick_rate(new_tick_rate);
        perif.framer->set_tick_rate(new_tick_rate);
    }
    for (radio_perifs_t& perif : _radio_perifs) {
        std::shared_ptr<sph::send_packet_streamer> my_streamer =
            std::dynamic_pointer_cast<sph::send_packet_streamer>(
                perif.tx_streamer.lock());
        if (my_streamer)
            my_streamer->set_tick_rate(new_tick_rate);
    }
}

void b200_impl::update_rx_dsp_tick_rate(
    const double tick_rate, rx_dsp_core_3000::sptr ddc, uhd::fs_path rx_dsp_path)
{
    ddc->set_tick_rate(tick_rate);
    if (_tree->access<bool>(rx_dsp_path / "rate" / "set").get()) {
        ddc->set_host_rate(_tree->access<double>(rx_dsp_path / "rate" / "value").get());
    }
}

void b200_impl::update_tx_dsp_tick_rate(
    const double tick_rate, tx_dsp_core_3000::sptr duc, uhd::fs_path tx_dsp_path)
{
    duc->set_tick_rate(tick_rate);
    if (_tree->access<bool>(tx_dsp_path / "rate" / "set").get()) {
        duc->set_host_rate(_tree->access<double>(tx_dsp_path / "rate" / "value").get());
    }
}

#define CHECK_RATE_AND_THROW(rate)                                                    \
    if (uhd::math::fp_compare::fp_compare_delta<double>(                              \
            rate, uhd::math::FREQ_COMPARISON_DELTA_HZ)                                \
        > uhd::math::fp_compare::fp_compare_delta<double>(                            \
              ad9361_device_t::AD9361_MAX_CLOCK_RATE,                                 \
              uhd::math::FREQ_COMPARISON_DELTA_HZ)) {                                 \
        throw uhd::value_error(                                                       \
            str(boost::format(                                                        \
                    "Requested sampling rate (%.2f Msps) exceeds maximum tick rate.") \
                % (rate / 1e6)));                                                     \
    }

double b200_impl::coerce_rx_samp_rate(
    rx_dsp_core_3000::sptr ddc, size_t dspno, const double rx_rate)
{
    // Have to set tick rate first, or the ddc will change the requested rate based on
    // default tick rate
    if (_tree->access<bool>("/mboards/0/auto_tick_rate").get()) {
        CHECK_RATE_AND_THROW(rx_rate);
        const std::string dsp_path =
            (boost::format("/mboards/0/rx_dsps/%s") % dspno).str();
        set_auto_tick_rate(rx_rate, dsp_path);
    }
    return ddc->set_host_rate(rx_rate);
}

void b200_impl::update_rx_samp_rate(const size_t dspno, const double rate)
{
    std::shared_ptr<sph::recv_packet_streamer> my_streamer =
        std::dynamic_pointer_cast<sph::recv_packet_streamer>(
            _radio_perifs[dspno].rx_streamer.lock());
    if (not my_streamer)
        return;
    my_streamer->set_samp_rate(rate);
    const double adj = _radio_perifs[dspno].ddc->get_scaling_adjustment();
    my_streamer->set_scale_factor(adj);
    _codec_mgr->check_bandwidth(rate, "Rx");
}

double b200_impl::coerce_tx_samp_rate(
    tx_dsp_core_3000::sptr duc, size_t dspno, const double tx_rate)
{
    // Have to set tick rate first, or the duc will change the requested rate based on
    // default tick rate
    if (_tree->access<bool>("/mboards/0/auto_tick_rate").get()) {
        CHECK_RATE_AND_THROW(tx_rate);
        const std::string dsp_path =
            (boost::format("/mboards/0/tx_dsps/%s") % dspno).str();
        set_auto_tick_rate(tx_rate, dsp_path);
    }
    return duc->set_host_rate(tx_rate);
}

void b200_impl::update_tx_samp_rate(const size_t dspno, const double rate)
{
    std::shared_ptr<sph::send_packet_streamer> my_streamer =
        std::dynamic_pointer_cast<sph::send_packet_streamer>(
            _radio_perifs[dspno].tx_streamer.lock());
    if (not my_streamer)
        return;
    my_streamer->set_samp_rate(rate);
    const double adj = _radio_perifs[dspno].duc->get_scaling_adjustment();
    my_streamer->set_scale_factor(adj);
    _codec_mgr->check_bandwidth(rate, "Tx");
}

/***********************************************************************
 * frontend selection
 **********************************************************************/
uhd::usrp::subdev_spec_t b200_impl::coerce_subdev_spec(
    const uhd::usrp::subdev_spec_t& spec_)
{
    uhd::usrp::subdev_spec_t spec = spec_;
    // Because of the confusing nature of the subdevs on B200
    // with different revs, we provide a convenience override,
    // where both A:A and A:B are mapped to A:A.
    //
    // Any other spec is probably illegal and will be caught by
    // validate_subdev_spec().
    if (spec.size() and (_product == B200 or _product == B200MINI or _product == B205MINI)
        and spec[0].sd_name == "B") {
        spec[0].sd_name = "A";
    }
    return spec;
}

void b200_impl::update_subdev_spec(
    const std::string& tx_rx, const uhd::usrp::subdev_spec_t& spec)
{
    // sanity checking
    if (spec.size()) {
        validate_subdev_spec(_tree, spec, tx_rx);
    }

    std::vector<size_t> chan_to_dsp_map(spec.size(), 0);
    for (size_t i = 0; i < spec.size(); i++) {
        chan_to_dsp_map[i] = (spec[i].sd_name == "A") ? 0 : 1;
    }
    _tree->access<std::vector<size_t>>("/mboards/0" / (tx_rx + "_chan_dsp_mapping"))
        .set(chan_to_dsp_map);

    this->update_enables();
}

static void b200_if_hdr_unpack_le(
    const uint32_t* packet_buff, vrt::if_packet_info_t& if_packet_info)
{
    if_packet_info.link_type = vrt::if_packet_info_t::LINK_TYPE_CHDR;
    return vrt::if_hdr_unpack_le(packet_buff, if_packet_info);
}

static void b200_if_hdr_pack_le(
    uint32_t* packet_buff, vrt::if_packet_info_t& if_packet_info)
{
    if_packet_info.link_type = vrt::if_packet_info_t::LINK_TYPE_CHDR;
    return vrt::if_hdr_pack_le(packet_buff, if_packet_info);
}

/***********************************************************************
 * Async Data
 **********************************************************************/
bool b200_impl::recv_async_msg(async_metadata_t& async_metadata, double timeout)
{
    return _async_task_data->async_md->pop_with_timed_wait(async_metadata, timeout);
}

/*
 * This method is constantly called in a msg_task loop.
 * Incoming messages are dispatched in to the hosts radio_ctrl_cores.
 * The radio_ctrl_core queues are accessed via a weak_ptr to them, stored in
 * AsyncTaskData. During shutdown the radio_ctrl_core dtor's are called. An empty
 * peek32(0) is sent out to flush pending async messages. The response to those messages
 * can't be delivered to the ctrl_core queues anymore because the shared pointer
 * corresponding to the weak_ptrs is no longer valid. Those stranded messages are put into
 * a dump_queue implemented in msg_task. A radio_ctrl_core can search for missing messages
 * there.
 */
boost::optional<uhd::msg_task::msg_type_t> b200_impl::handle_async_task(
    uhd::transport::zero_copy_if::sptr xport, std::shared_ptr<AsyncTaskData> data)
{
    managed_recv_buffer::sptr buff = xport->get_recv_buff();
    if (not buff or buff->size() < 8)
        return boost::none;

    const uint32_t sid = uhd::wtohx(buff->cast<const uint32_t*>()[1]);
    switch (sid) {
        // if the packet is a control response
        case B200_RESP0_MSG_SID:
        case B200_RESP1_MSG_SID:
        case B200_LOCAL_RESP_SID: {
            radio_ctrl_core_3000::sptr ctrl;
            if (sid == B200_RESP0_MSG_SID)
                ctrl = data->radio_ctrl[0].lock();
            if (sid == B200_RESP1_MSG_SID)
                ctrl = data->radio_ctrl[1].lock();
            if (sid == B200_LOCAL_RESP_SID)
                ctrl = data->local_ctrl.lock();
            if (ctrl) {
                ctrl->push_response(buff->cast<const uint32_t*>());
            } else {
                return std::make_pair(sid,
                    uhd::msg_task::buff_to_vector(buff->cast<uint8_t*>(), buff->size()));
            }
            break;
        }

        // if the packet is a uart message
        case B200_RX_GPS_UART_SID: {
            data->gpsdo_uart->handle_uart_packet(buff);
            break;
        }

        // or maybe the packet is a TX async message
        case B200_TX_MSG0_SID:
        case B200_TX_MSG1_SID: {
            const size_t i = (sid == B200_TX_MSG0_SID) ? 0 : 1;

            // extract packet info
            vrt::if_packet_info_t if_packet_info;
            if_packet_info.num_packet_words32 = buff->size() / sizeof(uint32_t);
            const uint32_t* packet_buff       = buff->cast<const uint32_t*>();

            // unpacking can fail
            try {
                b200_if_hdr_unpack_le(packet_buff, if_packet_info);
            } catch (const std::exception& ex) {
                UHD_LOGGER_ERROR("B200") << "Error parsing ctrl packet: " << ex.what();
                break;
            }

            // fill in the async metadata
            async_metadata_t metadata;
            load_metadata_from_buff(uhd::wtohx<uint32_t>,
                metadata,
                if_packet_info,
                packet_buff,
                _tick_rate,
                i);
            data->async_md->push_with_pop_on_full(metadata);
            standard_async_msg_prints(metadata);
            break;
        }

        // doh!
        default:
            UHD_LOGGER_ERROR("B200") << "Got a ctrl packet with unknown SID " << sid;
    }
    return boost::none;
}

/***********************************************************************
 * Receive streamer
 **********************************************************************/
rx_streamer::sptr b200_impl::get_rx_stream(const uhd::stream_args_t& args_)
{
    std::lock_guard<std::mutex> lock(_transport_setup_mutex);

    stream_args_t args = args_;

    // setup defaults for unspecified values
    if (args.otw_format.empty())
        args.otw_format = "sc16";
    args.channels = args.channels.empty() ? std::vector<size_t>(1, 0) : args.channels;

    if (_tree->access<bool>("/mboards/0/auto_tick_rate").get()) {
        set_auto_tick_rate(0, "", args.channels.size());
    }
    check_streamer_args(args, this->get_tick_rate(), "RX");

    std::shared_ptr<sph::recv_packet_streamer> my_streamer;
    for (size_t stream_i = 0; stream_i < args.channels.size(); stream_i++) {
        const size_t radio_index =
            _tree->access<std::vector<size_t>>("/mboards/0/rx_chan_dsp_mapping")
                .get()
                .at(args.channels[stream_i]);
        radio_perifs_t& perif = _radio_perifs[radio_index];
        if (args.otw_format == "sc16")
            perif.ctrl->poke32(TOREG(SR_RX_FMT), 0);
        if (args.otw_format == "sc12")
            perif.ctrl->poke32(TOREG(SR_RX_FMT), 1);
        if (args.otw_format == "fc32")
            perif.ctrl->poke32(TOREG(SR_RX_FMT), 2);
        if (args.otw_format == "sc8")
            perif.ctrl->poke32(TOREG(SR_RX_FMT), 3);
        const uint32_t sid = radio_index ? B200_RX_DATA1_SID : B200_RX_DATA0_SID;

        // calculate packet size
        static const size_t hdr_size =
            0
            + vrt::max_if_hdr_words32 * sizeof(uint32_t)
            //+ sizeof(vrt::if_packet_info_t().tlr) //no longer using trailer
            - sizeof(vrt::if_packet_info_t().cid) // no class id ever used
            - sizeof(vrt::if_packet_info_t().tsi) // no int time ever used
            ;
        const size_t bpp = _data_transport->get_recv_frame_size() - hdr_size;
        const size_t bpi = convert::get_bytes_per_item(args.otw_format);
        size_t spp       = unsigned(args.args.cast<double>("spp", bpp / bpi));
        spp = std::min<size_t>(4092, spp); // FPGA FIFO maximum for framing at full rate

        // make the new streamer given the samples per packet
        if (not my_streamer)
            my_streamer = std::make_shared<sph::recv_packet_streamer>(spp);
        my_streamer->resize(args.channels.size());

        // init some streamer stuff
        my_streamer->set_vrt_unpacker(&b200_if_hdr_unpack_le);

        // set the converter
        uhd::convert::id_type id;
        id.input_format  = args.otw_format + "_item32_le";
        id.num_inputs    = 1;
        id.output_format = args.cpu_format;
        id.num_outputs   = 1;
        my_streamer->set_converter(id);

        perif.framer->clear();
        perif.framer->set_nsamps_per_packet(spp);
        perif.framer->set_sid(sid);
        perif.framer->setup(args);
        perif.ddc->setup(args);
        _demux->realloc_sid(sid);
        my_streamer->set_xport_chan_get_buff(stream_i,
            std::bind(&recv_packet_demuxer_3000::get_recv_buff,
                _demux,
                sid,
                std::placeholders::_1),
            true /*flush*/);
        my_streamer->set_overflow_handler(
            stream_i, std::bind(&b200_impl::handle_overflow, this, radio_index));
        my_streamer->set_issue_stream_cmd(stream_i,
            std::bind(&rx_vita_core_3000::issue_stream_command,
                perif.framer,
                std::placeholders::_1));
        perif.rx_streamer = my_streamer; // store weak pointer

        // sets all tick and samp rates on this streamer
        this->update_tick_rate(this->get_tick_rate());
        _tree
            ->access<double>(
                str(boost::format("/mboards/0/rx_dsps/%u/rate/value") % radio_index))
            .update();
    }
    this->update_enables();

    return my_streamer;
}

void b200_impl::handle_overflow(const size_t radio_index)
{
    std::shared_ptr<sph::recv_packet_streamer> my_streamer =
        std::dynamic_pointer_cast<sph::recv_packet_streamer>(
            _radio_perifs[radio_index].rx_streamer.lock());
    if (my_streamer->get_num_channels() == 2) // MIMO time
    {
        // find out if we were in continuous mode before stopping
        const bool in_continuous_streaming_mode =
            _radio_perifs[radio_index].framer->in_continuous_streaming_mode();
        // stop streaming
        my_streamer->issue_stream_cmd(stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);
        // flush demux
        _demux->realloc_sid(B200_RX_DATA0_SID);
        _demux->realloc_sid(B200_RX_DATA1_SID);
        // flush actual transport
        while (_data_transport->get_recv_buff(0.001)) {
        }
        // restart streaming
        if (in_continuous_streaming_mode) {
            stream_cmd_t stream_cmd(stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
            stream_cmd.stream_now = false;
            stream_cmd.time_spec =
                _radio_perifs[radio_index].time64->get_time_now() + time_spec_t(0.01);
            my_streamer->issue_stream_cmd(stream_cmd);
        }
    } else
        _radio_perifs[radio_index].framer->handle_overflow();
}

/***********************************************************************
 * Transmit streamer
 **********************************************************************/
tx_streamer::sptr b200_impl::get_tx_stream(const uhd::stream_args_t& args_)
{
    std::lock_guard<std::mutex> lock(_transport_setup_mutex);

    stream_args_t args = args_;

    // setup defaults for unspecified values
    if (args.otw_format.empty())
        args.otw_format = "sc16";
    args.channels = args.channels.empty() ? std::vector<size_t>(1, 0) : args.channels;

    if (_tree->access<bool>("/mboards/0/auto_tick_rate").get()) {
        set_auto_tick_rate(0, "", args.channels.size());
    }
    check_streamer_args(args, this->get_tick_rate(), "TX");

    std::shared_ptr<sph::send_packet_streamer> my_streamer;
    for (size_t stream_i = 0; stream_i < args.channels.size(); stream_i++) {
        const size_t radio_index =
            _tree->access<std::vector<size_t>>("/mboards/0/tx_chan_dsp_mapping")
                .get()
                .at(args.channels[stream_i]);
        radio_perifs_t& perif = _radio_perifs[radio_index];
        if (args.otw_format == "sc16")
            perif.ctrl->poke32(TOREG(SR_TX_FMT), 0);
        if (args.otw_format == "sc12")
            perif.ctrl->poke32(TOREG(SR_TX_FMT), 1);
        if (args.otw_format == "fc32")
            perif.ctrl->poke32(TOREG(SR_TX_FMT), 2);
        if (args.otw_format == "sc8")
            perif.ctrl->poke32(TOREG(SR_TX_FMT), 3);

        // calculate packet size
        static const size_t hdr_size =
            0
            + vrt::max_if_hdr_words32 * sizeof(uint32_t)
            //+ sizeof(vrt::if_packet_info_t().tlr) //forced to have trailer
            - sizeof(vrt::if_packet_info_t().cid) // no class id ever used
            - sizeof(vrt::if_packet_info_t().tsi) // no int time ever used
            ;
        static const size_t bpp = _data_transport->get_send_frame_size() - hdr_size;
        const size_t spp        = bpp / convert::get_bytes_per_item(args.otw_format);

        // make the new streamer given the samples per packet
        if (not my_streamer)
            my_streamer = std::make_shared<sph::send_packet_streamer>(spp);
        my_streamer->resize(args.channels.size());

        // init some streamer stuff
        my_streamer->set_vrt_packer(&b200_if_hdr_pack_le);

        // set the converter
        uhd::convert::id_type id;
        id.input_format  = args.cpu_format;
        id.num_inputs    = 1;
        id.output_format = args.otw_format + "_item32_le";
        id.num_outputs   = 1;
        my_streamer->set_converter(id);

        perif.deframer->clear();
        perif.deframer->setup(args);
        perif.duc->setup(args);

        my_streamer->set_xport_chan_get_buff(stream_i,
            std::bind(
                &zero_copy_if::get_send_buff, _data_transport, std::placeholders::_1));
        my_streamer->set_async_receiver(std::bind(&async_md_type::pop_with_timed_wait,
            _async_task_data->async_md,
            std::placeholders::_1,
            std::placeholders::_2));
        my_streamer->set_xport_chan_sid(
            stream_i, true, radio_index ? B200_TX_DATA1_SID : B200_TX_DATA0_SID);
        my_streamer->set_enable_trailer(false); // TODO not implemented trailer support
                                                // yet
        perif.tx_streamer = my_streamer; // store weak pointer

        // sets all tick and samp rates on this streamer
        this->update_tick_rate(this->get_tick_rate());
        _tree
            ->access<double>(
                str(boost::format("/mboards/0/tx_dsps/%u/rate/value") % radio_index))
            .update();
    }
    this->update_enables();

    return my_streamer;
}
