naza/pkg/nazabits/bits_test.go

// Copyright 2020, Chef.  All rights reserved.
// https://github.com/q191201771/naza
//
// Use of this source code is governed by a MIT-style license
// that can be found in the License file.
//
// Author: Chef (191201771@qq.com)

package nazabits_test

import (
	"fmt"
	"math/rand"
	"testing"
	"time"

	"github.com/q191201771/naza/pkg/nazalog"

	"github.com/q191201771/naza/pkg/assert"
	"github.com/q191201771/naza/pkg/nazabits"
)

func TestGetBit8(t *testing.T) {
	assert.Equal(t, uint8(0), nazabits.GetBit8(0, 0))
	assert.Equal(t, uint8(1), nazabits.GetBit8(1<<1, 1))
	assert.Equal(t, uint8(1), nazabits.GetBit8(1<<1+1<<2, 2))
	assert.Equal(t, uint8(1), nazabits.GetBit8(1<<3+1<<4+1<<5, 3))
	assert.Equal(t, uint8(0), nazabits.GetBit8(0, 4))
	assert.Equal(t, uint8(1), nazabits.GetBit8(1<<5, 5))
	assert.Equal(t, uint8(0), nazabits.GetBit8(1+1<<5+1<<7, 6))
	assert.Equal(t, uint8(0), nazabits.GetBit8(0, 7))
}

func TestGetBits8(t *testing.T) {
	// 0110 1001 = 1 + 8 + 32 + 64 = 105
	v := uint8(105)
	assert.Equal(t, uint8(1), nazabits.GetBits8(v, 0, 1))
	assert.Equal(t, uint8(0), nazabits.GetBits8(v, 7, 1))
	assert.Equal(t, uint8(1), nazabits.GetBits8(v, 0, 2))
	assert.Equal(t, uint8(1), nazabits.GetBits8(v, 6, 2))
	assert.Equal(t, uint8(1), nazabits.GetBits8(v, 0, 3))
	assert.Equal(t, uint8(5), nazabits.GetBits8(v, 3, 3))
	assert.Equal(t, uint8(10), nazabits.GetBits8(v, 2, 4))
	assert.Equal(t, uint8(26), nazabits.GetBits8(v, 2, 5))
	assert.Equal(t, uint8(26), nazabits.GetBits8(v, 2, 6))
	assert.Equal(t, uint8(105), nazabits.GetBits8(v, 0, 7))
	assert.Equal(t, uint8(105), nazabits.GetBits8(v, 0, 8))
}

func TestGetBit16(t *testing.T) {
	v := []byte{48, 57} // 12345 {0011 0000, 0011 1001}
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 0))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 1))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 2))
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 3))
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 4))
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 5))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 6))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 7))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 8))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 9))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 10))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 11))
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 12))
	assert.Equal(t, uint8(1), nazabits.GetBit16(v, 13))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 14))
	assert.Equal(t, uint8(0), nazabits.GetBit16(v, 15))
}

func TestGetBits16(t *testing.T) {
	v := []byte{48, 57} // 12345 {0011 0000, 0011 1001}
	assert.Equal(t, uint16(12345), nazabits.GetBits16(v, 0, 16))
	assert.Equal(t, uint16(1), nazabits.GetBits16(v, 0, 1))
	assert.Equal(t, uint16(0), nazabits.GetBits16(v, 1, 2))
	assert.Equal(t, uint16(6), nazabits.GetBits16(v, 2, 3))
	assert.Equal(t, uint16(7), nazabits.GetBits16(v, 3, 4))
	assert.Equal(t, uint16(3), nazabits.GetBits16(v, 4, 5))
	assert.Equal(t, uint16(1), nazabits.GetBits16(v, 5, 6))
	assert.Equal(t, uint16(64), nazabits.GetBits16(v, 6, 7))
	assert.Equal(t, uint16(96), nazabits.GetBits16(v, 7, 8))
	assert.Equal(t, uint16(0), nazabits.GetBits16(v, 8, 1))
	assert.Equal(t, uint16(0), nazabits.GetBits16(v, 9, 2))
	assert.Equal(t, uint16(4), nazabits.GetBits16(v, 10, 3))
	assert.Equal(t, uint16(6), nazabits.GetBits16(v, 11, 4))
	assert.Equal(t, uint16(3), nazabits.GetBits16(v, 12, 3))
	assert.Equal(t, uint16(1), nazabits.GetBits16(v, 13, 2))
	assert.Equal(t, uint16(0), nazabits.GetBits16(v, 14, 1))
	assert.Equal(t, uint16(0), nazabits.GetBits16(v, 15, 1))
}

