SphinxBase  5prealpha
bitarr.c
1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /* ====================================================================
3  * Copyright (c) 2015 Carnegie Mellon University. All rights
4  * reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * This work was supported in part by funding from the Defense Advanced
19  * Research Projects Agency and the National Science Foundation of the
20  * United States of America, and the CMU Sphinx Speech Consortium.
21  *
22  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
23  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
26  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * ====================================================================
35  *
36  */
37 
38 /*
39  * bitarr.c -- Bit array manipulations implementation.
40  */
41 
42 #ifdef __APPLE__
43 #include <architecture/byte_order.h>
44 #elif __linux__
45 #include <endian.h>
46 #elif !defined(_WIN32) && !defined(_WIN64)
47 #include <arpa/nameser_compat.h>
48 #endif
49 
50 #include "sphinxbase/bitarr.h"
51 
55 typedef union {
56  float f;
57  uint32 i;
58 } float_enc;
59 
60 #define SIGN_BIT (0x80000000)
61 
69 static uint8 get_shift(uint8 bit, uint8 length)
70 {
71 #if BYTE_ORDER == LITTLE_ENDIAN
72  return bit;
73 #elif BYTE_ORDER == BIG_ENDIAN
74  return 64 - length - bit;
75 #else
76 #error "Bit packing code isn't written for your byte order."
77 #endif
78 }
79 
86 static uint64 read_off(bitarr_address_t address)
87 {
88 #if defined(__arm) || defined(__arm__)
89  uint64 value64;
90  const uint8 *base_off = (const uint8 *)(address.base) + (address.offset >> 3);
91  memcpy(&value64, base_off, sizeof(value64));
92  return value64;
93 #else
94  return *(const uint64*)((const uint8 *)(address.base) + (address.offset >> 3));
95 #endif
96 }
97 
98 uint64 bitarr_read_int57(bitarr_address_t address, uint8 length, uint64 mask)
99 {
100  return (read_off(address) >> get_shift(address.offset & 7, length)) & mask;
101 }
102 
103 void bitarr_write_int57(bitarr_address_t address, uint8 length, uint64 value)
104 {
105 #if defined(__arm) || defined(__arm__)
106  uint64 value64;
107  uint8 *base_off = (uint8 *)(address.base) + (address.offset >> 3);
108  memcpy(&value64, base_off, sizeof(value64));
109  value64 |= (value << get_shift(address.offset & 7, length));
110  memcpy(base_off, &value64, sizeof(value64));
111 #else
112  *(uint64 *)((uint8 *)(address.base) + (address.offset >> 3)) |= (value << get_shift(address.offset & 7, length));
113 #endif
114 }
115 
116 uint32 bitarr_read_int25(bitarr_address_t address, uint8 length, uint32 mask)
117 {
118 #if defined(__arm) || defined(__arm__)
119  uint32 value32;
120  const uint8 *base_off = (const uint8_t*)(address.base) + (address.offset >> 3);
121  memcpy(&value32, base_off, sizeof(value32));
122  return (value32 >> get_shift(address.offset & 7, length)) & mask;
123 #else
124  return (*(const uint32_t*)((const uint8_t*)(address.base) + (address.offset >> 3)) >> get_shift(address.offset & 7, length)) & mask;
125 #endif
126 }
127 
128 void bitarr_write_int25(bitarr_address_t address, uint8 length, uint32 value)
129 {
130 #if defined(__arm) || defined(__arm__)
131  uint32 value32;
132  uint8 *base_off = (uint8 *)(address.base) + (address.offset >> 3);
133  memcpy(&value32, base_off, sizeof(value32));
134  value32 |= (value << get_shift(address.offset & 7, length));
135  memcpy(base_off, &value32, sizeof(value32));
136 #else
137  *(uint32_t *)((uint8 *)(address.base) + (address.offset >> 3)) |= (value << get_shift(address.offset & 7, length));
138 #endif
139 }
140 
142 {
143  float_enc encoded;
144  encoded.i = (uint32)(read_off(address) >> get_shift(address.offset & 7, 31));
145  // Sign bit set means negative.
146  encoded.i |= SIGN_BIT;
147  return encoded.f;
148 }
149 
150 void bitarr_write_negfloat(bitarr_address_t address, float value)
151 {
152  float_enc encoded;
153  encoded.f = value;
154  encoded.i &= ~SIGN_BIT;
155  bitarr_write_int57(address, 31, encoded.i);
156 }
157 
159 {
160  float_enc encoded;
161  encoded.i = (uint32)(read_off(address) >> get_shift(address.offset & 7, 32));
162  return encoded.f;
163 }
164 
165 void bitarr_write_float(bitarr_address_t address, float value)
166 {
167  float_enc encoded;
168  encoded.f = value;
169  bitarr_write_int57(address, 32, encoded.i);
170 }
171 
172 void bitarr_mask_from_max(bitarr_mask_t *bit_mask, uint32 max_value)
173 {
174  bit_mask->bits = bitarr_required_bits(max_value);
175  bit_mask->mask = (uint32)((1ULL << bit_mask->bits) - 1);
176 }
177 
178 uint8 bitarr_required_bits(uint32 max_value)
179 {
180  uint8 res;
181 
182  if (!max_value) return 0;
183  res = 1;
184  while (max_value >>= 1) res++;
185  return res;
186 }
SPHINXBASE_EXPORT void bitarr_write_negfloat(bitarr_address_t address, float value)
Writes non positive float32 to bit array.
Definition: bitarr.c:150
SPHINXBASE_EXPORT void bitarr_mask_from_max(bitarr_mask_t *bit_mask, uint32 max_value)
Fills mask for certain int range according to provided max value.
Definition: bitarr.c:172
SPHINXBASE_EXPORT uint8 bitarr_required_bits(uint32 max_value)
Computes amount of bits required ti store integers upto value provided.
Definition: bitarr.c:178
SPHINXBASE_EXPORT float bitarr_read_negfloat(bitarr_address_t address)
Read non positive float32 from bit array.
Definition: bitarr.c:141
SPHINXBASE_EXPORT void bitarr_write_int25(bitarr_address_t address, uint8 length, uint32 value)
Write specified value into bit array.
Definition: bitarr.c:128
Union to map float to integer to store latter in bit array.
Definition: bitarr.c:55
Structure that stores address of certain value in bit array.
Definition: bitarr.h:75
SPHINXBASE_EXPORT uint32 bitarr_read_int25(bitarr_address_t address, uint8 length, uint32 mask)
Read uint32 value from bit array.
Definition: bitarr.c:116
SPHINXBASE_EXPORT void bitarr_write_float(bitarr_address_t address, float value)
Writes float32 to bit array.
Definition: bitarr.c:165
SPHINXBASE_EXPORT void bitarr_write_int57(bitarr_address_t address, uint8 length, uint64 value)
Write specified value into bit array.
Definition: bitarr.c:103
Structure that specifies bits required to efficiently store certain data.
Definition: bitarr.h:67
SPHINXBASE_EXPORT float bitarr_read_float(bitarr_address_t address)
Reads float32 from bit array.
Definition: bitarr.c:158
An implementation bit array - memory efficient storage for digit int and float data.
SPHINXBASE_EXPORT uint64 bitarr_read_int57(bitarr_address_t address, uint8 length, uint64 mask)
Read uint64 value from bit array.
Definition: bitarr.c:98