openrtx_codeplug.hh

#ifndef OPENRTX_CODEPLUG_HH
#define OPENRTX_CODEPLUG_HH
 
#include "codeplug.hh"
#include "signaling.hh"
#include "channel.hh"
#include "contact.hh"
 
class DMRContact;
class Zone;
class RXGroupList;
class ScanList;
 
class OpenRTXCodeplug : public Codeplug
{
  Q_OBJECT
 
public:
  enum Mode {
    Mode_None = 0, 
    Mode_FM   = 1, 
    Mode_DMR  = 2, 
    Mode_M17  = 3  
  };
 
public:
  class HeaderElement: public Codeplug::Element
  {
  protected:
    HeaderElement(uint8_t *ptr, size_t size);
 
  public:
    HeaderElement(uint8_t *ptr);
 
    void clear();
    bool isValid() const;
 
    virtual uint16_t version() const;
    virtual void setVersion();
 
    virtual QString author() const;
    virtual void setAuthor(const QString &name);
    virtual QString description() const;
    virtual void setDescription(const QString description);
 
    virtual QDateTime timestamp() const;
    virtual void setTimestamp(const QDateTime timestamp=QDateTime::currentDateTime());
 
    virtual unsigned int contactCount() const;
    virtual void setContactCount(unsigned int n);
    virtual unsigned int channelCount() const;
    virtual void setChannelCount(unsigned int n);
    virtual unsigned int zoneCount() const;
    virtual void setZoneCount(unsigned int n);
 
  protected:
    enum Offsets {
      OffsetMagic = 0x00, MagicNumber = 0x43585452, OffsetVersion = 0x08, OffsetAuthor = 0x0a,
      OffsetDescription = 0x2a, OffsetTimestamp = 0x4a, OffsetContactCount = 0x52,
      OffsetChannelCount = 0x54, OffsetZoneCount = 0x56, StringLength = 0x20,
      SupportedVersion = ((0<<8)|1)
    };
  };
 
  class ChannelElement: public Codeplug::Element
  {
  public:
    enum Bandwidth {
      BW_12_5kHz = 0,
      BW_20kHz   = 1,
      BW_25kHz   = 2
    };
 
    enum Timeslot {
      Timeslot1 = 1,
      Timeslot2 = 2
    };
 
    enum ChannelMode {
      M17Voice = 1,
      M17Data = 2,
      M17VoiceData = 3
    };
 
    enum EncryptionMode {
      EncrNone      = 0,
      EncrAES256    = 1,
      EncrScrambler = 2
    };
 
  protected:
    ChannelElement(uint8_t *ptr, size_t size);
 
  public:
    explicit ChannelElement(uint8_t *ptr);
    virtual ~ChannelElement();
 
    bool isValid() const;
 
    virtual void clear();
 
    virtual Mode mode() const;
    virtual void setMode(Mode mode);
 
    virtual bool rxOnly() const;
    virtual void setRXOnly(bool enable);
 
    virtual Bandwidth bandwidth() const;
    virtual void setBandwidth(Bandwidth bw);
 
    virtual float power() const;
    virtual void setPower(float dBm);
 
    virtual double rxFrequency() const;
    virtual void setRXFrequency(double MHz);
    virtual double txFrequency() const;
    virtual void setTXFrequency(double MHz);
 
    virtual bool hasScanListIndex() const;
    virtual unsigned int scanListIndex() const;
    virtual void setScanListIndex(unsigned int index);
    virtual void clearScanListIndex();
 
    virtual bool hasGroupListIndex() const;
    virtual unsigned int groupListIndex() const;
    virtual void setGroupListIndex(unsigned int index);
    virtual void clearGroupListIndex();
 
    virtual QString name() const;
    virtual void setName(const QString &name);
    virtual QString description() const;
    virtual void setDescription(const QString &description);
 
    virtual float latitude() const;
    virtual void setLatitude(float lat);
    virtual float longitude() const;
    virtual void setLongitude(float lat);
    virtual unsigned int altitude() const;
    virtual void setAltitude(unsigned int alt);
 
    virtual Signaling::Code rxTone() const;
    virtual void setRXTone(Signaling::Code code, const ErrorStack &err=ErrorStack());
    virtual Signaling::Code txTone() const;
    virtual void setTXTone(Signaling::Code code, const ErrorStack &err=ErrorStack());
 
    virtual unsigned int rxColorCode() const;
    virtual void setRXColorCode(unsigned int cc);
    virtual unsigned int txColorCode() const;
    virtual void setTXColorCode(unsigned int cc);
 
    virtual DMRChannel::TimeSlot timeslot() const;
    virtual void setTimeslot(DMRChannel::TimeSlot ts);
 
    virtual bool hasDMRContactIndex() const;
    virtual unsigned int dmrContactIndex() const;
    virtual void setDMRContactIndex(unsigned int idx);
    virtual void clearDMRContactIndex();
 
    virtual unsigned int rxChannelAccessNumber() const;
    virtual void setRXChannelAccessNumber(unsigned int cc);
    virtual unsigned int txChannelAccessNumber() const;
    virtual void setTXChannelAccessNumber(unsigned int cc);
 
    virtual EncryptionMode encryptionMode() const;
    virtual void setEncryptionMode(EncryptionMode mode);
 
    virtual ChannelMode channelMode() const;
    virtual void setChannelMode(ChannelMode mode);
 
    virtual bool gpsDataEnabled() const;
    virtual void enableGPSData(bool enable);
 
    virtual bool hasM17ContactIndex() const;
    virtual unsigned int m17ContactIndex() const;
    virtual void setM17ContactIndex(unsigned int idx);
    virtual void clearM17ContactIndex();
 