func TestCorner(t *testing.T) {
	v := []byte{0}
	var err error
	br := nazabits.NewBitReader(v)
	_, err = br.ReadBytes(1)
	assert.Equal(t, nil, err)
	_, err = br.ReadBit()
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadBits8(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadBits16(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadBits32(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadBits64(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadBytes(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	_, err = br.ReadGolomb()
	assert.Equal(t, nazabits.ErrNazaBits, err)
	assert.Equal(t, nazabits.ErrNazaBits, br.Err())

	v2 := []byte{1}
	br2 := nazabits.NewBitReader(v2)
	_, err = br2.ReadGolomb()
	assert.Equal(t, nazabits.ErrNazaBits, err)
	assert.Equal(t, nazabits.ErrNazaBits, br.Err())

	{
		v := []byte{1}
		br := nazabits.NewBitReader(v)
		_, _ = br.ReadBit()
		_, err = br.ReadBytes(1)
		assert.Equal(t, nazabits.ErrNazaBits, err)
	}
}

func TestBitReader_ReadBit(t *testing.T) {
	res := []uint8{0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 1}
	v := []byte{48, 57} // 12345 {0011 0000, 0011 1001}
	br := nazabits.NewBitReader(v)
	for _, b := range res {
		r, err := br.ReadBit()
		assert.Equal(t, nil, err)
		assert.Equal(t, b, r)
		assert.Equal(t, nil, br.Err())
	}
}

func TestBitReader_ReadBits8(t *testing.T) {
	v := []byte{48, 57, 48, 57}
	br := nazabits.NewBitReader(v)

	gold := []struct {
		n uint
		r uint8
	}{
		{1, 0},
		{2, 1},
		{3, 4},
		{4, 0},
		{5, 28},
		{6, 38},
		{7, 3},
	}
	for _, item := range gold {
		r, err := br.ReadBits8(item.n)
		assert.Equal(t, nil, err)
		assert.Equal(t, item.r, r, fmt.Sprintf("n=%d", item.n))
		assert.Equal(t, nil, br.Err())
	}

	br = nazabits.NewBitReader(v)
	// {0011 0000, 0011 1001, 0 011 0000, 0011 1001}
	r, err := br.ReadBits8(8)
	assert.Equal(t, nil, err)
	assert.Equal(t, uint8(48), r)
	assert.Equal(t, nil, br.Err())

	br = nazabits.NewBitReader(v)
	r, err = br.ReadBits8(3)
	assert.Equal(t, uint8(1), r)
	r, err = br.ReadBits8(6)
	assert.Equal(t, uint8(32), r)
}

func TestBitReader_ReadBits16(t *testing.T) {
	v := []byte{48, 57, 48, 57}

	gold := []struct {
		n uint
		r uint16
	}{
		{8, 48},
		{3, 1},
		{5, 25},
		{16, 12345},
	}
	br := nazabits.NewBitReader(v)
	for _, item := range gold {
		r, err := br.ReadBits16(item.n)
		assert.Equal(t, nil, err)
		assert.Equal(t, item.r, r)
		assert.Equal(t, nil, br.Err())
	}

	// {0011 0000, 0011 1001, 0 011 0000, 0011 1001}
	gold = []struct {
		n uint
		r uint16
	}{
		{5, 6},
		{8, 7},
		{9, 76},
		{10, 57},
	}
	br = nazabits.NewBitReader(v)
	for _, item := range gold {
		r, err := br.ReadBits16(item.n)
		assert.Equal(t, nil, err)
		assert.Equal(t, item.r, r)
		assert.Equal(t, nil, br.Err())
	}
}

func TestBitReader_ReadBits32(t *testing.T) {
	v := []byte{48, 57, 48, 57}
	br := nazabits.NewBitReader(v)
	r, err := br.ReadBits32(32)
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(809054265), r)
	assert.Equal(t, nil, br.Err())
}

func TestBitReader_ReadBits64(t *testing.T) {
	v := []byte{1, 2, 3, 4, 5, 6, 7, 8}
	br := nazabits.NewBitReader(v)
	r, err := br.ReadBits64(64)
	assert.Equal(t, nil, err)
	assert.Equal(t, uint64(72623859790382856), r)
	assert.Equal(t, nil, br.Err())
}

func TestBitReader_ReadBytes(t *testing.T) {
	// {0011 0000, 0011 1001, 0011 0000}
	v := []byte{48, 57, 48}
	{
		br := nazabits.NewBitReader(v)
		r, err := br.ReadBytes(2)
		assert.Equal(t, nil, err)
		assert.Equal(t, v[0:2], r)
		assert.Equal(t, nil, br.Err())
	}

	{
		br := nazabits.NewBitReader(v)
		r1, err := br.ReadBit()
		assert.Equal(t, nil, err)
		assert.Equal(t, uint8(0), r1)
		r2, err := br.ReadBytes(2)
		assert.Equal(t, nil, err)
		assert.Equal(t, []byte{96, 114}, r2)
	}
}

func TestBitReader_ReadGolomb(t *testing.T) {
	var b []byte
	var v uint32
	var err error
	var br nazabits.BitReader

	b = []byte{0x88, 0x82}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(7), v)
	assert.Equal(t, nil, br.Err())

	b = []byte{0x88, 0x84}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(7), v)
	assert.Equal(t, nil, br.Err())

	b = []byte{0x9a, 0x26}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(5), v)
	assert.Equal(t, nil, br.Err())

	b = []byte{0x9a, 0x46}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(5), v)
	assert.Equal(t, nil, br.Err())

	b = []byte{0x9a, 0x24}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(5), v)
	assert.Equal(t, nil, br.Err())

	b = []byte{0x9e, 0x42}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(0), v)
	v, err = br.ReadGolomb()
	assert.Equal(t, nil, err)
	assert.Equal(t, uint32(6), v)
	assert.Equal(t, nil, br.Err())

	// 1<<n + m - 1
	// 1(0, 0)   -> 0
	// 010(1, 0) -> 1
	// 011(1, 1) -> 2
	// 00100(2, 0) -> 3
	// 00111(2, 3) -> 7
	// (3, 7) -> 15
	// (4, 15) -> 31
	// (5, 31) -> 63
	// (9, 209) -> 720
	b = []byte{0x80}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(0), v)
	b = []byte{0x40}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(1), v)
	b = []byte{0x60}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(2), v)
	b = []byte{0x20}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(3), v)
	b = []byte{0x0, 0x40, 0x0}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(511), v)
	b = []byte{0x0, 0x5a, 0x20}
	br = nazabits.NewBitReader(b)
	v, err = br.ReadGolomb()
	assert.Equal(t, uint32(720), v)
	assert.Equal(t, nil, br.Err())
}

