File: huffman.rb

package info (click to toggle)
ruby-protocol-hpack 1.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 196 kB
  • sloc: ruby: 887; makefile: 4
file content (331 lines) | stat: -rw-r--r-- 6,951 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2014-2015, by Kaoru Maeda.
# Copyright, 2015, by Ilya Grigorik.
# Copyright, 2015, by Tamir Duberstein.
# Copyright, 2018-2024, by Samuel Williams.
# Copyright, 2022, by Daniel Morrison.
# Copyright, 2024, by Nathan Froyd.

require_relative "huffman/machine"
require_relative "error"

module Protocol
	module HPACK
		# Implementation of huffman encoding for HPACK.
		class Huffman
			BITS_AT_ONCE = 4
			EOS = 256

			# Encodes provided value via huffman encoding.
			# Length is not encoded in this method.
			#
			# @param str [String]
			# @return [String] binary string
			def self.encode(str)
				bitstring = str.each_byte.map {|chr| ENCODE_TABLE[chr]}.join
				bitstring << "1" * ((8 - bitstring.size) % 8)
				[bitstring].pack("B*")
			end

			# Decodes provided Huffman coded string.
			#
			# @param buf [Buffer]
			# @return [String] binary string
			# @raise [CompressionError] when Huffman coded string is malformed
			def self.decode(buffer)
				emit = String.new.b
				state = 0 # start state

				mask = (1 << BITS_AT_ONCE) - 1
				buffer.each_byte do |c|
					shift = BITS_AT_ONCE
					while shift >= 0
						branch = (c >> shift) & mask
						
						# MACHINE[state] = [final, [transitions]]
						#  [final] unfinished bits so far are prefix of the EOS code.
						# Each transition is [emit, next]
						#  [emit] character to be emitted on this transition, empty string, or EOS.
						#  [next] next state number.
						value, state = MACHINE[state][branch]
						
						raise CompressionError, "Huffman decode error (EOS found)" if value == EOS
						
						emit << value.chr if value
						shift -= BITS_AT_ONCE
					end
				end
				# Check whether partial input is correctly filled
				unless state <= MAX_FINAL_STATE
					raise CompressionError, "Huffman decode error (EOS invalid)"
				end
				emit.force_encoding(Encoding::BINARY)
			end

			# Huffman table as specified in https://tools.ietf.org/html/rfc7541#appendix-B
			CODES = [
				[0x1ff8, 13],
				[0x7fffd8, 23],
				[0xfffffe2, 28],
				[0xfffffe3, 28],
				[0xfffffe4, 28],
				[0xfffffe5, 28],
				[0xfffffe6, 28],
				[0xfffffe7, 28],
				[0xfffffe8, 28],
				[0xffffea, 24],
				[0x3ffffffc, 30],
				[0xfffffe9, 28],
				[0xfffffea, 28],
				[0x3ffffffd, 30],
				[0xfffffeb, 28],
				[0xfffffec, 28],
				[0xfffffed, 28],
				[0xfffffee, 28],
				[0xfffffef, 28],
				[0xffffff0, 28],
				[0xffffff1, 28],
				[0xffffff2, 28],
				[0x3ffffffe, 30],
				[0xffffff3, 28],
				[0xffffff4, 28],
				[0xffffff5, 28],
				[0xffffff6, 28],
				[0xffffff7, 28],
				[0xffffff8, 28],
				[0xffffff9, 28],
				[0xffffffa, 28],
				[0xffffffb, 28],
				[0x14, 6],
				[0x3f8, 10],
				[0x3f9, 10],
				[0xffa, 12],
				[0x1ff9, 13],
				[0x15, 6],
				[0xf8, 8],
				[0x7fa, 11],
				[0x3fa, 10],
				[0x3fb, 10],
				[0xf9, 8],
				[0x7fb, 11],
				[0xfa, 8],
				[0x16, 6],
				[0x17, 6],
				[0x18, 6],
				[0x0, 5],
				[0x1, 5],
				[0x2, 5],
				[0x19, 6],
				[0x1a, 6],
				[0x1b, 6],
				[0x1c, 6],
				[0x1d, 6],
				[0x1e, 6],
				[0x1f, 6],
				[0x5c, 7],
				[0xfb, 8],
				[0x7ffc, 15],
				[0x20, 6],
				[0xffb, 12],
				[0x3fc, 10],
				[0x1ffa, 13],
				[0x21, 6],
				[0x5d, 7],
				[0x5e, 7],
				[0x5f, 7],
				[0x60, 7],
				[0x61, 7],
				[0x62, 7],
				[0x63, 7],
				[0x64, 7],
				[0x65, 7],
				[0x66, 7],
				[0x67, 7],
				[0x68, 7],
				[0x69, 7],
				[0x6a, 7],
				[0x6b, 7],
				[0x6c, 7],
				[0x6d, 7],
				[0x6e, 7],
				[0x6f, 7],
				[0x70, 7],
				[0x71, 7],
				[0x72, 7],
				[0xfc, 8],
				[0x73, 7],
				[0xfd, 8],
				[0x1ffb, 13],
				[0x7fff0, 19],
				[0x1ffc, 13],
				[0x3ffc, 14],
				[0x22, 6],
				[0x7ffd, 15],
				[0x3, 5],
				[0x23, 6],
				[0x4, 5],
				[0x24, 6],
				[0x5, 5],
				[0x25, 6],
				[0x26, 6],
				[0x27, 6],
				[0x6, 5],
				[0x74, 7],
				[0x75, 7],
				[0x28, 6],
				[0x29, 6],
				[0x2a, 6],
				[0x7, 5],
				[0x2b, 6],
				[0x76, 7],
				[0x2c, 6],
				[0x8, 5],
				[0x9, 5],
				[0x2d, 6],
				[0x77, 7],
				[0x78, 7],
				[0x79, 7],
				[0x7a, 7],
				[0x7b, 7],
				[0x7ffe, 15],
				[0x7fc, 11],
				[0x3ffd, 14],
				[0x1ffd, 13],
				[0xffffffc, 28],
				[0xfffe6, 20],
				[0x3fffd2, 22],
				[0xfffe7, 20],
				[0xfffe8, 20],
				[0x3fffd3, 22],
				[0x3fffd4, 22],
				[0x3fffd5, 22],
				[0x7fffd9, 23],
				[0x3fffd6, 22],
				[0x7fffda, 23],
				[0x7fffdb, 23],
				[0x7fffdc, 23],
				[0x7fffdd, 23],
				[0x7fffde, 23],
				[0xffffeb, 24],
				[0x7fffdf, 23],
				[0xffffec, 24],
				[0xffffed, 24],
				[0x3fffd7, 22],
				[0x7fffe0, 23],
				[0xffffee, 24],
				[0x7fffe1, 23],
				[0x7fffe2, 23],
				[0x7fffe3, 23],
				[0x7fffe4, 23],
				[0x1fffdc, 21],
				[0x3fffd8, 22],
				[0x7fffe5, 23],
				[0x3fffd9, 22],
				[0x7fffe6, 23],
				[0x7fffe7, 23],
				[0xffffef, 24],
				[0x3fffda, 22],
				[0x1fffdd, 21],
				[0xfffe9, 20],
				[0x3fffdb, 22],
				[0x3fffdc, 22],
				[0x7fffe8, 23],
				[0x7fffe9, 23],
				[0x1fffde, 21],
				[0x7fffea, 23],
				[0x3fffdd, 22],
				[0x3fffde, 22],
				[0xfffff0, 24],
				[0x1fffdf, 21],
				[0x3fffdf, 22],
				[0x7fffeb, 23],
				[0x7fffec, 23],
				[0x1fffe0, 21],
				[0x1fffe1, 21],
				[0x3fffe0, 22],
				[0x1fffe2, 21],
				[0x7fffed, 23],
				[0x3fffe1, 22],
				[0x7fffee, 23],
				[0x7fffef, 23],
				[0xfffea, 20],
				[0x3fffe2, 22],
				[0x3fffe3, 22],
				[0x3fffe4, 22],
				[0x7ffff0, 23],
				[0x3fffe5, 22],
				[0x3fffe6, 22],
				[0x7ffff1, 23],
				[0x3ffffe0, 26],
				[0x3ffffe1, 26],
				[0xfffeb, 20],
				[0x7fff1, 19],
				[0x3fffe7, 22],
				[0x7ffff2, 23],
				[0x3fffe8, 22],
				[0x1ffffec, 25],
				[0x3ffffe2, 26],
				[0x3ffffe3, 26],
				[0x3ffffe4, 26],
				[0x7ffffde, 27],
				[0x7ffffdf, 27],
				[0x3ffffe5, 26],
				[0xfffff1, 24],
				[0x1ffffed, 25],
				[0x7fff2, 19],
				[0x1fffe3, 21],
				[0x3ffffe6, 26],
				[0x7ffffe0, 27],
				[0x7ffffe1, 27],
				[0x3ffffe7, 26],
				[0x7ffffe2, 27],
				[0xfffff2, 24],
				[0x1fffe4, 21],
				[0x1fffe5, 21],
				[0x3ffffe8, 26],
				[0x3ffffe9, 26],
				[0xffffffd, 28],
				[0x7ffffe3, 27],
				[0x7ffffe4, 27],
				[0x7ffffe5, 27],
				[0xfffec, 20],
				[0xfffff3, 24],
				[0xfffed, 20],
				[0x1fffe6, 21],
				[0x3fffe9, 22],
				[0x1fffe7, 21],
				[0x1fffe8, 21],
				[0x7ffff3, 23],
				[0x3fffea, 22],
				[0x3fffeb, 22],
				[0x1ffffee, 25],
				[0x1ffffef, 25],
				[0xfffff4, 24],
				[0xfffff5, 24],
				[0x3ffffea, 26],
				[0x7ffff4, 23],
				[0x3ffffeb, 26],
				[0x7ffffe6, 27],
				[0x3ffffec, 26],
				[0x3ffffed, 26],
				[0x7ffffe7, 27],
				[0x7ffffe8, 27],
				[0x7ffffe9, 27],
				[0x7ffffea, 27],
				[0x7ffffeb, 27],
				[0xffffffe, 28],
				[0x7ffffec, 27],
				[0x7ffffed, 27],
				[0x7ffffee, 27],
				[0x7ffffef, 27],
				[0x7fffff0, 27],
				[0x3ffffee, 26],
				[0x3fffffff, 30],
			].each(&:freeze).freeze
			
			ENCODE_TABLE = CODES.map {|c, l| [c].pack("N").unpack1("B*")[-l..-1]}.each(&:freeze).freeze
		end
	end
end