Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavdevice / timefilter.c
1 /*
2  * Delay Locked Loop based time filter
3  * Copyright (c) 2009 Samalyse
4  * Copyright (c) 2009 Michael Niedermayer
5  * Author: Olivier Guilyardi <olivier samalyse com>
6  *         Michael Niedermayer <michaelni gmx at>
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24
25 #include "libavutil/common.h"
26 #include "libavutil/mem.h"
27 #include "config.h"
28 #include "timefilter.h"
29
30 struct TimeFilter {
31     /// Delay Locked Loop data. These variables refer to mathematical
32     /// concepts described in: http://www.kokkinizita.net/papers/usingdll.pdf
33     double cycle_time;
34     double feedback2_factor;
35     double feedback3_factor;
36     double clock_period;
37     int count;
38 };
39
40 /* 1 - exp(-x) using a 3-order power series */
41 static double qexpneg(double x)
42 {
43     return 1 - 1 / (1 + x * (1 + x / 2 * (1 + x / 3)));
44 }
45
46 TimeFilter *ff_timefilter_new(double time_base,
47                               double period,
48                               double bandwidth)
49 {
50     TimeFilter *self       = av_mallocz(sizeof(TimeFilter));
51     double o               = 2 * M_PI * bandwidth * period * time_base;
52     self->clock_period     = time_base;
53     self->feedback2_factor = qexpneg(M_SQRT2 * o);
54     self->feedback3_factor = qexpneg(o * o) / period;
55     return self;
56 }
57
58 void ff_timefilter_destroy(TimeFilter *self)
59 {
60     av_freep(&self);
61 }
62
63 void ff_timefilter_reset(TimeFilter *self)
64 {
65     self->count = 0;
66 }
67
68 double ff_timefilter_update(TimeFilter *self, double system_time, double period)
69 {
70     self->count++;
71     if (self->count == 1) {
72         /// init loop
73         self->cycle_time = system_time;
74     } else {
75         double loop_error;
76         self->cycle_time += self->clock_period * period;
77         /// calculate loop error
78         loop_error = system_time - self->cycle_time;
79
80         /// update loop
81         self->cycle_time   += FFMAX(self->feedback2_factor, 1.0 / self->count) * loop_error;
82         self->clock_period += self->feedback3_factor * loop_error;
83     }
84     return self->cycle_time;
85 }
86
87 double ff_timefilter_eval(TimeFilter *self, double delta)
88 {
89     return self->cycle_time + self->clock_period * delta;
90 }
91
92 #ifdef TEST
93 #include "libavutil/lfg.h"
94 #define LFG_MAX ((1LL << 32) - 1)
95
96 #undef printf
97
98 int main(void)
99 {
100     AVLFG prng;
101     double n0, n1;
102 #define SAMPLES 1000
103     double ideal[SAMPLES];
104     double samples[SAMPLES];
105     double samplet[SAMPLES];
106 #if 1
107     for (n0 = 0; n0 < 40; n0 = 2 * n0 + 1) {
108         for (n1 = 0; n1 < 10; n1 = 2 * n1 + 1) {
109 #else
110     {
111         {
112             n0 = 7;
113             n1 = 1;
114 #endif
115             double best_error = 1000000000;
116             double bestpar0   = 1;
117             double bestpar1   = 1;
118             int better, i;
119
120             av_lfg_init(&prng, 123);
121             for (i = 0; i < SAMPLES; i++) {
122                 samplet[i] = 10 + i + (av_lfg_get(&prng) < LFG_MAX/2 ? 0 : 0.999);
123                 ideal[i]   = samplet[i] + n1 * i / (1000);
124                 samples[i] = ideal[i] + n0 * (av_lfg_get(&prng) - LFG_MAX / 2) / (LFG_MAX * 10LL);
125                 if(i && samples[i]<samples[i-1])
126                     samples[i]=samples[i-1]+0.001;
127             }
128
129             do {
130                 double par0, par1;
131                 better = 0;
132                 for (par0 = bestpar0 * 0.8; par0 <= bestpar0 * 1.21; par0 += bestpar0 * 0.05) {
133                     for (par1 = bestpar1 * 0.8; par1 <= bestpar1 * 1.21; par1 += bestpar1 * 0.05) {
134                         double error   = 0;
135                         TimeFilter *tf = ff_timefilter_new(1, par0, par1);
136                         for (i = 0; i < SAMPLES; i++) {
137                             double filtered;
138                             filtered = ff_timefilter_update(tf, samples[i], i ? (samplet[i] - samplet[i-1]) : 1);
139                             if(filtered < 0 || filtered > 1000000000)
140                                 printf("filter is unstable\n");
141                             error   += (filtered - ideal[i]) * (filtered - ideal[i]);
142                         }
143                         ff_timefilter_destroy(tf);
144                         if (error < best_error) {
145                             best_error = error;
146                             bestpar0   = par0;
147                             bestpar1   = par1;
148                             better     = 1;
149                         }
150                     }
151                 }
152             } while (better);
153 #if 0
154             double lastfil = 9;
155             TimeFilter *tf = ff_timefilter_new(1, bestpar0, bestpar1);
156             for (i = 0; i < SAMPLES; i++) {
157                 double filtered;
158                 filtered = ff_timefilter_update(tf, samples[i], 1);
159                 printf("%f %f %f %f\n", i - samples[i] + 10, filtered - samples[i],
160                        samples[FFMAX(i, 1)] - samples[FFMAX(i - 1, 0)], filtered - lastfil);
161                 lastfil = filtered;
162             }
163             ff_timefilter_destroy(tf);
164 #else
165             printf(" [%f %f %9f]", bestpar0, bestpar1, best_error);
166 #endif
167         }
168         printf("\n");
169     }
170     return 0;
171 }
172 #endif