func TestBitWriter_WriteBit(t *testing.T) {
	v := make([]byte, 2)
	bw := nazabits.NewBitWriter(v)
	bs := []uint8{0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 1}
	for _, b := range bs {
		bw.WriteBit(b)
	}
	assert.Equal(t, uint8(48), v[0])
	assert.Equal(t, uint8(57), v[1])

	v = make([]byte, 2)
	bw = nazabits.NewBitWriter(v)
	bs = []uint8{2, 4, 3, 5, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 1}
	for _, b := range bs {
		bw.WriteBit(b)
	}
	assert.Equal(t, uint8(48), v[0])
	assert.Equal(t, uint8(57), v[1])

	// 对非0原值进行位写入
	v = []uint8{0xF0}
	bw = nazabits.NewBitWriter(v)
	bw.WriteBit(0)
	bw.WriteBit(0)
	bw.WriteBit(0)
	bw.WriteBit(0)
	bw.WriteBit(1)
	bw.WriteBit(1)
	bw.WriteBit(1)
	bw.WriteBit(1)
	assert.Equal(t, uint8(0x0F), v[0])
}

func TestBitWriter_WriteBits8(t *testing.T) {
	v := make([]byte, 2)
	bw := nazabits.NewBitWriter(v)
	bw.WriteBits8(1, 0)
	bw.WriteBits8(2, 1)
	bw.WriteBits8(3, 4)
	bw.WriteBits8(4, 0)
	bw.WriteBits8(5, 28)
	bw.WriteBits8(1, 1)
	assert.Equal(t, uint8(48), v[0])
	assert.Equal(t, uint8(57), v[1])

	v = make([]byte, 1)
	bw = nazabits.NewBitWriter(v)
	bw.WriteBits8(3, 1+8+32+128)
	assert.Equal(t, uint8(1<<5), v[0])
}

func TestBitWriter_WriteBits16(t *testing.T) {
	v := make([]byte, 2)
	bw := nazabits.NewBitWriter(v)
	bw.WriteBits16(1, 0)
	bw.WriteBits16(2, 1)
	bw.WriteBits16(3, 4)
	bw.WriteBits16(4, 0)
	bw.WriteBits16(5, 28)
	bw.WriteBits16(1, 1)
	assert.Equal(t, uint8(48), v[0])
	assert.Equal(t, uint8(57), v[1])

	v = make([]byte, 1)
	bw = nazabits.NewBitWriter(v)
	bw.WriteBits16(3, 1+8+32+128)
	assert.Equal(t, uint8(1<<5), v[0])

	v = make([]byte, 2)
	bw = nazabits.NewBitWriter(v)
	bw.WriteBits16(16, 0xFFFF)
	assert.Equal(t, uint8(0xFF), v[0])
	assert.Equal(t, uint8(0xFF), v[1])
}

