v2

Documentation

Index

• Constants
• Variables
• type Compression
  • func (c Compression) String() string
• type CompressionBlock
• type Header
  • func (h Header) ComputeMaxBlocks(maxBlockLength, maxBlockCount, withheldFrameCount int) (blockCount, withheldFrameLength, framesPerBlock int)
  • func (h Header) Duration() time.Duration
  • func (h Header) FramesPerSecond() int
• type SparseRange

Constants

const (
	HeaderLength = 32
	MinorVersion = 0
	MajorVersion = 2
)

const (
	FppMaxCompressionBlockLength = 64 * 2014 // 2014 is not a typo, copied from https://github.com/FalconChristmas/fpp/blob/master/src/fseq/FSEQFile.cpp#L774
	FppMaxCompressionBlockCount  = math.MaxUint8
	FppWithheldFrameCount        = 10
)

Variables

var Identifier = []uint8("PESQ")

Types

type Compression

type Compression uint8

const (
	None Compression = 0
	Zstd Compression = 1
	Zlib Compression = 2
)

func (Compression) String

func (c Compression) String() string

type CompressionBlock

type CompressionBlock struct {
	FrameNumber uint32
	Length      uint32
}

type Header

type Header struct {
	Identifier             [4]uint8
	ChannelDataStartOffset uint16
	MinorVersion           uint8
	MajorVersion           uint8
	HeaderLength           uint16
	ChannelCount           uint32
	FrameCount             uint32
	StepTimeMilliseconds   uint8
	Flags1                 uint8 `fppignored:"true" fppdefault:"0"`
	Compression            Compression
	CompressionBlockCount  uint8
	SparseRangeCount       uint8
	Flags2                 uint8 `fppignored:"true" fppdefault:"0"`
	UniqueID               uint64
}

func (Header) ComputeMaxBlocks

func (h Header) ComputeMaxBlocks(maxBlockLength, maxBlockCount, withheldFrameCount int) (blockCount, withheldFrameLength, framesPerBlock int)

func (Header) Duration

func (h Header) Duration() time.Duration

func (Header) FramesPerSecond

func (h Header) FramesPerSecond() int

type SparseRange

type SparseRange struct {
	StartChannel uint24.Uint24
	ChannelCount uint24.Uint24
}