aboutsummaryrefslogtreecommitdiff
path: root/src/huffman/huffmantree.nim
blob: 58a840eac034e4048c8f7f14a52a0a8da1db6587 (plain)
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
# gzip-like LZSS compressor
# Copyright (C) 2018  Pacien TRAN-GIRARD
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import tables, heapqueue
import ../bitio/integers, ../bitio/bitreader, ../bitio/bitwriter

const valueLengthFieldBitLength* = 6  # 64

type HuffmanTreeNodeKind* = enum
  branch,
  leaf

type HuffmanTreeNode*[T: SomeUnsignedInt] = ref object
  case kind*: HuffmanTreeNodeKind
    of branch:
      left*, right*: HuffmanTreeNode[T]
      maxChildValue: T
    of leaf:
      value*: T

proc huffmanBranch*[T](left, right: HuffmanTreeNode[T]): HuffmanTreeNode[T] =
  HuffmanTreeNode[T](
    kind: branch, left: left, right: right,
    maxChildValue: max(left.maxValue(), right.maxValue()))

proc huffmanLeaf*[T](value: T): HuffmanTreeNode[T] =
  HuffmanTreeNode[T](kind: leaf, value: value)

proc `==`*[T](a, b: HuffmanTreeNode[T]): bool =
  if a.kind != b.kind: return false
  case a.kind:
    of branch: a.left == b.left and a.right == b.right
    of leaf: a.value == b.value

proc maxValue*[T](node: HuffmanTreeNode[T]): T =
  case node.kind:
    of branch: node.maxChildValue
    of leaf: node.value

proc deserialise*[T](bitReader: BitReader, valueType: typedesc[T]): HuffmanTreeNode[T] =
  let valueBitLength = bitReader.readBits(valueLengthFieldBitLength, uint8).int
  proc readNode(): HuffmanTreeNode[T] =
    case bitReader.readBool():
      of false: huffmanBranch(readNode(), readNode())
      of true: huffmanLeaf(bitReader.readBits(valueBitLength, valueType))
  readNode()

proc serialise*[T](tree: HuffmanTreeNode[T], bitWriter: BitWriter) =
  let maxValue = tree.maxValue()
  let valueBitLength = maxValue.bitLength()
  proc writeNode(node: HuffmanTreeNode[T]) =
    case node.kind:
      of branch:
        bitWriter.writeBool(false)
        writeNode(node.left)
        writeNode(node.right)
      of leaf:
        bitWriter.writeBool(true)
        bitWriter.writeBits(valueBitLength, node.value)
  bitWriter.writeBits(valueLengthFieldBitLength, valueBitLength.uint8)
  writeNode(tree)