1

/* $Id$ */

     2

     3

/** @file bitmath_func.hpp Functions related to bit mathematics. */

     4

     5

#ifndef BITMATH_FUNC_HPP

     6

#define BITMATH_FUNC_HPP

     7

     8

/**

     9

 * Fetch n bits from x, started at bit s.

    10

 *

    11

 * This function can be used to fetch n bits from the value x. The

    12

 * s value set the startposition to read. The startposition is

    13

 * count from the LSB and starts at 0. The result starts at a

    14

 * LSB, as this isn't just an and-bitmask but also some

    15

 * bit-shifting operations. GB(0xFF, 2, 1) will so

    16

 * return 0x01 (0000 0001) instead of

    17

 * 0x04 (0000 0100).

    18

 *

    19

 * @param x The value to read some bits.

    20

 * @param s The startposition to read some bits.

    21

 * @param n The number of bits to read.

    22

 * @return The selected bits, aligned to a LSB.

    23

 */

    24

template<typename T> static inline uint GB(const T x, const uint8 s, const uint8 n)

    25

{

    26

	return (x >> s) & ((1U << n) - 1);

    27

}

    28

    29

/** Set n bits from x starting at bit s to d

    30

 *

    31

 * This function sets n bits from x which started as bit s to the value of

    32

 * d. The parameters x, s and n works the same as the parameters of

    33

 * #GB. The result is saved in x again. Unused bits in the window

    34

 * provided by n are set to 0 if the value of b isn't "big" enough.

    35

 * This is not a bug, its a feature.

    36

 *

    37

 * @note Parameter x must be a variable as the result is saved there.

    38

 * @note To avoid unexpecting results the value of b should not use more

    39

 *       space as the provided space of n bits (log2)

    40

 * @param x The variable to change some bits

    41

 * @param s The startposition for the new bits

    42

 * @param n The size/window for the new bits

    43

 * @param d The actually new bits to save in the defined position.

    44

 * @return The new value of x

    45

 */

    46

template<typename T, typename U> static inline T SB(T& x, const uint8 s, const uint8 n, const U d)

    47

{

    48

	x &= (T)(~(((1U << n) - 1) << s));

    49

	x |= (T)(d << s);

    50

	return x;

    51

}

    52

    53

/** Add i to n bits of x starting at bit s.

    54

 *

    55

 * This add the value of i on n bits of x starting at bit s. The parameters x,

    56

 * s, i are similar to #GB besides x must be a variable as the result are

    57

 * saved there. An overflow does not affect the following bits of the given

    58

 * bit window and is simply ignored.

    59

 *

    60

 * @note Parameter x must be a variable as the result is saved there.

    61

 * @param x The variable to add some bits at some position

    62

 * @param s The startposition of the addition

    63

 * @param n The size/window for the addition

    64

 * @param i The value to add at the given startposition in the given window.

    65

 * @return The new value of x

    66

 */

    67

template<typename T, typename U> static inline T AB(T& x, const uint8 s, const uint8 n, const U i)

    68

{

    69

	const T mask = (T)(((1U << n) - 1) << s);

    70

	x = (T)((x & ~mask) | ((x + (i << s)) & mask));

    71

	return x;

    72

}

    73

    74

/**

    75

 * Checks if a bit in a value is set.

    76

 *

    77

 * This function checks if a bit inside a value is set or not.

    78

 * The y value specific the position of the bit, started at the

    79

 * LSB and count from 0.

    80

 *

    81

 * @param x The value to check

    82

 * @param y The position of the bit to check, started from the LSB

    83

 * @return True if the bit is set, false else.

    84

 */

    85

template<typename T> static inline bool HasBit(const T x, const uint8 y)

    86

{

    87

	return (x & ((T)1U << y)) != 0;

    88

}

    89

    90

/**

    91

 * Check several bits in a value.

    92

 *

    93

 * This macro checks if a value contains at least one bit of an other

    94

 * value.

    95

 *

    96

 * @param x The first value

    97

 * @param y The second value

    98

 * @return True if at least one bit is set in both values, false else.

    99

 */

   100

#define HASBITS(x, y) (((x) & (y)) != 0)

   101

   102

