MimosisMessage.cxx

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*/
 
#include "MimosisMessage.h"
 
#include <iomanip>
#include <sstream>
 
namespace mimosis
{
 
  WordType Message::GetWordType() const
  {
    uint16_t w = fWord;
    if (w == 0xFCAA) return WordType::Empty;  // Strictly for empty word
    if ((w & 0xFF00) == 0xFE00) return WordType::FrameHeader;
    if ((w & 0xFF00) == 0xFD00) return WordType::RegionHeader;
    if ((w & 0xFF00) == 0xFF00) return WordType::FrameTrailer;
    if (w <= 0xFBFF) return WordType::PixelData;
    if ((w & 0xFF80) == 0xFC00) return WordType::Spare;  // Spare words in 0xFC00 - 0xFC7F, except 0xFCAA
    return WordType::Unknown;
  }
 
  uint16_t Message::GetPixelAddress() const
  {
    // Only valid if type is PixelData (0..504)
    return fWord & 0x03FF;  // bits 0-9
  }
 
  uint8_t Message::GetPEAddress() const
  {
    return (fWord >> 10) & 0x07;  // bits 10-12
  }
 
  uint8_t Message::GetCode() const
  {
    return (fWord >> 13) & 0x07;  // bits 13-15
  }
 
  bool Message::IsValidPixelAddress() const
  {
    // Only valid for PixelData type
    return (GetWordType() == WordType::PixelData) && (GetPixelAddress() <= kMaxPixelAddress);
  }
 
  uint8_t Message::GetRegionNumber() const
  {
    // Valid if region header
    return fWord & 0x3F;  // bits 0-5
  }
 
  bool Message::IsFrameHeader() const { return GetWordType() == WordType::FrameHeader; }
 
  uint32_t Message::GetFrameNumber() const
  {
    // Frame number is in bits 0-23 of the correct frame header word (see ![image2](image2))
    // You need to invoke this only on the right header word in the frame header sequence.
    // Typically, the last of the 8 header words is the one holding the frame number.
    return static_cast<uint32_t>(fWord & 0x00FF) | (static_cast<uint32_t>((fWord & 0xFF00) >> 8) << 8);
    // Note: For full 24-bit, you may need to assemble from multiple header words
    // depending on the actual frame header sequence; please check your data format.
  }
 
  bool Message::IsFrameTrailer() const { return GetWordType() == WordType::FrameTrailer; }
 
  uint16_t Message::GetCRC() const
  {
    // In context: CRC is second-to-last word in trailer; just returns value
    return fWord;
  }
 
  uint8_t Message::GetTrailerFlags() const
  {
    // Only valid for last word in trailer: upper byte = 0xFF, lower byte = flags
    return (fWord & 0xFF);  // flags are in low byte
  }
 
  bool Message::IsRegionHeader() const { return GetWordType() == WordType::RegionHeader; }
  bool Message::IsPixelData() const { return GetWordType() == WordType::PixelData; }
  bool Message::IsEmptyWord() const { return GetWordType() == WordType::Empty; }
  bool Message::IsSpareWord() const { return GetWordType() == WordType::Spare; }
 
  std::string Message::PrintWordType(WordType type)
  {
    switch (type) {
      case WordType::Empty: return "Empty";
      case WordType::FrameHeader: return "FrameHeader";
      case WordType::RegionHeader: return "RegionHeader";
      case WordType::PixelData: return "PixelData";
      case WordType::FrameTrailer: return "FrameTrailer";
      case WordType::Spare: return "Spare";
      default: return "Unknown";
    }
  }
 
  std::string Message::ToString() const
  {
    std::ostringstream ss;
    ss << "[0x" << std::hex << std::setw(4) << std::setfill('0') << fWord << "] ";
    auto t = GetWordType();
    ss << PrintWordType(t);
 
    switch (t) {
      case WordType::FrameHeader:
        ss << " FrameHeader";
        ss << " (Raw: 0x" << std::hex << fWord << ")";
        break;
      case WordType::RegionHeader: ss << " Region#" << static_cast<int>(GetRegionNumber()); break;
      case WordType::PixelData:
        ss << " PixelAddr=" << static_cast<int>(GetPixelAddress()) << " PE=" << static_cast<int>(GetPEAddress())
           << " Code=" << static_cast<int>(GetCode()) << (IsValidPixelAddress() ? " [VALID]" : " [INVALID]");
        break;
      case WordType::FrameTrailer:
        ss << " Trailer ";
        ss << " Flags=0x" << std::hex << static_cast<int>(GetTrailerFlags());
        break;
      case WordType::Empty: ss << " Empty"; break;
      case WordType::Spare: ss << " Spare"; break;
      default: ss << " Unknown"; break;
    }
    return ss.str();
  }
 
}  // namespace mimosis