bits

package
v0.21.2-0...-6e41e77 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 26, 2021 License: MIT, MIT Imports: 4 Imported by: 0

Documentation

Overview

Package bits - bit reading and writing including Golomb codes and EBSP.

Beyond plain bit reading and writing, reading of ebsp (Encapsulated Byte Sequence Packets) Golomb codes as used in the AVC/H.264 and HEVC video coding standards.

Index

Constants

This section is empty.

Variables

View Source 
var ErrNotReedSeeker = errors.New("Reader does not support Seek")
View Source 
var SliceReadError = fmt.Errorf("Read too far in SliceReader")

Functions

func EBSP2rbsp 

func EBSP2rbsp(ebsp []byte) []byte

EBSP2rbsp - convert from EBSP to RBSP by removing start code emulation prevention bytes

Types

type AccErrByteWriter 

type AccErrByteWriter struct {
	// contains filtered or unexported fields
}

AccErrByteWriter - writer that wraps an io.Writer and accumulater error

func NewAccErrByteWriter 

func NewAccErrByteWriter(w io.Writer) *AccErrByteWriter

NewAccErrByteWriter - create accumulated error writer around io.Writer

func (*AccErrByteWriter) AccError 

func (a *AccErrByteWriter) AccError() error

AccError - return accumulated error

func (*AccErrByteWriter) WriteSlice 

func (a *AccErrByteWriter) WriteSlice(s []byte)

func (*AccErrByteWriter) WriteUint16 

func (a *AccErrByteWriter) WriteUint16(u uint16)

func (*AccErrByteWriter) WriteUint32 

func (a *AccErrByteWriter) WriteUint32(u uint32)

func (*AccErrByteWriter) WriteUint48 

func (a *AccErrByteWriter) WriteUint48(u uint64)

func (*AccErrByteWriter) WriteUint64 

func (a *AccErrByteWriter) WriteUint64(u uint64)

func (*AccErrByteWriter) WriteUint8 

func (a *AccErrByteWriter) WriteUint8(b byte)

type AccErrEBSPReader 

type AccErrEBSPReader struct {
	// contains filtered or unexported fields
}

AccErrEBSPReader - Reader that drops start code emulation 0x03 after two bytes of 0x00

func NewAccErrEBSPReader 

func NewAccErrEBSPReader(rd io.Reader) *AccErrEBSPReader

NewAccErrEBSPReader - return a new reader accumulating errors.

func (*AccErrEBSPReader) AccError 

func (r *AccErrEBSPReader) AccError() error

AccError - accumulated error

func (*AccErrEBSPReader) IsSeeker 

func (r *AccErrEBSPReader) IsSeeker() bool

IsSeeker - does reader support Seek

func (*AccErrEBSPReader) MoreRbspData 

func (r *AccErrEBSPReader) MoreRbspData() (bool, error)

MoreRbspData - false if next bit is 1 and last 1 in fullSlice Underlying reader must support ReadSeeker interface to reset after check Return false, nil if underlying error

func (*AccErrEBSPReader) NrBitsReadInCurrentByte 

func (r *AccErrEBSPReader) NrBitsReadInCurrentByte() int

NrBitsReadInCurrentByte - how many bits have been read

func (*AccErrEBSPReader) NrBytesRead 

func (r *AccErrEBSPReader) NrBytesRead() int

NrBytesRead - how many bytes read into parser

func (*AccErrEBSPReader) Read 

func (r *AccErrEBSPReader) Read(n int) uint

Read - read n bits and return 0 if (previous) error

func (*AccErrEBSPReader) ReadExpGolomb 

func (r *AccErrEBSPReader) ReadExpGolomb() uint

ReadExpGolomb - Read one unsigned exponential golomb code. Return 0 if error

func (*AccErrEBSPReader) ReadFlag 

func (r *AccErrEBSPReader) ReadFlag() bool

ReadFlag - read 1 bit into bool. Return false if not possible

func (*AccErrEBSPReader) ReadRbspTrailingBits 

func (r *AccErrEBSPReader) ReadRbspTrailingBits() error

ReadRbspTrailingBits - read rbsp_traling_bits. Return error if wrong pattern If other error, return nil and let AccError provide that error

func (*AccErrEBSPReader) ReadSignedGolomb 

