From 32284910277308ea3236edf5bf523cffc857cb12 Mon Sep 17 00:00:00 2001
From: Michael Niedermayer <michaelni@gmx.at>
Date: Fri, 6 Mar 2009 00:44:12 +0000
Subject: [PATCH] Add clock_period parameter, this should make the code easier
 to use.

Originally committed as revision 17845 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
 libavformat/timefilter.c |  6 +++---
 libavformat/timefilter.h | 10 +++++++---
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/libavformat/timefilter.c b/libavformat/timefilter.c
index 809dbc60ce..6873ad7b55 100644
--- a/libavformat/timefilter.c
+++ b/libavformat/timefilter.c
@@ -35,10 +35,10 @@ struct TimeFilter {
     int count;
 };
 
-TimeFilter * ff_timefilter_new(double feedback2_factor, double feedback3_factor)
+TimeFilter * ff_timefilter_new(double clock_period, double feedback2_factor, double feedback3_factor)
 {
     TimeFilter *self        = av_mallocz(sizeof(TimeFilter));
-    self->integrator2_state = 1.0;
+    self->integrator2_state = clock_period;
     self->feedback2_factor  = feedback2_factor;
     self->feedback3_factor  = feedback3_factor;
     return self;
@@ -98,7 +98,7 @@ main(){
                 for(par0= bestpar0*0.8; par0<=bestpar0*1.21; par0+=bestpar0*0.05){
                     for(par1= bestpar1*0.8; par1<=bestpar1*1.21; par1+=bestpar1*0.05){
                         double error=0;
-                        TimeFilter *tf= ff_timefilter_new(par0, par1);
+                        TimeFilter *tf= ff_timefilter_new(1, par0, par1);
                         for(i=0; i<SAMPLES; i++){
                             double filtered;
                             filtered=  ff_timefilter_update(tf, samples[i], 1);
diff --git a/libavformat/timefilter.h b/libavformat/timefilter.h
index 3532aede18..f3f16e1f6f 100644
--- a/libavformat/timefilter.h
+++ b/libavformat/timefilter.h
@@ -51,18 +51,22 @@ typedef struct TimeFilter TimeFilter;
  * 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.
  *
+ * @param clock_period period of the hardware clock in seconds
+ *        (for example 1.0/44100)
+ *
  * For more details about these parameters and background concepts please see:
  * http://www.kokkinizita.net/papers/usingdll.pdf
  */
-TimeFilter * ff_timefilter_new(double feedback2_factor, double feedback3_factor);
+TimeFilter * ff_timefilter_new(double clock_period, double feedback2_factor, double feedback3_factor);
 
 /**
  * Update the filter
  *
  * This function must be called in real time, at each process cycle.
  *
- * period is the device cycle duration in seconds. For example, at
- * 44.1Hz and a buffer size of 512 frames, period = 512 / 44100.
+ * @param period the device cycle duration in clock_periods. For example, at
+ * 44.1kHz and a buffer size of 512 frames, period = 512 when clock_period
+ * was 1.0/44100, or 512/44100 if clock_period was 1.
  *
  * system_time, in seconds, should be the value of the system clock time,
  * at (or as close as possible to) the moment the device hardware interrupt