    virtual Channel *toChannelObj(Context &ctx, const ErrorStack &err=ErrorStack()) const;
    virtual bool linkChannelObj(Channel *c, Context &ctx, const ErrorStack &err=ErrorStack()) const;
    virtual bool fromChannelObj(const Channel *c, Context &ctx, const ErrorStack &err=ErrorStack());
 
  protected:
    enum Offsets {
      OffsetMode = 0x00, OffsetBandwidth = 0x01, BitBandwidth = 0x00, OffsetRXOnly = 0x01,
      BitRXOnly = 0x02, OffsetPower = 0x02, OffsetRXFrequency = 0x03, OffsetTXFrequency = 0x07,
      OffsetScanList = 0x0b, OffsetGroupList = 0x0c, OffsetName = 0x0d, OffsetDescription = 0x2d,
      OffsetChLatInt = 0x4d, OffsetChLatDec = 0x4e, OffsetChLonInt = 0x50, OffsetChLonDec = 0x51,
      OffsetChAltitude = 0x53, OffsetRXTone = 0x55, OffsetTXTone = 0x56, OffsetRXColorCode = 0x55,
      BitRXColorCode = 0x00, OffsetTXColorCode = 0x55, BitTXColorCode = 0x04, OffsetTimeSlot = 0x56,
      OffsetDMRContact = 0x57, OffsetRXCAN = 0x55, BitRXCAN = 0x00, OffsetTXCAN = 0x55,
      BitTXCAN = 0x04, OffsetEncrMode = 0x56, BitEncrMode = 0x04, OffsetM17ChMode = 0x56,
      BitM17ChMode = 0x00, OffsetM17GPSMode = 0x57, OffsetM17Contact = 0x58, StringLength = 0x20
    };
  };
 
  class ContactElement: public Element
  {
  protected:
    ContactElement(uint8_t *ptr, unsigned size);
 
  public:
    explicit ContactElement(uint8_t *ptr);
    virtual ~ContactElement();
 
    void clear();
    bool isValid() const;
 
    virtual QString name() const;
    virtual void setName(const QString &name);
 
    virtual Mode mode() const;
    virtual void setMode(Mode mode);
 
    virtual unsigned int dmrId() const;
    virtual void setDMRId(unsigned int id);
 
    virtual bool dmrRing() const;
    virtual void enableDMRRing(bool enable);
 
    virtual DMRContact::Type dmrContactType() const;
    virtual void setDMRContactType(DMRContact::Type type);
 
    virtual QString m17Call() const;
    virtual bool setM17Call(const QString &call, const ErrorStack &err=ErrorStack());
 
    virtual DMRContact *toContactObj(Context &ctx, const ErrorStack &err=ErrorStack()) const;
    virtual void fromContactObj(const DMRContact *obj, Context &ctx, const ErrorStack &err=ErrorStack());
 
  protected:
    enum Offsets {
      OffsetName = 0x00, OffsetMode = 0x20, OffsetDMRId = 0x21, OffsetDMRCallType = 0x25,
      BitDMRCallType = 0, OffsetDMRRing = 0x25, BitDMRRing = 0x02, OffsetM17Address = 0x21,
      StringLength = 0x20
    };
 
  };
 
 
  class ZoneElement: Element
  {
  protected:
    ZoneElement(uint8_t *ptr, unsigned size);
 
  public:
    explicit ZoneElement(uint8_t *ptr);
    virtual ~ZoneElement();
 
    void clear();
    bool isValid() const;
 
    virtual QString name() const;
    virtual void setName(const QString &name);
 
    virtual unsigned int channelCount() const;
    virtual void setChannelCount(unsigned int n);
 
    virtual unsigned int channelIndex(unsigned int n) const;
    virtual void setChannelIndex(unsigned int n, unsigned int idx);
 
    virtual Zone *toZoneObj(Context &ctx) const;
    virtual bool linkZoneObj(Zone *zone, Context &ctx, bool putInB, const ErrorStack &err=ErrorStack()) const;
    virtual void fromZoneObjA(const Zone *zone, Context &ctx);
    virtual void fromZoneObjB(const Zone *zone, Context &ctx);
 
  protected:
    enum Offsets {
      OffsetName = 0x00, OffsetCount = 0x20, OffsetChannel = 0x22, StringLength = 0x20
    };
  };
 
public:
  explicit OpenRTXCodeplug(QObject *parent=nullptr);
 
  virtual ~OpenRTXCodeplug();
 
  virtual void clear();
 
  bool index(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) const;
 
  bool decode(Config *config, const ErrorStack &err=ErrorStack());
  bool encode(Config *config, const Flags &flags = Flags(), const ErrorStack &err=ErrorStack());
 
public:
  virtual bool decodeElements(Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool encodeElements(const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack());
 
  virtual unsigned int numContacts();
  virtual unsigned int offsetContact(unsigned int n);
  virtual bool encodeContacts(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool createContacts(Config *config, Context &ctx, const ErrorStack &err=ErrorStack());
 
  virtual unsigned int numChannels();
  virtual unsigned int offsetChannel(unsigned int n);
  virtual bool encodeChannels(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool createChannels(Config *config, Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool linkChannels(Config *config, Context &ctx, const ErrorStack &err=ErrorStack());
 
  virtual unsigned int numZones();
  virtual unsigned int offsetZoneOffsets();
  virtual unsigned int offsetZone(unsigned int n);
  virtual bool encodeZones(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool createZones(Config *config, Context &ctx, const ErrorStack &err=ErrorStack());
  virtual bool linkZones(Config *config, Context &ctx, const ErrorStack &err=ErrorStack());
 
protected:
  enum Offsets {
    HeaderSize = 0x58, ChannelSize = 0x5a, ContactSize = 0x27, ZoneHeaderSize=0x22
  };
};
 
#endif // OPENRTX_CODEPLUG_HH