mirror of
https://github.com/DSheirer/sdrtrunk.git
synced 2026-11-16 10:37:26 -05:00
95 lines
3.3 KiB
Java
95 lines
3.3 KiB
Java
/*
|
|
* *****************************************************************************
|
|
* Copyright (C) 2014-2025 Dennis Sheirer
|
|
*
|
|
* 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, either 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 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/>
|
|
* ****************************************************************************
|
|
*/
|
|
|
|
package io.github.dsheirer.edac;
|
|
|
|
import io.github.dsheirer.bits.BinaryMessage;
|
|
|
|
/**
|
|
* Hamming(17,12,3) Error detection and correction utility.
|
|
*/
|
|
public class Hamming17 implements IHamming
|
|
{
|
|
private static int[] CHECKSUMS = new int[]{0x1B, 0x1F, 0x1D, 0x1C, 0x0E, 0x07, 0x11, 0x1A, 0x0D, 0x14, 0x0A, 0x05,
|
|
0x10, 0x08, 0x04, 0x02, 0x01};
|
|
|
|
/**
|
|
* Calculates the bit error index of the Hamming(17,12,3) protected word that is contained in the binary message
|
|
* starting at the specified offset.
|
|
*
|
|
* @param message containing a Hamming protected word
|
|
* @param offset to the start of the protected word
|
|
* @return message index for an error bit or -1 if no errors are detected or 1000 if more than one bit error detected.
|
|
*/
|
|
public int getErrorIndex(BinaryMessage message, int offset)
|
|
{
|
|
int syndrome = getSyndrome(message, offset);
|
|
|
|
if(syndrome == 0)
|
|
{
|
|
return NO_ERRORS;
|
|
}
|
|
|
|
for(int index = 0; index < CHECKSUMS.length; index++)
|
|
{
|
|
if(syndrome == CHECKSUMS[index])
|
|
{
|
|
return index + offset;
|
|
}
|
|
}
|
|
|
|
return MULTIPLE_ERRORS;
|
|
}
|
|
|
|
/**
|
|
* Calculates the checksum (Parity 16,8,4,2,1) for data (12 <> 1 ) bits.
|
|
*
|
|
* @param frame - frame containing hamming protected word
|
|
* @param startIndex - start bit index of the hamming protected word
|
|
* @return checksum value
|
|
*/
|
|
private static int calculateChecksum(BinaryMessage frame, int startIndex)
|
|
{
|
|
int calculated = 0; //Starting value
|
|
|
|
/* Iterate the set bits and XOR running checksum with lookup value */
|
|
for(int i = frame.nextSetBit(startIndex); i >= startIndex && i < startIndex + 12; i = frame.nextSetBit(i + 1))
|
|
{
|
|
calculated ^= CHECKSUMS[i - startIndex];
|
|
}
|
|
|
|
return calculated;
|
|
}
|
|
|
|
/**
|
|
* Calculates the syndrome - xor of the calculated checksum and the actual
|
|
* checksum.
|
|
*
|
|
* @param frame - binary frame containing a hamming(17,12,5) protected word
|
|
* @param startIndex - of bit 0 of the hamming protected word
|
|
* @return - 0 (no errors) or 1 (single bit error corrected)
|
|
*/
|
|
public static int getSyndrome(BinaryMessage frame, int startIndex)
|
|
{
|
|
int calculated = calculateChecksum(frame, startIndex);
|
|
int checksum = frame.getInt(startIndex + 12, startIndex + 16);
|
|
return (checksum ^ calculated);
|
|
}
|
|
}
|