srsRAN_4G/lib/include/srsran/phy/channel/channel.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2021 Software Radio Systems Limited
 *
 * By using this file, you agree to the terms and conditions set
 * forth in the LICENSE file which can be found at the top level of
 * the distribution.
 *
 */

#ifndef SRSRAN_CHANNEL_H
#define SRSRAN_CHANNEL_H

#include "ch_awgn.h"
#include "delay.h"
#include "fading.h"
#include "hst.h"
#include "rlf.h"
#include "srsran/phy/common/phy_common.h"
#include "srsran/srslog/srslog.h"
#include <memory>
#include <string>

namespace srsran {

class channel
{
public:
  typedef struct {
    // General
    bool enable = false;

    // AWGN options
    bool  awgn_enable            = false;
    float awgn_signal_power_dBfs = 0.0f;
    float awgn_snr_dB            = 30.0f;

    // Fading options
    bool        fading_enable = false;
    std::string fading_model  = "none";

    // High Speed Train options
    bool  hst_enable      = false;
    float hst_fd_hz       = 750.0f;
    float hst_period_s    = 7.2f;
    float hst_init_time_s = 0.0f;

    // Delay options
    bool  delay_enable      = false;
    float delay_min_us      = 10;
    float delay_max_us      = 100;
    float delay_period_s    = 3600;
    float delay_init_time_s = 0;

    // RLF options
    bool     rlf_enable   = false;
    uint32_t rlf_t_on_ms  = 10000;
    uint32_t rlf_t_off_ms = 2000;
  } args_t;

  channel(const args_t& channel_args, uint32_t _nof_channels, srslog::basic_logger& logger);
  ~channel();
  void set_srate(uint32_t srate);
  void set_signal_power_dBfs(float power_dBfs);
  void run(cf_t* in[SRSRAN_MAX_CHANNELS], cf_t* out[SRSRAN_MAX_CHANNELS], uint32_t len, const srsran_timestamp_t& t);

private:
  srslog::basic_logger&    logger;
  float                    hst_init_phase              = 0.0f;
  srsran_channel_fading_t* fading[SRSRAN_MAX_CHANNELS] = {};
  srsran_channel_delay_t*  delay[SRSRAN_MAX_CHANNELS]  = {};
  srsran_channel_awgn_t*   awgn                        = nullptr;
  srsran_channel_hst_t*    hst                         = nullptr;
  srsran_channel_rlf_t*    rlf                         = nullptr;
  cf_t*                    buffer_in                   = nullptr;
  cf_t*                    buffer_out                  = nullptr;
  uint32_t                 nof_channels                = 0;
  uint32_t                 current_srate               = 0;
  args_t                   args                        = {};
};

typedef std::unique_ptr<channel> channel_ptr;

} // namespace srsran

#endif // SRSRAN_CHANNEL_H