timefilter: De-doxygenize normal code comments and drop silly ones
[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 Libav.
9  *
10  * Libav 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  * Libav 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 Libav; 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 TimeFilter *ff_timefilter_new(double clock_period,
41                               double feedback2_factor,
42                               double feedback3_factor)
43 {
44     TimeFilter *self       = av_mallocz(sizeof(TimeFilter));
45     self->clock_period     = clock_period;
46     self->feedback2_factor = feedback2_factor;
47     self->feedback3_factor = feedback3_factor;
48     return self;
49 }
50
51 void ff_timefilter_destroy(TimeFilter *self)
52 {
53     av_freep(&self);
54 }
55
56 void ff_timefilter_reset(TimeFilter *self)
57 {
58     self->count = 0;
59 }
60
61 double ff_timefilter_update(TimeFilter *self, double system_time, double period)
62 {
63     self->count++;
64     if (self->count == 1) {
65         self->cycle_time = system_time;
66     } else {
67         double loop_error;
68         self->cycle_time += self->clock_period * period;
69         loop_error = system_time - self->cycle_time;
70
71         self->cycle_time   += FFMAX(self->feedback2_factor, 1.0 / self->count) * loop_error;
72         self->clock_period += self->feedback3_factor * loop_error / period;
73     }
74     return self->cycle_time;
75 }
76
77 #ifdef TEST
78 #include "libavutil/lfg.h"
79 #define LFG_MAX ((1LL << 32) - 1)
80
81 #undef printf
82
83 int main(void)
84 {
85     AVLFG prng;
86     double n0, n1;
87 #define SAMPLES 1000
88     double ideal[SAMPLES];
89     double samples[SAMPLES];
90     for (n0 = 0; n0 < 40; n0 = 2 * n0 + 1) {
91         for (n1 = 0; n1 < 10; n1 = 2 * n1 + 1) {
92             double best_error = 1000000000;
93             double bestpar0   = 1;
94             double bestpar1   = 0.001;
95             int better, i;
96
97             av_lfg_init(&prng, 123);
98             for (i = 0; i < SAMPLES; i++) {
99                 ideal[i]   = 10 + i + n1 * i / (1000);
100                 samples[i] = ideal[i] + n0 * (av_lfg_get(&prng) - LFG_MAX / 2) / (LFG_MAX * 10LL);
101             }
102
103             do {
104                 double par0, par1;
105                 better = 0;
106                 for (par0 = bestpar0 * 0.8; par0 <= bestpar0 * 1.21; par0 += bestpar0 * 0.05) {
107                     for (par1 = bestpar1 * 0.8; par1 <= bestpar1 * 1.21; par1 += bestpar1 * 0.05) {
108                         double error   = 0;
109                         TimeFilter *tf = ff_timefilter_new(1, par0, par1);
110                         for (i = 0; i < SAMPLES; i++) {
111                             double filtered;
112                             filtered = ff_timefilter_update(tf, samples[i], 1);
113                             error   += (filtered - ideal[i]) * (filtered - ideal[i]);
114                         }
115                         ff_timefilter_destroy(tf);
116                         if (error < best_error) {
117                             best_error = error;
118                             bestpar0   = par0;
119                             bestpar1   = par1;
120                             better     = 1;
121                         }
122                     }
123                 }
124             } while (better);
125 #if 0
126             double lastfil = 9;
127             TimeFilter *tf = ff_timefilter_new(1, bestpar0, bestpar1);
128             for (i = 0; i < SAMPLES; i++) {
129                 double filtered;
130                 filtered = ff_timefilter_update(tf, samples[i], 1);
131                 printf("%f %f %f %f\n", i - samples[i] + 10, filtered - samples[i],
132                        samples[FFMAX(i, 1)] - samples[FFMAX(i - 1, 0)], filtered - lastfil);
133                 lastfil = filtered;
134             }
135             ff_timefilter_destroy(tf);
136 #else
137             printf(" [%f %f %9f]", bestpar0, bestpar1, best_error);
138 #endif
139         }
140         printf("\n");
141     }
142     return 0;
143 }
144 #endif