Module codec

Source
Expand description

Expose public API for encoding and decoding

Modules§

compressed
Compressed codec utilities
decoder
ADΔER stream decoder
empty
Filler for when generated ADΔER events need not be captured
encoder
ADΔER stream encoder
rate_controller
Control the quality of ADDER transcoding and compression in a predictable manner
raw
Raw codec utilities

Structs§

CodecMetadata
The metadata which stays the same over the course of an ADΔER stream
EncoderOptions
Options related to encoder controls (what gets encoded and how) TODO: Move adu_interval into this, rather than be fixed for the whole compressed file

Enums§

CodecError
EncoderType
The encoder type, along with any associated options
EventDrop
Allow the encoder to randomly drop events before compressing, if the event rate is too high
EventOrder
Reorder the events according to their firing times
WriteCompressionEnum
Different options for what to with the events we’re given

Constants§

LATEST_CODEC_VERSION
Current latest version of the codec.

Traits§

ReadCompression
A trait for reading ADΔER data from a stream.
WriteCompression
A trait for writing ADΔER data to a stream.