/**

   103

 * Set a bit in a variable.

   104

 *

   105

 * This function sets a bit in a variable. The variable is changed

   106

 * and the value is also returned. Parameter y defines the bit and

   107

 * starts at the LSB with 0.

   108

 *

   109

 * @param x The variable to set a bit

   110

 * @param y The bit position to set

   111

 * @return The new value of the old value with the bit set

   112

 */

   113

template<typename T> static inline T SetBit(T& x, const uint8 y)

   114

{

   115

	return x = (T)(x | (T)(1U << y));

   116

}

   117

   118

/**

   119

 * Sets several bits in a variable.

   120

 *

   121

 * This macro sets several bits in a variable. The bits to set are provided

   122

 * by a value. The new value is also returned.

   123

 *

   124

 * @param x The variable to set some bits

   125

 * @param y The value with set bits for setting them in the variable

   126

 * @return The new value of x

   127

 */

   128

#define SETBITS(x, y) ((x) |= (y))

   129

   130

/**

   131

 * Clears a bit in a variable.

   132

 *

   133

 * This function clears a bit in a variable. The variable is

   134

 * changed and the value is also returned. Parameter y defines the bit

   135

 * to clear and starts at the LSB with 0.

   136

 *

   137

 * @param x The variable to clear the bit

   138

 * @param y The bit position to clear

   139

 * @return The new value of the old value with the bit cleared

   140

 */

   141

template<typename T> static inline T ClrBit(T& x, const uint8 y)

   142

{

   143

	return x = (T)(x & ~((T)1U << y));

   144

}

   145

   146

/**

   147

 * Clears several bits in a variable.

   148

 *

   149

 * This macro clears several bits in a variable. The bits to clear are

   150

 * provided by a value. The new value is also returned.

   151

 *

   152

 * @param x The variable to clear some bits

   153

 * @param y The value with set bits for clearing them in the variable

   154

 * @return The new value of x

   155

 */

   156

#define CLRBITS(x, y) ((x) &= ~(y))

   157

   158

/**

   159

 * Toggles a bit in a variable.

   160

 *

   161

 * This function toggles a bit in a variable. The variable is

   162

 * changed and the value is also returned. Parameter y defines the bit

   163

 * to toggle and starts at the LSB with 0.

   164

 *

   165

 * @param x The varliable to toggle the bit

   166

 * @param y The bit position to toggle

   167

 * @return The new value of the old value with the bit toggled

   168

 */

   169

template<typename T> static inline T ToggleBit(T& x, const uint8 y)

   170

{

   171

	return x = (T)(x ^ (T)(1U << y));

   172

}

   173

   174

   175

/** Lookup table to check which bit is set in a 6 bit variable */

   176

extern const uint8 _ffb_64[64];

   177

   178

/**

   179

 * Returns the first occure of a bit in a 6-bit value (from right).

   180

 *

   181

 * Returns the position of the first bit that is not zero, counted from the

   182

 * LSB. Ie, 110100 returns 2, 000001 returns 0, etc. When x == 0 returns

   183

 * 0.

   184

 *

   185

 * @param x The 6-bit value to check the first zero-bit

   186

 * @return The first position of a bit started from the LSB or 0 if x is 0.

   187

 */

   188

#define FIND_FIRST_BIT(x) _ffb_64[(x)]

   189

   190

/**

   191

 * Finds the position of the first bit in an integer.

   192

 *

   193

 * This function returns the position of the first bit set in the

   194

 * integer. It does only check the bits of the bitmask

   195

 * 0x3F3F (0011111100111111) and checks only the

   196

 * bits of the bitmask 0x3F00 if and only if the

   197

 * lower part 0x00FF is 0. This results the bits at 0x00C0 must

   198

 * be also zero to check the bits at 0x3F00.

   199

 *

   200

 * @param value The value to check the first bits

   201

 * @return The position of the first bit which is set

   202

 * @see FIND_FIRST_BIT

   203

 */

   204

static inline uint8 FindFirstBit2x64(const int value)

   205

{

   206

	if ((value & 0xFF) == 0) {

   207

		return FIND_FIRST_BIT((value >> 8) & 0x3F) + 8;

   208

	} else {

   209

		return FIND_FIRST_BIT(value & 0x3F);

   210

	}

   211

}

   212

   213

