diff options
| author | Marton Balint <cus@passwd.hu> | 2021-02-06 11:16:57 +0100 |
|---|---|---|
| committer | Marton Balint <cus@passwd.hu> | 2021-02-27 21:30:41 +0100 |
| commit | 529bf5daf2935fb87787d7f7a5263e1b254d59d2 (patch) | |
| tree | 61d7319a9245ae54b485f249a7487148df539c81 /libavdevice/timefilter.h | |
| parent | 84094f017eba045dbb8643c1e0617c235e4f78df (diff) | |
avdevice/timefilter: remove obsolete comments from the docs
Also rename the parameters of the function to match with the implementation.
Signed-off-by: Marton Balint <cus@passwd.hu>
Diffstat (limited to 'libavdevice/timefilter.h')
| -rw-r--r-- | libavdevice/timefilter.h | 15 |
1 files changed, 1 insertions, 14 deletions
diff --git a/libavdevice/timefilter.h b/libavdevice/timefilter.h index cb3d0a788f..de70945062 100644 --- a/libavdevice/timefilter.h +++ b/libavdevice/timefilter.h @@ -39,16 +39,6 @@ typedef struct TimeFilter TimeFilter; /** * Create a new Delay Locked Loop time filter * - * feedback2_factor and feedback3_factor are the factors used for the - * multiplications that are respectively performed in the second and third - * feedback paths of the loop. - * - * Unless you know what you are doing, you should set these as follow: - * - * o = 2 * M_PI * bandwidth * period_in_seconds - * feedback2_factor = sqrt(2) * o - * feedback3_factor = o * o - * * Where bandwidth is up to you to choose. Smaller values will filter out more * of the jitter, but also take a longer time for the loop to settle. A good * starting point is something between 0.3 and 3 Hz. @@ -59,11 +49,8 @@ typedef struct TimeFilter TimeFilter; * @param brandwidth filtering bandwidth, in Hz * * @return a pointer to a TimeFilter struct, or NULL on error - * - * For more details about these parameters and background concepts please see: - * http://www.kokkinizita.net/papers/usingdll.pdf */ -TimeFilter * ff_timefilter_new(double clock_period, double feedback2_factor, double feedback3_factor); +TimeFilter * ff_timefilter_new(double time_base, double period, double bandwidth); /** * Update the filter |