///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2018-2019 Edouard Griffiths, F4EXB <f4exb06@gmail.com>          //
//                                                                               //
// 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 as 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 V3 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 DEVICES_SOAPYSDR_DEVICESOAPYSDRPARAMS_H_
#define DEVICES_SOAPYSDR_DEVICESOAPYSDRPARAMS_H_

#include <stdint.h>
#include <string>
#include <vector>

#include <SoapySDR/Device.hpp>

#include "export.h"

/**
 * This structure refers to one physical device shared among parties (logical devices represented by
 * the DeviceAPI with single Rx or Tx stream type).
 * It allows storing information on the common resources in one place and is shared among participants.
 * There is only one copy that is constructed by the first participant and destroyed by the last.
 * A participant knows it is the first or last by checking the lists of buddies (Rx + Tx).
 */

class DEVICES_API DeviceSoapySDRParams
{
public:
    struct GainSetting
    {
        std::string m_name;           //!< Name of the gain element
        SoapySDR::Range m_range;      //!< Gain range
    };

    struct FrequencySetting
    {
        std::string m_name;           //!< Name of the tunable element
        SoapySDR::RangeList m_ranges; //!< List of ranges of the tunable element
    };

    struct ChannelSettings
    {
        SoapySDR::ArgInfoList m_streamSettingsArgs;        //!< common stream parameters
        bool m_hasDCAutoCorrection;                        //!< DC offset auto correction flag
        bool m_hasDCOffsetValue;                           //!< DC offset value flag
        bool m_hasIQBalanceValue;                          //!< IQ correction value flag
        bool m_hasFrequencyCorrectionValue;                //!< Frequency correction value flag
        std::vector<std::string> m_antennas;               //!< Antenna ports names
        bool m_hasAGC;                                     //!< AGC flag
        SoapySDR::Range m_gainRange;                       //!< Global gain range
        std::vector<GainSetting> m_gainSettings;           //!< gain elements settings
        std::vector<FrequencySetting> m_frequencySettings; //!< tunable elements settings
        SoapySDR::ArgInfoList m_frequencySettingsArgs;     //!< common tuning parameters
        SoapySDR::RangeList m_ratesRanges;                 //!< list of ranges of sample rates
        SoapySDR::RangeList m_bandwidthsRanges;            //!< list of ranges of bandwidths
    };

    DeviceSoapySDRParams(SoapySDR::Device *device);
    ~DeviceSoapySDRParams();

    const SoapySDR::ArgInfoList& getDeviceArgs() const { return m_deviceSettingsArgs; }

    const ChannelSettings* getRxChannelSettings(uint32_t index)
    {
        if (index < m_nbRx) {
            return &m_RxChannelsSettings[index];
        } else {
            return 0;
        }
    }

    const ChannelSettings* getTxChannelSettings(uint32_t index)
    {
        if (index < m_nbTx) {
            return &m_TxChannelsSettings[index];
        } else {
            return 0;
        }
    }

    std::string getRxChannelMainTunableElementName(uint32_t index);
    std::string getTxChannelMainTunableElementName(uint32_t index);

private:
    void fillParams();
    void fillChannelParams(std::vector<ChannelSettings>& channelSettings, int direction, unsigned int ichan);
    void printParams();
    void printChannelParams(const ChannelSettings& channelSetting);

    // Printing functions copied from SoapySDR's SoapySDRProbe.cpp
    std::string argInfoToString(const SoapySDR::ArgInfo &argInfo, const std::string indent = "    ");
    std::string argInfoListToString(const SoapySDR::ArgInfoList &argInfos);
    std::string rangeToString(const SoapySDR::Range &range);
    std::string rangeListToString(const SoapySDR::RangeList &range, const double scale);

    template <typename Type>
    std::string vectorToString(const std::vector<Type> &options)
    {
        std::stringstream ss;

        if (options.empty()) {
            return "";
        }

        for (std::size_t i = 0; i < options.size(); i++)
        {
            if (not ss.str().empty()) {
                ss << ", ";
            }

            ss << options[i];
        }

        return ss.str();
    }

    SoapySDR::Device *m_device;
    SoapySDR::ArgInfoList m_deviceSettingsArgs; //!< list (vector) of device settings arguments
    uint32_t m_nbRx; //!< number of Rx channels
    uint32_t m_nbTx; //!< number of Tx channels
    std::vector<ChannelSettings> m_RxChannelsSettings;
    std::vector<ChannelSettings> m_TxChannelsSettings;
};


#endif /* DEVICES_SOAPYSDR_DEVICESOAPYSDRPARAMS_H_ */