MimosisMessage.h

Go to the documentation of this file.

/* Copyright (C) 2025 IKF Frankfurt University, Frankfurt am Main
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Ajit Kumar [committer], Jan Michel*/
 
#ifndef MIMOSISMESSAGE_H
#define MIMOSISMESSAGE_H
 
#include <cstdint>
#include <iostream>
#include <string>
 
namespace mimosis
{

  enum class WordType : uint8_t
  {
    Empty,         
    FrameHeader,   
    RegionHeader,  
    PixelData,     
    FrameTrailer,  
    Spare,         
    Unknown
  };

  enum class TrailerFlags : uint8_t
  {
    FrameOverflow       = 1 << 0,
    RegionOverflow      = 1 << 1,
    SuperRegionOverflow = 1 << 2,
    BufferFull          = 1 << 3
    // Bits 4..7 unused
  };

  struct WordField {
    uint8_t shift;
    uint8_t width;
    constexpr WordField(uint8_t s, uint8_t w) : shift(s), width(w) {}
  };
 
  static constexpr WordField kPixelAddrField(0, 10);    // bits 0-9: pixel address (0..504 used)
  static constexpr WordField kPEAddrField(10, 3);       // bits 10-12: PE (double col) address
  static constexpr WordField kCodeField(13, 3);         // bits 13-15: code (cluster, etc)
  static constexpr WordField kRegionNumField(0, 6);     // bits 0-5: region number (region header)
  static constexpr WordField kFrameNumField(0, 24);     // bits 0-23: frame number (in header)
  static constexpr WordField kTrailerFlagsField(8, 8);  // bits 8-15: trailer flags

  class Message {
   public:
    Message() : fWord(0) {}
    explicit Message(uint16_t word) : fWord(word) {}
    Message(const Message&) = default;
    Message& operator=(const Message&) = default;
 
    uint16_t GetRaw() const { return fWord; }
    void SetRaw(uint16_t w) { fWord = w; }

    WordType GetWordType() const;

    uint16_t GetPixelAddress() const;  // 0..504 used
    uint8_t GetPEAddress() const;
    uint8_t GetCode() const;
    bool IsValidPixelAddress() const;  

    uint8_t GetRegionNumber() const;

    bool IsFrameHeader() const;
    uint32_t GetFrameNumber() const;  

    bool IsFrameTrailer() const;
    uint16_t GetCRC() const;  // For use in parsing context
    uint8_t GetTrailerFlags() const;
 
    bool IsRegionHeader() const;
    bool IsPixelData() const;
    bool IsEmptyWord() const;
    bool IsSpareWord() const;
 
    static std::string PrintWordType(WordType type);

    std::string ToString() const;
 
   private:
    uint16_t fWord;
    static constexpr uint16_t kMaxPixelAddress = 504;  // MIMOSIS spec: addresses 0..504 used
  };
 
}  // namespace mimosis
 
#endif  // MIMOSISMESSAGE_H