source: proto/parabix2/bitutil.py @ 1230

Last change on this file since 1230 was 649, checked in by ksherdy, 9 years ago

Update comment.

File size: 4.7 KB
Line 
1#
2# bitutil.py
3#
4# Bitstream Utilities
5#
6# These are quick-and-dirty Python implementations of utilities
7# for demo purposes only.
8#
9# Robert D. Cameron
10# August 19, 2009
11#
12#----------------------------------------------------------------------------
13#
14# We use python's unlimited precision integers for unbounded bit streams.
15# This permits simple logical operations on the entire stream.
16# Assumption: bitstreams are little-endian (e.g., as on x86).
17#
18#----------------------------------------------------------------------------
19#
20import sys
21import codecs
22# Utility functions for demo purposes.
23#
24
25def writefile(filename, s, charcode='utf-8',):
26        f = codecs.open(filename, 'w', encoding=charcode)
27        f.write(s) # writes encoded bytes to file
28        f.close()
29
30def readfile(filename):
31        f = open(filename, 'r')
32        contents = f.read() 
33        f.close()
34        return contents
35
36def count_leading_zeroes(strm):
37        zeroes = 0
38        while (strm & 0xFFFFFFFF) == 0: 
39                zeroes += 32
40                strm >>= 32
41        while (strm & 1) == 0:
42                zeroes += 1
43                strm >>= 1
44        return zeroes
45
46def EOF_mask(strm_lgth):
47        mask = 1
48        mask <<= (strm_lgth)
49        mask -= 1
50        return mask
51
52def extract_bit(strm, pos):
53        bit = (strm >> pos) & 1
54        return bit
55
56def transpose_streams(s):
57        b = []
58        mask = 128
59        index = 0
60        while index < 8:
61                current = 0
62                cursor = 1
63                for byte in s:
64                        if  (ord(byte) & mask != 0):
65                                current += cursor
66                        cursor <<= 1
67                       
68                index+=1
69                mask>>=1
70                b.append(current)
71        return (b, cursor-1)  # basis streams and EOF mask
72
73def inverse_transpose(bitset, len):
74        bytestream=""
75        cursor = 1
76        for i in range(0, len):
77                byteval = 0
78                for j in range(0,8):
79                        if bitset[j] & cursor != 0:
80                                byteval += 128 >> j
81                bytestream += chr(byteval)
82                cursor += cursor
83        return bytestream
84                       
85def filter_bits(bitstream, delmask):
86        newstream = 0
87        cursor = 1
88        while delmask > 0:
89                if delmask & 1 == 0:
90                        if bitstream & 1 == 1:
91                                newstream += cursor
92                        cursor += cursor
93                delmask >>= 1
94                bitstream >>= 1
95        while bitstream > 0:
96                if bitstream & 1 == 1:
97                        newstream += cursor
98                cursor += cursor
99                bitstream >>= 1         
100        return newstream
101                       
102def filter_bytes(bytestream, delmask):
103        newstream=""
104        cursor = 1
105        for c in bytestream:
106                if delmask & cursor == 0:
107                        newstream += c
108                cursor += cursor
109        return newstream
110                       
111def merge_bytes(stream1, stream2):
112        s = ""
113        for i in range(len(stream1)):
114                s += stream1[i]
115                s += stream2[i]
116        return s
117
118def bitstream2string(stream, lgth):
119        str = ""
120        for i in range(lgth):
121                if stream & 1 == 1: str += '1'
122                else: str += '_'
123                stream >>= 1
124        return str
125
126def bitstream2stringLE(stream, lgth):
127        str = ""
128        for i in range(lgth):
129                if stream & 1 == 1: str = '1' + str
130                else: str = '_' + str
131                stream >>= 1
132        return str
133
134def print_aligned_streams(stream_list):
135        """Print out a set of aligned streams."""
136        label_max = max([len(p[0]) for p in stream_list])
137        for p in stream_list:
138                print (p[0] + " "*(label_max - len(p[0]))) + ": " + p[1] 
139
140def latex_streams(stream_list):
141        """Return a latex table for streams."""
142        table = "\\begin{tabular}{cr}"
143        for p in stream_list:
144                table += "\\\\\n" + p[0] +" & \\verb`" + p[1] +"`"
145        return table + "\n\\end{tabular}\n"
146
147def print_aligned_u8_byte_streams(u8_byte_stream):
148        """Print out a set of 'encoding' aligned streams."""
149
150        # Set the system info to print utf-8
151        info = codecs.lookup('utf-8')
152        sys.stdout = info.streamwriter(sys.stdout) 
153
154        label_max = max([len(p[0]) for p in u8_byte_stream])
155        for p in u8_byte_stream:
156                sys.stdout.write(p[0] + " "*(label_max - len(p[0])) + ": ")
157               
158                for c in (p[1].decode('utf-8')):                        # for each unicode character
159                        u8_seq_len = len(c.encode('utf-8'))     # encode the unicode character as utf-8 and get the utf-8 sequence length
160                        if u8_seq_len == 1:
161                                sys.stdout.write(c)
162                        elif u8_seq_len == 2:
163                                sys.stdout.write('2_')                          # align 2 byte sequences with a trailing _
164                        elif u8_seq_len == 3:
165                                sys.stdout.write('3__')                         # align 3 byte sequences with 2 trailing _
166                        elif u8_seq_len == 4:
167                                sys.stdout.write('4___')                        # align 2 byte sequences with 3 trailing _               
168                        else:
169                                sys.stdout.write('Error: Invalid UTF-8 character sequence of length: ' + str(u8_seq_len) + '.')                 
170                sys.stdout.write('\n')   
171
172def high_nybble_stream(bytes):
173        str=""
174        for b in bytes:
175                h = hex(ord(b))[-2]
176                if h == 'x': str += '0'
177                else: str += h
178        return str
179
180def low_nybble_stream(bytes):
181        str=""
182        for b in bytes:
183                str += hex(ord(b))[-1]
184        return str
185
186
187       
188#
189#  ScanThru is the core operation for parallel scanning.
190#  Given a bitstream Cursors marking current cursor positions,
191#  advance each cursor through occurrences of a character
192#  class identified by ScanStream.
193
194def ScanThru(Cursors, ScanStream):
195        return (Cursors + ScanStream) & ~ScanStream
196
197#
198# Advance all cursors by one position.
199def Advance(stream):
200        return stream + stream
201
Note: See TracBrowser for help on using the repository browser.