/*
 * Copyright (c) 2007 - 2026 Joseph Gaeddert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

//
// general utilities for manipulating bits and bytes, including
//  * counting ones in a byte, word, long word, etc.
//  * counting bit differences (e.g. errors) in arrays
//  * arrays for fast counting
//  * array for reversing bytes
//

#include <stdio.h>
#include "liquid.internal.h"

// Count the number of ones in a 16-bit integer
unsigned int liquid_count_ones_uint16(uint16_t _x)
{
    return
        liquid_c_ones[ (_x   )  & 0xff ] +
        liquid_c_ones[ (_x>>8)  & 0xff ];
}

unsigned int liquid_count_ones_uint32(uint32_t _x)
{
    return
        liquid_c_ones[ (_x    ) & 0xff ] +
        liquid_c_ones[ (_x>> 8) & 0xff ] +
        liquid_c_ones[ (_x>>16) & 0xff ] +
        liquid_c_ones[ (_x>>24) & 0xff ];
}

// count the number of ones in an integer
unsigned int liquid_count_ones(unsigned int _x)
{
    size_t sizeof_int = sizeof(int);

    if (sizeof_int==2)
        return liquid_count_ones_uint16(_x);
    else if (sizeof_int==4)
        return liquid_count_ones_uint32(_x);

    unsigned int i;
    unsigned int c=0;
    for (i=0; i<sizeof_int; i++) {
        c += liquid_c_ones[ _x & 0xff ];
        _x >>= 8;
    }   
    return c;
}

// Count the number of ones in a 16-bit integer, modulo 2
unsigned int liquid_count_ones_mod2_uint16(uint16_t _x)
{
    return liquid_count_ones_uint16(_x) & 1;
}

// Count the number of ones in a 32-bit integer, modulo 2
unsigned int liquid_count_ones_mod2_uint32(uint32_t _x)
{
    return liquid_count_ones_uint32(_x) & 1;
}

// count the number of ones in an integer, modulo 2
unsigned int liquid_count_ones_mod2(unsigned int _x)
{
    size_t sizeof_int = sizeof(int);

    if (sizeof_int==2)
        return liquid_count_ones_mod2_uint16(_x);
    else if (sizeof_int==4)
        return liquid_count_ones_mod2_uint32(_x);

    unsigned int i;
    unsigned int c=0;
    for (i=0; i<sizeof_int; i++) {
        c += liquid_c_ones_mod2[ _x & 0xff ];
        _x >>= 8;
    }   
    return c & 1;
}

// count the binary dot-product between two integers
unsigned int liquid_bdotprod(unsigned int _x,
                             unsigned int _y)
{
    return liquid_count_ones_mod2(_x & _y);
}

// compute binary dot products on 8-bit words
unsigned int liquid_bdotprod_uint8(uint8_t _x, uint8_t _y)
{
    return liquid_c_ones_mod2[_x & _y];
}

// compute binary dot products on 16-bit words
unsigned int liquid_bdotprod_uint16(uint16_t _x, uint16_t _y)
{
    return liquid_count_ones_mod2_uint16(_x & _y);
}

// compute binary dot products on 32-bit words
unsigned int liquid_bdotprod_uint32(uint32_t _x, uint32_t _y)
{
    return liquid_count_ones_mod2_uint32(_x & _y);
}


// counts the number of different bits between two symbols
unsigned int count_bit_errors(unsigned int _s1,
                              unsigned int _s2)
{
    return liquid_count_ones(_s1^_s2);
}

// counts the number of different bits between two arrays of symbols
//  _msg0   :   original message [size: _n x 1]
//  _msg1   :   copy of original message [size: _n x 1]
//  _n      :   message size
unsigned int count_bit_errors_array(unsigned char * _msg0,
                                    unsigned char * _msg1,
                                    unsigned int _n)
{
    unsigned int num_bit_errors = 0;
    unsigned int i;
    for (i=0; i<_n; i++)
        num_bit_errors += liquid_c_ones[_msg0[i] ^ _msg1[i]];

    return num_bit_errors;
}

// print string of bits to standard output
int liquid_print_bitstring(unsigned int _x,
                           unsigned int _n)
{
    unsigned int i;
    for (i=0; i<_n; i++)
        printf("%1u", (_x >> (_n-i-1)) & 1);
    return LIQUID_OK;
}

// print bitstring to char array
int liquid_sprintf_bitstring(char *       _str,
                             unsigned int _x, 
                             unsigned int _n) 
{
    unsigned int i;
    for (i=0; i<_n; i++)
        _str[i] = ((_x >> (_n-i-1)) & 1) ? '1' : '0';
    _str[i] = '\0';
    return LIQUID_OK;
}

// reverse byte table
unsigned const char liquid_reverse_byte_gentab[256] = {
    0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0,
    0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0,
    0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8,
    0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8,
    0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4,
    0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4,
    0x0c, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec,
    0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc,
    0x02, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2,
    0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2,
    0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea,
    0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa,
    0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6,
    0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6,
    0x0e, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee,
    0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe,
    0x01, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1,
    0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1,
    0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9,
    0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9,
    0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5,
    0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5,
    0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed,
    0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd,
    0x03, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3,
    0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3,
    0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb,
    0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb,
    0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7,
    0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7,
    0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef,
    0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff};

// 
// byte reversal
//

// slow implementation of byte reversal
unsigned char liquid_reverse_byte(unsigned char _x)
{
    unsigned char y = 0x00;
    unsigned int i;
    for (i=0; i<8; i++) {
        y <<= 1;
        y |= _x & 1;
        _x >>= 1;
    }
    return y;
}

// reverse integer with 16 bits of data
unsigned int liquid_reverse_uint16(unsigned int _x)
{
    return (liquid_reverse_byte_gentab[(_x     ) & 0xff] << 8) |
           (liquid_reverse_byte_gentab[(_x >> 8) & 0xff]     );
}

// reverse integer with 24 bits of data
unsigned int liquid_reverse_uint24(unsigned int _x)
{
    return (liquid_reverse_byte_gentab[(_x      ) & 0xff] << 16) |
           (liquid_reverse_byte_gentab[(_x >>  8) & 0xff] <<  8) |
           (liquid_reverse_byte_gentab[(_x >> 16) & 0xff]      );
}

// reverse integer with 32 bits of data
unsigned int liquid_reverse_uint32(unsigned int _x)
{
    return ((unsigned int)(liquid_reverse_byte_gentab[(_x      ) & 0xff]) << 24) |
           (liquid_reverse_byte_gentab[(_x >>  8) & 0xff] << 16) |
           (liquid_reverse_byte_gentab[(_x >> 16) & 0xff] <<  8) |
           (liquid_reverse_byte_gentab[(_x >> 24) & 0xff]      );
}