func (r *AccErrEBSPReader) ReadSignedGolomb() int

ReadSignedGolomb - Read one signed exponential golomb code. Return 0 if error

type AccErrReader 

type AccErrReader struct {
	// contains filtered or unexported fields
}

AccErrReader - bit reader that accumulates error First error can be fetched as reader.AccError()

func NewAccErrReader 

func NewAccErrReader(rd io.Reader) *AccErrReader

NewReader - return a new Reader

func (*AccErrReader) AccError 

func (r *AccErrReader) AccError() error

func (*AccErrReader) Read 

func (r *AccErrReader) Read(n int) uint

Read - read n bits. Return 0, if error now or previously

func (*AccErrReader) ReadFlag 

func (r *AccErrReader) ReadFlag() bool

ReadFlag - read 1 bit into flag. Return false if error now or previously

type EBSPReader 

type EBSPReader struct {
	// contains filtered or unexported fields
}

EBSPReader - Reader that drops start code emulation 0x03 after two bytes of 0x00

func NewEBSPReader 

func NewEBSPReader(rd io.Reader) *EBSPReader

NewEBSPReader - return a new Reader.

func (*EBSPReader) IsSeeker 

func (r *EBSPReader) IsSeeker() bool

IsSeeker - does reader support Seek

func (*EBSPReader) MoreRbspData 

func (r *EBSPReader) MoreRbspData() (bool, error)

MoreRbspData - false if next bit is 1 and last 1 in fullSlice Underlying reader must support ReadSeeker interface to reset after check

func (*EBSPReader) MustRead 

func (r *EBSPReader) MustRead(n int) uint

MustRead - read n bits and panic if not possible

func (*EBSPReader) MustReadExpGolomb 

func (r *EBSPReader) MustReadExpGolomb() uint

MustReadExpGolomb - Read one unsigned exponential golomb code. Panic if not possible

func (*EBSPReader) MustReadFlag 

func (r *EBSPReader) MustReadFlag() bool

MustReadFlag - read 1 bit into flag. Panic if not possible

func (*EBSPReader) MustReadSignedGolomb 

func (r *EBSPReader) MustReadSignedGolomb() int

MustReadSignedGolomb - Read one signed exponential golomb code. Panic if not possible

func (*EBSPReader) NrBitsReadInCurrentByte 

func (r *EBSPReader) NrBitsReadInCurrentByte() int

NrBitsReadInCurrentByte - how many bits have been read

func (*EBSPReader) NrBytesRead 

func (r *EBSPReader) NrBytesRead() int

NrBytesRead - how many bytes read into parser

func (*EBSPReader) Read 

func (r *EBSPReader) Read(n int) (uint, error)

Read - read n bits and return error if not possible

func (*EBSPReader) ReadExpGolomb 

func (r *EBSPReader) ReadExpGolomb() (uint, error)

ReadExpGolomb - Read one unsigned exponential golomb code

func (*EBSPReader) ReadFlag 

func (r *EBSPReader) ReadFlag() (bool, error)

ReadFlag - read 1 bit into flag. Return error if not possible

func (*EBSPReader) ReadRbspTrailingBits 

func (r *EBSPReader) ReadRbspTrailingBits() error

ReadRbspTrailingBits - read rbsp_traling_bits. Return false if wrong pattern

func (*EBSPReader) ReadSignedGolomb 

func (r *EBSPReader) ReadSignedGolomb() (int, error)

ReadSignedGolomb - Read one signed exponential golomb code

type EBSPWriter 

type EBSPWriter struct {
	// contains filtered or unexported fields
}

EbspWriter writes bits into underlying io.Writer and inserts start-code emulation prevention bytes as necessary Stops writing at first error. Errors that have occured can later be checked with Error().

func NewEBSPWriter 

func NewEBSPWriter(w io.Writer) *EBSPWriter

NewWriter - returns a new Writer

func (*EBSPWriter) StuffByteWithZeros 

func (w *EBSPWriter) StuffByteWithZeros()

StuffByteWithZeros - write zero bits until byte boundary (0-7bits)

func (*EBSPWriter) Write 

func (w *EBSPWriter) Write(bits uint, n int)

Write - write n bits from bits and save error state

func (*EBSPWriter) WriteRbspTrailingBits 

