upipe/uprobe_dejitter.h header reference
probe catching clock_ref and clock_ts events for dejittering More
Header inclusion
Members
Type
- struct uprobe_dejitter
Functions
- struct uprobe * uprobe_dejitter_alloc(struct uprobe *next, bool enabled, uint64_t deviation)
- void uprobe_dejitter_clean(struct uprobe_dejitter *uprobe_dejitter)
- struct uprobe * uprobe_dejitter_init(struct uprobe_dejitter *uprobe_dejitter, struct uprobe *next, bool enabled, uint64_t deviation)
- void uprobe_dejitter_set(struct uprobe *uprobe, bool enabled, uint64_t deviation)
Description
probe catching clock_ref and clock_ts events for dejittering
Members detail
This macro is declared in upipe/uprobe_dejitter.h source file, line 31.
This struct is declared in upipe/uprobe_dejitter.h source file, line 44.
This struct is a super-set of the uprobe structure with additional local members.
| Field | Description |
|---|---|
| unsigned int offset_divider; | number of offsets to average |
| unsigned int deviation_divider; | number of deviations to average |
| unsigned int offset_count; | number of references received for offset calculaton |
| double offset; | offset between stream clock and system clock |
| unsigned int deviation_count; | number of references received for deviation calculaton |
| double deviation; | average absolute deviation |
| uint64_t last_cr_prog; | cr_prog of last clock ref |
| uint64_t last_cr_sys; | cr_sys of last clock ref |
| struct urational drift_rate; | PLL drift rate |
| uint64_t last_print; | cr_sys of the last debug print |
| struct uprobe uprobe; | structure exported to modules |
This function is declared in upipe/uprobe_dejitter.h source file, line 102.
This function allocates a new uprobe_dejitter structure.
Parameter list:
- next: next probe to test if this one doesn't catch the event
- enabled: true if dejitter is enabled
- deviation: initial deviation, if not 0
The return value is pointer to uprobe, or NULL in case of error
void uprobe_dejitter_clean(struct uprobe_dejitter *uprobe_dejitter)
This function is declared in upipe/uprobe_dejitter.h source file, line 92.
This function cleans a uprobe_dejitter structure.
Parameter list:
- uprobe_dejitter: structure to clean
struct uprobe * uprobe_dejitter_init(struct uprobe_dejitter *uprobe_dejitter, struct uprobe *next, bool enabled, uint64_t deviation)
This function is declared in upipe/uprobe_dejitter.h source file, line 86.
This function initializes an already allocated uprobe_dejitter structure.
Parameter list:
- uprobe_pfx: pointer to the already allocated structure
- next: next probe to test if this one doesn't catch the event
- enabled: true if dejitter is enabled
- deviation: initial deviation, if not 0
The return value is pointer to uprobe, or NULL in case of error
This function is declared in upipe/uprobe_dejitter.h source file, line 111.
This function sets the parameters of the dejittering.
Parameter list:
- uprobe: pointer to probe
- enabled: true if dejitter is enabled
- deviation: initial deviation, if not 0
struct uprobe_dejitter * uprobe_dejitter_from_uprobe(struct uprobe *uprobe)
This function is for internal use only.
This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 19 in upipe/uprobe_dejitter.h source file, line 74.
This function returns the private uprobe_dejitter structure.
Parameter list:
- uprobe: public description structure of the probe
The return value is pointer to the private uprobe_dejitter structure
struct uprobe * uprobe_dejitter_to_uprobe(struct uprobe_dejitter *s)
This function is for internal use only.
This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 9 in upipe/uprobe_dejitter.h source file, line 74.
This function returns the public uprobe structure.
Parameter list:
- uprobe_dejitter: pointer to the private uprobe_dejitter structure
The return value is pointer to the public uprobe structure