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, unsigned int divider)
- void uprobe_dejitter_clean(struct uprobe_dejitter *uprobe_dejitter)
- struct uprobe * uprobe_dejitter_init(struct uprobe_dejitter *uprobe_dejitter, struct uprobe *next, unsigned int divider)
- void uprobe_dejitter_set(struct uprobe *uprobe, unsigned int divider)
Description
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 divider; | number of references to average |
| unsigned int offset_count; | number of references received for offset calculaton |
| int64_t offset; | offset between stream clock and system clock |
| int64_t offset_residue; | residue |
| unsigned int deviation_count; | number of references received for deviation calculaton |
| uint64_t deviation; | average absolute deviation |
| uint64_t deviation_residue; | residue |
| struct uprobe uprobe; | structure exported to modules |
This function is declared in upipe/uprobe_dejitter.h source file, line 90.
This function allocates a new uprobe_dejitter structure.
Parameters list:
- next: next probe to test if this one doesn't catch the event
- divider: number of reference clocks to keep for dejittering
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 82.
This function cleans a uprobe_dejitter structure.
Parameters list:
- uprobe_dejitter: structure to clean
struct uprobe * uprobe_dejitter_init(struct uprobe_dejitter *uprobe_dejitter, struct uprobe *next, unsigned int divider)
This function is declared in upipe/uprobe_dejitter.h source file, line 76.
This function initializes an already allocated uprobe_dejitter structure.
Parameters list:
- uprobe_pfx: pointer to the already allocated structure
- next: next probe to test if this one doesn't catch the event
- divider: number of reference clocks to keep for dejittering
The return value is pointer to uprobe, or NULL in case of error
void uprobe_dejitter_set(struct uprobe *uprobe, unsigned int divider)
This function is declared in upipe/uprobe_dejitter.h source file, line 97.
This function sets a different divider. If set to 0, dejittering is disabled.
Parameters list:
- uprobe: pointer to probe
- divider: number of reference clocks to keep for dejittering
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 18 in upipe/uprobe_dejitter.h source file, line 66.
This function returns the private uprobe_dejitter structure.
Parameters 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 8 in upipe/uprobe_dejitter.h source file, line 66.
This function returns the public uprobe structure.
Parameters list:
- uprobe_dejitter: pointer to the private uprobe_dejitter structure
The return value is pointer to the public uprobe structure