Skip to content

Commit 529bf5d

Browse files
committed
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 <[email protected]>
1 parent 84094f0 commit 529bf5d

File tree

1 file changed

+1
-14
lines changed

1 file changed

+1
-14
lines changed

libavdevice/timefilter.h

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,6 @@ typedef struct TimeFilter TimeFilter;
3939
/**
4040
* Create a new Delay Locked Loop time filter
4141
*
42-
* feedback2_factor and feedback3_factor are the factors used for the
43-
* multiplications that are respectively performed in the second and third
44-
* feedback paths of the loop.
45-
*
46-
* Unless you know what you are doing, you should set these as follow:
47-
*
48-
* o = 2 * M_PI * bandwidth * period_in_seconds
49-
* feedback2_factor = sqrt(2) * o
50-
* feedback3_factor = o * o
51-
*
5242
* Where bandwidth is up to you to choose. Smaller values will filter out more
5343
* of the jitter, but also take a longer time for the loop to settle. A good
5444
* starting point is something between 0.3 and 3 Hz.
@@ -59,11 +49,8 @@ typedef struct TimeFilter TimeFilter;
5949
* @param brandwidth filtering bandwidth, in Hz
6050
*
6151
* @return a pointer to a TimeFilter struct, or NULL on error
62-
*
63-
* For more details about these parameters and background concepts please see:
64-
* http://www.kokkinizita.net/papers/usingdll.pdf
6552
*/
66-
TimeFilter * ff_timefilter_new(double clock_period, double feedback2_factor, double feedback3_factor);
53+
TimeFilter * ff_timefilter_new(double time_base, double period, double bandwidth);
6754

6855
/**
6956
* Update the filter

0 commit comments

Comments
 (0)