func (w *EBSPWriter) WriteRbspTrailingBits()

Write - write rbsp trailing bits (a 1 followed by zeros to a byte boundary)

type Reader 

type Reader struct {
	// contains filtered or unexported fields
}

Reader - read bits from the given io.Reader

func NewReader 

func NewReader(rd io.Reader) *Reader

NewReader - return a new Reader

func (*Reader) MustRead 

func (r *Reader) MustRead(n int) uint

MustRead - Read bits and panic if not possible

func (*Reader) MustReadFlag 

func (r *Reader) MustReadFlag() bool

MustReadFlag - read 1 bit into flag and panic if not possible

func (*Reader) Read 

func (r *Reader) Read(n int) (uint, error)

Read - read n bits

func (*Reader) ReadFlag 

func (r *Reader) ReadFlag() (bool, error)

ReadFlag - read 1 bit into flag

type SliceReader 

type SliceReader struct {
	// contains filtered or unexported fields
}

SliceReader - read integers and other data from a slice. Accumulates error, and the first error can be retrived. If err != nil, 0 or empty string is returned

func NewSliceReader 

func NewSliceReader(data []byte) *SliceReader

NewSliceReader - create a new slice reader reading from data

func (*SliceReader) AccError 

func (s *SliceReader) AccError() error

AccError - get accumulated error after read operations

func (*SliceReader) GetPos 

func (s *SliceReader) GetPos() int

GetPos - get read position is slice

func (*SliceReader) Length 

func (s *SliceReader) Length() int

Length - get length of slice

func (*SliceReader) NrRemainingBytes 

func (s *SliceReader) NrRemainingBytes() int

NrRemaingingByts - return number of bytes remaining

func (*SliceReader) ReadBytes 

func (s *SliceReader) ReadBytes(n int) []byte

ReadBytes - read a slice of n bytes Return empty slice if n bytes not available

func (*SliceReader) ReadFixedLengthString 

func (s *SliceReader) ReadFixedLengthString(n int) string

ReadFixedLengthString - read string of specified length n. Sets err and returns empty string if full length not available

func (*SliceReader) ReadInt16 

func (s *SliceReader) ReadInt16() int16

ReadInt16 - read int16 from slice

func (*SliceReader) ReadInt32 

func (s *SliceReader) ReadInt32() int32

ReadInt32 - read int32 from slice

func (*SliceReader) ReadInt64 

func (s *SliceReader) ReadInt64() int64

ReadInt64 - read int64 from slice

func (*SliceReader) ReadUint16 

func (s *SliceReader) ReadUint16() uint16

ReadUint16 - read uint16 from slice

func (*SliceReader) ReadUint32 

func (s *SliceReader) ReadUint32() uint32

ReadUint32 - read uint32 from slice

func (*SliceReader) ReadUint64 

func (s *SliceReader) ReadUint64() uint64

ReadUint64 - read uint64 from slice

func (*SliceReader) ReadUint8 

func (s *SliceReader) ReadUint8() byte

ReadUint8 - read uint8 from slice

func (*SliceReader) ReadZeroTerminatedString 

func (s *SliceReader) ReadZeroTerminatedString() string

ReadZeroTerminatedString - read string until zero byte Set err and return empty string if no zero byte found

func (*SliceReader) RemainingBytes 

func (s *SliceReader) RemainingBytes() []byte

RemainingBytes - return remaining bytes of this slice

func (*SliceReader) SetPos 

func (s *SliceReader) SetPos(pos int)

SetPos - set read position is slice

func (*SliceReader) SkipBytes 

func (s *SliceReader) SkipBytes(n int)

SkipBytes - skip passed n bytes

type Writer 

type Writer struct {
	// contains filtered or unexported fields
}

Writer writes bits into underlying io.Writer. Stops writing at first error. Errors that have occured can later be checked with Error().

func NewWriter 

func NewWriter(w io.Writer) *Writer

NewWriter - returns a new Writer

func (*Writer) Error 

func (w *Writer) Error() error

Error - error that has occured and stopped writing

func (*Writer) Flush 

func (w *Writer) Flush()

Flush - write remaining bits to the underlying io.Writer. bits will be left-shifted.

func (*Writer) Write 

func (w *Writer) Write(bits uint, n int)

Write - write n bits from bits and save error state

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.