uint8 FindFirstBit(uint32 x);

   214

uint8 FindLastBit(uint64 x);

   215

   216

/**

   217

 * Clear the first bit in an integer.

   218

 *

   219

 * This function returns a value where the first bit (from LSB)

   220

 * is cleared.

   221

 * So, 110100 returns 110000, 000001 returns 000000, etc.

   222

 *

   223

 * @param value The value to clear the first bit

   224

 * @return The new value with the first bit cleared

   225

 */

   226

template<typename T> static inline T KillFirstBit(T value)

   227

{

   228

	return value &= (T)(value - 1);

   229

}

   230

   231

/**

   232

 * Counts the number of set bits in a variable.

   233

 *

   234

 * @param value the value to count the number of bits in.

   235

 * @return the number of bits.

   236

 */

   237

template<typename T> static inline uint CountBits(T value)

   238

{

   239

	uint num;

   240

   241

	/* This loop is only called once for every bit set by clearing the lowest

   242

	 * bit in each loop. The number of bits is therefore equal to the number of

   243

	 * times the loop was called. It was found at the following website:

   244

	 * http://graphics.stanford.edu/~seander/bithacks.html */

   245

   246

	for (num = 0; value != 0; num++) {

   247

		value &= (T)(value - 1);

   248

	}

   249

   250

	return num;

   251

}

   252

   253

/**

   254

 * ROtate x Left by n

   255

 *

   256

 * @note Assumes a byte has 8 bits

   257

 * @param x The value which we want to rotate

   258

 * @param n The number how many we waht to rotate

   259

 * @return A bit rotated number

   260

 */

   261

template<typename T> static inline T ROL(const T x, const uint8 n)

   262

{

   263

	return (T)(x << n | x >> (sizeof(x) * 8 - n));

   264

}

   265

   266

/**

   267

 * ROtate x Right by n

   268

 *

   269

 * @note Assumes a byte has 8 bits

   270

 * @param x The value which we want to rotate

   271

 * @param n The number how many we waht to rotate

   272

 * @return A bit rotated number

   273

 */

   274

template<typename T> static inline T ROR(const T x, const uint8 n)

   275

{

   276

	return (T)(x >> n | x << (sizeof(x) * 8 - n));

   277

}

   278

   279

/**

   280

 * Do an operation for each set set bit in a value.

   281

 *

   282

 * This macros is used to do an operation for each set

   283

 * bit in a variable. The first variable can be reused

   284

 * in the operation due to it's the bit position counter.

   285

 * The second variable will be cleared during the usage

   286

 *

   287

 * @param i The position counter

   288

 * @param b The value which we check for set bits

   289

 */

   290

#define FOR_EACH_SET_BIT(i, b)      \

   291

	for (i = 0; b != 0; i++, b >>= 1) \

   292

		if (b & 1)

   293

   294

   295

#if defined(__APPLE__)

   296

	/* Make endian swapping use Apple's macros to increase speed

   297

	 * (since it will use hardware swapping if available).

   298

	 * Even though they should return uint16 and uint32, we get

   299

	 * warnings if we don't cast those (why?) */

   300

	#define BSWAP32(x) ((uint32)Endian32_Swap(x))

   301

	#define BSWAP16(x) ((uint16)Endian16_Swap(x))

   302

#else

   303

	/**

   304

	 * Perform a 32 bits endianness bitswap on x.

   305

	 * @param x the variable to bitswap

   306

	 * @return the bitswapped value.

   307

	 */

   308

	static inline uint32 BSWAP32(uint32 x)

   309

	{

   310

		return ((x >> 24) & 0xFF) | ((x >> 8) & 0xFF00) | ((x << 8) & 0xFF0000) | ((x << 24) & 0xFF000000);

   311

	}

   312

   313

	/**

   314

	 * Perform a 16 bits endianness bitswap on x.

   315

	 * @param x the variable to bitswap

   316

	 * @return the bitswapped value.

   317

	 */

   318

	static inline uint16 BSWAP16(uint16 x)

   319

	{

   320

		return (x >> 8) | (x << 8);

   321

	}

   322

#endif /* __APPLE__ */

   323

   324

#endif /* BITMATH_FUNC_HPP */