func TestBitReader_AvailBits(t *testing.T) {
	v := []byte{1}
	br := nazabits.NewBitReader(v)

	_, _ = br.ReadBit()
	n, err := br.AvailBits()
	assert.Equal(t, uint(7), n)
	assert.Equal(t, nil, err)

	_, _ = br.ReadBit()
	n, err = br.AvailBits()
	assert.Equal(t, uint(6), n)
	assert.Equal(t, nil, err)

	_, err = br.ReadBits8(8)
	n, err = br.AvailBits()
	assert.Equal(t, nazabits.ErrNazaBits, err)
}

func TestBitReader_Skip(t *testing.T) {
	v := []byte{48, 57, 48} // {0011 0000, 0011 1001, 0011 0000}
	br := nazabits.NewBitReader(v)

	// 0,1
	r1, _ := br.ReadBit()
	assert.Equal(t, uint8(0), r1)

	// 0,3
	err := br.SkipBits(2)
	assert.Equal(t, nil, err)

	// 0,5
	r1, _ = br.ReadBits8(2)
	assert.Equal(t, uint8(2), r1)

	// 1,5
	err = br.SkipBytes(1)
	assert.Equal(t, nil, err)

	// 2,4
	err = br.SkipBits(7)
	assert.Equal(t, nil, err)

	// 2,6
	r1, _ = br.ReadBits8(2)
	assert.Equal(t, uint8(0), r1)

	err = br.SkipBits(4)
	assert.Equal(t, nazabits.ErrNazaBits, err)
	err = br.SkipBytes(1)
	assert.Equal(t, nazabits.ErrNazaBits, err)
}

// -----bench

func BenchmarkGetBits8(b *testing.B) {
	v := uint8(48)
	var ret uint8
	rand.Seed(time.Now().UnixNano())
	pos := rand.Int() % 8       // [0, 7]
	n := 1 + rand.Int()%(8-pos) // [1, 8]
	ppos := uint(pos)
	nn := uint(n)
	nazalog.Infof("%d, %d", ppos, nn)
	for i := 0; i < b.N; i++ {
		ret = nazabits.GetBits8(v, ppos, nn)
	}
	_ = ret
}

func BenchmarkGetBit8(b *testing.B) {
	v := uint8(48)
	var ret uint8
	rand.Seed(time.Now().UnixNano())
	pos := rand.Int() % 8 // [0, 7]
	ppos := uint(pos)
	nazalog.Infof("%d", ppos)
	for i := 0; i < b.N; i++ {
		ret = nazabits.GetBit8(v, ppos)
	}
	_ = ret
}

func BenchmarkBitReader_ReadBit(b *testing.B) {
	v := []byte{48, 57, 48, 57}
	var ret uint8
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		for j := 0; j < 16; j++ {
			a, _ := br.ReadBit()
			ret = a
		}
	}
	_ = ret
}

func BenchmarkBitReader_ReadBits8(b *testing.B) {
	v := []byte{48, 57, 48, 57}
	var ret uint8
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		a, _ := br.ReadBits8(4)
		a, _ = br.ReadBits8(8)
		ret = a
	}
	_ = ret
}

func BenchmarkBitReader_ReadBits16(b *testing.B) {
	v := []byte{48, 57, 48, 57}
	var ret uint16
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		a, _ := br.ReadBits16(5)
		a, _ = br.ReadBits16(8)
		a, _ = br.ReadBits16(9)
		a, _ = br.ReadBits16(10)
		ret = a
	}
	_ = ret
}

func BenchmarkBitReader_ReadBits32(b *testing.B) {
	v := []byte{48, 57, 48, 57}
	var ret uint32
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		ret, _ = br.ReadBits32(32)
	}
	_ = ret
}

func BenchmarkBitReader_ReadBits64(b *testing.B) {
	v := []byte{1, 2, 3, 4, 5, 6, 7, 8}
	var ret uint64
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		ret, _ = br.ReadBits64(64)
	}
	_ = ret
}

func BenchmarkBitReader_ReadBytes(b *testing.B) {
	v := make([]byte, 1024)
	var ret []byte
	for i := 0; i < b.N; i++ {
		br := nazabits.NewBitReader(v)
		ret, _ = br.ReadBytes(128)
	}
	_ = ret
}