comp_wlsb.h File Reference

Window-based Least Significant Bits (W-LSB) encoding. More...

#include "interval.h"
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>

Include dependency graph for comp_wlsb.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct c_wlsb *	c_create_wlsb (const size_t bits, const size_t window_width, const rohc_lsb_shift_t p)
	Create a new Window-based Least Significant Bits (W-LSB) encoding object. More...
void	c_destroy_wlsb (struct c_wlsb *s)
	Destroy a Window-based LSB (W-LSB) encoding object. More...
void	c_add_wlsb (struct c_wlsb *const wlsb, const uint32_t sn, const uint32_t value)
	Add a value into a W-LSB encoding object. More...
size_t	wlsb_get_k_8bits (const struct c_wlsb *const wlsb, const uint8_t value)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_kp_8bits (const struct c_wlsb *const wlsb, const uint8_t value, const rohc_lsb_shift_t p)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_k_16bits (const struct c_wlsb *const wlsb, const uint16_t value)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_mink_16bits (const struct c_wlsb *const wlsb, const uint16_t value, const size_t min_k)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_kp_16bits (const struct c_wlsb *const wlsb, const uint16_t value, const rohc_lsb_shift_t p)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_minkp_16bits (const struct c_wlsb *const wlsb, const uint16_t value, const size_t min_k, const rohc_lsb_shift_t p)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_k_32bits (const struct c_wlsb *const wlsb, const uint32_t value)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_mink_32bits (const struct c_wlsb *const wlsb, const uint32_t value, const size_t min_k)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_kp_32bits (const struct c_wlsb *const wlsb, const uint32_t value, const rohc_lsb_shift_t p)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_get_minkp_32bits (const struct c_wlsb *const wlsb, const uint32_t value, const size_t min_k, const rohc_lsb_shift_t p)
	Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window. More...
size_t	wlsb_ack (struct c_wlsb *const wlsb, const uint32_t sn_bits, const size_t sn_bits_nr)
	Acknowledge based on the Sequence Number (SN) More...

Detailed Description

Window-based Least Significant Bits (W-LSB) encoding.

Author

Didier Barvaux didie.nosp@m.r.ba.nosp@m.rvaux.nosp@m.@tou.nosp@m.louse.nosp@m..viv.nosp@m.eris..nosp@m.com

David Moreau from TAS

Function Documentation

void c_add_wlsb	(	struct c_wlsb *const	wlsb,
		const uint32_t	sn,
		const uint32_t	value
	)

Add a value into a W-LSB encoding object.

Parameters

wlsb	The W-LSB object
sn	The Sequence Number (SN) for the new entry
value	The value to base the LSB coding on

struct c_wlsb* c_create_wlsb	(	const size_t	bits,
		const size_t	window_width,
		const rohc_lsb_shift_t	p
	)

Create a new Window-based Least Significant Bits (W-LSB) encoding object.

Parameters

bits	The maximal number of bits for representing a value
window_width	The number of entries in the window (power of 2)
p	Shift parameter (see 4.5.2 in the RFC 3095)

Returns

The newly-created W-LSB encoding object

void c_destroy_wlsb

(

struct c_wlsb *const

wlsb

)

Destroy a Window-based LSB (W-LSB) encoding object.

Parameters

wlsb	The W-LSB object to destroy

size_t wlsb_ack	(	struct c_wlsb *const	wlsb,
		const uint32_t	sn_bits,
		const size_t	sn_bits_nr
	)

Acknowledge based on the Sequence Number (SN)

Removes all window entries older (and including) than the one that matches the given SN bits.

Parameters

wlsb	The W-LSB object
sn_bits	The LSB of the SN to acknowledge
sn_bits_nr	The number of LSB of the SN to acknowledge

Returns

The number of acked window entries

size_t wlsb_get_k_16bits	(	const struct c_wlsb *const	wlsb,
		const uint16_t	value
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 16-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_k_32bits	(	const struct c_wlsb *const	wlsb,
		const uint32_t	value
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 32-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_k_8bits	(	const struct c_wlsb *const	wlsb,
		const uint8_t	value
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 8-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_kp_16bits	(	const struct c_wlsb *const	wlsb,
		const uint16_t	value,
		const rohc_lsb_shift_t	p
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 16-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
p	The shift parameter p

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_kp_32bits	(	const struct c_wlsb *const	wlsb,
		const uint32_t	value,
		const rohc_lsb_shift_t	p
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 32-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
p	The shift parameter p

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_kp_8bits	(	const struct c_wlsb *const	wlsb,
		const uint8_t	value,
		const rohc_lsb_shift_t	p
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 8-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
p	The shift parameter p

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_mink_16bits	(	const struct c_wlsb *const	wlsb,
		const uint16_t	value,
		const size_t	min_k
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 16-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
min_k	The minimum number of bits to find out

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_mink_32bits	(	const struct c_wlsb *const	wlsb,
		const uint32_t	value,
		const size_t	min_k
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 32-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
min_k	The minimum number of bits to find out

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_minkp_16bits	(	const struct c_wlsb *const	wlsb,
		const uint16_t	value,
		const size_t	min_k,
		const rohc_lsb_shift_t	p
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 16-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
min_k	The minimum number of bits to find out
p	The shift parameter p

Returns

The number of bits required to uniquely recreate the value

size_t wlsb_get_minkp_32bits	(	const struct c_wlsb *const	wlsb,
		const uint32_t	value,
		const size_t	min_k,
		const rohc_lsb_shift_t	p
	)

Find out the minimal number of bits of the to-be-encoded value required to be able to uniquely recreate it given the window.

The function is dedicated to 32-bit fields.

Parameters

wlsb	The W-LSB object
value	The value to encode using the LSB algorithm
min_k	The minimum number of bits to find out
p	The shift parameter p

Returns

The number of bits required to uniquely recreate the value