Command.hxx

Go to the documentation of this file.

#pragma once
/*
  Copyright (c) 2012,2017, 2025, 2026 Matthew H. Reilly (kb1vc)
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:
 
  Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
  Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the
  distribution.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#include <string>
#include <memory>
#include <string.h>
 
#include <memory>
#include <SoDa/MailBox.hxx>
 
namespace SoDa
{
 
  class Command;
  typedef std::shared_ptr<Command> CommandPtr;
  
  class Command {
  public:
    enum CmdType
      {
    SET,
    GET,
    REP,
    NONE
      };

    enum ClockSource
      {
    EXTERNAL,
    INTERNAL
      }; 

    enum RxTxState
      {
    TX_OFF_0,
    TX_OFF_1,
    TX_OFF_2,
    TX_ON_0,
    TX_ON_1,
    TX_ON_2,     
      };

    enum CmdTarget
      {
    RX_TUNE_FREQ,

    RX_LO_FREQ,
 

    RX_IF_FREQ,
    
    RX_CENTER_FREQ,
      
    TX_TUNE_FREQ,

    TX_LO_FREQ,
    
    TX_IF_FREQ,

    RX_SAMP_RATE,

    TX_SAMP_RATE,

    RX_ANT,
    TX_ANT,

    RX_RF_GAIN,
    TX_RF_GAIN,

    RX_AF_GAIN,
    RX_AF_SIDETONE_GAIN,

    TX_AF_GAIN,

    TX_STATE,

    RX_STATE,

    TX_BEACON,

    TX_CW_TEXT,
    TX_CW_SPEED,
    TX_CW_FLUSHTEXT,

    TX_CW_MARKER,

    TX_CW_EMPTY,

    RX_MODE,
    TX_MODE,

    RX_BW,

    RBW,
 
    // and spectrum start/stop limits
    SPEC_CENTER_FREQ, 
    SPEC_RANGE_LOW,   
    SPEC_RANGE_HI,    
    SPEC_STEP,        
    SPEC_BUF_LEN,     
 
    SPEC_DIMS, 
 
    SPEC_AVG_WINDOW,  
    SPEC_UPDATE_RATE, 

    CLOCK_SOURCE,

    LO_CHECK,
    LO_OFFSET,
 
    RX_AF_FILTER, 
 
    RX_AF_FILTER_SHAPE, 

    GPS_LATLON,
    GPS_UTC,

    GPS_LOCK,

    SDR_VERSION,

    DBG_REP,

    HWMB_REP,

    STOP,

    TVRT_LO_ENABLE,

    TVRT_LO_DISABLE,

    TVRT_LO_CONFIG,

    STATUS_MESSAGE,

    TX_AUDIO_IN,

    TX_AUDIO_FILT_ENA,

    RX_GAIN_RANGE,

    TX_GAIN_RANGE,

    RX_ANT_NAME,

    TX_ANT_NAME,

    MOD_SEL_ENTRY,

    AF_FILT_ENTRY,

    INIT_SETUP_COMPLETE,

    CW_CHAR_SENT,

    RF_RECORD_START,

    RF_RECORD_STOP,

    NBFM_SQUELCH,

    LIST_MODES,

    LIST_AF_FILTERS,
    
    NULL_CMD
      };

    enum ModulationType
      {
    LSB,
    USB,
    CW_U,
    CW_L,
    AM,
    WBFM,
    NBFM
      };

    enum AudioFilterBW
      {
    BW_100,
    BW_500,
    BW_2000,
    BW_6000,
    BW_PASS,
    BW_WSPR,
    BW_NULL
      };

    enum UnitSelector
      {
    BaseBandRX,
    BaseBandTX,
    RFRX,
    RFTX,
    CWTX,
    CTRL
      };

    enum TXAudioSelector
      {
    MIC,
    NOISE
      };
 
 
  public:
    
    
    Command(CmdType _ct, CmdTarget _tgt)
    {
      cmd = _ct;
      target = _tgt;
      parm_type = ' ';
      id = command_sequence_number++;
    }
 
    static CommandPtr make(CmdType _ct, CmdTarget _tgt) {
      return std::make_shared<Command>(_ct, _tgt);
    }
    
    Command(CmdType _ct, CmdTarget _tgt,
        int p0,
        int p1 = 0,
        int p2 = 0,
        int p3 = 0)
    {
      cmd = _ct;
      target = _tgt;
      iparms[0] = p0;
      iparms[1] = p1;
      iparms[2] = p2;
      iparms[3] = p3;
      parm_type = 'I';
      id = command_sequence_number++;
    }
 
    static CommandPtr make(CmdType _ct, CmdTarget _tgt,
               int p0,
               int p1 = 0,
               int p2 = 0,
               int p3 = 0)
    {
      return std::make_shared<Command>(_ct, _tgt, p0, p1, p2, p3);
    }
    
    Command(CmdType _ct, CmdTarget _tgt,
        double p0,
        double p1 = 0.0,
        double p2 = 0.0,
        double p3 = 0.0)
    {
      cmd = _ct;
      target = _tgt;
      dparms[0] = p0;
      dparms[1] = p1;
      dparms[2] = p2;
      dparms[3] = p3;
      parm_type = 'D';
      id = command_sequence_number++;
    }
 
    static CommandPtr make(CmdType _ct, CmdTarget _tgt,
               double p0,
               double p1 = 0.0,
               double p2 = 0.0,
               double p3 = 0.0) {
      return std::make_shared<Command>(_ct, _tgt, p0, p1, p2, p3);
    }
    
    Command(CmdType _ct, CmdTarget _tgt, const std::string &_str_arg, unsigned int _tag = 0)
    {
      cmd = _ct;
      target = _tgt;
      tag = _tag;
      const char *cp = _str_arg.c_str();
      int i;
      for (i = 0; i < 64; i++)
    {
      sparm[i] = *cp;
      if (*cp == '\000')
        break;
      cp++;
    }
      parm_type = 'S';
      id = command_sequence_number++;
    }
 
    static CommandPtr make(CmdType _ct, CmdTarget _tgt, 
               const std::string &_str_arg, unsigned int _tag = 0)
    {
      return std::make_shared<Command>(_ct, _tgt, _str_arg, _tag);
    }
    
    Command(CmdType _ct, CmdTarget _tgt, const char *cp, unsigned int _tag = 0)
    {
      cmd = _ct;
      target = _tgt;
      tag = _tag;
      int i;
      for (i = 0; i < 64; i++)
    {
      sparm[i] = *cp;
      if (*cp == '\000')
        break;
      cp++;
    }
      parm_type = 'S';
      id = command_sequence_number++;
    }
 
    static CommandPtr make(CmdType _ct, CmdTarget _tgt, const char *cp, unsigned int _tag = 0) {
      return std::make_shared<Command>(_ct, _tgt, cp, _tag);
    }
    
    Command(const Command &cc)
    {
      cmd = cc.cmd;
      target = cc.target;
      strncpy(sparm, cc.sparm, 64);
      dparms[0] = cc.dparms[0];
      dparms[1] = cc.dparms[1];
      dparms[2] = cc.dparms[2];
      dparms[3] = cc.dparms[3];
      iparms[0] = cc.iparms[0];
      iparms[1] = cc.iparms[1];
      iparms[2] = cc.iparms[2];
      iparms[3] = cc.iparms[3];
      id = -1 * command_sequence_number++;
      parm_type = cc.parm_type;
    }

    Command()
    {
      cmd = NONE;
      target = NULL_CMD;
      parm_type = 'I';
      iparms[0] = 0;
      tag = 0;
    }
 
    static CommandPtr make() {
      return std::make_shared<Command>();
    }
    
    ~Command()
    {
    }

    static Command *parseCommandString(std::string str);

    std::string toString() const;

    static int getMaxStringLen() { return 64; }
 
    unsigned int tag; 
    union {
      int iparms[4];    
      double dparms[4]; 
      char sparm[64];   
    };
    CmdType cmd;      
    CmdTarget target; 
 
    int id;         
    char parm_type; 
 
    static int command_sequence_number; 
 
    static bool table_needs_init;                           
    static std::map<std::string, CmdTarget> target_map_s2v; 
    static std::map<CmdTarget, std::string> target_map_v2s; 
    static void initTables();
 
  private:
    static void initTableEntry(const std::string &, CmdTarget tgt);
  };
 
  template<Command::CmdTarget Targ, int numargs> struct DoubleCommand : public Command {
    template<typename... Args>
    DoubleCommand(CmdType sgr, Args... dvs) : Command(sgr, Targ) {
      static_assert(sizeof...(dvs) == numargs);
      static_assert(numargs <= 4);
      std::vector<double> vals = { static_cast<double>(dvs)... };
      for(int i = 0; i < numargs; i++) {
    dparms[i] = (i >= numargs) ? 0.0 : vals[i];
      }
      parm_type = 'D';
    }
    
    template<typename... Args>
    static CommandPtr make(CmdType sgr, Args... dvs) {
      return std::make_shared<DoubleCommand<Targ, numargs>>(sgr, dvs...);
    }
  };
 
  template<Command::CmdTarget Targ, int numargs> struct IntCommand : public Command {
    template<typename... Args>
    IntCommand(CmdType sgr, Args... ivs) : Command(sgr, Targ) {
      static_assert(sizeof...(ivs) == numargs);
      static_assert(numargs <= 4);
      std::vector<int> vals = { static_cast<int>(ivs)... };
      for(int i = 0; i < numargs; i++) {
    iparms[i] = vals[i];
      }
      parm_type = 'I';
    }
 
    template<typename... Args>
    static CommandPtr make(CmdType sgr, Args... ivs) {
      return std::make_shared<IntCommand<Targ, numargs>>(sgr, ivs...);
    }
  };
 
  template<Command::CmdTarget Targ, typename enum_type> struct EnumCommand : public Command {
    EnumCommand(CmdType sgr, enum_type ev) : Command(sgr, Targ) {
      iparms[0] = static_cast<int>(ev);
      iparms[1] = iparms[2] = iparms[3] = 0;
      parm_type = 'E';
      std::string name = enumToString(ev);
      ::strncpy(sparm + 4, name.c_str(), 59);
      sparm[63] = '\0';
    }
 
    EnumCommand(CmdType sgr) : Command(sgr, Targ) {
      iparms[0] = iparms[1] = iparms[2] = iparms[3] = 0;      
    }
    
    static CommandPtr make(CmdType sgr, enum_type ev) {
      return std::make_shared<EnumCommand<Targ, enum_type>>(sgr, ev);
    }
 
    static CommandPtr make(CmdType sgr) {
      return std::make_shared<EnumCommand<Targ, enum_type>>(sgr);
    }
 
    std::string getEnumStr() {
      return enumToString(static_cast<enum_type>(iparms[0]));
    }
    
  };
 
  template<Command::CmdTarget Targ> struct StringCommand : public Command {
    StringCommand(CmdType sgr, const std::string & s, unsigned int tag = 0)
      : Command(sgr, Targ, s, tag) {}
    StringCommand(CmdType sgr) : Command(sgr, Targ) {}
    static CommandPtr make(CmdType sgr, const std::string & s, unsigned int tag = 0) {
      return std::make_shared<StringCommand<Targ>>(sgr, s, tag);
    }
    static CommandPtr make(CmdType sgr) {
      return std::make_shared<StringCommand<Targ>>(sgr);
    }
  };
 
  typedef DoubleCommand<Command::RX_TUNE_FREQ, 1> CmdRXTuneFreq;
  typedef DoubleCommand<Command::RX_LO_FREQ, 1> CmdRXLOFreq;
  typedef DoubleCommand<Command::RX_IF_FREQ, 1> CmdRXIFFreq;
  typedef DoubleCommand<Command::RX_CENTER_FREQ, 1> CmdRXCenterFreq;
  
  typedef DoubleCommand<Command::TX_TUNE_FREQ, 1> CmdTXTuneFreq;
  typedef DoubleCommand<Command::TX_LO_FREQ, 1> CmdTXLOFreq;
  typedef DoubleCommand<Command::TX_IF_FREQ, 1> CmdTXIFFreq;
 
  typedef EnumCommand<Command::RX_MODE, Command::ModulationType> CmdRXMode;
  typedef EnumCommand<Command::TX_MODE, Command::ModulationType> CmdTXMode;
  typedef EnumCommand<Command::TX_STATE, Command::RxTxState>     CmdTXState;
  typedef EnumCommand<Command::CLOCK_SOURCE, Command::ClockSource> CmdClockSource;
  typedef EnumCommand<Command::TX_AUDIO_IN, Command::TXAudioSelector> CmdTXAudioIn;
 
  typedef IntCommand<Command::TX_BEACON,       1> CmdTXBeacon;
  typedef IntCommand<Command::TX_CW_SPEED,     1> CmdTXCWSpeed;
  typedef IntCommand<Command::TX_CW_MARKER,    1> CmdTXCWMarker;
  typedef IntCommand<Command::TX_CW_FLUSHTEXT, 1> CmdTXCWFlushText;
  typedef IntCommand<Command::TX_CW_EMPTY,     1> CmdTXCWEmpty;
  typedef IntCommand<Command::TX_AUDIO_FILT_ENA, 1> CmdTXAudioFiltEna;
  typedef IntCommand<Command::RX_AF_FILTER,    1> CmdRXAFFilter;
  typedef IntCommand<Command::RX_AF_FILTER_SHAPE, 1> CmdRXAFFilterShape;
  typedef IntCommand<Command::RX_BW,           1> CmdRXBW;
  typedef IntCommand<Command::SPEC_BUF_LEN,    1> CmdSpecBufLen;
  typedef IntCommand<Command::SPEC_AVG_WINDOW, 1> CmdSpecAvgWindow;
  typedef IntCommand<Command::SPEC_UPDATE_RATE,1> CmdSpecUpdateRate;
  typedef IntCommand<Command::GPS_LOCK,        1> CmdGPSLock;
  typedef IntCommand<Command::DBG_REP,         1> CmdDbgRep;
  typedef IntCommand<Command::GPS_UTC,         3> CmdGPSUTC;
 
  typedef StringCommand<Command::RX_ANT>          CmdRXAnt;
  typedef StringCommand<Command::TX_ANT>          CmdTXAnt;
  typedef StringCommand<Command::TX_CW_TEXT>      CmdTXCWText;
  typedef StringCommand<Command::SDR_VERSION>     CmdSDRVersion;
  typedef StringCommand<Command::HWMB_REP>        CmdHWMBRep;
  typedef StringCommand<Command::STATUS_MESSAGE>  CmdStatusMessage;
  typedef StringCommand<Command::RF_RECORD_START> CmdRFRecordStart;
  typedef StringCommand<Command::RX_ANT_NAME>     CmdRXAntName;
  typedef StringCommand<Command::TX_ANT_NAME>     CmdTXAntName;
  typedef StringCommand<Command::MOD_SEL_ENTRY>   CmdModSelEntry;
  typedef StringCommand<Command::AF_FILT_ENTRY>   CmdAFFiltEntry;
  typedef StringCommand<Command::CW_CHAR_SENT>    CmdCWCharSent;
 
inline std::string enumToString(Command::CmdType v) {
  switch(v) {
  case Command::SET:  return "SET";
  case Command::GET:  return "GET";
  case Command::REP:  return "REP";
  case Command::NONE: return "NONE";
  default:            return "CmdType(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::ClockSource v) {
  switch(v) {
  case Command::EXTERNAL: return "EXTERNAL";
  case Command::INTERNAL: return "INTERNAL";
  default:                return "ClockSource(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::RxTxState v) {
  switch(v) {
  case Command::TX_OFF_0: return "TX_OFF_0";
  case Command::TX_OFF_1: return "TX_OFF_1";
  case Command::TX_OFF_2: return "TX_OFF_2";
  case Command::TX_ON_0:  return "TX_ON_0";
  case Command::TX_ON_1:  return "TX_ON_1";
  case Command::TX_ON_2:  return "TX_ON_2";
  default:                return "RxTxState(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::ModulationType v) {
  switch(v) {
  case Command::LSB:  return "LSB";
  case Command::USB:  return "USB";
  case Command::CW_U: return "CW_U";
  case Command::CW_L: return "CW_L";
  case Command::AM:   return "AM";
  case Command::WBFM: return "WBFM";
  case Command::NBFM: return "NBFM";
  default:            return "ModulationType(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::AudioFilterBW v) {
  switch(v) {
  case Command::BW_100:  return "BW_100";
  case Command::BW_500:  return "BW_500";
  case Command::BW_2000: return "BW_2000";
  case Command::BW_6000: return "BW_6000";
  case Command::BW_PASS: return "BW_PASS";
  case Command::BW_WSPR: return "BW_WSPR";
  case Command::BW_NULL: return "BW_NULL";
  default:               return "AudioFilterBW(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::UnitSelector v) {
  switch(v) {
  case Command::BaseBandRX: return "BaseBandRX";
  case Command::BaseBandTX: return "BaseBandTX";
  case Command::RFRX:       return "RFRX";
  case Command::RFTX:       return "RFTX";
  case Command::CWTX:       return "CWTX";
  case Command::CTRL:       return "CTRL";
  default:                  return "UnitSelector(" + std::to_string((int)v) + ")";
  }
}
 
inline std::string enumToString(Command::TXAudioSelector v) {
  switch(v) {
  case Command::MIC:   return "MIC";
  case Command::NOISE: return "NOISE";
  default:             return "TXAudioSelector(" + std::to_string((int)v) + ")";
  }
}
 
} // namespace SoDa